@opens/gateways 1.11.6 → 1.12.0

package/dist/chat-config/contracts/index.d.mts

@@ -1,4 +1,3 @@
-/** A provider entity returned by the Chat Config API. */
 interface Provider {
     id: string;
     name: string;
@@ -8,8 +7,129 @@ interface Provider {
     createdAt: string;
     updatedAt: string;
 }
-/** Response returned by the Chat Config API when listing providers. */
 type ProviderListResponse = Provider[];
+interface GetProviderConfigurationsParams {
+    id: string | string[];
+}
+interface WhatsAppProviderSettings {
+    pin: string;
+    csat: boolean;
+    phone: string;
+    wabaId: string;
+    csatTTL: number;
+    isEnabledMarketingMessagesAPI: boolean;
+    phoneId: string;
+    appToken: string;
+    csatAnswer: string;
+    debugToken: string;
+    accessToken: string;
+    alias: string;
+}
+interface WidgetProviderFunctionValues<TValue> {
+    chat: TValue;
+    voice: TValue;
+    whatsapp: TValue;
+}
+interface WidgetProviderFunctions extends WidgetProviderFunctionValues<boolean> {
+    voice_in_chat: boolean;
+}
+interface WidgetProviderAuthSettings {
+    name: boolean;
+    nameValidationQuestion: string;
+    phone: boolean;
+    phoneValidationQuestion: string;
+    email: boolean;
+    emailValidationQuestion: string;
+    company: boolean;
+    subject: boolean;
+    cpfValidationQuestion: string;
+}
+interface WidgetProviderVoiceConfiguration {
+    id: number;
+    attendanceGroupId: string;
+    voiceTimeout: number;
+    description: string;
+    surname: string;
+    icon: string;
+}
+interface WidgetProviderThemeColors {
+    primary: string;
+    secondary: string;
+    accent: string;
+    neutral: string;
+}
+interface WidgetProviderThemeSettings {
+    name: string;
+    hexColors: WidgetProviderThemeColors;
+    tailwindColors: WidgetProviderThemeColors;
+    textColor: string;
+    type: string;
+}
+interface WidgetProviderWhatsappSettings {
+    phone: string;
+}
+interface WidgetProviderSettings {
+    name: string;
+    type: string;
+    hidePoweredByOpens: boolean;
+    showToClientEndChatOption: boolean;
+    showToClientRecordAudioOption: boolean;
+    hideBottomNavigation: boolean;
+    hideCloseButton: boolean;
+    openYuniqueWidget: boolean;
+    fontChoice: string;
+    useLogoAsUserImage: boolean;
+    removeFileButton: boolean;
+    position: string;
+    positionMarginLeft: number;
+    positionMarginTop: number;
+    iconImage: string;
+    customIconImage: string;
+    functionsIcons: WidgetProviderFunctionValues<string>;
+    functionsIconsDisplays: WidgetProviderFunctionValues<boolean>;
+    functionsDescriptions: WidgetProviderFunctionValues<string>;
+    functionsNames: WidgetProviderFunctionValues<string>;
+    functionsColors: WidgetProviderFunctionValues<string>;
+    functions: WidgetProviderFunctions;
+    auth: WidgetProviderAuthSettings;
+    initialFlow: boolean;
+    initialFlowId: string | null;
+    textVoiceLines: string[];
+    voiceConfig: Record<string, WidgetProviderVoiceConfiguration>;
+    iconSize: string;
+    theme: WidgetProviderThemeSettings;
+    flow?: any;
+    locale: string;
+    voiceRemoteAddress: string;
+    voiceDevice: string;
+    voiceCode: string;
+    buttonType: string;
+    whatsapp: WidgetProviderWhatsappSettings;
+    customButtonIcon: string;
+    logoUrl: string;
+}
+/** A provider configuration entity returned by the Chat Config API. */
+type ProviderConfiguration = {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number;
+    companyId: string;
+    active: boolean;
+    priority: number | null;
+    providerId: string;
+    configurations: WhatsAppProviderSettings | WidgetProviderSettings;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    csatConditionalRulesEnabled: boolean;
+    csatFeedbackTTL: number | null;
+    createdAt: string;
+    updatedAt: string;
+};
+/** Response returned by the Chat Config API when listing provider configurations. */
+interface ProviderConfigurationsResponse {
+    data: ProviderConfiguration[];
+}
 
 /** A provider entity nested within a configuration response. */
 interface ConfigProvider {
@@ -106,10 +226,17 @@ interface Queue {
     members: QueueMember[];
     distributionType: DistributionType;
 }
-/** Response returned when listing queues. */
 interface QueueListResponse {
     queues: Queue[];
 }
+interface GetServiceGroupsParams {
+    id: string | string[];
+}
+interface ServiceGroup extends Queue {
+}
+interface ServiceGroupsResponse {
+    data: ServiceGroup[];
+}
 
 /** Representation of a button in a Meta template. */
 interface MetaTemplateButton {
@@ -225,4 +352,4 @@ type RootRulesResponse = {
     data: Rule[];
 };
 
-export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetRootRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };

package/dist/chat-config/contracts/index.d.ts

@@ -1,4 +1,3 @@
-/** A provider entity returned by the Chat Config API. */
 interface Provider {
     id: string;
     name: string;
@@ -8,8 +7,129 @@ interface Provider {
     createdAt: string;
     updatedAt: string;
 }
-/** Response returned by the Chat Config API when listing providers. */
 type ProviderListResponse = Provider[];
+interface GetProviderConfigurationsParams {
+    id: string | string[];
+}
+interface WhatsAppProviderSettings {
+    pin: string;
+    csat: boolean;
+    phone: string;
+    wabaId: string;
+    csatTTL: number;
+    isEnabledMarketingMessagesAPI: boolean;
+    phoneId: string;
+    appToken: string;
+    csatAnswer: string;
+    debugToken: string;
+    accessToken: string;
+    alias: string;
+}
+interface WidgetProviderFunctionValues<TValue> {
+    chat: TValue;
+    voice: TValue;
+    whatsapp: TValue;
+}
+interface WidgetProviderFunctions extends WidgetProviderFunctionValues<boolean> {
+    voice_in_chat: boolean;
+}
+interface WidgetProviderAuthSettings {
+    name: boolean;
+    nameValidationQuestion: string;
+    phone: boolean;
+    phoneValidationQuestion: string;
+    email: boolean;
+    emailValidationQuestion: string;
+    company: boolean;
+    subject: boolean;
+    cpfValidationQuestion: string;
+}
+interface WidgetProviderVoiceConfiguration {
+    id: number;
+    attendanceGroupId: string;
+    voiceTimeout: number;
+    description: string;
+    surname: string;
+    icon: string;
+}
+interface WidgetProviderThemeColors {
+    primary: string;
+    secondary: string;
+    accent: string;
+    neutral: string;
+}
+interface WidgetProviderThemeSettings {
+    name: string;
+    hexColors: WidgetProviderThemeColors;
+    tailwindColors: WidgetProviderThemeColors;
+    textColor: string;
+    type: string;
+}
+interface WidgetProviderWhatsappSettings {
+    phone: string;
+}
+interface WidgetProviderSettings {
+    name: string;
+    type: string;
+    hidePoweredByOpens: boolean;
+    showToClientEndChatOption: boolean;
+    showToClientRecordAudioOption: boolean;
+    hideBottomNavigation: boolean;
+    hideCloseButton: boolean;
+    openYuniqueWidget: boolean;
+    fontChoice: string;
+    useLogoAsUserImage: boolean;
+    removeFileButton: boolean;
+    position: string;
+    positionMarginLeft: number;
+    positionMarginTop: number;
+    iconImage: string;
+    customIconImage: string;
+    functionsIcons: WidgetProviderFunctionValues<string>;
+    functionsIconsDisplays: WidgetProviderFunctionValues<boolean>;
+    functionsDescriptions: WidgetProviderFunctionValues<string>;
+    functionsNames: WidgetProviderFunctionValues<string>;
+    functionsColors: WidgetProviderFunctionValues<string>;
+    functions: WidgetProviderFunctions;
+    auth: WidgetProviderAuthSettings;
+    initialFlow: boolean;
+    initialFlowId: string | null;
+    textVoiceLines: string[];
+    voiceConfig: Record<string, WidgetProviderVoiceConfiguration>;
+    iconSize: string;
+    theme: WidgetProviderThemeSettings;
+    flow?: any;
+    locale: string;
+    voiceRemoteAddress: string;
+    voiceDevice: string;
+    voiceCode: string;
+    buttonType: string;
+    whatsapp: WidgetProviderWhatsappSettings;
+    customButtonIcon: string;
+    logoUrl: string;
+}
+/** A provider configuration entity returned by the Chat Config API. */
+type ProviderConfiguration = {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number;
+    companyId: string;
+    active: boolean;
+    priority: number | null;
+    providerId: string;
+    configurations: WhatsAppProviderSettings | WidgetProviderSettings;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    csatConditionalRulesEnabled: boolean;
+    csatFeedbackTTL: number | null;
+    createdAt: string;
+    updatedAt: string;
+};
+/** Response returned by the Chat Config API when listing provider configurations. */
+interface ProviderConfigurationsResponse {
+    data: ProviderConfiguration[];
+}
 
 /** A provider entity nested within a configuration response. */
 interface ConfigProvider {
@@ -106,10 +226,17 @@ interface Queue {
     members: QueueMember[];
     distributionType: DistributionType;
 }
-/** Response returned when listing queues. */
 interface QueueListResponse {
     queues: Queue[];
 }
+interface GetServiceGroupsParams {
+    id: string | string[];
+}
+interface ServiceGroup extends Queue {
+}
+interface ServiceGroupsResponse {
+    data: ServiceGroup[];
+}
 
 /** Representation of a button in a Meta template. */
 interface MetaTemplateButton {
@@ -225,4 +352,4 @@ type RootRulesResponse = {
     data: Rule[];
 };
 
-export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetRootRulesRequest, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule };
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetRootRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse } from './customer-service/contracts/index.mjs';
 export { CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
-import { ProviderListResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
-export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, QueueListResponse, Rule } from './chat-config/contracts/index.mjs';
+import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
+export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup } from './campaigns/contracts/index.mjs';
 export { CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.mjs';
 import { GetConfigTemplatesParams, GetConfigTemplatesResponse } from './chat-adapter/contracts/index.mjs';
@@ -11,6 +11,8 @@ import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertRespons
 export { IUploadPresignedUrlResponse } from './assets/contracts/index.mjs';
 import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse } from './contact-list/contracts/index.mjs';
 export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
+import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.mjs';
+export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.mjs';
 import { ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse } from './chat-webservice/contracts/index.mjs';
 export { RoomActiveDates, RoomMemberResponse, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
 import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.mjs';
@@ -66,6 +68,12 @@ declare class ChatConfigGateway {
      * @returns The list of providers.
      */
     getProviders(): Promise<ProviderListResponse>;
+    /**
+     * Retrieves provider configurations filtered by configuration IDs.
+     * @param params - Query parameters containing one or more configuration IDs.
+     * @returns The provider configurations matching the given IDs.
+     */
+    getProviderConfigurations(params?: GetProviderConfigurationsParams): Promise<ProviderConfigurationsResponse>;
     /**
      * Retrieves configurations filtered by provider.
      * @param providerId - The unique identifier of the provider.
@@ -86,6 +94,12 @@ declare class ChatConfigGateway {
      * @returns The queue memberships for the given member.
      */
     getMemberQueues(params: GetMemberQueuesRequest): Promise<QueueMember[]>;
+    /**
+     * Retrieves service groups filtered by service group IDs.
+     * @param params - Query parameters containing one or more service group IDs.
+     * @returns The service groups matching the given IDs.
+     */
+    getServiceGroups(params?: GetServiceGroupsParams): Promise<ServiceGroupsResponse>;
     /**
      * Retrieves a Meta template configuration by its ID.
      * @param templateId - The unique identifier of the template.
@@ -262,6 +276,77 @@ declare class ContactListGateway {
     getCategoryList(): Promise<ContactCategoryResponse[]>;
 }
 
+/**
+ * Gateway for interacting with the Integrations API.
+ */
+declare class IntegrationsGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves all integration partners configured for a company.
+     * @param companyId - The company identifier.
+     * @returns The integration partners configured for the company.
+     */
+    getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
+    /**
+     * Retrieves the hook catalog, optionally scoped by module.
+     * @param module - The optional module identifier used by the Integrations API filter.
+     * @returns The hook catalog items, filtered by module when provided.
+     */
+    getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
+    /**
+     * Creates an integration partner.
+     * @param payload - The partner creation payload.
+     * @returns The created integration partner.
+     */
+    createPartner(payload: CreateIntegrationPartnerRequest): Promise<IntegrationPartner>;
+    /**
+     * Deletes an integration partner.
+     * @param partnerId - The partner identifier.
+     * @returns A promise that resolves when the partner is deleted.
+     */
+    deletePartner({ partnerId }: DeleteIntegrationPartnerParams): Promise<void>;
+    /**
+     * Creates an integration action.
+     * @param payload - The action creation payload.
+     * @returns The created integration action.
+     */
+    createAction(payload: CreateIntegrationActionRequest): Promise<IntegrationAction>;
+    /**
+     * Updates an integration action.
+     * @param actionId - The action identifier.
+     * @param payload - The action update payload.
+     * @returns The updated integration action.
+     */
+    updateAction({ actionId, payload }: UpdateIntegrationActionParams): Promise<IntegrationAction>;
+    /**
+     * Creates an integration action field/header.
+     * @param payload - The field creation payload.
+     * @returns The created integration field.
+     */
+    createField(payload: CreateIntegrationFieldRequest): Promise<IntegrationField>;
+    /**
+     * Updates an integration action field/header.
+     * @param fieldId - The field identifier.
+     * @param payload - The field update payload.
+     * @returns The updated integration field response.
+     */
+    updateField({ fieldId, payload }: UpdateIntegrationFieldParams): Promise<IntegrationField | number[]>;
+    /**
+     * Deletes an integration action field/header.
+     * @param fieldId - The field identifier.
+     * @returns A promise that resolves when the field is deleted.
+     */
+    deleteField({ fieldId }: DeleteIntegrationFieldParams): Promise<void>;
+    /**
+     * Deletes an integration action.
+     * @param actionId - The action identifier.
+     * @returns A promise that resolves when the action is deleted.
+     */
+    deleteAction({ actionId }: DeleteIntegrationActionParams): Promise<void>;
+}
+
 /**
  * Gateway for interacting with the Chat Webservice API.
  */
@@ -314,6 +399,7 @@ type GatewayMap = {
     'chat-adapter': ChatAdapterGateway;
     assets: AssetsGateway;
     'contact-list': ContactListGateway;
+    integrations: IntegrationsGateway;
     'chat-webservice': ChatWebserviceGateway;
     'call-report': CallReportGateway;
 };
@@ -346,6 +432,9 @@ interface GatewayClientParams {
         contactList?: {
             baseUrl: string;
         };
+        integrations?: {
+            baseUrl: string;
+        };
         chatWebservice?: {
             baseUrl: string;
         };
@@ -378,4 +467,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetRoomByIdRequest, GetRootRulesRequest, ListContactHistoryRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueMember, QueueRule, RoomResponse, RootRulesResponse, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListContactHistoryRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RoomResponse, RootRulesResponse, ServiceGroupsResponse, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse } from './customer-service/contracts/index.js';
 export { CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
-import { ProviderListResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
-export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, QueueListResponse, Rule } from './chat-config/contracts/index.js';
+import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
+export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, QueueListResponse, Rule, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup } from './campaigns/contracts/index.js';
 export { CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.js';
 import { GetConfigTemplatesParams, GetConfigTemplatesResponse } from './chat-adapter/contracts/index.js';
@@ -11,6 +11,8 @@ import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertRespons
 export { IUploadPresignedUrlResponse } from './assets/contracts/index.js';
 import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse } from './contact-list/contracts/index.js';
 export { ContactPhoneResponse } from './contact-list/contracts/index.js';
+import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetIntegrationHooksCatalogRequest, HookCatalogItem, CreateIntegrationPartnerRequest, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.js';
+export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.js';
 import { ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse } from './chat-webservice/contracts/index.js';
 export { RoomActiveDates, RoomMemberResponse, RoomTagResponse } from './chat-webservice/contracts/index.js';
 import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.js';
@@ -66,6 +68,12 @@ declare class ChatConfigGateway {
      * @returns The list of providers.
      */
     getProviders(): Promise<ProviderListResponse>;
+    /**
+     * Retrieves provider configurations filtered by configuration IDs.
+     * @param params - Query parameters containing one or more configuration IDs.
+     * @returns The provider configurations matching the given IDs.
+     */
+    getProviderConfigurations(params?: GetProviderConfigurationsParams): Promise<ProviderConfigurationsResponse>;
     /**
      * Retrieves configurations filtered by provider.
      * @param providerId - The unique identifier of the provider.
@@ -86,6 +94,12 @@ declare class ChatConfigGateway {
      * @returns The queue memberships for the given member.
      */
     getMemberQueues(params: GetMemberQueuesRequest): Promise<QueueMember[]>;
+    /**
+     * Retrieves service groups filtered by service group IDs.
+     * @param params - Query parameters containing one or more service group IDs.
+     * @returns The service groups matching the given IDs.
+     */
+    getServiceGroups(params?: GetServiceGroupsParams): Promise<ServiceGroupsResponse>;
     /**
      * Retrieves a Meta template configuration by its ID.
      * @param templateId - The unique identifier of the template.
@@ -262,6 +276,77 @@ declare class ContactListGateway {
     getCategoryList(): Promise<ContactCategoryResponse[]>;
 }
 
+/**
+ * Gateway for interacting with the Integrations API.
+ */
+declare class IntegrationsGateway {
+    private readonly httpClient;
+    private readonly baseUrl;
+    constructor(httpClient: AxiosInstance, baseUrl: string);
+    /**
+     * Retrieves all integration partners configured for a company.
+     * @param companyId - The company identifier.
+     * @returns The integration partners configured for the company.
+     */
+    getPartnersByCompany({ companyId, name }: GetIntegrationPartnersByCompanyRequest): Promise<IntegrationPartner[]>;
+    /**
+     * Retrieves the hook catalog, optionally scoped by module.
+     * @param module - The optional module identifier used by the Integrations API filter.
+     * @returns The hook catalog items, filtered by module when provided.
+     */
+    getHooksCatalog({ module }?: GetIntegrationHooksCatalogRequest): Promise<HookCatalogItem[]>;
+    /**
+     * Creates an integration partner.
+     * @param payload - The partner creation payload.
+     * @returns The created integration partner.
+     */
+    createPartner(payload: CreateIntegrationPartnerRequest): Promise<IntegrationPartner>;
+    /**
+     * Deletes an integration partner.
+     * @param partnerId - The partner identifier.
+     * @returns A promise that resolves when the partner is deleted.
+     */
+    deletePartner({ partnerId }: DeleteIntegrationPartnerParams): Promise<void>;
+    /**
+     * Creates an integration action.
+     * @param payload - The action creation payload.
+     * @returns The created integration action.
+     */
+    createAction(payload: CreateIntegrationActionRequest): Promise<IntegrationAction>;
+    /**
+     * Updates an integration action.
+     * @param actionId - The action identifier.
+     * @param payload - The action update payload.
+     * @returns The updated integration action.
+     */
+    updateAction({ actionId, payload }: UpdateIntegrationActionParams): Promise<IntegrationAction>;
+    /**
+     * Creates an integration action field/header.
+     * @param payload - The field creation payload.
+     * @returns The created integration field.
+     */
+    createField(payload: CreateIntegrationFieldRequest): Promise<IntegrationField>;
+    /**
+     * Updates an integration action field/header.
+     * @param fieldId - The field identifier.
+     * @param payload - The field update payload.
+     * @returns The updated integration field response.
+     */
+    updateField({ fieldId, payload }: UpdateIntegrationFieldParams): Promise<IntegrationField | number[]>;
+    /**
+     * Deletes an integration action field/header.
+     * @param fieldId - The field identifier.
+     * @returns A promise that resolves when the field is deleted.
+     */
+    deleteField({ fieldId }: DeleteIntegrationFieldParams): Promise<void>;
+    /**
+     * Deletes an integration action.
+     * @param actionId - The action identifier.
+     * @returns A promise that resolves when the action is deleted.
+     */
+    deleteAction({ actionId }: DeleteIntegrationActionParams): Promise<void>;
+}
+
 /**
  * Gateway for interacting with the Chat Webservice API.
  */
@@ -314,6 +399,7 @@ type GatewayMap = {
     'chat-adapter': ChatAdapterGateway;
     assets: AssetsGateway;
     'contact-list': ContactListGateway;
+    integrations: IntegrationsGateway;
     'chat-webservice': ChatWebserviceGateway;
     'call-report': CallReportGateway;
 };
@@ -346,6 +432,9 @@ interface GatewayClientParams {
         contactList?: {
             baseUrl: string;
         };
+        integrations?: {
+            baseUrl: string;
+        };
         chatWebservice?: {
             baseUrl: string;
         };
@@ -378,4 +467,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetRoomByIdRequest, GetRootRulesRequest, ListContactHistoryRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueMember, QueueRule, RoomResponse, RootRulesResponse, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, ListContactHistoryRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RoomResponse, RootRulesResponse, ServiceGroupsResponse, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };