@slotchain/sdk 1.3.0 → 1.5.0

package/dist/index.cjs.js

@@ -740,11 +740,27 @@ var SlotClient = class {
     return response.data;
   }
   /**
-   * Create a new slot
+   * Create a new slot.
    * POST /api/v1/slots
-   * 
-   * @param data - Slot creation data (tenant_id, name required)
+   *
+   * Accepts any subset of `Slot` fields. For new integrations, prefer the
+   * exported `CreateSlotInput` type which documents the recommended shape
+   * and will become the enforced signature in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   *
+   * New fields available as of v1.4:
+   * - `starts_at` — ISO 8601 datetime when the slot opens
+   * - `ends_at`   — ISO 8601 datetime when the slot closes (omit for open-ended slots)
+   * - `metadata`  — term enrichment bag (term_name, season, half_term_start,
+   *                 half_term_end, capacity); see `SlotMetadata` type
+   *
+   * @param data - Slot creation data
    * @returns Created slot
+   *
+   * @example
+   * // Recommended — opt into stricter typing now:
+   * import { CreateSlotInput } from '@slotly/sdk';
+   * const input: CreateSlotInput = { name: 'Autumn Term', tenant_id: '...', starts_at: '...' };
+   * sdk.slots.create(input);
    */
   async create(data) {
     const response = await this.client.post(
@@ -754,11 +770,17 @@ var SlotClient = class {
     return response.data;
   }
   /**
-   * Update slot by ID
+   * Update slot by ID.
    * PUT /api/v1/slots/:id
-   * 
-   * @param id - Slot ID
-   * @param data - Slot update data
+   *
+   * Accepts any subset of `Slot` fields. For new integrations, prefer the
+   * exported `UpdateSlotInput` type — it will become the enforced signature
+   * in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   *
+   * New fields available as of v1.4: `starts_at`, `ends_at`, `metadata`.
+   *
+   * @param id   - Slot ID
+   * @param data - Fields to update
    * @returns Updated slot
    */
   async update(id, data) {
@@ -788,6 +810,13 @@ var SlotClient = class {
    * @param slots - Array of slots to create
    * @returns Created slots
    */
+  /**
+   * Bulk create slots.
+   * POST /api/v1/slots/bulk
+   *
+   * For new integrations, prefer passing `CreateSlotInput[]` — it will become
+   * the enforced signature in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   */
   async bulkCreate(slots) {
     const response = await this.client.post(
       "/api/v1/slots/bulk",
@@ -796,11 +825,14 @@ var SlotClient = class {
     return response.data;
   }
   /**
-   * Mark slot as available/unavailable
-   * Note: Use update() method with status or other fields
+   * Mark slot as available (live) or unavailable (archived).
+   *
+   * Note: previous versions sent 'active'/'inactive' which were not valid DB
+   * enum values. Fixed in v1.4 to use 'live'/'archived' — the only valid
+   * non-draft statuses. If you need 'draft', use update() directly.
    */
   async setAvailability(id, available) {
-    return this.update(id, { status: available ? "active" : "inactive" });
+    return this.update(id, { status: available ? "live" : "archived" });
   }
   /**
    * Get all active services for a slot with their items
@@ -1562,6 +1594,40 @@ var DocumentClient = class {
   }
 };
 
+// src/clients/notices-client.ts
+var NoticesClient = class {
+  constructor(client) {
+    this.base = "/api/v1/notices";
+    this.client = client;
+  }
+  /**
+   * List active notices for a tenant.
+   * Returns only notices where visible_until > activeAt (default: now).
+   */
+  async list(options) {
+    const response = await this.client.get(this.base, {
+      params: {
+        tenant_id: options.tenantId,
+        active_at: options.activeAt,
+        slot_id: options.slotId,
+        types: options.types?.join(",")
+      }
+    });
+    return response.data;
+  }
+  /**
+   * Get a single notice by its slot_moment id.
+   */
+  async getById(id, tenantId) {
+    const response = await this.client.get(`${this.base}/${id}`, {
+      params: { tenant_id: tenantId }
+    });
+    const { data } = response.data;
+    if (!data) throw new Error(`Notice ${id} not found`);
+    return data;
+  }
+};
+
 // src/errors.ts
 var SlotlyApiError = class _SlotlyApiError extends Error {
   constructor(code, message, statusCode, details) {
@@ -1895,7 +1961,8 @@ var useSlotly = (options) => {
     notification: new NotificationClient(client),
     dataQuality: new DataQualityClient(client),
     organization: new OrganizationClient(client),
-    document: new DocumentClient(client)
+    document: new DocumentClient(client),
+    notices: new NoticesClient(client)
   };
 };
 var index_default = useSlotly;