@placeshakr/config 10.20.2-alpha.0 → 10.20.2-alpha.1

package/src/whatsapp/requests.ts

@@ -0,0 +1,113 @@
+type NotifyQuoteStatusApprovedMessage = {
+  name: 'notify_quote_status_approved';
+  variables: {
+    header?: string[];
+    // 1. quoteTitle; 2. project address;
+    body: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type SendQuotePro = {
+  name: 'send_quote_pro';
+  variables: {
+    header?: string[];
+    // 1. quote name; 2. project address;
+    body: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type SendMediaRequest = {
+  name: 'send_media_request';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. project name; 3. project address;
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type SendPlanRequest = {
+  name: 'send_plan_request';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. project name; 3. project address;
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type QuoteReady = {
+  name: 'quote_ready';
+  variables: {
+    header?: string[];
+    // 1. sender name; 2. quote name; 3. project address
+    body: string[];
+    buttons: ButtonArgs[];
+  };
+};
+
+type WelcomeClient = {
+  name: 'welcome_client';
+  variables: {
+    header?: string[];
+    body?: string[];
+    buttons?: ButtonArgs[];
+  };
+};
+
+type ButtonArgs = {
+  type: 'button';
+  sub_type: 'quick_reply' | 'url';
+  index?: number;
+  parameters: { type: 'payload' | 'text'; value: string }[];
+};
+
+export type WhatsAppTemplate =
+  | NotifyQuoteStatusApprovedMessage
+  | SendQuotePro
+  | SendMediaRequest
+  | SendPlanRequest
+  | WelcomeClient
+  | QuoteReady;
+
+type TemplatePayloadArgs = {
+  type: 'template';
+  recipientPhone: string;
+  template: WhatsAppTemplate;
+};
+
+export type WhatsAppRequestPayloadType =
+  | 'audio'
+  | 'document'
+  | 'image'
+  | 'sticker'
+  | 'video'
+  | 'template'
+  | 'text';
+
+type CommonMultimediaPayload<T extends WhatsAppRequestPayloadType> = {
+  [key in T]: {
+    link: string;
+    filename: string;
+  };
+};
+
+type TextPayloadArgs = {
+  type: 'text';
+  recipientPhone: string;
+  message: string;
+};
+
+type MultimediaPayloadArgs<T extends WhatsAppRequestPayloadType> = {
+  type: T;
+  recipientPhone: string;
+} & CommonMultimediaPayload<T>;
+
+export type WABuildPayloadType<Type extends WhatsAppRequestPayloadType> =
+  Type extends 'text'
+    ? TextPayloadArgs
+    : Type extends 'template'
+    ? TemplatePayloadArgs
+    : MultimediaPayloadArgs<Type>;

package/src/whatsapp/responses.ts

@@ -0,0 +1,198 @@
+export type WhatsAppNotificationPayload = {
+  object: 'whatsapp_business_account';
+  entry: [
+    {
+      id: string;
+      changes: WhatAppNotificationValue[];
+    }
+  ];
+};
+
+export type WhatAppNotificationValue = {
+  value: {
+    contacts: WhatsAppContact[];
+    errors?: WhatsAppResponseError[];
+    messaging_product: 'whatsapp';
+    metadata: WhatsAppMetadata;
+    messages?: WhatsAppMessage[];
+    statuses?: WhatsAppStatus[];
+  };
+  field: 'messages';
+};
+
+type WhatsAppContact = {
+  wa_id: string;
+  profile: {
+    name: string;
+  };
+};
+
+type WhatsAppResponseError = {
+  code: number;
+  title: string;
+  message: string;
+  error_data: {
+    details: string;
+  };
+};
+
+type WhatsAppMetadata = {
+  display_phone_number: string;
+  phone_number_id: string;
+};
+
+export type WhatsAppMessage = {
+  audio?: {
+    id: string;
+    mime_type: string;
+  };
+  button?: {
+    payload: string;
+    text: string;
+  };
+  context?: {
+    forwarded: boolean;
+    frequently_forwarded: boolean;
+    from: string;
+    id: string;
+    referred_product: {
+      catalog_id: string;
+      product_retailer_id: string;
+    };
+  };
+  document?: {
+    caption?: string;
+    filename: string;
+    sha256: string;
+    mime_type: string;
+    id: string;
+  };
+  errors: {
+    code: number;
+    title: string;
+    message: string;
+    error_data: {
+      details: string;
+    };
+  };
+  from: string;
+  id: string;
+  image?: {
+    caption?: string;
+    sha256: string;
+    id: string;
+    mime_type: string;
+  };
+  interactive?: {
+    type: string;
+    button_reply: {
+      id: string;
+      title: string;
+    };
+    list_reply: {
+      id: string;
+      title: string;
+      description: string;
+    };
+  };
+  order?: {
+    catalog_id: string;
+    text: string;
+    product_items: {
+      product_retailer_id: string;
+      quantity: string;
+      item_price: string;
+      currency: string;
+    }[];
+  };
+  referral?: {
+    source_url: string;
+    source_type: 'ad' | 'post';
+    source_id: string;
+    headline: string;
+    body: string;
+    media_type: 'image' | 'video';
+    image_url?: string;
+    video_url?: string;
+    thumbnail_url?: string;
+    ctwa_clid: string;
+  };
+  sticker?: {
+    mime_type: string;
+    sha256: string;
+    id: string;
+    animated: boolean;
+  };
+  system?: {
+    body: string;
+    identity: string;
+    new_wa_id: string;
+    wa_id: string;
+    type: 'customer_changed_number' | 'customer_identity_changed';
+    customer: string;
+  };
+  text?: {
+    body: string;
+  };
+  timestamp: string;
+  type: WhatsAppMessageType;
+  video?: {
+    caption: string;
+    filename: string;
+    sha256: string;
+    id: string;
+    mime_type: string;
+  };
+};
+
+type WhatsAppStatus = {
+  biz_opaque_callback_data: string;
+  conversation: {
+    id: string;
+    origin: {
+      type:
+        | 'authentication'
+        | 'marketing'
+        | 'utility'
+        | 'service'
+        | 'referral_conversion';
+    };
+    expiration_timestamp?: string;
+  };
+  errors: {
+    code: number;
+    title: string;
+    message: string;
+    error_data: {
+      details: string;
+    };
+  }[];
+  id: string;
+  pricing: {
+    category:
+      | 'authentication'
+      | 'marketing'
+      | 'utility'
+      | 'service'
+      | 'referral_conversion';
+    pricing_model: 'CBP';
+  };
+  recipient_id: string;
+  status: 'delivered' | 'read' | 'sent';
+  timestamp: string;
+};
+
+export enum WhatsAppMessageType {
+  audio = 'audio',
+  button = 'button',
+  document = 'document',
+  text = 'text',
+  image = 'image',
+  interactive = 'interactive',
+  order = 'order',
+  sticker = 'sticker',
+  system = 'system',
+  unknown = 'unknown',
+  video = 'video',
+  location = 'location',
+}