@ikatec/digisac-api-sdk 4.11.0 → 4.12.0

package/src/apis/whatsappBusinessTemplates/WhatsappBusinessTemplatesApi.ts

@@ -1,17 +1,91 @@
 import type { ApiClient } from '../../core/ApiClient'
+import type { ListQuery } from '../../core/types'
 import { BaseCrudApi } from '../../core/BaseCrudApi'
 import type {
   WhatsappBusinessTemplate,
   CreateWhatsappBusinessTemplatePayload,
   UpdateWhatsappBusinessTemplatePayload,
+  WhatsappBusinessTemplateHsmLimit,
 } from './types'
 
+/**
+ * WhatsApp Business templates. Create, update, reads and count are local; `sendToReview`, `refreshTemplates`,
+ * `resume` and the delete of a template of a `whatsapp-business` connection call the provider (Meta, 360Dialog).
+ * `getById` answers `null` for an unknown id.
+ */
 export class WhatsappBusinessTemplatesApi extends BaseCrudApi<
   WhatsappBusinessTemplate,
   CreateWhatsappBusinessTemplatePayload,
-  UpdateWhatsappBusinessTemplatePayload
+  UpdateWhatsappBusinessTemplatePayload,
+  ListQuery<WhatsappBusinessTemplate>,
+  unknown
 > {
   constructor(client: ApiClient) {
     super(client, '/whatsapp-business-templates')
   }
+
+  /**
+   * Counts the templates matching the query.
+   * @permissions hsm.view
+   */
+  count(
+    query?: ListQuery<WhatsappBusinessTemplate>,
+    headers?: Record<string, string>,
+  ): Promise<{ count: number }> {
+    return this.client.get<{ count: number }>(
+      `${this.basePath}/count${this.toQueryString(query)}`,
+      headers,
+    )
+  }
+
+  /**
+   * Reads the template limit of the plan of the account. Send the `accountId` of the current user: the route is
+   * outside the error handler of the backend, so an unknown id gets no answer (the request waits for the timeout).
+   * @permissions hsm.view
+   */
+  getHsmLimit(
+    accountId: string,
+    headers?: Record<string, string>,
+  ): Promise<WhatsappBusinessTemplateHsmLimit> {
+    return this.client.get<WhatsappBusinessTemplateHsmLimit>(
+      `${this.basePath}/${accountId}/hsmLimit`,
+      headers,
+    )
+  }
+
+  /**
+   * Deletes a template. On a `whatsapp-business` connection it goes to the provider (and answers what it answers);
+   * a draft of another connection type is deleted locally (answers the stored template). An unknown id answers 500.
+   * @permissions hsm.view OR hsm.destroy
+   */
+  override deleteById(id: string, headers?: Record<string, string>): Promise<unknown> {
+    return super.deleteById(id, headers)
+  }
+
+  /**
+   * SENDS the template to Meta for approval (through the provider of the connection). An unknown or archived
+   * template answers 500 before anything is sent.
+   * @permissions hsm.view OR hsm.send OR hsm.send.before.expire
+   */
+  sendToReview(id: string, headers?: Record<string, string>): Promise<unknown> {
+    return this.client.post<unknown>(`${this.basePath}/${id}/send-to-review`, undefined, headers)
+  }
+
+  /**
+   * Reads the templates of the connected `whatsapp-business` connections from the provider and syncs them (it may
+   * archive the local templates the provider no longer has). Resolves the text `'OK'`.
+   * @permissions hsm.view
+   */
+  refreshTemplates(headers?: Record<string, string>): Promise<'OK'> {
+    return this.client.post<'OK'>(`${this.basePath}/refresh-templates`, undefined, headers)
+  }
+
+  /**
+   * Reads the template balance from 360Dialog. The backend looks for the 360Dialog connection on the whole platform,
+   * not only in the account, and calls 360Dialog when it finds one.
+   * @permissions hsm.view
+   */
+  resume(headers?: Record<string, string>): Promise<Record<string, unknown>[]> {
+    return this.client.get<Record<string, unknown>[]>(`${this.basePath}/resume`, headers)
+  }
 }

package/src/apis/whatsappBusinessTemplates/types.ts

@@ -10,7 +10,8 @@ export type WhatsappBusinessTemplateHeaderFormat = 'TEXT' | 'IMAGE' | 'VIDEO' |
 
 export type WhatsappBusinessTemplateButton = {
   type: string
-  text: string
+  /** Overwritten by the backend on `REQUEST_CONTACT_INFO` buttons. */
+  text?: string
   url?: string
   params?: string[]
   phone_number?: string
@@ -44,11 +45,40 @@ export type WhatsappBusinessTemplate = {
   createdAt: string
   updatedAt: string
   deletedAt: string | null
+  /** Only the listing includes it by default; `getById` answers it with `include: ['fileExample']`. */
+  fileExample?: WhatsappBusinessTemplateFileExample | null
+  // relationships
+  service?: Record<string, unknown>
+  account?: Record<string, unknown>
+}
+
+/** The media example of a template with a media header. */
+export type WhatsappBusinessTemplateFileExample = Record<string, unknown>
+
+/** The media example sent on create/update (`base64Url` as a data URL). */
+export type WhatsappBusinessTemplateFileExampleInput = {
+  fileName: string
+  base64Url: string
+  mimetype: string
 }
 
+export type WhatsappBusinessTemplateHsmLimit = {
+  hsmLimit: number
+  hsmUsedLimit: number
+  /** The balance left (a number), or `true` when the account has no limit. */
+  hasLimit: number | boolean
+}
+
+/**
+ * Stored locally (nothing goes to Meta until `sendToReview`). `status` is `''` for a draft and `namespace` is `''`
+ * until Meta answers — both are required by the database (500 without them).
+ */
 export type CreateWhatsappBusinessTemplatePayload = {
   name: string
   internalName: string
+  status: string
+  namespace: string
+  fileExample?: WhatsappBusinessTemplateFileExampleInput
   components: WhatsappBusinessTemplateComponent[]
   serviceId: string
   messageType: WhatsappBusinessTemplateMessageType
@@ -56,7 +86,14 @@ export type CreateWhatsappBusinessTemplatePayload = {
   category: WhatsappBusinessTemplateCategory
 }
 
+/**
+ * The backend validates the same 7 fields of the create on the update (`name`, `internalName`, `components`,
+ * `serviceId`, `messageType`, `language`, `category`), but ignores `name`.
+ */
 export type UpdateWhatsappBusinessTemplatePayload = {
+  status?: string
+  namespace?: string
+  fileExample?: WhatsappBusinessTemplateFileExampleInput
   name?: string
   internalName?: string
   components?: WhatsappBusinessTemplateComponent[]