@ikatec/digisac-api-sdk 4.6.0 → 4.8.0

package/dist/apis/campaigns/CampaignsApi.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"CampaignsApi.mjs","names":[],"sources":["../../../src/apis/campaigns/CampaignsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core'\nimport { BaseCrudApi } from '../../core'\nimport type {\n  AutoPauseModePayload,\n  Campaign,\n  CampaignStats,\n  CreateCampaignPayload,\n  ExportCampaignResultPayload,\n  ExportTemplateCsvPayload,\n  HsmLimit,\n  SetIntervalPayload,\n  UpdateCampaignPayload,\n} from './types'\n\nexport class CampaignsApi extends BaseCrudApi<\n  Campaign,\n  CreateCampaignPayload,\n  UpdateCampaignPayload\n> {\n  constructor(client: ApiClient) {\n    super(client, '/campaigns')\n\n    this.sendById = this.sendById.bind(this)\n    this.pauseById = this.pauseById.bind(this)\n    this.resumeById = this.resumeById.bind(this)\n    this.duplicateById = this.duplicateById.bind(this)\n    this.getStatsById = this.getStatsById.bind(this)\n    this.setIntervalById = this.setIntervalById.bind(this)\n    this.getContactCount = this.getContactCount.bind(this)\n    this.setAutoPauseMode = this.setAutoPauseMode.bind(this)\n    this.exportCampaignResult = this.exportCampaignResult.bind(this)\n    this.exportTemplateCsv = this.exportTemplateCsv.bind(this)\n    this.getHsmLimit = this.getHsmLimit.bind(this)\n  }\n\n  /** Starts sending messages for the given campaign. */\n  sendById(id: string): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/send`)\n  }\n\n  /** Pauses a campaign that is currently sending. */\n  pauseById(id: string): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/pause`)\n  }\n\n  /** Resumes a previously paused campaign. */\n  resumeById(id: string): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/resume`)\n  }\n\n  /** Creates a copy of an existing campaign. */\n  duplicateById(id: string): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/duplicate`)\n  }\n\n  /** Returns send/delivery/view statistics for a campaign. */\n  getStatsById(id: string): Promise<CampaignStats> {\n    return this.client.get<CampaignStats>(`${this.basePath}/${id}/stats`)\n  }\n\n  /** Updates the min/max send interval for a campaign. */\n  setIntervalById(id: string, data: SetIntervalPayload): Promise<Campaign> {\n    return this.client.post<Campaign, SetIntervalPayload>(`${this.basePath}/${id}/interval`, data)\n  }\n\n  /** Returns the total number of contacts targeted by a campaign. */\n  getContactCount(id: string): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/${id}/contactCount`)\n  }\n\n  /** Configures the auto-pause behavior for campaigns. */\n  setAutoPauseMode(data: AutoPauseModePayload): Promise<unknown> {\n    return this.client.put(`${this.basePath}/autoPauseMode`, data)\n  }\n\n  /** Exports campaign send results as a CSV file. */\n  exportCampaignResult(data: ExportCampaignResultPayload): Promise<unknown> {\n    return this.client.post(`${this.basePath}/export/csv`, data)\n  }\n\n  /** Exports a CSV template for importing contacts into an HSM campaign. */\n  exportTemplateCsv(data: ExportTemplateCsvPayload): Promise<unknown> {\n    return this.client.post(`${this.basePath}/exportTemplate`, data)\n  }\n\n  /** Returns the HSM message usage and limit for an account. */\n  getHsmLimit(accountId: string): Promise<HsmLimit> {\n    return this.client.get<HsmLimit>(`/whatsapp-business-templates/${accountId}/hsmLimit`)\n  }\n}\n"],"mappings":";;;;AAcA,IAAa,eAAb,cAAkC,YAIhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;AAE3B,OAAK,WAAW,KAAK,SAAS,KAAK,KAAK;AACxC,OAAK,YAAY,KAAK,UAAU,KAAK,KAAK;AAC1C,OAAK,aAAa,KAAK,WAAW,KAAK,KAAK;AAC5C,OAAK,gBAAgB,KAAK,cAAc,KAAK,KAAK;AAClD,OAAK,eAAe,KAAK,aAAa,KAAK,KAAK;AAChD,OAAK,kBAAkB,KAAK,gBAAgB,KAAK,KAAK;AACtD,OAAK,kBAAkB,KAAK,gBAAgB,KAAK,KAAK;AACtD,OAAK,mBAAmB,KAAK,iBAAiB,KAAK,KAAK;AACxD,OAAK,uBAAuB,KAAK,qBAAqB,KAAK,KAAK;AAChE,OAAK,oBAAoB,KAAK,kBAAkB,KAAK,KAAK;AAC1D,OAAK,cAAc,KAAK,YAAY,KAAK,KAAK;;;CAIhD,SAAS,IAA+B;AACtC,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,OAAO;;;CAIlE,UAAU,IAA+B;AACvC,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,QAAQ;;;CAInE,WAAW,IAA+B;AACxC,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS;;;CAIpE,cAAc,IAA+B;AAC3C,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,YAAY;;;CAIvE,aAAa,IAAoC;AAC/C,SAAO,KAAK,OAAO,IAAmB,GAAG,KAAK,SAAS,GAAG,GAAG,QAAQ;;;CAIvE,gBAAgB,IAAY,MAA6C;AACvE,SAAO,KAAK,OAAO,KAAmC,GAAG,KAAK,SAAS,GAAG,GAAG,YAAY,KAAK;;;CAIhG,gBAAgB,IAA6B;AAC3C,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,eAAe;;;CAIvE,iBAAiB,MAA8C;AAC7D,SAAO,KAAK,OAAO,IAAI,GAAG,KAAK,SAAS,iBAAiB,KAAK;;;CAIhE,qBAAqB,MAAqD;AACxE,SAAO,KAAK,OAAO,KAAK,GAAG,KAAK,SAAS,cAAc,KAAK;;;CAI9D,kBAAkB,MAAkD;AAClE,SAAO,KAAK,OAAO,KAAK,GAAG,KAAK,SAAS,kBAAkB,KAAK;;;CAIlE,YAAY,WAAsC;AAChD,SAAO,KAAK,OAAO,IAAc,gCAAgC,UAAU,WAAW"}
+{"version":3,"file":"CampaignsApi.mjs","names":[],"sources":["../../../src/apis/campaigns/CampaignsApi.ts"],"sourcesContent":["import qs from 'qs'\nimport type { ApiClient } from '../../core'\nimport { BaseCrudApi } from '../../core'\nimport type {\n  AutoPauseModePayload,\n  Campaign,\n  CampaignContactsPage,\n  CampaignContactsQuery,\n  CampaignListQuery,\n  CampaignStats,\n  CampaignTimelineEvent,\n  CreateCampaignPayload,\n  ExportCampaignImportErrorsQuery,\n  ExportCampaignResultPayload,\n  ExportTemplateCsvPayload,\n  HsmLimit,\n  SetIntervalPayload,\n  UpdateCampaignPayload,\n} from './types'\n\n/**\n * Campaigns (mass sending). Every `/campaigns` route requires the campaigns feature in the plan of\n * the account.\n * `getMany` takes the `where` of a `ListQuery` and the flat filters of the Campaigns screen (see\n * {@link CampaignListQuery}); `getById` of an unknown id resolves `null`. `deleteById` answers the\n * text `'OK'`. `getMany({ paginate: false })` answers 400 `FILTER_PARAM_INVALID` with the default\n * `'json'` query format (the route only takes `paginate` as a string): use `withQueryFormat('qs')`.\n */\nexport class CampaignsApi extends BaseCrudApi<\n  Campaign,\n  CreateCampaignPayload,\n  UpdateCampaignPayload,\n  CampaignListQuery,\n  'OK'\n> {\n  constructor(client: ApiClient) {\n    super(client, '/campaigns')\n  }\n\n  /**\n   * Starts sending the campaign: answers it as `processing` (an `import_error` campaign goes back\n   * to `importing_contacts`). It becomes `done` once every contact is fired.\n   * @permissions campaigns.view\n   */\n  sendById(id: string, headers?: Record<string, string>): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/send`, undefined, headers)\n  }\n\n  /**\n   * Sets the campaign as `paused` and answers `true`. An unknown id answers 500.\n   * @permissions campaigns.view\n   */\n  pauseById(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.post<boolean>(`${this.basePath}/${id}/pause`, undefined, headers)\n  }\n\n  /**\n   * Sets the campaign back to `processing` and answers `true`. An unknown id answers 500.\n   * @permissions campaigns.view\n   */\n  resumeById(id: string, headers?: Record<string, string>): Promise<boolean> {\n    return this.client.post<boolean>(`${this.basePath}/${id}/resume`, undefined, headers)\n  }\n\n  /**\n   * Fires again the messages that failed: sets them as pending and the campaign as `processing`.\n   * Answers the text `'OK'` (also when nothing failed, and then the status does not change); an\n   * unknown id answers `false` (status 200).\n   * @permissions campaigns.view\n   */\n  retryById(id: string, headers?: Record<string, string>): Promise<'OK' | false> {\n    return this.client.post<'OK' | false>(`${this.basePath}/${id}/retry`, undefined, headers)\n  }\n\n  /**\n   * Creates a copy of the campaign (`ready`, same title, messages and tags), answered without the\n   * messages. An unknown id answers 500.\n   * @permissions campaigns.view\n   */\n  duplicateById(id: string, headers?: Record<string, string>): Promise<Campaign> {\n    return this.client.post<Campaign>(`${this.basePath}/${id}/duplicate`, undefined, headers)\n  }\n\n  /** Returns the send, delivery and interaction statistics of the campaign. */\n  getStatsById(id: string, headers?: Record<string, string>): Promise<CampaignStats> {\n    return this.client.get<CampaignStats>(`${this.basePath}/${id}/stats`, headers)\n  }\n\n  /**\n   * Returns the events of the campaign (created, scheduled, started, finished and the last\n   * interruption), the most recent first.\n   */\n  getTimeline(id: string, headers?: Record<string, string>): Promise<CampaignTimelineEvent[]> {\n    return this.client.get<CampaignTimelineEvent[]>(`${this.basePath}/${id}/timeline`, headers)\n  }\n\n  /**\n   * Returns a page of the contacts of the campaign with their sending status (15 per page by\n   * default). An unknown id answers an empty page.\n   */\n  getContacts(\n    id: string,\n    query?: CampaignContactsQuery,\n    headers?: Record<string, string>,\n  ): Promise<CampaignContactsPage> {\n    return this.client.get<CampaignContactsPage>(\n      `${this.basePath}/${id}/contacts${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * Sets the min/max interval between the sends (whole numbers, `0` or more) and answers `true`.\n   * An unknown id answers 500.\n   * @permissions campaigns.view\n   */\n  setIntervalById(\n    id: string,\n    data: SetIntervalPayload,\n    headers?: Record<string, string>,\n  ): Promise<boolean> {\n    return this.client.post<boolean, SetIntervalPayload>(\n      `${this.basePath}/${id}/interval`,\n      data,\n      headers,\n    )\n  }\n\n  /** Returns the number of contacts targeted by the campaign. */\n  getContactCount(id: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/${id}/contactCount`, headers)\n  }\n\n  /** Counts the `ready` campaigns of a connection. An unknown id counts 0. */\n  countReadyByService(serviceId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-ready/${serviceId}`, headers)\n  }\n\n  /**\n   * Sets the auto-pause mode of the campaigns of the account (`settings.campaign`). Answers the\n   * text `'OK'`, or `false` when the account was not updated.\n   */\n  setAutoPauseMode(\n    data: AutoPauseModePayload,\n    headers?: Record<string, string>,\n  ): Promise<'OK' | false> {\n    return this.client.put<'OK' | false, AutoPauseModePayload>(\n      `${this.basePath}/autoPauseMode`,\n      data,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the contacts of the campaign and their sending result as CSV (13 columns in the\n   * language of the user; `,`, or `;` with `type: 'semiColon'`), streamed without a Content-Type.\n   */\n  exportCampaignResult(\n    data: ExportCampaignResultPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, ExportCampaignResultPayload>(\n      `${this.basePath}/export/csv`,\n      data,\n      headers,\n    )\n  }\n\n  /** Exports the CSV (`;`) to fill in the contacts of a campaign of the given HSM template. */\n  exportTemplateCsv(\n    data: ExportTemplateCsvPayload,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    return this.client.post<string, ExportTemplateCsvPayload>(\n      `${this.basePath}/exportTemplate`,\n      data,\n      headers,\n    )\n  }\n\n  /**\n   * Exports the rows of the import file that were not imported (invalid number, unknown or\n   * ambiguous username) as CSV: line, name, number, username and reason.\n   */\n  exportImportErrors(\n    id: string,\n    query?: ExportCampaignImportErrorsQuery,\n    headers?: Record<string, string>,\n  ): Promise<string> {\n    const queryString = query?.delimiter ? `?${qs.stringify({ delimiter: query.delimiter })}` : ''\n    return this.client.get<string>(`${this.basePath}/${id}/import-errors${queryString}`, headers)\n  }\n\n  /**\n   * Deletes the campaigns of the given ids and answers `true` (unknown ids are skipped). No id, or\n   * an id that is not a UUID, answers 400 `{ error: 'Invalid ids', code: 'INVALID_IDS' }`.\n   * @permissions campaigns.view OR campaigns.destroy\n   */\n  deleteMany(ids: string[], headers?: Record<string, string>): Promise<true> {\n    return this.client.request<true, { ids: string[] }>(\n      'DELETE',\n      `${this.basePath}/delete-many`,\n      { ids },\n      headers,\n    )\n  }\n\n  /** Returns the HSM message usage and limit of an account. */\n  getHsmLimit(accountId: string, headers?: Record<string, string>): Promise<HsmLimit> {\n    return this.client.get<HsmLimit>(`/whatsapp-business-templates/${accountId}/hsmLimit`, headers)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AA4BA,IAAa,eAAb,cAAkC,YAMhC;CACA,YAAY,QAAmB;AAC7B,QAAM,QAAQ,aAAa;;;;;;;CAQ7B,SAAS,IAAY,SAAqD;AACxE,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,QAAQ,QAAW,QAAQ;;;;;;CAOtF,UAAU,IAAY,SAAoD;AACxE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,QAAW,QAAQ;;;;;;CAOtF,WAAW,IAAY,SAAoD;AACzE,SAAO,KAAK,OAAO,KAAc,GAAG,KAAK,SAAS,GAAG,GAAG,UAAU,QAAW,QAAQ;;;;;;;;CASvF,UAAU,IAAY,SAAyD;AAC7E,SAAO,KAAK,OAAO,KAAmB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,QAAW,QAAQ;;;;;;;CAQ3F,cAAc,IAAY,SAAqD;AAC7E,SAAO,KAAK,OAAO,KAAe,GAAG,KAAK,SAAS,GAAG,GAAG,aAAa,QAAW,QAAQ;;;CAI3F,aAAa,IAAY,SAA0D;AACjF,SAAO,KAAK,OAAO,IAAmB,GAAG,KAAK,SAAS,GAAG,GAAG,SAAS,QAAQ;;;;;;CAOhF,YAAY,IAAY,SAAoE;AAC1F,SAAO,KAAK,OAAO,IAA6B,GAAG,KAAK,SAAS,GAAG,GAAG,YAAY,QAAQ;;;;;;CAO7F,YACE,IACA,OACA,SAC+B;AAC/B,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,GAAG,GAAG,WAAW,KAAK,cAAc,MAAM,IAC3D,QACD;;;;;;;CAQH,gBACE,IACA,MACA,SACkB;AAClB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,GAAG,GAAG,YACvB,MACA,QACD;;;CAIH,gBAAgB,IAAY,SAAmD;AAC7E,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,gBAAgB,QAAQ;;;CAIhF,oBAAoB,WAAmB,SAAmD;AACxF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,eAAe,aAAa,QAAQ;;;;;;CAOtF,iBACE,MACA,SACuB;AACvB,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,iBACjB,MACA,QACD;;;;;;CAOH,qBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,cACjB,MACA,QACD;;;CAIH,kBACE,MACA,SACiB;AACjB,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,kBACjB,MACA,QACD;;;;;;CAOH,mBACE,IACA,OACA,SACiB;EACjB,MAAM,cAAc,OAAO,YAAY,IAAI,GAAG,UAAU,EAAE,WAAW,MAAM,WAAW,CAAC,KAAK;AAC5F,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,gBAAgB,eAAe,QAAQ;;;;;;;CAQ/F,WAAW,KAAe,SAAiD;AACzE,SAAO,KAAK,OAAO,QACjB,UACA,GAAG,KAAK,SAAS,eACjB,EAAE,KAAK,EACP,QACD;;;CAIH,YAAY,WAAmB,SAAqD;AAClF,SAAO,KAAK,OAAO,IAAc,gCAAgC,UAAU,YAAY,QAAQ"}

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

@@ -1,16 +1,20 @@
+import type { ListQuery } from '../../core';
+import type { Account } from '../accounts';
 import type { Department } from '../departments';
 import type { File } from '../files';
-import type { Message } from '../messages';
 import type { Service } from '../services';
 import type { Tag } from '../tags';
 import type { User } from '../users';
 import type { WhatsappBusinessTemplate } from '../whatsappBusinessTemplates';
 export type CampaignStatus = 'ready' | 'queued' | 'processing' | 'paused' | 'waiting_connection' | 'canceled' | 'done' | 'insufficient_credits' | 'hsm_limit_exceeded' | 'import_error' | 'error' | 'importing_contacts' | 'preventive_break';
 export type CampaignConfig = {
-    /** Minimum interval in ms between sends. */
-    minInterval: number;
-    /** Maximum interval in ms between sends. */
-    maxInterval: number;
+    /**
+     * Minimum interval in ms between sends. Absent until set (a new campaign answers `config: {}`);
+     * `setIntervalById` stores a number, `updateById` stores what it is sent (a string stays a string).
+     */
+    minInterval?: number | string;
+    /** Maximum interval in ms between sends. Same rules as `minInterval`. */
+    maxInterval?: number | string;
     /** Column name in the import file used as the contact name. */
     nameField?: string;
     /** Column name in the import file used as the phone number. */
@@ -34,11 +38,22 @@ export type Campaign = {
     totalContacts: number | null;
     totalContactsImported: number | null;
     totalValidContacts: number | null;
-    sentContacts: number | null;
-    viewedContacts: number | null;
-    contactCount: number | null;
+    /** @deprecated Never answered: the campaign has no such column. */
+    sentContacts?: number | null;
+    /** @deprecated Never answered: the campaign has no such column. */
+    viewedContacts?: number | null;
+    /** @deprecated Never answered: read `getContactCount`. */
+    contactCount?: number | null;
     mustOpenTicket: boolean;
-    marketingIntegration: boolean;
+    /** @deprecated Never answered: the campaign transformer leaves the column out. */
+    marketingIntegration?: boolean;
+    /** Always `null`: the campaign has no such column (answered by the transformer). */
+    userId?: null;
+    /** Only in `getMany`: messages sent and viewed (ack 3). */
+    stats?: {
+        sent: number;
+        viewed: number;
+    };
     accountId: string;
     serviceId: string;
     defaultDepartmentId: string | null;
@@ -54,9 +69,26 @@ export type Campaign = {
     createdBy?: User | null;
     sentBy?: User | null;
     tags?: Tag[];
-    messages?: Message[];
+    messages?: CampaignMessage[];
     importFile?: File | null;
 };
+/** A message of the campaign (`campaign_messages`), as the `messages` include answers it. */
+export type CampaignMessage = {
+    id: string;
+    text: string | null;
+    extraOptions: Record<string, unknown> | null;
+    hsmId: string | null;
+    hsmFileId: string | null;
+    accountId: string;
+    campaignId: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string | null;
+    account?: Account;
+    file?: File | null;
+    hsmFile?: File | null;
+    hsm?: WhatsappBusinessTemplate | null;
+};
 export type CampaignRelationships = 'service' | 'defaultDepartment' | 'defaultUser' | 'createdBy' | 'sentBy' | 'tags' | 'messages' | 'importFile';
 export type CampaignTemplateParameterItem = {
     type: string;
@@ -102,6 +134,80 @@ export type CreateCampaignPayload = {
     marketingIntegration?: boolean;
 };
 export type UpdateCampaignPayload = Partial<CreateCampaignPayload>;
+/** The visible states the `status` filter of `getMany` takes (`'scheduled'` is derived from `isScheduled` + `sendsAt`). */
+export type CampaignListStatus = CampaignStatus | 'scheduled';
+/**
+ * `getMany` query: the `ListQuery` of a campaign plus the flat filters of the Campaigns screen.
+ * A flat `status` takes precedence over `where.status`. An invalid `status` or date answers 400
+ * `{ error: 'Invalid status' | 'Invalid date', code: 'FILTER_STATUS_INVALID' | 'FILTER_DATE_INVALID' }`.
+ */
+export type CampaignListQuery = ListQuery<Campaign> & {
+    serviceId?: string;
+    status?: CampaignListStatus;
+    /**
+     * Quality of the HSM template of the messages. `'HIGH'`, `'MEDIUM'` and `'LOW'` only filter when
+     * `include` has `messages` (the filter rewrites that include); without it they are ignored.
+     * `'UNKNOWN'` keeps the campaigns without a rated template.
+     */
+    templateHealth?: 'UNKNOWN' | 'HIGH' | 'MEDIUM' | 'LOW';
+    /** Searches the title (accent-insensitive). */
+    q?: string;
+    /**
+     * UTC ISO date-times ending in `Z` (a date alone answers 400 `FILTER_DATE_INVALID`); the days are
+     * taken in the timezone of the account. `sentAt*` filter `startedAt`.
+     */
+    sentAtFrom?: string;
+    sentAtTo?: string;
+    createdAtFrom?: string;
+    createdAtTo?: string;
+};
+/** The sending status of a contact of the campaign (`not_sent` in the filter also matches `pending`). */
+export type CampaignContactStatus = 'pending' | 'not_sent' | 'sent' | 'received' | 'read' | 'answered' | 'quality_hold' | 'quality_dropped';
+export type CampaignContactsQuery = {
+    page?: number;
+    perPage?: number;
+    /** Searches the name, the number and the username of the contact. */
+    search?: string;
+    contactStatus?: CampaignContactStatus[];
+    failReason?: string;
+    sortBy?: 'contactName' | 'contactNumber' | 'contactUsername' | 'status' | 'sentAt' | 'failReason';
+    sortDir?: 'ASC' | 'DESC';
+};
+export type CampaignContact = {
+    id: string;
+    sentAt: string | null;
+    failed: boolean;
+    failReason: string | null;
+    parameters: unknown;
+    contactName: string;
+    /** `null` for a contact known only by its username. */
+    contactNumber: string | null;
+    contactUsername: string | null;
+    contactId: string;
+    status: CampaignContactStatus;
+};
+export type CampaignContactsPage = {
+    data: CampaignContact[];
+    total: number;
+    limit: number;
+    skip: number;
+    currentPage: number;
+    lastPage: number;
+    from: number;
+    to: number;
+};
+export type CampaignTimelineEvent = {
+    /** `created`, `scheduled`, `started`, `finished` or `status-<status>`. */
+    id: string;
+    type: 'created' | 'scheduled' | 'started' | 'finished' | CampaignStatus;
+    timestamp: string;
+    /** The name of the user who created or sent the campaign, or `'Sistema'`. */
+    actor: string;
+    triggerType: 'manual' | 'automatic';
+};
+export type ExportCampaignImportErrorsQuery = {
+    delimiter?: ',' | ';' | ':';
+};
 export type CampaignStatsInfo = {
     totalValidContacts: number;
     totalContacts: number;
@@ -109,34 +215,67 @@ export type CampaignStatsInfo = {
     firedSuccessCount: number;
     firedFailedCount: number;
     totalMessagesCount: number;
+    sentMessagesCount: number;
     totalFiredCount: number;
     firedBlockedByMessageRuleCount: number;
 };
+/** Messages of the campaign by ack: `error`, `sending` (0), `sentToServer` (1), `received` (2), `viewed` (3), `played` (4). */
 export type CampaignStatsMessages = {
     error: number;
+    sending: number;
+    sentToServer: number;
     received: number;
     viewed: number;
+    played: number;
     answered: number;
 };
 export type CampaignStats = {
     campaignInfo: CampaignStatsInfo;
     messageInfo: CampaignStatsMessages;
+    /** @deprecated Kept by the backend for backward compatibility: read `campaignInfo.totalMessagesCount`. */
+    total: number;
+    /** @deprecated Read `campaignInfo.sentMessagesCount`. */
+    sent: number;
+    /** @deprecated Read `campaignInfo.firedFailedCount`. */
+    failed: number;
+    /** @deprecated Read `messageInfo.sending`. */
+    sending: number;
+    /** @deprecated Read `messageInfo.sentToServer`. */
+    sentToServer: number;
+    /** @deprecated Read `messageInfo.received`. */
+    received: number;
+    /** @deprecated Read `messageInfo.viewed`. */
+    viewed: number;
+    /** @deprecated Read `messageInfo.played`. */
+    played: number;
+    /** @deprecated Read `messageInfo.answered`. */
+    answered: number;
+    /** @deprecated Same as `messageInfo.sentToServer`. */
+    sentAndNotReceived: number;
 };
+/** Whole numbers, `0` or more (numeric strings are accepted). */
 export type SetIntervalPayload = {
-    minInterval: string;
-    maxInterval: string;
+    minInterval: number | string;
+    maxInterval: number | string;
 };
 export type ExportCampaignResultPayload = {
-    campaignId: string;
+    where: {
+        campaignId: string;
+        [key: string]: unknown;
+    };
+    /** `'semiColon'` separates the columns with `;` (default `,`). */
+    type?: 'semiColon';
 };
 export type ExportTemplateCsvPayload = {
     hsmId: string;
 };
 export type AutoPauseModePayload = {
-    mode: string;
+    mode: 'low-health' | 'medium-health' | 'disabled';
 };
 export type HsmLimit = {
     hsmLimit: number;
     hsmUsedLimit: number;
+    /** The HSM messages still available (`0` when none or the plan has no WhatsApp Business); `true` when the limit is disabled. */
+    hasLimit: number | boolean;
 };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAA;AAE5E,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,oBAAoB,GACpB,UAAU,GACV,MAAM,GACN,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,OAAO,GACP,oBAAoB,GACpB,kBAAkB,CAAA;AAEtB,MAAM,MAAM,cAAc,GAAG;IAC3B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,cAAc,EAAE,OAAO,CAAA;IACvB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,YAAY,CAAA;AAEhB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,6BAA6B,EAAE,CAAA;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAA;IACnC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,GAAG,CAAC,EAAE,wBAAwB,CAAA;IAC9B,UAAU,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACxC,YAAY,CAAC,EAAE,oBAAoB,CAAA;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAElE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,iBAAiB,CAAA;IAC/B,WAAW,EAAE,qBAAqB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,SAAS,CAAA;AAClC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAA;AAE5E,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,oBAAoB,GACpB,UAAU,GACV,MAAM,GACN,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,OAAO,GACP,oBAAoB,GACpB,kBAAkB,CAAA;AAEtB,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B,+DAA+D;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAA;IACpC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,mEAAmE;IACnE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,mEAAmE;IACnE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,cAAc,EAAE,OAAO,CAAA;IACvB,kFAAkF;IAClF,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,oFAAoF;IACpF,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,2DAA2D;IAC3D,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;IACxC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,iBAAiB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACrC,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAA;IAC5B,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB,CAAA;AAED,6FAA6F;AAC7F,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAC5C,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACrB,GAAG,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,mBAAmB,GACnB,aAAa,GACb,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,GACV,YAAY,CAAA;AAEhB,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,6BAA6B,EAAE,CAAA;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,QAAQ,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC/C,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAA;IACnC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,GAAG,CAAC,EAAE,wBAAwB,CAAA;IAC9B,UAAU,CAAC,EAAE,yBAAyB,EAAE,CAAA;IACxC,YAAY,CAAC,EAAE,oBAAoB,CAAA;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAElE,2HAA2H;AAC3H,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,WAAW,CAAA;AAE7D;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG;IACpD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAA;IACtD,+CAA+C;IAC/C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,yGAAyG;AACzG,MAAM,MAAM,qBAAqB,GAC7B,SAAS,GACT,UAAU,GACV,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,cAAc,GACd,iBAAiB,CAAA;AAErB,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,qBAAqB,EAAE,CAAA;IACvC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,aAAa,GAAG,eAAe,GAAG,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAA;IACjG,OAAO,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,uDAAuD;IACvD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,qBAAqB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,eAAe,EAAE,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,0EAA0E;IAC1E,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,cAAc,CAAA;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,QAAQ,GAAG,WAAW,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,SAAS,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,eAAe,EAAE,MAAM,CAAA;IACvB,8BAA8B,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,+HAA+H;AAC/H,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,YAAY,EAAE,iBAAiB,CAAA;IAC/B,WAAW,EAAE,qBAAqB,CAAA;IAClC,0GAA0G;IAC1G,KAAK,EAAE,MAAM,CAAA;IACb,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,MAAM,EAAE,MAAM,CAAA;IACd,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAA;IACf,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAA;IACpB,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,kBAAkB,EAAE,MAAM,CAAA;CAC3B,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;IAC5B,WAAW,EAAE,MAAM,GAAG,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAA;IACrD,kEAAkE;IAClE,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,YAAY,GAAG,eAAe,GAAG,UAAU,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,gIAAgI;IAChI,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAA;CAC3B,CAAA"}

package/dist/apis/tickets/TicketsApi.cjs

@@ -2,21 +2,94 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 
 //#region src/apis/tickets/TicketsApi.ts
+/**
+* Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+* the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+* `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+* `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+* of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+* tickets of the contacts of the connections restricted to that user; the counts and `getById`
+* do not.
+*/
 var TicketsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/tickets");
 	}
+	/** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+	updateById(id, body, headers) {
+		return super.updateById(id, body, headers);
+	}
+	/** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
 	/**
 	* Closes multiple tickets in a single request. This is the only ticket-close
 	* endpoint exposed by the API — there is no per-ticket close/update route.
 	*
 	* Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+	* `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+	* unknown or other accounts' tickets are skipped in silence; no id and no
+	* `allContactsSelected` answers 400 `ids not found`.
 	* @permissions tickets.close.all OR tickets.close.me
 	*/
 	closeMany(payload, headers) {
 		return this.client.put(`${this.basePath}/close-many`, payload, headers);
 	}
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	countPost(body, headers) {
+		return this.client.post(`${this.basePath}/count`, body, headers);
+	}
+	/** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+	countOpenByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-open/${serviceId}`, headers);
+	}
+	/** Counts the open tickets of a department. An unknown id counts 0. */
+	countOpenByDepartment(departmentId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-department/${departmentId}`, headers);
+	}
+	/** Counts the open tickets assigned to a user. An unknown id counts 0. */
+	countOpenByUser(userId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-user/${userId}`, headers);
+	}
+	/**
+	* The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+	* it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+	* `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+	*/
+	getFirstWaitingTime(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/first-waiting-time`, headers);
+	}
+	/**
+	* Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+	* summary, dates and the messages without the internal comments), sent as the attachment
+	* `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+	* (`undefined`); an unknown protocol never answers.
+	*/
+	exportTxt(protocol, headers) {
+		return this.client.post(`${this.basePath}/export`, { protocol }, headers);
+	}
+	/**
+	* Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+	* the user, dates in the timezone of the account), streamed without a Content-Type.
+	*
+	* The query must include `contact` with its `service` (the History screen also includes
+	* `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+	* and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+	* is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+	* (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+	* batch, so its rows are repeated or the CSV comes with the header only.
+	*/
+	exportHistory(query, headers) {
+		return this.client.post(`${this.basePath}/export-history${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion

package/dist/apis/tickets/TicketsApi.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"TicketsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n} from './types'\n\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<unknown> {\n    return this.client.put<unknown, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;AASA,IAAa,aAAb,cAAgCA,qCAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;;;;;;;;CAW3B,UAAU,SAAkC,SAAoD;AAC9F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD"}
+{"version":3,"file":"TicketsApi.cjs","names":["BaseCrudApi"],"sources":["../../../src/apis/tickets/TicketsApi.ts"],"sourcesContent":["import type { ApiClient } from '../../core/ApiClient'\nimport { BaseCrudApi } from '../../core/BaseCrudApi'\nimport type {\n  Ticket,\n  CreateTicketPayload,\n  UpdateTicketPayload,\n  CloseManyTicketsPayload,\n  TicketsCount,\n  TicketsCountManyQuery,\n  TicketsCountPostPayload,\n  TicketsCounts,\n  TicketsListQuery,\n} from './types'\n\n/**\n * Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,\n * the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by\n * `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the\n * `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`\n * of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the\n * tickets of the contacts of the connections restricted to that user; the counts and `getById`\n * do not.\n */\nexport class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {\n  constructor(client: ApiClient) {\n    super(client, '/tickets')\n  }\n\n  /** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */\n  override create(body: CreateTicketPayload, headers?: Record<string, string>): Promise<Ticket> {\n    return super.create(body, headers)\n  }\n\n  /** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */\n  override updateById(\n    id: string,\n    body: UpdateTicketPayload,\n    headers?: Record<string, string>,\n  ): Promise<Ticket> {\n    return super.updateById(id, body, headers)\n  }\n\n  /** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */\n  override deleteById(id: string, headers?: Record<string, string>): Promise<Ticket> {\n    return super.deleteById(id, headers)\n  }\n\n  /**\n   * Closes multiple tickets in a single request. This is the only ticket-close\n   * endpoint exposed by the API — there is no per-ticket close/update route.\n   *\n   * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`\n   * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty\n   * `where` closes every open ticket of the account. The answer has no body. Ids of closed,\n   * unknown or other accounts' tickets are skipped in silence; no id and no\n   * `allContactsSelected` answers 400 `ids not found`.\n   * @permissions tickets.close.all OR tickets.close.me\n   */\n  closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<void> {\n    return this.client.put<void, CloseManyTicketsPayload>(\n      `${this.basePath}/close-many`,\n      payload,\n      headers,\n    )\n  }\n\n  /**\n   * Counts the tickets matching the query. With `queries`, answers one count per query, in the\n   * same order (the root filters are then ignored).\n   */\n  count(query: TicketsCountManyQuery, headers?: Record<string, string>): Promise<TicketsCounts>\n  count(query?: TicketsListQuery, headers?: Record<string, string>): Promise<TicketsCount>\n  count(\n    query?: TicketsListQuery | TicketsCountManyQuery,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.get<TicketsCount | TicketsCounts>(\n      `${this.basePath}/count${this.toQueryString(query)}`,\n      headers,\n    )\n  }\n\n  /**\n   * POST variant of `count`, for queries too long for the URL. See {@link TicketsCountPostPayload}:\n   * `query` is required.\n   */\n  countPost(\n    body: TicketsCountPostPayload & { query: { queries: TicketsListQuery[] } },\n    headers?: Record<string, string>,\n  ): Promise<TicketsCounts>\n  countPost(body: TicketsCountPostPayload, headers?: Record<string, string>): Promise<TicketsCount>\n  countPost(\n    body: TicketsCountPostPayload,\n    headers?: Record<string, string>,\n  ): Promise<TicketsCount | TicketsCounts> {\n    return this.client.post<TicketsCount | TicketsCounts, TicketsCountPostPayload>(\n      `${this.basePath}/count`,\n      body,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */\n  countOpenByService(serviceId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open/${serviceId}`, headers)\n  }\n\n  /** Counts the open tickets of a department. An unknown id counts 0. */\n  countOpenByDepartment(departmentId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(\n      `${this.basePath}/count-open-by-department/${departmentId}`,\n      headers,\n    )\n  }\n\n  /** Counts the open tickets assigned to a user. An unknown id counts 0. */\n  countOpenByUser(userId: string, headers?: Record<string, string>): Promise<number> {\n    return this.client.get<number>(`${this.basePath}/count-open-by-user/${userId}`, headers)\n  }\n\n  /**\n   * The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while\n   * it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read\n   * `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.\n   */\n  getFirstWaitingTime(id: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.get<string>(`${this.basePath}/${id}/first-waiting-time`, headers)\n  }\n\n  /**\n   * Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,\n   * summary, dates and the messages without the internal comments), sent as the attachment\n   * `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty\n   * (`undefined`); an unknown protocol never answers.\n   */\n  exportTxt(protocol: string, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string, { protocol: string }>(\n      `${this.basePath}/export`,\n      { protocol },\n      headers,\n    )\n  }\n\n  /**\n   * Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of\n   * the user, dates in the timezone of the account), streamed without a Content-Type.\n   *\n   * The query must include `contact` with its `service` (the History screen also includes\n   * `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),\n   * and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header\n   * is sent, the answer never ends. Leave `page` out: the route pages through every match itself\n   * (`perPage` only sets the size of each batch), and a `page` in the query is read on every\n   * batch, so its rows are repeated or the CSV comes with the header only.\n   */\n  exportHistory(query: TicketsListQuery, headers?: Record<string, string>): Promise<string> {\n    return this.client.post<string>(\n      `${this.basePath}/export-history${this.toQueryString(query)}`,\n      undefined,\n      headers,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAuBA,IAAa,aAAb,cAAgCA,qCAA8D;CAC5F,YAAY,QAAmB;AAC7B,QAAM,QAAQ,WAAW;;;CAI3B,AAAS,OAAO,MAA2B,SAAmD;AAC5F,SAAO,MAAM,OAAO,MAAM,QAAQ;;;CAIpC,AAAS,WACP,IACA,MACA,SACiB;AACjB,SAAO,MAAM,WAAW,IAAI,MAAM,QAAQ;;;CAI5C,AAAS,WAAW,IAAY,SAAmD;AACjF,SAAO,MAAM,WAAW,IAAI,QAAQ;;;;;;;;;;;;;CActC,UAAU,SAAkC,SAAiD;AAC3F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,cACjB,SACA,QACD;;CASH,MACE,OACA,SACuC;AACvC,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,QAAQ,KAAK,cAAc,MAAM,IAClD,QACD;;CAYH,UACE,MACA,SACuC;AACvC,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,SACjB,MACA,QACD;;;CAIH,mBAAmB,WAAmB,SAAmD;AACvF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,cAAc,aAAa,QAAQ;;;CAIrF,sBAAsB,cAAsB,SAAmD;AAC7F,SAAO,KAAK,OAAO,IACjB,GAAG,KAAK,SAAS,4BAA4B,gBAC7C,QACD;;;CAIH,gBAAgB,QAAgB,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,sBAAsB,UAAU,QAAQ;;;;;;;CAQ1F,oBAAoB,IAAY,SAAmD;AACjF,SAAO,KAAK,OAAO,IAAY,GAAG,KAAK,SAAS,GAAG,GAAG,sBAAsB,QAAQ;;;;;;;;CAStF,UAAU,UAAkB,SAAmD;AAC7E,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,UACjB,EAAE,UAAU,EACZ,QACD;;;;;;;;;;;;;CAcH,cAAc,OAAyB,SAAmD;AACxF,SAAO,KAAK,OAAO,KACjB,GAAG,KAAK,SAAS,iBAAiB,KAAK,cAAc,MAAM,IAC3D,QACA,QACD"}

package/dist/apis/tickets/TicketsApi.d.ts

@@ -1,16 +1,81 @@
 import type { ApiClient } from '../../core/ApiClient';
 import { BaseCrudApi } from '../../core/BaseCrudApi';
-import type { Ticket, CreateTicketPayload, UpdateTicketPayload, CloseManyTicketsPayload } from './types';
+import type { Ticket, CreateTicketPayload, UpdateTicketPayload, CloseManyTicketsPayload, TicketsCount, TicketsCountManyQuery, TicketsCountPostPayload, TicketsCounts, TicketsListQuery } from './types';
+/**
+ * Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+ * the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+ * `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+ * `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+ * of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+ * tickets of the contacts of the connections restricted to that user; the counts and `getById`
+ * do not.
+ */
 export declare class TicketsApi extends BaseCrudApi<Ticket, CreateTicketPayload, UpdateTicketPayload> {
     constructor(client: ApiClient);
+    /** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+    create(body: CreateTicketPayload, headers?: Record<string, string>): Promise<Ticket>;
+    /** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+    updateById(id: string, body: UpdateTicketPayload, headers?: Record<string, string>): Promise<Ticket>;
+    /** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+    deleteById(id: string, headers?: Record<string, string>): Promise<Ticket>;
     /**
      * Closes multiple tickets in a single request. This is the only ticket-close
      * endpoint exposed by the API — there is no per-ticket close/update route.
      *
      * Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-     * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+     * to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+     * `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+     * unknown or other accounts' tickets are skipped in silence; no id and no
+     * `allContactsSelected` answers 400 `ids not found`.
      * @permissions tickets.close.all OR tickets.close.me
      */
-    closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<unknown>;
+    closeMany(payload: CloseManyTicketsPayload, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Counts the tickets matching the query. With `queries`, answers one count per query, in the
+     * same order (the root filters are then ignored).
+     */
+    count(query: TicketsCountManyQuery, headers?: Record<string, string>): Promise<TicketsCounts>;
+    count(query?: TicketsListQuery, headers?: Record<string, string>): Promise<TicketsCount>;
+    /**
+     * POST variant of `count`, for queries too long for the URL. See {@link TicketsCountPostPayload}:
+     * `query` is required.
+     */
+    countPost(body: TicketsCountPostPayload & {
+        query: {
+            queries: TicketsListQuery[];
+        };
+    }, headers?: Record<string, string>): Promise<TicketsCounts>;
+    countPost(body: TicketsCountPostPayload, headers?: Record<string, string>): Promise<TicketsCount>;
+    /** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+    countOpenByService(serviceId: string, headers?: Record<string, string>): Promise<number>;
+    /** Counts the open tickets of a department. An unknown id counts 0. */
+    countOpenByDepartment(departmentId: string, headers?: Record<string, string>): Promise<number>;
+    /** Counts the open tickets assigned to a user. An unknown id counts 0. */
+    countOpenByUser(userId: string, headers?: Record<string, string>): Promise<number>;
+    /**
+     * The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+     * it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+     * `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+     */
+    getFirstWaitingTime(id: string, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+     * summary, dates and the messages without the internal comments), sent as the attachment
+     * `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+     * (`undefined`); an unknown protocol never answers.
+     */
+    exportTxt(protocol: string, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+     * the user, dates in the timezone of the account), streamed without a Content-Type.
+     *
+     * The query must include `contact` with its `service` (the History screen also includes
+     * `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+     * and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+     * is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+     * (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+     * batch, so its rows are repeated or the CSV comes with the header only.
+     */
+    exportHistory(query: TicketsListQuery, headers?: Record<string, string>): Promise<string>;
 }
 //# sourceMappingURL=TicketsApi.d.ts.map

package/dist/apis/tickets/TicketsApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TicketsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/TicketsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAEhB,qBAAa,UAAW,SAAQ,WAAW,CAAC,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;gBAC/E,MAAM,EAAE,SAAS;IAI7B;;;;;;;OAOG;IACH,SAAS,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAOhG"}
+{"version":3,"file":"TicketsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/tickets/TicketsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EACV,MAAM,EACN,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,WAAW,CAAC,MAAM,EAAE,mBAAmB,EAAE,mBAAmB,CAAC;gBAC/E,MAAM,EAAE,SAAS;IAI7B,kIAAkI;IACzH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7F,4JAA4J;IACnJ,UAAU,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAIlB,qFAAqF;IAC5E,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;;;;;;;OAUG;IACH,SAAS,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5F;;;OAGG;IACH,KAAK,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAC7F,KAAK,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAWxF;;;OAGG;IACH,SAAS,CACP,IAAI,EAAE,uBAAuB,GAAG;QAAE,KAAK,EAAE;YAAE,OAAO,EAAE,gBAAgB,EAAE,CAAA;SAAE,CAAA;KAAE,EAC1E,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,aAAa,CAAC;IACzB,SAAS,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC;IAYjG,uFAAuF;IACvF,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxF,uEAAuE;IACvE,qBAAqB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAO9F,0EAA0E;IAC1E,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ9E;;;;;;;;;;OAUG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;CAO1F"}

package/dist/apis/tickets/TicketsApi.mjs

@@ -1,21 +1,94 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 
 //#region src/apis/tickets/TicketsApi.ts
+/**
+* Tickets. The backend only serves them for reading (`getMany`, `getOne`, `getById`, the counts,
+* the first waiting time and the exports) plus `closeMany`: a ticket is opened and transferred by
+* `ContactsApi.transferTicket`. The reads check no permission (any authenticated user): the
+* `@permissions` of the inherited `getMany`, `getOne` and `getById` do not apply here. `getById`
+* of an unknown id resolves `null`. For a user who is not an admin, `getMany` leaves out the
+* tickets of the contacts of the connections restricted to that user; the counts and `getById`
+* do not.
+*/
 var TicketsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/tickets");
 	}
+	/** @deprecated Not served: `POST /tickets` answers 404 `Route not found.`. Open a ticket through `ContactsApi.transferTicket`. */
+	create(body, headers) {
+		return super.create(body, headers);
+	}
+	/** @deprecated Not served: `PUT /tickets/{id}` answers 404 `Route not found.`. Transfer through `ContactsApi.transferTicket`, close through `closeMany`. */
+	updateById(id, body, headers) {
+		return super.updateById(id, body, headers);
+	}
+	/** @deprecated Not served: `DELETE /tickets/{id}` answers 404 `Route not found.`. */
+	deleteById(id, headers) {
+		return super.deleteById(id, headers);
+	}
 	/**
 	* Closes multiple tickets in a single request. This is the only ticket-close
 	* endpoint exposed by the API — there is no per-ticket close/update route.
 	*
 	* Pass `{ ids }` to close specific tickets, or `{ allContactsSelected: true, query }`
-	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`).
+	* to close every OPEN ticket matching `query` (the backend forces `isOpen: true`): an empty
+	* `where` closes every open ticket of the account. The answer has no body. Ids of closed,
+	* unknown or other accounts' tickets are skipped in silence; no id and no
+	* `allContactsSelected` answers 400 `ids not found`.
 	* @permissions tickets.close.all OR tickets.close.me
 	*/
 	closeMany(payload, headers) {
 		return this.client.put(`${this.basePath}/close-many`, payload, headers);
 	}
+	count(query, headers) {
+		return this.client.get(`${this.basePath}/count${this.toQueryString(query)}`, headers);
+	}
+	countPost(body, headers) {
+		return this.client.post(`${this.basePath}/count`, body, headers);
+	}
+	/** Counts the open tickets of the contacts of a connection. An unknown id counts 0. */
+	countOpenByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-open/${serviceId}`, headers);
+	}
+	/** Counts the open tickets of a department. An unknown id counts 0. */
+	countOpenByDepartment(departmentId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-department/${departmentId}`, headers);
+	}
+	/** Counts the open tickets assigned to a user. An unknown id counts 0. */
+	countOpenByUser(userId, headers) {
+		return this.client.get(`${this.basePath}/count-open-by-user/${userId}`, headers);
+	}
+	/**
+	* The first waiting time of the ticket (`metrics.waitingTime`) as `HH:mm:ss`; `'00:00:00'` while
+	* it was not measured. The hours wrap every 24 h (a wait of 25 h answers `'01:00:00'`): read
+	* `metrics.waitingTime` (seconds) for the full value. An unknown id answers 500.
+	*/
+	getFirstWaitingTime(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/first-waiting-time`, headers);
+	}
+	/**
+	* Exports the conversation of a ticket as text, by its protocol (contact, attendants, subjects,
+	* summary, dates and the messages without the internal comments), sent as the attachment
+	* `<protocol>.txt` (Content-Type `plain/text`). Without a protocol the body is empty
+	* (`undefined`); an unknown protocol never answers.
+	*/
+	exportTxt(protocol, headers) {
+		return this.client.post(`${this.basePath}/export`, { protocol }, headers);
+	}
+	/**
+	* Exports the tickets matching the query as CSV (`;`, a header of 20 columns in the language of
+	* the user, dates in the timezone of the account), streamed without a Content-Type.
+	*
+	* The query must include `contact` with its `service` (the History screen also includes
+	* `contact.tags`, `contact.person`, `user`, `department`, `ticketTopics` and `firstMessage`),
+	* and `order` must name unambiguous columns (e.g. `startedAt`): when a row fails after the header
+	* is sent, the answer never ends. Leave `page` out: the route pages through every match itself
+	* (`perPage` only sets the size of each batch), and a `page` in the query is read on every
+	* batch, so its rows are repeated or the CSV comes with the header only.
+	*/
+	exportHistory(query, headers) {
+		return this.client.post(`${this.basePath}/export-history${this.toQueryString(query)}`, void 0, headers);
+	}
 };
 
 //#endregion