@cstar.help/js 0.17.3 → 0.17.4

package/README.md

@@ -49,16 +49,16 @@ Manage tickets, customers, articles, team members, settings, game system, and ev
 ```typescript
 import { CStarClient } from '@cstar.help/js';
 
-const cstar = new CStarClient({
-	apiKey: process.env.CSTAR_SECRET_KEY, // sk_live_... or sk_test_...
-	teamId: process.env.CSTAR_TEAM_ID
-});
+const apiKey = process.env.CSTAR_SECRET_KEY; // sk_live_... or sk_test_...
+const teamId = process.env.CSTAR_TEAM_ID;
+if (!apiKey || !teamId) throw new Error('Set CSTAR_SECRET_KEY and CSTAR_TEAM_ID.');
+const cstar = new CStarClient({ apiKey, teamId });
 
 // List open tickets
 const { data: tickets } = await cstar.tickets.list({ status: 'open' });
 
 // Create a ticket
-const { data: ticket } = await cstar.tickets.create({
+const ticket = await cstar.tickets.create({
 	title: 'Help with billing',
 	customerId: 'cus_abc123'
 });
@@ -69,6 +69,8 @@ for await (const ticket of cstar.tickets.listAutoPaginating({ status: 'open' }))
 }
 ```
 
+Created, retrieved and updated resources are returned directly. List methods return `{ data, pagination, hasMore }`. Search returns `{ results, total, query }`. Read `cstar.lastMeta.requestId` immediately after a call when you need its request ID.
+
 ### Full Resource Reference
 
 **Core Resources** — Tickets, customers, and knowledge base.
@@ -167,14 +169,19 @@ await cstar.bulk.update({
 	data: { status: 'closed' }
 });
 
-// Export data
-const { data: exportResult } = await cstar.export.create({
-	resources: [{ type: 'tickets', filters: { status: 'closed' } }],
-	format: 'csv'
+// Export closed tickets as JSON with raw rows and per-resource counts
+const exported = await cstar.export.create({
+	resources: ['tickets'],
+	filters: { status: 'closed' },
+	format: 'json'
 });
+console.log(exported.summary.tickets);
+
+// CSV is text and supports one resource at a time
+const csv = await cstar.export.create({ resources: ['tickets'], format: 'csv' });
 
 // Saved views
-const { data: view } = await cstar.views.create({
+const view = await cstar.views.create({
 	name: 'Urgent Unresolved',
 	entityType: 'tickets',
 	filters: { priority: 'urgent', status: 'open' }
@@ -182,7 +189,7 @@ const { data: view } = await cstar.views.create({
 const { data: results } = await cstar.views.execute(view.id);
 
 // Search across everything
-const { data: searchResults } = await cstar.search.query({
+const { results: searchResults } = await cstar.search.query({
 	query: 'billing issue',
 	types: ['tickets', 'customers']
 });
@@ -448,7 +455,7 @@ try {
 Safely retry create/update operations:
 
 ```typescript
-const { data: ticket } = await cstar.tickets.create(
+const ticket = await cstar.tickets.create(
 	{ title: 'Billing issue', customerId: 'cus_abc' },
 	{ idempotencyKey: 'create-billing-issue-usr123' }
 );

package/dist/index.cjs

@@ -278,7 +278,7 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.17.3";
+var SDK_VERSION = "0.17.4";
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
@@ -384,8 +384,13 @@ var HttpClient = class {
       }
       if (response.ok) {
         if (response.status === 204) return void 0;
-        const json = await response.json();
         const headerRequestId = response.headers.get("x-request-id") ?? response.headers.get("x-cstar-request-id");
+        if (options?.responseType === "text") {
+          const text = await response.text();
+          this.captureMeta(null, headerRequestId);
+          return text;
+        }
+        const json = await response.json();
         this.captureMeta(json, headerRequestId);
         return this.unwrapEnvelope(json);
       }
@@ -1495,11 +1500,9 @@ var QuickRepliesResource = class {
   }
   /** Reorder quick replies. */
   async reorder(orderedIds) {
-    return this.client.request(
-      "PUT",
-      "/settings/quick-replies/reorder",
-      { body: { orderedIds } }
-    );
+    return this.client.request("PUT", "/settings/quick-replies/reorder", {
+      body: { orderedIds }
+    });
   }
 };
 var SettingsResource = class {
@@ -1673,9 +1676,13 @@ var CustomFieldsResource = class {
   }
   /** Reorder custom fields within a content type. */
   async reorder(contentType, orderedIds) {
-    return this.client.request("PUT", "/custom-fields/reorder", {
-      body: { contentType, orderedIds }
-    });
+    return this.client.request(
+      "PUT",
+      "/custom-fields/reorder",
+      {
+        body: { contentType, orderedIds }
+      }
+    );
   }
 };
 
@@ -1810,11 +1817,11 @@ var ExportResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** Create an export. Returns exported data synchronously. */
   async create(params, options) {
     return this.client.request("POST", "/export", {
       body: params,
-      idempotencyKey: options?.idempotencyKey
+      idempotencyKey: options?.idempotencyKey,
+      responseType: params.format === "csv" ? "text" : "json"
     });
   }
 };

package/dist/index.d.cts

@@ -79,6 +79,8 @@ interface FetchOptions {
     body?: unknown;
     query?: Record<string, string | string[] | number | boolean | undefined>;
     idempotencyKey?: string;
+    /** Decode successful downloads as text; error responses still use JSON. */
+    responseType?: 'json' | 'text';
 }
 /**
  * Low-level HTTP client for the cStar API.
@@ -708,7 +710,7 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     /** Fire a test webhook event to all active webhooks and CLI listeners. */
     triggerTest(params: WebhookTriggerTestParams, options?: RequestOptions): Promise<ApiResponse<WebhookTriggerTestResult>>;
     /** Get a sample webhook payload for an event type (used by Zapier). */
-    sample(event: string): Promise<ApiResponse<unknown[]>>;
+    sample(event: string): Promise<ListResponse<unknown>>;
     /** Subscribe to an event (REST Hooks / Zapier protocol). */
     restSubscribe(params: WebhookSubscribeParams, options?: RequestOptions): Promise<ApiResponse<WebhookSubscription>>;
     /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
@@ -847,7 +849,7 @@ declare class AutomationsResource extends BaseResource<AutomationRule, Automatio
     /** Toggle a rule's enabled state. */
     toggle(ruleId: string, enabled?: boolean): Promise<ApiResponse<AutomationRule>>;
     /** Reorder rules by providing an ordered array of IDs. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<AutomationRule[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<AutomationRule>>;
     /** Dry-run a rule against a specific resource (no actions executed). */
     test(ruleId: string, params: {
         resourceType: string;
@@ -1053,7 +1055,7 @@ declare class CommunityPostsResource extends BaseResource<CommunityPost, Communi
         following: boolean;
     }>>;
     /** List all comments on a post. */
-    listComments(postId: string): Promise<ApiResponse<CommunityComment[]>>;
+    listComments(postId: string): Promise<ListResponse<CommunityComment>>;
     /** Add a comment to a post. */
     createComment(postId: string, params: CommunityCommentCreateParams): Promise<ApiResponse<CommunityComment>>;
 }
@@ -1282,7 +1284,7 @@ declare class StatusesResource {
     private readonly client;
     constructor(client: HttpClient);
     /** List all statuses. */
-    list(): Promise<ApiResponse<TicketStatus[]>>;
+    list(): Promise<ListResponse<TicketStatus>>;
     /** Create a new status. */
     create(params: StatusCreateParams, options?: RequestOptions): Promise<ApiResponse<TicketStatus>>;
     /** Update a status. */
@@ -1290,14 +1292,14 @@ declare class StatusesResource {
     /** Delete a status. */
     del(statusKey: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder statuses. */
-    reorder(orderedKeys: string[]): Promise<ApiResponse<TicketStatus[]>>;
+    reorder(orderedKeys: string[]): Promise<ListResponse<TicketStatus>>;
 }
 /** Manage quick reply templates. */
 declare class QuickRepliesResource {
     private readonly client;
     constructor(client: HttpClient);
     /** List all quick replies. */
-    list(): Promise<ApiResponse<QuickReply[]>>;
+    list(): Promise<ListResponse<QuickReply>>;
     /** Create a new quick reply. */
     create(params: QuickReplyCreateParams, options?: RequestOptions): Promise<ApiResponse<QuickReply>>;
     /** Update a quick reply. */
@@ -1305,7 +1307,7 @@ declare class QuickRepliesResource {
     /** Delete a quick reply. */
     del(replyId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder quick replies. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<QuickReply[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<QuickReply>>;
 }
 /** Manage team settings. */
 declare class SettingsResource {
@@ -1500,7 +1502,10 @@ declare class CustomFieldsResource {
     /** Delete a custom field. */
     del(fieldId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder custom fields within a content type. */
-    reorder(contentType: 'ticket' | 'customer' | 'article', orderedIds: string[]): Promise<ApiResponse<CustomField[]>>;
+    reorder(contentType: 'ticket' | 'customer' | 'article', orderedIds: string[]): Promise<{
+        success: true;
+        reordered: number;
+    }>;
 }
 
 /** An SLA rule. */
@@ -1569,7 +1574,7 @@ declare class SlaResource {
     /** Delete an SLA rule. */
     del(ruleId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder SLA rules by providing an ordered array of IDs. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<SlaRule[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<SlaRule>>;
     /** Get SLA compliance metrics. */
     metrics(params?: SlaMetricsParams): Promise<ApiResponse<SlaMetrics>>;
 }
@@ -1744,20 +1749,41 @@ declare class BulkResource {
     del(params: BulkDeleteParams, options?: RequestOptions): Promise<ApiResponse<BulkResult>>;
 }
 
-/** Export request parameters. */
-interface ExportCreateParams {
-    resources: Array<{
-        type: 'tickets' | 'customers' | 'articles';
-        filters?: Record<string, unknown>;
-    }>;
-    format?: 'json' | 'csv';
-}
-/** Export response. */
+/** Resource tables supported by the export endpoint. */
+type ExportResourceType = 'tickets' | 'customers' | 'articles';
+/** Filters shared by all selected resources. */
+interface ExportFilters {
+    status?: string;
+    priority?: string;
+    createdAfter?: string;
+    createdBefore?: string;
+}
+/** JSON may export multiple resources or default to all three. */
+interface ExportJsonParams {
+    resources?: readonly [ExportResourceType, ...ExportResourceType[]];
+    format?: 'json';
+    filters?: ExportFilters;
+}
+/** CSV must select exactly one resource, including when passed through a helper. */
+interface ExportCsvParams {
+    resources: readonly [ExportResourceType];
+    format: 'csv';
+    filters?: ExportFilters;
+}
+/** Export parameters preserve the relationship between format and resources. */
+type ExportCreateParams = ExportJsonParams | ExportCsvParams;
+/** JSON export with raw database rows, unlike the mapped API resource objects. */
 interface ExportResult {
     object: 'export';
-    format: string;
-    resources: Record<string, unknown[]> | string;
-    totalRows: number;
+    format: 'json';
+    exportedAt: string;
+    teamId: string;
+    tickets?: Record<string, unknown>[];
+    customers?: Record<string, unknown>[];
+    articles?: Record<string, unknown>[];
+    /** Included when the selected tickets have messages. */
+    messages?: Record<string, unknown>[];
+    summary: Partial<Record<ExportResourceType | 'messages', number>>;
 }
 
 /** Import request parameters. */
@@ -1828,8 +1854,12 @@ interface ImportLogListParams extends PaginationParams {
 declare class ExportResource {
     private readonly client;
     constructor(client: HttpClient);
-    /** Create an export. Returns exported data synchronously. */
-    create(params: ExportCreateParams, options?: RequestOptions): Promise<ApiResponse<ExportResult>>;
+    /** Create a CSV export. The API returns text for a single resource. */
+    create(params: ExportCsvParams, options?: RequestOptions): Promise<string>;
+    /** Create a JSON export with raw rows and per-resource counts. */
+    create(params: ExportJsonParams, options?: RequestOptions): Promise<ExportResult>;
+    /** A runtime-selected format returns JSON or CSV text accordingly. */
+    create(params: ExportCreateParams, options?: RequestOptions): Promise<ExportResult | string>;
 }
 /** Import data into your team. */
 declare class ImportResource {
@@ -1893,13 +1923,19 @@ interface SearchParams {
     types?: Array<'tickets' | 'customers' | 'articles'>;
     limit?: number;
 }
+/** Cross-resource search results with the original query and returned count. */
+interface SearchResponse {
+    results: SearchResult[];
+    total: number;
+    query: string;
+}
 
 /** Search across tickets, customers, and articles. */
 declare class SearchResource {
     private readonly client;
     constructor(client: HttpClient);
     /** Perform a cross-resource search. */
-    query(params: SearchParams): Promise<ApiResponse<SearchResult[]>>;
+    query(params: SearchParams): Promise<SearchResponse>;
 }
 
 /** A tag with usage count. */
@@ -2489,7 +2525,7 @@ declare class AchievementsResource {
     /** List unlocked achievements only. */
     unlocked(params?: {
         userId: string;
-    }): Promise<ApiResponse<Achievement[]>>;
+    }): Promise<ListResponse<Achievement>>;
     /** Get a single achievement. */
     get(achievementId: string, params?: {
         userId?: string;
@@ -2909,7 +2945,7 @@ interface CStarClientConfig {
  * viewing your site.
  *
  * For client-side integrations, use:
- * - `@cstar.help/js/chat` — Customer chat widget (publishable key)
+ * - `@cstar.help/js/chat` — Customer chat widget (HMAC or customer session)
  * - `@cstar.help/js/library` — Public knowledge base (no auth)
  * - `@cstar.help/js/community` — Public community forum (no auth)
  *
@@ -3037,4 +3073,4 @@ declare class CStarClient {
     get lastMeta(): LastMeta;
 }
 
-export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
+export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };

package/dist/index.d.ts

@@ -79,6 +79,8 @@ interface FetchOptions {
     body?: unknown;
     query?: Record<string, string | string[] | number | boolean | undefined>;
     idempotencyKey?: string;
+    /** Decode successful downloads as text; error responses still use JSON. */
+    responseType?: 'json' | 'text';
 }
 /**
  * Low-level HTTP client for the cStar API.
@@ -708,7 +710,7 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     /** Fire a test webhook event to all active webhooks and CLI listeners. */
     triggerTest(params: WebhookTriggerTestParams, options?: RequestOptions): Promise<ApiResponse<WebhookTriggerTestResult>>;
     /** Get a sample webhook payload for an event type (used by Zapier). */
-    sample(event: string): Promise<ApiResponse<unknown[]>>;
+    sample(event: string): Promise<ListResponse<unknown>>;
     /** Subscribe to an event (REST Hooks / Zapier protocol). */
     restSubscribe(params: WebhookSubscribeParams, options?: RequestOptions): Promise<ApiResponse<WebhookSubscription>>;
     /** Unsubscribe from an event (REST Hooks / Zapier protocol). Returns void (204 No Content). */
@@ -847,7 +849,7 @@ declare class AutomationsResource extends BaseResource<AutomationRule, Automatio
     /** Toggle a rule's enabled state. */
     toggle(ruleId: string, enabled?: boolean): Promise<ApiResponse<AutomationRule>>;
     /** Reorder rules by providing an ordered array of IDs. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<AutomationRule[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<AutomationRule>>;
     /** Dry-run a rule against a specific resource (no actions executed). */
     test(ruleId: string, params: {
         resourceType: string;
@@ -1053,7 +1055,7 @@ declare class CommunityPostsResource extends BaseResource<CommunityPost, Communi
         following: boolean;
     }>>;
     /** List all comments on a post. */
-    listComments(postId: string): Promise<ApiResponse<CommunityComment[]>>;
+    listComments(postId: string): Promise<ListResponse<CommunityComment>>;
     /** Add a comment to a post. */
     createComment(postId: string, params: CommunityCommentCreateParams): Promise<ApiResponse<CommunityComment>>;
 }
@@ -1282,7 +1284,7 @@ declare class StatusesResource {
     private readonly client;
     constructor(client: HttpClient);
     /** List all statuses. */
-    list(): Promise<ApiResponse<TicketStatus[]>>;
+    list(): Promise<ListResponse<TicketStatus>>;
     /** Create a new status. */
     create(params: StatusCreateParams, options?: RequestOptions): Promise<ApiResponse<TicketStatus>>;
     /** Update a status. */
@@ -1290,14 +1292,14 @@ declare class StatusesResource {
     /** Delete a status. */
     del(statusKey: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder statuses. */
-    reorder(orderedKeys: string[]): Promise<ApiResponse<TicketStatus[]>>;
+    reorder(orderedKeys: string[]): Promise<ListResponse<TicketStatus>>;
 }
 /** Manage quick reply templates. */
 declare class QuickRepliesResource {
     private readonly client;
     constructor(client: HttpClient);
     /** List all quick replies. */
-    list(): Promise<ApiResponse<QuickReply[]>>;
+    list(): Promise<ListResponse<QuickReply>>;
     /** Create a new quick reply. */
     create(params: QuickReplyCreateParams, options?: RequestOptions): Promise<ApiResponse<QuickReply>>;
     /** Update a quick reply. */
@@ -1305,7 +1307,7 @@ declare class QuickRepliesResource {
     /** Delete a quick reply. */
     del(replyId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder quick replies. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<QuickReply[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<QuickReply>>;
 }
 /** Manage team settings. */
 declare class SettingsResource {
@@ -1500,7 +1502,10 @@ declare class CustomFieldsResource {
     /** Delete a custom field. */
     del(fieldId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder custom fields within a content type. */
-    reorder(contentType: 'ticket' | 'customer' | 'article', orderedIds: string[]): Promise<ApiResponse<CustomField[]>>;
+    reorder(contentType: 'ticket' | 'customer' | 'article', orderedIds: string[]): Promise<{
+        success: true;
+        reordered: number;
+    }>;
 }
 
 /** An SLA rule. */
@@ -1569,7 +1574,7 @@ declare class SlaResource {
     /** Delete an SLA rule. */
     del(ruleId: string): Promise<ApiResponse<DeleteResponse>>;
     /** Reorder SLA rules by providing an ordered array of IDs. */
-    reorder(orderedIds: string[]): Promise<ApiResponse<SlaRule[]>>;
+    reorder(orderedIds: string[]): Promise<ListResponse<SlaRule>>;
     /** Get SLA compliance metrics. */
     metrics(params?: SlaMetricsParams): Promise<ApiResponse<SlaMetrics>>;
 }
@@ -1744,20 +1749,41 @@ declare class BulkResource {
     del(params: BulkDeleteParams, options?: RequestOptions): Promise<ApiResponse<BulkResult>>;
 }
 
-/** Export request parameters. */
-interface ExportCreateParams {
-    resources: Array<{
-        type: 'tickets' | 'customers' | 'articles';
-        filters?: Record<string, unknown>;
-    }>;
-    format?: 'json' | 'csv';
-}
-/** Export response. */
+/** Resource tables supported by the export endpoint. */
+type ExportResourceType = 'tickets' | 'customers' | 'articles';
+/** Filters shared by all selected resources. */
+interface ExportFilters {
+    status?: string;
+    priority?: string;
+    createdAfter?: string;
+    createdBefore?: string;
+}
+/** JSON may export multiple resources or default to all three. */
+interface ExportJsonParams {
+    resources?: readonly [ExportResourceType, ...ExportResourceType[]];
+    format?: 'json';
+    filters?: ExportFilters;
+}
+/** CSV must select exactly one resource, including when passed through a helper. */
+interface ExportCsvParams {
+    resources: readonly [ExportResourceType];
+    format: 'csv';
+    filters?: ExportFilters;
+}
+/** Export parameters preserve the relationship between format and resources. */
+type ExportCreateParams = ExportJsonParams | ExportCsvParams;
+/** JSON export with raw database rows, unlike the mapped API resource objects. */
 interface ExportResult {
     object: 'export';
-    format: string;
-    resources: Record<string, unknown[]> | string;
-    totalRows: number;
+    format: 'json';
+    exportedAt: string;
+    teamId: string;
+    tickets?: Record<string, unknown>[];
+    customers?: Record<string, unknown>[];
+    articles?: Record<string, unknown>[];
+    /** Included when the selected tickets have messages. */
+    messages?: Record<string, unknown>[];
+    summary: Partial<Record<ExportResourceType | 'messages', number>>;
 }
 
 /** Import request parameters. */
@@ -1828,8 +1854,12 @@ interface ImportLogListParams extends PaginationParams {
 declare class ExportResource {
     private readonly client;
     constructor(client: HttpClient);
-    /** Create an export. Returns exported data synchronously. */
-    create(params: ExportCreateParams, options?: RequestOptions): Promise<ApiResponse<ExportResult>>;
+    /** Create a CSV export. The API returns text for a single resource. */
+    create(params: ExportCsvParams, options?: RequestOptions): Promise<string>;
+    /** Create a JSON export with raw rows and per-resource counts. */
+    create(params: ExportJsonParams, options?: RequestOptions): Promise<ExportResult>;
+    /** A runtime-selected format returns JSON or CSV text accordingly. */
+    create(params: ExportCreateParams, options?: RequestOptions): Promise<ExportResult | string>;
 }
 /** Import data into your team. */
 declare class ImportResource {
@@ -1893,13 +1923,19 @@ interface SearchParams {
     types?: Array<'tickets' | 'customers' | 'articles'>;
     limit?: number;
 }
+/** Cross-resource search results with the original query and returned count. */
+interface SearchResponse {
+    results: SearchResult[];
+    total: number;
+    query: string;
+}
 
 /** Search across tickets, customers, and articles. */
 declare class SearchResource {
     private readonly client;
     constructor(client: HttpClient);
     /** Perform a cross-resource search. */
-    query(params: SearchParams): Promise<ApiResponse<SearchResult[]>>;
+    query(params: SearchParams): Promise<SearchResponse>;
 }
 
 /** A tag with usage count. */
@@ -2489,7 +2525,7 @@ declare class AchievementsResource {
     /** List unlocked achievements only. */
     unlocked(params?: {
         userId: string;
-    }): Promise<ApiResponse<Achievement[]>>;
+    }): Promise<ListResponse<Achievement>>;
     /** Get a single achievement. */
     get(achievementId: string, params?: {
         userId?: string;
@@ -2909,7 +2945,7 @@ interface CStarClientConfig {
  * viewing your site.
  *
  * For client-side integrations, use:
- * - `@cstar.help/js/chat` — Customer chat widget (publishable key)
+ * - `@cstar.help/js/chat` — Customer chat widget (HMAC or customer session)
  * - `@cstar.help/js/library` — Public knowledge base (no auth)
  * - `@cstar.help/js/community` — Public community forum (no auth)
  *
@@ -3037,4 +3073,4 @@ declare class CStarClient {
     get lastMeta(): LastMeta;
 }
 
-export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };
+export { type Achievement, type AchievementListParams, type ActivityEvent, type ActivityListParams, type AiAction, type AiActionParams, type AiActionResult, type AnalyticsOverview, type AnalyticsParams, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, type Attachment, type AttachmentListParams, type AuditLogEntry, type AuditLogListParams, type AutomationAction, type AutomationCondition, type AutomationConditions, type AutomationCreateParams, type AutomationExecution, type AutomationExecutionListParams, type AutomationListParams, type AutomationRule, type AutomationTestResult, type AutomationUpdateParams, type BillingPortal, type BillingPortalParams, type Boss, type BossDamageParams, type BossDamageResult, type BossDefeat, type BossDefeatListParams, type BossSpawnParams, type BulkDeleteParams, type BulkResult, type BulkUpdateParams, type BusinessHours, type BusinessHoursUpdateParams, CStarClient, type CStarClientConfig, CStarRealtime, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type ConnectionHandler, type Cosmetic, type CosmeticListParams, type CosmeticPreferences, type CsatSettings, type CsatSettingsUpdateParams, type CsatStats, type CsatSurvey, type CsatSurveyCreateParams, type CsatSurveyListParams, type CurrentSeason, type CustomField, type CustomFieldCreateParams, type CustomFieldListParams, type CustomFieldUpdateParams, type Customer, type CustomerCreateParams, type CustomerGroup, type CustomerGroupAddMembersParams, type CustomerGroupAddResult, type CustomerGroupCreateParams, type CustomerGroupListParams, type CustomerGroupMemberListParams, type CustomerGroupMembersResult, type CustomerGroupRemoveResult, type CustomerGroupUpdateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, type ErrorHandler, type EventHandler, type ExportCreateParams, type ExportCsvParams, type ExportFilters, type ExportJsonParams, type ExportResourceType, type ExportResult, type GameConfig, type HighFive, type HighFiveCanSend, type HighFiveCreateParams, type HighFiveListParams, type ImportCreateParams, type ImportLog, type ImportLogListParams, type ImportResult, type Invite, type InviteCreateParams, type InviteListParams, type LeaderboardEntry, type LeaderboardParams, type ListResponse, type Member, type MemberListParams, type MemberUpdateParams, type Mention, type MentionListParams, type MentionUnreadCount, type Message, type MessageCreateParams, type Metadata, type Notification, type NotificationListParams, OfflineQueue, type OfflineQueueOptions, type OneUp, type OneUpCreateParams, type OneUpListParams, type OneUpRemaining, type OneUpSendResult, type PaginationInfo, type PaginationParams, type Player, type Puzzle, type PuzzleCompleteParams, type PuzzleCompleteResult, type PuzzleLeaderboardParams, type PuzzleLeaderboardResult, type PuzzleStreak, type Quest, type QuestHistory, type QuestHistoryParams, type QuestList, type QueueItem, type QueueResult, type QuickReply, type QuickReplyCreateParams, type QuickReplyUpdateParams, type RealtimeEvent, type RealtimeOptions, type RequestOptions, type SavedView, type SearchParams, type SearchResponse, type SearchResult, type Season, type SeasonStats, type SkillAllocateParams, type SkillAllocateResult, type SkillTree, type SlaMetrics, type SlaMetricsParams, type SlaRule, type SlaRuleCreateParams, type SlaRuleListParams, type SlaRuleUpdateParams, type StatusCreateParams, type StatusUpdateParams, Subscription$1 as Subscription, type Tag, type TagListParams, type TeamSettings, type TeamSettingsUpdateParams, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketStatus, type TicketUpdateParams, type TopicCustomField, type UnreadCount, type ViewCreateParams, type ViewExecuteParams, type ViewListParams, type ViewUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEventData, WebhookEventType, type WebhookListParams, type WebhookListener, type WebhookListenerParams, type WebhookSubscribeParams, type WebhookSubscription, type WebhookTestResult, type WebhookTriggerTestParams, type WebhookTriggerTestResult, type WebhookUpdateParams, type WidgetSettings, type WidgetSettingsUpdateParams };

package/dist/index.js

@@ -237,7 +237,7 @@ function parseError(statusCode, body, retryAfter) {
 }
 
 // src/client.ts
-var SDK_VERSION = "0.17.3";
+var SDK_VERSION = "0.17.4";
 var DEFAULT_BASE_URL = "https://www.cstar.help";
 var DEFAULT_API_VERSION = "2026-03-01";
 var DEFAULT_MAX_RETRIES = 3;
@@ -343,8 +343,13 @@ var HttpClient = class {
       }
       if (response.ok) {
         if (response.status === 204) return void 0;
-        const json = await response.json();
         const headerRequestId = response.headers.get("x-request-id") ?? response.headers.get("x-cstar-request-id");
+        if (options?.responseType === "text") {
+          const text = await response.text();
+          this.captureMeta(null, headerRequestId);
+          return text;
+        }
+        const json = await response.json();
         this.captureMeta(json, headerRequestId);
         return this.unwrapEnvelope(json);
       }
@@ -1454,11 +1459,9 @@ var QuickRepliesResource = class {
   }
   /** Reorder quick replies. */
   async reorder(orderedIds) {
-    return this.client.request(
-      "PUT",
-      "/settings/quick-replies/reorder",
-      { body: { orderedIds } }
-    );
+    return this.client.request("PUT", "/settings/quick-replies/reorder", {
+      body: { orderedIds }
+    });
   }
 };
 var SettingsResource = class {
@@ -1632,9 +1635,13 @@ var CustomFieldsResource = class {
   }
   /** Reorder custom fields within a content type. */
   async reorder(contentType, orderedIds) {
-    return this.client.request("PUT", "/custom-fields/reorder", {
-      body: { contentType, orderedIds }
-    });
+    return this.client.request(
+      "PUT",
+      "/custom-fields/reorder",
+      {
+        body: { contentType, orderedIds }
+      }
+    );
   }
 };
 
@@ -1769,11 +1776,11 @@ var ExportResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** Create an export. Returns exported data synchronously. */
   async create(params, options) {
     return this.client.request("POST", "/export", {
       body: params,
-      idempotencyKey: options?.idempotencyKey
+      idempotencyKey: options?.idempotencyKey,
+      responseType: params.format === "csv" ? "text" : "json"
     });
   }
 };

package/package.json

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