@compassdigital/sdk.typescript 4.419.0 → 4.421.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.419.0",
3
+ "version": "4.421.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -623,6 +623,8 @@ import {
623
623
  GetMenuV3DraftBrandVerifyPublishResponse,
624
624
  PostMenuV3DraftBrandArchiveResponse,
625
625
  PostMenuV3DraftBrandUnarchiveResponse,
626
+ PostMenuV3DraftBrandSyncMenuworksQuery,
627
+ PostMenuV3DraftBrandSyncMenuworksResponse,
626
628
  PostMenuV3BrandQuery,
627
629
  PostMenuV3BrandBody,
628
630
  PostMenuV3BrandResponse,
@@ -1177,6 +1179,10 @@ import {
1177
1179
  GetPaymentCashlessConsumerResponse,
1178
1180
  GetPaymentClienttokenConsumerQuery,
1179
1181
  GetPaymentClienttokenConsumerResponse,
1182
+ GetPaymentHpcConsumerQuery,
1183
+ GetPaymentHpcConsumerResponse,
1184
+ GetPaymentTokenConsumerQuery,
1185
+ GetPaymentTokenConsumerResponse,
1180
1186
  GetConsumerShoppingcartResponse,
1181
1187
  PutConsumerShoppingcartBody,
1182
1188
  PutConsumerShoppingcartResponse,
@@ -7404,6 +7410,28 @@ export class ServiceClient extends BaseServiceClient {
7404
7410
  );
7405
7411
  }
7406
7412
 
7413
+ /**
7414
+ * POST /menu/v3/draft/brand/{id}/sync-menuworks
7415
+ *
7416
+ * @param id - TODO: add parameter to swagger.json
7417
+ * @param options - additional request options
7418
+ */
7419
+ post_menu_v3_draft_brand_sync_menuworks(
7420
+ id: string,
7421
+ options?: {
7422
+ query?: PostMenuV3DraftBrandSyncMenuworksQuery;
7423
+ } & RequestOptions,
7424
+ ): ResponsePromise<PostMenuV3DraftBrandSyncMenuworksResponse> {
7425
+ return this.request(
7426
+ 'menu',
7427
+ '/menu/v3/draft/brand/{id}/sync-menuworks',
7428
+ 'POST',
7429
+ `/menu/v3/draft/brand/${id}/sync-menuworks`,
7430
+ null,
7431
+ options,
7432
+ );
7433
+ }
7434
+
7407
7435
  /**
7408
7436
  * POST /menu/v3/brand
7409
7437
  *
@@ -13356,6 +13384,46 @@ export class ServiceClient extends BaseServiceClient {
13356
13384
  );
13357
13385
  }
13358
13386
 
13387
+ /**
13388
+ * GET /consumer/payment/hpc - Get FreedomPay HPC iframe for payment card entry
13389
+ *
13390
+ * @param options - additional request options
13391
+ */
13392
+ get_payment_hpc_consumer(
13393
+ options: {
13394
+ query: GetPaymentHpcConsumerQuery;
13395
+ } & RequestOptions,
13396
+ ): ResponsePromise<GetPaymentHpcConsumerResponse> {
13397
+ return this.request(
13398
+ 'consumer',
13399
+ '/consumer/payment/hpc',
13400
+ 'GET',
13401
+ `/consumer/payment/hpc`,
13402
+ null,
13403
+ options,
13404
+ );
13405
+ }
13406
+
13407
+ /**
13408
+ * GET /consumer/payment/token - Get FreedomPay payment token from HPC session
13409
+ *
13410
+ * @param options - additional request options
13411
+ */
13412
+ get_payment_token_consumer(
13413
+ options: {
13414
+ query: GetPaymentTokenConsumerQuery;
13415
+ } & RequestOptions,
13416
+ ): ResponsePromise<GetPaymentTokenConsumerResponse> {
13417
+ return this.request(
13418
+ 'consumer',
13419
+ '/consumer/payment/token',
13420
+ 'GET',
13421
+ `/consumer/payment/token`,
13422
+ null,
13423
+ options,
13424
+ );
13425
+ }
13426
+
13359
13427
  /**
13360
13428
  * GET /consumer/shoppingcart/{id} - Get a shopping cart by ID
13361
13429
  *
@@ -2228,6 +2228,38 @@ export interface ConsumerGetPaymentClienttokenResponse {
2228
2228
  expires_in?: number;
2229
2229
  }
2230
2230
 
2231
+ export interface ConsumerGetPaymentHpcResponse {
2232
+ // FreedomPay HPC iframe HTML
2233
+ iframe?: string;
2234
+ // Session key for subsequent HPC operations
2235
+ sessionKey?: string;
2236
+ }
2237
+
2238
+ export interface ConsumerGetPaymentTokenResponse {
2239
+ // Payment token
2240
+ token?: string;
2241
+ // Masked account number
2242
+ accountNumberMasked?: string;
2243
+ // Card expiration month
2244
+ cardExpirationMonth?: string;
2245
+ // Card expiration year
2246
+ cardExpirationYear?: string;
2247
+ // Card brand
2248
+ brand?: string;
2249
+ // POS card type
2250
+ posCardType?: string;
2251
+ // Card type
2252
+ cardType?: string;
2253
+ // Token expiration
2254
+ tokenExpiration?: string;
2255
+ // POS data
2256
+ posData?: string;
2257
+ // New token
2258
+ newToken?: string;
2259
+ // Session key
2260
+ sessionKey?: string;
2261
+ }
2262
+
2231
2263
  export interface PromoDetails {
2232
2264
  code?: string;
2233
2265
  provider?: Record<string, any>;
@@ -3648,6 +3680,36 @@ export interface GetPaymentClienttokenConsumerQuery {
3648
3680
 
3649
3681
  export type GetPaymentClienttokenConsumerResponse = ConsumerGetPaymentClienttokenResponse;
3650
3682
 
3683
+ // GET /consumer/payment/hpc - Get FreedomPay HPC iframe for payment card entry
3684
+
3685
+ export interface GetPaymentHpcConsumerQuery {
3686
+ // CDL Site ID
3687
+ siteId: string;
3688
+ // hCaptcha response key
3689
+ captchaResponseKey: string;
3690
+ // Graphql query string
3691
+ _query?: string;
3692
+ }
3693
+
3694
+ export type GetPaymentHpcConsumerResponse = ConsumerGetPaymentHpcResponse;
3695
+
3696
+ // GET /consumer/payment/token - Get FreedomPay payment token from HPC session
3697
+
3698
+ export interface GetPaymentTokenConsumerQuery {
3699
+ // Payment Key
3700
+ paymentKey: string;
3701
+ // Session key
3702
+ sessionKey: string;
3703
+ // CDL Site ID
3704
+ siteId: string;
3705
+ // Name on card
3706
+ nameOnCard: string;
3707
+ // Graphql query string
3708
+ _query?: string;
3709
+ }
3710
+
3711
+ export type GetPaymentTokenConsumerResponse = ConsumerGetPaymentTokenResponse;
3712
+
3651
3713
  // GET /consumer/shoppingcart/{id} - Get a shopping cart by ID
3652
3714
 
3653
3715
  export interface GetConsumerShoppingcartPath {
@@ -4086,6 +4086,28 @@ export interface PostMenuV3DraftBrandUnarchiveRequest
4086
4086
  extends BaseRequest,
4087
4087
  PostMenuV3DraftBrandUnarchivePath {}
4088
4088
 
4089
+ // POST /menu/v3/draft/brand/{id}/sync-menuworks
4090
+
4091
+ export interface PostMenuV3DraftBrandSyncMenuworksPath {
4092
+ // TODO: add parameter to swagger.json
4093
+ id: string;
4094
+ }
4095
+
4096
+ export interface PostMenuV3DraftBrandSyncMenuworksQuery {
4097
+ brand_id?: string;
4098
+ }
4099
+
4100
+ export interface PostMenuV3DraftBrandSyncMenuworksResponse {
4101
+ process_id: string;
4102
+ status: string;
4103
+ [index: string]: any;
4104
+ }
4105
+
4106
+ export interface PostMenuV3DraftBrandSyncMenuworksRequest
4107
+ extends BaseRequest,
4108
+ RequestQuery<PostMenuV3DraftBrandSyncMenuworksQuery>,
4109
+ PostMenuV3DraftBrandSyncMenuworksPath {}
4110
+
4089
4111
  // POST /menu/v3/brand
4090
4112
 
4091
4113
  export interface PostMenuV3BrandQuery {