@chirpie/sdk 1.0.10 → 1.0.12

package/dist/index.d.mts

@@ -102,6 +102,10 @@ interface CreatePostInput {
     account_id: string;
     text: string;
     media_urls?: string[];
+    /**
+     * ISO 8601 datetime to schedule the post (UTC). Must be in the future.
+     * Scheduled posts publish within ~5 minutes of this time.
+     */
     schedule_at?: string;
 }
 interface CreateThreadInput {
@@ -110,6 +114,10 @@ interface CreateThreadInput {
         text: string;
         media_urls?: string[];
     }[];
+    /**
+     * ISO 8601 datetime to schedule the entire thread (UTC). Must be in the future.
+     * Scheduled threads publish within ~5 minutes of this time.
+     */
     schedule_at?: string;
 }
 interface ListPostsOptions {
@@ -128,6 +136,18 @@ declare class ChirpieClient {
     private baseUrl;
     constructor(options: ChirpieClientOptions);
     private request;
+    /**
+     * Create a post (immediate or scheduled).
+     * If `schedule_at` is set, the post is queued and publishes within ~5 minutes
+     * of the scheduled time.
+     *
+     * @param input - Post payload including `account_id`, `text`, optional `media_urls`, and optional `schedule_at`.
+     * @returns The created post.
+     * @throws {ChirpieError} On network/transport failure.
+     * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+     *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+     *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+     */
     createPost(input: CreatePostInput): Promise<ApiPost>;
     listPosts(options?: ListPostsOptions): Promise<ApiPost[]>;
     getPost(id: string): Promise<ApiPost>;
@@ -135,6 +155,19 @@ declare class ChirpieClient {
         id: string;
         deleted: boolean;
     }>;
+    /**
+     * Create a thread (immediate or scheduled).
+     * If `schedule_at` is set, the thread is queued and publishes within ~5 minutes
+     * of the scheduled time. Threads publish atomically — if any post fails, the
+     * entire thread is retried.
+     *
+     * @param input - Thread payload including `account_id`, an array of `posts` (text + optional `media_urls`), and optional `schedule_at`.
+     * @returns The created thread, including each post's id and status.
+     * @throws {ChirpieError} On network/transport failure.
+     * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+     *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+     *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+     */
     createThread(input: CreateThreadInput): Promise<ApiThread>;
     listAccounts(): Promise<ApiAccount[]>;
     connectXAccount(): Promise<{

package/dist/index.d.ts

@@ -102,6 +102,10 @@ interface CreatePostInput {
     account_id: string;
     text: string;
     media_urls?: string[];
+    /**
+     * ISO 8601 datetime to schedule the post (UTC). Must be in the future.
+     * Scheduled posts publish within ~5 minutes of this time.
+     */
     schedule_at?: string;
 }
 interface CreateThreadInput {
@@ -110,6 +114,10 @@ interface CreateThreadInput {
         text: string;
         media_urls?: string[];
     }[];
+    /**
+     * ISO 8601 datetime to schedule the entire thread (UTC). Must be in the future.
+     * Scheduled threads publish within ~5 minutes of this time.
+     */
     schedule_at?: string;
 }
 interface ListPostsOptions {
@@ -128,6 +136,18 @@ declare class ChirpieClient {
     private baseUrl;
     constructor(options: ChirpieClientOptions);
     private request;
+    /**
+     * Create a post (immediate or scheduled).
+     * If `schedule_at` is set, the post is queued and publishes within ~5 minutes
+     * of the scheduled time.
+     *
+     * @param input - Post payload including `account_id`, `text`, optional `media_urls`, and optional `schedule_at`.
+     * @returns The created post.
+     * @throws {ChirpieError} On network/transport failure.
+     * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+     *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+     *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+     */
     createPost(input: CreatePostInput): Promise<ApiPost>;
     listPosts(options?: ListPostsOptions): Promise<ApiPost[]>;
     getPost(id: string): Promise<ApiPost>;
@@ -135,6 +155,19 @@ declare class ChirpieClient {
         id: string;
         deleted: boolean;
     }>;
+    /**
+     * Create a thread (immediate or scheduled).
+     * If `schedule_at` is set, the thread is queued and publishes within ~5 minutes
+     * of the scheduled time. Threads publish atomically — if any post fails, the
+     * entire thread is retried.
+     *
+     * @param input - Thread payload including `account_id`, an array of `posts` (text + optional `media_urls`), and optional `schedule_at`.
+     * @returns The created thread, including each post's id and status.
+     * @throws {ChirpieError} On network/transport failure.
+     * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+     *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+     *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+     */
     createThread(input: CreateThreadInput): Promise<ApiThread>;
     listAccounts(): Promise<ApiAccount[]>;
     connectXAccount(): Promise<{

package/dist/index.js

@@ -90,6 +90,18 @@ var ChirpieClient = class {
     return json.data;
   }
   // Posts
+  /**
+   * Create a post (immediate or scheduled).
+   * If `schedule_at` is set, the post is queued and publishes within ~5 minutes
+   * of the scheduled time.
+   *
+   * @param input - Post payload including `account_id`, `text`, optional `media_urls`, and optional `schedule_at`.
+   * @returns The created post.
+   * @throws {ChirpieError} On network/transport failure.
+   * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+   *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+   *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+   */
   async createPost(input) {
     return this.request("POST", "/posts", input);
   }
@@ -109,6 +121,19 @@ var ChirpieClient = class {
     return this.request("DELETE", `/posts/${id}`);
   }
   // Threads
+  /**
+   * Create a thread (immediate or scheduled).
+   * If `schedule_at` is set, the thread is queued and publishes within ~5 minutes
+   * of the scheduled time. Threads publish atomically — if any post fails, the
+   * entire thread is retried.
+   *
+   * @param input - Thread payload including `account_id`, an array of `posts` (text + optional `media_urls`), and optional `schedule_at`.
+   * @returns The created thread, including each post's id and status.
+   * @throws {ChirpieError} On network/transport failure.
+   * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+   *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+   *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+   */
   async createThread(input) {
     return this.request("POST", "/threads", input);
   }

package/dist/index.mjs

@@ -58,6 +58,18 @@ var ChirpieClient = class {
     return json.data;
   }
   // Posts
+  /**
+   * Create a post (immediate or scheduled).
+   * If `schedule_at` is set, the post is queued and publishes within ~5 minutes
+   * of the scheduled time.
+   *
+   * @param input - Post payload including `account_id`, `text`, optional `media_urls`, and optional `schedule_at`.
+   * @returns The created post.
+   * @throws {ChirpieError} On network/transport failure.
+   * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+   *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+   *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+   */
   async createPost(input) {
     return this.request("POST", "/posts", input);
   }
@@ -77,6 +89,19 @@ var ChirpieClient = class {
     return this.request("DELETE", `/posts/${id}`);
   }
   // Threads
+  /**
+   * Create a thread (immediate or scheduled).
+   * If `schedule_at` is set, the thread is queued and publishes within ~5 minutes
+   * of the scheduled time. Threads publish atomically — if any post fails, the
+   * entire thread is retried.
+   *
+   * @param input - Thread payload including `account_id`, an array of `posts` (text + optional `media_urls`), and optional `schedule_at`.
+   * @returns The created thread, including each post's id and status.
+   * @throws {ChirpieError} On network/transport failure.
+   * @throws {ChirpieApiError} On non-2xx responses (auth, validation, plan limit, platform error) or invalid JSON.
+   *   X posts whose text contains a link are billed at $0.25 each on paid plans, and are
+   *   rejected on the Free plan with code `x_link_posts_require_paid_plan` (HTTP 402).
+   */
   async createThread(input) {
     return this.request("POST", "/threads", input);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chirpie/sdk",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Chirpie SDK — TypeScript client for the Chirpie social media API",
   "repository": {
     "type": "git",