@ikatec/digisac-api-sdk 4.7.0 → 4.8.0

package/dist/apis/campaigns/CampaignsApi.cjs

@@ -1,66 +1,133 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_chunk = require('../../_chunks/chunk-Dk0Otj32.cjs');
 const require_core_BaseCrudApi = require('../../core/BaseCrudApi.cjs');
 require('../../core/index.cjs');
+let qs = require("qs");
+qs = require_chunk.__toESM(qs);
 
 //#region src/apis/campaigns/CampaignsApi.ts
+/**
+* Campaigns (mass sending). Every `/campaigns` route requires the campaigns feature in the plan of
+* the account.
+* `getMany` takes the `where` of a `ListQuery` and the flat filters of the Campaigns screen (see
+* {@link CampaignListQuery}); `getById` of an unknown id resolves `null`. `deleteById` answers the
+* text `'OK'`. `getMany({ paginate: false })` answers 400 `FILTER_PARAM_INVALID` with the default
+* `'json'` query format (the route only takes `paginate` as a string): use `withQueryFormat('qs')`.
+*/
 var CampaignsApi = class extends require_core_BaseCrudApi.BaseCrudApi {
 	constructor(client) {
 		super(client, "/campaigns");
-		this.sendById = this.sendById.bind(this);
-		this.pauseById = this.pauseById.bind(this);
-		this.resumeById = this.resumeById.bind(this);
-		this.duplicateById = this.duplicateById.bind(this);
-		this.getStatsById = this.getStatsById.bind(this);
-		this.setIntervalById = this.setIntervalById.bind(this);
-		this.getContactCount = this.getContactCount.bind(this);
-		this.setAutoPauseMode = this.setAutoPauseMode.bind(this);
-		this.exportCampaignResult = this.exportCampaignResult.bind(this);
-		this.exportTemplateCsv = this.exportTemplateCsv.bind(this);
-		this.getHsmLimit = this.getHsmLimit.bind(this);
-	}
-	/** Starts sending messages for the given campaign. */
-	sendById(id) {
-		return this.client.post(`${this.basePath}/${id}/send`);
-	}
-	/** Pauses a campaign that is currently sending. */
-	pauseById(id) {
-		return this.client.post(`${this.basePath}/${id}/pause`);
-	}
-	/** Resumes a previously paused campaign. */
-	resumeById(id) {
-		return this.client.post(`${this.basePath}/${id}/resume`);
-	}
-	/** Creates a copy of an existing campaign. */
-	duplicateById(id) {
-		return this.client.post(`${this.basePath}/${id}/duplicate`);
-	}
-	/** Returns send/delivery/view statistics for a campaign. */
-	getStatsById(id) {
-		return this.client.get(`${this.basePath}/${id}/stats`);
-	}
-	/** Updates the min/max send interval for a campaign. */
-	setIntervalById(id, data) {
-		return this.client.post(`${this.basePath}/${id}/interval`, data);
-	}
-	/** Returns the total number of contacts targeted by a campaign. */
-	getContactCount(id) {
-		return this.client.get(`${this.basePath}/${id}/contactCount`);
-	}
-	/** Configures the auto-pause behavior for campaigns. */
-	setAutoPauseMode(data) {
-		return this.client.put(`${this.basePath}/autoPauseMode`, data);
-	}
-	/** Exports campaign send results as a CSV file. */
-	exportCampaignResult(data) {
-		return this.client.post(`${this.basePath}/export/csv`, data);
-	}
-	/** Exports a CSV template for importing contacts into an HSM campaign. */
-	exportTemplateCsv(data) {
-		return this.client.post(`${this.basePath}/exportTemplate`, data);
-	}
-	/** Returns the HSM message usage and limit for an account. */
-	getHsmLimit(accountId) {
-		return this.client.get(`/whatsapp-business-templates/${accountId}/hsmLimit`);
+	}
+	/**
+	* Starts sending the campaign: answers it as `processing` (an `import_error` campaign goes back
+	* to `importing_contacts`). It becomes `done` once every contact is fired.
+	* @permissions campaigns.view
+	*/
+	sendById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/send`, void 0, headers);
+	}
+	/**
+	* Sets the campaign as `paused` and answers `true`. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	pauseById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/pause`, void 0, headers);
+	}
+	/**
+	* Sets the campaign back to `processing` and answers `true`. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	resumeById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/resume`, void 0, headers);
+	}
+	/**
+	* Fires again the messages that failed: sets them as pending and the campaign as `processing`.
+	* Answers the text `'OK'` (also when nothing failed, and then the status does not change); an
+	* unknown id answers `false` (status 200).
+	* @permissions campaigns.view
+	*/
+	retryById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/retry`, void 0, headers);
+	}
+	/**
+	* Creates a copy of the campaign (`ready`, same title, messages and tags), answered without the
+	* messages. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	duplicateById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/duplicate`, void 0, headers);
+	}
+	/** Returns the send, delivery and interaction statistics of the campaign. */
+	getStatsById(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/stats`, headers);
+	}
+	/**
+	* Returns the events of the campaign (created, scheduled, started, finished and the last
+	* interruption), the most recent first.
+	*/
+	getTimeline(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/timeline`, headers);
+	}
+	/**
+	* Returns a page of the contacts of the campaign with their sending status (15 per page by
+	* default). An unknown id answers an empty page.
+	*/
+	getContacts(id, query, headers) {
+		return this.client.get(`${this.basePath}/${id}/contacts${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Sets the min/max interval between the sends (whole numbers, `0` or more) and answers `true`.
+	* An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	setIntervalById(id, data, headers) {
+		return this.client.post(`${this.basePath}/${id}/interval`, data, headers);
+	}
+	/** Returns the number of contacts targeted by the campaign. */
+	getContactCount(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/contactCount`, headers);
+	}
+	/** Counts the `ready` campaigns of a connection. An unknown id counts 0. */
+	countReadyByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-ready/${serviceId}`, headers);
+	}
+	/**
+	* Sets the auto-pause mode of the campaigns of the account (`settings.campaign`). Answers the
+	* text `'OK'`, or `false` when the account was not updated.
+	*/
+	setAutoPauseMode(data, headers) {
+		return this.client.put(`${this.basePath}/autoPauseMode`, data, headers);
+	}
+	/**
+	* Exports the contacts of the campaign and their sending result as CSV (13 columns in the
+	* language of the user; `,`, or `;` with `type: 'semiColon'`), streamed without a Content-Type.
+	*/
+	exportCampaignResult(data, headers) {
+		return this.client.post(`${this.basePath}/export/csv`, data, headers);
+	}
+	/** Exports the CSV (`;`) to fill in the contacts of a campaign of the given HSM template. */
+	exportTemplateCsv(data, headers) {
+		return this.client.post(`${this.basePath}/exportTemplate`, data, headers);
+	}
+	/**
+	* Exports the rows of the import file that were not imported (invalid number, unknown or
+	* ambiguous username) as CSV: line, name, number, username and reason.
+	*/
+	exportImportErrors(id, query, headers) {
+		const queryString = query?.delimiter ? `?${qs.default.stringify({ delimiter: query.delimiter })}` : "";
+		return this.client.get(`${this.basePath}/${id}/import-errors${queryString}`, headers);
+	}
+	/**
+	* Deletes the campaigns of the given ids and answers `true` (unknown ids are skipped). No id, or
+	* an id that is not a UUID, answers 400 `{ error: 'Invalid ids', code: 'INVALID_IDS' }`.
+	* @permissions campaigns.view OR campaigns.destroy
+	*/
+	deleteMany(ids, headers) {
+		return this.client.request("DELETE", `${this.basePath}/delete-many`, { ids }, headers);
+	}
+	/** Returns the HSM message usage and limit of an account. */
+	getHsmLimit(accountId, headers) {
+		return this.client.get(`/whatsapp-business-templates/${accountId}/hsmLimit`, headers);
 	}
 };
 

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

@@ -1 +1 @@
-{"version":3,"file":"CampaignsApi.cjs","names":["BaseCrudApi"],"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,cAAkCA,qCAIhC;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.cjs","names":["BaseCrudApi"],"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,cAAkCA,qCAMhC;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,WAAG,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/CampaignsApi.d.ts

@@ -1,29 +1,91 @@
 import type { ApiClient } from '../../core';
 import { BaseCrudApi } from '../../core';
-import type { AutoPauseModePayload, Campaign, CampaignStats, CreateCampaignPayload, ExportCampaignResultPayload, ExportTemplateCsvPayload, HsmLimit, SetIntervalPayload, UpdateCampaignPayload } from './types';
-export declare class CampaignsApi extends BaseCrudApi<Campaign, CreateCampaignPayload, UpdateCampaignPayload> {
+import type { AutoPauseModePayload, Campaign, CampaignContactsPage, CampaignContactsQuery, CampaignListQuery, CampaignStats, CampaignTimelineEvent, CreateCampaignPayload, ExportCampaignImportErrorsQuery, ExportCampaignResultPayload, ExportTemplateCsvPayload, HsmLimit, SetIntervalPayload, UpdateCampaignPayload } from './types';
+/**
+ * Campaigns (mass sending). Every `/campaigns` route requires the campaigns feature in the plan of
+ * the account.
+ * `getMany` takes the `where` of a `ListQuery` and the flat filters of the Campaigns screen (see
+ * {@link CampaignListQuery}); `getById` of an unknown id resolves `null`. `deleteById` answers the
+ * text `'OK'`. `getMany({ paginate: false })` answers 400 `FILTER_PARAM_INVALID` with the default
+ * `'json'` query format (the route only takes `paginate` as a string): use `withQueryFormat('qs')`.
+ */
+export declare class CampaignsApi extends BaseCrudApi<Campaign, CreateCampaignPayload, UpdateCampaignPayload, CampaignListQuery, 'OK'> {
     constructor(client: ApiClient);
-    /** Starts sending messages for the given campaign. */
-    sendById(id: string): Promise<Campaign>;
-    /** Pauses a campaign that is currently sending. */
-    pauseById(id: string): Promise<Campaign>;
-    /** Resumes a previously paused campaign. */
-    resumeById(id: string): Promise<Campaign>;
-    /** Creates a copy of an existing campaign. */
-    duplicateById(id: string): Promise<Campaign>;
-    /** Returns send/delivery/view statistics for a campaign. */
-    getStatsById(id: string): Promise<CampaignStats>;
-    /** Updates the min/max send interval for a campaign. */
-    setIntervalById(id: string, data: SetIntervalPayload): Promise<Campaign>;
-    /** Returns the total number of contacts targeted by a campaign. */
-    getContactCount(id: string): Promise<number>;
-    /** Configures the auto-pause behavior for campaigns. */
-    setAutoPauseMode(data: AutoPauseModePayload): Promise<unknown>;
-    /** Exports campaign send results as a CSV file. */
-    exportCampaignResult(data: ExportCampaignResultPayload): Promise<unknown>;
-    /** Exports a CSV template for importing contacts into an HSM campaign. */
-    exportTemplateCsv(data: ExportTemplateCsvPayload): Promise<unknown>;
-    /** Returns the HSM message usage and limit for an account. */
-    getHsmLimit(accountId: string): Promise<HsmLimit>;
+    /**
+     * Starts sending the campaign: answers it as `processing` (an `import_error` campaign goes back
+     * to `importing_contacts`). It becomes `done` once every contact is fired.
+     * @permissions campaigns.view
+     */
+    sendById(id: string, headers?: Record<string, string>): Promise<Campaign>;
+    /**
+     * Sets the campaign as `paused` and answers `true`. An unknown id answers 500.
+     * @permissions campaigns.view
+     */
+    pauseById(id: string, headers?: Record<string, string>): Promise<boolean>;
+    /**
+     * Sets the campaign back to `processing` and answers `true`. An unknown id answers 500.
+     * @permissions campaigns.view
+     */
+    resumeById(id: string, headers?: Record<string, string>): Promise<boolean>;
+    /**
+     * Fires again the messages that failed: sets them as pending and the campaign as `processing`.
+     * Answers the text `'OK'` (also when nothing failed, and then the status does not change); an
+     * unknown id answers `false` (status 200).
+     * @permissions campaigns.view
+     */
+    retryById(id: string, headers?: Record<string, string>): Promise<'OK' | false>;
+    /**
+     * Creates a copy of the campaign (`ready`, same title, messages and tags), answered without the
+     * messages. An unknown id answers 500.
+     * @permissions campaigns.view
+     */
+    duplicateById(id: string, headers?: Record<string, string>): Promise<Campaign>;
+    /** Returns the send, delivery and interaction statistics of the campaign. */
+    getStatsById(id: string, headers?: Record<string, string>): Promise<CampaignStats>;
+    /**
+     * Returns the events of the campaign (created, scheduled, started, finished and the last
+     * interruption), the most recent first.
+     */
+    getTimeline(id: string, headers?: Record<string, string>): Promise<CampaignTimelineEvent[]>;
+    /**
+     * Returns a page of the contacts of the campaign with their sending status (15 per page by
+     * default). An unknown id answers an empty page.
+     */
+    getContacts(id: string, query?: CampaignContactsQuery, headers?: Record<string, string>): Promise<CampaignContactsPage>;
+    /**
+     * Sets the min/max interval between the sends (whole numbers, `0` or more) and answers `true`.
+     * An unknown id answers 500.
+     * @permissions campaigns.view
+     */
+    setIntervalById(id: string, data: SetIntervalPayload, headers?: Record<string, string>): Promise<boolean>;
+    /** Returns the number of contacts targeted by the campaign. */
+    getContactCount(id: string, headers?: Record<string, string>): Promise<number>;
+    /** Counts the `ready` campaigns of a connection. An unknown id counts 0. */
+    countReadyByService(serviceId: string, headers?: Record<string, string>): Promise<number>;
+    /**
+     * Sets the auto-pause mode of the campaigns of the account (`settings.campaign`). Answers the
+     * text `'OK'`, or `false` when the account was not updated.
+     */
+    setAutoPauseMode(data: AutoPauseModePayload, headers?: Record<string, string>): Promise<'OK' | false>;
+    /**
+     * Exports the contacts of the campaign and their sending result as CSV (13 columns in the
+     * language of the user; `,`, or `;` with `type: 'semiColon'`), streamed without a Content-Type.
+     */
+    exportCampaignResult(data: ExportCampaignResultPayload, headers?: Record<string, string>): Promise<string>;
+    /** Exports the CSV (`;`) to fill in the contacts of a campaign of the given HSM template. */
+    exportTemplateCsv(data: ExportTemplateCsvPayload, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Exports the rows of the import file that were not imported (invalid number, unknown or
+     * ambiguous username) as CSV: line, name, number, username and reason.
+     */
+    exportImportErrors(id: string, query?: ExportCampaignImportErrorsQuery, headers?: Record<string, string>): Promise<string>;
+    /**
+     * Deletes the campaigns of the given ids and answers `true` (unknown ids are skipped). No id, or
+     * an id that is not a UUID, answers 400 `{ error: 'Invalid ids', code: 'INVALID_IDS' }`.
+     * @permissions campaigns.view OR campaigns.destroy
+     */
+    deleteMany(ids: string[], headers?: Record<string, string>): Promise<true>;
+    /** Returns the HSM message usage and limit of an account. */
+    getHsmLimit(accountId: string, headers?: Record<string, string>): Promise<HsmLimit>;
 }
 //# sourceMappingURL=CampaignsApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CampaignsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/CampaignsApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EACV,oBAAoB,EACpB,QAAQ,EACR,aAAa,EACb,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EACxB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB,qBAAa,YAAa,SAAQ,WAAW,CAC3C,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,CACtB;gBACa,MAAM,EAAE,SAAS;IAgB7B,sDAAsD;IACtD,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvC,mDAAmD;IACnD,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIxC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIzC,8CAA8C;IAC9C,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5C,4DAA4D;IAC5D,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIhD,wDAAwD;IACxD,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIxE,mEAAmE;IACnE,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI5C,wDAAwD;IACxD,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9D,mDAAmD;IACnD,oBAAoB,CAAC,IAAI,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzE,0EAA0E;IAC1E,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC;IAInE,8DAA8D;IAC9D,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAGlD"}
+{"version":3,"file":"CampaignsApi.d.ts","sourceRoot":"","sources":["../../../src/apis/campaigns/CampaignsApi.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,EACV,oBAAoB,EACpB,QAAQ,EACR,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,aAAa,EACb,qBAAqB,EACrB,qBAAqB,EACrB,+BAA+B,EAC/B,2BAA2B,EAC3B,wBAAwB,EACxB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAEhB;;;;;;;GAOG;AACH,qBAAa,YAAa,SAAQ,WAAW,CAC3C,QAAQ,EACR,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,IAAI,CACL;gBACa,MAAM,EAAE,SAAS;IAI7B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIzE;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzE;;;OAGG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAI1E;;;;;OAKG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;IAI9E;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI9E,6EAA6E;IAC7E,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IAIlF;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAI3F;;;OAGG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,oBAAoB,CAAC;IAOhC;;;;OAIG;IACH,eAAe,CACb,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,OAAO,CAAC;IAQnB,+DAA+D;IAC/D,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9E,4EAA4E;IAC5E,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIzF;;;OAGG;IACH,gBAAgB,CACd,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;IAQxB;;;OAGG;IACH,oBAAoB,CAClB,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAQlB,6FAA6F;IAC7F,iBAAiB,CACf,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAQlB;;;OAGG;IACH,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/B,OAAO,CAAC,MAAM,CAAC;IAKlB;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E,6DAA6D;IAC7D,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;CAGpF"}

package/dist/apis/campaigns/CampaignsApi.mjs

@@ -1,65 +1,130 @@
 import { BaseCrudApi } from "../../core/BaseCrudApi.mjs";
 import "../../core/index.mjs";
+import qs from "qs";
 
 //#region src/apis/campaigns/CampaignsApi.ts
+/**
+* Campaigns (mass sending). Every `/campaigns` route requires the campaigns feature in the plan of
+* the account.
+* `getMany` takes the `where` of a `ListQuery` and the flat filters of the Campaigns screen (see
+* {@link CampaignListQuery}); `getById` of an unknown id resolves `null`. `deleteById` answers the
+* text `'OK'`. `getMany({ paginate: false })` answers 400 `FILTER_PARAM_INVALID` with the default
+* `'json'` query format (the route only takes `paginate` as a string): use `withQueryFormat('qs')`.
+*/
 var CampaignsApi = class extends BaseCrudApi {
 	constructor(client) {
 		super(client, "/campaigns");
-		this.sendById = this.sendById.bind(this);
-		this.pauseById = this.pauseById.bind(this);
-		this.resumeById = this.resumeById.bind(this);
-		this.duplicateById = this.duplicateById.bind(this);
-		this.getStatsById = this.getStatsById.bind(this);
-		this.setIntervalById = this.setIntervalById.bind(this);
-		this.getContactCount = this.getContactCount.bind(this);
-		this.setAutoPauseMode = this.setAutoPauseMode.bind(this);
-		this.exportCampaignResult = this.exportCampaignResult.bind(this);
-		this.exportTemplateCsv = this.exportTemplateCsv.bind(this);
-		this.getHsmLimit = this.getHsmLimit.bind(this);
-	}
-	/** Starts sending messages for the given campaign. */
-	sendById(id) {
-		return this.client.post(`${this.basePath}/${id}/send`);
-	}
-	/** Pauses a campaign that is currently sending. */
-	pauseById(id) {
-		return this.client.post(`${this.basePath}/${id}/pause`);
-	}
-	/** Resumes a previously paused campaign. */
-	resumeById(id) {
-		return this.client.post(`${this.basePath}/${id}/resume`);
-	}
-	/** Creates a copy of an existing campaign. */
-	duplicateById(id) {
-		return this.client.post(`${this.basePath}/${id}/duplicate`);
-	}
-	/** Returns send/delivery/view statistics for a campaign. */
-	getStatsById(id) {
-		return this.client.get(`${this.basePath}/${id}/stats`);
-	}
-	/** Updates the min/max send interval for a campaign. */
-	setIntervalById(id, data) {
-		return this.client.post(`${this.basePath}/${id}/interval`, data);
-	}
-	/** Returns the total number of contacts targeted by a campaign. */
-	getContactCount(id) {
-		return this.client.get(`${this.basePath}/${id}/contactCount`);
-	}
-	/** Configures the auto-pause behavior for campaigns. */
-	setAutoPauseMode(data) {
-		return this.client.put(`${this.basePath}/autoPauseMode`, data);
-	}
-	/** Exports campaign send results as a CSV file. */
-	exportCampaignResult(data) {
-		return this.client.post(`${this.basePath}/export/csv`, data);
-	}
-	/** Exports a CSV template for importing contacts into an HSM campaign. */
-	exportTemplateCsv(data) {
-		return this.client.post(`${this.basePath}/exportTemplate`, data);
-	}
-	/** Returns the HSM message usage and limit for an account. */
-	getHsmLimit(accountId) {
-		return this.client.get(`/whatsapp-business-templates/${accountId}/hsmLimit`);
+	}
+	/**
+	* Starts sending the campaign: answers it as `processing` (an `import_error` campaign goes back
+	* to `importing_contacts`). It becomes `done` once every contact is fired.
+	* @permissions campaigns.view
+	*/
+	sendById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/send`, void 0, headers);
+	}
+	/**
+	* Sets the campaign as `paused` and answers `true`. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	pauseById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/pause`, void 0, headers);
+	}
+	/**
+	* Sets the campaign back to `processing` and answers `true`. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	resumeById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/resume`, void 0, headers);
+	}
+	/**
+	* Fires again the messages that failed: sets them as pending and the campaign as `processing`.
+	* Answers the text `'OK'` (also when nothing failed, and then the status does not change); an
+	* unknown id answers `false` (status 200).
+	* @permissions campaigns.view
+	*/
+	retryById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/retry`, void 0, headers);
+	}
+	/**
+	* Creates a copy of the campaign (`ready`, same title, messages and tags), answered without the
+	* messages. An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	duplicateById(id, headers) {
+		return this.client.post(`${this.basePath}/${id}/duplicate`, void 0, headers);
+	}
+	/** Returns the send, delivery and interaction statistics of the campaign. */
+	getStatsById(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/stats`, headers);
+	}
+	/**
+	* Returns the events of the campaign (created, scheduled, started, finished and the last
+	* interruption), the most recent first.
+	*/
+	getTimeline(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/timeline`, headers);
+	}
+	/**
+	* Returns a page of the contacts of the campaign with their sending status (15 per page by
+	* default). An unknown id answers an empty page.
+	*/
+	getContacts(id, query, headers) {
+		return this.client.get(`${this.basePath}/${id}/contacts${this.toQueryString(query)}`, headers);
+	}
+	/**
+	* Sets the min/max interval between the sends (whole numbers, `0` or more) and answers `true`.
+	* An unknown id answers 500.
+	* @permissions campaigns.view
+	*/
+	setIntervalById(id, data, headers) {
+		return this.client.post(`${this.basePath}/${id}/interval`, data, headers);
+	}
+	/** Returns the number of contacts targeted by the campaign. */
+	getContactCount(id, headers) {
+		return this.client.get(`${this.basePath}/${id}/contactCount`, headers);
+	}
+	/** Counts the `ready` campaigns of a connection. An unknown id counts 0. */
+	countReadyByService(serviceId, headers) {
+		return this.client.get(`${this.basePath}/count-ready/${serviceId}`, headers);
+	}
+	/**
+	* Sets the auto-pause mode of the campaigns of the account (`settings.campaign`). Answers the
+	* text `'OK'`, or `false` when the account was not updated.
+	*/
+	setAutoPauseMode(data, headers) {
+		return this.client.put(`${this.basePath}/autoPauseMode`, data, headers);
+	}
+	/**
+	* Exports the contacts of the campaign and their sending result as CSV (13 columns in the
+	* language of the user; `,`, or `;` with `type: 'semiColon'`), streamed without a Content-Type.
+	*/
+	exportCampaignResult(data, headers) {
+		return this.client.post(`${this.basePath}/export/csv`, data, headers);
+	}
+	/** Exports the CSV (`;`) to fill in the contacts of a campaign of the given HSM template. */
+	exportTemplateCsv(data, headers) {
+		return this.client.post(`${this.basePath}/exportTemplate`, data, headers);
+	}
+	/**
+	* Exports the rows of the import file that were not imported (invalid number, unknown or
+	* ambiguous username) as CSV: line, name, number, username and reason.
+	*/
+	exportImportErrors(id, query, headers) {
+		const queryString = query?.delimiter ? `?${qs.stringify({ delimiter: query.delimiter })}` : "";
+		return this.client.get(`${this.basePath}/${id}/import-errors${queryString}`, headers);
+	}
+	/**
+	* Deletes the campaigns of the given ids and answers `true` (unknown ids are skipped). No id, or
+	* an id that is not a UUID, answers 400 `{ error: 'Invalid ids', code: 'INVALID_IDS' }`.
+	* @permissions campaigns.view OR campaigns.destroy
+	*/
+	deleteMany(ids, headers) {
+		return this.client.request("DELETE", `${this.basePath}/delete-many`, { ids }, headers);
+	}
+	/** Returns the HSM message usage and limit of an account. */
+	getHsmLimit(accountId, headers) {
+		return this.client.get(`/whatsapp-business-templates/${accountId}/hsmLimit`, headers);
 	}
 };
 

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"}