@ikatec/digisac-api-sdk 4.4.0 → 4.5.0

package/dist/apis/kanbanColumns/KanbanColumnsApi.mjs

@@ -5,6 +5,15 @@ var KanbanColumnsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/kanban-columns");
 	}
+	/**
+	* Moves a column between two neighbours of the same board. Both the column and a neighbour
+	* must be draggable; swapped neighbours (`before` after `after`) fail with 500. Resolves to the
+	* column with its new `position`.
+	* @permissions kanban.columns.update
+	*/
+	reorder(id, body, headers) {
+		return this.client.patch(`${this.basePath}/${id}/reorder`, body, headers);
+	}
 };
 
 //#endregion

package/dist/apis/kanbanColumns/KanbanColumnsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"KanbanColumnsApi.mjs","names":[],"sources":["../../../src/apis/kanbanColumns/KanbanColumnsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { KanbanColumn, CreateKanbanColumnPayload, UpdateKanbanColumnPayload } from './types'\n\nexport class KanbanColumnsApi extends BaseCrudApi<\n  KanbanColumn,\n  CreateKanbanColumnPayload,\n  UpdateKanbanColumnPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/kanban-columns')\n  }\n}\n"],"mappings":";;;AAIA,IAAa,mBAAb,cAAsC,YAIpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB"}
+{"version":3,"file":"KanbanColumnsApi.mjs","names":[],"sources":["../../../src/apis/kanbanColumns/KanbanColumnsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  KanbanColumn,\n  CreateKanbanColumnPayload,\n  ReorderKanbanColumnPayload,\n  UpdateKanbanColumnPayload,\n} from './types'\n\nexport class KanbanColumnsApi extends BaseCrudApi<\n  KanbanColumn,\n  CreateKanbanColumnPayload,\n  UpdateKanbanColumnPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/kanban-columns')\n  }\n\n  /**\n   * Moves a column between two neighbours of the same board. Both the column and a neighbour\n   * must be draggable; swapped neighbours (`before` after `after`) fail with 500. Resolves to the\n   * column with its new `position`.\n   * @permissions kanban.columns.update\n   */\n  reorder(\n    id: string,\n    body: ReorderKanbanColumnPayload,\n    headers?: Record<string, string>,\n  ): Promise<KanbanColumn> {\n    return this.client.patch<KanbanColumn, ReorderKanbanColumnPayload>(\n      `${this.basePath}/${id}/reorder`,\n      body,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;AASA,IAAa,mBAAb,cAAsC,YAIpC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,kBAAkB;;;;;;;;CASlC,QACE,IACA,MACA,SACuB;AACvB,SAAO,KAAK,OAAO,MACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,MACA,QACD"}

package/dist/apis/kanbanColumns/types.d.ts

@@ -12,15 +12,19 @@ export type KanbanColumn = {
     accountId: string;
     createdAt: string;
     updatedAt: string;
-    deletedAt: string | null;
-    kanbanBoard?: KanbanBoard;
+    board?: KanbanBoard | null;
     cards?: KanbanCard[];
 };
-export type KanbanColumnRelationships = 'kanbanBoard' | 'cards';
+export type KanbanColumnRelationships = 'cards';
 export type CreateKanbanColumnPayload = {
     name: string;
     kanbanBoardId: string;
+    /** A board has one `'initial'` and one `'final'` column (a second one fails). */
     role?: KanbanColumnRole;
+    /**
+     * @deprecated Ignored by the backend: the position is computed (`'initial'` first, `'final'`
+     * last, other columns just before the final one). Use `reorder` to move a column.
+     */
     position?: string;
     ticketWaitTimeMinutes?: number;
     isDraggable?: boolean;
@@ -32,4 +36,11 @@ export type UpdateKanbanColumnPayload = {
     ticketWaitTimeMinutes?: number | null;
     isDraggable?: boolean;
 };
+/** Neighbours of the column after the move (omit both to move it to the middle, `'M'`). */
+export type ReorderKanbanColumnPayload = {
+    /** The column that ends up on the left. */
+    beforeColumnId?: string;
+    /** The column that ends up on the right. */
+    afterColumnId?: string;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/apis/kanbanColumns/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/kanbanColumns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAE9D,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,aAAa,GAAG,OAAO,CAAA;AAE/D,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/kanbanColumns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEtD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAE9D,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IAEjB,KAAK,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAA;AAE/C,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,iFAAiF;IACjF,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,2FAA2F;AAC3F,MAAM,MAAM,0BAA0B,GAAG;IACvC,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA"}

package/dist/apis/messages/MessagesApi.cjs

@@ -44,7 +44,10 @@ var MessagesApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	bulkDestroy(body, headers) {
 		return this.client.request("DELETE", `${this.basePath}/many`, body, headers);
 	}
-	/** Triggers an AI-generated summary for the conversation associated with the given message. */
+	/**
+	* Triggers an AI-generated summary for the conversation associated with the given message.
+	* Resolves to `'OK'`.
+	*/
 	summarize(id, headers) {
 		return this.client.post(`${this.basePath}/${id}/summarize`, void 0, headers);
 	}

package/dist/apis/messages/MessagesApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"MessagesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/messages/MessagesApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Message,\n  CreateMessagePayload,\n  UpdateMessagePayload,\n  ForwardMessagesPayload,\n  ForwardMessagesResult,\n  SendVcardsPayload,\n  SendReactionPayload,\n  MagicTextPayload,\n  MagicTextResult,\n  CheckSummaryPayload,\n  CheckSummaryResult,\n  BulkDestroyPayload,\n  OutOfRangeResult,\n  LoadAroundQuery,\n} from './types'\n\nexport class MessagesApi extends BaseCrudApi<Message, CreateMessagePayload, UpdateMessagePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/messages')\n  }\n\n  /** Forwards one or more messages to one or more contacts (max 20 messages to 5 contacts). */\n  forward(\n    body: ForwardMessagesPayload,\n    headers?: Record<string, string>,\n  ): Promise<ForwardMessagesResult> {\n    return this.client.post<ForwardMessagesResult, ForwardMessagesPayload>(\n      `${this.basePath}/forward`,\n      body,\n      headers,\n    )\n  }\n\n  /** Revokes (soft-deletes) a sent message so it is no longer visible to the recipient. */\n  revoke(id: string, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message>(`${this.basePath}/${id}/revoke`, undefined, headers)\n  }\n\n  /** Removes a previously sent reaction from a message. */\n  revokeReaction(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.put<boolean>(`${this.basePath}/${id}/revoke-reaction`, undefined, headers)\n  }\n\n  /** Sends one or more contacts as vCard messages to a given contact. */\n  sendVcards(body: SendVcardsPayload, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message, SendVcardsPayload>(\n      `${this.basePath}/send-vcards`,\n      body,\n      headers,\n    )\n  }\n\n  /** Sends an emoji reaction to a message. */\n  sendReaction(\n    id: string,\n    body: SendReactionPayload,\n    headers?: Record<string, string>,\n  ): Promise<boolean> {\n    return this.client.post<boolean, SendReactionPayload>(\n      `${this.basePath}/${id}/send-reaction`,\n      body,\n      headers,\n    )\n  }\n\n  /** Uses AI to rewrite or correct a message text with a given tone (e.g. \"correct\", \"professional\", \"casual\"). */\n  magicText(body: MagicTextPayload, headers?: Record<string, string>): Promise<MagicTextResult> {\n    return this.client.post<MagicTextResult, MagicTextPayload>(\n      `${this.basePath}/magic-text`,\n      body,\n      headers,\n    )\n  }\n\n  /** Checks whether an AI-generated summary already exists for a given ticket. */\n  checkSummary(\n    body: CheckSummaryPayload,\n    headers?: Record<string, string>,\n  ): Promise<CheckSummaryResult> {\n    return this.client.post<CheckSummaryResult, CheckSummaryPayload>(\n      `${this.basePath}/check-summary`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes multiple messages matching the given where clause.\n   * @permissions messages.destroy\n   */\n  bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.request<boolean, BulkDestroyPayload>(\n      'DELETE',\n      `${this.basePath}/many`,\n      body,\n      headers,\n    )\n  }\n\n  /** Triggers an AI-generated summary for the conversation associated with the given message. */\n  summarize(id: string, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void>(`${this.basePath}/${id}/summarize`, undefined, headers)\n  }\n\n  /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */\n  outOfRange(\n    id: string,\n    limit?: number,\n    headers?: Record<string, string>,\n  ): Promise<OutOfRangeResult> {\n    const queryString = limit ? `?${qs.stringify({ limit })}` : ''\n    return this.client.get<OutOfRangeResult>(\n      `${this.basePath}/${id}/out-of-range${queryString}`,\n      headers,\n    )\n  }\n\n  /** Re-downloads and syncs the file attachment for a message from the messaging service. */\n  syncFile(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/sync-file`, undefined, headers)\n  }\n\n  /** Loads messages surrounding a target message (N before and N after), useful for jumping to a specific point in a conversation. */\n  around(\n    id: string,\n    query?: LoadAroundQuery,\n    headers?: Record<string, string>,\n  ): Promise<Message[]> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Message[]>(`${this.basePath}/${id}/around${queryString}`, headers)\n  }\n}\n"],"mappings":";;;;;;;AAoBA,IAAa,cAAb,cAAiCA,qCAAiE;CAChG,YAAY,QAAmB;AAC7B,QAAM,QAAQ,YAAY;;;CAI5B,QACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,WACjB,MACA,QACD;;;CAIH,OAAO,IAAY,SAAoD;AACrE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,UAAU,QAAW,QAAQ;;;CAIvF,eAAe,IAAY,SAAoD;AAC7E,SAAO,KAAK,OAAO,IAAa,GAAG,KAAK,SAAS,GAAG,GAAG,mBAAmB,QAAW,QAAQ;;;CAI/F,WAAW,MAAyB,SAAoD;AACtF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;CAIH,aACE,IACA,MACA,SACkB;AAClB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,MACA,QACD;;;CAIH,UAAU,MAAwB,SAA4D;AAC5F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,cACjB,MACA,QACD;;;CAIH,aACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBACjB,MACA,QACD;;;;;;CAOH,YAAY,MAA0B,SAAoD;AACxF,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,QACjB,MACA,QACD;;;CAIH,UAAU,IAAY,SAAiD;AACrE,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAIvF,WACE,IACA,OACA,SAC2B;EAC3B,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,EAAE,OAAO,CAAC,KAAK;AAC5D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,eAAe,eACtC,QACD;;;CAIH,SAAS,IAAY,SAAoD;AACvE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAI1F,OACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,eAAe,QAAQ"}
+{"version":3,"file":"MessagesApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/messages/MessagesApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Message,\n  CreateMessagePayload,\n  UpdateMessagePayload,\n  ForwardMessagesPayload,\n  ForwardMessagesResult,\n  SendVcardsPayload,\n  SendReactionPayload,\n  MagicTextPayload,\n  MagicTextResult,\n  CheckSummaryPayload,\n  CheckSummaryResult,\n  BulkDestroyPayload,\n  OutOfRangeResult,\n  LoadAroundQuery,\n} from './types'\n\nexport class MessagesApi extends BaseCrudApi<Message, CreateMessagePayload, UpdateMessagePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/messages')\n  }\n\n  /** Forwards one or more messages to one or more contacts (max 20 messages to 5 contacts). */\n  forward(\n    body: ForwardMessagesPayload,\n    headers?: Record<string, string>,\n  ): Promise<ForwardMessagesResult> {\n    return this.client.post<ForwardMessagesResult, ForwardMessagesPayload>(\n      `${this.basePath}/forward`,\n      body,\n      headers,\n    )\n  }\n\n  /** Revokes (soft-deletes) a sent message so it is no longer visible to the recipient. */\n  revoke(id: string, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message>(`${this.basePath}/${id}/revoke`, undefined, headers)\n  }\n\n  /** Removes a previously sent reaction from a message. */\n  revokeReaction(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.put<boolean>(`${this.basePath}/${id}/revoke-reaction`, undefined, headers)\n  }\n\n  /** Sends one or more contacts as vCard messages to a given contact. */\n  sendVcards(body: SendVcardsPayload, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message, SendVcardsPayload>(\n      `${this.basePath}/send-vcards`,\n      body,\n      headers,\n    )\n  }\n\n  /** Sends an emoji reaction to a message. */\n  sendReaction(\n    id: string,\n    body: SendReactionPayload,\n    headers?: Record<string, string>,\n  ): Promise<boolean> {\n    return this.client.post<boolean, SendReactionPayload>(\n      `${this.basePath}/${id}/send-reaction`,\n      body,\n      headers,\n    )\n  }\n\n  /** Uses AI to rewrite or correct a message text with a given tone (e.g. \"correct\", \"professional\", \"casual\"). */\n  magicText(body: MagicTextPayload, headers?: Record<string, string>): Promise<MagicTextResult> {\n    return this.client.post<MagicTextResult, MagicTextPayload>(\n      `${this.basePath}/magic-text`,\n      body,\n      headers,\n    )\n  }\n\n  /** Checks whether an AI-generated summary already exists for a given ticket. */\n  checkSummary(\n    body: CheckSummaryPayload,\n    headers?: Record<string, string>,\n  ): Promise<CheckSummaryResult> {\n    return this.client.post<CheckSummaryResult, CheckSummaryPayload>(\n      `${this.basePath}/check-summary`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes multiple messages matching the given where clause.\n   * @permissions messages.destroy\n   */\n  bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.request<boolean, BulkDestroyPayload>(\n      'DELETE',\n      `${this.basePath}/many`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Triggers an AI-generated summary for the conversation associated with the given message.\n   * Resolves to `'OK'`.\n   */\n  summarize(id: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string>(`${this.basePath}/${id}/summarize`, undefined, headers)\n  }\n\n  /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */\n  outOfRange(\n    id: string,\n    limit?: number,\n    headers?: Record<string, string>,\n  ): Promise<OutOfRangeResult> {\n    const queryString = limit ? `?${qs.stringify({ limit })}` : ''\n    return this.client.get<OutOfRangeResult>(\n      `${this.basePath}/${id}/out-of-range${queryString}`,\n      headers,\n    )\n  }\n\n  /** Re-downloads and syncs the file attachment for a message from the messaging service. */\n  syncFile(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/sync-file`, undefined, headers)\n  }\n\n  /** Loads messages surrounding a target message (N before and N after), useful for jumping to a specific point in a conversation. */\n  around(\n    id: string,\n    query?: LoadAroundQuery,\n    headers?: Record<string, string>,\n  ): Promise<Message[]> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Message[]>(`${this.basePath}/${id}/around${queryString}`, headers)\n  }\n}\n"],"mappings":";;;;;;;AAoBA,IAAa,cAAb,cAAiCA,qCAAiE;CAChG,YAAY,QAAmB;AAC7B,QAAM,QAAQ,YAAY;;;CAI5B,QACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,WACjB,MACA,QACD;;;CAIH,OAAO,IAAY,SAAoD;AACrE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,UAAU,QAAW,QAAQ;;;CAIvF,eAAe,IAAY,SAAoD;AAC7E,SAAO,KAAK,OAAO,IAAa,GAAG,KAAK,SAAS,GAAG,GAAG,mBAAmB,QAAW,QAAQ;;;CAI/F,WAAW,MAAyB,SAAoD;AACtF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;CAIH,aACE,IACA,MACA,SACkB;AAClB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,MACA,QACD;;;CAIH,UAAU,MAAwB,SAA4D;AAC5F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,cACjB,MACA,QACD;;;CAIH,aACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBACjB,MACA,QACD;;;;;;CAOH,YAAY,MAA0B,SAAoD;AACxF,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,QACjB,MACA,QACD;;;;;;CAOH,UAAU,IAAY,SAAmD;AACvE,SAAO,KAAK,OAAO,KAAa,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAIzF,WACE,IACA,OACA,SAC2B;EAC3B,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,EAAE,OAAO,CAAC,KAAK;AAC5D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,eAAe,eACtC,QACD;;;CAIH,SAAS,IAAY,SAAoD;AACvE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAI1F,OACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,WAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,eAAe,QAAQ"}

package/dist/apis/messages/MessagesApi.d.ts

@@ -22,8 +22,11 @@ export declare class MessagesApi extends BaseCrudApi<Message, CreateMessagePaylo
      * @permissions messages.destroy
      */
     bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean>;
-    /** Triggers an AI-generated summary for the conversation associated with the given message. */
-    summarize(id: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Triggers an AI-generated summary for the conversation associated with the given message.
+     * Resolves to `'OK'`.
+     */
+    summarize(id: string, headers?: Record<string, string>): Promise<string>;
     /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */
     outOfRange(id: string, limit?: number, headers?: Record<string, string>): Promise<OutOfRangeResult>;
     /** Re-downloads and syncs the file attachment for a message from the messaging service. */

package/dist/apis/messages/MessagesApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MessagesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/messages/MessagesApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EAChB,MAAM,SAAS,CAAA;AAEhB,qBAAa,WAAY,SAAQ,WAAW,CAAC,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;gBACnF,MAAM,EAAE,SAAS;IAI7B,6FAA6F;IAC7F,OAAO,CACL,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC,yFAAyF;IACzF,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE,yDAAyD;IACzD,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E,uEAAuE;IACvE,UAAU,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvF,4CAA4C;IAC5C,YAAY,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,CAAC;IAQnB,iHAAiH;IACjH,SAAS,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ7F,gFAAgF;IAChF,YAAY,CACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IASzF,+FAA+F;IAC/F,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE,iHAAiH;IACjH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC;IAQ5B,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxE,oIAAoI;IACpI,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,EAAE,CAAC;CAItB"}
+{"version":3,"file":"MessagesApi.d.ts","sourceRoot":"","sources":["../../../src/apis/messages/MessagesApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EAChB,MAAM,SAAS,CAAA;AAEhB,qBAAa,WAAY,SAAQ,WAAW,CAAC,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,CAAC;gBACnF,MAAM,EAAE,SAAS;IAI7B,6FAA6F;IAC7F,OAAO,CACL,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,qBAAqB,CAAC;IAQjC,yFAAyF;IACzF,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAItE,yDAAyD;IACzD,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9E,uEAAuE;IACvE,UAAU,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQvF,4CAA4C;IAC5C,YAAY,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,CAAC;IAQnB,iHAAiH;IACjH,SAAS,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;IAQ7F,gFAAgF;IAChF,YAAY,CACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IASzF;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxE,iHAAiH;IACjH,UAAU,CACR,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,gBAAgB,CAAC;IAQ5B,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIxE,oIAAoI;IACpI,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,EAAE,CAAC;CAItB"}

package/dist/apis/messages/MessagesApi.mjs

@@ -41,7 +41,10 @@ var MessagesApi = class extends BaseCrudApi {
 	bulkDestroy(body, headers) {
 		return this.client.request("DELETE", `${this.basePath}/many`, body, headers);
 	}
-	/** Triggers an AI-generated summary for the conversation associated with the given message. */
+	/**
+	* Triggers an AI-generated summary for the conversation associated with the given message.
+	* Resolves to `'OK'`.
+	*/
 	summarize(id, headers) {
 		return this.client.post(`${this.basePath}/${id}/summarize`, void 0, headers);
 	}

package/dist/apis/messages/MessagesApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"MessagesApi.mjs","names":[],"sources":["../../../src/apis/messages/MessagesApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Message,\n  CreateMessagePayload,\n  UpdateMessagePayload,\n  ForwardMessagesPayload,\n  ForwardMessagesResult,\n  SendVcardsPayload,\n  SendReactionPayload,\n  MagicTextPayload,\n  MagicTextResult,\n  CheckSummaryPayload,\n  CheckSummaryResult,\n  BulkDestroyPayload,\n  OutOfRangeResult,\n  LoadAroundQuery,\n} from './types'\n\nexport class MessagesApi extends BaseCrudApi<Message, CreateMessagePayload, UpdateMessagePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/messages')\n  }\n\n  /** Forwards one or more messages to one or more contacts (max 20 messages to 5 contacts). */\n  forward(\n    body: ForwardMessagesPayload,\n    headers?: Record<string, string>,\n  ): Promise<ForwardMessagesResult> {\n    return this.client.post<ForwardMessagesResult, ForwardMessagesPayload>(\n      `${this.basePath}/forward`,\n      body,\n      headers,\n    )\n  }\n\n  /** Revokes (soft-deletes) a sent message so it is no longer visible to the recipient. */\n  revoke(id: string, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message>(`${this.basePath}/${id}/revoke`, undefined, headers)\n  }\n\n  /** Removes a previously sent reaction from a message. */\n  revokeReaction(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.put<boolean>(`${this.basePath}/${id}/revoke-reaction`, undefined, headers)\n  }\n\n  /** Sends one or more contacts as vCard messages to a given contact. */\n  sendVcards(body: SendVcardsPayload, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message, SendVcardsPayload>(\n      `${this.basePath}/send-vcards`,\n      body,\n      headers,\n    )\n  }\n\n  /** Sends an emoji reaction to a message. */\n  sendReaction(\n    id: string,\n    body: SendReactionPayload,\n    headers?: Record<string, string>,\n  ): Promise<boolean> {\n    return this.client.post<boolean, SendReactionPayload>(\n      `${this.basePath}/${id}/send-reaction`,\n      body,\n      headers,\n    )\n  }\n\n  /** Uses AI to rewrite or correct a message text with a given tone (e.g. \"correct\", \"professional\", \"casual\"). */\n  magicText(body: MagicTextPayload, headers?: Record<string, string>): Promise<MagicTextResult> {\n    return this.client.post<MagicTextResult, MagicTextPayload>(\n      `${this.basePath}/magic-text`,\n      body,\n      headers,\n    )\n  }\n\n  /** Checks whether an AI-generated summary already exists for a given ticket. */\n  checkSummary(\n    body: CheckSummaryPayload,\n    headers?: Record<string, string>,\n  ): Promise<CheckSummaryResult> {\n    return this.client.post<CheckSummaryResult, CheckSummaryPayload>(\n      `${this.basePath}/check-summary`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes multiple messages matching the given where clause.\n   * @permissions messages.destroy\n   */\n  bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.request<boolean, BulkDestroyPayload>(\n      'DELETE',\n      `${this.basePath}/many`,\n      body,\n      headers,\n    )\n  }\n\n  /** Triggers an AI-generated summary for the conversation associated with the given message. */\n  summarize(id: string, headers?: Record<string, string>): Promise<void> {\n    return this.client.post<void>(`${this.basePath}/${id}/summarize`, undefined, headers)\n  }\n\n  /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */\n  outOfRange(\n    id: string,\n    limit?: number,\n    headers?: Record<string, string>,\n  ): Promise<OutOfRangeResult> {\n    const queryString = limit ? `?${qs.stringify({ limit })}` : ''\n    return this.client.get<OutOfRangeResult>(\n      `${this.basePath}/${id}/out-of-range${queryString}`,\n      headers,\n    )\n  }\n\n  /** Re-downloads and syncs the file attachment for a message from the messaging service. */\n  syncFile(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/sync-file`, undefined, headers)\n  }\n\n  /** Loads messages surrounding a target message (N before and N after), useful for jumping to a specific point in a conversation. */\n  around(\n    id: string,\n    query?: LoadAroundQuery,\n    headers?: Record<string, string>,\n  ): Promise<Message[]> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Message[]>(`${this.basePath}/${id}/around${queryString}`, headers)\n  }\n}\n"],"mappings":";;;;AAoBA,IAAa,cAAb,cAAiC,YAAiE;CAChG,YAAY,QAAmB;AAC7B,QAAM,QAAQ,YAAY;;;CAI5B,QACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,WACjB,MACA,QACD;;;CAIH,OAAO,IAAY,SAAoD;AACrE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,UAAU,QAAW,QAAQ;;;CAIvF,eAAe,IAAY,SAAoD;AAC7E,SAAO,KAAK,OAAO,IAAa,GAAG,KAAK,SAAS,GAAG,GAAG,mBAAmB,QAAW,QAAQ;;;CAI/F,WAAW,MAAyB,SAAoD;AACtF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;CAIH,aACE,IACA,MACA,SACkB;AAClB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,MACA,QACD;;;CAIH,UAAU,MAAwB,SAA4D;AAC5F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,cACjB,MACA,QACD;;;CAIH,aACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBACjB,MACA,QACD;;;;;;CAOH,YAAY,MAA0B,SAAoD;AACxF,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,QACjB,MACA,QACD;;;CAIH,UAAU,IAAY,SAAiD;AACrE,SAAO,KAAK,OAAO,KAAW,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAIvF,WACE,IACA,OACA,SAC2B;EAC3B,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,EAAE,OAAO,CAAC,KAAK;AAC5D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,eAAe,eACtC,QACD;;;CAIH,SAAS,IAAY,SAAoD;AACvE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAI1F,OACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,eAAe,QAAQ"}
+{"version":3,"file":"MessagesApi.mjs","names":[],"sources":["../../../src/apis/messages/MessagesApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Message,\n  CreateMessagePayload,\n  UpdateMessagePayload,\n  ForwardMessagesPayload,\n  ForwardMessagesResult,\n  SendVcardsPayload,\n  SendReactionPayload,\n  MagicTextPayload,\n  MagicTextResult,\n  CheckSummaryPayload,\n  CheckSummaryResult,\n  BulkDestroyPayload,\n  OutOfRangeResult,\n  LoadAroundQuery,\n} from './types'\n\nexport class MessagesApi extends BaseCrudApi<Message, CreateMessagePayload, UpdateMessagePayload> {\n  constructor(client: ApiClient) {\n    super(client, '/messages')\n  }\n\n  /** Forwards one or more messages to one or more contacts (max 20 messages to 5 contacts). */\n  forward(\n    body: ForwardMessagesPayload,\n    headers?: Record<string, string>,\n  ): Promise<ForwardMessagesResult> {\n    return this.client.post<ForwardMessagesResult, ForwardMessagesPayload>(\n      `${this.basePath}/forward`,\n      body,\n      headers,\n    )\n  }\n\n  /** Revokes (soft-deletes) a sent message so it is no longer visible to the recipient. */\n  revoke(id: string, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message>(`${this.basePath}/${id}/revoke`, undefined, headers)\n  }\n\n  /** Removes a previously sent reaction from a message. */\n  revokeReaction(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.put<boolean>(`${this.basePath}/${id}/revoke-reaction`, undefined, headers)\n  }\n\n  /** Sends one or more contacts as vCard messages to a given contact. */\n  sendVcards(body: SendVcardsPayload, headers?: Record<string, string>): Promise<Message> {\n    return this.client.post<Message, SendVcardsPayload>(\n      `${this.basePath}/send-vcards`,\n      body,\n      headers,\n    )\n  }\n\n  /** Sends an emoji reaction to a message. */\n  sendReaction(\n    id: string,\n    body: SendReactionPayload,\n    headers?: Record<string, string>,\n  ): Promise<boolean> {\n    return this.client.post<boolean, SendReactionPayload>(\n      `${this.basePath}/${id}/send-reaction`,\n      body,\n      headers,\n    )\n  }\n\n  /** Uses AI to rewrite or correct a message text with a given tone (e.g. \"correct\", \"professional\", \"casual\"). */\n  magicText(body: MagicTextPayload, headers?: Record<string, string>): Promise<MagicTextResult> {\n    return this.client.post<MagicTextResult, MagicTextPayload>(\n      `${this.basePath}/magic-text`,\n      body,\n      headers,\n    )\n  }\n\n  /** Checks whether an AI-generated summary already exists for a given ticket. */\n  checkSummary(\n    body: CheckSummaryPayload,\n    headers?: Record<string, string>,\n  ): Promise<CheckSummaryResult> {\n    return this.client.post<CheckSummaryResult, CheckSummaryPayload>(\n      `${this.basePath}/check-summary`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes multiple messages matching the given where clause.\n   * @permissions messages.destroy\n   */\n  bulkDestroy(body: BulkDestroyPayload, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.request<boolean, BulkDestroyPayload>(\n      'DELETE',\n      `${this.basePath}/many`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Triggers an AI-generated summary for the conversation associated with the given message.\n   * Resolves to `'OK'`.\n   */\n  summarize(id: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string>(`${this.basePath}/${id}/summarize`, undefined, headers)\n  }\n\n  /** Checks whether a message is out of the visible range (i.e. there are more than `limit` messages after it). */\n  outOfRange(\n    id: string,\n    limit?: number,\n    headers?: Record<string, string>,\n  ): Promise<OutOfRangeResult> {\n    const queryString = limit ? `?${qs.stringify({ limit })}` : ''\n    return this.client.get<OutOfRangeResult>(\n      `${this.basePath}/${id}/out-of-range${queryString}`,\n      headers,\n    )\n  }\n\n  /** Re-downloads and syncs the file attachment for a message from the messaging service. */\n  syncFile(id: string, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.post<unknown>(`${this.basePath}/${id}/sync-file`, undefined, headers)\n  }\n\n  /** Loads messages surrounding a target message (N before and N after), useful for jumping to a specific point in a conversation. */\n  around(\n    id: string,\n    query?: LoadAroundQuery,\n    headers?: Record<string, string>,\n  ): Promise<Message[]> {\n    const queryString = query ? `?${qs.stringify(query)}` : ''\n    return this.client.get<Message[]>(`${this.basePath}/${id}/around${queryString}`, headers)\n  }\n}\n"],"mappings":";;;;AAoBA,IAAa,cAAb,cAAiC,YAAiE;CAChG,YAAY,QAAmB;AAC7B,QAAM,QAAQ,YAAY;;;CAI5B,QACE,MACA,SACgC;AAChC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,WACjB,MACA,QACD;;;CAIH,OAAO,IAAY,SAAoD;AACrE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,UAAU,QAAW,QAAQ;;;CAIvF,eAAe,IAAY,SAAoD;AAC7E,SAAO,KAAK,OAAO,IAAa,GAAG,KAAK,SAAS,GAAG,GAAG,mBAAmB,QAAW,QAAQ;;;CAI/F,WAAW,MAAyB,SAAoD;AACtF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;CAIH,aACE,IACA,MACA,SACkB;AAClB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,iBACvB,MACA,QACD;;;CAIH,UAAU,MAAwB,SAA4D;AAC5F,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,cACjB,MACA,QACD;;;CAIH,aACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBACjB,MACA,QACD;;;;;;CAOH,YAAY,MAA0B,SAAoD;AACxF,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,QACjB,MACA,QACD;;;;;;CAOH,UAAU,IAAY,SAAmD;AACvE,SAAO,KAAK,OAAO,KAAa,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAIzF,WACE,IACA,OACA,SAC2B;EAC3B,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,EAAE,OAAO,CAAC,KAAK;AAC5D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,eAAe,eACtC,QACD;;;CAIH,SAAS,IAAY,SAAoD;AACvE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAI1F,OACE,IACA,OACA,SACoB;EACpB,MAAM,cAAc,QAAQ,IAAI,GAAG,UAAU,MAAM,KAAK;AACxD,SAAO,KAAK,OAAO,IAAe,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,eAAe,QAAQ"}

package/dist/apis/messages/types.d.ts

@@ -94,6 +94,19 @@ export type Message = {
     transcribeError?: boolean;
     reactionParentMessageId: string | null;
     hsmId: string | null;
+    isFromBot: boolean;
+    accountId: string;
+    serviceId: string;
+    contactId: string;
+    /** The contact that sent the message; `null` when it is from the account. */
+    fromId: string | null;
+    toId: string | null;
+    /** The user that sent the message; `null` for a received one. */
+    userId: string | null;
+    ticketId: string | null;
+    ticketUserId: string | null;
+    ticketDepartmentId: string | null;
+    quotedMessageId: string | null;
     createdAt: string;
     updatedAt: string;
     deletedAt: string | null;

package/dist/apis/messages/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/messages/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAElF,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,OAAO,GACP,KAAK,GACL,OAAO,GACP,OAAO,GACP,UAAU,GACV,OAAO,GACP,UAAU,GACV,OAAO,GACP,SAAS,GACT,SAAS,GACT,QAAQ,GACR,SAAS,GACT,UAAU,GACV,KAAK,GACL,YAAY,GACZ,MAAM,CAAA;AAEV,MAAM,MAAM,WAAW,GAAG;IACxB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,aAAa,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAChC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,aAAa,EAAE,OAAO,CAAA;QACtB,KAAK,CAAC,EAAE,OAAO,CAAA;KAChB,CAAA;IACD,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE;QACT,GAAG,EAAE,MAAM,CAAA;QACX,GAAG,EAAE,MAAM,CAAA;QACX,UAAU,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,OAAO,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,gBAAgB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACpC,GAAG,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAA;IACrC,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;IACrB,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,cAAc,EAAE,CAAA;IAChC,sBAAsB,CAAC,EAAE;QACvB,MAAM,EAAE,OAAO,CAAA;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,EAAE,CAAA;KACnB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAC5B,MAAM,GACN,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,OAAO,GACP,WAAW,GACX,SAAS,GACT,eAAe,GACf,YAAY,GACZ,kBAAkB,GAClB,KAAK,GACL,SAAS,GACT,WAAW,GACX,uBAAuB,GACvB,eAAe,GACf,wBAAwB,CAAA;AAE5B,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACvB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,EAAE,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACvB,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,EAAE,CAAA;AAEH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/messages/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAA;AAElF,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,OAAO,GACP,KAAK,GACL,OAAO,GACP,OAAO,GACP,UAAU,GACV,OAAO,GACP,UAAU,GACV,OAAO,GACP,SAAS,GACT,SAAS,GACT,QAAQ,GACR,SAAS,GACT,UAAU,GACV,KAAK,GACL,YAAY,GACZ,MAAM,CAAA;AAEV,MAAM,MAAM,WAAW,GAAG;IACxB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,aAAa,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAChC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,aAAa,EAAE,OAAO,CAAA;QACtB,KAAK,CAAC,EAAE,OAAO,CAAA;KAChB,CAAA;IACD,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACtB,QAAQ,CAAC,EAAE;QACT,GAAG,EAAE,MAAM,CAAA;QACX,GAAG,EAAE,MAAM,CAAA;QACX,UAAU,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,YAAY,CAAC,EAAE;QACb,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,EAAE,MAAM,CAAA;QACd,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,OAAO,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iEAAiE;IACjE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAC9B,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB,gBAAgB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACpC,GAAG,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAA;IACrC,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAA;IACrB,qBAAqB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,cAAc,EAAE,CAAA;IAChC,sBAAsB,CAAC,EAAE;QACvB,MAAM,EAAE,OAAO,CAAA;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,OAAO,EAAE,CAAA;KACnB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAC5B,MAAM,GACN,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,OAAO,GACP,WAAW,GACX,SAAS,GACT,eAAe,GACf,YAAY,GACZ,kBAAkB,GAClB,KAAK,GACL,SAAS,GACT,WAAW,GACX,uBAAuB,GACvB,eAAe,GACf,wBAAwB,CAAA;AAE5B,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACvB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,EAAE,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAA;IACvB,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,EAAE,CAAA;AAEH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/apis/pipeline/PipelineApi.cjs

@@ -6,6 +6,139 @@ var PipelineApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/pipelines");
 	}
+	/**
+	* Adds a stage (with its statuses and reasons) to a pipeline. Resolves to the stage as stored,
+	* without the statuses/reasons, or to a refusal code with 200: `'STAGES_LIMIT'` (the pipeline
+	* already has 10 stages) or `'STAGE_ALREADY_EXIST'` (same name).
+	* @permissions pipelines.update
+	*/
+	createStage(body, headers) {
+		return this.client.post(`${this.basePath}/stage`, body, headers);
+	}
+	/**
+	* Updates a stage. `statuses` and `reasons` replace the whole set: items with `id` are kept
+	* and updated, items without it are created and the missing ones are deleted — omitting the
+	* lists deletes every status and reason of the stage. Resolves to the stage as stored, or to
+	* `'STAGE_ALREADY_EXIST'`.
+	* @permissions pipelines.update
+	*/
+	updateStage(id, body, headers) {
+		return this.client.put(`${this.basePath}/stage/${id}`, body, headers);
+	}
+	/**
+	* Deletes a stage and moves its cards (see {@link DeletePipelineStagePayload}). Resolves to
+	* `'MESSAGE_STAGE_DELETED'`, or to `'PIPELINES_MIN_STAGES'` (nothing deleted) when the pipeline
+	* has only 2 stages. The backend also serves this under `PUT /pipelines/delete-stage/{id}`.
+	* @permissions pipelines.update
+	*/
+	deleteStage(id, body = {}, headers) {
+		return this.client.request("DELETE", `${this.basePath}/stage/${id}`, body, headers);
+	}
+	/**
+	* Lists the statuses of every stage of a pipeline (`[]` for an unknown pipeline).
+	* @permissions pipelines.view
+	*/
+	getStatuses(pipelineId, headers) {
+		return this.client.get(`${this.basePath}/statuses/${pipelineId}`, headers);
+	}
+	/**
+	* Gets a stage status with the number of cards using it. An unknown id resolves to
+	* `{ cardsCount: 0 }` with 200, not to an error.
+	* @permissions pipelines.view
+	*/
+	getStatus(id, headers) {
+		return this.client.get(`${this.basePath}/status/${id}`, headers);
+	}
+	/**
+	* Deletes a stage status, keeping its cards without status or moving them to another one.
+	* Resolves to `'MESSAGE_STATUS_DELETED'`.
+	* @permissions pipelines.view
+	*/
+	deleteStatus(id, body, headers) {
+		return this.client.post(`${this.basePath}/delete-status/${id}`, body, headers);
+	}
+	/**
+	* Renames a stage status — same route as {@link deleteStatus}, without an `action`.
+	* Resolves to `'MESSAGE_STATUS_RENAMED'`; an empty name fails with 500.
+	* @permissions pipelines.view
+	*/
+	renameStatus(id, newStatusName, headers) {
+		return this.client.post(`${this.basePath}/delete-status/${id}`, { newStatusName }, headers);
+	}
+	/**
+	* Creates an automation of a pipeline. Resolves to the automation as stored.
+	* @permissions pipelines.update
+	*/
+	createAutomation(body, headers) {
+		return this.client.post(`${this.basePath}/automations`, body, headers);
+	}
+	/**
+	* Updates an automation. Resolves to the automation as stored.
+	* @permissions pipelines.update
+	*/
+	updateAutomation(id, body, headers) {
+		return this.client.put(`${this.basePath}/automations/${id}`, body, headers);
+	}
+	/**
+	* Deletes an automation. Resolves with no content; an unknown id fails with 500.
+	* @permissions pipelines.update
+	*/
+	deleteAutomation(id, headers) {
+		return this.client.delete(`${this.basePath}/automations/${id}`, headers);
+	}
+	/**
+	* Gets the automation of a pipeline — a single object (the first one found), or `[]` when
+	* the pipeline has none.
+	* @permissions pipelines.view
+	*/
+	getAutomation(pipelineId, headers) {
+		return this.client.get(`${this.basePath}/automations/${pipelineId}`, headers);
+	}
+	/**
+	* Copies a pipeline as `"<name> (copy)"`, with its stages, statuses, reasons and automations
+	* (not its departments). Resolves to the new pipeline as stored, without the stages.
+	* @permissions pipelines.view
+	*/
+	duplicate(pipelineId, headers) {
+		return this.client.post(`${this.basePath}/duplicate/${pipelineId}`, void 0, headers);
+	}
+	/**
+	* Archives a pipeline. Resolves to the pipeline with its stages and their card totals.
+	* @permissions pipelines.update
+	*/
+	archive(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/archive`, { archive: true }, headers);
+	}
+	/**
+	* Restores an archived pipeline. Resolves to the pipeline with its stages and their totals.
+	* @permissions pipelines.update
+	*/
+	unarchive(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/archive`, { archive: false }, headers);
+	}
+	/**
+	* Exports the cards of a pipeline as CSV text (`;` as the delimiter): a summary block
+	* followed by one row per card.
+	* @permissions pipelines.view
+	*/
+	exportCsv(id, body = {}, headers) {
+		return this.client.post(`${this.basePath}/${id}/export`, body, headers);
+	}
+	/**
+	* Lists the pipelines of the account with their stages and card totals. Not paginated.
+	* @permissions pipelines.view
+	*/
+	getManyWithTotals(query, headers) {
+		return this.client.get(`${this.basePath}/withTotals${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Gets the card totals of a stage, optionally filtered like the board. Resolves to `null`
+	* for an unknown stage.
+	* @permissions pipelines.update OR pipelines.opportunity.update
+	*/
+	getStageTotals(stageId, filters = {}, headers) {
+		return this.client.post(`${this.basePath}/stage-totals/${stageId}`, filters, headers);
+	}
 };
 
 //#endregion

package/dist/apis/pipeline/PipelineApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"PipelineApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/pipeline/PipelineApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type { Pipeline, CreatePipelinePayload, UpdatePipelinePayload } from './types'\n\nexport class PipelineApi extends BaseCrudApi<\n  Pipeline,\n  CreatePipelinePayload,\n  UpdatePipelinePayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/pipelines')\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,cAAb,cAAiCA,qCAI/B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa"}
+{"version":3,"file":"PipelineApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/pipeline/PipelineApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  CreatePipelineAutomationPayload,\n  CreatePipelinePayload,\n  CreatePipelineStagePayload,\n  DeletePipelineStagePayload,\n  DeletePipelineStageResult,\n  DeletePipelineStatusPayload,\n  ExportPipelinePayload,\n  Pipeline,\n  PipelineAutomation,\n  PipelineRecord,\n  PipelineStage,\n  PipelineStageRefusal,\n  PipelineStageStatusWithCount,\n  PipelineStageTotals,\n  PipelineStageTotalsFilters,\n  PipelineStatusRef,\n  PipelinesWithTotals,\n  PipelinesWithTotalsQuery,\n  UpdatePipelineAutomationPayload,\n  UpdatePipelinePayload,\n  UpdatePipelineStagePayload,\n} from './types'\n\nexport class PipelineApi extends BaseCrudApi<\n  Pipeline,\n  CreatePipelinePayload,\n  UpdatePipelinePayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/pipelines')\n  }\n\n  /**\n   * Adds a stage (with its statuses and reasons) to a pipeline. Resolves to the stage as stored,\n   * without the statuses/reasons, or to a refusal code with 200: `'STAGES_LIMIT'` (the pipeline\n   * already has 10 stages) or `'STAGE_ALREADY_EXIST'` (same name).\n   * @permissions pipelines.update\n   */\n  createStage(\n    body: CreatePipelineStagePayload,\n    headers?: Record<string, string>,\n  ): Promise<PipelineStage | PipelineStageRefusal> {\n    return this.client.post<PipelineStage | PipelineStageRefusal, CreatePipelineStagePayload>(\n      `${this.basePath}/stage`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Updates a stage. `statuses` and `reasons` replace the whole set: items with `id` are kept\n   * and updated, items without it are created and the missing ones are deleted — omitting the\n   * lists deletes every status and reason of the stage. Resolves to the stage as stored, or to\n   * `'STAGE_ALREADY_EXIST'`.\n   * @permissions pipelines.update\n   */\n  updateStage(\n    id: string,\n    body: UpdatePipelineStagePayload,\n    headers?: Record<string, string>,\n  ): Promise<PipelineStage | 'STAGE_ALREADY_EXIST'> {\n    return this.client.put<PipelineStage | 'STAGE_ALREADY_EXIST', UpdatePipelineStagePayload>(\n      `${this.basePath}/stage/${id}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes a stage and moves its cards (see {@link DeletePipelineStagePayload}). Resolves to\n   * `'MESSAGE_STAGE_DELETED'`, or to `'PIPELINES_MIN_STAGES'` (nothing deleted) when the pipeline\n   * has only 2 stages. The backend also serves this under `PUT /pipelines/delete-stage/{id}`.\n   * @permissions pipelines.update\n   */\n  deleteStage(\n    id: string,\n    body: DeletePipelineStagePayload = {},\n    headers?: Record<string, string>,\n  ): Promise<DeletePipelineStageResult> {\n    return this.client.request<DeletePipelineStageResult, DeletePipelineStagePayload>(\n      'DELETE',\n      `${this.basePath}/stage/${id}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Lists the statuses of every stage of a pipeline (`[]` for an unknown pipeline).\n   * @permissions pipelines.view\n   */\n  getStatuses(pipelineId: string, headers?: Record<string, string>): Promise<PipelineStatusRef[]> {\n    return this.client.get<PipelineStatusRef[]>(`${this.basePath}/statuses/${pipelineId}`, headers)\n  }\n\n  /**\n   * Gets a stage status with the number of cards using it. An unknown id resolves to\n   * `{ cardsCount: 0 }` with 200, not to an error.\n   * @permissions pipelines.view\n   */\n  getStatus(\n    id: string,\n    headers?: Record<string, string>,\n  ): Promise<PipelineStageStatusWithCount | { cardsCount: 0 }> {\n    return this.client.get<PipelineStageStatusWithCount | { cardsCount: 0 }>(\n      `${this.basePath}/status/${id}`,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes a stage status, keeping its cards without status or moving them to another one.\n   * Resolves to `'MESSAGE_STATUS_DELETED'`.\n   * @permissions pipelines.view\n   */\n  deleteStatus(\n    id: string,\n    body: DeletePipelineStatusPayload,\n    headers?: Record<string, string>,\n  ): Promise<'MESSAGE_STATUS_DELETED'> {\n    return this.client.post<'MESSAGE_STATUS_DELETED', DeletePipelineStatusPayload>(\n      `${this.basePath}/delete-status/${id}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Renames a stage status — same route as {@link deleteStatus}, without an `action`.\n   * Resolves to `'MESSAGE_STATUS_RENAMED'`; an empty name fails with 500.\n   * @permissions pipelines.view\n   */\n  renameStatus(\n    id: string,\n    newStatusName: string,\n    headers?: Record<string, string>,\n  ): Promise<'MESSAGE_STATUS_RENAMED'> {\n    return this.client.post<'MESSAGE_STATUS_RENAMED', { newStatusName: string }>(\n      `${this.basePath}/delete-status/${id}`,\n      { newStatusName },\n      headers,\n    )\n  }\n\n  /**\n   * Creates an automation of a pipeline. Resolves to the automation as stored.\n   * @permissions pipelines.update\n   */\n  createAutomation(\n    body: CreatePipelineAutomationPayload,\n    headers?: Record<string, string>,\n  ): Promise<PipelineAutomation> {\n    return this.client.post<PipelineAutomation, CreatePipelineAutomationPayload>(\n      `${this.basePath}/automations`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Updates an automation. Resolves to the automation as stored.\n   * @permissions pipelines.update\n   */\n  updateAutomation(\n    id: string,\n    body: UpdatePipelineAutomationPayload,\n    headers?: Record<string, string>,\n  ): Promise<PipelineAutomation> {\n    return this.client.put<PipelineAutomation, UpdatePipelineAutomationPayload>(\n      `${this.basePath}/automations/${id}`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Deletes an automation. Resolves with no content; an unknown id fails with 500.\n   * @permissions pipelines.update\n   */\n  deleteAutomation(id: string, headers?: Record<string, string>): Promise<void> {\n    return this.client.delete<void>(`${this.basePath}/automations/${id}`, headers)\n  }\n\n  /**\n   * Gets the automation of a pipeline — a single object (the first one found), or `[]` when\n   * the pipeline has none.\n   * @permissions pipelines.view\n   */\n  getAutomation(\n    pipelineId: string,\n    headers?: Record<string, string>,\n  ): Promise<PipelineAutomation | []> {\n    return this.client.get<PipelineAutomation | []>(\n      `${this.basePath}/automations/${pipelineId}`,\n      headers,\n    )\n  }\n\n  /**\n   * Copies a pipeline as `\"<name> (copy)\"`, with its stages, statuses, reasons and automations\n   * (not its departments). Resolves to the new pipeline as stored, without the stages.\n   * @permissions pipelines.view\n   */\n  duplicate(pipelineId: string, headers?: Record<string, string>): Promise<PipelineRecord> {\n    return this.client.post<PipelineRecord>(\n      `${this.basePath}/duplicate/${pipelineId}`,\n      undefined,\n      headers,\n    )\n  }\n\n  /**\n   * Archives a pipeline. Resolves to the pipeline with its stages and their card totals.\n   * @permissions pipelines.update\n   */\n  archive(id: string, headers?: Record<string, string>): Promise<Pipeline> {\n    return this.client.post<Pipeline, { archive: boolean }>(\n      `${this.basePath}/${id}/archive`,\n      { archive: true },\n      headers,\n    )\n  }\n\n  /**\n   * Restores an archived pipeline. Resolves to the pipeline with its stages and their totals.\n   * @permissions pipelines.update\n   */\n  unarchive(id: string, headers?: Record<string, string>): Promise<Pipeline> {\n    return this.client.post<Pipeline, { archive: boolean }>(\n      `${this.basePath}/${id}/archive`,\n      { archive: false },\n      headers,\n    )\n  }\n\n  /**\n   * Exports the cards of a pipeline as CSV text (`;` as the delimiter): a summary block\n   * followed by one row per card.\n   * @permissions pipelines.view\n   */\n  exportCsv(\n    id: string,\n    body: ExportPipelinePayload = {},\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, ExportPipelinePayload>(\n      `${this.basePath}/${id}/export`,\n      body,\n      headers,\n    )\n  }\n\n  /**\n   * Lists the pipelines of the account with their stages and card totals. Not paginated.\n   * @permissions pipelines.view\n   */\n  getManyWithTotals(\n    query?: PipelinesWithTotalsQuery,\n    headers?: Record<string, string>,\n  ): Promise<PipelinesWithTotals> {\n    return this.client.get<PipelinesWithTotals>(\n      `${this.basePath}/withTotals${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Gets the card totals of a stage, optionally filtered like the board. Resolves to `null`\n   * for an unknown stage.\n   * @permissions pipelines.update OR pipelines.opportunity.update\n   */\n  getStageTotals(\n    stageId: string,\n    filters: PipelineStageTotalsFilters = {},\n    headers?: Record<string, string>,\n  ): Promise<PipelineStageTotals | null> {\n    return this.client.post<PipelineStageTotals | null, PipelineStageTotalsFilters>(\n      `${this.basePath}/stage-totals/${stageId}`,\n      filters,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AA0BA,IAAa,cAAb,cAAiCA,qCAI/B;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;;;CAS7B,YACE,MACA,SAC+C;AAC/C,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,SACjB,MACA,QACD;;;;;;;;;CAUH,YACE,IACA,MACA,SACgD;AAChD,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,SAAS,MAC1B,MACA,QACD;;;;;;;;CASH,YACE,IACA,OAAmC,EAAE,EACrC,SACoC;AACpC,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,SAAS,MAC1B,MACA,QACD;;;;;;CAOH,YAAY,YAAoB,SAAgE;AAC9F,SAAO,KAAK,OAAO,IAAyB,GAAG,KAAK,SAAS,YAAY,cAAc,QAAQ;;;;;;;CAQjG,UACE,IACA,SAC2D;AAC3D,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,UAAU,MAC3B,QACD;;;;;;;CAQH,aACE,IACA,MACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBAAiB,MAClC,MACA,QACD;;;;;;;CAQH,aACE,IACA,eACA,SACmC;AACnC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBAAiB,MAClC,EAAE,eAAe,EACjB,QACD;;;;;;CAOH,iBACE,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,eACjB,MACA,QACD;;;;;;CAOH,iBACE,IACA,MACA,SAC6B;AAC7B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,eAAe,MAChC,MACA,QACD;;;;;;CAOH,iBAAiB,IAAY,SAAiD;AAC5E,SAAO,KAAK,OAAO,OAAa,GAAG,KAAK,SAAS,eAAe,MAAM,QAAQ;;;;;;;CAQhF,cACE,YACA,SACkC;AAClC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,eAAe,cAChC,QACD;;;;;;;CAQH,UAAU,YAAoB,SAA2D;AACvF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,aAAa,cAC9B,QACA,QACD;;;;;;CAOH,QAAQ,IAAY,SAAqD;AACvE,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,EAAE,SAAS,MAAM,EACjB,QACD;;;;;;CAOH,UAAU,IAAY,SAAqD;AACzE,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WACvB,EAAE,SAAS,OAAO,EAClB,QACD;;;;;;;CAQH,UACE,IACA,OAA8B,EAAE,EAChC,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,UACvB,MACA,QACD;;;;;;CAOH,kBACE,OACA,SAC8B;AAC9B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,aAAa,KAAK,cAAc,MAAM,IACvD,QACD;;;;;;;CAQH,eACE,SACA,UAAsC,EAAE,EACxC,SACqC;AACrC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,gBAAgB,WACjC,SACA,QACD"}

package/dist/apis/pipeline/PipelineApi.d.ts

@@ -1,7 +1,108 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Pipeline, CreatePipelinePayload, UpdatePipelinePayload } from './types';
+import type { CreatePipelineAutomationPayload, CreatePipelinePayload, CreatePipelineStagePayload, DeletePipelineStagePayload, DeletePipelineStageResult, DeletePipelineStatusPayload, ExportPipelinePayload, Pipeline, PipelineAutomation, PipelineRecord, PipelineStage, PipelineStageRefusal, PipelineStageStatusWithCount, PipelineStageTotals, PipelineStageTotalsFilters, PipelineStatusRef, PipelinesWithTotals, PipelinesWithTotalsQuery, UpdatePipelineAutomationPayload, UpdatePipelinePayload, UpdatePipelineStagePayload } from './types';
 export declare class PipelineApi extends BaseCrudApi<Pipeline, CreatePipelinePayload, UpdatePipelinePayload> {
     constructor(client: ApiClient);
+    /**
+     * Adds a stage (with its statuses and reasons) to a pipeline. Resolves to the stage as stored,
+     * without the statuses/reasons, or to a refusal code with 200: `'STAGES_LIMIT'` (the pipeline
+     * already has 10 stages) or `'STAGE_ALREADY_EXIST'` (same name).
+     * @permissions pipelines.update
+     */
+    createStage(body: CreatePipelineStagePayload, headers?: Record<string, string>): Promise<PipelineStage | PipelineStageRefusal>;
+    /**
+     * Updates a stage. `statuses` and `reasons` replace the whole set: items with `id` are kept
+     * and updated, items without it are created and the missing ones are deleted — omitting the
+     * lists deletes every status and reason of the stage. Resolves to the stage as stored, or to
+     * `'STAGE_ALREADY_EXIST'`.
+     * @permissions pipelines.update
+     */
+    updateStage(id: string, body: UpdatePipelineStagePayload, headers?: Record<string, string>): Promise<PipelineStage | 'STAGE_ALREADY_EXIST'>;
+    /**
+     * Deletes a stage and moves its cards (see {@link DeletePipelineStagePayload}). Resolves to
+     * `'MESSAGE_STAGE_DELETED'`, or to `'PIPELINES_MIN_STAGES'` (nothing deleted) when the pipeline
+     * has only 2 stages. The backend also serves this under `PUT /pipelines/delete-stage/{id}`.
+     * @permissions pipelines.update
+     */
+    deleteStage(id: string, body?: DeletePipelineStagePayload, headers?: Record<string, string>): Promise<DeletePipelineStageResult>;
+    /**
+     * Lists the statuses of every stage of a pipeline (`[]` for an unknown pipeline).
+     * @permissions pipelines.view
+     */
+    getStatuses(pipelineId: string, headers?: Record<string, string>): Promise<PipelineStatusRef[]>;
+    /**
+     * Gets a stage status with the number of cards using it. An unknown id resolves to
+     * `{ cardsCount: 0 }` with 200, not to an error.
+     * @permissions pipelines.view
+     */
+    getStatus(id: string, headers?: Record<string, string>): Promise<PipelineStageStatusWithCount | {
+        cardsCount: 0;
+    }>;
+    /**
+     * Deletes a stage status, keeping its cards without status or moving them to another one.
+     * Resolves to `'MESSAGE_STATUS_DELETED'`.
+     * @permissions pipelines.view
+     */
+    deleteStatus(id: string, body: DeletePipelineStatusPayload, headers?: Record<string, string>): Promise<'MESSAGE_STATUS_DELETED'>;
+    /**
+     * Renames a stage status — same route as {@link deleteStatus}, without an `action`.
+     * Resolves to `'MESSAGE_STATUS_RENAMED'`; an empty name fails with 500.
+     * @permissions pipelines.view
+     */
+    renameStatus(id: string, newStatusName: string, headers?: Record<string, string>): Promise<'MESSAGE_STATUS_RENAMED'>;
+    /**
+     * Creates an automation of a pipeline. Resolves to the automation as stored.
+     * @permissions pipelines.update
+     */
+    createAutomation(body: CreatePipelineAutomationPayload, headers?: Record<string, string>): Promise<PipelineAutomation>;
+    /**
+     * Updates an automation. Resolves to the automation as stored.
+     * @permissions pipelines.update
+     */
+    updateAutomation(id: string, body: UpdatePipelineAutomationPayload, headers?: Record<string, string>): Promise<PipelineAutomation>;
+    /**
+     * Deletes an automation. Resolves with no content; an unknown id fails with 500.
+     * @permissions pipelines.update
+     */
+    deleteAutomation(id: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Gets the automation of a pipeline — a single object (the first one found), or `[]` when
+     * the pipeline has none.
+     * @permissions pipelines.view
+     */
+    getAutomation(pipelineId: string, headers?: Record<string, string>): Promise<PipelineAutomation | []>;
+    /**
+     * Copies a pipeline as `"<name> (copy)"`, with its stages, statuses, reasons and automations
+     * (not its departments). Resolves to the new pipeline as stored, without the stages.
+     * @permissions pipelines.view
+     */
+    duplicate(pipelineId: string, headers?: Record<string, string>): Promise<PipelineRecord>;
+    /**
+     * Archives a pipeline. Resolves to the pipeline with its stages and their card totals.
+     * @permissions pipelines.update
+     */
+    archive(id: string, headers?: Record<string, string>): Promise<Pipeline>;
+    /**
+     * Restores an archived pipeline. Resolves to the pipeline with its stages and their totals.
+     * @permissions pipelines.update
+     */
+    unarchive(id: string, headers?: Record<string, string>): Promise<Pipeline>;
+    /**
+     * Exports the cards of a pipeline as CSV text (`;` as the delimiter): a summary block
+     * followed by one row per card.
+     * @permissions pipelines.view
+     */
+    exportCsv(id: string, body?: ExportPipelinePayload, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Lists the pipelines of the account with their stages and card totals. Not paginated.
+     * @permissions pipelines.view
+     */
+    getManyWithTotals(query?: PipelinesWithTotalsQuery, headers?: Record<string, string>): Promise<PipelinesWithTotals>;
+    /**
+     * Gets the card totals of a stage, optionally filtered like the board. Resolves to `null`
+     * for an unknown stage.
+     * @permissions pipelines.update OR pipelines.opportunity.update
+     */
+    getStageTotals(stageId: string, filters?: PipelineStageTotalsFilters, headers?: Record<string, string>): Promise<PipelineStageTotals | null>;
 }
 //# sourceMappingURL=PipelineApi.d.ts.map

package/dist/apis/pipeline/PipelineApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PipelineApi.d.ts","sourceRoot":"","sources":["../../../src/apis/pipeline/PipelineApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAErF,qBAAa,WAAY,SAAQ,WAAW,CAC1C,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,CACtB;gBACa,MAAM,EAAE,SAAS;CAG9B"}
+{"version":3,"file":"PipelineApi.d.ts","sourceRoot":"","sources":["../../../src/apis/pipeline/PipelineApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,+BAA+B,EAC/B,qBAAqB,EACrB,0BAA0B,EAC1B,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,QAAQ,EACR,kBAAkB,EAClB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,4BAA4B,EAC5B,mBAAmB,EACnB,0BAA0B,EAC1B,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,+BAA+B,EAC/B,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,SAAS,CAAA;AAEhB,qBAAa,WAAY,SAAQ,WAAW,CAC1C,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,CACtB;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;;OAKG;IACH,WAAW,CACT,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,aAAa,GAAG,oBAAoB,CAAC;IAQhD;;;;;;OAMG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,aAAa,GAAG,qBAAqB,CAAC;IAQjD;;;;;OAKG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,0BAA+B,EACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,yBAAyB,CAAC;IASrC;;;OAGG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAI/F;;;;OAIG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,4BAA4B,GAAG;QAAE,UAAU,EAAE,CAAC,CAAA;KAAE,CAAC;IAO5D;;;;OAIG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;;OAIG;IACH,YAAY,CACV,EAAE,EAAE,MAAM,EACV,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;OAGG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7E;;;;OAIG;IACH,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAOnC;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC;IAQxF;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQxE;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAQ1E;;;;OAIG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,qBAA0B,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAQlB;;;OAGG;IACH,iBAAiB,CACf,KAAK,CAAC,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,mBAAmB,CAAC;IAO/B;;;;OAIG;IACH,cAAc,CACZ,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAA+B,EACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAOvC"}