@slotchain/sdk 1.4.0 → 1.5.0

package/dist/index.d.mts

@@ -388,7 +388,7 @@ interface GetOrganizationOptions {
 /**
  * Artifact / document attached to a customer or booking
  */
-type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant';
+type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant' | 'slot_moment';
 type ArtifactMimeCategory = 'pdf' | 'document' | 'image' | 'spreadsheet' | 'video' | 'audio' | 'other';
 interface Artifact {
     id: string;
@@ -446,6 +446,46 @@ interface UploadArtifactOptions {
     mime_type?: string;
     metadata?: Record<string, unknown>;
 }
+/**
+ * Slot-scoped operational notice (early closure, venue change, general alert).
+ * Backed by a `slot_moment` — see NOTICES_PLAN.md in slotly-admin.
+ */
+type NoticeMomentType = 'general_notice' | 'early_closure' | 'closure_notice' | 'venue_change';
+interface SlotNotice {
+    id: string;
+    slotId: string;
+    tenantId: string;
+    momentType: NoticeMomentType;
+    createdAt: string;
+    createdBy: string | null;
+    notice: {
+        type: string;
+        title: string;
+        message: string;
+        /** YYYY-MM-DD — the day the notice applies to */
+        affectedDate: string;
+        /** HH:MM — only present for early_closure notices */
+        closesAt?: string;
+        severity: 'info' | 'warning' | 'urgent';
+        visibleFrom: string;
+        visibleUntil: string;
+        dismissible: boolean;
+        /** Signed URL for the notice's attached graphic, if one was uploaded */
+        imageUrl?: string | null;
+        /** Staff-picked display treatment — 'banner' (compact, stacks) or 'modal' (full-screen, one at a time) */
+        presentation: 'banner' | 'modal';
+    };
+    affectedBookingIds: string[];
+}
+interface ListNoticesOptions {
+    tenantId: string;
+    /** Filter to notices active at this ISO timestamp. Defaults to now. */
+    activeAt?: string;
+    /** Filter to a specific slot */
+    slotId?: string;
+    /** Specific notice types to include. Defaults to all notice types. */
+    types?: NoticeMomentType[];
+}
 /**
  * Full tenant configuration including branding, services, and service items
  * Service items are nested within each service object (not as a separate top-level array)
@@ -1565,6 +1605,34 @@ declare class DocumentClient {
     }): Promise<Artifact>;
 }
 
+/**
+ * NoticesClient — read active slot-scoped operational notices.
+ *
+ * Notices are a product concept (early closure, venue change, general alert)
+ * backed by `slot_moments` internally — the SDK surface reflects the product,
+ * not the storage model. Each notice's attached graphic (if any) is already
+ * resolved to a signed `imageUrl` server-side.
+ *
+ * @example List active notices for a tenant
+ * ```ts
+ * const { data } = await slotly.notices.list({ tenantId });
+ * ```
+ */
+declare class NoticesClient {
+    private readonly client;
+    private readonly base;
+    constructor(client: AxiosInstance);
+    /**
+     * List active notices for a tenant.
+     * Returns only notices where visible_until > activeAt (default: now).
+     */
+    list(options: ListNoticesOptions): Promise<ApiResponse<SlotNotice[]>>;
+    /**
+     * Get a single notice by its slot_moment id.
+     */
+    getById(id: string, tenantId: string): Promise<SlotNotice>;
+}
+
 /**
  * Custom error classes for Slotly SDK
  */
@@ -1729,6 +1797,8 @@ interface SlotlyApi {
     organization: OrganizationClient;
     /** Upload and retrieve file artifacts (CVs, invoices, images) linked to any Slotly entity */
     document: DocumentClient;
+    /** List slot-scoped operational notices (early closure, venue change, general alerts) */
+    notices: NoticesClient;
 }
 /**
  * Initialize and configure a new Slotly API client with dual authentication.
@@ -1793,4 +1863,4 @@ interface SlotlyApi {
  */
 declare const useSlotly: (options: SlotlyClientOptions) => SlotlyApi;
 
-export { type ApiResponse, type Artifact, type ArtifactEntityType, type ArtifactMimeCategory, type ArtifactWithUrl, type Booking, type BookingWithSlot, type Category, type CreateSlotInput, type Customer, type CustomerIdentity, type CustomerWithBookings, type CustomerWithIdentities, type DataQualityIssue, type FindOrCreateCustomerOptions, type Flow, type FlowStep, type GetOrganizationOptions, type ListArtifactsOptions, type ListBookingsOptions, type Notification, type NotificationPreferences, type Organization, type OrganizationFullConfig, type ResolveCustomerOptions, type Service, type ServiceItem, type ServiceItemWithService, type ServiceWithItems, type Slot, type SlotMetadata, type SlotServiceWithItems, type SlotlyApi, SlotlyApiError, type SlotlyAuthContext, SlotlyAuthError, type SlotlyClientOptions, SlotlyConfigurationError, SlotlyNetworkError, type SlotlyRequest, type Studio, type Tenant, type TenantBranding, type TenantFullConfig, type UpdateSlotInput, type UploadArtifactOptions, useSlotly as default, getSlotlyContext, useSlotly, validateSlotlyRequest };
+export { type ApiResponse, type Artifact, type ArtifactEntityType, type ArtifactMimeCategory, type ArtifactWithUrl, type Booking, type BookingWithSlot, type Category, type CreateSlotInput, type Customer, type CustomerIdentity, type CustomerWithBookings, type CustomerWithIdentities, type DataQualityIssue, type FindOrCreateCustomerOptions, type Flow, type FlowStep, type GetOrganizationOptions, type ListArtifactsOptions, type ListBookingsOptions, type ListNoticesOptions, type NoticeMomentType, type Notification, type NotificationPreferences, type Organization, type OrganizationFullConfig, type ResolveCustomerOptions, type Service, type ServiceItem, type ServiceItemWithService, type ServiceWithItems, type Slot, type SlotMetadata, type SlotNotice, type SlotServiceWithItems, type SlotlyApi, SlotlyApiError, type SlotlyAuthContext, SlotlyAuthError, type SlotlyClientOptions, SlotlyConfigurationError, SlotlyNetworkError, type SlotlyRequest, type Studio, type Tenant, type TenantBranding, type TenantFullConfig, type UpdateSlotInput, type UploadArtifactOptions, useSlotly as default, getSlotlyContext, useSlotly, validateSlotlyRequest };

package/dist/index.d.ts

@@ -388,7 +388,7 @@ interface GetOrganizationOptions {
 /**
  * Artifact / document attached to a customer or booking
  */
-type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant';
+type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant' | 'slot_moment';
 type ArtifactMimeCategory = 'pdf' | 'document' | 'image' | 'spreadsheet' | 'video' | 'audio' | 'other';
 interface Artifact {
     id: string;
@@ -446,6 +446,46 @@ interface UploadArtifactOptions {
     mime_type?: string;
     metadata?: Record<string, unknown>;
 }
+/**
+ * Slot-scoped operational notice (early closure, venue change, general alert).
+ * Backed by a `slot_moment` — see NOTICES_PLAN.md in slotly-admin.
+ */
+type NoticeMomentType = 'general_notice' | 'early_closure' | 'closure_notice' | 'venue_change';
+interface SlotNotice {
+    id: string;
+    slotId: string;
+    tenantId: string;
+    momentType: NoticeMomentType;
+    createdAt: string;
+    createdBy: string | null;
+    notice: {
+        type: string;
+        title: string;
+        message: string;
+        /** YYYY-MM-DD — the day the notice applies to */
+        affectedDate: string;
+        /** HH:MM — only present for early_closure notices */
+        closesAt?: string;
+        severity: 'info' | 'warning' | 'urgent';
+        visibleFrom: string;
+        visibleUntil: string;
+        dismissible: boolean;
+        /** Signed URL for the notice's attached graphic, if one was uploaded */
+        imageUrl?: string | null;
+        /** Staff-picked display treatment — 'banner' (compact, stacks) or 'modal' (full-screen, one at a time) */
+        presentation: 'banner' | 'modal';
+    };
+    affectedBookingIds: string[];
+}
+interface ListNoticesOptions {
+    tenantId: string;
+    /** Filter to notices active at this ISO timestamp. Defaults to now. */
+    activeAt?: string;
+    /** Filter to a specific slot */
+    slotId?: string;
+    /** Specific notice types to include. Defaults to all notice types. */
+    types?: NoticeMomentType[];
+}
 /**
  * Full tenant configuration including branding, services, and service items
  * Service items are nested within each service object (not as a separate top-level array)
@@ -1565,6 +1605,34 @@ declare class DocumentClient {
     }): Promise<Artifact>;
 }
 
+/**
+ * NoticesClient — read active slot-scoped operational notices.
+ *
+ * Notices are a product concept (early closure, venue change, general alert)
+ * backed by `slot_moments` internally — the SDK surface reflects the product,
+ * not the storage model. Each notice's attached graphic (if any) is already
+ * resolved to a signed `imageUrl` server-side.
+ *
+ * @example List active notices for a tenant
+ * ```ts
+ * const { data } = await slotly.notices.list({ tenantId });
+ * ```
+ */
+declare class NoticesClient {
+    private readonly client;
+    private readonly base;
+    constructor(client: AxiosInstance);
+    /**
+     * List active notices for a tenant.
+     * Returns only notices where visible_until > activeAt (default: now).
+     */
+    list(options: ListNoticesOptions): Promise<ApiResponse<SlotNotice[]>>;
+    /**
+     * Get a single notice by its slot_moment id.
+     */
+    getById(id: string, tenantId: string): Promise<SlotNotice>;
+}
+
 /**
  * Custom error classes for Slotly SDK
  */
@@ -1729,6 +1797,8 @@ interface SlotlyApi {
     organization: OrganizationClient;
     /** Upload and retrieve file artifacts (CVs, invoices, images) linked to any Slotly entity */
     document: DocumentClient;
+    /** List slot-scoped operational notices (early closure, venue change, general alerts) */
+    notices: NoticesClient;
 }
 /**
  * Initialize and configure a new Slotly API client with dual authentication.
@@ -1793,4 +1863,4 @@ interface SlotlyApi {
  */
 declare const useSlotly: (options: SlotlyClientOptions) => SlotlyApi;
 
-export { type ApiResponse, type Artifact, type ArtifactEntityType, type ArtifactMimeCategory, type ArtifactWithUrl, type Booking, type BookingWithSlot, type Category, type CreateSlotInput, type Customer, type CustomerIdentity, type CustomerWithBookings, type CustomerWithIdentities, type DataQualityIssue, type FindOrCreateCustomerOptions, type Flow, type FlowStep, type GetOrganizationOptions, type ListArtifactsOptions, type ListBookingsOptions, type Notification, type NotificationPreferences, type Organization, type OrganizationFullConfig, type ResolveCustomerOptions, type Service, type ServiceItem, type ServiceItemWithService, type ServiceWithItems, type Slot, type SlotMetadata, type SlotServiceWithItems, type SlotlyApi, SlotlyApiError, type SlotlyAuthContext, SlotlyAuthError, type SlotlyClientOptions, SlotlyConfigurationError, SlotlyNetworkError, type SlotlyRequest, type Studio, type Tenant, type TenantBranding, type TenantFullConfig, type UpdateSlotInput, type UploadArtifactOptions, useSlotly as default, getSlotlyContext, useSlotly, validateSlotlyRequest };
+export { type ApiResponse, type Artifact, type ArtifactEntityType, type ArtifactMimeCategory, type ArtifactWithUrl, type Booking, type BookingWithSlot, type Category, type CreateSlotInput, type Customer, type CustomerIdentity, type CustomerWithBookings, type CustomerWithIdentities, type DataQualityIssue, type FindOrCreateCustomerOptions, type Flow, type FlowStep, type GetOrganizationOptions, type ListArtifactsOptions, type ListBookingsOptions, type ListNoticesOptions, type NoticeMomentType, type Notification, type NotificationPreferences, type Organization, type OrganizationFullConfig, type ResolveCustomerOptions, type Service, type ServiceItem, type ServiceItemWithService, type ServiceWithItems, type Slot, type SlotMetadata, type SlotNotice, type SlotServiceWithItems, type SlotlyApi, SlotlyApiError, type SlotlyAuthContext, SlotlyAuthError, type SlotlyClientOptions, SlotlyConfigurationError, SlotlyNetworkError, type SlotlyRequest, type Studio, type Tenant, type TenantBranding, type TenantFullConfig, type UpdateSlotInput, type UploadArtifactOptions, useSlotly as default, getSlotlyContext, useSlotly, validateSlotlyRequest };

package/dist/index.esm.js

@@ -1553,6 +1553,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) {
@@ -1886,7 +1920,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;