@ikatec/digisac-api-sdk 4.11.0 → 4.13.0

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[]