@relayapi/sdk 0.2.2

package/dist/resources/webhooks.d.ts

@@ -0,0 +1,205 @@
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+export declare class Webhooks extends APIResource {
+    /**
+     * Create a new webhook endpoint. The signing secret is returned only once in the
+     * response.
+     */
+    create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse>;
+    /**
+     * Update a webhook endpoint
+     */
+    update(id: string, body?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<WebhookUpdateResponse>;
+    /**
+     * List webhook endpoints
+     */
+    list(query?: WebhookListParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListResponse>;
+    /**
+     * Delete a webhook endpoint
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Returns delivery logs from the last 7 days.
+     */
+    listLogs(query?: WebhookListLogsParams | null | undefined, options?: RequestOptions): APIPromise<WebhookListLogsResponse>;
+    /**
+     * Send a test POST request to the webhook URL to verify it is reachable.
+     */
+    sendTest(body: WebhookSendTestParams, options?: RequestOptions): APIPromise<WebhookSendTestResponse>;
+}
+export interface WebhookCreateResponse {
+    /**
+     * Webhook ID
+     */
+    id: string;
+    /**
+     * Creation timestamp
+     */
+    created_at: string;
+    /**
+     * Whether the webhook is active
+     */
+    enabled: boolean;
+    /**
+     * Subscribed events
+     */
+    events: Array<string>;
+    /**
+     * Webhook signing secret (shown only once)
+     */
+    secret: string;
+    /**
+     * Endpoint URL
+     */
+    url: string;
+}
+export interface WebhookUpdateResponse {
+    /**
+     * Webhook ID
+     */
+    id: string;
+    /**
+     * Creation timestamp
+     */
+    created_at: string;
+    /**
+     * Whether the webhook is active
+     */
+    enabled: boolean;
+    /**
+     * Subscribed events
+     */
+    events: Array<string>;
+    /**
+     * Last update timestamp
+     */
+    updated_at: string;
+    /**
+     * Endpoint URL
+     */
+    url: string;
+}
+export interface WebhookListResponse {
+    data: Array<WebhookListResponse.Data>;
+    /**
+     * Whether more items exist
+     */
+    has_more: boolean;
+    /**
+     * Cursor for next page
+     */
+    next_cursor: string | null;
+}
+export declare namespace WebhookListResponse {
+    interface Data {
+        /**
+         * Webhook ID
+         */
+        id: string;
+        /**
+         * Creation timestamp
+         */
+        created_at: string;
+        /**
+         * Whether the webhook is active
+         */
+        enabled: boolean;
+        /**
+         * Subscribed events
+         */
+        events: Array<string>;
+        /**
+         * Last update timestamp
+         */
+        updated_at: string;
+        /**
+         * Endpoint URL
+         */
+        url: string;
+    }
+}
+export interface WebhookListLogsResponse {
+    data: Array<WebhookListLogsResponse.Data>;
+    has_more: boolean;
+    next_cursor: string | null;
+}
+export declare namespace WebhookListLogsResponse {
+    interface Data {
+        id: string;
+        created_at: string;
+        error: string | null;
+        event: string;
+        response_time_ms: number | null;
+        status_code: number | null;
+        success: boolean;
+        webhook_id: string;
+    }
+}
+export interface WebhookSendTestResponse {
+    /**
+     * Response time in milliseconds
+     */
+    response_time_ms: number | null;
+    /**
+     * HTTP status code from the test delivery
+     */
+    status_code: number | null;
+    /**
+     * Whether the test delivery succeeded
+     */
+    success: boolean;
+}
+export interface WebhookCreateParams {
+    /**
+     * Events to subscribe to
+     */
+    events: Array<'post.published' | 'post.partial' | 'post.failed' | 'post.scheduled' | 'account.connected' | 'account.disconnected' | 'comment.received' | 'message.received'>;
+    /**
+     * Webhook endpoint URL
+     */
+    url: string;
+}
+export interface WebhookUpdateParams {
+    /**
+     * Enable or disable the webhook
+     */
+    enabled?: boolean;
+    /**
+     * Updated events
+     */
+    events?: Array<'post.published' | 'post.partial' | 'post.failed' | 'post.scheduled' | 'account.connected' | 'account.disconnected' | 'comment.received' | 'message.received'>;
+    /**
+     * Updated endpoint URL
+     */
+    url?: string;
+}
+export interface WebhookListParams {
+    /**
+     * Pagination cursor
+     */
+    cursor?: string;
+    /**
+     * Number of items per page
+     */
+    limit?: number;
+}
+export interface WebhookListLogsParams {
+    /**
+     * Pagination cursor
+     */
+    cursor?: string;
+    /**
+     * Number of items per page
+     */
+    limit?: number;
+}
+export interface WebhookSendTestParams {
+    /**
+     * ID of the webhook to test
+     */
+    webhook_id: string;
+}
+export declare namespace Webhooks {
+    export { type WebhookCreateResponse as WebhookCreateResponse, type WebhookUpdateResponse as WebhookUpdateResponse, type WebhookListResponse as WebhookListResponse, type WebhookListLogsResponse as WebhookListLogsResponse, type WebhookSendTestResponse as WebhookSendTestResponse, type WebhookCreateParams as WebhookCreateParams, type WebhookUpdateParams as WebhookUpdateParams, type WebhookListParams as WebhookListParams, type WebhookListLogsParams as WebhookListLogsParams, type WebhookSendTestParams as WebhookSendTestParams, };
+}

package/dist/resources/webhooks.js

@@ -0,0 +1,50 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = void 0;
+const resource_1 = require("../core/resource");
+const headers_1 = require("../internal/headers");
+const path_1 = require("../internal/utils/path");
+class Webhooks extends resource_1.APIResource {
+    /**
+     * Create a new webhook endpoint. The signing secret is returned only once in the
+     * response.
+     */
+    create(body, options) {
+        return this._client.post('/v1/webhooks', { body, ...options });
+    }
+    /**
+     * Update a webhook endpoint
+     */
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/v1/webhooks/${id}`, { body, ...options });
+    }
+    /**
+     * List webhook endpoints
+     */
+    list(query = {}, options) {
+        return this._client.get('/v1/webhooks', { query, ...options });
+    }
+    /**
+     * Delete a webhook endpoint
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/v1/webhooks/${id}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Returns delivery logs from the last 7 days.
+     */
+    listLogs(query = {}, options) {
+        return this._client.get('/v1/webhooks/logs', { query, ...options });
+    }
+    /**
+     * Send a test POST request to the webhook URL to verify it is reachable.
+     */
+    sendTest(body, options) {
+        return this._client.post('/v1/webhooks/test', { body, ...options });
+    }
+}
+exports.Webhooks = Webhooks;

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

@@ -0,0 +1,291 @@
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+export declare class Broadcasts extends APIResource {
+    /**
+     * Create a broadcast
+     */
+    create(body: BroadcastCreateParams, options?: RequestOptions): APIPromise<BroadcastCreateResponse>;
+    /**
+     * Get broadcast details
+     */
+    retrieve(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastRetrieveResponse>;
+    /**
+     * List broadcasts
+     */
+    list(query: BroadcastListParams, options?: RequestOptions): APIPromise<BroadcastListResponse>;
+    /**
+     * Delete a broadcast
+     */
+    delete(broadcastID: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Schedule a broadcast
+     */
+    schedule(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastScheduleResponse>;
+    /**
+     * Send a broadcast immediately
+     */
+    send(broadcastID: string, options?: RequestOptions): APIPromise<BroadcastSendResponse>;
+}
+export interface BroadcastCreateResponse {
+    /**
+     * Broadcast ID
+     */
+    id: string;
+    /**
+     * Created timestamp
+     */
+    created_at: string;
+    /**
+     * Broadcast name
+     */
+    name: string;
+    /**
+     * Total recipients
+     */
+    recipient_count: number;
+    /**
+     * Broadcast status
+     */
+    status: 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
+    /**
+     * Template name
+     */
+    template: string;
+    /**
+     * Failed sends
+     */
+    failed?: number;
+    /**
+     * Scheduled time
+     */
+    scheduled_at?: string | null;
+    /**
+     * Successfully sent
+     */
+    sent?: number;
+}
+export interface BroadcastRetrieveResponse {
+    /**
+     * Broadcast ID
+     */
+    id: string;
+    /**
+     * Created timestamp
+     */
+    created_at: string;
+    /**
+     * Broadcast name
+     */
+    name: string;
+    /**
+     * Total recipients
+     */
+    recipient_count: number;
+    /**
+     * Broadcast status
+     */
+    status: 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
+    /**
+     * Template name
+     */
+    template: string;
+    /**
+     * Failed sends
+     */
+    failed?: number;
+    /**
+     * Scheduled time
+     */
+    scheduled_at?: string | null;
+    /**
+     * Successfully sent
+     */
+    sent?: number;
+}
+export interface BroadcastListResponse {
+    data: Array<BroadcastListResponse.Data>;
+}
+export declare namespace BroadcastListResponse {
+    interface Data {
+        /**
+         * Broadcast ID
+         */
+        id: string;
+        /**
+         * Created timestamp
+         */
+        created_at: string;
+        /**
+         * Broadcast name
+         */
+        name: string;
+        /**
+         * Total recipients
+         */
+        recipient_count: number;
+        /**
+         * Broadcast status
+         */
+        status: 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
+        /**
+         * Template name
+         */
+        template: string;
+        /**
+         * Failed sends
+         */
+        failed?: number;
+        /**
+         * Scheduled time
+         */
+        scheduled_at?: string | null;
+        /**
+         * Successfully sent
+         */
+        sent?: number;
+    }
+}
+export interface BroadcastScheduleResponse {
+    /**
+     * Broadcast ID
+     */
+    id: string;
+    /**
+     * Created timestamp
+     */
+    created_at: string;
+    /**
+     * Broadcast name
+     */
+    name: string;
+    /**
+     * Total recipients
+     */
+    recipient_count: number;
+    /**
+     * Broadcast status
+     */
+    status: 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
+    /**
+     * Template name
+     */
+    template: string;
+    /**
+     * Failed sends
+     */
+    failed?: number;
+    /**
+     * Scheduled time
+     */
+    scheduled_at?: string | null;
+    /**
+     * Successfully sent
+     */
+    sent?: number;
+}
+export interface BroadcastSendResponse {
+    /**
+     * Broadcast ID
+     */
+    id: string;
+    /**
+     * Created timestamp
+     */
+    created_at: string;
+    /**
+     * Broadcast name
+     */
+    name: string;
+    /**
+     * Total recipients
+     */
+    recipient_count: number;
+    /**
+     * Broadcast status
+     */
+    status: 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
+    /**
+     * Template name
+     */
+    template: string;
+    /**
+     * Failed sends
+     */
+    failed?: number;
+    /**
+     * Scheduled time
+     */
+    scheduled_at?: string | null;
+    /**
+     * Successfully sent
+     */
+    sent?: number;
+}
+export interface BroadcastCreateParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+    /**
+     * Broadcast name
+     */
+    name: string;
+    /**
+     * Recipient list
+     */
+    recipients: Array<BroadcastCreateParams.Recipient>;
+    template: BroadcastCreateParams.Template;
+    /**
+     * ISO 8601 timestamp to schedule send
+     */
+    scheduled_at?: string;
+}
+export declare namespace BroadcastCreateParams {
+    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;
+        components?: Array<Template.Component>;
+    }
+    namespace Template {
+        interface Component {
+            /**
+             * Component type
+             */
+            type: 'header' | 'body' | 'button';
+            /**
+             * Component parameters
+             */
+            parameters?: Array<{
+                [key: string]: unknown;
+            }>;
+        }
+    }
+}
+export interface BroadcastListParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+}
+export declare namespace Broadcasts {
+    export { 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, };
+}

package/dist/resources/whatsapp/broadcasts.js

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

package/dist/resources/whatsapp/business-profile.d.ts

@@ -0,0 +1,85 @@
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+export declare class BusinessProfile extends APIResource {
+    /**
+     * Get WhatsApp Business profile
+     */
+    retrieve(query: BusinessProfileRetrieveParams, options?: RequestOptions): APIPromise<BusinessProfileRetrieveResponse>;
+    /**
+     * Update WhatsApp Business profile
+     */
+    update(body: BusinessProfileUpdateParams, options?: RequestOptions): APIPromise<BusinessProfileUpdateResponse>;
+}
+export interface BusinessProfileRetrieveResponse {
+    /**
+     * About text
+     */
+    about?: string | null;
+    /**
+     * Business address
+     */
+    address?: string | null;
+    /**
+     * Description
+     */
+    description?: string | null;
+    /**
+     * Business email
+     */
+    email?: string | null;
+    /**
+     * Profile picture URL
+     */
+    profile_picture_url?: string | null;
+    /**
+     * Website URLs
+     */
+    websites?: Array<string>;
+}
+export interface BusinessProfileUpdateResponse {
+    /**
+     * About text
+     */
+    about?: string | null;
+    /**
+     * Business address
+     */
+    address?: string | null;
+    /**
+     * Description
+     */
+    description?: string | null;
+    /**
+     * Business email
+     */
+    email?: string | null;
+    /**
+     * Profile picture URL
+     */
+    profile_picture_url?: string | null;
+    /**
+     * Website URLs
+     */
+    websites?: Array<string>;
+}
+export interface BusinessProfileRetrieveParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+}
+export interface BusinessProfileUpdateParams {
+    /**
+     * WhatsApp account ID
+     */
+    account_id: string;
+    about?: string;
+    address?: string;
+    description?: string;
+    email?: string;
+    websites?: Array<string>;
+}
+export declare namespace BusinessProfile {
+    export { type BusinessProfileRetrieveResponse as BusinessProfileRetrieveResponse, type BusinessProfileUpdateResponse as BusinessProfileUpdateResponse, type BusinessProfileRetrieveParams as BusinessProfileRetrieveParams, type BusinessProfileUpdateParams as BusinessProfileUpdateParams, };
+}

package/dist/resources/whatsapp/business-profile.js

@@ -0,0 +1,20 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BusinessProfile = void 0;
+const resource_1 = require("../../core/resource");
+class BusinessProfile extends resource_1.APIResource {
+    /**
+     * Get WhatsApp Business profile
+     */
+    retrieve(query, options) {
+        return this._client.get('/v1/whatsapp/business-profile', { query, ...options });
+    }
+    /**
+     * Update WhatsApp Business profile
+     */
+    update(body, options) {
+        return this._client.put('/v1/whatsapp/business-profile', { body, ...options });
+    }
+}
+exports.BusinessProfile = BusinessProfile;