@compassdigital/sdk.typescript 4.897.0 → 4.899.0

package/src/index.ts

@@ -1721,10 +1721,22 @@ import {
 	PatchCentricPosOrderReceiptEmailResponse,
 	PostCentricPosOrderReceiptBody,
 	PostCentricPosOrderReceiptResponse,
+	GetCentricPosAdminDeviceResponse,
+	PutCentricPosAdminDeviceSettingsBody,
+	PutCentricPosAdminDeviceSettingsResponse,
+	DeleteCentricPosAdminDeviceSettingsResponse,
 	GetCentricPosDigitalSignageOrdersQuery,
 	GetCentricPosDigitalSignageOrdersResponse,
 } from './interface/centric-pos';
 
+import {
+	QueryAuditEventsBody,
+	QueryAuditEventsResponse,
+	GetAuditEventResponse,
+	PostAuditEventBody,
+	PostAuditEventResponse,
+} from './interface/audit';
+
 import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -19856,6 +19868,68 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /centric-pos/v1/admin/device/{serialNumber} - Get a POS device with its settings
+	 *
+	 * @param serialNumber - Serial number of the device
+	 * @param options - additional request options
+	 */
+	get_centric_pos_admin_device(
+		serialNumber: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetCentricPosAdminDeviceResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/admin/device/{serialNumber}',
+			'GET',
+			`/centric-pos/v1/admin/device/${serialNumber}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * PUT /centric-pos/v1/admin/device/{serialNumber}/settings - Save a POS device's location and hidden stations
+	 *
+	 * @param serialNumber - Serial number of the device
+	 * @param body
+	 * @param options - additional request options
+	 */
+	put_centric_pos_admin_device_settings(
+		serialNumber: string,
+		body: PutCentricPosAdminDeviceSettingsBody,
+		options?: RequestOptions,
+	): ResponsePromise<PutCentricPosAdminDeviceSettingsResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/admin/device/{serialNumber}/settings',
+			'PUT',
+			`/centric-pos/v1/admin/device/${serialNumber}/settings`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * DELETE /centric-pos/v1/admin/device/{serialNumber}/settings - Clear a POS device's settings without unregistering it
+	 *
+	 * @param serialNumber - Serial number of the device
+	 * @param options - additional request options
+	 */
+	delete_centric_pos_admin_device_settings(
+		serialNumber: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteCentricPosAdminDeviceSettingsResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/admin/device/{serialNumber}/settings',
+			'DELETE',
+			`/centric-pos/v1/admin/device/${serialNumber}/settings`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /centric-pos/innovation/v1/digital-signage/orders/{stationId} - Get in-progress and ready orders for a station
 	 *
@@ -19877,4 +19951,54 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * POST /audit/events/query - Query audit events
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	query_audit_events(
+		body: QueryAuditEventsBody,
+		options?: RequestOptions,
+	): ResponsePromise<QueryAuditEventsResponse> {
+		return this.request(
+			'audit',
+			'/audit/events/query',
+			'POST',
+			`/audit/events/query`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /audit/events/{id} - Get a single audit event by ID
+	 *
+	 * @param id - Audit event ID
+	 * @param options - additional request options
+	 */
+	get_audit_event(id: string, options?: RequestOptions): ResponsePromise<GetAuditEventResponse> {
+		return this.request(
+			'audit',
+			'/audit/events/{id}',
+			'GET',
+			`/audit/events/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /audit/ingest - Ingest an audit event
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_audit_event(
+		body: PostAuditEventBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostAuditEventResponse> {
+		return this.request('audit', '/audit/ingest', 'POST', `/audit/ingest`, body, options);
+	}
 }

package/src/interface/audit.ts

@@ -0,0 +1,165 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface EntityRefFilterDTO {
+	// Entity type, e.g. location, brand, calendar
+	type: string;
+	// Entity ID
+	id: string;
+}
+
+export interface GetAuditEventsQueryDTO {
+	// Full-text search across action, source, resource name, and error message
+	q?: string;
+	// Filter by action, e.g. calendar_updated
+	action?: string;
+	// Filter by originating service, e.g. calendar-service
+	source?: string;
+	// Entity ref filters — each entry must match a nested entity_ref on the event. Multiple entries are AND-ed together. Use indexed notation: entity_refs[0][type]=location&entity_refs[0][id]=loc-123&entity_refs[1][type]=brand&entity_refs[1][id]=brand-456
+	entity_refs?: EntityRefFilterDTO[];
+	// Filter by actor user ID
+	actor_id?: string;
+	actor_type?: 'human' | 'service' | 'system';
+	outcome?: 'success' | 'failure';
+	// ISO 8601 start date (inclusive)
+	from?: string;
+	// ISO 8601 end date (inclusive)
+	to?: string;
+	// Dot-path that must exist in changes.old, e.g. timezone
+	old_path?: string;
+	// Value at old_path — use with old_path
+	old_value?: string;
+	// Dot-path that must exist in changes.new, e.g. timezone
+	new_path?: string;
+	// Value at new_path — use with new_path
+	new_value?: string;
+	// Page number (1-based)
+	page?: number;
+	// Items per page (max 100)
+	limit?: number;
+}
+
+export interface AuditActorDTO {
+	id: string;
+	type: 'human' | 'internal' | 'external';
+}
+
+export interface AuditResourceDTO {
+	type: string;
+	id: string;
+	name: string;
+}
+
+export interface AuditEntityRefDTO {
+	type: string;
+	id: string;
+	name?: string;
+}
+
+export interface AuditEventResponseDTO {
+	id: string;
+	action: string;
+	description?: string;
+	source: string;
+	timestamp: string;
+	ingested_at: string;
+	outcome: 'success' | 'failure';
+	correlation_id?: string;
+	actor: AuditActorDTO;
+	resource: AuditResourceDTO;
+	entity_refs: AuditEntityRefDTO[];
+	changes?: Record<string, any>;
+	error_message?: string;
+}
+
+export interface AuditEventsListResponseDTO {
+	events: AuditEventResponseDTO[];
+	total: number;
+	page: number;
+	limit: number;
+}
+
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
+}
+
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	// user friendly error message
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	// additional error data
+	data: ErrorData;
+}
+
+export interface TraceContextDTO {
+	traceId?: string;
+}
+
+export interface AuditEventPayloadDTO {
+	action: string;
+	description?: string;
+	actor: AuditActorDTO;
+	outcome: 'success' | 'failure';
+	error_message?: string;
+	entity_refs: AuditEntityRefDTO[];
+	resource: AuditResourceDTO;
+	changes?: Record<string, any>;
+	correlation_id?: string;
+}
+
+export interface IngestAuditEventDTO {
+	id: string;
+	version: 'v1.0' | '0.0.1';
+	// Time of the action; ISO-8601 preferred; epoch ms string also accepted from MessageBus
+	timestamp: string;
+	traceContext?: TraceContextDTO;
+	payload: AuditEventPayloadDTO;
+}
+
+export interface EventBridgeEnvelopeDTO {
+	'detail-type': 'AuditEvent';
+	source: string;
+	detail: IngestAuditEventDTO;
+}
+
+export interface IngestResponseDTO {
+	id: string;
+	status: 'indexed' | 'duplicate';
+}
+
+// POST /audit/events/query - Query audit events
+
+export type QueryAuditEventsBody = GetAuditEventsQueryDTO;
+
+export type QueryAuditEventsResponse = AuditEventsListResponseDTO;
+
+// GET /audit/events/{id} - Get a single audit event by ID
+
+export interface GetAuditEventPath {
+	// Audit event ID
+	id: string;
+}
+
+export type GetAuditEventResponse = AuditEventResponseDTO;
+
+// POST /audit/ingest - Ingest an audit event
+
+export type PostAuditEventBody = EventBridgeEnvelopeDTO;
+
+export type PostAuditEventResponse = IngestResponseDTO;

package/src/interface/centric-pos.ts

@@ -256,6 +256,43 @@ export interface PostOrderReceiptRequest {
 	receiptEmail: string;
 }
 
+export interface CentricPOSDeviceStation {
+	// Station (brand) ID
+	id: string;
+	// Station name
+	name?: string;
+	// Whether the station is hidden on this device
+	hidden: boolean;
+	// Whether the station can take orders: it has payment credentials or is a no-payment station
+	orderable: boolean;
+}
+
+export interface CentricPOSDevice {
+	// Serial number of the device
+	serialNumber: string;
+	// Site the device is registered at
+	siteId: string;
+	// Whether the device holds a login
+	registered: boolean;
+	// Whether the device's location is at its site and it shows at least one orderable station
+	complete: boolean;
+	// Location saved for the device
+	locationId?: string;
+	// Name of the device's location
+	locationName?: string;
+	// Merchant name set on the device's location
+	merchantName?: string;
+	// Centric POS stations at the device's location, with whether each is hidden
+	stations: CentricPOSDeviceStation[];
+}
+
+export interface CentricPOSDeviceSettingsPutBody {
+	// Location at the device's site
+	locationId: string;
+	// Stations at the location to hide on the device
+	hiddenStationIds: string[];
+}
+
 export interface DigitalSignageOrder {
 	// Display ID for the order
 	displayId: string;
@@ -337,6 +374,35 @@ export type PostCentricPosOrderReceiptBody = PostOrderReceiptRequest;
 
 export type PostCentricPosOrderReceiptResponse = {};
 
+// GET /centric-pos/v1/admin/device/{serialNumber} - Get a POS device with its settings
+
+export interface GetCentricPosAdminDevicePath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type GetCentricPosAdminDeviceResponse = CentricPOSDevice;
+
+// PUT /centric-pos/v1/admin/device/{serialNumber}/settings - Save a POS device's location and hidden stations
+
+export interface PutCentricPosAdminDeviceSettingsPath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type PutCentricPosAdminDeviceSettingsBody = CentricPOSDeviceSettingsPutBody;
+
+export type PutCentricPosAdminDeviceSettingsResponse = CentricPOSDevice;
+
+// DELETE /centric-pos/v1/admin/device/{serialNumber}/settings - Clear a POS device's settings without unregistering it
+
+export interface DeleteCentricPosAdminDeviceSettingsPath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type DeleteCentricPosAdminDeviceSettingsResponse = {};
+
 // GET /centric-pos/innovation/v1/digital-signage/orders/{stationId} - Get in-progress and ready orders for a station
 
 export interface GetCentricPosDigitalSignageOrdersPath {

package/src/interface/consumer.ts

@@ -4897,7 +4897,7 @@ export interface PostConsumerUserAccessCodeValidateRequest {
 
 export interface PostConsumerUserAccessCodeValidateResponse {
 	// The client the access code unlocks
-	client: 'amazon' | 'test-exclusive-company';
+	client: string;
 }
 
 export interface PostConsumerUserAccessCodeRedeemRequest {
@@ -4907,7 +4907,7 @@ export interface PostConsumerUserAccessCodeRedeemRequest {
 
 export interface PostConsumerUserAccessCodeRedeemResponse {
 	// The client the caller is now affiliated with
-	client: 'amazon' | 'test-exclusive-company';
+	client: string;
 }
 
 // GET /consumer/v1/health-check