@opens/gateways 1.14.8 → 1.15.0

package/dist/customer-service/contracts/index.d.mts

@@ -92,4 +92,172 @@ interface ManagedUser {
 }
 type GetManagedUsersResponse = ManagedUser[];
 
-export type { CompanyData, CompanyResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
+/** Visual status literals for an announcement payload. */
+type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
+/** Button displayed inside an announcement payload. */
+interface AnnouncementButton {
+    /** Button label. */
+    text: string;
+    /** Target URL opened when the button is clicked. */
+    url: string;
+    /** Whether the URL should open in a new browser tab. */
+    new_tab: boolean;
+}
+/** Payload rendered by the announcement widget. */
+interface AnnouncementPayload {
+    /** Main announcement message. */
+    message: string;
+    /** Visual style applied to the announcement. */
+    visual_status: AnnouncementVisualStatus;
+    /** Optional action buttons (up to 3). */
+    buttons?: AnnouncementButton[];
+}
+/** URL targeting rule for an announcement. */
+interface AnnouncementTargetingRuleUrl {
+    /** Matching strategy. */
+    operator: 'starts_with' | 'exact_match';
+    /** URL value to match against the current page URL. */
+    value: string;
+}
+/** Targeting rules used to decide whether an announcement should be shown. */
+interface AnnouncementTargetingRules {
+    /** When true, the announcement matches every profile. */
+    allProfiles?: boolean;
+    /** Profile slugs that should see the announcement. */
+    profiles?: string[];
+    /** URL-based targeting rule. */
+    url?: AnnouncementTargetingRuleUrl;
+}
+/** Company linked to an announcement. */
+interface AnnouncementCompany {
+    /** Announcement identifier. */
+    announcementId: string;
+    /** Company identifier. */
+    companyId: string;
+}
+/** Announcement type returned by the API. */
+interface AnnouncementType {
+    /** Unique identifier. */
+    id: string;
+    /** Type slug (e.g. banner, modal). */
+    type: string;
+    /** Display name. */
+    name: string;
+}
+/** Announcement entity returned by the Customer Service API. */
+interface Announcement {
+    /** Unique identifier. */
+    id: string;
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement is currently active. */
+    isActive: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Targeting rules (JSONB). */
+    targetingRules: AnnouncementTargetingRules;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Creation ISO date. */
+    createdAt: string;
+    /** Last update ISO date. */
+    updatedAt: string;
+    /** Linked companies (included on detail endpoints). */
+    announcement_companies?: AnnouncementCompany[];
+    /** Linked announcement type (included on list/detail endpoints). */
+    announcement_type?: AnnouncementType;
+}
+/** Query filters for listing announcements through the admin endpoint. */
+interface AnnouncementListFilters {
+    /** Page number (defaults to 1). */
+    page?: number;
+    /** Items per page (defaults to 20, max 100). */
+    limit?: number;
+    /** Filter by active flag. */
+    isActive?: boolean;
+    /** Filter by global companies flag. */
+    allCompanies?: boolean;
+    /** true: only expired; false: only not expired; omitted: no expiration filter. */
+    expired?: boolean;
+    /** Filter by a linked company UUID. */
+    companyId?: string;
+    /** Filter by announcement type UUID. */
+    typeId?: string;
+    /** Filter by targeted profile. */
+    profile?: string;
+    /** Filter by targeted URL. */
+    url?: string;
+}
+/** Paginated response returned by the announcements admin list endpoint. */
+interface AnnouncementListResponse {
+    /** Total matching rows. */
+    count: number;
+    /** Current page rows. */
+    rows: Announcement[];
+}
+/** Request payload for creating an announcement. */
+interface CreateAnnouncementRequest {
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement should start active (defaults to true). */
+    isActive?: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Company UUIDs allowed to see the announcement when allCompanies is false. */
+    companies?: string[];
+    /** Targeting rules. */
+    targetingRules?: AnnouncementTargetingRules;
+}
+/** Request payload for updating an announcement. */
+interface UpdateAnnouncementRequest {
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement is currently active. */
+    isActive?: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Company UUIDs allowed to see the announcement when allCompanies is false. */
+    companies?: string[];
+    /** Targeting rules. */
+    targetingRules?: AnnouncementTargetingRules;
+}
+/** Request payload for toggling an announcement active status. */
+interface UpdateAnnouncementStatusRequest {
+    /** New active status. */
+    isActive: boolean;
+}
+/** Query parameters for the active announcements widget endpoint. */
+interface ActiveAnnouncementQuery {
+    /** Widget context (e.g. current page URL). */
+    environment?: {
+        /** Current page URL used for URL targeting rules. */
+        url?: string;
+    };
+}
+/** Slim announcement payload returned by the active endpoint (widget). */
+interface ActiveAnnouncement {
+    /** Unique identifier. */
+    id: string;
+    /** Announcement type slug. */
+    type?: string;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+}
+
+export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };

package/dist/customer-service/contracts/index.d.ts

@@ -92,4 +92,172 @@ interface ManagedUser {
 }
 type GetManagedUsersResponse = ManagedUser[];
 
-export type { CompanyData, CompanyResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };
+/** Visual status literals for an announcement payload. */
+type AnnouncementVisualStatus = 'success' | 'alert' | 'warning' | 'custom';
+/** Button displayed inside an announcement payload. */
+interface AnnouncementButton {
+    /** Button label. */
+    text: string;
+    /** Target URL opened when the button is clicked. */
+    url: string;
+    /** Whether the URL should open in a new browser tab. */
+    new_tab: boolean;
+}
+/** Payload rendered by the announcement widget. */
+interface AnnouncementPayload {
+    /** Main announcement message. */
+    message: string;
+    /** Visual style applied to the announcement. */
+    visual_status: AnnouncementVisualStatus;
+    /** Optional action buttons (up to 3). */
+    buttons?: AnnouncementButton[];
+}
+/** URL targeting rule for an announcement. */
+interface AnnouncementTargetingRuleUrl {
+    /** Matching strategy. */
+    operator: 'starts_with' | 'exact_match';
+    /** URL value to match against the current page URL. */
+    value: string;
+}
+/** Targeting rules used to decide whether an announcement should be shown. */
+interface AnnouncementTargetingRules {
+    /** When true, the announcement matches every profile. */
+    allProfiles?: boolean;
+    /** Profile slugs that should see the announcement. */
+    profiles?: string[];
+    /** URL-based targeting rule. */
+    url?: AnnouncementTargetingRuleUrl;
+}
+/** Company linked to an announcement. */
+interface AnnouncementCompany {
+    /** Announcement identifier. */
+    announcementId: string;
+    /** Company identifier. */
+    companyId: string;
+}
+/** Announcement type returned by the API. */
+interface AnnouncementType {
+    /** Unique identifier. */
+    id: string;
+    /** Type slug (e.g. banner, modal). */
+    type: string;
+    /** Display name. */
+    name: string;
+}
+/** Announcement entity returned by the Customer Service API. */
+interface Announcement {
+    /** Unique identifier. */
+    id: string;
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement is currently active. */
+    isActive: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Targeting rules (JSONB). */
+    targetingRules: AnnouncementTargetingRules;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Creation ISO date. */
+    createdAt: string;
+    /** Last update ISO date. */
+    updatedAt: string;
+    /** Linked companies (included on detail endpoints). */
+    announcement_companies?: AnnouncementCompany[];
+    /** Linked announcement type (included on list/detail endpoints). */
+    announcement_type?: AnnouncementType;
+}
+/** Query filters for listing announcements through the admin endpoint. */
+interface AnnouncementListFilters {
+    /** Page number (defaults to 1). */
+    page?: number;
+    /** Items per page (defaults to 20, max 100). */
+    limit?: number;
+    /** Filter by active flag. */
+    isActive?: boolean;
+    /** Filter by global companies flag. */
+    allCompanies?: boolean;
+    /** true: only expired; false: only not expired; omitted: no expiration filter. */
+    expired?: boolean;
+    /** Filter by a linked company UUID. */
+    companyId?: string;
+    /** Filter by announcement type UUID. */
+    typeId?: string;
+    /** Filter by targeted profile. */
+    profile?: string;
+    /** Filter by targeted URL. */
+    url?: string;
+}
+/** Paginated response returned by the announcements admin list endpoint. */
+interface AnnouncementListResponse {
+    /** Total matching rows. */
+    count: number;
+    /** Current page rows. */
+    rows: Announcement[];
+}
+/** Request payload for creating an announcement. */
+interface CreateAnnouncementRequest {
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement should start active (defaults to true). */
+    isActive?: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Company UUIDs allowed to see the announcement when allCompanies is false. */
+    companies?: string[];
+    /** Targeting rules. */
+    targetingRules?: AnnouncementTargetingRules;
+}
+/** Request payload for updating an announcement. */
+interface UpdateAnnouncementRequest {
+    /** Display name. */
+    name: string;
+    /** Identifier of the announcement type. */
+    typeId: string;
+    /** Whether the announcement is currently active. */
+    isActive?: boolean;
+    /** Whether the announcement is visible to all companies. */
+    allCompanies: boolean;
+    /** Optional expiration ISO date. */
+    expiresAt?: string | null;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+    /** Company UUIDs allowed to see the announcement when allCompanies is false. */
+    companies?: string[];
+    /** Targeting rules. */
+    targetingRules?: AnnouncementTargetingRules;
+}
+/** Request payload for toggling an announcement active status. */
+interface UpdateAnnouncementStatusRequest {
+    /** New active status. */
+    isActive: boolean;
+}
+/** Query parameters for the active announcements widget endpoint. */
+interface ActiveAnnouncementQuery {
+    /** Widget context (e.g. current page URL). */
+    environment?: {
+        /** Current page URL used for URL targeting rules. */
+        url?: string;
+    };
+}
+/** Slim announcement payload returned by the active endpoint (widget). */
+interface ActiveAnnouncement {
+    /** Unique identifier. */
+    id: string;
+    /** Announcement type slug. */
+    type?: string;
+    /** Renderable payload. */
+    payload: AnnouncementPayload;
+}
+
+export type { ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementButton, AnnouncementCompany, AnnouncementListFilters, AnnouncementListResponse, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, CompanyResponse, CreateAnnouncementRequest, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };

package/dist/customer-service/contracts/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './user';"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/customer-service/contracts/index.ts"],"sourcesContent":["export * from './work-group';\nexport * from './company';\nexport * from './user';\nexport * from './announcement';"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 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 { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
+export { AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
 import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, 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, ProviderName, 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, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';
@@ -63,6 +63,49 @@ declare class CustomerServiceGateway {
      * Logs out the current user.
      */
     logout(): Promise<void>;
+    /**
+     * Retrieves a paginated list of announcements.
+     * @param query - Optional filters and pagination parameters.
+     * @returns The paginated announcements response.
+     */
+    findAnnouncements(query?: AnnouncementListFilters): Promise<AnnouncementListResponse>;
+    /**
+     * Retrieves an announcement by its unique identifier.
+     * @param announcementId - The unique identifier of the announcement.
+     * @returns The announcement data.
+     */
+    getAnnouncement(announcementId: string): Promise<Announcement>;
+    /**
+     * Creates a new announcement.
+     * @param payload - The announcement data to create.
+     * @returns The created announcement.
+     */
+    createAnnouncement(payload: CreateAnnouncementRequest): Promise<Announcement>;
+    /**
+     * Updates an existing announcement.
+     * @param announcementId - The unique identifier of the announcement.
+     * @param payload - The announcement data to update.
+     * @returns The updated announcement.
+     */
+    updateAnnouncement(announcementId: string, payload: UpdateAnnouncementRequest): Promise<Announcement>;
+    /**
+     * Toggles the active status of an announcement.
+     * @param announcementId - The unique identifier of the announcement.
+     * @param payload - The new active status.
+     * @returns The updated announcement.
+     */
+    updateAnnouncementStatus(announcementId: string, payload: UpdateAnnouncementStatusRequest): Promise<Announcement>;
+    /**
+     * Removes an announcement by its unique identifier.
+     * @param announcementId - The unique identifier of the announcement.
+     */
+    deleteAnnouncement(announcementId: string): Promise<void>;
+    /**
+     * Retrieves active announcements tailored for the widget context.
+     * @param query - The company and environment context.
+     * @returns The active announcements for the widget.
+     */
+    findActiveAnnouncements(query: ActiveAnnouncementQuery): Promise<ActiveAnnouncement[]>;
 }
 
 /**
@@ -716,4 +759,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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 { CompanyResponse, WorkGroupListResponse, WorkGroupResponse, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
+export { AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementType, AnnouncementVisualStatus, CompanyData, ManagedUser, User, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
 import { ProviderListResponse, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, 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, ProviderName, 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, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';
@@ -63,6 +63,49 @@ declare class CustomerServiceGateway {
      * Logs out the current user.
      */
     logout(): Promise<void>;
+    /**
+     * Retrieves a paginated list of announcements.
+     * @param query - Optional filters and pagination parameters.
+     * @returns The paginated announcements response.
+     */
+    findAnnouncements(query?: AnnouncementListFilters): Promise<AnnouncementListResponse>;
+    /**
+     * Retrieves an announcement by its unique identifier.
+     * @param announcementId - The unique identifier of the announcement.
+     * @returns The announcement data.
+     */
+    getAnnouncement(announcementId: string): Promise<Announcement>;
+    /**
+     * Creates a new announcement.
+     * @param payload - The announcement data to create.
+     * @returns The created announcement.
+     */
+    createAnnouncement(payload: CreateAnnouncementRequest): Promise<Announcement>;
+    /**
+     * Updates an existing announcement.
+     * @param announcementId - The unique identifier of the announcement.
+     * @param payload - The announcement data to update.
+     * @returns The updated announcement.
+     */
+    updateAnnouncement(announcementId: string, payload: UpdateAnnouncementRequest): Promise<Announcement>;
+    /**
+     * Toggles the active status of an announcement.
+     * @param announcementId - The unique identifier of the announcement.
+     * @param payload - The new active status.
+     * @returns The updated announcement.
+     */
+    updateAnnouncementStatus(announcementId: string, payload: UpdateAnnouncementStatusRequest): Promise<Announcement>;
+    /**
+     * Removes an announcement by its unique identifier.
+     * @param announcementId - The unique identifier of the announcement.
+     */
+    deleteAnnouncement(announcementId: string): Promise<void>;
+    /**
+     * Retrieves active announcements tailored for the widget context.
+     * @param query - The company and environment context.
+     * @returns The active announcements for the widget.
+     */
+    findActiveAnnouncements(query: ActiveAnnouncementQuery): Promise<ActiveAnnouncement[]>;
 }
 
 /**
@@ -716,4 +759,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-export { AccessPackage, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
+export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyResource, CompanyResponse, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateQueueRuleRequest, GetAccessPackagesParams, GetAllUsersParams, GetAllUsersResponse, GetAttachmentByIdRequest, GetAutomationPartnerRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, GetCompanyAccessPackagesParams, GetCompanyResourcesParams, GetConfigTemplatesParams, GetConfigTemplatesResponse, GetConfigsByProviderParams, GetContactPhonesParams, GetInitialContextRequest, GetInitialContextResponse, GetIntegrationHooksCatalogRequest, GetIntegrationPartnersByCompanyRequest, GetManagedUsersResponse, GetMemberQueuesRequest, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetPresignedUrlRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRoomByIdRequest, GetRootRulesRequest, GetServiceGroupsParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateTimeEntryRequest, UploadPresignedUrlResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };

package/dist/index.js

@@ -109,6 +109,79 @@ var CustomerServiceGateway = class {
   async logout() {
     await this.httpClient.get(`${this.baseUrl}/users/logout`);
   }
+  /**
+   * Retrieves a paginated list of announcements.
+   * @param query - Optional filters and pagination parameters.
+   * @returns The paginated announcements response.
+   */
+  async findAnnouncements(query) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/announcements/admin`, {
+      params: query
+    });
+    return data;
+  }
+  /**
+   * Retrieves an announcement by its unique identifier.
+   * @param announcementId - The unique identifier of the announcement.
+   * @returns The announcement data.
+   */
+  async getAnnouncement(announcementId) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/announcements/admin/${announcementId}`);
+    return data;
+  }
+  /**
+   * Creates a new announcement.
+   * @param payload - The announcement data to create.
+   * @returns The created announcement.
+   */
+  async createAnnouncement(payload) {
+    const { data } = await this.httpClient.post(`${this.baseUrl}/announcements/admin`, payload);
+    return data;
+  }
+  /**
+   * Updates an existing announcement.
+   * @param announcementId - The unique identifier of the announcement.
+   * @param payload - The announcement data to update.
+   * @returns The updated announcement.
+   */
+  async updateAnnouncement(announcementId, payload) {
+    const { data } = await this.httpClient.put(
+      `${this.baseUrl}/announcements/admin/${announcementId}`,
+      payload
+    );
+    return data;
+  }
+  /**
+   * Toggles the active status of an announcement.
+   * @param announcementId - The unique identifier of the announcement.
+   * @param payload - The new active status.
+   * @returns The updated announcement.
+   */
+  async updateAnnouncementStatus(announcementId, payload) {
+    const { data } = await this.httpClient.patch(
+      `${this.baseUrl}/announcements/admin/${announcementId}/status`,
+      payload
+    );
+    return data;
+  }
+  /**
+   * Removes an announcement by its unique identifier.
+   * @param announcementId - The unique identifier of the announcement.
+   */
+  async deleteAnnouncement(announcementId) {
+    await this.httpClient.delete(`${this.baseUrl}/announcements/admin/${announcementId}`);
+  }
+  /**
+   * Retrieves active announcements tailored for the widget context.
+   * @param query - The company and environment context.
+   * @returns The active announcements for the widget.
+   */
+  async findActiveAnnouncements(query) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/announcements/active`, {
+      params: query
+    });
+    return data;
+  }
 };
 
 // src/chat-config/index.ts