@opens/gateways 1.16.16 → 1.16.18

package/dist/cases/contracts/index.d.mts

@@ -77,6 +77,53 @@ interface CaseFeedByActionItem {
     protocol: string | null;
 }
 
+/** Colors offered by the UI when creating or updating a case status. */
+type CaseStatusColor = 'blue' | 'yellow' | 'green' | 'purple' | 'red' | 'cyan' | 'orange' | 'gray';
+/** Id of a fixed workflow stage. Stages are global, not per-company. */
+type CaseStageId = 'OPEN' | 'IN_PROGRESS' | 'CLOSED';
+/** A fixed workflow stage (Aberto / Em andamento / Fechado). */
+interface CaseStage {
+    id: CaseStageId;
+    label: string;
+}
+/** A company-scoped case status, linked to a fixed stage. */
+interface CaseStatus {
+    id: number;
+    name: string | null;
+    companyId: string;
+    caseStageId: CaseStageId;
+    /** Any color stored by the API; the UI palette is `CaseStatusColor`. */
+    color: string;
+    /** Hex of the color when it belongs to the color catalog (list only). */
+    colorHex?: string | null;
+    isDefault: boolean;
+    isCustomStatus: boolean;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    /** Present when the API includes the related stage (e.g. list). */
+    stage?: CaseStage;
+}
+/** Request payload for creating a case status. */
+interface CreateCaseStatusRequest {
+    name: string;
+    caseStageId: CaseStageId;
+    color: CaseStatusColor;
+}
+/** Request payload for updating a case status. All fields besides `statusId` are optional. */
+interface UpdateCaseStatusRequest {
+    statusId: number;
+    name?: string;
+    caseStageId?: CaseStageId;
+    color?: CaseStatusColor;
+    isActive?: boolean;
+}
+/** Request parameters for listing case statuses. */
+interface ListCaseStatusesRequest {
+    activeOnly?: boolean;
+}
+
 /** A case item as returned by the cases listing endpoint. */
 interface CaseListItem {
     id: number;
@@ -92,9 +139,7 @@ interface CaseListItem {
     dueDate: string | null;
     createdAt: string;
     updatedAt: string;
-    status?: {
-        name: string;
-    };
+    status?: CaseStatus;
     categories?: {
         id: string;
         name: string;
@@ -208,4 +253,4 @@ interface ClonedCase extends Omit<CaseListItem, 'status' | 'categories'> {
     estimatedTimeMinutes: number | null;
 }
 
-export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
+export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseStage, CaseStageId, CaseStatus, CaseStatusColor, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateCaseStatusRequest, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCaseStatusesRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateTimeEntryRequest };

package/dist/cases/contracts/index.d.ts

@@ -77,6 +77,53 @@ interface CaseFeedByActionItem {
     protocol: string | null;
 }
 
+/** Colors offered by the UI when creating or updating a case status. */
+type CaseStatusColor = 'blue' | 'yellow' | 'green' | 'purple' | 'red' | 'cyan' | 'orange' | 'gray';
+/** Id of a fixed workflow stage. Stages are global, not per-company. */
+type CaseStageId = 'OPEN' | 'IN_PROGRESS' | 'CLOSED';
+/** A fixed workflow stage (Aberto / Em andamento / Fechado). */
+interface CaseStage {
+    id: CaseStageId;
+    label: string;
+}
+/** A company-scoped case status, linked to a fixed stage. */
+interface CaseStatus {
+    id: number;
+    name: string | null;
+    companyId: string;
+    caseStageId: CaseStageId;
+    /** Any color stored by the API; the UI palette is `CaseStatusColor`. */
+    color: string;
+    /** Hex of the color when it belongs to the color catalog (list only). */
+    colorHex?: string | null;
+    isDefault: boolean;
+    isCustomStatus: boolean;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    /** Present when the API includes the related stage (e.g. list). */
+    stage?: CaseStage;
+}
+/** Request payload for creating a case status. */
+interface CreateCaseStatusRequest {
+    name: string;
+    caseStageId: CaseStageId;
+    color: CaseStatusColor;
+}
+/** Request payload for updating a case status. All fields besides `statusId` are optional. */
+interface UpdateCaseStatusRequest {
+    statusId: number;
+    name?: string;
+    caseStageId?: CaseStageId;
+    color?: CaseStatusColor;
+    isActive?: boolean;
+}
+/** Request parameters for listing case statuses. */
+interface ListCaseStatusesRequest {
+    activeOnly?: boolean;
+}
+
 /** A case item as returned by the cases listing endpoint. */
 interface CaseListItem {
     id: number;
@@ -92,9 +139,7 @@ interface CaseListItem {
     dueDate: string | null;
     createdAt: string;
     updatedAt: string;
-    status?: {
-        name: string;
-    };
+    status?: CaseStatus;
     categories?: {
         id: string;
         name: string;
@@ -208,4 +253,4 @@ interface ClonedCase extends Omit<CaseListItem, 'status' | 'categories'> {
     estimatedTimeMinutes: number | null;
 }
 
-export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateTimeEntryRequest };
+export type { CaseFeedByActionItem, CaseListItem, CasePermissions, CasePermissionsValue, CaseStage, CaseStageId, CaseStatus, CaseStatusColor, CaseTimeEntry, CloneCaseRequest, ClonedCase, CommentHistoryChangeType, CommentHistoryCursor, CommentHistoryEntry, CommentHistoryPage, CreateCaseStatusRequest, CreateTimeEntryRequest, DeleteTimeEntryRequest, GetCaseFeedByActionsRequest, GetCommentHistoryRequest, ListCaseStatusesRequest, ListCasesCursor, ListCasesRequest, ListCasesResponse, ListTimeEntriesPage, ListTimeEntriesRequest, TimeEntryCursor, UpdateCasePermissionsRequest, UpdateCaseStatusRequest, UpdateTimeEntryRequest };

package/dist/cases/contracts/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/cases/contracts/index.ts"],"sourcesContent":["export * from './comment-history';\nexport * from './case-permissions';\nexport * from './case-feed-by-actions';\nexport * from './list-cases';\nexport * from './time-entry';\nexport * from './clone-case';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/cases/contracts/index.ts"],"sourcesContent":["export * from './comment-history';\nexport * from './case-permissions';\nexport * from './case-feed-by-actions';\nexport * from './list-cases';\nexport * from './time-entry';\nexport * from './case-status';\nexport * from './clone-case';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

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

@@ -334,48 +334,76 @@ interface FindOrCreateQueueRuleRequest {
 }
 /** Response returned when finding or creating a queue rule. */
 interface QueueRule extends Rule {
-    flow?: Record<string, unknown>[];
+    flow?: Rule[];
 }
+/** Known rule action values used by the Chat Config API. */
+type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | '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';
+/** Request query parameters for listing root rules. */
 type GetRootRulesRequest = {
     companyId: string;
     offset: number;
     limit: number;
     name?: string;
 };
+/**
+ * Request query parameters for listing paginated rules (`GET /rules/paginated`).
+ * `offset` defaults to `0` and `limit` defaults to `50` (max `100`) on the API.
+ */
+type GetRulesRequest = {
+    companyId: string;
+    offset?: number;
+    limit?: number;
+    name?: string;
+    isRoot?: boolean;
+    action?: RuleAction[];
+    archiveStatus?: RuleArchiveStatus;
+    associations?: RuleAssociation[];
+};
+/** Automatic message payload stored on a rule. */
+interface RuleAutomaticMessage {
+    messageBody: string;
+    caption: string | null;
+    messageType: string;
+}
+/** Rule entity returned by the Chat Config API. */
 interface Rule {
     id: string;
     companyId: string;
     name: string;
     action: string;
-    message: string;
-    automaticMessage: {
-        messageBody: string;
-        caption: string | null;
-        messageType: string;
-    } | null;
+    message: string | null;
+    automaticMessage: RuleAutomaticMessage | null;
     callOnQueue: Record<string, unknown> | null;
-    uraDescription: string;
+    uraDescription: string | null;
     interactiveMessageId: string | null;
     configId: string | null;
     queueId: string | null;
-    redirectQueue: Record<string, unknown> | null;
+    redirectQueue: string | null;
     redirectRuleId: string | null;
-    questionnaire: Record<string, unknown>;
+    questionnaire: Record<string, unknown> | null;
     webhook: Record<string, unknown> | null;
     isRoot: boolean;
     redirectDefault: boolean;
     redirectTimeout: number;
     delay: number | null;
     disableTyping: boolean;
+    settings: Record<string, unknown> | null;
     archivedAt: string | null;
     autoTagEnabled: boolean;
-    autoTagIds: string[];
+    autoTagIds: number[];
     createdAt: string;
     updatedAt: string;
+    flow?: Rule[];
 }
-/** Response returned by the Chat Config API when listing root rules. */
-type RootRulesResponse = {
+/** Response returned by the Chat Config API when listing paginated rules. */
+type RulesResponse = {
     data: Rule[];
 };
+/** 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, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };
+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 };

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

@@ -334,48 +334,76 @@ interface FindOrCreateQueueRuleRequest {
 }
 /** Response returned when finding or creating a queue rule. */
 interface QueueRule extends Rule {
-    flow?: Record<string, unknown>[];
+    flow?: Rule[];
 }
+/** Known rule action values used by the Chat Config API. */
+type RuleAction = 'queue' | 'interactiveMessage' | 'message' | 'automaticMessage' | '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';
+/** Request query parameters for listing root rules. */
 type GetRootRulesRequest = {
     companyId: string;
     offset: number;
     limit: number;
     name?: string;
 };
+/**
+ * Request query parameters for listing paginated rules (`GET /rules/paginated`).
+ * `offset` defaults to `0` and `limit` defaults to `50` (max `100`) on the API.
+ */
+type GetRulesRequest = {
+    companyId: string;
+    offset?: number;
+    limit?: number;
+    name?: string;
+    isRoot?: boolean;
+    action?: RuleAction[];
+    archiveStatus?: RuleArchiveStatus;
+    associations?: RuleAssociation[];
+};
+/** Automatic message payload stored on a rule. */
+interface RuleAutomaticMessage {
+    messageBody: string;
+    caption: string | null;
+    messageType: string;
+}
+/** Rule entity returned by the Chat Config API. */
 interface Rule {
     id: string;
     companyId: string;
     name: string;
     action: string;
-    message: string;
-    automaticMessage: {
-        messageBody: string;
-        caption: string | null;
-        messageType: string;
-    } | null;
+    message: string | null;
+    automaticMessage: RuleAutomaticMessage | null;
     callOnQueue: Record<string, unknown> | null;
-    uraDescription: string;
+    uraDescription: string | null;
     interactiveMessageId: string | null;
     configId: string | null;
     queueId: string | null;
-    redirectQueue: Record<string, unknown> | null;
+    redirectQueue: string | null;
     redirectRuleId: string | null;
-    questionnaire: Record<string, unknown>;
+    questionnaire: Record<string, unknown> | null;
     webhook: Record<string, unknown> | null;
     isRoot: boolean;
     redirectDefault: boolean;
     redirectTimeout: number;
     delay: number | null;
     disableTyping: boolean;
+    settings: Record<string, unknown> | null;
     archivedAt: string | null;
     autoTagEnabled: boolean;
-    autoTagIds: string[];
+    autoTagIds: number[];
     createdAt: string;
     updatedAt: string;
+    flow?: Rule[];
 }
-/** Response returned by the Chat Config API when listing root rules. */
-type RootRulesResponse = {
+/** Response returned by the Chat Config API when listing paginated rules. */
+type RulesResponse = {
     data: Rule[];
 };
+/** 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, GetServiceGroupsParams, MetaTemplateButton, MetaTemplateConfigResponse, MetaTemplateConfigsResponse, Provider, ProviderConfiguration, ProviderConfigurationsResponse, ProviderDisplayInfoResponse, ProviderListResponse, ProviderName, Queue, QueueListResponse, QueueMember, QueueRule, RootRulesResponse, Rule, ServiceGroup, ServiceGroupsResponse, WhatsAppProviderSettings, WidgetProviderSettings };
+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 };