@opens/gateways 1.15.16 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -123,4 +123,33 @@ interface ContactHistoryResponse {
123
123
  data: ContactInteractionResponse[];
124
124
  }
125
125
 
126
- export type { ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
126
+ /** Query parameters for fetching company telephony usage. */
127
+ interface CallReportCompanyUsageRequest {
128
+ createdGte?: string;
129
+ createdLte?: string;
130
+ }
131
+ /** Telephony usage totals split by inbound and outbound entries in the Call Report API. */
132
+ interface CallReportTelephonyUsageEntryResponse {
133
+ inbound: number;
134
+ outbound: number;
135
+ }
136
+ /** Provider usage totals for telephony calls in the Call Report API. */
137
+ interface CallReportTelephonyUsageProvidersResponse {
138
+ phone: number;
139
+ yunique: number;
140
+ }
141
+ /** Telephony usage totals returned by the Call Report API. */
142
+ interface CallReportTelephonyUsageResponse {
143
+ internal: number;
144
+ total: number;
145
+ entry: CallReportTelephonyUsageEntryResponse;
146
+ providers: CallReportTelephonyUsageProvidersResponse;
147
+ }
148
+ /** Company usage response returned by the Call Report API. */
149
+ interface CallReportCompanyUsageResponse {
150
+ data: {
151
+ telephony: CallReportTelephonyUsageResponse;
152
+ };
153
+ }
154
+
155
+ export type { CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
@@ -123,4 +123,33 @@ interface ContactHistoryResponse {
123
123
  data: ContactInteractionResponse[];
124
124
  }
125
125
 
126
- export type { ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
126
+ /** Query parameters for fetching company telephony usage. */
127
+ interface CallReportCompanyUsageRequest {
128
+ createdGte?: string;
129
+ createdLte?: string;
130
+ }
131
+ /** Telephony usage totals split by inbound and outbound entries in the Call Report API. */
132
+ interface CallReportTelephonyUsageEntryResponse {
133
+ inbound: number;
134
+ outbound: number;
135
+ }
136
+ /** Provider usage totals for telephony calls in the Call Report API. */
137
+ interface CallReportTelephonyUsageProvidersResponse {
138
+ phone: number;
139
+ yunique: number;
140
+ }
141
+ /** Telephony usage totals returned by the Call Report API. */
142
+ interface CallReportTelephonyUsageResponse {
143
+ internal: number;
144
+ total: number;
145
+ entry: CallReportTelephonyUsageEntryResponse;
146
+ providers: CallReportTelephonyUsageProvidersResponse;
147
+ }
148
+ /** Company usage response returned by the Call Report API. */
149
+ interface CallReportCompanyUsageResponse {
150
+ data: {
151
+ telephony: CallReportTelephonyUsageResponse;
152
+ };
153
+ }
154
+
155
+ export type { CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistoryResponse, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse, ListContactHistoryRequest };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/call-report/contracts/index.ts"],"sourcesContent":["export * from './contact-history';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/call-report/contracts/index.ts"],"sourcesContent":["export * from './contact-history';\nexport * from './usage';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
@@ -325,4 +325,46 @@ interface UpdateMemberInRoomRequest {
325
325
  new?: boolean;
326
326
  }
327
327
 
328
- export type { CancelInvitationRequest, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, ForwardMessageRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };
328
+ /** Query parameters for fetching company chat and email usage. */
329
+ interface ChatWebserviceCompanyUsageRequest {
330
+ createdGte?: string;
331
+ createdLte?: string;
332
+ }
333
+ /** Usage totals split by inbound and outbound entries in the Chat Webservice API. */
334
+ interface ChatWebserviceCompanyUsageEntryResponse {
335
+ inbound: number;
336
+ outbound: number;
337
+ }
338
+ /** Provider usage totals for chat attendances in the Chat Webservice API. */
339
+ interface ChatWebserviceChatUsageProvidersResponse {
340
+ whatsapp: number;
341
+ yunique: number;
342
+ messenger: number;
343
+ direct: number;
344
+ }
345
+ /** Provider usage totals for email attendances in the Chat Webservice API. */
346
+ interface ChatWebserviceEmailUsageProvidersResponse {
347
+ gmail: number;
348
+ outlook: number;
349
+ }
350
+ /** Chat usage totals returned by the Chat Webservice API. */
351
+ interface ChatWebserviceChatUsageResponse {
352
+ total: number;
353
+ entry: ChatWebserviceCompanyUsageEntryResponse;
354
+ providers: ChatWebserviceChatUsageProvidersResponse;
355
+ }
356
+ /** Email usage totals returned by the Chat Webservice API. */
357
+ interface ChatWebserviceEmailUsageResponse {
358
+ total: number;
359
+ entry: ChatWebserviceCompanyUsageEntryResponse;
360
+ providers: ChatWebserviceEmailUsageProvidersResponse;
361
+ }
362
+ /** Company usage response returned by the Chat Webservice API. */
363
+ interface ChatWebserviceCompanyUsageResponse {
364
+ data: {
365
+ chat: ChatWebserviceChatUsageResponse;
366
+ email: ChatWebserviceEmailUsageResponse;
367
+ };
368
+ }
369
+
370
+ export type { CancelInvitationRequest, ChatWebserviceChatUsageProvidersResponse, ChatWebserviceChatUsageResponse, ChatWebserviceCompanyUsageEntryResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, ChatWebserviceEmailUsageProvidersResponse, ChatWebserviceEmailUsageResponse, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, ForwardMessageRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };
@@ -325,4 +325,46 @@ interface UpdateMemberInRoomRequest {
325
325
  new?: boolean;
326
326
  }
327
327
 
328
- export type { CancelInvitationRequest, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, ForwardMessageRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };
328
+ /** Query parameters for fetching company chat and email usage. */
329
+ interface ChatWebserviceCompanyUsageRequest {
330
+ createdGte?: string;
331
+ createdLte?: string;
332
+ }
333
+ /** Usage totals split by inbound and outbound entries in the Chat Webservice API. */
334
+ interface ChatWebserviceCompanyUsageEntryResponse {
335
+ inbound: number;
336
+ outbound: number;
337
+ }
338
+ /** Provider usage totals for chat attendances in the Chat Webservice API. */
339
+ interface ChatWebserviceChatUsageProvidersResponse {
340
+ whatsapp: number;
341
+ yunique: number;
342
+ messenger: number;
343
+ direct: number;
344
+ }
345
+ /** Provider usage totals for email attendances in the Chat Webservice API. */
346
+ interface ChatWebserviceEmailUsageProvidersResponse {
347
+ gmail: number;
348
+ outlook: number;
349
+ }
350
+ /** Chat usage totals returned by the Chat Webservice API. */
351
+ interface ChatWebserviceChatUsageResponse {
352
+ total: number;
353
+ entry: ChatWebserviceCompanyUsageEntryResponse;
354
+ providers: ChatWebserviceChatUsageProvidersResponse;
355
+ }
356
+ /** Email usage totals returned by the Chat Webservice API. */
357
+ interface ChatWebserviceEmailUsageResponse {
358
+ total: number;
359
+ entry: ChatWebserviceCompanyUsageEntryResponse;
360
+ providers: ChatWebserviceEmailUsageProvidersResponse;
361
+ }
362
+ /** Company usage response returned by the Chat Webservice API. */
363
+ interface ChatWebserviceCompanyUsageResponse {
364
+ data: {
365
+ chat: ChatWebserviceChatUsageResponse;
366
+ email: ChatWebserviceEmailUsageResponse;
367
+ };
368
+ }
369
+
370
+ export type { CancelInvitationRequest, ChatWebserviceChatUsageProvidersResponse, ChatWebserviceChatUsageResponse, ChatWebserviceCompanyUsageEntryResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, ChatWebserviceEmailUsageProvidersResponse, ChatWebserviceEmailUsageResponse, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, ForwardMessageRequest, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, GetRoomByIdRequest, InvitationResponse, ListInvitationsRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageResponse, MessageStatusResponse, ReplyInvitationRequest, RoomActiveDates, RoomMemberResponse, RoomResponse, RoomTagResponse, SendAttachmentMessageResponse, SendMessageRequest, UpdateMemberInRoomRequest };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/chat-webservice/contracts/index.ts"],"sourcesContent":["export * from './invitation';\nexport * from './room';\nexport * from './message';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../../../src/chat-webservice/contracts/index.ts"],"sourcesContent":["export * from './invitation';\nexport * from './room';\nexport * from './message';\nexport * from './usage';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/dist/index.d.mts CHANGED
@@ -13,10 +13,10 @@ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResp
13
13
  export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
14
14
  import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, ListAutomationPartnersRequest, AutomationPartner, ListAutomationActionsRequest, AutomationPartnerAction, GetAutomationPartnerRequest, CreateAutomationPartnerRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.mjs';
15
15
  export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.mjs';
16
- import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.mjs';
17
- export { ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
18
- import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.mjs';
19
- export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
16
+ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse } from './chat-webservice/contracts/index.mjs';
17
+ export { ChatWebserviceChatUsageProvidersResponse, ChatWebserviceChatUsageResponse, ChatWebserviceCompanyUsageEntryResponse, ChatWebserviceEmailUsageProvidersResponse, ChatWebserviceEmailUsageResponse, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.mjs';
18
+ import { ListContactHistoryRequest, ContactHistoryResponse, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse } from './call-report/contracts/index.mjs';
19
+ export { CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.mjs';
20
20
  import { CallEndpoint } from './calls/contracts/index.mjs';
21
21
  export { CallEndpointStatus } from './calls/contracts/index.mjs';
22
22
  import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.mjs';
@@ -666,6 +666,13 @@ declare class ChatWebserviceGateway {
666
666
  * @returns The updated room member.
667
667
  */
668
668
  updateMemberInRoom(memberId: number, payload: UpdateMemberInRoomRequest): Promise<RoomMemberResponse>;
669
+ /**
670
+ * Fetches aggregated chat and email usage for a company.
671
+ * @param companyId - The company identifier.
672
+ * @param params - Optional date range filters.
673
+ * @returns The aggregated chat and email usage totals.
674
+ */
675
+ getCompanyUsage(companyId: string, params?: ChatWebserviceCompanyUsageRequest): Promise<ChatWebserviceCompanyUsageResponse>;
669
676
  }
670
677
 
671
678
  /**
@@ -681,6 +688,13 @@ declare class CallReportGateway {
681
688
  * @returns The paginated contact history response.
682
689
  */
683
690
  listContactHistory(params?: ListContactHistoryRequest): Promise<ContactHistoryResponse>;
691
+ /**
692
+ * Fetches aggregated telephony usage for a company.
693
+ * @param companyId - The company identifier.
694
+ * @param params - Optional date range filters.
695
+ * @returns The aggregated telephony usage totals.
696
+ */
697
+ getCompanyUsage(companyId: string, params?: CallReportCompanyUsageRequest): Promise<CallReportCompanyUsageResponse>;
684
698
  }
685
699
 
686
700
  /**
@@ -906,4 +920,4 @@ declare const configure: (params: GatewayClientParams) => void;
906
920
  */
907
921
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
908
922
 
909
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, 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, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
923
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, 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, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.d.ts CHANGED
@@ -13,10 +13,10 @@ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResp
13
13
  export { ContactPhoneResponse } from './contact-list/contracts/index.js';
14
14
  import { GetIntegrationPartnersByCompanyRequest, IntegrationPartner, GetWebhooksByCompanyRequest as GetWebhooksByCompanyRequest$1, GetIntegrationHooksCatalogRequest, HookCatalogItem, ListAutomationPartnersRequest, AutomationPartner, ListAutomationActionsRequest, AutomationPartnerAction, GetAutomationPartnerRequest, CreateAutomationPartnerRequest, CreateIntegrationPartnerRequest, CreateWebhookRequest as CreateWebhookRequest$1, DeleteIntegrationPartnerParams, CreateIntegrationActionRequest, IntegrationAction, UpdateIntegrationActionParams, CreateIntegrationFieldRequest, IntegrationField, UpdateIntegrationFieldParams, DeleteIntegrationFieldParams, DeleteIntegrationActionParams } from './integrations/contracts/index.js';
15
15
  export { UpdateIntegrationActionRequest, UpdateIntegrationFieldRequest } from './integrations/contracts/index.js';
16
- import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse } from './chat-webservice/contracts/index.js';
17
- export { ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
18
- import { ListContactHistoryRequest, ContactHistoryResponse } from './call-report/contracts/index.js';
19
- export { ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
16
+ import { ListInvitationsRequest, InvitationResponse, ReplyInvitationRequest, CancelInvitationRequest, ListLiveUserRoomsRequest, LiveUserRoomResponse, GetRoomByIdRequest, RoomResponse, GetInitialContextRequest, GetInitialContextResponse, GetMessagesByCursorRequest, GetMessagesByCursorResponse, SendMessageRequest, MessageResponse, ForwardMessageRequest, SendAttachmentMessageResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, UpdateMemberInRoomRequest, RoomMemberResponse, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse } from './chat-webservice/contracts/index.js';
17
+ export { ChatWebserviceChatUsageProvidersResponse, ChatWebserviceChatUsageResponse, ChatWebserviceCompanyUsageEntryResponse, ChatWebserviceEmailUsageProvidersResponse, ChatWebserviceEmailUsageResponse, ForwardMessageDestination, ForwardMessageForwardingMetadata, ForwardMessageMetadata, MessageAttachment, MessageMetadata, MessageReactionResponse, MessageReplyContext, MessageStatusResponse, RoomActiveDates, RoomTagResponse } from './chat-webservice/contracts/index.js';
18
+ import { ListContactHistoryRequest, ContactHistoryResponse, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse } from './call-report/contracts/index.js';
19
+ export { CallReportTelephonyUsageEntryResponse, CallReportTelephonyUsageProvidersResponse, CallReportTelephonyUsageResponse, ContactHistoryIndex, ContactHistorySortOrder, ContactInteractionResponse, InteractionCallStepResponse, InteractionChatStepResponse, InteractionMemberResponse, InteractionOrganizationResponse } from './call-report/contracts/index.js';
20
20
  import { CallEndpoint } from './calls/contracts/index.js';
21
21
  export { CallEndpointStatus } from './calls/contracts/index.js';
22
22
  import { GetCommentHistoryRequest, CommentHistoryPage, CasePermissions, UpdateCasePermissionsRequest, GetCaseFeedByActionsRequest, CaseFeedByActionItem, ListCasesRequest, ListCasesResponse, CreateTimeEntryRequest, CaseTimeEntry, ListTimeEntriesRequest, ListTimeEntriesPage, UpdateTimeEntryRequest, DeleteTimeEntryRequest } from './cases/contracts/index.js';
@@ -666,6 +666,13 @@ declare class ChatWebserviceGateway {
666
666
  * @returns The updated room member.
667
667
  */
668
668
  updateMemberInRoom(memberId: number, payload: UpdateMemberInRoomRequest): Promise<RoomMemberResponse>;
669
+ /**
670
+ * Fetches aggregated chat and email usage for a company.
671
+ * @param companyId - The company identifier.
672
+ * @param params - Optional date range filters.
673
+ * @returns The aggregated chat and email usage totals.
674
+ */
675
+ getCompanyUsage(companyId: string, params?: ChatWebserviceCompanyUsageRequest): Promise<ChatWebserviceCompanyUsageResponse>;
669
676
  }
670
677
 
671
678
  /**
@@ -681,6 +688,13 @@ declare class CallReportGateway {
681
688
  * @returns The paginated contact history response.
682
689
  */
683
690
  listContactHistory(params?: ListContactHistoryRequest): Promise<ContactHistoryResponse>;
691
+ /**
692
+ * Fetches aggregated telephony usage for a company.
693
+ * @param companyId - The company identifier.
694
+ * @param params - Optional date range filters.
695
+ * @returns The aggregated telephony usage totals.
696
+ */
697
+ getCompanyUsage(companyId: string, params?: CallReportCompanyUsageRequest): Promise<CallReportCompanyUsageResponse>;
684
698
  }
685
699
 
686
700
  /**
@@ -906,4 +920,4 @@ declare const configure: (params: GatewayClientParams) => void;
906
920
  */
907
921
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
908
922
 
909
- export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, 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, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
923
+ export { AccessPackage, ActiveAnnouncement, ActiveAnnouncementQuery, Announcement, AnnouncementListFilters, AnnouncementListResponse, AnnouncementType, AttachmentByIdResponse, AudioConvertResponse, AutomationPartner, AutomationPartnerAction, CallEndpoint, CallReportCompanyUsageRequest, CallReportCompanyUsageResponse, Campaign, CampaignAccessResponse, CampaignCompanyPaginatedResponse, CampaignCompanyQueryParams, CampaignCompanyResponse, CampaignContactPaginatedResponse, CampaignContactQueryParams, CampaignContactResponse, CampaignContactsDashboardData, CampaignContactsDashboardQueryParams, CampaignPaginatedResponse, CampaignQueryParams, CampaignUser, CampaignWorkGroup, CampaignWorkGroupPaginatedResponse, CampaignWorkGroupQueryParams, CancelInvitationRequest, CaseFeedByActionItem, CasePermissions, CaseTimeEntry, ChatWebserviceCompanyUsageRequest, ChatWebserviceCompanyUsageResponse, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, EnableCampaignCompanyRequest, FindOrCreateContactRequest, FindOrCreateQueueRuleRequest, FlowCatalogParams, FlowCatalogResponse, FlowDefinition, FlowReadiness, ForwardMessageRequest, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, 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, GetSupportWidgetIdResponse, GetUserByIdResponse, 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, StrongPasswordOptions, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.js CHANGED
@@ -1164,6 +1164,19 @@ var ChatWebserviceGateway = class {
1164
1164
  const { data } = await this.httpClient.patch(`${this.baseUrl}/member/${memberId}`, payload);
1165
1165
  return data;
1166
1166
  }
1167
+ /**
1168
+ * Fetches aggregated chat and email usage for a company.
1169
+ * @param companyId - The company identifier.
1170
+ * @param params - Optional date range filters.
1171
+ * @returns The aggregated chat and email usage totals.
1172
+ */
1173
+ async getCompanyUsage(companyId, params = {}) {
1174
+ const { data } = await this.httpClient.get(
1175
+ `${this.baseUrl}/companies/${companyId}/usage`,
1176
+ { params }
1177
+ );
1178
+ return data;
1179
+ }
1167
1180
  };
1168
1181
 
1169
1182
  // src/call-report/index.ts
@@ -1185,6 +1198,19 @@ var CallReportGateway = class {
1185
1198
  });
1186
1199
  return data;
1187
1200
  }
1201
+ /**
1202
+ * Fetches aggregated telephony usage for a company.
1203
+ * @param companyId - The company identifier.
1204
+ * @param params - Optional date range filters.
1205
+ * @returns The aggregated telephony usage totals.
1206
+ */
1207
+ async getCompanyUsage(companyId, params = {}) {
1208
+ const { data } = await this.httpClient.get(
1209
+ `${this.baseUrl}/companies/${companyId}/usage`,
1210
+ { params }
1211
+ );
1212
+ return data;
1213
+ }
1188
1214
  };
1189
1215
 
1190
1216
  // src/calls/index.ts
@@ -1200,7 +1226,7 @@ var CallsGateway = class {
1200
1226
  * @returns The list of call endpoints.
1201
1227
  */
1202
1228
  async getEndpoints() {
1203
- const { data } = await this.httpClient.get(`${this.baseUrl}/endpoints`);
1229
+ const { data } = await this.httpClient.get(`${this.baseUrl}/api/v1/endpoints`);
1204
1230
  return data;
1205
1231
  }
1206
1232
  };