@opens/gateways 1.16.13 → 1.16.15

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.
@@ -4,8 +4,8 @@ interface FindOrCreateContactRequest {
4
4
  companyId: string;
5
5
  email: string;
6
6
  }
7
- /** Contact returned by the Contact List API. */
8
- interface ContactResponse {
7
+ /** Base contact data returned by the Contact List API. */
8
+ interface Contact {
9
9
  id: string;
10
10
  belongsTo: string;
11
11
  name: string;
@@ -20,6 +20,41 @@ interface ContactResponse {
20
20
  categoryId: string | null;
21
21
  organizationId: string | null;
22
22
  }
23
+ /** Contact returned by the Contact List API. */
24
+ interface ContactResponse extends Contact {
25
+ }
26
+ /** Contact phone returned when fetching a contact by identifier. */
27
+ interface FindContactByIdPhoneResponse {
28
+ id: number;
29
+ number: string;
30
+ ddi: string;
31
+ country: string;
32
+ isWhatsapp: boolean;
33
+ companyId: string;
34
+ isActive: boolean;
35
+ deletedAt: string | null;
36
+ fullNumber: string;
37
+ declinedMarketing: boolean;
38
+ createdAt: string;
39
+ updatedAt: string;
40
+ contactId: string;
41
+ }
42
+ /** Contact email returned when fetching a contact by identifier. */
43
+ interface FindContactByIdEmailResponse {
44
+ id: number;
45
+ address: string;
46
+ isActive: boolean;
47
+ deletedAt: string | null;
48
+ contactId: string;
49
+ }
50
+ /** Response returned by the Contact List API when fetching a contact by identifier. */
51
+ interface FindContactByIdResponse extends Contact {
52
+ phones: FindContactByIdPhoneResponse[];
53
+ emails: FindContactByIdEmailResponse[];
54
+ organization: Record<string, unknown> | null;
55
+ category: Record<string, unknown> | null;
56
+ instagramProfile: Record<string, unknown>[];
57
+ }
23
58
 
24
59
  /** Query parameters for searching contact phones. */
25
60
  interface GetContactPhonesParams {
@@ -66,4 +101,4 @@ interface ContactCategoryResponse {
66
101
  name: string;
67
102
  }
68
103
 
69
- export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindOrCreateContactRequest, GetContactPhonesParams };
104
+ export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
@@ -4,8 +4,8 @@ interface FindOrCreateContactRequest {
4
4
  companyId: string;
5
5
  email: string;
6
6
  }
7
- /** Contact returned by the Contact List API. */
8
- interface ContactResponse {
7
+ /** Base contact data returned by the Contact List API. */
8
+ interface Contact {
9
9
  id: string;
10
10
  belongsTo: string;
11
11
  name: string;
@@ -20,6 +20,41 @@ interface ContactResponse {
20
20
  categoryId: string | null;
21
21
  organizationId: string | null;
22
22
  }
23
+ /** Contact returned by the Contact List API. */
24
+ interface ContactResponse extends Contact {
25
+ }
26
+ /** Contact phone returned when fetching a contact by identifier. */
27
+ interface FindContactByIdPhoneResponse {
28
+ id: number;
29
+ number: string;
30
+ ddi: string;
31
+ country: string;
32
+ isWhatsapp: boolean;
33
+ companyId: string;
34
+ isActive: boolean;
35
+ deletedAt: string | null;
36
+ fullNumber: string;
37
+ declinedMarketing: boolean;
38
+ createdAt: string;
39
+ updatedAt: string;
40
+ contactId: string;
41
+ }
42
+ /** Contact email returned when fetching a contact by identifier. */
43
+ interface FindContactByIdEmailResponse {
44
+ id: number;
45
+ address: string;
46
+ isActive: boolean;
47
+ deletedAt: string | null;
48
+ contactId: string;
49
+ }
50
+ /** Response returned by the Contact List API when fetching a contact by identifier. */
51
+ interface FindContactByIdResponse extends Contact {
52
+ phones: FindContactByIdPhoneResponse[];
53
+ emails: FindContactByIdEmailResponse[];
54
+ organization: Record<string, unknown> | null;
55
+ category: Record<string, unknown> | null;
56
+ instagramProfile: Record<string, unknown>[];
57
+ }
23
58
 
24
59
  /** Query parameters for searching contact phones. */
25
60
  interface GetContactPhonesParams {
@@ -66,4 +101,4 @@ interface ContactCategoryResponse {
66
101
  name: string;
67
102
  }
68
103
 
69
- export type { ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindOrCreateContactRequest, GetContactPhonesParams };
104
+ export type { Contact, ContactCategoryResponse, ContactPhoneResponse, ContactPhoneSearchResponse, ContactResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse, FindContactByIdResponse, FindOrCreateContactRequest, GetContactPhonesParams };
@@ -66,7 +66,7 @@ interface UpdateCompanyJsonConfigRequest {
66
66
  valueJson: StrongPasswordOptions;
67
67
  }
68
68
  /** Known company config keys that accept a boolean value. */
69
- type CompanyBooleanConfigKey = 'block-silent-close' | 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
69
+ type CompanyBooleanConfigKey = 'block-anonymous-messages' | 'block-silent-close' | 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
70
70
  /** Known company config keys that accept a string value. */
71
71
  type CompanyStringConfigKey = 'proxy_ami' | 'snep_password' | 'snep_ip';
72
72
  /** Known company config keys that accept a JSON value. */
@@ -66,7 +66,7 @@ interface UpdateCompanyJsonConfigRequest {
66
66
  valueJson: StrongPasswordOptions;
67
67
  }
68
68
  /** Known company config keys that accept a boolean value. */
69
- type CompanyBooleanConfigKey = 'block-silent-close' | 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
69
+ type CompanyBooleanConfigKey = 'block-anonymous-messages' | 'block-silent-close' | 'mandatory-tag' | 'prevent-tag-edit' | 'inbox-hide-message-enabled' | 'show-deleted-users';
70
70
  /** Known company config keys that accept a string value. */
71
71
  type CompanyStringConfigKey = 'proxy_ami' | 'snep_password' | 'snep_ip';
72
72
  /** Known company config keys that accept a JSON value. */
package/dist/index.d.mts CHANGED
@@ -9,8 +9,8 @@ import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, Fl
9
9
  export { ConfigTemplatesPaging, FlowCatalogItem, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.mjs';
10
10
  import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.mjs';
11
11
  export { IUploadPresignedUrlResponse } from './assets/contracts/index.mjs';
12
- import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.mjs';
13
- export { ContactPhoneResponse } from './contact-list/contracts/index.mjs';
12
+ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.mjs';
13
+ export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse } 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
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';
@@ -488,6 +488,12 @@ declare class ContactListGateway {
488
488
  * @returns An array of contact categories.
489
489
  */
490
490
  getCategoryList(): Promise<ContactCategoryResponse[]>;
491
+ /**
492
+ * Finds a contact by its unique identifier.
493
+ * @param contactId - The unique identifier of the contact.
494
+ * @returns The contact and its associated details.
495
+ */
496
+ findById(contactId: string): Promise<FindContactByIdResponse>;
491
497
  /**
492
498
  * Finds an existing contact or creates a new one.
493
499
  * @param payload - The contact data sent as query parameters and in the request body.
@@ -991,4 +997,4 @@ declare const configure: (params: GatewayClientParams) => void;
991
997
  */
992
998
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
993
999
 
994
- 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, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, 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, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1000
+ 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, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, 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, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.d.ts CHANGED
@@ -9,8 +9,8 @@ import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, Fl
9
9
  export { ConfigTemplatesPaging, FlowCatalogItem, MessageTemplate, MessageTemplateComponent } from './chat-adapter/contracts/index.js';
10
10
  import { GetPresignedUrlRequest, UploadPresignedUrlResponse, AudioConvertResponse, GetAttachmentByIdRequest, AttachmentByIdResponse } from './assets/contracts/index.js';
11
11
  export { IUploadPresignedUrlResponse } from './assets/contracts/index.js';
12
- import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.js';
13
- export { ContactPhoneResponse } from './contact-list/contracts/index.js';
12
+ import { GetContactPhonesParams, ContactPhoneSearchResponse, ContactCategoryResponse, FindContactByIdResponse, FindOrCreateContactRequest, ContactResponse } from './contact-list/contracts/index.js';
13
+ export { Contact, ContactPhoneResponse, FindContactByIdEmailResponse, FindContactByIdPhoneResponse } 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
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';
@@ -488,6 +488,12 @@ declare class ContactListGateway {
488
488
  * @returns An array of contact categories.
489
489
  */
490
490
  getCategoryList(): Promise<ContactCategoryResponse[]>;
491
+ /**
492
+ * Finds a contact by its unique identifier.
493
+ * @param contactId - The unique identifier of the contact.
494
+ * @returns The contact and its associated details.
495
+ */
496
+ findById(contactId: string): Promise<FindContactByIdResponse>;
491
497
  /**
492
498
  * Finds an existing contact or creates a new one.
493
499
  * @param payload - The contact data sent as query parameters and in the request body.
@@ -991,4 +997,4 @@ declare const configure: (params: GatewayClientParams) => void;
991
997
  */
992
998
  declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
993
999
 
994
- 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, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, 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, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
1000
+ 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, CloneCaseRequest, ClonedCase, CommentHistoryPage, CompanyAccessPackageItem, CompanyBooleanConfigKey, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, CompanyQueue, CompanyResource, CompanyResponse, CompanyStringConfigKey, CompanyWithConfigsResponse, Config, ConfigListByProviderResponse, ContactCategoryResponse, ContactHistoryResponse, ContactPhoneSearchResponse, ContactResponse, CreateAnnouncementRequest, CreateAutomationPartnerRequest, CreateCampaignContactRequest, CreateCampaignRequest, CreateCampaignWorkGroupRequest, CreateCompanyAccessPackagePayload, CreateIntegrationActionRequest, CreateIntegrationFieldRequest, CreateIntegrationPartnerRequest, CreateTimeEntryRequest, CreateUserPreferenceRequest, CreateWebhookRequest$1 as CreateWebhookRequest, DeleteIntegrationActionParams, DeleteIntegrationFieldParams, DeleteIntegrationPartnerParams, DeleteTimeEntryRequest, DeleteUserDeviceResponse, DeleteUserPreferenceParams, DeleteUserPreferenceResponse, EnableCampaignCompanyRequest, FindContactByIdResponse, 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, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCasesRequest, ListCasesResponse, ListContactHistoryRequest, ListInvitationsRequest, ListLiveUserRoomsRequest, ListTimeEntriesPage, ListTimeEntriesRequest, ListUsersRequest, ListUsersResponse, LiveUserRoomResponse, MarkMessagesAsReadRequest, MarkMessagesAsReadResponse, MessageResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, PaginatedResult, PatchCampaignContactRequest, PatchCampaignRequest, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, Queue, QueueMember, QueueRule, RegisterUserDeviceRequest, RegisterUserDeviceResponse, ReplyInvitationRequest, RoomMemberResponse, RoomResponse, RootRulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCompanyAccessPackagePayload, UpdateCompanyBooleanConfigRequest, UpdateCompanyJsonConfigRequest, UpdateCompanyRequest, UpdateCompanyStringConfigRequest, UpdateCompanyUserAvatarResponse, UpdateCompanyUserRequest, UpdateIntegrationActionParams, UpdateIntegrationFieldParams, UpdateMemberInRoomRequest, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, UpdateTimeEntryRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UploadPresignedUrlResponse, User, UserPreference, UserProfile, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, WorkGroupListResponse, WorkGroupMembersResponse, WorkGroupResponse, configure, gateway };
package/dist/index.js CHANGED
@@ -871,6 +871,15 @@ var ContactListGateway = class {
871
871
  const { data } = await this.httpClient.get(`${this.baseUrl}/contact/category`);
872
872
  return data;
873
873
  }
874
+ /**
875
+ * Finds a contact by its unique identifier.
876
+ * @param contactId - The unique identifier of the contact.
877
+ * @returns The contact and its associated details.
878
+ */
879
+ async findById(contactId) {
880
+ const { data } = await this.httpClient.get(`${this.baseUrl}/contact/${contactId}`);
881
+ return data;
882
+ }
874
883
  /**
875
884
  * Finds an existing contact or creates a new one.
876
885
  * @param payload - The contact data sent as query parameters and in the request body.