@cstar.help/js 0.3.0 → 0.3.2

package/dist/index.cjs

@@ -328,6 +328,13 @@ var WebhooksResource = class extends BaseResource {
   }
 };
 
+// src/resources/categories.ts
+var CategoriesResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/categories");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -336,6 +343,7 @@ var CStarClient = class {
     this.customers = new CustomersResource(this.client);
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
+    this.categories = new CategoriesResource(this.client);
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/dist/index.d.cts

@@ -278,7 +278,7 @@ interface Article {
     slug: string | null;
     excerpt: string | null;
     content: string | null;
-    category: string;
+    categoryId: string | null;
     status: 'draft' | 'published';
     tags: string[];
     notes: string | null;
@@ -306,7 +306,7 @@ interface ArticleCreateParams {
     title: string;
     content?: string;
     excerpt?: string;
-    category?: string;
+    categoryId?: string;
     status?: 'draft' | 'published';
     tags?: string[];
     notes?: string;
@@ -320,7 +320,7 @@ interface ArticleUpdateParams {
     title?: string;
     content?: string;
     excerpt?: string;
-    category?: string;
+    categoryId?: string;
     status?: 'draft' | 'published';
     tags?: string[];
     notes?: string;
@@ -429,6 +429,48 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     }): Promise<ApiResponse<WebhookTestResult>>;
 }
 
+/** A cStar article category. */
+interface Category {
+    id: string;
+    object: 'category';
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string | null;
+    color: string | null;
+    sortOrder: number;
+    isPublic: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Parameters for listing categories. */
+interface CategoryListParams extends PaginationParams {
+    isPublic?: boolean;
+}
+/** Parameters for creating a category. */
+interface CategoryCreateParams {
+    name: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+/** Parameters for updating a category. */
+interface CategoryUpdateParams {
+    name?: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+
+/** Manage article categories. */
+declare class CategoriesResource extends BaseResource<Category, CategoryListParams, CategoryCreateParams, CategoryUpdateParams> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -510,10 +552,12 @@ declare class CStarClient {
     readonly articles: ArticlesResource;
     /** Manage webhook endpoints. */
     readonly webhooks: WebhooksResource;
+    /** Manage article categories. */
+    readonly categories: CategoriesResource;
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.d.ts

@@ -278,7 +278,7 @@ interface Article {
     slug: string | null;
     excerpt: string | null;
     content: string | null;
-    category: string;
+    categoryId: string | null;
     status: 'draft' | 'published';
     tags: string[];
     notes: string | null;
@@ -306,7 +306,7 @@ interface ArticleCreateParams {
     title: string;
     content?: string;
     excerpt?: string;
-    category?: string;
+    categoryId?: string;
     status?: 'draft' | 'published';
     tags?: string[];
     notes?: string;
@@ -320,7 +320,7 @@ interface ArticleUpdateParams {
     title?: string;
     content?: string;
     excerpt?: string;
-    category?: string;
+    categoryId?: string;
     status?: 'draft' | 'published';
     tags?: string[];
     notes?: string;
@@ -429,6 +429,48 @@ declare class WebhooksResource extends BaseResource<Webhook, WebhookListParams,
     }): Promise<ApiResponse<WebhookTestResult>>;
 }
 
+/** A cStar article category. */
+interface Category {
+    id: string;
+    object: 'category';
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string | null;
+    color: string | null;
+    sortOrder: number;
+    isPublic: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Parameters for listing categories. */
+interface CategoryListParams extends PaginationParams {
+    isPublic?: boolean;
+}
+/** Parameters for creating a category. */
+interface CategoryCreateParams {
+    name: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+/** Parameters for updating a category. */
+interface CategoryUpdateParams {
+    name?: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sortOrder?: number;
+    isPublic?: boolean;
+}
+
+/** Manage article categories. */
+declare class CategoriesResource extends BaseResource<Category, CategoryListParams, CategoryCreateParams, CategoryUpdateParams> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -510,10 +552,12 @@ declare class CStarClient {
     readonly articles: ArticlesResource;
     /** Manage webhook endpoints. */
     readonly webhooks: WebhooksResource;
+    /** Manage article categories. */
+    readonly categories: CategoriesResource;
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.js

@@ -296,6 +296,13 @@ var WebhooksResource = class extends BaseResource {
   }
 };
 
+// src/resources/categories.ts
+var CategoriesResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/categories");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -304,6 +311,7 @@ var CStarClient = class {
     this.customers = new CustomersResource(this.client);
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
+    this.categories = new CategoriesResource(this.client);
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/dist/webhook/index.d.cts

@@ -77,7 +77,7 @@ interface Article {
     slug: string | null;
     excerpt: string | null;
     content: string | null;
-    category: string;
+    categoryId: string | null;
     status: 'draft' | 'published';
     tags: string[];
     notes: string | null;

package/dist/webhook/index.d.ts

@@ -77,7 +77,7 @@ interface Article {
     slug: string | null;
     excerpt: string | null;
     content: string | null;
-    category: string;
+    categoryId: string | null;
     status: 'draft' | 'published';
     tags: string[];
     notes: string | null;

package/package.json

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