@opens/gateways 1.16.18 → 1.16.20

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;
@@ -363,35 +373,168 @@ type GetRulesRequest = {
     archiveStatus?: RuleArchiveStatus;
     associations?: RuleAssociation[];
 };
+/**
+ * Request query parameters for counting rules (`GET /rules/count`).
+ * Shares the filter fields of `GetRulesRequest`, excluding pagination and associations.
+ */
+type GetRulesCountRequest = {
+    companyId: string;
+    name?: string;
+    isRoot?: boolean;
+    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[];
@@ -399,11 +542,17 @@ 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[];
 };
+/** Response returned by the Chat Config API when counting rules. */
+type RulesCountResponse = {
+    total: number;
+};
 /** 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, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, 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;
@@ -363,35 +373,168 @@ type GetRulesRequest = {
     archiveStatus?: RuleArchiveStatus;
     associations?: RuleAssociation[];
 };
+/**
+ * Request query parameters for counting rules (`GET /rules/count`).
+ * Shares the filter fields of `GetRulesRequest`, excluding pagination and associations.
+ */
+type GetRulesCountRequest = {
+    companyId: string;
+    name?: string;
+    isRoot?: boolean;
+    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[];
@@ -399,11 +542,17 @@ 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[];
 };
+/** Response returned by the Chat Config API when counting rules. */
+type RulesCountResponse = {
+    total: number;
+};
 /** 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, GetRulesRequest, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, 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/index.d.mts

@@ -1,8 +1,8 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.mjs';
 export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.mjs';
-import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse } from './chat-config/contracts/index.mjs';
-export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
+import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRuleByIdRequest, RuleResponse, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse, GetRulesCountRequest, RulesCountResponse } from './chat-config/contracts/index.mjs';
+export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.mjs';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.mjs';
 export { CampaignAccessReason, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignNameLikeQueryOperators, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.mjs';
 import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, FlowCatalogParams, FlowCatalogResponse, FlowDefinition } from './chat-adapter/contracts/index.mjs';
@@ -299,6 +299,14 @@ declare class ChatConfigGateway {
      * @returns The found or created queue rule.
      */
     findOrCreateQueueRule(payload: FindOrCreateQueueRuleRequest): Promise<QueueRule>;
+    /**
+     * Retrieves a rule by its ID (`GET /rules/:id`).
+     * Pass `rootOnly: false` to expand the nested `flow` tree recursively.
+     * @param ruleId - The unique identifier of the rule.
+     * @param params - Optional query parameters (`rootOnly`, `includeFlow`, etc.).
+     * @returns The rule, optionally with nested `flow`.
+     */
+    getRuleById(ruleId: string, params?: GetRuleByIdRequest): Promise<RuleResponse>;
     /**
      * @param params - The company and pagination parameters.
      * @returns The paginated initial service rules.
@@ -310,6 +318,12 @@ declare class ChatConfigGateway {
      * @returns The paginated rules matching the given filters.
      */
     getRules(params: GetRulesRequest): Promise<RulesResponse>;
+    /**
+     * Counts rules matching the given filters.
+     * @param params - Query parameters for filtering rules (same filters as `getRules`, without pagination/associations).
+     * @returns The total number of rules matching the filters.
+     */
+    getRulesCount(params: GetRulesCountRequest): Promise<RulesCountResponse>;
 }
 
 /**
@@ -1009,4 +1023,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-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, CaseStatus, 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, CreateCaseStatusRequest, 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, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, 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, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, 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 };
+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, CaseStatus, 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, CreateCaseStatusRequest, 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, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, 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, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, 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

@@ -1,8 +1,8 @@
 import { AxiosInstance } from 'axios';
 import { CompanyResponse, UpdateCompanyRequest, GetSupportWidgetIdResponse, UpdateSupportWidgetIdRequest, UpdateSupportWidgetIdResponse, CompanyQueue, CompanyWithConfigsResponse, StrongPasswordOptionsResponse, CompanyConfigKey, CompanyConfigResponse, CompanyJsonConfigKey, UpdateCompanyJsonConfigRequest, CompanyBooleanConfigKey, UpdateCompanyBooleanConfigRequest, CompanyStringConfigKey, UpdateCompanyStringConfigRequest, User, ListUsersRequest, ListUsersResponse, WorkGroupListResponse, WorkGroupResponse, UserProfile, WorkGroupMembersResponse, GetAllUsersParams, GetAllUsersResponse, GetManagedUsersResponse, GetUserByIdResponse, UpdateCompanyUserRequest, UpdateUserPasswordRequest, UpdateUserPasswordResponse, UpdateCompanyUserAvatarResponse, GenerateTwoFactorOtpRequest, GenerateTwoFactorOtpResponse, ValidateTwoFactorOtpRequest, ValidateTwoFactorOtpResponse, AnnouncementListFilters, AnnouncementListResponse, Announcement, CreateAnnouncementRequest, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, AnnouncementType, ActiveAnnouncementQuery, ActiveAnnouncement } from './customer-service/contracts/index.js';
 export { AnnouncementAppearance, AnnouncementButton, AnnouncementCompany, AnnouncementPayload, AnnouncementTargetingRuleUrl, AnnouncementTargetingRules, AnnouncementVisualStatus, CompanyData, ListUsersInclude, ListUsersProfile, ListUsersStatus, ListUsersType, ManagedUser, StrongPasswordOptions, UserBond, WorkGroup, WorkGroupMember } from './customer-service/contracts/index.js';
-import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse } from './chat-config/contracts/index.js';
-export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
+import { ProviderListResponse, Config, GetProviderConfigurationsParams, ProviderConfigurationsResponse, GetProviderDisplayInfoParams, ProviderDisplayInfoResponse, GetConfigsByProviderParams, ConfigListByProviderResponse, Queue, GetMemberQueuesRequest, QueueMember, GetServiceGroupsParams, ServiceGroupsResponse, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, FindOrCreateQueueRuleRequest, QueueRule, GetRuleByIdRequest, RuleResponse, GetRootRulesRequest, RootRulesResponse, GetRulesRequest, RulesResponse, GetRulesCountRequest, RulesCountResponse } from './chat-config/contracts/index.js';
+export { ConfigProvider, DistributionType, MetaTemplateButton, Provider, ProviderConfiguration, ProviderName, QueueListResponse, Rule, RuleAction, RuleArchiveStatus, RuleAssociation, RuleAutomaticMessage, RuleCallOnQueue, RuleFlowSettings, RuleFlowTextResponse, RuleHttpMethod, RuleInteractiveType, RuleQuestionnaire, RuleQuestionnaireBodyField, RuleQuestionnaireHeader, RuleQuestionnaireInteractiveOption, RuleQuestionnaireQuestion, RuleQuestionnaireQuestionType, RuleQuestionnaireValidationAction, RuleQuestionnaireValidationRegexType, RuleSettings, RuleWebhook, RuleWebhookHeader, RuleWebhookResponseMapping, ServiceGroup, WhatsAppProviderSettings, WidgetProviderSettings } from './chat-config/contracts/index.js';
 import { CampaignQueryParams, CampaignPaginatedResponse, Campaign, CreateCampaignRequest, PatchCampaignRequest, CampaignContactQueryParams, CampaignContactPaginatedResponse, CampaignContactResponse, CreateCampaignContactRequest, PatchCampaignContactRequest, CampaignContactsDashboardQueryParams, CampaignContactsDashboardData, CampaignUser, CampaignWorkGroupQueryParams, CampaignWorkGroupPaginatedResponse, CreateCampaignWorkGroupRequest, CampaignWorkGroup, CampaignCompanyQueryParams, CampaignCompanyPaginatedResponse, CampaignCompanyResponse, EnableCampaignCompanyRequest, CampaignAccessResponse } from './campaigns/contracts/index.js';
 export { CampaignAccessReason, CampaignContactCampaignStatus, CampaignContactDispatchStatus, CampaignContactFilter, CampaignContactLikeQueryOperators, CampaignContactQueryOperators, CampaignContactQueryValue, CampaignContactSortDirection, CampaignContactSortParams, CampaignContactsDashboardChannelPerformance, CampaignContactsDashboardEvolutionItem, CampaignContactsDashboardExactQueryOperators, CampaignContactsDashboardFunnelItem, CampaignContactsDashboardInterval, CampaignContactsDashboardMetrics, CampaignContactsDashboardQueryValue, CampaignContactsDashboardRangeQueryOperators, CampaignContactsDashboardStatusDistribution, CampaignContactsDashboardStatusMetrics, CampaignContactsDashboardSummary, CampaignContactsDashboardTopCampaign, CampaignNameLikeQueryOperators, CampaignProvider, CampaignRetryConfig, CampaignSchedule, CampaignStatus, WhatsAppPayload, WhatsAppTemplateComponent } from './campaigns/contracts/index.js';
 import { GetConfigTemplatesParams, GetConfigTemplatesResponse, FlowReadiness, FlowCatalogParams, FlowCatalogResponse, FlowDefinition } from './chat-adapter/contracts/index.js';
@@ -299,6 +299,14 @@ declare class ChatConfigGateway {
      * @returns The found or created queue rule.
      */
     findOrCreateQueueRule(payload: FindOrCreateQueueRuleRequest): Promise<QueueRule>;
+    /**
+     * Retrieves a rule by its ID (`GET /rules/:id`).
+     * Pass `rootOnly: false` to expand the nested `flow` tree recursively.
+     * @param ruleId - The unique identifier of the rule.
+     * @param params - Optional query parameters (`rootOnly`, `includeFlow`, etc.).
+     * @returns The rule, optionally with nested `flow`.
+     */
+    getRuleById(ruleId: string, params?: GetRuleByIdRequest): Promise<RuleResponse>;
     /**
      * @param params - The company and pagination parameters.
      * @returns The paginated initial service rules.
@@ -310,6 +318,12 @@ declare class ChatConfigGateway {
      * @returns The paginated rules matching the given filters.
      */
     getRules(params: GetRulesRequest): Promise<RulesResponse>;
+    /**
+     * Counts rules matching the given filters.
+     * @param params - Query parameters for filtering rules (same filters as `getRules`, without pagination/associations).
+     * @returns The total number of rules matching the filters.
+     */
+    getRulesCount(params: GetRulesCountRequest): Promise<RulesCountResponse>;
 }
 
 /**
@@ -1009,4 +1023,4 @@ declare const configure: (params: GatewayClientParams) => void;
  */
 declare function gateway<T extends keyof GatewayMap>(service: T): GatewayMap[T];
 
-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, CaseStatus, 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, CreateCaseStatusRequest, 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, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, 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, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, 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 };
+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, CaseStatus, 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, CreateCaseStatusRequest, 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, GetRuleByIdRequest, GetRulesCountRequest, GetRulesRequest, GetServiceGroupsParams, GetSupportWidgetIdResponse, GetSystemNotificationsParams, GetSystemNotificationsResponse, GetUserByIdResponse, GetUserDevicesParams, GetUserDevicesResponse, GetUserPreferencesParams, GetWebhooksByCompanyRequest$1 as GetWebhooksByCompanyRequest, HookCatalogItem, IntegrationAction, IntegrationField, IntegrationPartner, InvitationResponse, ListAutomationActionsRequest, ListAutomationPartnersRequest, ListCaseStatusesRequest, 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, RuleResponse, RulesCountResponse, RulesResponse, SERVICE_GATEWAYS, SERVICE_GATEWAYS as SERVICE_GATEWAYS_TYPE, SendAttachmentMessageResponse, SendMessageRequest, ServiceGroupsResponse, StrongPasswordOptionsResponse, UpdateAnnouncementRequest, UpdateAnnouncementStatusRequest, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, 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

@@ -509,6 +509,19 @@ var ChatConfigGateway = class {
     const { data } = await this.httpClient.put(`${this.baseUrl}/rules/queue/find-or-create`, payload);
     return data;
   }
+  /**
+   * Retrieves a rule by its ID (`GET /rules/:id`).
+   * Pass `rootOnly: false` to expand the nested `flow` tree recursively.
+   * @param ruleId - The unique identifier of the rule.
+   * @param params - Optional query parameters (`rootOnly`, `includeFlow`, etc.).
+   * @returns The rule, optionally with nested `flow`.
+   */
+  async getRuleById(ruleId, params) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/rules/${ruleId}`, {
+      params
+    });
+    return data;
+  }
   /**
    * @param params - The company and pagination parameters.
    * @returns The paginated initial service rules.
@@ -537,6 +550,17 @@ var ChatConfigGateway = class {
     });
     return data;
   }
+  /**
+   * Counts rules matching the given filters.
+   * @param params - Query parameters for filtering rules (same filters as `getRules`, without pagination/associations).
+   * @returns The total number of rules matching the filters.
+   */
+  async getRulesCount(params) {
+    const { data } = await this.httpClient.get(`${this.baseUrl}/rules/count`, {
+      params
+    });
+    return data;
+  }
 };
 
 // src/campaigns/index.ts