@ikatec/digisac-api-sdk 4.7.0 → 4.9.0

package/src/apis/services/types.ts

@@ -47,6 +47,52 @@ export type ServiceConnectionStatus = {
   timestamp?: string
 }
 
+/**
+ * `data.webchat` of a Webchat service. Every key is optional: the object only fills up once the
+ * service is set up, and older services lack the keys added later (e.g. `instagram`). The backend
+ * stores what the forms send without normalizing it, so `null` and `{}` show up where the web
+ * forms write them.
+ */
+export type WebchatServiceData = {
+  /** Widget id in the webchat API; the page link is `${webchatUrl}/${id}`. Absent before setup. */
+  id?: string
+  name?: string | null
+  /** WhatsApp channel of the widget: DDI + number, without mask. `null` once cleared. */
+  phone?: string | null
+  /** Telegram channel of the widget, without `@`. `null` once cleared. */
+  telegram?: string | null
+  /** Instagram channel of the widget, without `@`. `null` once cleared. */
+  instagram?: string | null
+  isOpenForm?: boolean
+  isOpenChat?: boolean
+  /** `{}` when no picture was picked in the legacy form. */
+  file?: { base64Url?: string; mimetype?: string; fileName?: string }
+  googleId?: string | null
+  desktopChatOpen?: boolean
+  mobileChatOpen?: boolean
+  getClientData?: boolean
+  closeTicketByClient?: boolean
+  phoneClient?: boolean
+  phoneClientRequired?: boolean
+  clientName?: boolean
+  clientNameRequired?: boolean
+  /** `null` or `{}` when no custom field is asked for. */
+  customField?: { id?: string; name?: string } | null
+  customFieldRequired?: boolean
+  custom?: {
+    webchatBalloon?: boolean
+    webchatBalloonText?: string | null
+    webchatColor?: string
+    /** File id. */
+    logo?: string
+    /** File id. */
+    profilePhoto?: string
+    /** File id. */
+    webchatIcon?: string
+    typeIcon?: string
+  }
+}
+
 export type ServiceData = {
   // ─── Common ───────────────────────────────────────────────────────────────
   token?: string
@@ -106,7 +152,7 @@ export type ServiceData = {
     mimetype: string
     fileName: string
   }
-  webchat?: Record<string, unknown>
+  webchat?: WebchatServiceData
 
   // ─── Other ────────────────────────────────────────────────────────────────
   driverId?: string