@relayapi/sdk 0.2.2

package/dist/resources/whatsapp/templates.js

@@ -0,0 +1,39 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+const resource_1 = require("../../core/resource");
+const headers_1 = require("../../internal/headers");
+const path_1 = require("../../internal/utils/path");
+class Templates extends resource_1.APIResource {
+    /**
+     * Create a message template
+     */
+    create(body, options) {
+        return this._client.post('/v1/whatsapp/templates', { body, ...options });
+    }
+    /**
+     * Get template details
+     */
+    retrieve(templateName, query, options) {
+        return this._client.get((0, path_1.path) `/v1/whatsapp/templates/${templateName}`, { query, ...options });
+    }
+    /**
+     * List message templates
+     */
+    list(query, options) {
+        return this._client.get('/v1/whatsapp/templates', { query, ...options });
+    }
+    /**
+     * Delete a message template
+     */
+    delete(templateName, params, options) {
+        const { account_id } = params;
+        return this._client.delete((0, path_1.path) `/v1/whatsapp/templates/${templateName}`, {
+            query: { account_id },
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Templates = Templates;

package/dist/resources/whatsapp/whatsapp.d.ts

@@ -0,0 +1,148 @@
+import { APIResource } from '../../core/resource';
+import * as BroadcastsAPI from './broadcasts';
+import { BroadcastCreateParams, BroadcastCreateResponse, BroadcastListParams, BroadcastListResponse, BroadcastRetrieveResponse, BroadcastScheduleResponse, BroadcastSendResponse, Broadcasts } from './broadcasts';
+import * as BusinessProfileAPI from './business-profile';
+import { BusinessProfile, BusinessProfileRetrieveParams, BusinessProfileRetrieveResponse, BusinessProfileUpdateParams, BusinessProfileUpdateResponse } from './business-profile';
+import * as ContactsAPI from './contacts';
+import { ContactBulkOperationsParams, ContactBulkOperationsResponse, ContactCreateParams, ContactCreateResponse, ContactImportParams, ContactImportResponse, ContactListParams, ContactListResponse, ContactRetrieveResponse, Contacts } from './contacts';
+import * as GroupsAPI from './groups';
+import { GroupCreateParams, GroupCreateResponse, GroupListParams, GroupListResponse, Groups } from './groups';
+import * as TemplatesAPI from './templates';
+import { TemplateCreateParams, TemplateCreateResponse, TemplateDeleteParams, TemplateListParams, TemplateListResponse, TemplateRetrieveParams, TemplateRetrieveResponse, Templates } from './templates';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+export declare class Whatsapp extends APIResource {
+    broadcasts: BroadcastsAPI.Broadcasts;
+    templates: TemplatesAPI.Templates;
+    contacts: ContactsAPI.Contacts;
+    groups: GroupsAPI.Groups;
+    businessProfile: BusinessProfileAPI.BusinessProfile;
+    /**
+     * Send bulk WhatsApp messages via template
+     */
+    bulkSend(body: WhatsappBulkSendParams, options?: RequestOptions): APIPromise<WhatsappBulkSendResponse>;
+    /**
+     * List registered phone numbers
+     */
+    listPhoneNumbers(query: WhatsappListPhoneNumbersParams, options?: RequestOptions): APIPromise<WhatsappListPhoneNumbersResponse>;
+}
+export interface WhatsappBulkSendResponse {
+    results: Array<WhatsappBulkSendResponse.Result>;
+    summary: WhatsappBulkSendResponse.Summary;
+}
+export declare namespace WhatsappBulkSendResponse {
+    interface Result {
+        /**
+         * Recipient phone number
+         */
+        phone: string;
+        /**
+         * Send status
+         */
+        status: 'sent' | 'failed';
+        /**
+         * Error message if failed
+         */
+        error?: string | null;
+    }
+    interface Summary {
+        /**
+         * Failed count
+         */
+        failed: number;
+        /**
+         * Successfully sent count
+         */
+        sent: number;
+    }
+}
+export interface WhatsappListPhoneNumbersResponse {
+    data: Array<WhatsappListPhoneNumbersResponse.Data>;
+}
+export declare namespace WhatsappListPhoneNumbersResponse {
+    interface Data {
+        /**
+         * Phone number ID
+         */
+        id: string;
+        /**
+         * Phone number
+         */
+        phone_number: string;
+        /**
+         * Registration status
+         */
+        status: 'active' | 'inactive' | 'pending';
+        /**
+         * Display name
+         */
+        display_name?: string | null;
+    }
+}
+export interface WhatsappBulkSendParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+    /**
+     * Recipients
+     */
+    recipients: Array<WhatsappBulkSendParams.Recipient>;
+    template: WhatsappBulkSendParams.Template;
+}
+export declare namespace WhatsappBulkSendParams {
+    interface Recipient {
+        /**
+         * Phone number in E.164 format
+         */
+        phone: string;
+        /**
+         * Template variable substitutions
+         */
+        variables?: {
+            [key: string]: string;
+        };
+    }
+    interface Template {
+        /**
+         * Template language code
+         */
+        language: string;
+        /**
+         * Template name
+         */
+        name: string;
+        /**
+         * Template components
+         */
+        components?: Array<Template.Component>;
+    }
+    namespace Template {
+        interface Component {
+            /**
+             * Component type
+             */
+            type: 'header' | 'body' | 'button';
+            /**
+             * Component parameters
+             */
+            parameters?: Array<{
+                [key: string]: unknown;
+            }>;
+        }
+    }
+}
+export interface WhatsappListPhoneNumbersParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+}
+export declare namespace Whatsapp {
+    export { type WhatsappBulkSendResponse as WhatsappBulkSendResponse, type WhatsappListPhoneNumbersResponse as WhatsappListPhoneNumbersResponse, type WhatsappBulkSendParams as WhatsappBulkSendParams, type WhatsappListPhoneNumbersParams as WhatsappListPhoneNumbersParams, };
+    export { Broadcasts as Broadcasts, type BroadcastCreateResponse as BroadcastCreateResponse, type BroadcastRetrieveResponse as BroadcastRetrieveResponse, type BroadcastListResponse as BroadcastListResponse, type BroadcastScheduleResponse as BroadcastScheduleResponse, type BroadcastSendResponse as BroadcastSendResponse, type BroadcastCreateParams as BroadcastCreateParams, type BroadcastListParams as BroadcastListParams, };
+    export { Templates as Templates, type TemplateCreateResponse as TemplateCreateResponse, type TemplateRetrieveResponse as TemplateRetrieveResponse, type TemplateListResponse as TemplateListResponse, type TemplateCreateParams as TemplateCreateParams, type TemplateRetrieveParams as TemplateRetrieveParams, type TemplateListParams as TemplateListParams, type TemplateDeleteParams as TemplateDeleteParams, };
+    export { Contacts as Contacts, type ContactCreateResponse as ContactCreateResponse, type ContactRetrieveResponse as ContactRetrieveResponse, type ContactListResponse as ContactListResponse, type ContactBulkOperationsResponse as ContactBulkOperationsResponse, type ContactImportResponse as ContactImportResponse, type ContactCreateParams as ContactCreateParams, type ContactListParams as ContactListParams, type ContactBulkOperationsParams as ContactBulkOperationsParams, type ContactImportParams as ContactImportParams, };
+    export { Groups as Groups, type GroupCreateResponse as GroupCreateResponse, type GroupListResponse as GroupListResponse, type GroupCreateParams as GroupCreateParams, type GroupListParams as GroupListParams, };
+    export { BusinessProfile as BusinessProfile, type BusinessProfileRetrieveResponse as BusinessProfileRetrieveResponse, type BusinessProfileUpdateResponse as BusinessProfileUpdateResponse, type BusinessProfileRetrieveParams as BusinessProfileRetrieveParams, type BusinessProfileUpdateParams as BusinessProfileUpdateParams, };
+}

package/dist/resources/whatsapp/whatsapp.js

@@ -0,0 +1,76 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Whatsapp = void 0;
+const resource_1 = require("../../core/resource");
+const BroadcastsAPI = __importStar(require("./broadcasts"));
+const broadcasts_1 = require("./broadcasts");
+const BusinessProfileAPI = __importStar(require("./business-profile"));
+const business_profile_1 = require("./business-profile");
+const ContactsAPI = __importStar(require("./contacts"));
+const contacts_1 = require("./contacts");
+const GroupsAPI = __importStar(require("./groups"));
+const groups_1 = require("./groups");
+const TemplatesAPI = __importStar(require("./templates"));
+const templates_1 = require("./templates");
+class Whatsapp extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.broadcasts = new BroadcastsAPI.Broadcasts(this._client);
+        this.templates = new TemplatesAPI.Templates(this._client);
+        this.contacts = new ContactsAPI.Contacts(this._client);
+        this.groups = new GroupsAPI.Groups(this._client);
+        this.businessProfile = new BusinessProfileAPI.BusinessProfile(this._client);
+    }
+    /**
+     * Send bulk WhatsApp messages via template
+     */
+    bulkSend(body, options) {
+        return this._client.post('/v1/whatsapp/bulk-send', { body, ...options });
+    }
+    /**
+     * List registered phone numbers
+     */
+    listPhoneNumbers(query, options) {
+        return this._client.get('/v1/whatsapp/phone-numbers', { query, ...options });
+    }
+}
+exports.Whatsapp = Whatsapp;
+Whatsapp.Broadcasts = broadcasts_1.Broadcasts;
+Whatsapp.Templates = templates_1.Templates;
+Whatsapp.Contacts = contacts_1.Contacts;
+Whatsapp.Groups = groups_1.Groups;
+Whatsapp.BusinessProfile = business_profile_1.BusinessProfile;

package/dist/resources/whatsapp.d.ts

@@ -0,0 +1 @@
+export * from './whatsapp/index';

package/dist/resources/whatsapp.js

@@ -0,0 +1,18 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./whatsapp/index"), exports);

package/dist/resources.d.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/dist/resources.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/index"), exports);

package/dist/uploads.d.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/dist/uploads.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @deprecated Import from ./core/uploads instead */
+__exportStar(require("./core/uploads"), exports);

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "0.2.2";

package/dist/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+// Version is managed by release-please. Do not edit manually.
+exports.VERSION = '0.2.2'; // x-release-please-version

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@relayapi/sdk",
+  "version": "0.2.2",
+  "description": "The official TypeScript library for the Relay API",
+  "author": "Relay <support@relayapi.dev>",
+  "license": "Apache-2.0",
+  "type": "commonjs",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts",
+      "require": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.8"
+  }
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Relay as default } from './client';
+
+export { type Uploadable, toFile } from './core/uploads';
+export { APIPromise } from './core/api-promise';
+export { Relay, type ClientOptions } from './client';
+export {
+  RelayError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} from './core/error';