@opens/gateways 1.16.19 → 1.16.21

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

@@ -337,11 +337,21 @@ interface QueueRule extends Rule {
     flow?: Rule[];
 }
 /** Known rule action values used by the Chat Config API. */
-type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | 'callOnQueue' | 'ura' | 'webhook' | 'questionnaire' | 'flow' | 'csat';
+type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | 'automatic-message' | 'callOnQueue' | 'ura' | 'webhook' | 'questionnaire' | 'flow' | 'csat';
 /** Archive filter for listing rules. Matches `GET /rules/paginated` query validation. */
 type RuleArchiveStatus = 'archived' | 'unarchived' | 'all';
 /** Associations that can be eager-loaded when listing paginated rules. */
 type RuleAssociation = 'flow';
+/** HTTP method used by webhook and questionnaire outbound requests. */
+type RuleHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | string;
+/** Interactive presentation for URA rules (`settings.interactiveType`). */
+type RuleInteractiveType = 'button' | 'list';
+/** Validation action taken after a questionnaire answer is validated. */
+type RuleQuestionnaireValidationAction = 'nextQuestion' | 'sendToRule' | 'terminateChat' | 'nextFlow' | 'addAutoTags' | string;
+/** Built-in regex validation kinds for questionnaire questions. */
+type RuleQuestionnaireValidationRegexType = 'email' | 'cpf' | 'lettersOnly' | 'numbersOnly' | 'customExpression' | '' | string;
+/** Question input type for questionnaire questions. */
+type RuleQuestionnaireQuestionType = 'interactive_menu' | string;
 /** Request query parameters for listing root rules. */
 type GetRootRulesRequest = {
     companyId: string;
@@ -374,35 +384,157 @@ type GetRulesCountRequest = {
     action?: RuleAction[];
     archiveStatus?: RuleArchiveStatus;
 };
+/**
+ * Request query parameters for fetching a rule by id (`GET /rules/:id`).
+ * When `rootOnly` is omitted the API defaults to `true` (no recursive flow tree).
+ * Pass `rootOnly: false` to expand nested `flow` via `buildRuleTree`.
+ */
+type GetRuleByIdRequest = {
+    rootOnly?: boolean;
+    includeFlow?: boolean;
+    collapseDistinctId?: boolean;
+    distinctId?: boolean | string;
+    expand?: RuleAssociation[];
+};
 /** Automatic message payload stored on a rule. */
 interface RuleAutomaticMessage {
     messageBody: string;
-    caption: string | null;
-    messageType: string;
+    caption?: string | null;
+    messageType?: string;
+}
+/** Call-on-queue payload stored on a rule. */
+interface RuleCallOnQueue {
+    id: string;
+    attendanceGroupId?: string;
+    voiceTimeout?: number;
+    minutesToExpire?: number;
+    callToActionMessage?: string;
+}
+/** Custom HTTP header used by webhook requests. */
+interface RuleWebhookHeader {
+    key: string;
+    value: string;
+}
+/** Mapping from a webhook JSON response path into a context key. */
+interface RuleWebhookResponseMapping {
+    replaceValue: string;
+    jsonPath: string;
+    newJsonKey: string;
+}
+/** Webhook configuration stored on a rule. */
+interface RuleWebhook {
+    customHeaders: RuleWebhookHeader[];
+    webhookMethodType: RuleHttpMethod;
+    webhookEndpoint: string;
+    webhookResponseMappings: RuleWebhookResponseMapping[];
+}
+/** Interactive option used by questionnaire `interactive_menu` questions. */
+interface RuleQuestionnaireInteractiveOption {
+    id: string;
+    text: string;
+}
+/** Single question inside a questionnaire rule. */
+interface RuleQuestionnaireQuestion {
+    questionText: string;
+    isResponsePrivateEnabled?: boolean;
+    isEnabledCustomDebounce?: boolean;
+    customDebounceSeconds?: number;
+    hasValidation?: boolean;
+    isUsingCustomValidation?: boolean;
+    customValidationUrl?: string;
+    customValidationMethod?: string;
+    validationRegexType?: RuleQuestionnaireValidationRegexType;
+    validationRegexPattern?: string;
+    maxValidationAttempts?: number;
+    onValidationFailureReply?: string;
+    onValidationSuccessAction?: RuleQuestionnaireValidationAction;
+    onValidationSuccessActionTarget?: string;
+    onValidationFailureAction?: RuleQuestionnaireValidationAction;
+    onValidationFailureActionTarget?: string;
+    onValidationFailureMessage?: string;
+    onValidationSuccessAutoTagIds?: number[];
+    onValidationFailureAutoTagIds?: number[];
+    questionType?: RuleQuestionnaireQuestionType;
+    interactiveOptions?: RuleQuestionnaireInteractiveOption[];
+}
+/** HTTP header sent with the questionnaire outbound request. */
+interface RuleQuestionnaireHeader {
+    id?: number;
+    key: string;
+    value: string;
+}
+/** Body/query field sent with the questionnaire outbound request. */
+interface RuleQuestionnaireBodyField {
+    id?: number;
+    key: string;
+    value: string;
+    isFilledByAnswer?: boolean;
+    answerIndex?: number | null;
+}
+/**
+ * Questionnaire configuration stored on a rule.
+ * The API may return `null`, a full object, or an empty object `{}`.
+ */
+interface RuleQuestionnaire {
+    questions?: RuleQuestionnaireQuestion[];
+    questionHeaders?: RuleQuestionnaireHeader[];
+    questionBodyFields?: RuleQuestionnaireBodyField[];
+    questionEndpoint?: string;
+    questionMethodType?: RuleHttpMethod | '';
+}
+/** Text-response behavior for Meta flow rules (`settings.flow.textResponse`). */
+interface RuleFlowTextResponse {
+    behavior: 'require_flow' | 'redirect_rule';
+    sendReminder?: boolean;
+    reminderMessage?: string;
+    targetRuleId?: string;
+}
+/** Meta interactive flow configuration (`settings.flow`). */
+interface RuleFlowSettings {
+    configId: string;
+    metaFlowId: string;
+    flowAction: 'navigate' | 'data_exchange';
+    flowCta: string;
+    flowBody: string;
+    webhookUrl?: string;
+    firstScreen?: string;
+    flowHeader?: string;
+    flowFooter?: string;
+    contextKey?: string;
+    textResponse?: RuleFlowTextResponse;
+}
+/**
+ * Rule settings JSON.
+ * Common keys: `interactiveType` (URA) and `flow` (action `flow`).
+ */
+interface RuleSettings {
+    interactiveType?: RuleInteractiveType;
+    flow?: RuleFlowSettings;
+    [key: string]: unknown;
 }
 /** Rule entity returned by the Chat Config API. */
 interface Rule {
     id: string;
     companyId: string;
     name: string;
-    action: string;
+    action: RuleAction | string;
     message: string | null;
     automaticMessage: RuleAutomaticMessage | null;
-    callOnQueue: Record<string, unknown> | null;
+    callOnQueue: RuleCallOnQueue | null;
     uraDescription: string | null;
     interactiveMessageId: string | null;
     configId: string | null;
     queueId: string | null;
     redirectQueue: string | null;
     redirectRuleId: string | null;
-    questionnaire: Record<string, unknown> | null;
-    webhook: Record<string, unknown> | null;
+    questionnaire: RuleQuestionnaire | null;
+    webhook: RuleWebhook | null;
     isRoot: boolean;
     redirectDefault: boolean;
     redirectTimeout: number;
     delay: number | null;
     disableTyping: boolean;
-    settings: Record<string, unknown> | null;
+    settings: RuleSettings | null;
     archivedAt: string | null;
     autoTagEnabled: boolean;
     autoTagIds: number[];
@@ -410,6 +542,8 @@ interface Rule {
     updatedAt: string;
     flow?: Rule[];
 }
+/** Response returned by `GET /rules/:id`. */
+type RuleResponse = Rule;
 /** Response returned by the Chat Config API when listing paginated rules. */
 type RulesResponse = {
     data: Rule[];
@@ -421,4 +555,4 @@ type RulesCountResponse = {
 /** Response returned by the Chat Config API when listing root rules. */
 type RootRulesResponse = RulesResponse;
 
-export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRootRulesRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RulesCountResponse, RulesResponse, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleResponse, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, RulesCountResponse, RulesResponse, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };

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

@@ -337,11 +337,21 @@ interface QueueRule extends Rule {
     flow?: Rule[];
 }
 /** Known rule action values used by the Chat Config API. */
-type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | 'callOnQueue' | 'ura' | 'webhook' | 'questionnaire' | 'flow' | 'csat';
+type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | 'automatic-message' | 'callOnQueue' | 'ura' | 'webhook' | 'questionnaire' | 'flow' | 'csat';
 /** Archive filter for listing rules. Matches `GET /rules/paginated` query validation. */
 type RuleArchiveStatus = 'archived' | 'unarchived' | 'all';
 /** Associations that can be eager-loaded when listing paginated rules. */
 type RuleAssociation = 'flow';
+/** HTTP method used by webhook and questionnaire outbound requests. */
+type RuleHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | string;
+/** Interactive presentation for URA rules (`settings.interactiveType`). */
+type RuleInteractiveType = 'button' | 'list';
+/** Validation action taken after a questionnaire answer is validated. */
+type RuleQuestionnaireValidationAction = 'nextQuestion' | 'sendToRule' | 'terminateChat' | 'nextFlow' | 'addAutoTags' | string;
+/** Built-in regex validation kinds for questionnaire questions. */
+type RuleQuestionnaireValidationRegexType = 'email' | 'cpf' | 'lettersOnly' | 'numbersOnly' | 'customExpression' | '' | string;
+/** Question input type for questionnaire questions. */
+type RuleQuestionnaireQuestionType = 'interactive_menu' | string;
 /** Request query parameters for listing root rules. */
 type GetRootRulesRequest = {
     companyId: string;
@@ -374,35 +384,157 @@ type GetRulesCountRequest = {
     action?: RuleAction[];
     archiveStatus?: RuleArchiveStatus;
 };
+/**
+ * Request query parameters for fetching a rule by id (`GET /rules/:id`).
+ * When `rootOnly` is omitted the API defaults to `true` (no recursive flow tree).
+ * Pass `rootOnly: false` to expand nested `flow` via `buildRuleTree`.
+ */
+type GetRuleByIdRequest = {
+    rootOnly?: boolean;
+    includeFlow?: boolean;
+    collapseDistinctId?: boolean;
+    distinctId?: boolean | string;
+    expand?: RuleAssociation[];
+};
 /** Automatic message payload stored on a rule. */
 interface RuleAutomaticMessage {
     messageBody: string;
-    caption: string | null;
-    messageType: string;
+    caption?: string | null;
+    messageType?: string;
+}
+/** Call-on-queue payload stored on a rule. */
+interface RuleCallOnQueue {
+    id: string;
+    attendanceGroupId?: string;
+    voiceTimeout?: number;
+    minutesToExpire?: number;
+    callToActionMessage?: string;
+}
+/** Custom HTTP header used by webhook requests. */
+interface RuleWebhookHeader {
+    key: string;
+    value: string;
+}
+/** Mapping from a webhook JSON response path into a context key. */
+interface RuleWebhookResponseMapping {
+    replaceValue: string;
+    jsonPath: string;
+    newJsonKey: string;
+}
+/** Webhook configuration stored on a rule. */
+interface RuleWebhook {
+    customHeaders: RuleWebhookHeader[];
+    webhookMethodType: RuleHttpMethod;
+    webhookEndpoint: string;
+    webhookResponseMappings: RuleWebhookResponseMapping[];
+}
+/** Interactive option used by questionnaire `interactive_menu` questions. */
+interface RuleQuestionnaireInteractiveOption {
+    id: string;
+    text: string;
+}
+/** Single question inside a questionnaire rule. */
+interface RuleQuestionnaireQuestion {
+    questionText: string;
+    isResponsePrivateEnabled?: boolean;
+    isEnabledCustomDebounce?: boolean;
+    customDebounceSeconds?: number;
+    hasValidation?: boolean;
+    isUsingCustomValidation?: boolean;
+    customValidationUrl?: string;
+    customValidationMethod?: string;
+    validationRegexType?: RuleQuestionnaireValidationRegexType;
+    validationRegexPattern?: string;
+    maxValidationAttempts?: number;
+    onValidationFailureReply?: string;
+    onValidationSuccessAction?: RuleQuestionnaireValidationAction;
+    onValidationSuccessActionTarget?: string;
+    onValidationFailureAction?: RuleQuestionnaireValidationAction;
+    onValidationFailureActionTarget?: string;
+    onValidationFailureMessage?: string;
+    onValidationSuccessAutoTagIds?: number[];
+    onValidationFailureAutoTagIds?: number[];
+    questionType?: RuleQuestionnaireQuestionType;
+    interactiveOptions?: RuleQuestionnaireInteractiveOption[];
+}
+/** HTTP header sent with the questionnaire outbound request. */
+interface RuleQuestionnaireHeader {
+    id?: number;
+    key: string;
+    value: string;
+}
+/** Body/query field sent with the questionnaire outbound request. */
+interface RuleQuestionnaireBodyField {
+    id?: number;
+    key: string;
+    value: string;
+    isFilledByAnswer?: boolean;
+    answerIndex?: number | null;
+}
+/**
+ * Questionnaire configuration stored on a rule.
+ * The API may return `null`, a full object, or an empty object `{}`.
+ */
+interface RuleQuestionnaire {
+    questions?: RuleQuestionnaireQuestion[];
+    questionHeaders?: RuleQuestionnaireHeader[];
+    questionBodyFields?: RuleQuestionnaireBodyField[];
+    questionEndpoint?: string;
+    questionMethodType?: RuleHttpMethod | '';
+}
+/** Text-response behavior for Meta flow rules (`settings.flow.textResponse`). */
+interface RuleFlowTextResponse {
+    behavior: 'require_flow' | 'redirect_rule';
+    sendReminder?: boolean;
+    reminderMessage?: string;
+    targetRuleId?: string;
+}
+/** Meta interactive flow configuration (`settings.flow`). */
+interface RuleFlowSettings {
+    configId: string;
+    metaFlowId: string;
+    flowAction: 'navigate' | 'data_exchange';
+    flowCta: string;
+    flowBody: string;
+    webhookUrl?: string;
+    firstScreen?: string;
+    flowHeader?: string;
+    flowFooter?: string;
+    contextKey?: string;
+    textResponse?: RuleFlowTextResponse;
+}
+/**
+ * Rule settings JSON.
+ * Common keys: `interactiveType` (URA) and `flow` (action `flow`).
+ */
+interface RuleSettings {
+    interactiveType?: RuleInteractiveType;
+    flow?: RuleFlowSettings;
+    [key: string]: unknown;
 }
 /** Rule entity returned by the Chat Config API. */
 interface Rule {
     id: string;
     companyId: string;
     name: string;
-    action: string;
+    action: RuleAction | string;
     message: string | null;
     automaticMessage: RuleAutomaticMessage | null;
-    callOnQueue: Record<string, unknown> | null;
+    callOnQueue: RuleCallOnQueue | null;
     uraDescription: string | null;
     interactiveMessageId: string | null;
     configId: string | null;
     queueId: string | null;
     redirectQueue: string | null;
     redirectRuleId: string | null;
-    questionnaire: Record<string, unknown> | null;
-    webhook: Record<string, unknown> | null;
+    questionnaire: RuleQuestionnaire | null;
+    webhook: RuleWebhook | null;
     isRoot: boolean;
     redirectDefault: boolean;
     redirectTimeout: number;
     delay: number | null;
     disableTyping: boolean;
-    settings: Record<string, unknown> | null;
+    settings: RuleSettings | null;
     archivedAt: string | null;
     autoTagEnabled: boolean;
     autoTagIds: number[];
@@ -410,6 +542,8 @@ interface Rule {
     updatedAt: string;
     flow?: Rule[];
 }
+/** Response returned by `GET /rules/:id`. */
+type RuleResponse = Rule;
 /** Response returned by the Chat Config API when listing paginated rules. */
 type RulesResponse = {
     data: Rule[];
@@ -421,4 +555,4 @@ type RulesCountResponse = {
 /** Response returned by the Chat Config API when listing root rules. */
 type RootRulesResponse = RulesResponse;
 
-export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRootRulesRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RulesCountResponse, RulesResponse, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };
+export type { Config, ConfigListByProviderResponse, ConfigProvider, DistributionType, FindOrCreateQueueRuleRequest, GetConfigsByProviderParams, GetMemberQueuesRequest, GetProviderConfigurationsParams, GetProviderDisplayInfoParams, GetRootRulesRequest, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleResponse, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, RulesCountResponse, RulesResponse, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };