@cstar.help/js 0.18.1 → 0.18.2

package/README.md

@@ -483,14 +483,14 @@ const ticket = await cstar.tickets.create(
 For 24 hours, the same request with the same key returns the first successful
 response. The same key with a different body throws `CStarValidationError`
 (`idempotency_key_reused`, 422). While the first request is still running, the
-API answers `409 idempotency_key_in_use` with `Retry-After`. From 0.18.1
-(unreleased), the client waits and retries within `maxRetries`; 0.18.0 throws
+API answers `409 idempotency_key_in_use` with `Retry-After`. From 0.18.1, the client waits and retries within `maxRetries`; 0.18.0 throws
 `CStarConflictError`.
 
 The API ignores the key on `webhooks.create`, `webhooks.listen` and
-`export.create`, so a key does not make their retries safe: the client still
-retries a network error or 5xx. Leave the key off those calls (without one the
-client does not retry them), or use a client with `maxRetries: 0`. Check
+`export.create`, so a key does not make their retries safe. From 0.18.2 the
+client does not send the key on those calls and does not retry a network error
+or 5xx; 0.18.1 and earlier still retry them, so there leave the key off (without
+one the client does not retry them) or use a client with `maxRetries: 0`. Check
 `webhooks.list()` before you retry `webhooks.create`. A repeated `export.create`
 only reads your data again (nothing is stored). A repeated `webhooks.listen` is a
 second CLI listener: remove it with `webhooks.unlisten(id)`, or it is swept after

package/dist/chat/index.d.cts

@@ -1,4 +1,4 @@
-import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.cjs';
+import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-BHCahwev.cjs';
 
 /** Configuration for the ChatClient. */
 interface ChatConfig {

package/dist/chat/index.d.ts

@@ -1,4 +1,4 @@
-import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.js';
+import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-BHCahwev.js';
 
 /** Configuration for the ChatClient. */
 interface ChatConfig {

package/dist/community/index.d.cts

@@ -1,5 +1,5 @@
-import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.cjs';
-export { n as CommunityComment } from '../types-DF7GprCV.cjs';
+import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-BHCahwev.cjs';
+export { n as CommunityComment } from '../types-BHCahwev.cjs';
 export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.cjs';
 
 /**

package/dist/community/index.d.ts

@@ -1,5 +1,5 @@
-import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.js';
-export { n as CommunityComment } from '../types-DF7GprCV.js';
+import { h as CommunityConfig, i as CommunityTopic, j as CommunityPostListParams, k as CommunityPost, l as CommunityPostDetail, m as CommunitySearchResult, C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-BHCahwev.js';
+export { n as CommunityComment } from '../types-BHCahwev.js';
 export { A as ApiErrorBody, C as CStarAuthenticationError, a as CStarConflictError, b as CStarError, c as CStarFeatureDisabledError, d as CStarNotFoundError, e as CStarPermissionError, f as CStarRateLimitError, g as CStarRealtimeUnavailableError, h as CStarServerError, i as CStarValidationError, E as ErrorType, p as parseError, j as parsePublicError } from '../errors-bW8CwTn4.js';
 
 /**

package/dist/index.cjs

@@ -278,7 +278,7 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.18.1";
+var SDK_VERSION = "0.18.2";
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
@@ -1252,6 +1252,15 @@ var WebhooksResource = class extends BaseResource {
   constructor(client) {
     super(client, "/webhooks");
   }
+  /**
+   * Create a webhook endpoint. Its answer carries the signing secret, so the
+   * API keeps it out of the Idempotency-Key cache: an `idempotencyKey` is
+   * not sent, and a network error or 5xx is not retried, since the webhook
+   * may already exist. List webhooks before creating it again.
+   */
+  async create(params, _options) {
+    return this.client.request("POST", this.basePath, { body: params });
+  }
   /** Send a test delivery to a webhook endpoint. */
   async test(webhookId, params) {
     return this.client.request(
@@ -1286,11 +1295,14 @@ var WebhooksResource = class extends BaseResource {
   async unsubscribe(subscriptionId) {
     await this.client.request("DELETE", `/webhooks/subscribe/${subscriptionId}`);
   }
-  /** Register a CLI listener (returns listenerId and signing secret). */
-  async listen(params, options) {
+  /**
+   * Register a CLI listener (returns listenerId and signing secret). The API
+   * ignores Idempotency-Key here (the answer is a secret), so an
+   * `idempotencyKey` is not sent and a network error or 5xx is not retried.
+   */
+  async listen(params, _options) {
     return this.client.request("POST", "/webhooks/listen", {
-      body: params,
-      idempotencyKey: options?.idempotencyKey
+      body: params
     });
   }
   /** Deregister a CLI listener. */
@@ -1878,10 +1890,9 @@ var ExportResource = class {
   constructor(client) {
     this.client = client;
   }
-  async create(params, options) {
+  async create(params, _options) {
     return this.client.request("POST", "/export", {
       body: params,
-      idempotencyKey: options?.idempotencyKey,
       responseType: params.format === "csv" ? "text" : "json"
     });
   }

package/dist/index.d.cts

@@ -772,6 +772,13 @@ interface WebhookTriggerTestResult {
 /** Manage webhook endpoints. */
 declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams, WebhookCreateParams, WebhookUpdateParams> {
     constructor(client: HttpClient);
+    /**
+     * Create a webhook endpoint. Its answer carries the signing secret, so the
+     * API keeps it out of the Idempotency-Key cache: an `idempotencyKey` is
+     * not sent, and a network error or 5xx is not retried, since the webhook
+     * may already exist. List webhooks before creating it again.
+     */
+    create(params: WebhookCreateParams, _options?: RequestOptions): Promise<Webhook>;
     /** Send a test delivery to a webhook endpoint. */
     test(webhookId: string, params?: {
         event?: WebhookEventType;
@@ -784,8 +791,12 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     restSubscribe(params: WebhookSubscribeParams, options?: RequestOptions): Promise<ApiResponse<WebhookSubscription>>;
     /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
     unsubscribe(subscriptionId: string): Promise<void>;
-    /** Register a CLI listener (returns listenerId and signing secret). */
-    listen(params: WebhookListenerParams, options?: RequestOptions): Promise<ApiResponse<WebhookListener>>;
+    /**
+     * Register a CLI listener (returns listenerId and signing secret). The API
+     * ignores Idempotency-Key here (the answer is a secret), so an
+     * `idempotencyKey` is not sent and a network error or 5xx is not retried.
+     */
+    listen(params: WebhookListenerParams, _options?: RequestOptions): Promise<ApiResponse<WebhookListener>>;
     /** Deregister a CLI listener. */
     unlisten(listenerId: string): Promise<ApiResponse<{
         deleted: true;
@@ -2052,7 +2063,12 @@ interface ImportCreateParams {
      * read is named in `warnings`.
      */
     records: Record<string, unknown>[];
-    /** How to handle duplicates. Defaults to `'overwrite'`. */
+    /**
+     * What a customer row does when the team already has a customer with its
+     * email: `'skip'` (the default) leaves that customer alone and reports the
+     * row in `warnings`, `'overwrite'` updates it, `'merge'` fills only its
+     * empty fields. A row repeating an earlier row's email is skipped.
+     */
     mergeStrategy?: 'skip' | 'overwrite' | 'merge';
 }
 /** Import result. */
@@ -2107,7 +2123,11 @@ interface ImportLogListParams extends PaginationParams {
     resource?: 'tickets' | 'customers' | 'articles';
 }
 
-/** Export data from your team. */
+/**
+ * Export data from your team. The API ignores Idempotency-Key on exports, so
+ * `options.idempotencyKey` is accepted but not sent, and an export that
+ * fails with a network error or 5xx is not retried.
+ */
 declare class ExportResource {
     private readonly client;
     constructor(client: HttpClient);

package/dist/index.d.ts

@@ -772,6 +772,13 @@ interface WebhookTriggerTestResult {
 /** Manage webhook endpoints. */
 declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams, WebhookCreateParams, WebhookUpdateParams> {
     constructor(client: HttpClient);
+    /**
+     * Create a webhook endpoint. Its answer carries the signing secret, so the
+     * API keeps it out of the Idempotency-Key cache: an `idempotencyKey` is
+     * not sent, and a network error or 5xx is not retried, since the webhook
+     * may already exist. List webhooks before creating it again.
+     */
+    create(params: WebhookCreateParams, _options?: RequestOptions): Promise<Webhook>;
     /** Send a test delivery to a webhook endpoint. */
     test(webhookId: string, params?: {
         event?: WebhookEventType;
@@ -784,8 +791,12 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     restSubscribe(params: WebhookSubscribeParams, options?: RequestOptions): Promise<ApiResponse<WebhookSubscription>>;
     /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
     unsubscribe(subscriptionId: string): Promise<void>;
-    /** Register a CLI listener (returns listenerId and signing secret). */
-    listen(params: WebhookListenerParams, options?: RequestOptions): Promise<ApiResponse<WebhookListener>>;
+    /**
+     * Register a CLI listener (returns listenerId and signing secret). The API
+     * ignores Idempotency-Key here (the answer is a secret), so an
+     * `idempotencyKey` is not sent and a network error or 5xx is not retried.
+     */
+    listen(params: WebhookListenerParams, _options?: RequestOptions): Promise<ApiResponse<WebhookListener>>;
     /** Deregister a CLI listener. */
     unlisten(listenerId: string): Promise<ApiResponse<{
         deleted: true;
@@ -2052,7 +2063,12 @@ interface ImportCreateParams {
      * read is named in `warnings`.
      */
     records: Record<string, unknown>[];
-    /** How to handle duplicates. Defaults to `'overwrite'`. */
+    /**
+     * What a customer row does when the team already has a customer with its
+     * email: `'skip'` (the default) leaves that customer alone and reports the
+     * row in `warnings`, `'overwrite'` updates it, `'merge'` fills only its
+     * empty fields. A row repeating an earlier row's email is skipped.
+     */
     mergeStrategy?: 'skip' | 'overwrite' | 'merge';
 }
 /** Import result. */
@@ -2107,7 +2123,11 @@ interface ImportLogListParams extends PaginationParams {
     resource?: 'tickets' | 'customers' | 'articles';
 }
 
-/** Export data from your team. */
+/**
+ * Export data from your team. The API ignores Idempotency-Key on exports, so
+ * `options.idempotencyKey` is accepted but not sent, and an export that
+ * fails with a network error or 5xx is not retried.
+ */
 declare class ExportResource {
     private readonly client;
     constructor(client: HttpClient);

package/dist/index.js

@@ -237,7 +237,7 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.18.1";
+var SDK_VERSION = "0.18.2";
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
@@ -1211,6 +1211,15 @@ var WebhooksResource = class extends BaseResource {
   constructor(client) {
     super(client, "/webhooks");
   }
+  /**
+   * Create a webhook endpoint. Its answer carries the signing secret, so the
+   * API keeps it out of the Idempotency-Key cache: an `idempotencyKey` is
+   * not sent, and a network error or 5xx is not retried, since the webhook
+   * may already exist. List webhooks before creating it again.
+   */
+  async create(params, _options) {
+    return this.client.request("POST", this.basePath, { body: params });
+  }
   /** Send a test delivery to a webhook endpoint. */
   async test(webhookId, params) {
     return this.client.request(
@@ -1245,11 +1254,14 @@ var WebhooksResource = class extends BaseResource {
   async unsubscribe(subscriptionId) {
     await this.client.request("DELETE", `/webhooks/subscribe/${subscriptionId}`);
   }
-  /** Register a CLI listener (returns listenerId and signing secret). */
-  async listen(params, options) {
+  /**
+   * Register a CLI listener (returns listenerId and signing secret). The API
+   * ignores Idempotency-Key here (the answer is a secret), so an
+   * `idempotencyKey` is not sent and a network error or 5xx is not retried.
+   */
+  async listen(params, _options) {
     return this.client.request("POST", "/webhooks/listen", {
-      body: params,
-      idempotencyKey: options?.idempotencyKey
+      body: params
     });
   }
   /** Deregister a CLI listener. */
@@ -1837,10 +1849,9 @@ var ExportResource = class {
   constructor(client) {
     this.client = client;
   }
-  async create(params, options) {
+  async create(params, _options) {
     return this.client.request("POST", "/export", {
       body: params,
-      idempotencyKey: options?.idempotencyKey,
       responseType: params.format === "csv" ? "text" : "json"
     });
   }

package/dist/{types-DF7GprCV.d.cts → types-BHCahwev.d.cts}

@@ -1,4 +1,4 @@
-/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+/** Attachment metadata for community posts and comments (images only, max 4 MB each). */
 interface CommunityAttachment {
     filename: string;
     content_type: string;
@@ -30,7 +30,7 @@ interface CommunityCreatePostParams {
     topicId: string;
     /** Custom field values keyed by field definition ID. */
     customFields?: Record<string, string>;
-    /** Image attachments (max 10, images only, 5MB each). */
+    /** Image attachments (max 10, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a post as the original author. */
@@ -53,7 +53,7 @@ interface CommunityCreateCommentParams {
     body: string;
     /** Parent comment ID for replies (optional, 1-level nesting). */
     parentCommentId?: string | null;
-    /** Image attachments (max 5, images only, 5MB each). */
+    /** Image attachments (max 5, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Response from creating a post. */

package/dist/{types-DF7GprCV.d.ts → types-BHCahwev.d.ts}

@@ -1,4 +1,4 @@
-/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+/** Attachment metadata for community posts and comments (images only, max 4 MB each). */
 interface CommunityAttachment {
     filename: string;
     content_type: string;
@@ -30,7 +30,7 @@ interface CommunityCreatePostParams {
     topicId: string;
     /** Custom field values keyed by field definition ID. */
     customFields?: Record<string, string>;
-    /** Image attachments (max 10, images only, 5MB each). */
+    /** Image attachments (max 10, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Parameters for updating a post as the original author. */
@@ -53,7 +53,7 @@ interface CommunityCreateCommentParams {
     body: string;
     /** Parent comment ID for replies (optional, 1-level nesting). */
     parentCommentId?: string | null;
-    /** Image attachments (max 5, images only, 5MB each). */
+    /** Image attachments (max 5, images only, 4 MB each). */
     attachments?: CommunityAttachment[];
 }
 /** Response from creating a post. */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.18.1",
+	"version": "0.18.2",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",