Class ProxyService

Represents the proxy service.

Constructors

constructor

new ProxyService(proxyRepository: ProxyRepository): ProxyService
Creates a new service instance.
Parameters
- proxyRepository: ProxyRepository
  The proxy repository instance.
Returns ProxyService
- Defined in modules/proxy/proxy.service.ts:41

Methods

create

create(
    data: {
        campaignId: string;
        lockSecret: string;
        proxyId: string;
        url: string;
    },
): Promise<ProxyModel>
Creates a new proxy.
Parameters
- data: { campaignId: string; lockSecret: string; proxyId: string; url: string }
  The data object.
Returns Promise<ProxyModel>
The created proxy model.
- Defined in modules/proxy/proxy.service.ts:49

delete

delete(
data: { campaignId: string; lockSecret: string; proxyId: string },
): Promise<void>
Deletes the proxy by its ID.
Parameters
- data: { campaignId: string; lockSecret: string; proxyId: string }
  The data object.
Returns Promise<void>
- Defined in modules/proxy/proxy.service.ts:152

disable

disable(
data: { campaignId: string; lockSecret: string; proxyId: string },
): Promise<void>
Disables the proxy, stopping traffic routing.
Parameters
- data: { campaignId: string; lockSecret: string; proxyId: string }
  The data object.
Returns Promise<void>
- Defined in modules/proxy/proxy.service.ts:129

enable

enable(
data: { campaignId: string; lockSecret: string; proxyId: string },
): Promise<void>
Enables the proxy, making it available for traffic routing.
Parameters
- data: { campaignId: string; lockSecret: string; proxyId: string }
  The data object.
Returns Promise<void>
- Defined in modules/proxy/proxy.service.ts:106

list

list(data: { campaignId: string }): Promise<ProxyModel[]>
Lists all proxies for the campaign.
Parameters
- data: { campaignId: string }
  The data object.
Returns Promise<ProxyModel[]>
The array of proxy models.
- Defined in modules/proxy/proxy.service.ts:176

read

read(data: { campaignId: string; proxyId: string }): Promise<ProxyModel>
Reads the proxy by its ID.
Parameters
- data: { campaignId: string; proxyId: string }
  The data object.
Returns Promise<ProxyModel>
The proxy model.

Throws
ReplServerError If the proxy is not found.
- Defined in modules/proxy/proxy.service.ts:89

`Static`register

register(container: DIContainer): void
Registers the service as a singleton in the DI container.
Parameters
- container: DIContainer
  The DI container to register in.
Returns void
- Defined in modules/proxy/proxy.service.ts:29