@opens/gateways 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -1,47 +1,386 @@
 import { AxiosInstance } from 'axios';
 
+/** Shared company data fields returned by the Customer Service API. */
+interface CompanyData {
+    id: string;
+    name: string;
+    hostname: string;
+    crm_code: string;
+    token: string;
+    status: string;
+    timezone: string;
+    utc: string;
+    check_bad_password: boolean;
+    limit_bad_password: number;
+    watching: boolean;
+    trial: boolean;
+    support_widget_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a company. */
 interface CompanyResponse {
-    company: {
-        id: string;
+    company: CompanyData;
+}
+
+/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
+interface WorkGroup {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching the work groups list. */
+interface WorkGroupListResponse extends CompanyData {
+    workgroups: WorkGroup[];
+}
+/** A user membership entity nested within {@link WorkGroupResponse}. */
+interface WorkGroupMember {
+    id: string;
+    username: string;
+    email: string;
+    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
+    status: 'new' | 'activated' | 'disabled';
+    avatar: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a single work group. */
+interface WorkGroupResponse {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+    workgroups_users: WorkGroupMember[];
+}
+/** Response returned by the Customer Service API when fetching members of a work group. */
+type WorkGroupMembersResponse = WorkGroupMember[];
+
+/**
+ * Gateway for interacting with the Customer Service API.
+ */
+declare class CustomerServiceGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves a company by its unique identifier.
+     * @param companyId - The unique identifier of the company.
+     * @returns The company data wrapped in a {@link CompanyResponse}.
+     */
+    getCompanyById(companyId: string): Promise<CompanyResponse>;
+    /**
+     * Retrieves all work groups for a company.
+     * @param companyId - The unique identifier of the company.
+     * @returns The work groups for the given company.
+     */
+    getWorkGroups(companyId: string): Promise<WorkGroupListResponse>;
+    /**
+     * Retrieves a work group by its unique identifier.
+     * @param workGroupId - The unique identifier of the work group.
+     * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+     * @returns The work group data wrapped in a {@link WorkGroupResponse}.
+     */
+    getWorkGroupById(workGroupId: string, companyId?: string): Promise<WorkGroupResponse>;
+    /**
+     * Retrieves the members of a work group by its identifier.
+     * @param groupId - The unique identifier of the work group.
+     * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+     * @param profile - Filter members by profile (optional).
+     * @returns The members of the work group.
+     */
+    getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
+}
+
+/** A provider entity returned by the Chat Config API. */
+interface Provider {
+    id: string;
+    name: string;
+    configurationsSchema: Record<string, unknown> | null;
+    defaultSession: number;
+    type: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Chat Config API when listing providers. */
+type ProviderListResponse = Provider[];
+
+/** A provider entity nested within a configuration response. */
+interface ConfigProvider {
+    id: string;
+    name: string;
+    type: string;
+    defaultSession: number;
+    configurationsSchema: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A configuration entity returned by the Chat Config API. */
+interface Config {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number | null;
+    companyId: string;
+    active: boolean;
+    configurations: Record<string, unknown>;
+    priority: number | null;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    providers: ConfigProvider;
+}
+/** Response returned by the Chat Config API when listing configurations by provider. */
+interface ConfigListByProviderResponse {
+    configurations: Config[];
+}
+/** Query parameters for filtering configurations by provider. */
+interface GetConfigsByProviderParams {
+    isAssistanceEnabled?: boolean;
+    rewind?: number;
+    active?: boolean;
+    priority?: number;
+    inbound?: boolean;
+    outbound?: boolean;
+    providerType?: string;
+    providerName?: string;
+}
+
+/**
+ * Gateway for interacting with the Chat Config API.
+ */
+declare class ChatConfigGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves all available providers.
+     * @returns The list of providers.
+     */
+    getProviders(): Promise<ProviderListResponse>;
+    /**
+     * Retrieves configurations filtered by provider.
+     * @param providerId - The unique identifier of the provider.
+     * @param params - Optional query parameters for filtering configurations.
+     * @returns The configurations for the given provider.
+     */
+    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+}
+
+/** Campaign status literals. */
+type CampaignStatus = 'ongoing' | 'finished' | 'paused' | 'scheduled';
+/** Campaign provider literals. */
+type CampaignProvider = 'whatsapp';
+/** WhatsApp template component structure. */
+interface WhatsAppTemplateComponent {
+    type: string;
+    parameters: {
+        type: string;
+        text?: string;
+    }[];
+}
+/** WhatsApp payload used when dispatching campaign messages. */
+interface WhatsAppPayload {
+    template: {
         name: string;
-        hostname: string;
-        crm_code: string;
-        token: string;
+        components: WhatsAppTemplateComponent[];
+        language: string;
         status: string;
-        timezone: string;
-        utc: string;
-        check_bad_password: boolean;
-        limit_bad_password: number;
-        watching: boolean;
-        trial: boolean;
-        support_widget_id: string;
-        createdAt: string;
-        updatedAt: string;
+        category: string;
+        id: string;
     };
+    templateOptions: {
+        buttonsVariablesValues?: (string | null)[] | null;
+        bodyVariablesValues?: string[];
+        headerVariablesValues?: string[];
+        headerFileInfos?: {
+            filename: string;
+            fileUrl: string;
+            parsedFilename: string;
+        };
+    };
+}
+/** Contact filter applied when adding contacts to a campaign. */
+interface CampaignContactFilter {
+    excludeDeclinedMarketing?: boolean;
+}
+/** Schedule configuration for a campaign. */
+interface CampaignSchedule {
+    startAt?: string;
+    repeat?: {
+        delay?: number;
+        count?: number;
+        until?: string;
+    };
+}
+/** Campaign entity returned by the Campaigns API. */
+interface Campaign {
+    id: string;
+    sid: number;
+    companyId: string;
+    createdBy: string;
+    assignedTo: string;
+    name?: string;
+    provider: CampaignProvider;
+    providerId: number;
+    providerConfigId: string;
+    associatedRuleId?: string;
+    payload: WhatsAppPayload;
+    conversionRuleIds: string[];
+    status: CampaignStatus;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    failedCampaignAttempts: number;
+    queuedCampaignAttempts: number;
+    deliveredCampaignAttempts: number;
+    convertedCampaignAttempts: number;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+    schedule?: CampaignSchedule;
+}
+/** Paginated response returned by the Campaigns API for list endpoints. */
+interface CampaignPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: Campaign[];
+}
+/** Request payload for creating a campaign. */
+interface CreateCampaignRequest {
+    name: string;
+    payload: WhatsAppPayload;
+    provider: CampaignProvider;
+    companyId: string;
+    createdBy: string;
+    providerId: number;
+    providerConfigId: string;
+    schedule: CampaignSchedule;
+    associatedRuleId?: string;
+    assignedTo?: string;
+    expiresAt?: string;
+}
+/** Request payload for updating a campaign. */
+interface PatchCampaignRequest {
+    name?: string;
+    expiresAt?: string;
+    status?: CampaignStatus;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+}
+/** Query parameters for listing campaigns. */
+interface CampaignQueryParams {
+    companyId?: string;
+    status?: CampaignStatus;
+    createdBy?: string;
+    assignedTo?: string;
+    name?: string;
+    limit?: number;
+    skip?: number;
 }
 
-declare class CustomerServiceGateway {
+/**
+ * Gateway for interacting with the Campaigns API.
+ */
+declare class CampaignsGateway {
     private readonly httpClient;
     private readonly baseUrl;
     constructor(httpClient: AxiosInstance, baseUrl: string);
-    getCompanyById(companyId: string): Promise<CompanyResponse>;
+    /**
+     * Retrieves a paginated list of campaigns.
+     * @param query - Optional query parameters for filtering and pagination.
+     * @returns The paginated campaigns response.
+     */
+    find(query?: CampaignQueryParams): Promise<CampaignPaginatedResponse>;
+    /**
+     * Retrieves a campaign by its unique identifier.
+     * @param id - The unique identifier of the campaign.
+     * @returns The campaign data.
+     */
+    get(id: string): Promise<Campaign>;
+    /**
+     * Creates a new campaign.
+     * @param payload - The campaign data to create.
+     * @returns The created campaign.
+     */
+    create(payload: CreateCampaignRequest): Promise<Campaign>;
+    /**
+     * Partially updates an existing campaign.
+     * @param id - The unique identifier of the campaign.
+     * @param payload - The fields to update.
+     * @returns The updated campaign.
+     */
+    patch(id: string, payload: PatchCampaignRequest): Promise<Campaign>;
+    /**
+     * Removes a campaign by its unique identifier.
+     * @param id - The unique identifier of the campaign.
+     * @returns The removed campaign.
+     */
+    remove(id: string): Promise<Campaign>;
 }
 
+/**
+ * Maps service identifiers to their corresponding gateway types.
+ * Used by the `gateway()` function to infer the correct return type
+ * based on the service name passed as argument.
+ *
+ * When adding a new service, add an entry here with the service
+ * identifier as the key and the gateway class as the value.
+ */
+type GatewayMap = {
+    'customer-service': CustomerServiceGateway;
+    'chat-config': ChatConfigGateway;
+    'campaigns': CampaignsGateway;
+};
+/**
+ * Parameters required to configure the SDK client.
+ * Each service configuration is optional, only provide the services you need.
+ */
 interface GatewayClientParams {
+    /** An Axios instance used as the HTTP client for all gateway requests. */
     axiosClient: AxiosInstance;
+    /** API token used for authentication across all services. */
     apiToken: string;
+    /** Configuration for each service gateway. Only the services you configure will be available. */
     services: {
-        customerService: {
+        customerService?: {
+            baseUrl: string;
+        };
+        chatConfig?: {
+            baseUrl: string;
+        };
+        campaigns?: {
             baseUrl: string;
         };
     };
 }
 
-declare enum SERVICE_GATEWAYS {
-    CUSTOMER_SERVICE = "customer-service"
-}
-
+/**
+ * Initializes the SDK with the required configuration parameters.
+ * Must be called before using {@link gateway}.
+ */
 declare const configure: (params: GatewayClientParams) => void;
-declare const gateway: (service: SERVICE_GATEWAYS) => CustomerServiceGateway;
+/**
+ * Returns the gateway instance for the specified service.
+ *
+ * @typeParam T - A service identifier key from {@link GatewayMap}.
+ * @param service - The service identifier (e.g. `SERVICE_GATEWAYS.CUSTOMER_SERVICE`).
+ * @returns The corresponding gateway instance with all its methods.
+ * @throws {Error} If the SDK has not been configured via {@link configure}.
+ * @throws {Error} If an unknown service identifier is provided.
+ *
+ * @example
+ * ```ts
+ * configure({ axiosClient, apiToken: '...', services: { customerService: { baseUrl: '...' } } });
+ * const customer = gateway('customer-service');
+ * const company = await customer.getCompanyById('123');
+ * ```
+ */
+declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
 export { configure, gateway };

package/dist/index.d.ts

@@ -1,47 +1,386 @@
 import { AxiosInstance } from 'axios';
 
+/** Shared company data fields returned by the Customer Service API. */
+interface CompanyData {
+    id: string;
+    name: string;
+    hostname: string;
+    crm_code: string;
+    token: string;
+    status: string;
+    timezone: string;
+    utc: string;
+    check_bad_password: boolean;
+    limit_bad_password: number;
+    watching: boolean;
+    trial: boolean;
+    support_widget_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a company. */
 interface CompanyResponse {
-    company: {
-        id: string;
+    company: CompanyData;
+}
+
+/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
+interface WorkGroup {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching the work groups list. */
+interface WorkGroupListResponse extends CompanyData {
+    workgroups: WorkGroup[];
+}
+/** A user membership entity nested within {@link WorkGroupResponse}. */
+interface WorkGroupMember {
+    id: string;
+    username: string;
+    email: string;
+    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
+    status: 'new' | 'activated' | 'disabled';
+    avatar: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a single work group. */
+interface WorkGroupResponse {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+    workgroups_users: WorkGroupMember[];
+}
+/** Response returned by the Customer Service API when fetching members of a work group. */
+type WorkGroupMembersResponse = WorkGroupMember[];
+
+/**
+ * Gateway for interacting with the Customer Service API.
+ */
+declare class CustomerServiceGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves a company by its unique identifier.
+     * @param companyId - The unique identifier of the company.
+     * @returns The company data wrapped in a {@link CompanyResponse}.
+     */
+    getCompanyById(companyId: string): Promise<CompanyResponse>;
+    /**
+     * Retrieves all work groups for a company.
+     * @param companyId - The unique identifier of the company.
+     * @returns The work groups for the given company.
+     */
+    getWorkGroups(companyId: string): Promise<WorkGroupListResponse>;
+    /**
+     * Retrieves a work group by its unique identifier.
+     * @param workGroupId - The unique identifier of the work group.
+     * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+     * @returns The work group data wrapped in a {@link WorkGroupResponse}.
+     */
+    getWorkGroupById(workGroupId: string, companyId?: string): Promise<WorkGroupResponse>;
+    /**
+     * Retrieves the members of a work group by its identifier.
+     * @param groupId - The unique identifier of the work group.
+     * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+     * @param profile - Filter members by profile (optional).
+     * @returns The members of the work group.
+     */
+    getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse>;
+}
+
+/** A provider entity returned by the Chat Config API. */
+interface Provider {
+    id: string;
+    name: string;
+    configurationsSchema: Record<string, unknown> | null;
+    defaultSession: number;
+    type: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Chat Config API when listing providers. */
+type ProviderListResponse = Provider[];
+
+/** A provider entity nested within a configuration response. */
+interface ConfigProvider {
+    id: string;
+    name: string;
+    type: string;
+    defaultSession: number;
+    configurationsSchema: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A configuration entity returned by the Chat Config API. */
+interface Config {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number | null;
+    companyId: string;
+    active: boolean;
+    configurations: Record<string, unknown>;
+    priority: number | null;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    providers: ConfigProvider;
+}
+/** Response returned by the Chat Config API when listing configurations by provider. */
+interface ConfigListByProviderResponse {
+    configurations: Config[];
+}
+/** Query parameters for filtering configurations by provider. */
+interface GetConfigsByProviderParams {
+    isAssistanceEnabled?: boolean;
+    rewind?: number;
+    active?: boolean;
+    priority?: number;
+    inbound?: boolean;
+    outbound?: boolean;
+    providerType?: string;
+    providerName?: string;
+}
+
+/**
+ * Gateway for interacting with the Chat Config API.
+ */
+declare class ChatConfigGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves all available providers.
+     * @returns The list of providers.
+     */
+    getProviders(): Promise<ProviderListResponse>;
+    /**
+     * Retrieves configurations filtered by provider.
+     * @param providerId - The unique identifier of the provider.
+     * @param params - Optional query parameters for filtering configurations.
+     * @returns The configurations for the given provider.
+     */
+    getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse>;
+}
+
+/** Campaign status literals. */
+type CampaignStatus = 'ongoing' | 'finished' | 'paused' | 'scheduled';
+/** Campaign provider literals. */
+type CampaignProvider = 'whatsapp';
+/** WhatsApp template component structure. */
+interface WhatsAppTemplateComponent {
+    type: string;
+    parameters: {
+        type: string;
+        text?: string;
+    }[];
+}
+/** WhatsApp payload used when dispatching campaign messages. */
+interface WhatsAppPayload {
+    template: {
         name: string;
-        hostname: string;
-        crm_code: string;
-        token: string;
+        components: WhatsAppTemplateComponent[];
+        language: string;
         status: string;
-        timezone: string;
-        utc: string;
-        check_bad_password: boolean;
-        limit_bad_password: number;
-        watching: boolean;
-        trial: boolean;
-        support_widget_id: string;
-        createdAt: string;
-        updatedAt: string;
+        category: string;
+        id: string;
     };
+    templateOptions: {
+        buttonsVariablesValues?: (string | null)[] | null;
+        bodyVariablesValues?: string[];
+        headerVariablesValues?: string[];
+        headerFileInfos?: {
+            filename: string;
+            fileUrl: string;
+            parsedFilename: string;
+        };
+    };
+}
+/** Contact filter applied when adding contacts to a campaign. */
+interface CampaignContactFilter {
+    excludeDeclinedMarketing?: boolean;
+}
+/** Schedule configuration for a campaign. */
+interface CampaignSchedule {
+    startAt?: string;
+    repeat?: {
+        delay?: number;
+        count?: number;
+        until?: string;
+    };
+}
+/** Campaign entity returned by the Campaigns API. */
+interface Campaign {
+    id: string;
+    sid: number;
+    companyId: string;
+    createdBy: string;
+    assignedTo: string;
+    name?: string;
+    provider: CampaignProvider;
+    providerId: number;
+    providerConfigId: string;
+    associatedRuleId?: string;
+    payload: WhatsAppPayload;
+    conversionRuleIds: string[];
+    status: CampaignStatus;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    failedCampaignAttempts: number;
+    queuedCampaignAttempts: number;
+    deliveredCampaignAttempts: number;
+    convertedCampaignAttempts: number;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+    schedule?: CampaignSchedule;
+}
+/** Paginated response returned by the Campaigns API for list endpoints. */
+interface CampaignPaginatedResponse {
+    total: number;
+    limit: number;
+    skip: number;
+    data: Campaign[];
+}
+/** Request payload for creating a campaign. */
+interface CreateCampaignRequest {
+    name: string;
+    payload: WhatsAppPayload;
+    provider: CampaignProvider;
+    companyId: string;
+    createdBy: string;
+    providerId: number;
+    providerConfigId: string;
+    schedule: CampaignSchedule;
+    associatedRuleId?: string;
+    assignedTo?: string;
+    expiresAt?: string;
+}
+/** Request payload for updating a campaign. */
+interface PatchCampaignRequest {
+    name?: string;
+    expiresAt?: string;
+    status?: CampaignStatus;
+    categoryId?: number;
+    contactFilter?: CampaignContactFilter;
+}
+/** Query parameters for listing campaigns. */
+interface CampaignQueryParams {
+    companyId?: string;
+    status?: CampaignStatus;
+    createdBy?: string;
+    assignedTo?: string;
+    name?: string;
+    limit?: number;
+    skip?: number;
 }
 
-declare class CustomerServiceGateway {
+/**
+ * Gateway for interacting with the Campaigns API.
+ */
+declare class CampaignsGateway {
     private readonly httpClient;
     private readonly baseUrl;
     constructor(httpClient: AxiosInstance, baseUrl: string);
-    getCompanyById(companyId: string): Promise<CompanyResponse>;
+    /**
+     * Retrieves a paginated list of campaigns.
+     * @param query - Optional query parameters for filtering and pagination.
+     * @returns The paginated campaigns response.
+     */
+    find(query?: CampaignQueryParams): Promise<CampaignPaginatedResponse>;
+    /**
+     * Retrieves a campaign by its unique identifier.
+     * @param id - The unique identifier of the campaign.
+     * @returns The campaign data.
+     */
+    get(id: string): Promise<Campaign>;
+    /**
+     * Creates a new campaign.
+     * @param payload - The campaign data to create.
+     * @returns The created campaign.
+     */
+    create(payload: CreateCampaignRequest): Promise<Campaign>;
+    /**
+     * Partially updates an existing campaign.
+     * @param id - The unique identifier of the campaign.
+     * @param payload - The fields to update.
+     * @returns The updated campaign.
+     */
+    patch(id: string, payload: PatchCampaignRequest): Promise<Campaign>;
+    /**
+     * Removes a campaign by its unique identifier.
+     * @param id - The unique identifier of the campaign.
+     * @returns The removed campaign.
+     */
+    remove(id: string): Promise<Campaign>;
 }
 
+/**
+ * Maps service identifiers to their corresponding gateway types.
+ * Used by the `gateway()` function to infer the correct return type
+ * based on the service name passed as argument.
+ *
+ * When adding a new service, add an entry here with the service
+ * identifier as the key and the gateway class as the value.
+ */
+type GatewayMap = {
+    'customer-service': CustomerServiceGateway;
+    'chat-config': ChatConfigGateway;
+    'campaigns': CampaignsGateway;
+};
+/**
+ * Parameters required to configure the SDK client.
+ * Each service configuration is optional, only provide the services you need.
+ */
 interface GatewayClientParams {
+    /** An Axios instance used as the HTTP client for all gateway requests. */
     axiosClient: AxiosInstance;
+    /** API token used for authentication across all services. */
     apiToken: string;
+    /** Configuration for each service gateway. Only the services you configure will be available. */
     services: {
-        customerService: {
+        customerService?: {
+            baseUrl: string;
+        };
+        chatConfig?: {
+            baseUrl: string;
+        };
+        campaigns?: {
             baseUrl: string;
         };
     };
 }
 
-declare enum SERVICE_GATEWAYS {
-    CUSTOMER_SERVICE = "customer-service"
-}
-
+/**
+ * Initializes the SDK with the required configuration parameters.
+ * Must be called before using {@link gateway}.
+ */
 declare const configure: (params: GatewayClientParams) => void;
-declare const gateway: (service: SERVICE_GATEWAYS) => CustomerServiceGateway;
+/**
+ * Returns the gateway instance for the specified service.
+ *
+ * @typeParam T - A service identifier key from {@link GatewayMap}.
+ * @param service - The service identifier (e.g. `SERVICE_GATEWAYS.CUSTOMER_SERVICE`).
+ * @returns The corresponding gateway instance with all its methods.
+ * @throws {Error} If the SDK has not been configured via {@link configure}.
+ * @throws {Error} If an unknown service identifier is provided.
+ *
+ * @example
+ * ```ts
+ * configure({ axiosClient, apiToken: '...', services: { customerService: { baseUrl: '...' } } });
+ * const customer = gateway('customer-service');
+ * const company = await customer.getCompanyById('123');
+ * ```
+ */
+declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
 export { configure, gateway };

package/dist/index.js

@@ -33,25 +33,175 @@ var CustomerServiceGateway = class {
   }
   httpClient;
   baseUrl;
+  /**
+   * Retrieves a company by its unique identifier.
+   * @param companyId - The unique identifier of the company.
+   * @returns The company data wrapped in a {@link CompanyResponse}.
+   */
   async getCompanyById(companyId) {
     const { data } = await this.httpClient.get(`${this.baseUrl}/companies/search/${companyId}`);
     return data;
   }
+  /**
+   * Retrieves all work groups for a company.
+   * @param companyId - The unique identifier of the company.
+   * @returns The work groups for the given company.
+   */
+  async getWorkGroups(companyId) {
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/companies/work-groups`,
+      { params: { company_id: companyId } }
+    );
+    return data;
+  }
+  /**
+   * Retrieves a work group by its unique identifier.
+   * @param workGroupId - The unique identifier of the work group.
+   * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+   * @returns The work group data wrapped in a {@link WorkGroupResponse}.
+   */
+  async getWorkGroupById(workGroupId, companyId) {
+    const params = companyId ? { company_id: companyId } : void 0;
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/companies/work-groups/${workGroupId}`,
+      { params }
+    );
+    return data;
+  }
+  /**
+   * Retrieves the members of a work group by its identifier.
+   * @param groupId - The unique identifier of the work group.
+   * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+   * @param profile - Filter members by profile (optional).
+   * @returns The members of the work group.
+   */
+  async getWorkGroupMembers(groupId, companyId, profile) {
+    const params = {};
+    if (companyId) params.company_id = companyId;
+    if (profile) params.profile = profile;
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/bonds/work-groups/${groupId}`,
+      { params }
+    );
+    return data;
+  }
+};
+
+// src/chat-config/index.ts
+var ChatConfigGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  /**
+   * Retrieves all available providers.
+   * @returns The list of providers.
+   */
+  async getProviders() {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/providers`);
+    return data;
+  }
+  /**
+   * Retrieves configurations filtered by provider.
+   * @param providerId - The unique identifier of the provider.
+   * @param params - Optional query parameters for filtering configurations.
+   * @returns The configurations for the given provider.
+   */
+  async getConfigsByProvider(providerId, params) {
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/config/provider/${providerId}`,
+      { params }
+    );
+    return data;
+  }
+};
+
+// src/campaigns/index.ts
+var CampaignsGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  /**
+   * Retrieves a paginated list of campaigns.
+   * @param query - Optional query parameters for filtering and pagination.
+   * @returns The paginated campaigns response.
+   */
+  async find(query) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/campaigns`, {
+      params: query
+    });
+    return data;
+  }
+  /**
+   * Retrieves a campaign by its unique identifier.
+   * @param id - The unique identifier of the campaign.
+   * @returns The campaign data.
+   */
+  async get(id) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/campaigns/${id}`);
+    return data;
+  }
+  /**
+   * Creates a new campaign.
+   * @param payload - The campaign data to create.
+   * @returns The created campaign.
+   */
+  async create(payload) {
+    const { data } = await this.httpClient.post(`${this.baseUrl}/campaigns`, payload);
+    return data;
+  }
+  /**
+   * Partially updates an existing campaign.
+   * @param id - The unique identifier of the campaign.
+   * @param payload - The fields to update.
+   * @returns The updated campaign.
+   */
+  async patch(id, payload) {
+    const { data } = await this.httpClient.patch(`${this.baseUrl}/campaigns/${id}`, payload);
+    return data;
+  }
+  /**
+   * Removes a campaign by its unique identifier.
+   * @param id - The unique identifier of the campaign.
+   * @returns The removed campaign.
+   */
+  async remove(id) {
+    const { data } = await this.httpClient.delete(`${this.baseUrl}/campaigns/${id}`);
+    return data;
+  }
 };
 
 // src/@common/client.ts
 var SDKGateways = class {
   customerService;
-  constructor(customerService) {
+  chatConfig;
+  campaigns;
+  constructor(customerService, chatConfig, campaigns) {
     this.customerService = customerService;
+    this.chatConfig = chatConfig;
+    this.campaigns = campaigns;
   }
 };
 function createClient(params) {
   const httpClient = params.axiosClient;
-  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);
-  return new SDKGateways(customerService);
+  const customerService = params.services.customerService ? new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl) : null;
+  const chatConfig = params.services.chatConfig ? new ChatConfigGateway(httpClient, params.services.chatConfig.baseUrl) : null;
+  const campaigns = params.services.campaigns ? new CampaignsGateway(httpClient, params.services.campaigns.baseUrl) : null;
+  return new SDKGateways(customerService, chatConfig, campaigns);
 }
 
+// src/@common/enums.ts
+var SERVICE_GATEWAYS = {
+  CUSTOMER_SERVICE: "customer-service",
+  CHAT_CONFIG: "chat-config",
+  CAMPAIGNS: "campaigns"
+};
+
 // src/index.ts
 var SDK = class {
   client = null;
@@ -63,18 +213,28 @@ var sdk = new SDK();
 var configure = (params) => {
   sdk.configure(params);
 };
-var gateway = (service) => {
+function gateway(service) {
   if (!sdk.client)
     throw new Error(
       "SDK not configured. Please call configure() with the appropriate parameters before using the SDK."
     );
   switch (service) {
-    case "customer-service" /* CUSTOMER_SERVICE */:
+    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:
+      if (!sdk.client.customerService)
+        throw new Error(`Service 'customer-service' is not configured. Provide its baseUrl in configure().`);
       return sdk.client.customerService;
+    case SERVICE_GATEWAYS.CHAT_CONFIG:
+      if (!sdk.client.chatConfig)
+        throw new Error(`Service 'chat-config' is not configured. Provide its baseUrl in configure().`);
+      return sdk.client.chatConfig;
+    case SERVICE_GATEWAYS.CAMPAIGNS:
+      if (!sdk.client.campaigns)
+        throw new Error(`Service 'campaigns' is not configured. Provide its baseUrl in configure().`);
+      return sdk.client.campaigns;
     default:
       throw new Error(`Unknown service gateway: ${service}`);
   }
-};
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   configure,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/customer-service/index.ts","../src/@common/client.ts"],"sourcesContent":["import { createClient, SDKGatewaysInterface, GatewayClientParams } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\nexport const gateway = (service: SERVICE_GATEWAYS) => {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      return sdk.client.customerService;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n};\n","import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\n\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n}\n\nexport type { CompanyResponse } from './contracts/company';\n","import { CustomerServiceGateway } from '../customer-service';\nimport { AxiosInstance } from 'axios';\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway;\n  constructor(customerService: CustomerServiceGateway) {\n    this.customerService = customerService;\n  }\n}\n\nexport interface GatewayClientParams {\n  axiosClient: AxiosInstance;\n  apiToken: string;\n  services: {\n    customerService: {\n      baseUrl: string;\n    };\n  };\n}\n\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);\n  return new SDKGateways(customerService);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACGO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA,EAGnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AACF;;;ACNA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA,YAAY,iBAAyC;AACnD,SAAK,kBAAkB;AAAA,EACzB;AACF;AAYO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO;AACtG,SAAO,IAAI,YAAY,eAAe;AACxC;;;AF1BA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAEb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAEO,IAAM,UAAU,CAAC,YAA8B;AACpD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf;AACE,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/customer-service/index.ts","../src/chat-config/index.ts","../src/campaigns/index.ts","../src/@common/client.ts","../src/@common/enums.ts"],"sourcesContent":["import { createClient, SDKGatewaysInterface, GatewayClientParams, GatewayMap } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\n\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\n/**\n * Initializes the SDK with the required configuration parameters.\n * Must be called before using {@link gateway}.\n */\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\n/**\n * Returns the gateway instance for the specified service.\n *\n * @typeParam T - A service identifier key from {@link GatewayMap}.\n * @param service - The service identifier (e.g. `SERVICE_GATEWAYS.CUSTOMER_SERVICE`).\n * @returns The corresponding gateway instance with all its methods.\n * @throws {Error} If the SDK has not been configured via {@link configure}.\n * @throws {Error} If an unknown service identifier is provided.\n *\n * @example\n * ```ts\n * configure({ axiosClient, apiToken: '...', services: { customerService: { baseUrl: '...' } } });\n * const customer = gateway('customer-service');\n * const company = await customer.getCompanyById('123');\n * ```\n */\nexport function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];\nexport function gateway(service: SERVICE_GATEWAYS) {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      if (!sdk.client.customerService)\n        throw new Error(`Service 'customer-service' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.customerService;\n    case SERVICE_GATEWAYS.CHAT_CONFIG:\n      if (!sdk.client.chatConfig)\n        throw new Error(`Service 'chat-config' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.chatConfig;\n    case SERVICE_GATEWAYS.CAMPAIGNS:\n      if (!sdk.client.campaigns)\n        throw new Error(`Service 'campaigns' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.campaigns;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n}\n","import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\nimport type { WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse } from './contracts/work-group';\n\n/**\n * Gateway for interacting with the Customer Service API.\n */\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves a company by its unique identifier.\n   * @param companyId - The unique identifier of the company.\n   * @returns The company data wrapped in a {@link CompanyResponse}.\n   */\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n\n  /**\n   * Retrieves all work groups for a company.\n   * @param companyId - The unique identifier of the company.\n   * @returns The work groups for the given company.\n   */\n  async getWorkGroups(companyId: string): Promise<WorkGroupListResponse> {\n    const { data } = await this.httpClient.get<WorkGroupListResponse>(\n      `${this.baseUrl}/companies/work-groups`,\n      { params: { company_id: companyId } },\n    );\n    return data;\n  }\n\n  /**\n   * Retrieves a work group by its unique identifier.\n   * @param workGroupId - The unique identifier of the work group.\n   * @param companyId - The unique identifier of the company (optional, sent as query parameter).\n   * @returns The work group data wrapped in a {@link WorkGroupResponse}.\n   */\n  async getWorkGroupById(workGroupId: string, companyId?: string): Promise<WorkGroupResponse> {\n    const params = companyId ? { company_id: companyId } : undefined;\n    const { data } = await this.httpClient.get<WorkGroupResponse>(\n      `${this.baseUrl}/companies/work-groups/${workGroupId}`,\n      { params },\n    );\n    return data;\n  }\n\n  /**\n   * Retrieves the members of a work group by its identifier.\n   * @param groupId - The unique identifier of the work group.\n   * @param companyId - The unique identifier of the company (optional, sent as query parameter).\n   * @param profile - Filter members by profile (optional).\n   * @returns The members of the work group.\n   */\n  async getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse> {\n    const params: { company_id?: string; profile?: string[] } = {};\n    if (companyId) params.company_id = companyId;\n    if (profile) params.profile = profile;\n    const { data } = await this.httpClient.get<WorkGroupMembersResponse>(\n      `${this.baseUrl}/bonds/work-groups/${groupId}`,\n      { params },\n    );\n    return data;\n  }\n}\n\nexport type { CompanyResponse, CompanyData } from './contracts/company';\nexport type { WorkGroup, WorkGroupMember, WorkGroupMembersResponse, WorkGroupListResponse, WorkGroupResponse } from './contracts/work-group';","import type { AxiosInstance } from 'axios';\nimport type { ProviderListResponse } from './contracts/provider';\nimport type { ConfigListByProviderResponse, GetConfigsByProviderParams } from './contracts/config';\n\n/**\n * Gateway for interacting with the Chat Config API.\n */\nexport class ChatConfigGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves all available providers.\n   * @returns The list of providers.\n   */\n  async getProviders(): Promise<ProviderListResponse> {\n    const { data } = await this.httpClient.get<ProviderListResponse>(`${this.baseUrl}/providers`);\n    return data;\n  }\n\n  /**\n   * Retrieves configurations filtered by provider.\n   * @param providerId - The unique identifier of the provider.\n   * @param params - Optional query parameters for filtering configurations.\n   * @returns The configurations for the given provider.\n   */\n  async getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse> {\n    const { data } = await this.httpClient.get<ConfigListByProviderResponse>(\n      `${this.baseUrl}/config/provider/${providerId}`,\n      { params },\n    );\n    return data;\n  }\n}\n\nexport type { ProviderListResponse, Provider } from './contracts/provider';\nexport type { ConfigListByProviderResponse, Config, ConfigProvider, GetConfigsByProviderParams } from './contracts/config';","import type { AxiosInstance } from 'axios';\nimport type {\n  Campaign,\n  CampaignPaginatedResponse,\n  CampaignQueryParams,\n  CreateCampaignRequest,\n  PatchCampaignRequest,\n} from './contracts/campaign';\n\n/**\n * Gateway for interacting with the Campaigns API.\n */\nexport class CampaignsGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves a paginated list of campaigns.\n   * @param query - Optional query parameters for filtering and pagination.\n   * @returns The paginated campaigns response.\n   */\n  async find(query?: CampaignQueryParams): Promise<CampaignPaginatedResponse> {\n    const { data } = await this.httpClient.get<CampaignPaginatedResponse>(`${this.baseUrl}/campaigns`, {\n      params: query,\n    });\n    return data;\n  }\n\n  /**\n   * Retrieves a campaign by its unique identifier.\n   * @param id - The unique identifier of the campaign.\n   * @returns The campaign data.\n   */\n  async get(id: string): Promise<Campaign> {\n    const { data } = await this.httpClient.get<Campaign>(`${this.baseUrl}/campaigns/${id}`);\n    return data;\n  }\n\n  /**\n   * Creates a new campaign.\n   * @param payload - The campaign data to create.\n   * @returns The created campaign.\n   */\n  async create(payload: CreateCampaignRequest): Promise<Campaign> {\n    const { data } = await this.httpClient.post<Campaign>(`${this.baseUrl}/campaigns`, payload);\n    return data;\n  }\n\n  /**\n   * Partially updates an existing campaign.\n   * @param id - The unique identifier of the campaign.\n   * @param payload - The fields to update.\n   * @returns The updated campaign.\n   */\n  async patch(id: string, payload: PatchCampaignRequest): Promise<Campaign> {\n    const { data } = await this.httpClient.patch<Campaign>(`${this.baseUrl}/campaigns/${id}`, payload);\n    return data;\n  }\n\n  /**\n   * Removes a campaign by its unique identifier.\n   * @param id - The unique identifier of the campaign.\n   * @returns The removed campaign.\n   */\n  async remove(id: string): Promise<Campaign> {\n    const { data } = await this.httpClient.delete<Campaign>(`${this.baseUrl}/campaigns/${id}`);\n    return data;\n  }\n}\n\nexport type {\n  Campaign,\n  CampaignPaginatedResponse,\n  CampaignQueryParams,\n  CampaignStatus,\n  CampaignProvider,\n  WhatsAppPayload,\n  WhatsAppTemplateComponent,\n  CampaignContactFilter,\n  CampaignSchedule,\n  CreateCampaignRequest,\n  PatchCampaignRequest,\n} from './contracts/campaign';","import { CustomerServiceGateway } from '../customer-service';\nimport { ChatConfigGateway } from '../chat-config';\nimport { CampaignsGateway } from '../campaigns';\nimport { AxiosInstance } from 'axios';\n\n/**\n * Maps service identifiers to their corresponding gateway types.\n * Used by the `gateway()` function to infer the correct return type\n * based on the service name passed as argument.\n *\n * When adding a new service, add an entry here with the service\n * identifier as the key and the gateway class as the value.\n */\nexport type GatewayMap = {\n  'customer-service': CustomerServiceGateway;\n  'chat-config': ChatConfigGateway;\n  'campaigns': CampaignsGateway;\n};\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway | null;\n  chatConfig: ChatConfigGateway | null;\n  campaigns: CampaignsGateway | null;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway | null;\n  chatConfig: ChatConfigGateway | null;\n  campaigns: CampaignsGateway | null;\n  constructor(customerService: CustomerServiceGateway | null, chatConfig: ChatConfigGateway | null, campaigns: CampaignsGateway | null) {\n    this.customerService = customerService;\n    this.chatConfig = chatConfig;\n    this.campaigns = campaigns;\n  }\n}\n\n/**\n * Parameters required to configure the SDK client.\n * Each service configuration is optional, only provide the services you need.\n */\nexport interface GatewayClientParams {\n  /** An Axios instance used as the HTTP client for all gateway requests. */\n  axiosClient: AxiosInstance;\n  /** API token used for authentication across all services. */\n  apiToken: string;\n  /** Configuration for each service gateway. Only the services you configure will be available. */\n  services: {\n    customerService?: {\n      baseUrl: string;\n    };\n    chatConfig?: {\n      baseUrl: string;\n    };\n    campaigns?: {\n      baseUrl: string;\n    };\n  };\n}\n\n/**\n * Creates an SDKGateways instance with all service gateways initialized\n * using the provided configuration parameters.\n * Services without configuration will be set to null and will throw\n * an error if accessed via `gateway()`.\n */\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = params.services.customerService\n    ? new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl)\n    : null;\n  const chatConfig = params.services.chatConfig\n    ? new ChatConfigGateway(httpClient, params.services.chatConfig.baseUrl)\n    : null;\n  const campaigns = params.services.campaigns\n    ? new CampaignsGateway(httpClient, params.services.campaigns.baseUrl)\n    : null;\n  return new SDKGateways(customerService, chatConfig, campaigns);\n}\n","export const SERVICE_GATEWAYS = {\n  CUSTOMER_SERVICE: 'customer-service',\n  CHAT_CONFIG: 'chat-config',\n  CAMPAIGNS: 'campaigns',\n} as const;\n\nexport type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACOO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,WAAmD;AACrE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO;AAAA,MACf,EAAE,QAAQ,EAAE,YAAY,UAAU,EAAE;AAAA,IACtC;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,iBAAiB,aAAqB,WAAgD;AAC1F,UAAM,SAAS,YAAY,EAAE,YAAY,UAAU,IAAI;AACvD,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,0BAA0B,WAAW;AAAA,MACpD,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,oBAAoB,SAAiB,WAAoB,SAAuD;AACpH,UAAM,SAAsD,CAAC;AAC7D,QAAI,UAAW,QAAO,aAAa;AACnC,QAAI,QAAS,QAAO,UAAU;AAC9B,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,sBAAsB,OAAO;AAAA,MAC5C,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AACF;;;AC7DO,IAAM,oBAAN,MAAwB;AAAA,EAC7B,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnB,MAAM,eAA8C;AAClD,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAA0B,GAAG,KAAK,OAAO,YAAY;AAC5F,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,qBAAqB,YAAoB,QAA4E;AACzH,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,oBAAoB,UAAU;AAAA,MAC7C,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AACF;;;ACvBO,IAAM,mBAAN,MAAuB;AAAA,EAC5B,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,MAAM,KAAK,OAAiE;AAC1E,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAA+B,GAAG,KAAK,OAAO,cAAc;AAAA,MACjG,QAAQ;AAAA,IACV,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,IAA+B;AACvC,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAc,GAAG,KAAK,OAAO,cAAc,EAAE,EAAE;AACtF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OAAO,SAAmD;AAC9D,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,KAAe,GAAG,KAAK,OAAO,cAAc,OAAO;AAC1F,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,IAAY,SAAkD;AACxE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,MAAgB,GAAG,KAAK,OAAO,cAAc,EAAE,IAAI,OAAO;AACjG,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OAAO,IAA+B;AAC1C,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,OAAiB,GAAG,KAAK,OAAO,cAAc,EAAE,EAAE;AACzF,WAAO;AAAA,EACT;AACF;;;AC7CA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA,YAAY,iBAAgD,YAAsC,WAAoC;AACpI,SAAK,kBAAkB;AACvB,SAAK,aAAa;AAClB,SAAK,YAAY;AAAA,EACnB;AACF;AA+BO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,OAAO,SAAS,kBACpC,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO,IAC9E;AACJ,QAAM,aAAa,OAAO,SAAS,aAC/B,IAAI,kBAAkB,YAAY,OAAO,SAAS,WAAW,OAAO,IACpE;AACJ,QAAM,YAAY,OAAO,SAAS,YAC9B,IAAI,iBAAiB,YAAY,OAAO,SAAS,UAAU,OAAO,IAClE;AACJ,SAAO,IAAI,YAAY,iBAAiB,YAAY,SAAS;AAC/D;;;AC7EO,IAAM,mBAAmB;AAAA,EAC9B,kBAAkB;AAAA,EAClB,aAAa;AAAA,EACb,WAAW;AACb;;;ALDA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAMb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAmBO,SAAS,QAAQ,SAA2B;AACjD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,mFAAmF;AACrG,aAAO,IAAI,OAAO;AAAA,IACpB,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,8EAA8E;AAChG,aAAO,IAAI,OAAO;AAAA,IACpB,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,4EAA4E;AAC9F,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}

package/dist/index.mjs

@@ -6,25 +6,175 @@ var CustomerServiceGateway = class {
   }
   httpClient;
   baseUrl;
+  /**
+   * Retrieves a company by its unique identifier.
+   * @param companyId - The unique identifier of the company.
+   * @returns The company data wrapped in a {@link CompanyResponse}.
+   */
   async getCompanyById(companyId) {
     const { data } = await this.httpClient.get(`${this.baseUrl}/companies/search/${companyId}`);
     return data;
   }
+  /**
+   * Retrieves all work groups for a company.
+   * @param companyId - The unique identifier of the company.
+   * @returns The work groups for the given company.
+   */
+  async getWorkGroups(companyId) {
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/companies/work-groups`,
+      { params: { company_id: companyId } }
+    );
+    return data;
+  }
+  /**
+   * Retrieves a work group by its unique identifier.
+   * @param workGroupId - The unique identifier of the work group.
+   * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+   * @returns The work group data wrapped in a {@link WorkGroupResponse}.
+   */
+  async getWorkGroupById(workGroupId, companyId) {
+    const params = companyId ? { company_id: companyId } : void 0;
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/companies/work-groups/${workGroupId}`,
+      { params }
+    );
+    return data;
+  }
+  /**
+   * Retrieves the members of a work group by its identifier.
+   * @param groupId - The unique identifier of the work group.
+   * @param companyId - The unique identifier of the company (optional, sent as query parameter).
+   * @param profile - Filter members by profile (optional).
+   * @returns The members of the work group.
+   */
+  async getWorkGroupMembers(groupId, companyId, profile) {
+    const params = {};
+    if (companyId) params.company_id = companyId;
+    if (profile) params.profile = profile;
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/bonds/work-groups/${groupId}`,
+      { params }
+    );
+    return data;
+  }
+};
+
+// src/chat-config/index.ts
+var ChatConfigGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  /**
+   * Retrieves all available providers.
+   * @returns The list of providers.
+   */
+  async getProviders() {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/providers`);
+    return data;
+  }
+  /**
+   * Retrieves configurations filtered by provider.
+   * @param providerId - The unique identifier of the provider.
+   * @param params - Optional query parameters for filtering configurations.
+   * @returns The configurations for the given provider.
+   */
+  async getConfigsByProvider(providerId, params) {
+    const { data } = await this.httpClient.get(
+      `${this.baseUrl}/config/provider/${providerId}`,
+      { params }
+    );
+    return data;
+  }
+};
+
+// src/campaigns/index.ts
+var CampaignsGateway = class {
+  constructor(httpClient, baseUrl) {
+    this.httpClient = httpClient;
+    this.baseUrl = baseUrl;
+  }
+  httpClient;
+  baseUrl;
+  /**
+   * Retrieves a paginated list of campaigns.
+   * @param query - Optional query parameters for filtering and pagination.
+   * @returns The paginated campaigns response.
+   */
+  async find(query) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/campaigns`, {
+      params: query
+    });
+    return data;
+  }
+  /**
+   * Retrieves a campaign by its unique identifier.
+   * @param id - The unique identifier of the campaign.
+   * @returns The campaign data.
+   */
+  async get(id) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/campaigns/${id}`);
+    return data;
+  }
+  /**
+   * Creates a new campaign.
+   * @param payload - The campaign data to create.
+   * @returns The created campaign.
+   */
+  async create(payload) {
+    const { data } = await this.httpClient.post(`${this.baseUrl}/campaigns`, payload);
+    return data;
+  }
+  /**
+   * Partially updates an existing campaign.
+   * @param id - The unique identifier of the campaign.
+   * @param payload - The fields to update.
+   * @returns The updated campaign.
+   */
+  async patch(id, payload) {
+    const { data } = await this.httpClient.patch(`${this.baseUrl}/campaigns/${id}`, payload);
+    return data;
+  }
+  /**
+   * Removes a campaign by its unique identifier.
+   * @param id - The unique identifier of the campaign.
+   * @returns The removed campaign.
+   */
+  async remove(id) {
+    const { data } = await this.httpClient.delete(`${this.baseUrl}/campaigns/${id}`);
+    return data;
+  }
 };
 
 // src/@common/client.ts
 var SDKGateways = class {
   customerService;
-  constructor(customerService) {
+  chatConfig;
+  campaigns;
+  constructor(customerService, chatConfig, campaigns) {
     this.customerService = customerService;
+    this.chatConfig = chatConfig;
+    this.campaigns = campaigns;
   }
 };
 function createClient(params) {
   const httpClient = params.axiosClient;
-  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);
-  return new SDKGateways(customerService);
+  const customerService = params.services.customerService ? new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl) : null;
+  const chatConfig = params.services.chatConfig ? new ChatConfigGateway(httpClient, params.services.chatConfig.baseUrl) : null;
+  const campaigns = params.services.campaigns ? new CampaignsGateway(httpClient, params.services.campaigns.baseUrl) : null;
+  return new SDKGateways(customerService, chatConfig, campaigns);
 }
 
+// src/@common/enums.ts
+var SERVICE_GATEWAYS = {
+  CUSTOMER_SERVICE: "customer-service",
+  CHAT_CONFIG: "chat-config",
+  CAMPAIGNS: "campaigns"
+};
+
 // src/index.ts
 var SDK = class {
   client = null;
@@ -36,18 +186,28 @@ var sdk = new SDK();
 var configure = (params) => {
   sdk.configure(params);
 };
-var gateway = (service) => {
+function gateway(service) {
   if (!sdk.client)
     throw new Error(
       "SDK not configured. Please call configure() with the appropriate parameters before using the SDK."
     );
   switch (service) {
-    case "customer-service" /* CUSTOMER_SERVICE */:
+    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:
+      if (!sdk.client.customerService)
+        throw new Error(`Service 'customer-service' is not configured. Provide its baseUrl in configure().`);
       return sdk.client.customerService;
+    case SERVICE_GATEWAYS.CHAT_CONFIG:
+      if (!sdk.client.chatConfig)
+        throw new Error(`Service 'chat-config' is not configured. Provide its baseUrl in configure().`);
+      return sdk.client.chatConfig;
+    case SERVICE_GATEWAYS.CAMPAIGNS:
+      if (!sdk.client.campaigns)
+        throw new Error(`Service 'campaigns' is not configured. Provide its baseUrl in configure().`);
+      return sdk.client.campaigns;
     default:
       throw new Error(`Unknown service gateway: ${service}`);
   }
-};
+}
 export {
   configure,
   gateway

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/customer-service/index.ts","../src/@common/client.ts","../src/index.ts"],"sourcesContent":["import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\n\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n}\n\nexport type { CompanyResponse } from './contracts/company';\n","import { CustomerServiceGateway } from '../customer-service';\nimport { AxiosInstance } from 'axios';\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway;\n  constructor(customerService: CustomerServiceGateway) {\n    this.customerService = customerService;\n  }\n}\n\nexport interface GatewayClientParams {\n  axiosClient: AxiosInstance;\n  apiToken: string;\n  services: {\n    customerService: {\n      baseUrl: string;\n    };\n  };\n}\n\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl);\n  return new SDKGateways(customerService);\n}\n","import { createClient, SDKGatewaysInterface, GatewayClientParams } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\nexport const gateway = (service: SERVICE_GATEWAYS) => {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      return sdk.client.customerService;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n};\n"],"mappings":";AAGO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA,EAGnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AACF;;;ACNA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA,YAAY,iBAAyC;AACnD,SAAK,kBAAkB;AAAA,EACzB;AACF;AAYO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO;AACtG,SAAO,IAAI,YAAY,eAAe;AACxC;;;AC1BA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAEb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAEO,IAAM,UAAU,CAAC,YAA8B;AACpD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf;AACE,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}
+{"version":3,"sources":["../src/customer-service/index.ts","../src/chat-config/index.ts","../src/campaigns/index.ts","../src/@common/client.ts","../src/@common/enums.ts","../src/index.ts"],"sourcesContent":["import type { AxiosInstance } from 'axios';\nimport type { CompanyResponse } from './contracts/company';\nimport type { WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse } from './contracts/work-group';\n\n/**\n * Gateway for interacting with the Customer Service API.\n */\nexport class CustomerServiceGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves a company by its unique identifier.\n   * @param companyId - The unique identifier of the company.\n   * @returns The company data wrapped in a {@link CompanyResponse}.\n   */\n  async getCompanyById(companyId: string): Promise<CompanyResponse> {\n    const { data } = await this.httpClient.get<CompanyResponse>(`${this.baseUrl}/companies/search/${companyId}`);\n    return data;\n  }\n\n  /**\n   * Retrieves all work groups for a company.\n   * @param companyId - The unique identifier of the company.\n   * @returns The work groups for the given company.\n   */\n  async getWorkGroups(companyId: string): Promise<WorkGroupListResponse> {\n    const { data } = await this.httpClient.get<WorkGroupListResponse>(\n      `${this.baseUrl}/companies/work-groups`,\n      { params: { company_id: companyId } },\n    );\n    return data;\n  }\n\n  /**\n   * Retrieves a work group by its unique identifier.\n   * @param workGroupId - The unique identifier of the work group.\n   * @param companyId - The unique identifier of the company (optional, sent as query parameter).\n   * @returns The work group data wrapped in a {@link WorkGroupResponse}.\n   */\n  async getWorkGroupById(workGroupId: string, companyId?: string): Promise<WorkGroupResponse> {\n    const params = companyId ? { company_id: companyId } : undefined;\n    const { data } = await this.httpClient.get<WorkGroupResponse>(\n      `${this.baseUrl}/companies/work-groups/${workGroupId}`,\n      { params },\n    );\n    return data;\n  }\n\n  /**\n   * Retrieves the members of a work group by its identifier.\n   * @param groupId - The unique identifier of the work group.\n   * @param companyId - The unique identifier of the company (optional, sent as query parameter).\n   * @param profile - Filter members by profile (optional).\n   * @returns The members of the work group.\n   */\n  async getWorkGroupMembers(groupId: string, companyId?: string, profile?: string[]): Promise<WorkGroupMembersResponse> {\n    const params: { company_id?: string; profile?: string[] } = {};\n    if (companyId) params.company_id = companyId;\n    if (profile) params.profile = profile;\n    const { data } = await this.httpClient.get<WorkGroupMembersResponse>(\n      `${this.baseUrl}/bonds/work-groups/${groupId}`,\n      { params },\n    );\n    return data;\n  }\n}\n\nexport type { CompanyResponse, CompanyData } from './contracts/company';\nexport type { WorkGroup, WorkGroupMember, WorkGroupMembersResponse, WorkGroupListResponse, WorkGroupResponse } from './contracts/work-group';","import type { AxiosInstance } from 'axios';\nimport type { ProviderListResponse } from './contracts/provider';\nimport type { ConfigListByProviderResponse, GetConfigsByProviderParams } from './contracts/config';\n\n/**\n * Gateway for interacting with the Chat Config API.\n */\nexport class ChatConfigGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves all available providers.\n   * @returns The list of providers.\n   */\n  async getProviders(): Promise<ProviderListResponse> {\n    const { data } = await this.httpClient.get<ProviderListResponse>(`${this.baseUrl}/providers`);\n    return data;\n  }\n\n  /**\n   * Retrieves configurations filtered by provider.\n   * @param providerId - The unique identifier of the provider.\n   * @param params - Optional query parameters for filtering configurations.\n   * @returns The configurations for the given provider.\n   */\n  async getConfigsByProvider(providerId: string, params?: GetConfigsByProviderParams): Promise<ConfigListByProviderResponse> {\n    const { data } = await this.httpClient.get<ConfigListByProviderResponse>(\n      `${this.baseUrl}/config/provider/${providerId}`,\n      { params },\n    );\n    return data;\n  }\n}\n\nexport type { ProviderListResponse, Provider } from './contracts/provider';\nexport type { ConfigListByProviderResponse, Config, ConfigProvider, GetConfigsByProviderParams } from './contracts/config';","import type { AxiosInstance } from 'axios';\nimport type {\n  Campaign,\n  CampaignPaginatedResponse,\n  CampaignQueryParams,\n  CreateCampaignRequest,\n  PatchCampaignRequest,\n} from './contracts/campaign';\n\n/**\n * Gateway for interacting with the Campaigns API.\n */\nexport class CampaignsGateway {\n  constructor(\n    private readonly httpClient: AxiosInstance,\n    private readonly baseUrl: string,\n  ) {}\n\n  /**\n   * Retrieves a paginated list of campaigns.\n   * @param query - Optional query parameters for filtering and pagination.\n   * @returns The paginated campaigns response.\n   */\n  async find(query?: CampaignQueryParams): Promise<CampaignPaginatedResponse> {\n    const { data } = await this.httpClient.get<CampaignPaginatedResponse>(`${this.baseUrl}/campaigns`, {\n      params: query,\n    });\n    return data;\n  }\n\n  /**\n   * Retrieves a campaign by its unique identifier.\n   * @param id - The unique identifier of the campaign.\n   * @returns The campaign data.\n   */\n  async get(id: string): Promise<Campaign> {\n    const { data } = await this.httpClient.get<Campaign>(`${this.baseUrl}/campaigns/${id}`);\n    return data;\n  }\n\n  /**\n   * Creates a new campaign.\n   * @param payload - The campaign data to create.\n   * @returns The created campaign.\n   */\n  async create(payload: CreateCampaignRequest): Promise<Campaign> {\n    const { data } = await this.httpClient.post<Campaign>(`${this.baseUrl}/campaigns`, payload);\n    return data;\n  }\n\n  /**\n   * Partially updates an existing campaign.\n   * @param id - The unique identifier of the campaign.\n   * @param payload - The fields to update.\n   * @returns The updated campaign.\n   */\n  async patch(id: string, payload: PatchCampaignRequest): Promise<Campaign> {\n    const { data } = await this.httpClient.patch<Campaign>(`${this.baseUrl}/campaigns/${id}`, payload);\n    return data;\n  }\n\n  /**\n   * Removes a campaign by its unique identifier.\n   * @param id - The unique identifier of the campaign.\n   * @returns The removed campaign.\n   */\n  async remove(id: string): Promise<Campaign> {\n    const { data } = await this.httpClient.delete<Campaign>(`${this.baseUrl}/campaigns/${id}`);\n    return data;\n  }\n}\n\nexport type {\n  Campaign,\n  CampaignPaginatedResponse,\n  CampaignQueryParams,\n  CampaignStatus,\n  CampaignProvider,\n  WhatsAppPayload,\n  WhatsAppTemplateComponent,\n  CampaignContactFilter,\n  CampaignSchedule,\n  CreateCampaignRequest,\n  PatchCampaignRequest,\n} from './contracts/campaign';","import { CustomerServiceGateway } from '../customer-service';\nimport { ChatConfigGateway } from '../chat-config';\nimport { CampaignsGateway } from '../campaigns';\nimport { AxiosInstance } from 'axios';\n\n/**\n * Maps service identifiers to their corresponding gateway types.\n * Used by the `gateway()` function to infer the correct return type\n * based on the service name passed as argument.\n *\n * When adding a new service, add an entry here with the service\n * identifier as the key and the gateway class as the value.\n */\nexport type GatewayMap = {\n  'customer-service': CustomerServiceGateway;\n  'chat-config': ChatConfigGateway;\n  'campaigns': CampaignsGateway;\n};\n\nexport interface SDKGatewaysInterface {\n  customerService: CustomerServiceGateway | null;\n  chatConfig: ChatConfigGateway | null;\n  campaigns: CampaignsGateway | null;\n}\n\nclass SDKGateways {\n  customerService: CustomerServiceGateway | null;\n  chatConfig: ChatConfigGateway | null;\n  campaigns: CampaignsGateway | null;\n  constructor(customerService: CustomerServiceGateway | null, chatConfig: ChatConfigGateway | null, campaigns: CampaignsGateway | null) {\n    this.customerService = customerService;\n    this.chatConfig = chatConfig;\n    this.campaigns = campaigns;\n  }\n}\n\n/**\n * Parameters required to configure the SDK client.\n * Each service configuration is optional, only provide the services you need.\n */\nexport interface GatewayClientParams {\n  /** An Axios instance used as the HTTP client for all gateway requests. */\n  axiosClient: AxiosInstance;\n  /** API token used for authentication across all services. */\n  apiToken: string;\n  /** Configuration for each service gateway. Only the services you configure will be available. */\n  services: {\n    customerService?: {\n      baseUrl: string;\n    };\n    chatConfig?: {\n      baseUrl: string;\n    };\n    campaigns?: {\n      baseUrl: string;\n    };\n  };\n}\n\n/**\n * Creates an SDKGateways instance with all service gateways initialized\n * using the provided configuration parameters.\n * Services without configuration will be set to null and will throw\n * an error if accessed via `gateway()`.\n */\nexport function createClient(params: GatewayClientParams) {\n  const httpClient = params.axiosClient;\n  const customerService = params.services.customerService\n    ? new CustomerServiceGateway(httpClient, params.services.customerService.baseUrl)\n    : null;\n  const chatConfig = params.services.chatConfig\n    ? new ChatConfigGateway(httpClient, params.services.chatConfig.baseUrl)\n    : null;\n  const campaigns = params.services.campaigns\n    ? new CampaignsGateway(httpClient, params.services.campaigns.baseUrl)\n    : null;\n  return new SDKGateways(customerService, chatConfig, campaigns);\n}\n","export const SERVICE_GATEWAYS = {\n  CUSTOMER_SERVICE: 'customer-service',\n  CHAT_CONFIG: 'chat-config',\n  CAMPAIGNS: 'campaigns',\n} as const;\n\nexport type SERVICE_GATEWAYS = (typeof SERVICE_GATEWAYS)[keyof typeof SERVICE_GATEWAYS];\n","import { createClient, SDKGatewaysInterface, GatewayClientParams, GatewayMap } from './@common/client';\nimport { SERVICE_GATEWAYS } from './@common/enums';\n\nclass SDK {\n  client: SDKGatewaysInterface | null = null;\n\n  configure(params: GatewayClientParams) {\n    this.client = createClient(params);\n  }\n}\nconst sdk = new SDK();\n\n/**\n * Initializes the SDK with the required configuration parameters.\n * Must be called before using {@link gateway}.\n */\nexport const configure = (params: GatewayClientParams) => {\n  sdk.configure(params);\n};\n\n/**\n * Returns the gateway instance for the specified service.\n *\n * @typeParam T - A service identifier key from {@link GatewayMap}.\n * @param service - The service identifier (e.g. `SERVICE_GATEWAYS.CUSTOMER_SERVICE`).\n * @returns The corresponding gateway instance with all its methods.\n * @throws {Error} If the SDK has not been configured via {@link configure}.\n * @throws {Error} If an unknown service identifier is provided.\n *\n * @example\n * ```ts\n * configure({ axiosClient, apiToken: '...', services: { customerService: { baseUrl: '...' } } });\n * const customer = gateway('customer-service');\n * const company = await customer.getCompanyById('123');\n * ```\n */\nexport function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];\nexport function gateway(service: SERVICE_GATEWAYS) {\n  if (!sdk.client)\n    throw new Error(\n      'SDK not configured. Please call configure() with the appropriate parameters before using the SDK.',\n    );\n\n  switch (service) {\n    case SERVICE_GATEWAYS.CUSTOMER_SERVICE:\n      if (!sdk.client.customerService)\n        throw new Error(`Service 'customer-service' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.customerService;\n    case SERVICE_GATEWAYS.CHAT_CONFIG:\n      if (!sdk.client.chatConfig)\n        throw new Error(`Service 'chat-config' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.chatConfig;\n    case SERVICE_GATEWAYS.CAMPAIGNS:\n      if (!sdk.client.campaigns)\n        throw new Error(`Service 'campaigns' is not configured. Provide its baseUrl in configure().`);\n      return sdk.client.campaigns;\n    default:\n      throw new Error(`Unknown service gateway: ${service}`);\n  }\n}\n"],"mappings":";AAOO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,MAAM,eAAe,WAA6C;AAChE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAqB,GAAG,KAAK,OAAO,qBAAqB,SAAS,EAAE;AAC3G,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,cAAc,WAAmD;AACrE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO;AAAA,MACf,EAAE,QAAQ,EAAE,YAAY,UAAU,EAAE;AAAA,IACtC;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,iBAAiB,aAAqB,WAAgD;AAC1F,UAAM,SAAS,YAAY,EAAE,YAAY,UAAU,IAAI;AACvD,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,0BAA0B,WAAW;AAAA,MACpD,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,oBAAoB,SAAiB,WAAoB,SAAuD;AACpH,UAAM,SAAsD,CAAC;AAC7D,QAAI,UAAW,QAAO,aAAa;AACnC,QAAI,QAAS,QAAO,UAAU;AAC9B,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,sBAAsB,OAAO;AAAA,MAC5C,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AACF;;;AC7DO,IAAM,oBAAN,MAAwB;AAAA,EAC7B,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnB,MAAM,eAA8C;AAClD,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAA0B,GAAG,KAAK,OAAO,YAAY;AAC5F,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,qBAAqB,YAAoB,QAA4E;AACzH,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW;AAAA,MACrC,GAAG,KAAK,OAAO,oBAAoB,UAAU;AAAA,MAC7C,EAAE,OAAO;AAAA,IACX;AACA,WAAO;AAAA,EACT;AACF;;;ACvBO,IAAM,mBAAN,MAAuB;AAAA,EAC5B,YACmB,YACA,SACjB;AAFiB;AACA;AAAA,EAChB;AAAA,EAFgB;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQnB,MAAM,KAAK,OAAiE;AAC1E,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAA+B,GAAG,KAAK,OAAO,cAAc;AAAA,MACjG,QAAQ;AAAA,IACV,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,IAAI,IAA+B;AACvC,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,IAAc,GAAG,KAAK,OAAO,cAAc,EAAE,EAAE;AACtF,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OAAO,SAAmD;AAC9D,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,KAAe,GAAG,KAAK,OAAO,cAAc,OAAO;AAC1F,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,IAAY,SAAkD;AACxE,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,MAAgB,GAAG,KAAK,OAAO,cAAc,EAAE,IAAI,OAAO;AACjG,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,OAAO,IAA+B;AAC1C,UAAM,EAAE,KAAK,IAAI,MAAM,KAAK,WAAW,OAAiB,GAAG,KAAK,OAAO,cAAc,EAAE,EAAE;AACzF,WAAO;AAAA,EACT;AACF;;;AC7CA,IAAM,cAAN,MAAkB;AAAA,EAChB;AAAA,EACA;AAAA,EACA;AAAA,EACA,YAAY,iBAAgD,YAAsC,WAAoC;AACpI,SAAK,kBAAkB;AACvB,SAAK,aAAa;AAClB,SAAK,YAAY;AAAA,EACnB;AACF;AA+BO,SAAS,aAAa,QAA6B;AACxD,QAAM,aAAa,OAAO;AAC1B,QAAM,kBAAkB,OAAO,SAAS,kBACpC,IAAI,uBAAuB,YAAY,OAAO,SAAS,gBAAgB,OAAO,IAC9E;AACJ,QAAM,aAAa,OAAO,SAAS,aAC/B,IAAI,kBAAkB,YAAY,OAAO,SAAS,WAAW,OAAO,IACpE;AACJ,QAAM,YAAY,OAAO,SAAS,YAC9B,IAAI,iBAAiB,YAAY,OAAO,SAAS,UAAU,OAAO,IAClE;AACJ,SAAO,IAAI,YAAY,iBAAiB,YAAY,SAAS;AAC/D;;;AC7EO,IAAM,mBAAmB;AAAA,EAC9B,kBAAkB;AAAA,EAClB,aAAa;AAAA,EACb,WAAW;AACb;;;ACDA,IAAM,MAAN,MAAU;AAAA,EACR,SAAsC;AAAA,EAEtC,UAAU,QAA6B;AACrC,SAAK,SAAS,aAAa,MAAM;AAAA,EACnC;AACF;AACA,IAAM,MAAM,IAAI,IAAI;AAMb,IAAM,YAAY,CAAC,WAAgC;AACxD,MAAI,UAAU,MAAM;AACtB;AAmBO,SAAS,QAAQ,SAA2B;AACjD,MAAI,CAAC,IAAI;AACP,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAEF,UAAQ,SAAS;AAAA,IACf,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,mFAAmF;AACrG,aAAO,IAAI,OAAO;AAAA,IACpB,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,8EAA8E;AAChG,aAAO,IAAI,OAAO;AAAA,IACpB,KAAK,iBAAiB;AACpB,UAAI,CAAC,IAAI,OAAO;AACd,cAAM,IAAI,MAAM,4EAA4E;AAC9F,aAAO,IAAI,OAAO;AAAA,IACpB;AACE,YAAM,IAAI,MAAM,4BAA4B,OAAO,EAAE;AAAA,EACzD;AACF;","names":[]}

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A simple package to help with some common tasks",
   "name": "@opens/gateways",
   "private": false,