meta-cloud-api 0.0.2 → 0.0.4

package/src/types/messages.ts

@@ -1,453 +0,0 @@
-/**
- * Copyright (c) Meta Platforms, Inc. and affiliates.
- * All rights reserved.
- *
- * This source code is licensed under the license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import { BaseClass } from './base';
-import {
-    MessageTypesEnum,
-    ComponentTypesEnum,
-    LanguagesEnum,
-    ParametersTypesEnum,
-    CurrencyCodesEnum,
-    ButtonTypesEnum,
-    ButtonPositionEnum,
-    InteractiveTypesEnum,
-} from './enums';
-import { GeneralRequestBody, RequesterResponseInterface } from './request';
-
-export type GeneralMessageBody = GeneralRequestBody & {
-    /**
-     * The Meta messaging product name.
-     * @default 'whatsapp'
-     */
-    messaging_product: 'whatsapp';
-};
-
-export type StatusObject = {
-    status: 'read';
-    message_id: string;
-};
-
-export type StatusRequestBody = GeneralMessageBody & StatusObject;
-
-type ConTextObject = {
-    message_id: string;
-};
-
-export type MessageRequestBody<T extends MessageTypesEnum> = GeneralMessageBody & {
-    recipient_type?: string;
-    to: string;
-    context?: ConTextObject;
-    type?: T;
-};
-
-type MetaAudioMediaObject = {
-    id: string;
-    link?: never;
-};
-
-type HostedAudioMediaObject = {
-    id?: never;
-    link: string;
-};
-
-export type AudioMediaObject = MetaAudioMediaObject | HostedAudioMediaObject;
-
-export type AudioMessageRequestBody = MessageRequestBody<MessageTypesEnum.Audio> & {
-    [MessageTypesEnum.Audio]: [AudioMediaObject];
-};
-
-type AddressesObject = {
-    street?: string;
-    city?: string;
-    state?: string;
-    zip?: string;
-    country?: string;
-    country_code?: string;
-    type?: 'HOME' | 'WORK' | string;
-};
-
-type EmailObject = {
-    email?: string;
-    type?: 'HOME' | 'WORK' | string;
-};
-
-type NameObject = {
-    formatted_name: string;
-    first_name?: string;
-    last_name?: string;
-    middle_name?: string;
-    suffix?: string;
-    prefix?: string;
-};
-
-type OrgObject = {
-    company?: string;
-    department?: string;
-    title?: string;
-};
-
-type PhoneObject = {
-    phone?: 'PHONE_NUMBER';
-    type?: 'CELL' | 'MAIN' | 'IPHONE' | 'HOME' | 'WORK' | string;
-    wa_id?: string;
-};
-
-type URLObject = {
-    url?: string;
-    type?: 'HOME' | 'WORK' | string;
-};
-
-export type ContactObject = {
-    addresses?: AddressesObject[];
-    birthday?: `${number}${number}${number}${number}-${number}${number}-${number}${number}`;
-    emails?: EmailObject[];
-    name: NameObject;
-    org?: OrgObject;
-    phones?: PhoneObject[];
-    urls?: URLObject[];
-};
-
-export type ContactsMessageRequestBody = MessageRequestBody<MessageTypesEnum.Contacts> & {
-    [MessageTypesEnum.Contacts]: [ContactObject];
-};
-
-type MetaDocumentMediaObject = {
-    id: string;
-    link?: never;
-    caption?: string;
-    filename?: string;
-};
-
-type HostedDocumentMediaObject = {
-    id?: never;
-    link: string;
-    caption?: string;
-    filename?: string;
-};
-
-export type DocumentMediaObject = MetaDocumentMediaObject | HostedDocumentMediaObject;
-
-export type DocumentMessageRequestBody = MessageRequestBody<MessageTypesEnum.Document> & {
-    [MessageTypesEnum.Document]: [DocumentMediaObject];
-};
-
-type MetaImageMediaObject = {
-    id: string;
-    link?: never;
-    caption?: string;
-};
-
-type HostedImageMediaObject = {
-    id?: never;
-    link: string;
-    caption?: string;
-};
-
-export type ImageMediaObject = MetaImageMediaObject | HostedImageMediaObject;
-
-export type ImageMessageRequestBody = MessageRequestBody<MessageTypesEnum.Image> & {
-    [MessageTypesEnum.Image]: [ImageMediaObject];
-};
-
-type ProductObject = {
-    product_retailer_id: string;
-};
-
-type SimpleTextObject = {
-    text: string;
-};
-
-type RowObject = {
-    id: string;
-    title: string;
-    description?: string;
-};
-
-type MultiProductSectionObject = {
-    product_items: ProductObject[];
-    rows?: never;
-    title?: string;
-};
-
-type ListSectionObject = {
-    product_items?: never;
-    rows: RowObject[];
-    title?: string;
-};
-
-type SectionObject = MultiProductSectionObject | ListSectionObject;
-
-type ButtonObject = {
-    title: string;
-    id: string;
-};
-
-type ReplyButtonObject = {
-    type: 'reply';
-    reply: ButtonObject;
-};
-
-type ActionObject = {
-    button?: string;
-    buttons?: ReplyButtonObject[];
-    catalog_id?: string;
-    product_retailer_id?: string;
-    sections?: SectionObject;
-};
-
-type HeaderObject = {
-    type: 'document' | 'image' | 'text' | 'video';
-    document?: DocumentMediaObject;
-    image?: ImageMediaObject;
-    text?: string;
-    video?: VideoMediaObject;
-};
-
-type ButtonInteractiveObject = {
-    type: InteractiveTypesEnum.Button;
-    body: SimpleTextObject;
-    footer?: SimpleTextObject;
-    header?: HeaderObject;
-    action: ActionObject;
-};
-
-type ListInteractiveObject = {
-    type: InteractiveTypesEnum.List;
-    body: SimpleTextObject;
-    footer?: SimpleTextObject;
-    header?: HeaderObject;
-    action: ActionObject;
-};
-
-type ProductInteractiveObject = {
-    type: InteractiveTypesEnum.Product;
-    body?: SimpleTextObject;
-    footer?: SimpleTextObject;
-    header?: HeaderObject;
-    action: ActionObject;
-};
-
-type ProductListInteractiveObject = {
-    type: InteractiveTypesEnum.ProductList;
-    body: SimpleTextObject;
-    footer?: SimpleTextObject;
-    header: HeaderObject;
-    action: ActionObject;
-};
-
-export type InteractiveObject =
-    | ButtonInteractiveObject
-    | ListInteractiveObject
-    | ProductInteractiveObject
-    | ProductListInteractiveObject;
-
-export type InteractiveMessageRequestBody = MessageRequestBody<MessageTypesEnum.Interactive> & {
-    [MessageTypesEnum.Interactive]: InteractiveObject;
-};
-
-type MetaStickerMediaObject = {
-    id: string;
-    link?: never;
-};
-
-type HostedStickerMediaObject = {
-    id?: never;
-    link: string;
-};
-
-export type StickerMediaObject = MetaStickerMediaObject | HostedStickerMediaObject;
-
-export type StickerMessageRequestBody = MessageRequestBody<MessageTypesEnum.Sticker> & {
-    [MessageTypesEnum.Sticker]: [StickerMediaObject];
-};
-
-type ReActionObject = {
-    message_id: string;
-    emoji: string;
-};
-
-export type ReactionMessageRequestBody = MessageRequestBody<MessageTypesEnum.Reaction> & ReActionObject;
-
-export type TextObject = {
-    body: string;
-    preview_url?: boolean;
-};
-
-export type TextMessageRequestBody = MessageRequestBody<MessageTypesEnum.Text> & {
-    [MessageTypesEnum.Text]: [TextObject];
-};
-
-type MetaHostedVideoMediaObject = {
-    id: string;
-    link?: never;
-    caption?: string;
-};
-
-type SelfHostedVideoMediaObject = {
-    id?: never;
-    link: string;
-    caption?: string;
-};
-
-export type VideoMediaObject = MetaHostedVideoMediaObject | SelfHostedVideoMediaObject;
-
-export type VideoMessageRequestBody = MessageRequestBody<MessageTypesEnum.Video> & {
-    [MessageTypesEnum.Video]: [VideoMediaObject];
-};
-
-type LanguageObject = {
-    policy: 'deterministic';
-    code: LanguagesEnum;
-};
-
-type ParametersObject<T extends ParametersTypesEnum> = {
-    type: T;
-};
-
-type TextParametersObject = ParametersObject<ParametersTypesEnum.Text> & SimpleTextObject;
-
-type CurrencyObject = {
-    fallback_value: string;
-    code: CurrencyCodesEnum;
-    amount_1000: number;
-};
-
-type CurrencyParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {
-    currency: CurrencyObject;
-};
-
-type DateTimeObject = {
-    fallback_value: string;
-};
-
-type DateTimeParametersObject = ParametersObject<ParametersTypesEnum.Currency> & {
-    date_time: DateTimeObject;
-};
-
-type DocumentParametersObject = ParametersObject<ParametersTypesEnum.Document> & DocumentMediaObject;
-
-type ImageParametersObject = ParametersObject<ParametersTypesEnum.Image> & ImageMediaObject;
-
-type VideoParametersObject = ParametersObject<ParametersTypesEnum.Video> & VideoMediaObject;
-
-type QuickReplyButtonParametersObject = {
-    type: ParametersTypesEnum.Payload;
-    payload: string;
-};
-
-type URLButtonParametersObject = SimpleTextObject & {
-    type: ParametersTypesEnum.Text;
-};
-
-type ButtonParameterObject = QuickReplyButtonParametersObject | URLButtonParametersObject;
-
-type ComponentObject<T extends ComponentTypesEnum> = {
-    type: T;
-    parameters: (
-        | CurrencyParametersObject
-        | DateTimeParametersObject
-        | DocumentParametersObject
-        | ImageParametersObject
-        | TextParametersObject
-        | VideoParametersObject
-    )[];
-};
-
-type ButtonComponentObject = ComponentObject<ComponentTypesEnum.Button> & {
-    parameters: ButtonParameterObject;
-    sub_type: ButtonTypesEnum;
-    index: ButtonPositionEnum;
-};
-
-export type MessageTemplateObject<T extends ComponentTypesEnum> = {
-    name: string;
-    language: LanguageObject;
-    components?: (ComponentObject<T> | ButtonComponentObject)[];
-};
-
-export type MessageTemplateRequestBody<T extends ComponentTypesEnum> = MessageRequestBody<MessageTypesEnum.Template> &
-    MessageTemplateObject<T>;
-
-export type LocationObject = {
-    longitude: number;
-    latitude: number;
-    name?: string;
-    address?: string;
-};
-
-export type LocationMessageRequestBody = MessageRequestBody<MessageTypesEnum.Location> & {
-    [MessageTypesEnum.Location]: [LocationObject];
-};
-
-export type MessagesResponse = GeneralMessageBody & {
-    contacts: [
-        {
-            input: string;
-            wa_id: string;
-        },
-    ];
-    messages: [
-        {
-            id: string;
-        },
-    ];
-};
-
-export declare class MessagesClass extends BaseClass {
-    audio(
-        body: AudioMediaObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    contacts(
-        body: [ContactObject],
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    document(
-        body: DocumentMediaObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    image(
-        body: ImageMediaObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    interactive(
-        body: InteractiveObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    location(
-        body: LocationObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    status(body: StatusObject): Promise<RequesterResponseInterface<MessagesResponse>>;
-    sticker(
-        body: StickerMediaObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    template(
-        body: MessageTemplateObject<ComponentTypesEnum>,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    text(
-        body: TextObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-    video(
-        body: VideoMediaObject,
-        recipient: number,
-        replyMessageId?: string,
-    ): Promise<RequesterResponseInterface<MessagesResponse>>;
-}

package/src/types/phoneNumber.ts

@@ -1,111 +0,0 @@
-import { Paging, RequesterResponseInterface, ResponseData, ResponseSuccess } from './request';
-
-export type QualityRating = 'GREEN' | 'YELLOW' | 'RED' | 'NA';
-
-export type AccountMode = 'LIVE' | 'SANDBOX';
-
-export type CodeVerificationStatus =
-    | 'NOT_VERIFIED'
-    | 'VERIFIED'
-    | 'EXPIRED'
-    | 'PENDING'
-    | 'DELETED'
-    | 'MIGRATED'
-    | 'BANNED'
-    | 'RESTRICTED'
-    | 'RATE_LIMITED'
-    | 'FLAGGED'
-    | 'CONNECTED'
-    | 'DISCONNECTED'
-    | 'UNKNOWN'
-    | 'UNVERIFIED';
-
-export type MessagingLimitTier = 'TIER_50' | 'TIER_250' | 'TIER_1K' | 'TIER_10K' | 'TIER_100K' | 'TIER_UNLIMITED';
-
-export type PlatformType = 'CLOUD_API' | 'ON_PREMISE' | 'NOT_APPLICABLE';
-
-export type ThroughputLevel = 'STANDARD' | 'HIGH' | 'NOT_APPLICABLE';
-
-export type HealthStatusEntity = {
-    entity_type: string;
-    id: string;
-    can_send_message: string;
-    additional_info?: string[];
-    errors?: Array<{
-        error_code: number;
-        error_description: string;
-        possible_solution: string;
-    }>;
-};
-
-export type HealthStatus = {
-    can_send_message: string;
-    entities: HealthStatusEntity[];
-};
-
-export type QualityScore = {
-    score: QualityRating;
-};
-
-export type Throughput = {
-    level: ThroughputLevel;
-};
-
-export type PhoneNumberResponse = {
-    display_phone_number: string;
-    id: string;
-    quality_rating: QualityRating;
-    verified_name: string;
-    account_mode?: AccountMode;
-    certificate?: string;
-    code_verification_status?: CodeVerificationStatus;
-    conversational_automation?: Record<string, unknown>;
-    eligibility_for_api_business_global_search?: string;
-    health_status?: HealthStatus;
-    is_official_business_account?: boolean;
-    is_on_biz_app?: boolean;
-    is_pin_enabled?: boolean;
-    is_preverified_number?: boolean;
-    last_onboarded_time?: string;
-    messaging_limit_tier?: MessagingLimitTier;
-    name_status?: string;
-    new_certificate?: string;
-    new_name_status?: string;
-    platform_type?: PlatformType;
-    quality_score?: QualityScore;
-    search_visibility?: string;
-    status?: CodeVerificationStatus;
-    throughput?: Throughput;
-};
-
-export type Cursors = {
-    before: string;
-    after: string;
-};
-
-export type PhoneNumbersResponse = {
-    data: PhoneNumberResponse[];
-    paging: Paging;
-};
-
-export type RequestVerificationCodeRequest = {
-    code_method: 'SMS' | 'VOICE';
-    language: string;
-};
-
-export type VerifyCodeRequest = {
-    code: string;
-};
-
-export type TwoStepVerificationParams = {
-    pin: string;
-};
-
-export declare class PhoneNumberClass {
-    getPhoneNumberById(fields?: string): Promise<RequesterResponseInterface<PhoneNumberResponse>>;
-    getPhoneNumbers(): Promise<RequesterResponseInterface<PhoneNumbersResponse>>;
-    requestVerificationCode(
-        params: RequestVerificationCodeRequest,
-    ): Promise<RequesterResponseInterface<ResponseSuccess>>;
-    verifyCode(params: VerifyCodeRequest): Promise<RequesterResponseInterface<ResponseSuccess>>;
-}

package/src/types/qrCode.ts

@@ -1,30 +0,0 @@
-import { ResponseSuccess } from './request';
-
-import { RequesterResponseInterface, ResponseData } from './request';
-
-export type QrCodeResponse = {
-    code: string;
-    prefilled_message: string;
-    deep_link_url: string;
-    qr_image_url?: string;
-};
-
-export type QrCodesResponse = ResponseData<QrCodeResponse[]>;
-
-export type CreateQrCodeRequest = {
-    prefilled_message: string;
-    generate_qr_image?: 'SVG' | 'PNG';
-};
-
-export type UpdateQrCodeRequest = {
-    code: string;
-    prefilled_message: string;
-};
-
-export interface QrCodeClass {
-    createQrCode(request: CreateQrCodeRequest): Promise<RequesterResponseInterface<QrCodeResponse>>;
-    getQrCodes(): Promise<RequesterResponseInterface<QrCodesResponse>>;
-    getQrCode(qrCodeId: string): Promise<RequesterResponseInterface<QrCodeResponse>>;
-    updateQrCode(request: UpdateQrCodeRequest): Promise<RequesterResponseInterface<QrCodeResponse>>;
-    deleteQrCode(qrCodeId: string): Promise<RequesterResponseInterface<ResponseSuccess>>;
-}

package/src/types/registration.ts

@@ -1,17 +0,0 @@
-import { RequesterResponseInterface, ResponseSuccess } from './request';
-import { DataLocalizationRegionEnum } from './enums';
-
-export type RegistrationRequest = {
-    messaging_product: 'whatsapp';
-    pin: string;
-    data_localization_region?: DataLocalizationRegionEnum;
-};
-
-export interface RegistrationClass {
-    register(
-        pin: string,
-        dataLocalizationRegion?: DataLocalizationRegionEnum,
-    ): Promise<RequesterResponseInterface<ResponseSuccess>>;
-
-    deregister(): Promise<RequesterResponseInterface<ResponseSuccess>>;
-}

package/src/types/request.ts

@@ -1,66 +0,0 @@
-import { HttpMethodsEnum } from './enums';
-
-export type GeneralRequestBody = Record<string, any>;
-
-export interface GeneralHeaderInterface {
-    /**
-     * Authorization token. This is required for all HTTP requests made to the graph API.
-     * @default 'Bearer '
-     */
-    Authorization: string;
-
-    /**
-     * Content type of the message being sent. This is required for all HTTP requests made to the graph API.
-     * @default 'application/json'
-     */
-    'Content-Type': string;
-
-    /**
-     * User agent field sent in all requests. This is used to gather SDK usage metrics and help
-     * better triage support requests.
-     * @default `WA_SDK/${ SDK_version } (Node.js ${ process.version })`
-     */
-    'User-Agent': string;
-}
-
-export interface RequesterResponseInterface<T> {
-    json: () => Promise<T>;
-}
-
-export interface ResponseSuccess {
-    success: boolean;
-}
-
-export interface ResponseData<T> {
-    data: T;
-}
-
-export interface ResponsePagination<T> {
-    data: T[];
-    paging: Paging;
-}
-
-export interface Paging {
-    cursors: {
-        before: string;
-        after: string;
-    };
-    next: string;
-}
-
-export declare class RequesterClass {
-    constructor(
-        host: string,
-        apiVersion: string,
-        phoneNumberId: number,
-        accessToken: string,
-        businessAcctId: string,
-        userAgent: string,
-    );
-    sendRequest: (
-        method: HttpMethodsEnum,
-        path: string,
-        timeout: number,
-        body?: any,
-    ) => Promise<RequesterResponseInterface<any>>;
-}