@chirpie/sdk 1.0.11 → 1.0.13

package/dist/index.d.mts

@@ -31,9 +31,42 @@ interface ApiAccount {
     display_name: string | null;
     avatar_url: string | null;
     max_post_length: number;
+    /**
+     * X accounts only. True when the account was connected through your own X
+     * developer app, so its posts use your X API credits.
+     */
+    byo_keys?: boolean;
     is_active: boolean;
     created_at: string;
 }
+/** Status of your own X developer app. Never includes the client secret. */
+interface XKeysStatus {
+    configured: boolean;
+    label: string | null;
+    /** Last 4 characters of the stored client ID, to confirm which app is saved. */
+    client_id_last4: string | null;
+    /** The exact callback URI to register on your X app. */
+    redirect_uri: string;
+    created_at: string | null;
+    updated_at: string | null;
+}
+interface SetXKeysInput {
+    /** OAuth 2.0 Client ID from developer.x.com. */
+    client_id: string;
+    /** OAuth 2.0 Client Secret from developer.x.com. Stored encrypted. */
+    client_secret: string;
+    /** Optional human-readable name for the app. */
+    label?: string;
+}
+interface SetXKeysResult extends XKeysStatus {
+    required_scopes: string[];
+    message: string;
+}
+interface RemoveXKeysResult {
+    configured: false;
+    removed: true;
+    message: string;
+}
 interface ApiAnalytics {
     post_id: string;
     platform: Platform;
@@ -145,6 +178,8 @@ declare class ChirpieClient {
      * @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[]>;
@@ -163,6 +198,8 @@ declare class ChirpieClient {
      * @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[]>;
@@ -214,6 +251,26 @@ declare class ChirpieClient {
     connectAccount(): Promise<{
         authorization_url: string;
     }>;
+    /**
+     * Register your own X developer app so X accounts connect through it and
+     * post against your X API credits instead of Chirpie's. Link posts from
+     * accounts connected this way are not surcharged.
+     *
+     * Add the returned `redirect_uri` as a callback URI on your X app, then
+     * reconnect each X account you want to move onto your app — accounts that
+     * are already connected keep using whichever app connected them.
+     */
+    setXKeys(input: SetXKeysInput): Promise<SetXKeysResult>;
+    /**
+     * Remove your own X developer app. X accounts connected through it stop
+     * refreshing until you re-add the keys or reconnect them through Chirpie.
+     */
+    removeXKeys(): Promise<RemoveXKeysResult>;
+    /**
+     * Check whether your own X developer app is configured. Never returns the
+     * client secret.
+     */
+    getXKeysStatus(): Promise<XKeysStatus>;
     createKey(name?: string): Promise<{
         key: string;
         prefix: string;
@@ -259,4 +316,4 @@ declare function deleteConfig(): boolean;
  */
 declare function requireConfig(): ChirpieConfig;
 
-export { type ApiAccount, type ApiAnalytics, type ApiKeyInfo, type ApiPost, type ApiThread, ChirpieApiError, ChirpieClient, type ChirpieClientOptions, type ChirpieConfig, ChirpieError, type ConnectBlueskyInput, type ConnectFacebookInput, type ConnectGBPInput, type ConnectInstagramInput, type ConnectLinkedInInput, type ConnectMastodonInput, type ConnectPinterestInput, type ConnectRedditInput, type ConnectSnapchatInput, type ConnectTelegramInput, type ConnectThreadsInput, type ConnectTikTokInput, type ConnectYouTubeInput, type CreatePostInput, type CreateThreadInput, type ListPostsOptions, deleteConfig, getConfig, requireConfig, saveConfig };
+export { type ApiAccount, type ApiAnalytics, type ApiKeyInfo, type ApiPost, type ApiThread, ChirpieApiError, ChirpieClient, type ChirpieClientOptions, type ChirpieConfig, ChirpieError, type ConnectBlueskyInput, type ConnectFacebookInput, type ConnectGBPInput, type ConnectInstagramInput, type ConnectLinkedInInput, type ConnectMastodonInput, type ConnectPinterestInput, type ConnectRedditInput, type ConnectSnapchatInput, type ConnectTelegramInput, type ConnectThreadsInput, type ConnectTikTokInput, type ConnectYouTubeInput, type CreatePostInput, type CreateThreadInput, type ListPostsOptions, type RemoveXKeysResult, type SetXKeysInput, type SetXKeysResult, type XKeysStatus, deleteConfig, getConfig, requireConfig, saveConfig };

package/dist/index.d.ts

@@ -31,9 +31,42 @@ interface ApiAccount {
     display_name: string | null;
     avatar_url: string | null;
     max_post_length: number;
+    /**
+     * X accounts only. True when the account was connected through your own X
+     * developer app, so its posts use your X API credits.
+     */
+    byo_keys?: boolean;
     is_active: boolean;
     created_at: string;
 }
+/** Status of your own X developer app. Never includes the client secret. */
+interface XKeysStatus {
+    configured: boolean;
+    label: string | null;
+    /** Last 4 characters of the stored client ID, to confirm which app is saved. */
+    client_id_last4: string | null;
+    /** The exact callback URI to register on your X app. */
+    redirect_uri: string;
+    created_at: string | null;
+    updated_at: string | null;
+}
+interface SetXKeysInput {
+    /** OAuth 2.0 Client ID from developer.x.com. */
+    client_id: string;
+    /** OAuth 2.0 Client Secret from developer.x.com. Stored encrypted. */
+    client_secret: string;
+    /** Optional human-readable name for the app. */
+    label?: string;
+}
+interface SetXKeysResult extends XKeysStatus {
+    required_scopes: string[];
+    message: string;
+}
+interface RemoveXKeysResult {
+    configured: false;
+    removed: true;
+    message: string;
+}
 interface ApiAnalytics {
     post_id: string;
     platform: Platform;
@@ -145,6 +178,8 @@ declare class ChirpieClient {
      * @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[]>;
@@ -163,6 +198,8 @@ declare class ChirpieClient {
      * @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[]>;
@@ -214,6 +251,26 @@ declare class ChirpieClient {
     connectAccount(): Promise<{
         authorization_url: string;
     }>;
+    /**
+     * Register your own X developer app so X accounts connect through it and
+     * post against your X API credits instead of Chirpie's. Link posts from
+     * accounts connected this way are not surcharged.
+     *
+     * Add the returned `redirect_uri` as a callback URI on your X app, then
+     * reconnect each X account you want to move onto your app — accounts that
+     * are already connected keep using whichever app connected them.
+     */
+    setXKeys(input: SetXKeysInput): Promise<SetXKeysResult>;
+    /**
+     * Remove your own X developer app. X accounts connected through it stop
+     * refreshing until you re-add the keys or reconnect them through Chirpie.
+     */
+    removeXKeys(): Promise<RemoveXKeysResult>;
+    /**
+     * Check whether your own X developer app is configured. Never returns the
+     * client secret.
+     */
+    getXKeysStatus(): Promise<XKeysStatus>;
     createKey(name?: string): Promise<{
         key: string;
         prefix: string;
@@ -259,4 +316,4 @@ declare function deleteConfig(): boolean;
  */
 declare function requireConfig(): ChirpieConfig;
 
-export { type ApiAccount, type ApiAnalytics, type ApiKeyInfo, type ApiPost, type ApiThread, ChirpieApiError, ChirpieClient, type ChirpieClientOptions, type ChirpieConfig, ChirpieError, type ConnectBlueskyInput, type ConnectFacebookInput, type ConnectGBPInput, type ConnectInstagramInput, type ConnectLinkedInInput, type ConnectMastodonInput, type ConnectPinterestInput, type ConnectRedditInput, type ConnectSnapchatInput, type ConnectTelegramInput, type ConnectThreadsInput, type ConnectTikTokInput, type ConnectYouTubeInput, type CreatePostInput, type CreateThreadInput, type ListPostsOptions, deleteConfig, getConfig, requireConfig, saveConfig };
+export { type ApiAccount, type ApiAnalytics, type ApiKeyInfo, type ApiPost, type ApiThread, ChirpieApiError, ChirpieClient, type ChirpieClientOptions, type ChirpieConfig, ChirpieError, type ConnectBlueskyInput, type ConnectFacebookInput, type ConnectGBPInput, type ConnectInstagramInput, type ConnectLinkedInInput, type ConnectMastodonInput, type ConnectPinterestInput, type ConnectRedditInput, type ConnectSnapchatInput, type ConnectTelegramInput, type ConnectThreadsInput, type ConnectTikTokInput, type ConnectYouTubeInput, type CreatePostInput, type CreateThreadInput, type ListPostsOptions, type RemoveXKeysResult, type SetXKeysInput, type SetXKeysResult, type XKeysStatus, deleteConfig, getConfig, requireConfig, saveConfig };

package/dist/index.js

@@ -99,6 +99,8 @@ var ChirpieClient = class {
    * @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);
@@ -129,6 +131,8 @@ var ChirpieClient = class {
    * @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);
@@ -209,6 +213,33 @@ var ChirpieClient = class {
   async connectAccount() {
     return this.connectXAccount();
   }
+  // Your own X developer app ("bring your own keys")
+  /**
+   * Register your own X developer app so X accounts connect through it and
+   * post against your X API credits instead of Chirpie's. Link posts from
+   * accounts connected this way are not surcharged.
+   *
+   * Add the returned `redirect_uri` as a callback URI on your X app, then
+   * reconnect each X account you want to move onto your app — accounts that
+   * are already connected keep using whichever app connected them.
+   */
+  async setXKeys(input) {
+    return this.request("PUT", "/accounts/x/keys", input);
+  }
+  /**
+   * Remove your own X developer app. X accounts connected through it stop
+   * refreshing until you re-add the keys or reconnect them through Chirpie.
+   */
+  async removeXKeys() {
+    return this.request("DELETE", "/accounts/x/keys");
+  }
+  /**
+   * Check whether your own X developer app is configured. Never returns the
+   * client secret.
+   */
+  async getXKeysStatus() {
+    return this.request("GET", "/accounts/x/keys");
+  }
   // Keys
   async createKey(name) {
     return this.request(

package/dist/index.mjs

@@ -67,6 +67,8 @@ var ChirpieClient = class {
    * @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);
@@ -97,6 +99,8 @@ var ChirpieClient = class {
    * @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);
@@ -177,6 +181,33 @@ var ChirpieClient = class {
   async connectAccount() {
     return this.connectXAccount();
   }
+  // Your own X developer app ("bring your own keys")
+  /**
+   * Register your own X developer app so X accounts connect through it and
+   * post against your X API credits instead of Chirpie's. Link posts from
+   * accounts connected this way are not surcharged.
+   *
+   * Add the returned `redirect_uri` as a callback URI on your X app, then
+   * reconnect each X account you want to move onto your app — accounts that
+   * are already connected keep using whichever app connected them.
+   */
+  async setXKeys(input) {
+    return this.request("PUT", "/accounts/x/keys", input);
+  }
+  /**
+   * Remove your own X developer app. X accounts connected through it stop
+   * refreshing until you re-add the keys or reconnect them through Chirpie.
+   */
+  async removeXKeys() {
+    return this.request("DELETE", "/accounts/x/keys");
+  }
+  /**
+   * Check whether your own X developer app is configured. Never returns the
+   * client secret.
+   */
+  async getXKeysStatus() {
+    return this.request("GET", "/accounts/x/keys");
+  }
   // Keys
   async createKey(name) {
     return this.request(

package/package.json

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