@cstar.help/js 0.4.0 → 0.5.0

package/dist/index.js

@@ -302,6 +302,65 @@ var WebhooksResource = class extends BaseResource {
   }
 };
 
+// src/resources/automations.ts
+var AutomationsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/automations");
+  }
+  /** Toggle a rule's enabled state. */
+  async toggle(ruleId, enabled) {
+    return this.client.request(
+      "PATCH",
+      `/automations/${ruleId}/toggle`,
+      { body: enabled !== void 0 ? { enabled } : {} }
+    );
+  }
+  /** Reorder rules by providing an ordered array of IDs. */
+  async reorder(orderedIds) {
+    return this.client.request("PUT", "/automations/reorder", {
+      body: { orderedIds }
+    });
+  }
+  /** Dry-run a rule against a specific resource (no actions executed). */
+  async test(ruleId, params) {
+    return this.client.request(
+      "POST",
+      `/automations/${ruleId}/test`,
+      { body: params }
+    );
+  }
+  /** Get execution history for a specific rule. */
+  async executions(ruleId, params) {
+    const searchParams = new URLSearchParams();
+    if (params?.page) searchParams.set("page", String(params.page));
+    if (params?.pageSize) searchParams.set("pageSize", String(params.pageSize));
+    if (params?.triggerEvent) searchParams.set("triggerEvent", params.triggerEvent);
+    if (params?.resourceId) searchParams.set("resourceId", params.resourceId);
+    const qs = searchParams.toString();
+    return this.client.request(
+      "GET",
+      `/automations/${ruleId}/executions${qs ? `?${qs}` : ""}`
+    );
+  }
+  /** Get all execution history for the team. */
+  async allExecutions(params) {
+    const searchParams = new URLSearchParams();
+    if (params?.page) searchParams.set("page", String(params.page));
+    if (params?.pageSize) searchParams.set("pageSize", String(params.pageSize));
+    if (params?.triggerEvent) searchParams.set("triggerEvent", params.triggerEvent);
+    if (params?.resourceId) searchParams.set("resourceId", params.resourceId);
+    const qs = searchParams.toString();
+    return this.client.request(
+      "GET",
+      `/automations/executions${qs ? `?${qs}` : ""}`
+    );
+  }
+  /** Test conditions against sample data (without a rule). */
+  async evaluate(params) {
+    return this.client.request("POST", "/automations/evaluate", { body: params });
+  }
+};
+
 // src/resources/categories.ts
 var CategoriesResource = class extends BaseResource {
   constructor(client) {
@@ -352,6 +411,783 @@ var CommunityTopicsResource = class extends BaseResource {
   }
 };
 
+// src/resources/members.ts
+var InvitesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List pending invites. */
+  async list(params) {
+    return this.client.request("GET", "/invites", {
+      query: params
+    });
+  }
+  /** Create and send a new invite. */
+  async create(params, options) {
+    return this.client.request("POST", "/invites", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Revoke a pending invite. */
+  async del(inviteId) {
+    return this.client.request("DELETE", `/invites/${inviteId}`);
+  }
+};
+var MembersResource = class {
+  constructor(client) {
+    this.client = client;
+    this.invites = new InvitesResource(client);
+  }
+  /** List all team members. */
+  async list(params) {
+    return this.client.request("GET", "/members", {
+      query: params
+    });
+  }
+  /** Get a single member by membership ID. */
+  async get(memberId) {
+    return this.client.request("GET", `/members/${memberId}`);
+  }
+  /** Update a member's role. */
+  async update(memberId, params) {
+    return this.client.request("PATCH", `/members/${memberId}`, {
+      body: params
+    });
+  }
+  /** Remove a member from the team. */
+  async del(memberId) {
+    return this.client.request("DELETE", `/members/${memberId}`);
+  }
+};
+
+// src/resources/settings.ts
+var StatusesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all statuses. */
+  async list() {
+    return this.client.request("GET", "/settings/statuses");
+  }
+  /** Create a new status. */
+  async create(params, options) {
+    return this.client.request("POST", "/settings/statuses", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Update a status. */
+  async update(statusKey, params) {
+    return this.client.request(
+      "PATCH",
+      `/settings/statuses/${statusKey}`,
+      { body: params }
+    );
+  }
+  /** Delete a status. */
+  async del(statusKey) {
+    return this.client.request(
+      "DELETE",
+      `/settings/statuses/${statusKey}`
+    );
+  }
+  /** Reorder statuses. */
+  async reorder(orderedKeys) {
+    return this.client.request("PUT", "/settings/statuses/reorder", {
+      body: { orderedKeys }
+    });
+  }
+};
+var QuickRepliesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all quick replies. */
+  async list() {
+    return this.client.request("GET", "/settings/quick-replies");
+  }
+  /** Create a new quick reply. */
+  async create(params, options) {
+    return this.client.request("POST", "/settings/quick-replies", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Update a quick reply. */
+  async update(replyId, params) {
+    return this.client.request(
+      "PATCH",
+      `/settings/quick-replies/${replyId}`,
+      { body: params }
+    );
+  }
+  /** Delete a quick reply. */
+  async del(replyId) {
+    return this.client.request(
+      "DELETE",
+      `/settings/quick-replies/${replyId}`
+    );
+  }
+  /** Reorder quick replies. */
+  async reorder(orderedIds) {
+    return this.client.request(
+      "PUT",
+      "/settings/quick-replies/reorder",
+      { body: { orderedIds } }
+    );
+  }
+};
+var SettingsResource = class {
+  constructor(client) {
+    this.client = client;
+    this.statuses = new StatusesResource(client);
+    this.quickReplies = new QuickRepliesResource(client);
+  }
+  /** Get all team settings. */
+  async get() {
+    return this.client.request("GET", "/settings");
+  }
+  /** Update team settings (bulk). */
+  async update(params) {
+    return this.client.request("PATCH", "/settings", { body: params });
+  }
+  /** Get business hours configuration. */
+  async getBusinessHours() {
+    return this.client.request("GET", "/settings/business-hours");
+  }
+  /** Update business hours configuration. */
+  async updateBusinessHours(params) {
+    return this.client.request("PATCH", "/settings/business-hours", {
+      body: params
+    });
+  }
+  /** Get widget settings. */
+  async getWidget() {
+    return this.client.request("GET", "/settings/widget");
+  }
+  /** Update widget settings. */
+  async updateWidget(params) {
+    return this.client.request("PATCH", "/settings/widget", {
+      body: params
+    });
+  }
+};
+
+// src/resources/notifications.ts
+var NotificationsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List notifications. */
+  async list(params) {
+    return this.client.request("GET", "/notifications", {
+      query: params
+    });
+  }
+  /** Get unread notification count. */
+  async unreadCount() {
+    return this.client.request("GET", "/notifications/unread-count");
+  }
+  /** Mark a single notification as read. */
+  async markRead(notificationId) {
+    return this.client.request(
+      "PATCH",
+      `/notifications/${notificationId}`,
+      { body: { read: true } }
+    );
+  }
+  /** Mark all notifications as read. */
+  async markAllRead() {
+    return this.client.request(
+      "POST",
+      "/notifications/mark-all-read"
+    );
+  }
+};
+
+// src/resources/attachments.ts
+var AttachmentsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List attachments. */
+  async list(params) {
+    return this.client.request("GET", "/attachments", {
+      query: params
+    });
+  }
+  /** Get a single attachment. */
+  async get(attachmentId) {
+    return this.client.request("GET", `/attachments/${attachmentId}`);
+  }
+  /** Delete an attachment. */
+  async del(attachmentId) {
+    return this.client.request(
+      "DELETE",
+      `/attachments/${attachmentId}`
+    );
+  }
+};
+
+// src/resources/customFields.ts
+var CustomFieldsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List custom fields. */
+  async list(params) {
+    return this.client.request("GET", "/custom-fields", {
+      query: params
+    });
+  }
+  /** Get a single custom field. */
+  async get(fieldId) {
+    return this.client.request("GET", `/custom-fields/${fieldId}`);
+  }
+  /** Create a custom field. */
+  async create(params, options) {
+    return this.client.request("POST", "/custom-fields", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Update a custom field. */
+  async update(fieldId, params) {
+    return this.client.request("PATCH", `/custom-fields/${fieldId}`, {
+      body: params
+    });
+  }
+  /** Delete a custom field. */
+  async del(fieldId) {
+    return this.client.request("DELETE", `/custom-fields/${fieldId}`);
+  }
+  /** Reorder custom fields. */
+  async reorder(orderedIds) {
+    return this.client.request("PUT", "/custom-fields/reorder", {
+      body: { orderedIds }
+    });
+  }
+};
+
+// src/resources/sla.ts
+var SlaResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List SLA rules. */
+  async list(params) {
+    return this.client.request("GET", "/sla/rules", {
+      query: params
+    });
+  }
+  /** Get a single SLA rule. */
+  async get(ruleId) {
+    return this.client.request("GET", `/sla/rules/${ruleId}`);
+  }
+  /** Create an SLA rule. */
+  async create(params, options) {
+    return this.client.request("POST", "/sla/rules", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Update an SLA rule. */
+  async update(ruleId, params) {
+    return this.client.request("PATCH", `/sla/rules/${ruleId}`, {
+      body: params
+    });
+  }
+  /** Delete an SLA rule. */
+  async del(ruleId) {
+    return this.client.request("DELETE", `/sla/rules/${ruleId}`);
+  }
+};
+
+// src/resources/analytics.ts
+var AnalyticsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get analytics overview. */
+  async overview(params) {
+    return this.client.request("GET", "/analytics/overview", {
+      query: params
+    });
+  }
+  /** Get per-agent performance stats. */
+  async agents(params) {
+    return this.client.request("GET", "/analytics/agents", {
+      query: params
+    });
+  }
+  /** Get CSAT statistics. */
+  async csatStats(params) {
+    return this.client.request("GET", "/csat/stats", {
+      query: params
+    });
+  }
+  /** List individual CSAT responses. */
+  async csatResponses(params) {
+    return this.client.request("GET", "/csat/responses", {
+      query: params
+    });
+  }
+};
+
+// src/resources/bulk.ts
+var BulkResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Bulk update resources. */
+  async update(params, options) {
+    return this.client.request("POST", "/bulk", {
+      body: { action: "update", ...params },
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Bulk delete resources. */
+  async del(params, options) {
+    return this.client.request("POST", "/bulk", {
+      body: { action: "delete", ...params },
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+};
+
+// src/resources/exportImport.ts
+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
+    });
+  }
+};
+var ImportResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Run an import. Processes records synchronously (max 500). */
+  async create(params, options) {
+    return this.client.request("POST", "/import", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** List import history logs. */
+  async logs(params) {
+    return this.client.request("GET", "/import", {
+      query: params
+    });
+  }
+  /** Get a single import log. */
+  async getLog(logId) {
+    return this.client.request("GET", `/import/logs/${logId}`);
+  }
+};
+
+// src/resources/auditLog.ts
+var AuditLogResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List audit log entries. */
+  async list(params) {
+    return this.client.request("GET", "/audit-log", {
+      query: params
+    });
+  }
+};
+
+// src/resources/search.ts
+var SearchResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Perform a cross-resource search. */
+  async query(params) {
+    const query = {
+      q: params.query,
+      limit: params.limit?.toString()
+    };
+    if (params.types?.length) {
+      query.types = params.types.join(",");
+    }
+    return this.client.request("GET", "/search", { query });
+  }
+};
+
+// src/resources/tags.ts
+var TagsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all tags with usage counts. */
+  async list(params) {
+    return this.client.request("GET", "/tags", {
+      query: params
+    });
+  }
+  /** Create a tag. */
+  async create(name, options) {
+    return this.client.request("POST", "/tags", {
+      body: { name },
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Delete a tag. */
+  async del(name) {
+    return this.client.request(
+      "DELETE",
+      `/tags/${encodeURIComponent(name)}`
+    );
+  }
+};
+
+// src/resources/activity.ts
+var ActivityResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List recent activity events. */
+  async list(params) {
+    return this.client.request("GET", "/activity", {
+      query: params
+    });
+  }
+};
+
+// src/resources/customerGroups.ts
+var CustomerGroupsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/customer-groups");
+  }
+};
+
+// src/resources/game.ts
+var BossResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get current boss state. */
+  async current() {
+    return this.client.request("GET", "/game/boss");
+  }
+  /** Check if a boss is active (lightweight). */
+  async isActive() {
+    return this.client.request("GET", "/game/boss/active");
+  }
+  /** Spawn a new boss. */
+  async spawn(params, options) {
+    return this.client.request("POST", "/game/boss/spawn", {
+      body: params ?? {},
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Deal damage to the current boss. */
+  async damage(params, options) {
+    return this.client.request("POST", "/game/boss/damage", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** List boss defeat history. */
+  async defeats(params) {
+    return this.client.request("GET", "/game/boss/defeats", {
+      query: params
+    });
+  }
+  /** Get a single defeat record. */
+  async getDefeat(defeatId) {
+    return this.client.request("GET", `/game/boss/defeats/${defeatId}`);
+  }
+};
+var AchievementsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all achievements with progress. */
+  async list(params) {
+    return this.client.request("GET", "/game/achievements", {
+      query: params
+    });
+  }
+  /** List unlocked achievements only. */
+  async unlocked(params) {
+    return this.client.request("GET", "/game/achievements/unlocked", {
+      query: params
+    });
+  }
+  /** Get a single achievement. */
+  async get(achievementId, params) {
+    return this.client.request("GET", `/game/achievements/${achievementId}`, {
+      query: params
+    });
+  }
+};
+var QuestsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get today's quests. */
+  async today(params) {
+    return this.client.request("GET", "/game/quests/today", {
+      query: params
+    });
+  }
+  /** Get quest history. */
+  async history(params) {
+    return this.client.request("GET", "/game/quests/history", {
+      query: params
+    });
+  }
+};
+var PuzzlesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get today's puzzle. */
+  async today(params) {
+    return this.client.request("GET", "/game/puzzles/today", {
+      query: params
+    });
+  }
+  /** Submit a puzzle answer. */
+  async complete(params, options) {
+    return this.client.request("POST", "/game/puzzles/complete", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Get puzzle streak for a user. */
+  async streak(params) {
+    return this.client.request("GET", "/game/puzzles/streak", {
+      query: params
+    });
+  }
+  /** Get puzzle leaderboard. */
+  async leaderboard(params) {
+    return this.client.request("GET", "/game/puzzles/leaderboard", {
+      query: params
+    });
+  }
+};
+var OneUpsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List one-ups. */
+  async list(params) {
+    return this.client.request("GET", "/game/one-ups", {
+      query: params
+    });
+  }
+  /** Send a one-up. */
+  async send(params, options) {
+    return this.client.request("POST", "/game/one-ups", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Check remaining free one-ups today. */
+  async remaining(params) {
+    return this.client.request("GET", "/game/one-ups/remaining", {
+      query: params
+    });
+  }
+};
+var HighFivesResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List high fives. */
+  async list(params) {
+    return this.client.request("GET", "/game/high-fives", {
+      query: params
+    });
+  }
+  /** Send a high five. */
+  async send(params, options) {
+    return this.client.request("POST", "/game/high-fives", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Check if you can send a high five to a team. */
+  async canSend(recipientTeamId, params) {
+    return this.client.request("GET", `/game/high-fives/can-send/${recipientTeamId}`, {
+      query: params
+    });
+  }
+};
+var CosmeticsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List unlocked cosmetics. */
+  async list(params) {
+    return this.client.request("GET", "/game/cosmetics", {
+      query: params
+    });
+  }
+  /** Get cosmetic preferences. */
+  async getPreferences(params) {
+    return this.client.request("GET", "/game/cosmetics/preferences", {
+      query: params
+    });
+  }
+  /** Update cosmetic preferences. */
+  async updatePreferences(params) {
+    return this.client.request("PATCH", "/game/cosmetics/preferences", { body: params });
+  }
+};
+var SeasonsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** List all seasons. */
+  async list() {
+    return this.client.request("GET", "/game/seasons");
+  }
+  /** Get the current active season. */
+  async current() {
+    return this.client.request("GET", "/game/seasons/current");
+  }
+  /** Get user stats for a season. */
+  async stats(seasonId, params) {
+    return this.client.request("GET", `/game/seasons/${seasonId}/stats`, {
+      query: params
+    });
+  }
+};
+var SkillsResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get the skill tree with current allocations. */
+  async get(params) {
+    return this.client.request("GET", "/game/skills", {
+      query: params
+    });
+  }
+  /** Allocate a skill point. */
+  async allocate(params, options) {
+    return this.client.request("POST", "/game/skills/allocate", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Reset all skill allocations. */
+  async reset(params, options) {
+    return this.client.request("POST", "/game/skills/reset", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+};
+var GameResource = class {
+  constructor(client) {
+    this.client = client;
+    this.boss = new BossResource(client);
+    this.achievements = new AchievementsResource(client);
+    this.quests = new QuestsResource(client);
+    this.puzzles = new PuzzlesResource(client);
+    this.oneUps = new OneUpsResource(client);
+    this.highFives = new HighFivesResource(client);
+    this.cosmetics = new CosmeticsResource(client);
+    this.seasons = new SeasonsResource(client);
+    this.skills = new SkillsResource(client);
+  }
+  /** Get current player stats. */
+  async player(params) {
+    return this.client.request("GET", "/game/player", {
+      query: params
+    });
+  }
+  /** Get a specific player's stats by membership ID. */
+  async getPlayer(memberId) {
+    return this.client.request("GET", `/game/player/${memberId}`);
+  }
+  /** Get the team leaderboard. */
+  async leaderboard(params) {
+    return this.client.request("GET", "/game/leaderboard", {
+      query: params
+    });
+  }
+  /** Get the current user's leaderboard position. */
+  async myRank(params) {
+    return this.client.request("GET", "/game/leaderboard/me", {
+      query: params
+    });
+  }
+};
+
+// src/resources/ai.ts
+var AiResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Run an AI action. */
+  async run(params, options) {
+    return this.client.request("POST", "/ai", {
+      body: params,
+      idempotencyKey: options?.idempotencyKey
+    });
+  }
+  /** Auto-tag a ticket. */
+  async autoTag(ticketId) {
+    return this.run({ action: "auto-tag", ticketId });
+  }
+  /** Suggest a reply for a ticket. */
+  async suggestReply(ticketId) {
+    return this.run({ action: "suggest-reply", ticketId });
+  }
+  /** Summarize a ticket. */
+  async summarize(ticketId) {
+    return this.run({ action: "summarize", ticketId });
+  }
+  /** Improve text. */
+  async improve(text) {
+    return this.run({ action: "improve", text });
+  }
+};
+
+// src/resources/views.ts
+var ViewsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/views");
+  }
+  /** Execute a view — returns the filtered results. */
+  async execute(viewId, params) {
+    return this.client.request("GET", `/views/${viewId}/tickets`, {
+      query: params
+    });
+  }
+};
+
+// src/resources/billing.ts
+var BillingResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /** Get current subscription status. */
+  async subscription() {
+    return this.client.request("GET", "/billing/subscription");
+  }
+  /** Create a Stripe billing portal session. */
+  async portal(params) {
+    return this.client.request("POST", "/billing/portal", {
+      body: params ?? {}
+    });
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -360,11 +1196,31 @@ var CStarClient = class {
     this.customers = new CustomersResource(this.client);
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
+    this.automations = new AutomationsResource(this.client);
     this.categories = new CategoriesResource(this.client);
     this.community = {
       posts: new CommunityPostsResource(this.client),
       topics: new CommunityTopicsResource(this.client)
     };
+    this.members = new MembersResource(this.client);
+    this.settings = new SettingsResource(this.client);
+    this.notifications = new NotificationsResource(this.client);
+    this.attachments = new AttachmentsResource(this.client);
+    this.customFields = new CustomFieldsResource(this.client);
+    this.sla = new SlaResource(this.client);
+    this.analytics = new AnalyticsResource(this.client);
+    this.bulk = new BulkResource(this.client);
+    this.export = new ExportResource(this.client);
+    this.import = new ImportResource(this.client);
+    this.auditLog = new AuditLogResource(this.client);
+    this.search = new SearchResource(this.client);
+    this.tags = new TagsResource(this.client);
+    this.activity = new ActivityResource(this.client);
+    this.customerGroups = new CustomerGroupsResource(this.client);
+    this.game = new GameResource(this.client);
+    this.ai = new AiResource(this.client);
+    this.views = new ViewsResource(this.client);
+    this.billing = new BillingResource(this.client);
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {