@opens/gateways 1.11.2 → 1.11.4

package/dist/campaigns/contracts/index.d.mts

@@ -171,6 +171,7 @@ interface CampaignContactResponse {
     campaignId: string;
     createdAt: string;
     updatedAt: string;
+    deliveredAt?: string | null;
     contactEndpointId?: string;
     dispatchStatusMessage: string;
     contactName?: string;
@@ -205,6 +206,7 @@ type PatchCampaignContactRequest = {
     campaignId?: string;
     createdAt?: string;
     updatedAt?: string;
+    deliveredAt?: string | null;
     contactEndpointId?: string;
     dispatchStatusMessage?: string;
     contactName?: string;
@@ -245,6 +247,132 @@ type CampaignContactQueryParams = {
     $select?: (keyof CampaignContactResponse)[];
 };
 
+type CampaignContactsDashboardInterval = 'day' | 'week' | 'month';
+type CampaignContactsDashboardQueryValue = string | number | boolean;
+type CampaignContactsDashboardExactQueryOperators<T extends CampaignContactsDashboardQueryValue> = {
+    $in?: T[];
+    $ne?: T;
+};
+type CampaignContactsDashboardRangeQueryOperators<T extends string | number> = CampaignContactsDashboardExactQueryOperators<T> & {
+    $gt?: T;
+    $gte?: T;
+    $lt?: T;
+    $lte?: T;
+};
+interface CampaignContactsDashboardQueryParams {
+    companyId: string;
+    id?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignName?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    createdBy?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    assignedTo?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignCreatedBy?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignAssignedTo?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientName?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientEndpoint?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientEndpointId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    serviceId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    communicationChannelId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    providerConfigId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    dispatchStatus?: CampaignContactDispatchStatus | CampaignContactsDashboardExactQueryOperators<CampaignContactDispatchStatus>;
+    dispatchStatusMessage?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    wasMessageRead?: boolean | CampaignContactsDashboardExactQueryOperators<boolean>;
+    hasAutomaticFollowUp?: boolean | CampaignContactsDashboardExactQueryOperators<boolean>;
+    retryCount?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    createdAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    updatedAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    deliveredAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    convertedAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    followUpSentAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    timeToConvert?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    conversionHour?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    conversionDay?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    interval?: CampaignContactsDashboardInterval;
+}
+interface CampaignContactsDashboardStatusMetrics {
+    scheduled: number;
+    queued: number;
+    delivered: number;
+    converted: number;
+    failed: number;
+}
+interface CampaignContactsDashboardSummary {
+    campaignsSent: number;
+    contactsImpacted: number;
+    messagesSent: number;
+    deliveredMessages: number;
+    responseMessages: number;
+    convertedMessages: number;
+    rejectedMessages: number;
+    deliveryRate: number;
+    responseRate: number;
+    conversionRate: number;
+    rejectionRate: number;
+    averageResponseTimeMinutes: number | null;
+    resendCount: number;
+    automaticFollowUpCount: number;
+}
+interface CampaignContactsDashboardFunnelItem {
+    key: string;
+    label: string;
+    count: number;
+    base: number;
+    rate: number;
+}
+interface CampaignContactsDashboardEvolutionItem {
+    period: string;
+    sent: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+}
+interface CampaignContactsDashboardTopCampaign {
+    campaignId: string;
+    campaignName?: string;
+    createdBy?: string;
+    contacts: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+    conversionRate: number;
+    status?: CampaignStatus;
+}
+interface CampaignContactsDashboardChannelPerformance {
+    serviceId: string;
+    sent: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+    deliveryRate: number;
+    responseRate: number;
+    conversionRate: number;
+}
+interface CampaignContactsDashboardStatusDistribution {
+    key: number;
+    total: number;
+    byStatus: CampaignContactsDashboardStatusMetrics;
+}
+interface CampaignContactsDashboardMetrics {
+    byStatus: CampaignContactsDashboardStatusMetrics;
+    averageTimeToConvert: number | null;
+    summary: CampaignContactsDashboardSummary;
+    funnel: CampaignContactsDashboardFunnelItem[];
+    evolution: CampaignContactsDashboardEvolutionItem[];
+    topCampaigns: CampaignContactsDashboardTopCampaign[];
+    byChannel: CampaignContactsDashboardChannelPerformance[];
+    byConversionDay: CampaignContactsDashboardStatusDistribution[];
+    byConversionHour: CampaignContactsDashboardStatusDistribution[];
+}
+interface CampaignContactsDashboardData {
+    total: number;
+    filters: {
+        from: string;
+        to: string;
+    };
+    metrics: CampaignContactsDashboardMetrics;
+}
+
 /** Work group entity returned by the Campaigns API. */
 interface CampaignWorkGroup {
     id: string;
@@ -273,4 +401,4 @@ interface CreateCampaignWorkGroupRequest {
     companyId: string;
 }
 
-export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignRetryConfig, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };
+export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardData, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryParams, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignRetryConfig, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };

package/dist/campaigns/contracts/index.d.ts

@@ -171,6 +171,7 @@ interface CampaignContactResponse {
     campaignId: string;
     createdAt: string;
     updatedAt: string;
+    deliveredAt?: string | null;
     contactEndpointId?: string;
     dispatchStatusMessage: string;
     contactName?: string;
@@ -205,6 +206,7 @@ type PatchCampaignContactRequest = {
     campaignId?: string;
     createdAt?: string;
     updatedAt?: string;
+    deliveredAt?: string | null;
     contactEndpointId?: string;
     dispatchStatusMessage?: string;
     contactName?: string;
@@ -245,6 +247,132 @@ type CampaignContactQueryParams = {
     $select?: (keyof CampaignContactResponse)[];
 };
 
+type CampaignContactsDashboardInterval = 'day' | 'week' | 'month';
+type CampaignContactsDashboardQueryValue = string | number | boolean;
+type CampaignContactsDashboardExactQueryOperators<T extends CampaignContactsDashboardQueryValue> = {
+    $in?: T[];
+    $ne?: T;
+};
+type CampaignContactsDashboardRangeQueryOperators<T extends string | number> = CampaignContactsDashboardExactQueryOperators<T> & {
+    $gt?: T;
+    $gte?: T;
+    $lt?: T;
+    $lte?: T;
+};
+interface CampaignContactsDashboardQueryParams {
+    companyId: string;
+    id?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignName?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    createdBy?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    assignedTo?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignCreatedBy?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    campaignAssignedTo?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientName?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientEndpoint?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    clientEndpointId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    serviceId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    communicationChannelId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    providerConfigId?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    dispatchStatus?: CampaignContactDispatchStatus | CampaignContactsDashboardExactQueryOperators<CampaignContactDispatchStatus>;
+    dispatchStatusMessage?: string | CampaignContactsDashboardExactQueryOperators<string>;
+    wasMessageRead?: boolean | CampaignContactsDashboardExactQueryOperators<boolean>;
+    hasAutomaticFollowUp?: boolean | CampaignContactsDashboardExactQueryOperators<boolean>;
+    retryCount?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    createdAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    updatedAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    deliveredAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    convertedAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    followUpSentAt?: string | CampaignContactsDashboardRangeQueryOperators<string>;
+    timeToConvert?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    conversionHour?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    conversionDay?: number | CampaignContactsDashboardRangeQueryOperators<number>;
+    interval?: CampaignContactsDashboardInterval;
+}
+interface CampaignContactsDashboardStatusMetrics {
+    scheduled: number;
+    queued: number;
+    delivered: number;
+    converted: number;
+    failed: number;
+}
+interface CampaignContactsDashboardSummary {
+    campaignsSent: number;
+    contactsImpacted: number;
+    messagesSent: number;
+    deliveredMessages: number;
+    responseMessages: number;
+    convertedMessages: number;
+    rejectedMessages: number;
+    deliveryRate: number;
+    responseRate: number;
+    conversionRate: number;
+    rejectionRate: number;
+    averageResponseTimeMinutes: number | null;
+    resendCount: number;
+    automaticFollowUpCount: number;
+}
+interface CampaignContactsDashboardFunnelItem {
+    key: string;
+    label: string;
+    count: number;
+    base: number;
+    rate: number;
+}
+interface CampaignContactsDashboardEvolutionItem {
+    period: string;
+    sent: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+}
+interface CampaignContactsDashboardTopCampaign {
+    campaignId: string;
+    campaignName?: string;
+    createdBy?: string;
+    contacts: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+    conversionRate: number;
+    status?: CampaignStatus;
+}
+interface CampaignContactsDashboardChannelPerformance {
+    serviceId: string;
+    sent: number;
+    delivered: number;
+    responses: number;
+    conversions: number;
+    deliveryRate: number;
+    responseRate: number;
+    conversionRate: number;
+}
+interface CampaignContactsDashboardStatusDistribution {
+    key: number;
+    total: number;
+    byStatus: CampaignContactsDashboardStatusMetrics;
+}
+interface CampaignContactsDashboardMetrics {
+    byStatus: CampaignContactsDashboardStatusMetrics;
+    averageTimeToConvert: number | null;
+    summary: CampaignContactsDashboardSummary;
+    funnel: CampaignContactsDashboardFunnelItem[];
+    evolution: CampaignContactsDashboardEvolutionItem[];
+    topCampaigns: CampaignContactsDashboardTopCampaign[];
+    byChannel: CampaignContactsDashboardChannelPerformance[];
+    byConversionDay: CampaignContactsDashboardStatusDistribution[];
+    byConversionHour: CampaignContactsDashboardStatusDistribution[];
+}
+interface CampaignContactsDashboardData {
+    total: number;
+    filters: {
+        from: string;
+        to: string;
+    };
+    metrics: CampaignContactsDashboardMetrics;
+}
+
 /** Work group entity returned by the Campaigns API. */
 interface CampaignWorkGroup {
     id: string;
@@ -273,4 +401,4 @@ interface CreateCampaignWorkGroupRequest {
     companyId: string;
 }
 
-export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignRetryConfig, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };
+export type { Campaign, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactPaginatedResponse, CampaignContactQueryOperators, CampaignContactQueryParams, CampaignContactQueryValue, CampaignContactResponse, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardData, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryParams, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignPaginatedResponse, CampaignProvider, CampaignQueryParams, CampaignRetryConfig, CampaignSchedule, CampaignStatus, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, PatchCampaignContactRequest, PatchCampaignRequest, WhatsAppPayload, WhatsAppTemplateComponent };

package/dist/campaigns/contracts/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/campaigns/contracts/index.ts"],"sourcesContent":["export * from './campaign';\nexport * from './campaign-contacts';\nexport * from './work-group';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/campaigns/contracts/index.ts"],"sourcesContent":["export * from './campaign';\nexport * from './campaign-contacts';\nexport * from './campaign-contacts-dashboard';\nexport * from './work-group';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.mts

@@ -3,16 +3,14 @@ import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMem
 export { CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
 import { ProviderListResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.mjs';
 export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, QueueListResponse, QueueMember, Rule } from './chat-config/contracts/index.mjs';
-import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup } from './campaigns/contracts/index.mjs';
-export { CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/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';
 export { ConfigTemplatesPaging, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.mjs';
 import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.mjs';
 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';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -178,6 +176,7 @@ declare class CampaignsGateway {
      * @returns The removed campaign contact.
      */
     removeCampaignContact(id: string): Promise<CampaignContactResponse>;
+    getContactsDashboardData(query: CampaignContactsDashboardQueryParams): Promise<CampaignContactsDashboardData>;
     getUsers(): Promise<CampaignUser[]>;
     listWorkGroups(query?: CampaignWorkGroupQueryParams): Promise<CampaignWorkGroupPaginatedResponse>;
     createWorkGroup(payload: CreateCampaignWorkGroupRequest): Promise<CampaignWorkGroup>;
@@ -253,77 +252,6 @@ 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>;
-}
-
 /**
  * Maps service identifiers to their corresponding gateway types.
  * Used by the `gateway()` function to infer the correct return type
@@ -339,7 +267,6 @@ type GatewayMap = {
     'chat-adapter': ChatAdapterGateway;
     'assets': AssetsGateway;
     'contact-list': ContactListGateway;
-    'integrations': IntegrationsGateway;
 };
 /**
  * Parameters required to configure the SDK client.
@@ -370,9 +297,6 @@ interface GatewayClientParams {
         contactList?: {
             baseUrl: string;
         };
-        integrations?: {
-            baseUrl: string;
-        };
     };
 }
 
@@ -399,4 +323,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, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetPresignedUrlRequest, GetRootRulesRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueRule, RootRulesResponse, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetManagedUsersResponse, GetPresignedUrlRequest, GetRootRulesRequest, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueRule, RootRulesResponse, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };

package/dist/index.d.ts

@@ -3,16 +3,14 @@ import { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMem
 export { CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
 import { ProviderListResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse } from './chat-config/contracts/index.js';
 export { Config, ConfigProvider, DistributionType, MetaTemplateButton, Provider, QueueListResponse, QueueMember, Rule } from './chat-config/contracts/index.js';
-import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup } from './campaigns/contracts/index.js';
-export { CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/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';
 export { ConfigTemplatesPaging, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.js';
 import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.js';
 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';
 
 /**
  * Gateway for interacting with the Customer Service API.
@@ -178,6 +176,7 @@ declare class CampaignsGateway {
      * @returns The removed campaign contact.
      */
     removeCampaignContact(id: string): Promise<CampaignContactResponse>;
+    getContactsDashboardData(query: CampaignContactsDashboardQueryParams): Promise<CampaignContactsDashboardData>;
     getUsers(): Promise<CampaignUser[]>;
     listWorkGroups(query?: CampaignWorkGroupQueryParams): Promise<CampaignWorkGroupPaginatedResponse>;
     createWorkGroup(payload: CreateCampaignWorkGroupRequest): Promise<CampaignWorkGroup>;
@@ -253,77 +252,6 @@ 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>;
-}
-
 /**
  * Maps service identifiers to their corresponding gateway types.
  * Used by the `gateway()` function to infer the correct return type
@@ -339,7 +267,6 @@ type GatewayMap = {
     'chat-adapter': ChatAdapterGateway;
     'assets': AssetsGateway;
     'contact-list': ContactListGateway;
-    'integrations': IntegrationsGateway;
 };
 /**
  * Parameters required to configure the SDK client.
@@ -370,9 +297,6 @@ interface GatewayClientParams {
         contactList?: {
             baseUrl: string;
         };
-        integrations?: {
-            baseUrl: string;
-        };
     };
 }
 
@@ -399,4 +323,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, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetPresignedUrlRequest, GetRootRulesRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueRule, RootRulesResponse, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AttachmentByIdResponse, AudioConvertResponse, Campaign, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactPhoneSearchResponse, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, FindOrCreateQueueRuleRequest, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetManagedUsersResponse, GetPresignedUrlRequest, GetRootRulesRequest, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PatchCampaignContactRequest, PatchCampaignRequest, ProviderListResponse, Queue, QueueRule, RootRulesResponse, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };