@relayapi/sdk 0.2.2

package/dist/resources/posts/posts.d.ts

@@ -0,0 +1,607 @@
+import { APIResource } from '../../core/resource';
+import * as LogsAPI from './logs';
+import { LogListParams, LogListResponse, LogRetrieveResponse, Logs } from './logs';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+export declare class Posts extends APIResource {
+    logs: LogsAPI.Logs;
+    /**
+     * Create a post. Use scheduled_at: "now" to publish immediately, "draft" to save
+     * as draft, or an ISO timestamp to schedule.
+     *
+     * @example
+     * ```ts
+     * const post = await client.posts.create({
+     *   scheduled_at: 'now',
+     *   targets: ['string'],
+     * });
+     * ```
+     */
+    create(body: PostCreateParams, options?: RequestOptions): APIPromise<PostCreateResponse>;
+    /**
+     * Get a post
+     *
+     * @example
+     * ```ts
+     * const post = await client.posts.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<PostRetrieveResponse>;
+    /**
+     * Update a draft or scheduled post.
+     *
+     * @example
+     * ```ts
+     * const post = await client.posts.update('id');
+     * ```
+     */
+    update(id: string, body?: PostUpdateParams | null | undefined, options?: RequestOptions): APIPromise<PostUpdateResponse>;
+    /**
+     * List posts
+     *
+     * @example
+     * ```ts
+     * const posts = await client.posts.list();
+     * ```
+     */
+    list(query?: PostListParams | null | undefined, options?: RequestOptions): APIPromise<PostListResponse>;
+    /**
+     * Delete a draft or scheduled post.
+     *
+     * @example
+     * ```ts
+     * await client.posts.delete('id');
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Create multiple posts in a single request. Each item follows the same schema as
+     * single post creation.
+     *
+     * @example
+     * ```ts
+     * const response = await client.posts.bulkCreate({
+     *   posts: [{ scheduled_at: 'now', targets: ['string'] }],
+     * });
+     * ```
+     */
+    bulkCreate(body: PostBulkCreateParams, options?: RequestOptions): APIPromise<PostBulkCreateResponse>;
+    /**
+     * Retry publishing for failed targets on a post.
+     *
+     * @example
+     * ```ts
+     * const response = await client.posts.retry('id');
+     * ```
+     */
+    retry(id: string, options?: RequestOptions): APIPromise<PostRetryResponse>;
+    /**
+     * Attempt to delete the post from each platform and set the post status to
+     * cancelled.
+     *
+     * @example
+     * ```ts
+     * const response = await client.posts.unpublish('id');
+     * ```
+     */
+    unpublish(id: string, options?: RequestOptions): APIPromise<PostUnpublishResponse>;
+}
+export interface PostCreateResponse {
+    /**
+     * Post ID
+     */
+    id: string;
+    content: string | null;
+    created_at: string;
+    media: Array<PostCreateResponse.Media> | null;
+    scheduled_at: string | null;
+    status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+    /**
+     * Per-target results
+     */
+    targets: {
+        [key: string]: PostCreateResponse.Targets;
+    };
+    updated_at: string;
+}
+export declare namespace PostCreateResponse {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+    interface Targets {
+        platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+        accounts?: Array<Targets.Account>;
+        error?: Targets.Error;
+    }
+    namespace Targets {
+        interface Account {
+            id: string;
+            /**
+             * Published post URL on the platform
+             */
+            url: string | null;
+            username: string | null;
+        }
+        interface Error {
+            code: string;
+            message: string;
+        }
+    }
+}
+export interface PostRetrieveResponse {
+    /**
+     * Post ID
+     */
+    id: string;
+    content: string | null;
+    created_at: string;
+    media: Array<PostRetrieveResponse.Media> | null;
+    scheduled_at: string | null;
+    status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+    /**
+     * Per-target results
+     */
+    targets: {
+        [key: string]: PostRetrieveResponse.Targets;
+    };
+    updated_at: string;
+}
+export declare namespace PostRetrieveResponse {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+    interface Targets {
+        platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+        accounts?: Array<Targets.Account>;
+        error?: Targets.Error;
+    }
+    namespace Targets {
+        interface Account {
+            id: string;
+            /**
+             * Published post URL on the platform
+             */
+            url: string | null;
+            username: string | null;
+        }
+        interface Error {
+            code: string;
+            message: string;
+        }
+    }
+}
+export interface PostUpdateResponse {
+    /**
+     * Post ID
+     */
+    id: string;
+    content: string | null;
+    created_at: string;
+    media: Array<PostUpdateResponse.Media> | null;
+    scheduled_at: string | null;
+    status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+    /**
+     * Per-target results
+     */
+    targets: {
+        [key: string]: PostUpdateResponse.Targets;
+    };
+    updated_at: string;
+}
+export declare namespace PostUpdateResponse {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+    interface Targets {
+        platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+        accounts?: Array<Targets.Account>;
+        error?: Targets.Error;
+    }
+    namespace Targets {
+        interface Account {
+            id: string;
+            /**
+             * Published post URL on the platform
+             */
+            url: string | null;
+            username: string | null;
+        }
+        interface Error {
+            code: string;
+            message: string;
+        }
+    }
+}
+export interface PostListResponse {
+    data: Array<PostListResponse.Data>;
+    /**
+     * Whether more items exist
+     */
+    has_more: boolean;
+    /**
+     * Cursor for next page
+     */
+    next_cursor: string | null;
+}
+export declare namespace PostListResponse {
+    interface Data {
+        /**
+         * Post ID
+         */
+        id: string;
+        content: string | null;
+        created_at: string;
+        media: Array<Data.Media> | null;
+        scheduled_at: string | null;
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+        /**
+         * Per-target results
+         */
+        targets: {
+            [key: string]: Data.Targets;
+        };
+        updated_at: string;
+    }
+    namespace Data {
+        interface Media {
+            /**
+             * Public URL of the media file
+             */
+            url: string;
+            /**
+             * Media type. Inferred from URL extension if omitted.
+             */
+            type?: 'image' | 'video' | 'gif' | 'document';
+        }
+        interface Targets {
+            platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+            status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+            accounts?: Array<Targets.Account>;
+            error?: Targets.Error;
+        }
+        namespace Targets {
+            interface Account {
+                id: string;
+                /**
+                 * Published post URL on the platform
+                 */
+                url: string | null;
+                username: string | null;
+            }
+            interface Error {
+                code: string;
+                message: string;
+            }
+        }
+    }
+}
+export interface PostBulkCreateResponse {
+    data: Array<PostBulkCreateResponse.Data>;
+    summary: PostBulkCreateResponse.Summary;
+}
+export declare namespace PostBulkCreateResponse {
+    interface Data {
+        /**
+         * Post ID
+         */
+        id: string;
+        content: string | null;
+        created_at: string;
+        media: Array<Data.Media> | null;
+        scheduled_at: string | null;
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+        /**
+         * Per-target results
+         */
+        targets: {
+            [key: string]: Data.Targets;
+        };
+        updated_at: string;
+    }
+    namespace Data {
+        interface Media {
+            /**
+             * Public URL of the media file
+             */
+            url: string;
+            /**
+             * Media type. Inferred from URL extension if omitted.
+             */
+            type?: 'image' | 'video' | 'gif' | 'document';
+        }
+        interface Targets {
+            platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+            status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+            accounts?: Array<Targets.Account>;
+            error?: Targets.Error;
+        }
+        namespace Targets {
+            interface Account {
+                id: string;
+                /**
+                 * Published post URL on the platform
+                 */
+                url: string | null;
+                username: string | null;
+            }
+            interface Error {
+                code: string;
+                message: string;
+            }
+        }
+    }
+    interface Summary {
+        failed: number;
+        succeeded: number;
+        total: number;
+    }
+}
+export interface PostRetryResponse {
+    /**
+     * Post ID
+     */
+    id: string;
+    content: string | null;
+    created_at: string;
+    media: Array<PostRetryResponse.Media> | null;
+    scheduled_at: string | null;
+    status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+    /**
+     * Per-target results
+     */
+    targets: {
+        [key: string]: PostRetryResponse.Targets;
+    };
+    updated_at: string;
+}
+export declare namespace PostRetryResponse {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+    interface Targets {
+        platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+        accounts?: Array<Targets.Account>;
+        error?: Targets.Error;
+    }
+    namespace Targets {
+        interface Account {
+            id: string;
+            /**
+             * Published post URL on the platform
+             */
+            url: string | null;
+            username: string | null;
+        }
+        interface Error {
+            code: string;
+            message: string;
+        }
+    }
+}
+export interface PostUnpublishResponse {
+    /**
+     * Post ID
+     */
+    id: string;
+    content: string | null;
+    created_at: string;
+    media: Array<PostUnpublishResponse.Media> | null;
+    scheduled_at: string | null;
+    status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'partial';
+    /**
+     * Per-target results
+     */
+    targets: {
+        [key: string]: PostUnpublishResponse.Targets;
+    };
+    updated_at: string;
+}
+export declare namespace PostUnpublishResponse {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+    interface Targets {
+        platform: 'twitter' | 'instagram' | 'facebook' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'reddit' | 'bluesky' | 'threads' | 'telegram' | 'snapchat' | 'googlebusiness' | 'whatsapp' | 'mastodon' | 'discord' | 'sms';
+        status: 'draft' | 'scheduled' | 'publishing' | 'published' | 'failed';
+        accounts?: Array<Targets.Account>;
+        error?: Targets.Error;
+    }
+    namespace Targets {
+        interface Account {
+            id: string;
+            /**
+             * Published post URL on the platform
+             */
+            url: string | null;
+            username: string | null;
+        }
+        interface Error {
+            code: string;
+            message: string;
+        }
+    }
+}
+export interface PostCreateParams {
+    /**
+     * Publish intent. Use "now" to publish immediately, "draft" to save as draft, or
+     * an ISO 8601 timestamp to schedule.
+     */
+    scheduled_at: string;
+    /**
+     * Account IDs or platform names to publish to
+     */
+    targets: Array<string>;
+    /**
+     * Post text. Optional if target_options provide per-target content.
+     */
+    content?: string;
+    /**
+     * Media attachments
+     */
+    media?: Array<PostCreateParams.Media>;
+    /**
+     * Per-target customizations keyed by target value (account ID or platform name)
+     */
+    target_options?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    /**
+     * IANA timezone for scheduling
+     */
+    timezone?: string;
+}
+export declare namespace PostCreateParams {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+}
+export interface PostUpdateParams {
+    /**
+     * Post text
+     */
+    content?: string;
+    /**
+     * Updated media
+     */
+    media?: Array<PostUpdateParams.Media>;
+    /**
+     * Publish intent. Use "now" to publish immediately, "draft" to save as draft, or
+     * an ISO 8601 timestamp to schedule.
+     */
+    scheduled_at?: string;
+    target_options?: {
+        [key: string]: {
+            [key: string]: unknown;
+        };
+    };
+    /**
+     * Updated targets
+     */
+    targets?: Array<string>;
+    timezone?: string;
+}
+export declare namespace PostUpdateParams {
+    interface Media {
+        /**
+         * Public URL of the media file
+         */
+        url: string;
+        /**
+         * Media type. Inferred from URL extension if omitted.
+         */
+        type?: 'image' | 'video' | 'gif' | 'document';
+    }
+}
+export interface PostListParams {
+    /**
+     * Pagination cursor
+     */
+    cursor?: string;
+    /**
+     * Number of items per page
+     */
+    limit?: number;
+}
+export interface PostBulkCreateParams {
+    /**
+     * Array of posts to create (max 50)
+     */
+    posts: Array<PostBulkCreateParams.Post>;
+}
+export declare namespace PostBulkCreateParams {
+    interface Post {
+        /**
+         * Publish intent. Use "now" to publish immediately, "draft" to save as draft, or
+         * an ISO 8601 timestamp to schedule.
+         */
+        scheduled_at: string;
+        /**
+         * Account IDs or platform names to publish to
+         */
+        targets: Array<string>;
+        /**
+         * Post text. Optional if target_options provide per-target content.
+         */
+        content?: string;
+        /**
+         * Media attachments
+         */
+        media?: Array<Post.Media>;
+        /**
+         * Per-target customizations keyed by target value (account ID or platform name)
+         */
+        target_options?: {
+            [key: string]: {
+                [key: string]: unknown;
+            };
+        };
+        /**
+         * IANA timezone for scheduling
+         */
+        timezone?: string;
+    }
+    namespace Post {
+        interface Media {
+            /**
+             * Public URL of the media file
+             */
+            url: string;
+            /**
+             * Media type. Inferred from URL extension if omitted.
+             */
+            type?: 'image' | 'video' | 'gif' | 'document';
+        }
+    }
+}
+export declare namespace Posts {
+    export { 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 { Logs as Logs, type LogRetrieveResponse as LogRetrieveResponse, type LogListResponse as LogListResponse, type LogListParams as LogListParams, };
+}