@compassdigital/sdk.typescript 4.72.0 → 4.74.0

package/src/interface/config.ts

@@ -134,6 +134,7 @@ export interface PrivateMealplanConfig {
 		manual_id_entry?: string;
 		port?: number;
 		vendor_number?: number;
+		client?: string;
 	};
 }
 

package/src/interface/consumer.ts

@@ -1,107 +1,107 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface IsStatus {
-  eligible: boolean;
-  validated?: boolean;
-  preferred?: boolean;
+	eligible: boolean;
+	validated?: boolean;
+	preferred?: boolean;
 }
 
 export interface Tender {
-  id: string;
-  name?: string;
-  balance?: number;
-  type?: string;
-  currency?: string;
-  tender_number?: string;
-  is: IsStatus;
+	id: string;
+	name?: string;
+	balance?: number;
+	type?: string;
+	currency?: string;
+	tender_number?: string;
+	is: IsStatus;
 }
 
 export interface TenderList {
-  tenders: Tender[];
+	tenders: Tender[];
 }
 
 export interface BillingAddress {
-  postal_code?: string;
+	postal_code?: string;
 }
 
 export interface ExpiryDate {
-  month: number;
-  year: number;
+	month: number;
+	year: number;
 }
 
 export interface CreditCard {
-  billing_address?: BillingAddress;
-  card_type?: string;
-  expiry?: ExpiryDate;
-  is: IsStatus;
-  masked_card_number?: string;
-  name_on_card?: string;
-  nickname?: string;
-  token: string;
-  token_expiration_date?: string;
+	billing_address?: BillingAddress;
+	card_type?: string;
+	expiry?: ExpiryDate;
+	is: IsStatus;
+	masked_card_number?: string;
+	name_on_card?: string;
+	nickname?: string;
+	token: string;
+	token_expiration_date?: string;
 }
 
 export interface CreditCardData {
-  data: CreditCard[];
+	data: CreditCard[];
 }
 
 export interface DigitalWalletFlavor {
-  is: IsStatus;
+	is: IsStatus;
 }
 
 export interface DigitalWallet {
-  applewallet: DigitalWalletFlavor;
-  googlewallet: DigitalWalletFlavor;
+	applewallet: DigitalWalletFlavor;
+	googlewallet: DigitalWalletFlavor;
 }
 
 export interface ListAvailablePaymentsResponseDTO {
-  mealplan: TenderList;
-  cashless: TenderList;
-  credit_cards: CreditCardData;
-  digital_wallet_pay: DigitalWallet;
+	mealplan: TenderList;
+	cashless: TenderList;
+	credit_cards: CreditCardData;
+	digital_wallet_pay: DigitalWallet;
 }
 
 export interface UnauthorizedErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
 export interface NotFoundErrorDTO {
-  message: string;
-  code: number;
-  data: Record<string, any>;
+	message: string;
+	code: number;
+	data: Record<string, any>;
 }
 
-// GET /dev/consumer/v1/health-check
+// GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type HealthCheckControllerExecuteResponse = {};
 
 export interface HealthCheckControllerExecuteRequest
-  extends BaseRequest,
-    RequestQuery<HealthCheckControllerExecuteQuery> {}
+	extends BaseRequest,
+		RequestQuery<HealthCheckControllerExecuteQuery> {}
 
-// GET /dev/consumer/v1/payment-methods - List payment methods available in a given brand
+// GET /consumer/v1/payment-methods - List payment methods available in a given brand
 
 export interface GetPaymentListByBrandQuery {
-  // Brand ID as Encoded CDL ID
-  brandID?: string;
-  // Site ID as Encoded CDL ID
-  siteID?: string;
-  // Graphql query string
-  _query?: string;
+	// Brand ID as Encoded CDL ID
+	brandID?: string;
+	// Site ID as Encoded CDL ID
+	siteID?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetPaymentListByBrandResponse = ListAvailablePaymentsResponseDTO;
 
 export interface GetPaymentListByBrandRequest
-  extends BaseRequest,
-    RequestQuery<GetPaymentListByBrandQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetPaymentListByBrandQuery> {}

package/src/interface/mealplan.ts

@@ -232,6 +232,7 @@ export interface DeleteMealplanTenderResponse {
 	tender_id?: number;
 	currency?: string;
 	transaction_amount?: number;
+	drained_tender_name?: string;
 }
 
 export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {

package/src/interface/menu.ts

@@ -633,7 +633,7 @@ export interface DraftItemDTO {
 	tax_tags?: string[];
 	brand_id?: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: Record<string, any>;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -732,7 +732,7 @@ export interface DraftModifierDTO {
 	is_active?: boolean;
 	posid?: string;
 	reporting?: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id?: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
@@ -1049,7 +1049,7 @@ export interface PublishedItemDTO {
 	tax_tags?: string[];
 	brand_id?: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
 	tags?: string[];
@@ -1112,7 +1112,7 @@ export interface PublishedModifierDTO {
 	tax_tags?: string[];
 	is_active?: boolean;
 	posid?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id?: string;
 	line_route?: string;
 	is_out_of_stock?: boolean;
@@ -1413,7 +1413,7 @@ export interface DraftItemEntityDTO {
 	tax_tags?: string[];
 	brand_id: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -1452,7 +1452,7 @@ export interface DraftModifierEntityDTO {
 	is_active?: boolean;
 	posid?: string;
 	reporting: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
@@ -2324,6 +2324,42 @@ export interface GetMenuV3DraftLocalMenuGroupBrandsRequest
 		RequestQuery<GetMenuV3DraftLocalMenuGroupBrandsQuery>,
 		GetMenuV3DraftLocalMenuGroupBrandsPath {}
 
+// GET /menu/v3/draft/local-menu-group/{id}/items
+
+export interface GetMenuV3DraftLocalMenuGroupItemsPath {
+	id: string;
+}
+
+export interface GetMenuV3DraftLocalMenuGroupItemsQuery {
+	// If specified, only the selected fields will be returned
+	select?: string[];
+	// List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
+	relationships?: string[];
+	// The fields that filtering is allowed on
+	filter?: string;
+	// Number of records to load per page
+	limit?: number;
+	page?: number;
+	// A field to sort the results based on
+	sort_by?: string;
+	sort_order?: 'DESC' | 'ASC';
+	// How soft deleted records should be shown in the list
+	soft_deleted?: 'include' | 'exclude' | 'only';
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV3DraftLocalMenuGroupItemsResponse {
+	results: DraftItemDTO[];
+	meta?: ListResponseMetadataDTO;
+	[index: string]: any;
+}
+
+export interface GetMenuV3DraftLocalMenuGroupItemsRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3DraftLocalMenuGroupItemsQuery>,
+		GetMenuV3DraftLocalMenuGroupItemsPath {}
+
 // GET /menu/v3/local-menu-group/{id}/brands
 
 export interface GetMenuV3LocalMenuGroupBrandsPath {
@@ -2519,7 +2555,7 @@ export interface GetMenuV3LocalMenuGroupExportSolutionsRequest
 // GET /menu/v3/local-menu-group/{id}/export/solution/{solution_id}
 
 export interface GetMenuV3LocalMenuGroupExportSolutionPath {
-	// Id of the local menu group
+	// local_menu_group
 	id: string;
 	// export_solution
 	solution_id: string;
@@ -4736,7 +4772,7 @@ export interface PostMenuV3DraftItemBody {
 	tax_tags?: string[];
 	brand_id: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -4809,7 +4845,7 @@ export interface PatchMenuV3DraftItemBody {
 	tax_tags?: string[];
 	brand_id?: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -4921,7 +4957,7 @@ export type PostMenuV3DraftItemsBody = {
 	tax_tags?: string[];
 	brand_id: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -5024,7 +5060,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
 	tax_tags?: string[];
 	brand_id?: string;
 	line_route?: string;
-	posid_segment?: string;
+	posid_segment?: number;
 	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
@@ -6151,7 +6187,7 @@ export interface PostMenuV3DraftModifierBody {
 	is_active?: boolean;
 	posid?: string;
 	reporting: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
@@ -6224,7 +6260,7 @@ export interface PatchMenuV3DraftModifierBody {
 	is_active?: boolean;
 	posid?: string;
 	reporting?: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id?: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
@@ -6336,7 +6372,7 @@ export type PostMenuV3DraftModifiersBody = {
 	is_active?: boolean;
 	posid?: string;
 	reporting: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;
@@ -6439,7 +6475,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
 	is_active?: boolean;
 	posid?: string;
 	reporting?: ReportingMetadataDTO;
-	posid_segment?: string;
+	posid_segment?: number;
 	brand_id?: string;
 	line_route?: string;
 	menu_works?: MenuWorksDTO;

package/src/interface/shoppingcart.ts

@@ -45,6 +45,7 @@ export interface ItemResponse {
 		active?: boolean;
 		amount?: MonetaryValue;
 	};
+	weighed_price?: Price;
 	// Subtotal of the item including all options
 	_subtotal?: {
 		amount?: MonetaryValue;
@@ -483,11 +484,18 @@ export interface DrainOrderType {
 
 // POST /shoppingcart - Create a new ShoppingCart
 
+export interface PostShoppingcartCartQuery {
+	// If set to true then the hidden brand validation will be skipped, requires global write permission
+	skip_hidden_brand_check?: boolean;
+}
+
 export type PostShoppingcartCartBody = ShoppingCartRequest;
 
 export type PostShoppingcartCartResponse = ShoppingCartResponse;
 
-export interface PostShoppingcartCartRequest extends BaseRequest {
+export interface PostShoppingcartCartRequest
+	extends BaseRequest,
+		RequestQuery<PostShoppingcartCartQuery> {
 	body: PostShoppingcartCartBody;
 }
 
@@ -671,9 +679,17 @@ export interface PutShoppingcartCheckoutPath {
 	id: string;
 }
 
+export interface PutShoppingcartCheckoutQuery {
+	// If set to true then the hidden brand validation will be skipped, requires global write permission
+	skip_hidden_brand_check?: boolean;
+}
+
 export type PutShoppingcartCheckoutResponse = ShoppingCartResponse;
 
-export interface PutShoppingcartCheckoutRequest extends BaseRequest, PutShoppingcartCheckoutPath {}
+export interface PutShoppingcartCheckoutRequest
+	extends BaseRequest,
+		RequestQuery<PutShoppingcartCheckoutQuery>,
+		PutShoppingcartCheckoutPath {}
 
 // POST /shoppingcart/bulk - Get multiple ShoppingCarts
 

package/src/interface/util.ts

@@ -2,12 +2,12 @@
  * Convert number query parameters to string.
  */
 export type RequestQuery<T extends object> = {
-  [K in keyof T]: T[K] extends number|undefined ? string : T[K];
-}
+	[K in keyof T]: T[K] extends number | undefined ? string : T[K];
+};
 
 /**
  *  All requests implement this interface.
  */
 export interface BaseRequest {
-  headers?: Record<string, string>;
+	headers?: Record<string, string>;
 }

package/test/client.test.ts

@@ -26,7 +26,7 @@ describe('ServiceClient', () => {
 		expect(task).toEqual(fake);
 		const req = intercept.mock.calls[0][0];
 		expect(req).toEqual({
-			name: 'get_task',
+			route: '/task/{id}',
 			service: 'task',
 			url: 'https://dev.api.compassdigital.org/task/some_id',
 			method: 'get',