@relayapi/sdk 0.2.2

package/dist/resources/tools/validate.d.ts

@@ -0,0 +1,689 @@
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+export declare class Validate extends APIResource {
+    /**
+     * Check character counts against platform limits
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.tools.validate.checkPostLength({
+     *     content: 'content',
+     *   });
+     * ```
+     */
+    checkPostLength(body: ValidateCheckPostLengthParams, options?: RequestOptions): APIPromise<ValidateCheckPostLengthResponse>;
+    /**
+     * Check if a subreddit exists and get its details
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.tools.validate.retrieveSubreddit({
+     *     name: 'name',
+     *   });
+     * ```
+     */
+    retrieveSubreddit(query: ValidateRetrieveSubredditParams, options?: RequestOptions): APIPromise<ValidateRetrieveSubredditResponse>;
+    /**
+     * Validate a media URL for platform compatibility
+     *
+     * @example
+     * ```ts
+     * const response = await client.tools.validate.validateMedia({
+     *   url: 'https://example.com',
+     * });
+     * ```
+     */
+    validateMedia(body: ValidateValidateMediaParams, options?: RequestOptions): APIPromise<ValidateValidateMediaResponse>;
+    /**
+     * Validate a post (dry-run without publishing)
+     *
+     * @example
+     * ```ts
+     * const response = await client.tools.validate.validatePost({
+     *   scheduled_at: 'now',
+     *   targets: ['string'],
+     * });
+     * ```
+     */
+    validatePost(body: ValidateValidatePostParams, options?: RequestOptions): APIPromise<ValidateValidatePostResponse>;
+}
+export interface ValidateCheckPostLengthResponse {
+    /**
+     * Character count per platform
+     */
+    platforms: ValidateCheckPostLengthResponse.Platforms;
+}
+export declare namespace ValidateCheckPostLengthResponse {
+    /**
+     * Character count per platform
+     */
+    interface Platforms {
+        bluesky?: Platforms.Bluesky;
+        discord?: Platforms.Discord;
+        facebook?: Platforms.Facebook;
+        googlebusiness?: Platforms.Googlebusiness;
+        instagram?: Platforms.Instagram;
+        linkedin?: Platforms.Linkedin;
+        mastodon?: Platforms.Mastodon;
+        pinterest?: Platforms.Pinterest;
+        reddit?: Platforms.Reddit;
+        sms?: Platforms.SMS;
+        snapchat?: Platforms.Snapchat;
+        telegram?: Platforms.Telegram;
+        threads?: Platforms.Threads;
+        tiktok?: Platforms.Tiktok;
+        twitter?: Platforms.Twitter;
+        whatsapp?: Platforms.Whatsapp;
+        youtube?: Platforms.Youtube;
+    }
+    namespace Platforms {
+        interface Bluesky {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Discord {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Facebook {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Googlebusiness {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Instagram {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Linkedin {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Mastodon {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Pinterest {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Reddit {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface SMS {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Snapchat {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Telegram {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Threads {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Tiktok {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Twitter {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Whatsapp {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Youtube {
+            /**
+             * Character count for this platform
+             */
+            count: number;
+            /**
+             * Character limit for this platform
+             */
+            limit: number;
+            /**
+             * Whether content is within limit
+             */
+            within_limit: boolean;
+        }
+    }
+}
+export interface ValidateRetrieveSubredditResponse {
+    /**
+     * Whether the subreddit exists
+     */
+    exists: boolean;
+    /**
+     * Canonical subreddit name
+     */
+    name?: string | null;
+    /**
+     * Whether NSFW
+     */
+    nsfw?: boolean | null;
+    /**
+     * Allowed post types
+     */
+    post_types?: ValidateRetrieveSubredditResponse.PostTypes;
+    /**
+     * Subscriber count
+     */
+    subscribers?: number | null;
+    /**
+     * Subreddit title
+     */
+    title?: string | null;
+}
+export declare namespace ValidateRetrieveSubredditResponse {
+    /**
+     * Allowed post types
+     */
+    interface PostTypes {
+        /**
+         * Allows image posts
+         */
+        image: boolean;
+        /**
+         * Allows link posts
+         */
+        link: boolean;
+        /**
+         * Allows text posts
+         */
+        self: boolean;
+    }
+}
+export interface ValidateValidateMediaResponse {
+    /**
+     * Whether the URL is accessible
+     */
+    accessible: boolean;
+    /**
+     * Per-platform size limits
+     */
+    platform_limits: ValidateValidateMediaResponse.PlatformLimits;
+    /**
+     * MIME type
+     */
+    content_type?: string | null;
+    /**
+     * File size in bytes
+     */
+    size?: number | null;
+}
+export declare namespace ValidateValidateMediaResponse {
+    /**
+     * Per-platform size limits
+     */
+    interface PlatformLimits {
+        bluesky?: PlatformLimits.Bluesky;
+        discord?: PlatformLimits.Discord;
+        facebook?: PlatformLimits.Facebook;
+        googlebusiness?: PlatformLimits.Googlebusiness;
+        instagram?: PlatformLimits.Instagram;
+        linkedin?: PlatformLimits.Linkedin;
+        mastodon?: PlatformLimits.Mastodon;
+        pinterest?: PlatformLimits.Pinterest;
+        reddit?: PlatformLimits.Reddit;
+        sms?: PlatformLimits.SMS;
+        snapchat?: PlatformLimits.Snapchat;
+        telegram?: PlatformLimits.Telegram;
+        threads?: PlatformLimits.Threads;
+        tiktok?: PlatformLimits.Tiktok;
+        twitter?: PlatformLimits.Twitter;
+        whatsapp?: PlatformLimits.Whatsapp;
+        youtube?: PlatformLimits.Youtube;
+    }
+    namespace PlatformLimits {
+        interface Bluesky {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Discord {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Facebook {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Googlebusiness {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Instagram {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Linkedin {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Mastodon {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Pinterest {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Reddit {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface SMS {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Snapchat {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Telegram {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Threads {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Tiktok {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Twitter {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Whatsapp {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+        interface Youtube {
+            /**
+             * Maximum file size in bytes
+             */
+            max_size: number;
+            /**
+             * Whether file size is within limit
+             */
+            within_limit: boolean;
+        }
+    }
+}
+export interface ValidateValidatePostResponse {
+    /**
+     * Blocking errors
+     */
+    errors: Array<ValidateValidatePostResponse.Error>;
+    /**
+     * Whether the post is valid for all targets
+     */
+    valid: boolean;
+    /**
+     * Non-blocking warnings
+     */
+    warnings: Array<ValidateValidatePostResponse.Warning>;
+}
+export declare namespace ValidateValidatePostResponse {
+    interface Error {
+        /**
+         * Error code
+         */
+        code: string;
+        /**
+         * Human-readable error message
+         */
+        message: string;
+        /**
+         * Target identifier (account ID, platform, or field name)
+         */
+        target: string;
+    }
+    interface Warning {
+        /**
+         * Error code
+         */
+        code: string;
+        /**
+         * Human-readable error message
+         */
+        message: string;
+        /**
+         * Target identifier (account ID, platform, or field name)
+         */
+        target: string;
+    }
+}
+export interface ValidateCheckPostLengthParams {
+    /**
+     * Post content to check
+     */
+    content: string;
+}
+export interface ValidateRetrieveSubredditParams {
+    /**
+     * Subreddit name (without r/ prefix)
+     */
+    name: string;
+}
+export interface ValidateValidateMediaParams {
+    /**
+     * Media URL to validate
+     */
+    url: string;
+}
+export interface ValidateValidatePostParams {
+    /**
+     * 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<ValidateValidatePostParams.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 ValidateValidatePostParams {
+    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 Validate {
+    export { type ValidateCheckPostLengthResponse as ValidateCheckPostLengthResponse, type ValidateRetrieveSubredditResponse as ValidateRetrieveSubredditResponse, type ValidateValidateMediaResponse as ValidateValidateMediaResponse, type ValidateValidatePostResponse as ValidateValidatePostResponse, type ValidateCheckPostLengthParams as ValidateCheckPostLengthParams, type ValidateRetrieveSubredditParams as ValidateRetrieveSubredditParams, type ValidateValidateMediaParams as ValidateValidateMediaParams, type ValidateValidatePostParams as ValidateValidatePostParams, };
+}