@relayapi/sdk 0.2.2

package/dist/api-promise.d.ts

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

package/dist/api-promise.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/api-promise instead */
+__exportStar(require("./core/api-promise"), exports);

package/dist/client.d.ts

@@ -0,0 +1,225 @@
+import type { RequestInit, RequestInfo } from './internal/builtin-types';
+import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from './internal/types';
+export type { Logger, LogLevel } from './internal/utils/log';
+import * as Opts from './internal/request-options';
+import * as Errors from './core/error';
+import * as Uploads from './core/uploads';
+import * as API from './resources/index';
+import { APIPromise } from './core/api-promise';
+import { AccountGroupCreateParams, AccountGroupCreateResponse, AccountGroupListResponse, AccountGroupUpdateParams, AccountGroupUpdateResponse, AccountGroups } from './resources/account-groups';
+import { APIKeyCreateParams, APIKeyCreateResponse, APIKeyListParams, APIKeyListResponse, APIKeys } from './resources/api-keys';
+import { ConnectionListLogsParams, ConnectionListLogsResponse, Connections } from './resources/connections';
+import { Media, MediaGetPresignURLParams, MediaGetPresignURLResponse, MediaListParams, MediaListResponse, MediaRetrieveResponse, MediaUploadParams, MediaUploadResponse } from './resources/media';
+import { Reddit, RedditGetFeedParams, RedditGetFeedResponse, RedditSearchParams, RedditSearchResponse } from './resources/reddit';
+import { Usage, UsageRetrieveResponse } from './resources/usage';
+import { WebhookCreateParams, WebhookCreateResponse, WebhookListLogsParams, WebhookListLogsResponse, WebhookListParams, WebhookListResponse, WebhookSendTestParams, WebhookSendTestResponse, WebhookUpdateParams, WebhookUpdateResponse, Webhooks } from './resources/webhooks';
+import { AccountListParams, AccountListResponse, AccountRetrieveResponse, AccountUpdateParams, AccountUpdateResponse, Accounts } from './resources/accounts/accounts';
+import { Analytics, AnalyticsGetBestTimeParams, AnalyticsGetBestTimeResponse, AnalyticsGetContentDecayParams, AnalyticsGetContentDecayResponse, AnalyticsGetPostTimelineParams, AnalyticsGetPostTimelineResponse, AnalyticsGetPostingFrequencyParams, AnalyticsGetPostingFrequencyResponse, AnalyticsListDailyMetricsParams, AnalyticsListDailyMetricsResponse, AnalyticsRetrieveParams, AnalyticsRetrieveResponse } from './resources/analytics/analytics';
+import { Connect, ConnectCompleteOAuthCallbackParams, ConnectCompleteOAuthCallbackResponse, ConnectCreateBlueskyConnectionParams, ConnectCreateBlueskyConnectionResponse, ConnectFetchPendingDataParams, ConnectFetchPendingDataResponse, ConnectStartOAuthFlowParams, ConnectStartOAuthFlowResponse } from './resources/connect/connect';
+import { Inbox } from './resources/inbox/inbox';
+import { PostBulkCreateParams, PostBulkCreateResponse, PostCreateParams, PostCreateResponse, PostListParams, PostListResponse, PostRetrieveResponse, PostRetryResponse, PostUnpublishResponse, PostUpdateParams, PostUpdateResponse, Posts } from './resources/posts/posts';
+import { Queue, QueueGetNextSlotResponse, QueuePreviewParams, QueuePreviewResponse } from './resources/queue/queue';
+import { Tools } from './resources/tools/tools';
+import { Twitter } from './resources/twitter/twitter';
+import { Whatsapp, WhatsappBulkSendParams, WhatsappBulkSendResponse, WhatsappListPhoneNumbersParams, WhatsappListPhoneNumbersResponse } from './resources/whatsapp/whatsapp';
+import { type Fetch } from './internal/builtin-types';
+import { HeadersLike, NullableHeaders } from './internal/headers';
+import { FinalRequestOptions, RequestOptions } from './internal/request-options';
+import { type LogLevel, type Logger } from './internal/utils/log';
+export interface ClientOptions {
+    /**
+     * API key (rlay_live_* or rlay_test_*)
+     */
+    apiKey?: string | undefined;
+    /**
+     * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+     *
+     * Defaults to process.env['RELAY_BASE_URL'].
+     */
+    baseURL?: string | null | undefined;
+    /**
+     * The maximum amount of time (in milliseconds) that the client should wait for a response
+     * from the server before timing out a single request.
+     *
+     * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+     * much longer than this timeout before the promise succeeds or fails.
+     *
+     * @unit milliseconds
+     */
+    timeout?: number | undefined;
+    /**
+     * Additional `RequestInit` options to be passed to `fetch` calls.
+     * Properties will be overridden by per-request `fetchOptions`.
+     */
+    fetchOptions?: MergedRequestInit | undefined;
+    /**
+     * Specify a custom `fetch` function implementation.
+     *
+     * If not provided, we expect that `fetch` is defined globally.
+     */
+    fetch?: Fetch | undefined;
+    /**
+     * The maximum number of times that the client will retry a request in case of a
+     * temporary failure, like a network error or a 5XX error from the server.
+     *
+     * @default 2
+     */
+    maxRetries?: number | undefined;
+    /**
+     * Default headers to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * header to `null` in request options.
+     */
+    defaultHeaders?: HeadersLike | undefined;
+    /**
+     * Default query parameters to include with every request to the API.
+     *
+     * These can be removed in individual requests by explicitly setting the
+     * param to `undefined` in request options.
+     */
+    defaultQuery?: Record<string, string | undefined> | undefined;
+    /**
+     * Set the log level.
+     *
+     * Defaults to process.env['RELAY_LOG'] or 'warn' if it isn't set.
+     */
+    logLevel?: LogLevel | undefined;
+    /**
+     * Set the logger.
+     *
+     * Defaults to globalThis.console.
+     */
+    logger?: Logger | undefined;
+}
+/**
+ * API Client for interfacing with the Relay API.
+ */
+export declare class Relay {
+    #private;
+    apiKey: string;
+    baseURL: string;
+    maxRetries: number;
+    timeout: number;
+    logger: Logger;
+    logLevel: LogLevel | undefined;
+    fetchOptions: MergedRequestInit | undefined;
+    private fetch;
+    protected idempotencyHeader?: string;
+    private _options;
+    /**
+     * API Client for interfacing with the Relay API.
+     *
+     * @param {string | undefined} [opts.apiKey=process.env['RELAY_API_KEY'] ?? undefined]
+     * @param {string} [opts.baseURL=process.env['RELAY_BASE_URL'] ?? https://api.relayapi.dev] - Override the default base URL for the API.
+     * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+     * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
+     * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+     * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+     * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
+     * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
+     */
+    constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
+    /**
+     * Create a new client instance re-using the same options given to the current client with optional overriding.
+     */
+    withOptions(options: Partial<ClientOptions>): this;
+    protected defaultQuery(): Record<string, string | undefined> | undefined;
+    protected validateHeaders({ values, nulls }: NullableHeaders): void;
+    protected authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined>;
+    /**
+     * Basic re-implementation of `qs.stringify` for primitive types.
+     */
+    protected stringifyQuery(query: object | Record<string, unknown>): string;
+    private getUserAgent;
+    protected defaultIdempotencyKey(): string;
+    protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
+    buildURL(path: string, query: Record<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
+    /**
+     * Used as a callback for mutating the given `FinalRequestOptions` object.
+     */
+    protected prepareOptions(options: FinalRequestOptions): Promise<void>;
+    /**
+     * Used as a callback for mutating the given `RequestInit` object.
+     *
+     * This is useful for cases where you want to add certain headers based off of
+     * the request properties, e.g. `method` or `url`.
+     */
+    protected prepareRequest(request: RequestInit, { url, options }: {
+        url: string;
+        options: FinalRequestOptions;
+    }): Promise<void>;
+    get<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    post<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    patch<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    put<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    delete<Rsp>(path: string, opts?: PromiseOrValue<RequestOptions>): APIPromise<Rsp>;
+    private methodRequest;
+    request<Rsp>(options: PromiseOrValue<FinalRequestOptions>, remainingRetries?: number | null): APIPromise<Rsp>;
+    private makeRequest;
+    fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise<Response>;
+    private shouldRetry;
+    private retryRequest;
+    private calculateDefaultRetryTimeoutMillis;
+    buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: {
+        retryCount?: number;
+    }): Promise<{
+        req: FinalizedRequestInit;
+        url: string;
+        timeout: number;
+    }>;
+    private buildHeaders;
+    private _makeAbort;
+    private buildBody;
+    static Relay: typeof Relay;
+    static DEFAULT_TIMEOUT: number;
+    static RelayError: typeof Errors.RelayError;
+    static APIError: typeof Errors.APIError;
+    static APIConnectionError: typeof Errors.APIConnectionError;
+    static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError;
+    static APIUserAbortError: typeof Errors.APIUserAbortError;
+    static NotFoundError: typeof Errors.NotFoundError;
+    static ConflictError: typeof Errors.ConflictError;
+    static RateLimitError: typeof Errors.RateLimitError;
+    static BadRequestError: typeof Errors.BadRequestError;
+    static AuthenticationError: typeof Errors.AuthenticationError;
+    static InternalServerError: typeof Errors.InternalServerError;
+    static PermissionDeniedError: typeof Errors.PermissionDeniedError;
+    static UnprocessableEntityError: typeof Errors.UnprocessableEntityError;
+    static toFile: typeof Uploads.toFile;
+    posts: API.Posts;
+    accounts: API.Accounts;
+    media: API.Media;
+    webhooks: API.Webhooks;
+    apiKeys: API.APIKeys;
+    usage: API.Usage;
+    accountGroups: API.AccountGroups;
+    connect: API.Connect;
+    connections: API.Connections;
+    analytics: API.Analytics;
+    tools: API.Tools;
+    queue: API.Queue;
+    twitter: API.Twitter;
+    inbox: API.Inbox;
+    reddit: API.Reddit;
+    whatsapp: API.Whatsapp;
+}
+export declare namespace Relay {
+    export type RequestOptions = Opts.RequestOptions;
+    export { Posts as Posts, type PostCreateResponse as PostCreateResponse, type PostRetrieveResponse as PostRetrieveResponse, type PostUpdateResponse as PostUpdateResponse, type PostListResponse as PostListResponse, type PostBulkCreateResponse as PostBulkCreateResponse, type PostRetryResponse as PostRetryResponse, type PostUnpublishResponse as PostUnpublishResponse, type PostCreateParams as PostCreateParams, type PostUpdateParams as PostUpdateParams, type PostListParams as PostListParams, type PostBulkCreateParams as PostBulkCreateParams, };
+    export { Accounts as Accounts, type AccountRetrieveResponse as AccountRetrieveResponse, type AccountUpdateResponse as AccountUpdateResponse, type AccountListResponse as AccountListResponse, type AccountUpdateParams as AccountUpdateParams, type AccountListParams as AccountListParams, };
+    export { Media as Media, type MediaListResponse as MediaListResponse, type MediaRetrieveResponse as MediaRetrieveResponse, type MediaGetPresignURLResponse as MediaGetPresignURLResponse, type MediaUploadResponse as MediaUploadResponse, type MediaListParams as MediaListParams, type MediaGetPresignURLParams as MediaGetPresignURLParams, type MediaUploadParams as MediaUploadParams, };
+    export { Webhooks as Webhooks, 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, };
+    export { APIKeys as APIKeys, type APIKeyCreateResponse as APIKeyCreateResponse, type APIKeyListResponse as APIKeyListResponse, type APIKeyCreateParams as APIKeyCreateParams, type APIKeyListParams as APIKeyListParams, };
+    export { Usage as Usage, type UsageRetrieveResponse as UsageRetrieveResponse };
+    export { AccountGroups as AccountGroups, type AccountGroupCreateResponse as AccountGroupCreateResponse, type AccountGroupUpdateResponse as AccountGroupUpdateResponse, type AccountGroupListResponse as AccountGroupListResponse, type AccountGroupCreateParams as AccountGroupCreateParams, type AccountGroupUpdateParams as AccountGroupUpdateParams, };
+    export { Connect as Connect, type ConnectCompleteOAuthCallbackResponse as ConnectCompleteOAuthCallbackResponse, type ConnectCreateBlueskyConnectionResponse as ConnectCreateBlueskyConnectionResponse, type ConnectFetchPendingDataResponse as ConnectFetchPendingDataResponse, type ConnectStartOAuthFlowResponse as ConnectStartOAuthFlowResponse, type ConnectCompleteOAuthCallbackParams as ConnectCompleteOAuthCallbackParams, type ConnectCreateBlueskyConnectionParams as ConnectCreateBlueskyConnectionParams, type ConnectFetchPendingDataParams as ConnectFetchPendingDataParams, type ConnectStartOAuthFlowParams as ConnectStartOAuthFlowParams, };
+    export { Connections as Connections, type ConnectionListLogsResponse as ConnectionListLogsResponse, type ConnectionListLogsParams as ConnectionListLogsParams, };
+    export { Analytics as Analytics, type AnalyticsRetrieveResponse as AnalyticsRetrieveResponse, type AnalyticsGetBestTimeResponse as AnalyticsGetBestTimeResponse, type AnalyticsGetContentDecayResponse as AnalyticsGetContentDecayResponse, type AnalyticsGetPostTimelineResponse as AnalyticsGetPostTimelineResponse, type AnalyticsGetPostingFrequencyResponse as AnalyticsGetPostingFrequencyResponse, type AnalyticsListDailyMetricsResponse as AnalyticsListDailyMetricsResponse, type AnalyticsRetrieveParams as AnalyticsRetrieveParams, type AnalyticsGetBestTimeParams as AnalyticsGetBestTimeParams, type AnalyticsGetContentDecayParams as AnalyticsGetContentDecayParams, type AnalyticsGetPostTimelineParams as AnalyticsGetPostTimelineParams, type AnalyticsGetPostingFrequencyParams as AnalyticsGetPostingFrequencyParams, type AnalyticsListDailyMetricsParams as AnalyticsListDailyMetricsParams, };
+    export { Tools as Tools };
+    export { Queue as Queue, type QueueGetNextSlotResponse as QueueGetNextSlotResponse, type QueuePreviewResponse as QueuePreviewResponse, type QueuePreviewParams as QueuePreviewParams, };
+    export { Twitter as Twitter };
+    export { Inbox as Inbox };
+    export { Reddit as Reddit, type RedditGetFeedResponse as RedditGetFeedResponse, type RedditSearchResponse as RedditSearchResponse, type RedditGetFeedParams as RedditGetFeedParams, type RedditSearchParams as RedditSearchParams, };
+    export { Whatsapp as Whatsapp, type WhatsappBulkSendResponse as WhatsappBulkSendResponse, type WhatsappListPhoneNumbersResponse as WhatsappListPhoneNumbersResponse, type WhatsappBulkSendParams as WhatsappBulkSendParams, type WhatsappListPhoneNumbersParams as WhatsappListPhoneNumbersParams, };
+}