@opens/gateways 1.5.1 → 1.7.0

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

@@ -0,0 +1,67 @@
+/** Parameters for retrieving configuration templates. */
+interface GetConfigTemplatesParams {
+    /** Optional template name filter. */
+    templateName?: string;
+    /** Optional maximum number of templates to return. */
+    limit?: number;
+    /** Optional status filter (e.g. 'APPROVED', 'REJECTED', 'PENDING'). */
+    status?: string;
+    /** Optional category filter (e.g. 'UTILITY', 'MARKETING', 'AUTHENTICATION'). */
+    category?: string;
+    /** Optional pagination cursor token/URL. */
+    next?: string;
+    /** Optional pagination cursor 'after' parameter. */
+    after?: string;
+}
+/** Component of a message template. */
+interface MessageTemplateComponent {
+    /** Type of the component (e.g. 'HEADER', 'BODY', 'FOOTER', 'BUTTONS'). */
+    type: string;
+    /** Format of the component (e.g. 'TEXT', 'IMAGE', 'DOCUMENT', 'VIDEO'). */
+    format?: string;
+    /** Text content of the component. */
+    text?: string;
+    /** List of buttons in the component if type is 'BUTTONS'. */
+    buttons?: Array<{
+        type: string;
+        text: string;
+        url?: string;
+        phoneNumber?: string;
+    }>;
+}
+/** Details of a message template. */
+interface MessageTemplate {
+    /** Name of the message template. */
+    name: string;
+    /** Status of the template (e.g. 'APPROVED', 'REJECTED', 'PENDING'). */
+    status: string;
+    /** Category of the template (e.g. 'UTILITY', 'MARKETING', 'AUTHENTICATION'). */
+    category: string;
+    /** Language locale of the template (e.g. 'pt_BR', 'en_US'). */
+    language: string;
+    /** Components that build up the template content. */
+    components: MessageTemplateComponent[];
+    /** Unique identifier of the template. */
+    id: string;
+}
+/** Pagination information for the template query response. */
+interface ConfigTemplatesPaging {
+    /** Cursors used to paginate results. */
+    cursors?: {
+        /** Cursor pointing to the start of the current range. */
+        before?: string;
+        /** Cursor pointing to the end of the current range. */
+        after?: string;
+    };
+    /** URL for the next page of results. */
+    next?: string;
+}
+/** Response containing the list of message templates configured. */
+interface GetConfigTemplatesResponse {
+    /** List of message templates. */
+    data: MessageTemplate[];
+    /** Pagination information. */
+    paging?: ConfigTemplatesPaging;
+}
+
+export type { ConfigTemplatesPaging, GetConfigTemplatesParams, GetConfigTemplatesResponse, MessageTemplate, MessageTemplateComponent };

package/dist/chat-adapter/contracts/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/chat-adapter/contracts/index.ts
+var contracts_exports = {};
+module.exports = __toCommonJS(contracts_exports);
+//# sourceMappingURL=index.js.map

package/dist/chat-adapter/contracts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/chat-adapter/contracts/index.ts"],"sourcesContent":["export * from './chat-adapter';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/chat-adapter/contracts/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/chat-adapter/contracts/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

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

@@ -0,0 +1,201 @@
+/** A provider entity returned by the Chat Config API. */
+interface Provider {
+    id: string;
+    name: string;
+    configurationsSchema: Record<string, unknown> | null;
+    defaultSession: number;
+    type: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Chat Config API when listing providers. */
+type ProviderListResponse = Provider[];
+
+/** A provider entity nested within a configuration response. */
+interface ConfigProvider {
+    id: string;
+    name: string;
+    type: string;
+    defaultSession: number;
+    configurationsSchema: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A configuration entity returned by the Chat Config API. */
+interface Config {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number | null;
+    companyId: string;
+    active: boolean;
+    configurations: Record<string, unknown>;
+    priority: number | null;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    providers: ConfigProvider;
+}
+/** Response returned by the Chat Config API when listing configurations by provider. */
+interface ConfigListByProviderResponse {
+    configurations: Config[];
+}
+/** Query parameters for filtering configurations by provider. */
+interface GetConfigsByProviderParams {
+    isAssistanceEnabled?: boolean;
+    rewind?: number;
+    active?: boolean;
+    priority?: number;
+    inbound?: boolean;
+    outbound?: boolean;
+    providerType?: string;
+    providerName?: string;
+}
+
+interface QueueMember {
+    id: string;
+    memberId: string;
+    priority: number;
+    permission: string;
+    lastAttendance: string;
+    lastInvite: string;
+    paused: boolean;
+    activeChat: number;
+    online: boolean;
+    companyId: string;
+    avatar: string;
+    username: string;
+    createdAt: string;
+    updatedAt: string;
+    queueId: string;
+}
+type DistributionType = {
+    id: string;
+    alias: string;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+};
+interface Queue {
+    id: string;
+    distributionTypeId: string;
+    companyId: string;
+    name: string;
+    strategy: 'leastrecent' | 'roundrobin' | 'random';
+    defaultQueue: boolean;
+    unlimitedService: boolean;
+    serviceLimit: number;
+    timeLimit: number;
+    skipOncallUsers: boolean;
+    csat: boolean;
+    csatAnswer: string;
+    csatTTL: number;
+    outsideBusinessHourMessage: string;
+    createCallbackOnExpired: boolean;
+    createCallbackOnOutsideBusinessHours: boolean;
+    archived: boolean;
+    isPrivate: boolean;
+    createdAt: string;
+    updatedAt: string;
+    members: QueueMember[];
+    distributionType: DistributionType;
+}
+/** Response returned when listing queues. */
+interface QueueListResponse {
+    queues: Queue[];
+}
+
+/** Representation of a button in a Meta template. */
+interface MetaTemplateButton {
+    /** Unique identifier of the button. */
+    id: string;
+    /** Type of the button (e.g. 'URL', 'PHONE_NUMBER', 'QUICK_REPLY'). */
+    type: string;
+    /** Text displayed on the button. */
+    text: string;
+    /** Value of the button (e.g. URL or phone number). */
+    value?: string | null;
+    /** Dynamic variable of the button. */
+    variable?: string | null;
+    /** ID of the template configuration to which the button belongs. */
+    templateConfigId: string;
+    /** Creation date of the record. */
+    createdAt?: string;
+    /** Update date of the record. */
+    updatedAt?: string;
+}
+/** Detailed configuration of a Meta template. */
+interface MetaTemplateConfigResponse {
+    /** Unique identifier of the template configuration. */
+    id: string;
+    /** Name of the template in Meta. */
+    name: string;
+    /** Identifier of the template in Meta. */
+    templateId: string;
+    /** Company identifier in Meta. */
+    companyId: string;
+    /** Format of the template (e.g. TEXT, IMAGE, VIDEO). */
+    format?: string | null;
+    /** Content of the template header. */
+    headerContent?: string | null;
+    /** Defines if the header has dynamic content (parameters). */
+    isDynamicHeader: boolean;
+    /** Type of the header (e.g. TEXT, IMAGE, DOCUMENT, VIDEO). */
+    headerType?: string | null;
+    /** Content of the template body. */
+    bodyContent?: string | null;
+    /** Type of the body (e.g. TEXT). */
+    bodyType?: string | null;
+    /** Content of the template footer. */
+    footerContent?: string | null;
+    /** Type of the footer (e.g. TEXT). */
+    footerType?: string | null;
+    /** ID of the configuration associated with the template. */
+    configId?: string | null;
+    /** ID of the provider associated with the template. */
+    providerId?: string | null;
+    /** Creation date of the record. */
+    createdAt?: string;
+    /** Update date of the record. */
+    updatedAt?: string;
+    /** List of buttons in the template. */
+    buttons?: MetaTemplateButton[];
+}
+/** Response containing the list of template configurations associated with a configuration. */
+interface MetaTemplateConfigsResponse {
+    /** List of Meta template configurations. */
+    templatesConfig: MetaTemplateConfigResponse[];
+}
+
+/** Request payload for finding or creating a queue rule. */
+interface FindOrCreateQueueRuleRequest {
+    companyId: string;
+    queueId: string;
+    configId: string;
+}
+/** Response returned when finding or creating a queue rule. */
+interface QueueRule {
+    id: string;
+    companyId: string;
+    name: string;
+    action: string;
+    message?: string;
+    automaticMessage?: Record<string, unknown>;
+    callOnQueue?: Record<string, unknown>;
+    uraDescription: string;
+    interactiveMessageId: string | null;
+    configId?: string;
+    queueId?: string;
+    redirectQueue: Record<string, unknown> | null;
+    redirectRuleId?: string;
+    questionnaire?: Record<string, unknown>;
+    webhook?: Record<string, unknown>;
+    isRoot: boolean;
+    redirectDefault: boolean;
+    redirectTimeout?: number;
+    delay?: number;
+    createdAt: string;
+    updatedAt: string;
+    flow?: Record<string, unknown>[];
+}
+
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule };

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

@@ -0,0 +1,201 @@
+/** A provider entity returned by the Chat Config API. */
+interface Provider {
+    id: string;
+    name: string;
+    configurationsSchema: Record<string, unknown> | null;
+    defaultSession: number;
+    type: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Chat Config API when listing providers. */
+type ProviderListResponse = Provider[];
+
+/** A provider entity nested within a configuration response. */
+interface ConfigProvider {
+    id: string;
+    name: string;
+    type: string;
+    defaultSession: number;
+    configurationsSchema: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A configuration entity returned by the Chat Config API. */
+interface Config {
+    id: string;
+    isAssistanceEnabled: boolean;
+    rewind: number | null;
+    companyId: string;
+    active: boolean;
+    configurations: Record<string, unknown>;
+    priority: number | null;
+    inbound: boolean;
+    outbound: boolean;
+    deletedAt: string | null;
+    providers: ConfigProvider;
+}
+/** Response returned by the Chat Config API when listing configurations by provider. */
+interface ConfigListByProviderResponse {
+    configurations: Config[];
+}
+/** Query parameters for filtering configurations by provider. */
+interface GetConfigsByProviderParams {
+    isAssistanceEnabled?: boolean;
+    rewind?: number;
+    active?: boolean;
+    priority?: number;
+    inbound?: boolean;
+    outbound?: boolean;
+    providerType?: string;
+    providerName?: string;
+}
+
+interface QueueMember {
+    id: string;
+    memberId: string;
+    priority: number;
+    permission: string;
+    lastAttendance: string;
+    lastInvite: string;
+    paused: boolean;
+    activeChat: number;
+    online: boolean;
+    companyId: string;
+    avatar: string;
+    username: string;
+    createdAt: string;
+    updatedAt: string;
+    queueId: string;
+}
+type DistributionType = {
+    id: string;
+    alias: string;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+};
+interface Queue {
+    id: string;
+    distributionTypeId: string;
+    companyId: string;
+    name: string;
+    strategy: 'leastrecent' | 'roundrobin' | 'random';
+    defaultQueue: boolean;
+    unlimitedService: boolean;
+    serviceLimit: number;
+    timeLimit: number;
+    skipOncallUsers: boolean;
+    csat: boolean;
+    csatAnswer: string;
+    csatTTL: number;
+    outsideBusinessHourMessage: string;
+    createCallbackOnExpired: boolean;
+    createCallbackOnOutsideBusinessHours: boolean;
+    archived: boolean;
+    isPrivate: boolean;
+    createdAt: string;
+    updatedAt: string;
+    members: QueueMember[];
+    distributionType: DistributionType;
+}
+/** Response returned when listing queues. */
+interface QueueListResponse {
+    queues: Queue[];
+}
+
+/** Representation of a button in a Meta template. */
+interface MetaTemplateButton {
+    /** Unique identifier of the button. */
+    id: string;
+    /** Type of the button (e.g. 'URL', 'PHONE_NUMBER', 'QUICK_REPLY'). */
+    type: string;
+    /** Text displayed on the button. */
+    text: string;
+    /** Value of the button (e.g. URL or phone number). */
+    value?: string | null;
+    /** Dynamic variable of the button. */
+    variable?: string | null;
+    /** ID of the template configuration to which the button belongs. */
+    templateConfigId: string;
+    /** Creation date of the record. */
+    createdAt?: string;
+    /** Update date of the record. */
+    updatedAt?: string;
+}
+/** Detailed configuration of a Meta template. */
+interface MetaTemplateConfigResponse {
+    /** Unique identifier of the template configuration. */
+    id: string;
+    /** Name of the template in Meta. */
+    name: string;
+    /** Identifier of the template in Meta. */
+    templateId: string;
+    /** Company identifier in Meta. */
+    companyId: string;
+    /** Format of the template (e.g. TEXT, IMAGE, VIDEO). */
+    format?: string | null;
+    /** Content of the template header. */
+    headerContent?: string | null;
+    /** Defines if the header has dynamic content (parameters). */
+    isDynamicHeader: boolean;
+    /** Type of the header (e.g. TEXT, IMAGE, DOCUMENT, VIDEO). */
+    headerType?: string | null;
+    /** Content of the template body. */
+    bodyContent?: string | null;
+    /** Type of the body (e.g. TEXT). */
+    bodyType?: string | null;
+    /** Content of the template footer. */
+    footerContent?: string | null;
+    /** Type of the footer (e.g. TEXT). */
+    footerType?: string | null;
+    /** ID of the configuration associated with the template. */
+    configId?: string | null;
+    /** ID of the provider associated with the template. */
+    providerId?: string | null;
+    /** Creation date of the record. */
+    createdAt?: string;
+    /** Update date of the record. */
+    updatedAt?: string;
+    /** List of buttons in the template. */
+    buttons?: MetaTemplateButton[];
+}
+/** Response containing the list of template configurations associated with a configuration. */
+interface MetaTemplateConfigsResponse {
+    /** List of Meta template configurations. */
+    templatesConfig: MetaTemplateConfigResponse[];
+}
+
+/** Request payload for finding or creating a queue rule. */
+interface FindOrCreateQueueRuleRequest {
+    companyId: string;
+    queueId: string;
+    configId: string;
+}
+/** Response returned when finding or creating a queue rule. */
+interface QueueRule {
+    id: string;
+    companyId: string;
+    name: string;
+    action: string;
+    message?: string;
+    automaticMessage?: Record<string, unknown>;
+    callOnQueue?: Record<string, unknown>;
+    uraDescription: string;
+    interactiveMessageId: string | null;
+    configId?: string;
+    queueId?: string;
+    redirectQueue: Record<string, unknown> | null;
+    redirectRuleId?: string;
+    questionnaire?: Record<string, unknown>;
+    webhook?: Record<string, unknown>;
+    isRoot: boolean;
+    redirectDefault: boolean;
+    redirectTimeout?: number;
+    delay?: number;
+    createdAt: string;
+    updatedAt: string;
+    flow?: Record<string, unknown>[];
+}
+
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderListResponse, Queue, QueueListResponse, QueueMember, QueueRule };

package/dist/chat-config/contracts/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/chat-config/contracts/index.ts
+var contracts_exports = {};
+module.exports = __toCommonJS(contracts_exports);
+//# sourceMappingURL=index.js.map

package/dist/chat-config/contracts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/chat-config/contracts/index.ts"],"sourcesContent":["export * from './config';\nexport * from './provider';\nexport * from './queues';\nexport * from './meta-template';\nexport * from './rule';"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/chat-config/contracts/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/chat-config/contracts/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

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

@@ -0,0 +1,95 @@
+/** Shared company data fields returned by the Customer Service API. */
+interface CompanyData {
+    id: string;
+    name: string;
+    hostname: string;
+    crm_code: string;
+    token: string;
+    status: string;
+    timezone: string;
+    utc: string;
+    check_bad_password: boolean;
+    limit_bad_password: number;
+    watching: boolean;
+    trial: boolean;
+    support_widget_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a company. */
+interface CompanyResponse {
+    company: CompanyData;
+}
+
+/** A work group entity nested within {@link WorkGroupListResponse} and {@link WorkGroupResponse}. */
+interface WorkGroup {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching the work groups list. */
+interface WorkGroupListResponse extends CompanyData {
+    workgroups: WorkGroup[];
+}
+/** A user membership entity nested within {@link WorkGroupResponse}. */
+interface WorkGroupMember {
+    id: string;
+    username: string;
+    email: string;
+    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
+    status: 'new' | 'activated' | 'disabled';
+    avatar: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Response returned by the Customer Service API when fetching a single work group. */
+interface WorkGroupResponse {
+    id: string;
+    name: string;
+    description: string | null;
+    type: 'default' | 'user';
+    company_id: string;
+    createdAt: string;
+    updatedAt: string;
+    workgroups_users: WorkGroupMember[];
+}
+/** Response returned by the Customer Service API when fetching members of a work group. */
+type WorkGroupMembersResponse = WorkGroupMember[];
+
+interface User {
+    id: string;
+    username: string;
+    email: string;
+    profile: 'p_admin' | 'p_manager' | 'p_corporative' | 'p_agent';
+    status: 'new' | 'activated' | 'disabled';
+    avatar: string | null;
+    type: string;
+    companyId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface GetAllUsersParams {
+    status?: string;
+    includeWorkGroups?: boolean;
+    withoutOpensUsers?: boolean;
+}
+interface GetAllUsersResponse {
+    users: User[];
+}
+interface ManagedUser {
+    id: string;
+    username: string;
+    email: string;
+    profile: string;
+    status: string;
+    companyId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+type GetManagedUsersResponse = ManagedUser[];
+
+export type { CompanyData, CompanyResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, ManagedUser, User, WorkGroup, WorkGroupListResponse, WorkGroupMember, WorkGroupMembersResponse, WorkGroupResponse };