@compassdigital/sdk.typescript 4.139.0 → 4.140.0

package/src/interface/catalog.ts

@@ -0,0 +1,325 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface CatalogResponseDTO {
+	id: number;
+	parent_id: number | null;
+	name: string;
+	display: Record<string, any>;
+	meta: Record<string, any> | null;
+	items: Record<string, any> | null;
+}
+
+export type CatalogItemResponseDTO = Record<string, any>;
+
+export interface PaginationQueryDTO {
+	// Page number
+	page?: number;
+	// Number of items per page
+	limit?: number;
+	// Field to sort by
+	sort_by?: string;
+	// Sort order
+	order?: 'ASC' | 'DESC';
+}
+
+export type FilterQueryDTO = Record<string, any>;
+
+export interface ListParamsDTO {
+	pagination?: PaginationQueryDTO;
+	filter?: FilterQueryDTO;
+}
+
+export type CatalogItemsListResponseDTO = Record<string, any>;
+
+export interface SearchConditionDTO {
+	// Contains search term
+	contains?: string;
+	// Exact match
+	equals?: Record<string, any>;
+	// Value greater than this
+	moreThan?: Record<string, any>;
+	// Value less than this
+	lessThan?: Record<string, any>;
+	// Negate condition (e.g., not equal). Accepts: `true` (boolean), `{ equals: 5 }` (object), `"sample string"` (string), or `123` (number).
+	not?: Record<string, any>;
+	// In the list of values
+	in?: string[];
+	// Array contains these values
+	arrayContains?: string[];
+	// Value greater than or equal to this
+	moreThanOrEqual?: Record<string, any>;
+	// Value less than or equal to this
+	lessThanOrEqual?: Record<string, any>;
+}
+
+export type BaseItemDTO = Record<string, any>;
+
+// GET /catalog/status - Get the status of the Catalog service
+
+export interface GetCatalogStatusQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogStatusResponse = {};
+
+export interface GetCatalogStatusRequest extends BaseRequest, RequestQuery<GetCatalogStatusQuery> {}
+
+// GET /catalog/status/connections - Get the status of Catalog database connections
+
+export interface GetCatalogConnectionsStatusQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogConnectionsStatusResponse = {};
+
+export interface GetCatalogConnectionsStatusRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogConnectionsStatusQuery> {}
+
+// POST /catalog/v1/catalog - Create a new catalog
+
+export interface PostCatalogBody {
+	name?: string;
+	display?: Record<string, any>;
+	parent_id?: number | null;
+	meta?: Record<string, any>;
+}
+
+export type PostCatalogResponse = CatalogResponseDTO;
+
+export interface PostCatalogRequest extends BaseRequest {
+	body: PostCatalogBody;
+}
+
+// PATCH /catalog/v1/catalog/{id} - Update a catalog
+
+export interface PatchCatalogPath {
+	id: number;
+}
+
+export interface PatchCatalogBody {
+	name?: string | null;
+	display?: Record<string, any> | null;
+	parent_id?: number | null;
+	meta?: Record<string, any> | null;
+}
+
+export type PatchCatalogResponse = CatalogResponseDTO;
+
+export interface PatchCatalogRequest extends BaseRequest, PatchCatalogPath {
+	body: PatchCatalogBody;
+}
+
+// GET /catalog/v1/catalog/{id} - Get a catalog
+
+export interface GetCatalogPath {
+	id: number;
+}
+
+export interface GetCatalogQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogResponse = CatalogResponseDTO;
+
+export interface GetCatalogRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogQuery>,
+		GetCatalogPath {}
+
+// DELETE /catalog/v1/catalog/{id} - Delete a catalog
+
+export interface DeleteCatalogPath {
+	id: number;
+}
+
+export type DeleteCatalogResponse = CatalogResponseDTO;
+
+export interface DeleteCatalogRequest extends BaseRequest, DeleteCatalogPath {}
+
+// POST /catalog/v1/catalog/{id}/item - Create a new catalog item
+
+export interface PostCatalogItemPath {
+	id: number;
+}
+
+export interface PostCatalogItemBody {
+	base_item_id?: string;
+	name?: string;
+	catalog_item_id?: number | null;
+	label?: string | null;
+	description?: string | null;
+	price?: number | null;
+	overrides?: Record<string, any> | null;
+	options?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+	is_visible?: boolean | null;
+	is_out_of_stock?: boolean | null;
+}
+
+export type PostCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface PostCatalogItemRequest extends BaseRequest, PostCatalogItemPath {
+	body: PostCatalogItemBody;
+}
+
+// POST /catalog/v1/catalog/{id}/items/bulk - Bulk create catalog items
+
+export interface PostCatalogItemsBulkPath {
+	id: number;
+}
+
+export type PostCatalogItemsBulkBody = string[];
+
+export type PostCatalogItemsBulkResponse = CatalogItemResponseDTO[];
+
+export interface PostCatalogItemsBulkRequest extends BaseRequest, PostCatalogItemsBulkPath {
+	body: PostCatalogItemsBulkBody;
+}
+
+// PATCH /catalog/v1/catalog/{catalog_id}/item/{id} - Update a catalog item
+
+export interface PatchCatalogItemPath {
+	catalog_id: number;
+	id: number;
+}
+
+export interface PatchCatalogItemBody {
+	base_item_id?: string;
+	name?: string | null;
+	label?: string | null;
+	description?: string | null;
+	price?: number | null;
+	overrides?: Record<string, any> | null;
+	options?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+	is_visible?: boolean | null;
+	is_out_of_stock?: boolean | null;
+}
+
+export type PatchCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface PatchCatalogItemRequest extends BaseRequest, PatchCatalogItemPath {
+	body: PatchCatalogItemBody;
+}
+
+// DELETE /catalog/v1/catalog/{catalog_id}/item/{id} - Delete a catalog item
+
+export interface DeleteCatalogItemPath {
+	catalog_id: number;
+	id: number;
+}
+
+export type DeleteCatalogItemResponse = CatalogItemResponseDTO;
+
+export interface DeleteCatalogItemRequest extends BaseRequest, DeleteCatalogItemPath {}
+
+// POST /catalog/v1/catalog/{id}/items - List catalog items
+
+export interface PostListCatalogItemsPath {
+	id: number;
+}
+
+export type PostListCatalogItemsBody = ListParamsDTO;
+
+export type PostListCatalogItemsResponse = CatalogItemsListResponseDTO;
+
+export interface PostListCatalogItemsRequest extends BaseRequest, PostListCatalogItemsPath {
+	body: PostListCatalogItemsBody;
+}
+
+// GET /catalog/v1/catalog/{id}/items - List catalog items
+
+export interface GetListCatalogItemsPath {
+	id: number;
+}
+
+export interface GetListCatalogItemsQuery {
+	page: number;
+	limit: number;
+	sort_by: string;
+	order: string;
+	filter: FilterQueryDTO;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetListCatalogItemsResponse = CatalogItemsListResponseDTO;
+
+export interface GetListCatalogItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetListCatalogItemsQuery>,
+		GetListCatalogItemsPath {}
+
+// POST /catalog/v1/catalog/{id}/clone - Clone a catalog
+
+export interface PostCloneCatalogPath {
+	id: number;
+}
+
+export type PostCloneCatalogResponse = CatalogResponseDTO;
+
+export interface PostCloneCatalogRequest extends BaseRequest, PostCloneCatalogPath {}
+
+// POST /catalog/v1/base-item - Create a new base item
+
+export interface PostCatalogBaseItemBody {
+	name?: string;
+	description?: string | null;
+	price?: number | null;
+	barcode?: string | null;
+	reporting?: Record<string, any> | null;
+	tax?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+}
+
+export type PostCatalogBaseItemResponse = BaseItemDTO;
+
+export interface PostCatalogBaseItemRequest extends BaseRequest {
+	body: PostCatalogBaseItemBody;
+}
+
+// GET /catalog/v1/base-item - List base items
+
+export interface GetCatalogBaseItemsQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetCatalogBaseItemsBody {
+	search?: string | null;
+	limit?: number;
+	offset?: number;
+}
+
+export type GetCatalogBaseItemsResponse = BaseItemDTO[];
+
+export interface GetCatalogBaseItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogBaseItemsQuery> {
+	body: GetCatalogBaseItemsBody;
+}
+
+// GET /catalog/v1/base-item/{id} - Get a base item by id
+
+export interface GetCatalogBaseItemPath {
+	id: string;
+}
+
+export interface GetCatalogBaseItemQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCatalogBaseItemResponse = BaseItemDTO;
+
+export interface GetCatalogBaseItemRequest
+	extends BaseRequest,
+		RequestQuery<GetCatalogBaseItemQuery>,
+		GetCatalogBaseItemPath {}