@opens/gateways 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -1,47 +1,441 @@
 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;
+}
+
+interface QueueMember {
+    id: string;
+    memberId: string;
+    priority: number;
+    permission: string;
+    lastAttendance: string;
+    lastInvite: string;
+    paused: boolean;
+    activeChat: number;
+    online: boolean;
+    companyId: string;
+    avatar: string;
+    username: string;
+    createdAt: string;
+    updatedAt: string;
+    queueId: string;
+}
+type DistributionType = {
+    id: string;
+    alias: string;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+};
+interface Queue {
+    id: string;
+    distributionTypeId: string;
+    companyId: string;
+    name: string;
+    strategy: 'leastrecent' | 'roundrobin' | 'random';
+    defaultQueue: boolean;
+    unlimitedService: boolean;
+    serviceLimit: number;
+    timeLimit: number;
+    skipOncallUsers: boolean;
+    csat: boolean;
+    csatAnswer: string;
+    csatTTL: number;
+    outsideBusinessHourMessage: string;
+    createCallbackOnExpired: boolean;
+    createCallbackOnOutsideBusinessHours: boolean;
+    archived: boolean;
+    isPrivate: boolean;
+    createdAt: string;
+    updatedAt: string;
+    members: QueueMember[];
+    distributionType: DistributionType;
+}
+
+/**
+ * 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>;
+    /**
+     * Retrieves a queue by its ID.
+     * @param queueId - The unique identifier of the queue.
+     * @returns The queue data.
+     */
+    getQueueById(queueId: string): Promise<Queue>;
+}
+
+/** 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 };
+export { type Campaign, type CampaignContactFilter, type CampaignPaginatedResponse, type CampaignProvider, type CampaignQueryParams, type CampaignSchedule, type CampaignStatus, type CompanyData, type CompanyResponse, type Config, type ConfigListByProviderResponse, type ConfigProvider, type CreateCampaignRequest, type DistributionType, type GetConfigsByProviderParams, type PatchCampaignRequest, type Provider, type ProviderListResponse, type Queue, type QueueMember, type WhatsAppPayload, type WhatsAppTemplateComponent, type WorkGroup, type WorkGroupListResponse, type WorkGroupMember, type WorkGroupMembersResponse, type WorkGroupResponse, configure, gateway };

package/dist/index.js

@@ -33,25 +33,184 @@ 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;
+  }
+  /**
+   * Retrieves a queue by its ID.
+   * @param queueId - The unique identifier of the queue.
+   * @returns The queue data.
+   */
+  async getQueueById(queueId) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/queue/${queueId}`);
+    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 +222,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,