@compassdigital/sdk.typescript 3.17.0 → 3.19.0

package/src/index.ts

@@ -182,6 +182,7 @@ import {
   DeleteShoppingcartCartLoyaltyResponse,
   PostShoppingcartCloneCartBody,
   PostShoppingcartCloneCartResponse,
+  PutShoppingcartCheckoutResponse,
   PostShoppingcartBulkBody,
   PostShoppingcartBulkResponse,
 } from "./interface/shoppingcart";
@@ -292,8 +293,6 @@ import {
   GetPromoVoucherifyActivityConfigResponse,
 } from "./interface/promo";
 
-import { PostDhSqlResponse } from "./interface/dh";
-
 import {
   GetConfigAppconfigResponse,
   GetConfigResponse,
@@ -398,45 +397,6 @@ import {
   PutUserVerificationPhoneResponse,
 } from "./interface/user";
 
-import {
-  PostLoyaltyEnrollQuery,
-  PostLoyaltyEnrollResponse,
-  GetLoyaltyPointsQuery,
-  GetLoyaltyPointsResponse,
-  GetLoyaltyOffersResponse,
-  GetLoyaltyEnrollmentstatusResponse,
-  GetLoyaltyBalanceResponse,
-  GetLoyaltyOpportunitiesQuery,
-  GetLoyaltyOpportunitiesResponse,
-  PostLoyaltyOpportunitiesQuery,
-  PostLoyaltyOpportunitiesResponse,
-  GetLoyaltyRewardsResponse,
-  GetLoyaltyCouponsResponse,
-  GetLoyaltyOrderpointsQuery,
-  GetLoyaltyOrderpointsResponse,
-  PostLoyaltyOrderpointsBody,
-  PostLoyaltyOrderpointsResponse,
-  PostLoyaltyPurchaseQuery,
-  PostLoyaltyPurchaseBody,
-  PostLoyaltyPurchaseResponse,
-  PostLoyaltyBuyrewardQuery,
-  PostLoyaltyBuyrewardBody,
-  PostLoyaltyBuyrewardResponse,
-  GetLoyaltyHistoryQuery,
-  GetLoyaltyHistoryResponse,
-  GetLoyaltyCouponResponse,
-  PatchLoyaltyCouponBody,
-  PatchLoyaltyCouponResponse,
-  GetLoyaltySearchQuery,
-  GetLoyaltySearchResponse,
-  GetLoyaltyUsersQuery,
-  GetLoyaltyUsersResponse,
-  GetLoyaltyEventsQuery,
-  GetLoyaltyEventsResponse,
-} from "./interface/loyalty";
-
-import { GetBrandResponse, GetBrandsResponse } from "./interface/brand";
-
 import {
   GetCalendarQuery,
   GetCalendarResponse,
@@ -449,31 +409,6 @@ import {
   PostCalendarSyncResponse,
 } from "./interface/calendar";
 
-import {
-  PostDeliveryOrderBody,
-  PostDeliveryOrderResponse,
-  PatchDeliveryOrderResponse,
-  GetDeliveryOrderResponse,
-} from "./interface/delivery";
-
-import {
-  PostScheduleBody,
-  PostScheduleResponse,
-  GetSchedulesQuery,
-  GetSchedulesResponse,
-  GetScheduleResponse,
-  PutScheduleBody,
-  PutScheduleResponse,
-  DeleteScheduleResponse,
-} from "./interface/schedule";
-
-import {
-  PostVoteBody,
-  PostVoteResponse,
-  GetVoteIdfaQuery,
-  GetVoteIdfaResponse,
-} from "./interface/vote";
-
 import {
   PostFileBody,
   PostFileResponse,
@@ -481,10 +416,6 @@ import {
   DeleteFileResponse,
 } from "./interface/file";
 
-import { PostMessageBody, PostMessageResponse, GetMessageResponse } from "./interface/message";
-
-import { GetLoggerBrandStatusQuery, GetLoggerBrandStatusResponse } from "./interface/logger";
-
 import {
   GetMenuClientResponse,
   GetMenusQuery,
@@ -2435,6 +2366,26 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * PUT /shoppingcart/{id}/checkout - handle ui checkout flow and call taxjar for full tax breakdown
+   *
+   * @param id - Shopping cart ID
+   * @param options - additional request options
+   */
+  put_shoppingcart_checkout(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<PutShoppingcartCheckoutResponse> {
+    return this.request(
+      "shoppingcart",
+      "put_shoppingcart_checkout",
+      "put",
+      `/shoppingcart/${id}/checkout`,
+      null,
+      options
+    );
+  }
+
   /**
    * POST /shoppingcart/bulk - Get multiple ShoppingCarts
    *
@@ -3351,15 +3302,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * POST /dh/sql
-   *
-   * @param options - additional request options
-   */
-  post_dh_sql(options?: RequestOptions): ResponsePromise<PostDhSqlResponse> {
-    return this.request("dh", "post_dh_sql", "post", `/dh/sql`, null, options);
-  }
-
   /**
    * GET /config/appconfig - get appconfig - an object with data for clients including minimum versions apps (boost, thrive, J&J) should be running and a link to the respective app store
    *
@@ -4301,469 +4243,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * POST /loyalty/{id}/enroll/{user_id} - Enroll logged in user in Loyalty program
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  post_loyalty_enroll(
-    id: string,
-    user_id: string,
-    options?: {
-      query?: PostLoyaltyEnrollQuery;
-    } & RequestOptions
-  ): ResponsePromise<PostLoyaltyEnrollResponse> {
-    return this.request(
-      "loyalty",
-      "post_loyalty_enroll",
-      "post",
-      `/loyalty/${id}/enroll/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/points - Get potential points user could earn from certain event in Loyalty program
-   *
-   * @param id - Loyalty Provider id
-   * @param options - additional request options
-   */
-  get_loyalty_points(
-    id: string,
-    options: {
-      query: GetLoyaltyPointsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyPointsResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_points",
-      "get",
-      `/loyalty/${id}/points`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/offers/{user_id} - Get offers for the logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_offers(
-    id: string,
-    user_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyOffersResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_offers",
-      "get",
-      `/loyalty/${id}/offers/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/enrollmentstatus/{user_id} - Get enrollment status for logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_enrollmentstatus(
-    id: string,
-    user_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyEnrollmentstatusResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_enrollmentstatus",
-      "get",
-      `/loyalty/${id}/enrollmentstatus/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/balance/{user_id} - Get loyalty point balance for logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_balance(
-    id: string,
-    user_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyBalanceResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_balance",
-      "get",
-      `/loyalty/${id}/balance/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/opportunities/{user_id} - Get earning opportunities for the logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_opportunities(
-    id: string,
-    user_id: string,
-    options?: {
-      query?: GetLoyaltyOpportunitiesQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyOpportunitiesResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_opportunities",
-      "get",
-      `/loyalty/${id}/opportunities/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * POST /loyalty/{id}/opportunities/{user_id} - Record an event for the logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  post_loyalty_opportunities(
-    id: string,
-    user_id: string,
-    options: {
-      query: PostLoyaltyOpportunitiesQuery;
-    } & RequestOptions
-  ): ResponsePromise<PostLoyaltyOpportunitiesResponse> {
-    return this.request(
-      "loyalty",
-      "post_loyalty_opportunities",
-      "post",
-      `/loyalty/${id}/opportunities/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/rewards/{user_id} - Get rewards available for the logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_rewards(
-    id: string,
-    user_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyRewardsResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_rewards",
-      "get",
-      `/loyalty/${id}/rewards/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/coupons/{user_id} - Get coupons available for the logged in user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_coupons(
-    id: string,
-    user_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyCouponsResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_coupons",
-      "get",
-      `/loyalty/${id}/coupons/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for an order based on amount.
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_orderpoints(
-    id: string,
-    user_id: string,
-    options: {
-      query: GetLoyaltyOrderpointsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyOrderpointsResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_orderpoints",
-      "get",
-      `/loyalty/${id}/orderpoints/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * POST /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for a order based on amount and items
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param body
-   * @param options - additional request options
-   */
-  post_loyalty_orderpoints(
-    id: string,
-    user_id: string,
-    body: PostLoyaltyOrderpointsBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostLoyaltyOrderpointsResponse> {
-    return this.request(
-      "loyalty",
-      "post_loyalty_orderpoints",
-      "post",
-      `/loyalty/${id}/orderpoints/${user_id}`,
-      body,
-      options
-    );
-  }
-
-  /**
-   * POST /loyalty/{id}/purchase/{user_id} - Record purchase event
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param body
-   * @param options - additional request options
-   */
-  post_loyalty_purchase(
-    id: string,
-    user_id: string,
-    body: PostLoyaltyPurchaseBody,
-    options?: {
-      query?: PostLoyaltyPurchaseQuery;
-    } & RequestOptions
-  ): ResponsePromise<PostLoyaltyPurchaseResponse> {
-    return this.request(
-      "loyalty",
-      "post_loyalty_purchase",
-      "post",
-      `/loyalty/${id}/purchase/${user_id}`,
-      body,
-      options
-    );
-  }
-
-  /**
-   * POST /loyalty/{id}/buyreward/{user_id} - Redeem rewards to coupons
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param body
-   * @param options - additional request options
-   */
-  post_loyalty_buyreward(
-    id: string,
-    user_id: string,
-    body: PostLoyaltyBuyrewardBody,
-    options?: {
-      query?: PostLoyaltyBuyrewardQuery;
-    } & RequestOptions
-  ): ResponsePromise<PostLoyaltyBuyrewardResponse> {
-    return this.request(
-      "loyalty",
-      "post_loyalty_buyreward",
-      "post",
-      `/loyalty/${id}/buyreward/${user_id}`,
-      body,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/history/{user_id} - Get history of loyalty transactions for user
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param options - additional request options
-   */
-  get_loyalty_history(
-    id: string,
-    user_id: string,
-    options?: {
-      query?: GetLoyaltyHistoryQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyHistoryResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_history",
-      "get",
-      `/loyalty/${id}/history/${user_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/coupon/{user_id}/{coupon_id} - get coupon's information
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param coupon_id - Coupon code to get coupon information
-   * @param options - additional request options
-   */
-  get_loyalty_coupon(
-    id: string,
-    user_id: string,
-    coupon_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetLoyaltyCouponResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_coupon",
-      "get",
-      `/loyalty/${id}/coupon/${user_id}/${coupon_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * PATCH /loyalty/{id}/coupon/{user_id}/{coupon_id} - Update coupon's status
-   *
-   * @param id - Loyalty Provider id
-   * @param user_id - CompassDigital User id
-   * @param coupon_id - Coupon code to update
-   * @param body
-   * @param options - additional request options
-   */
-  patch_loyalty_coupon(
-    id: string,
-    user_id: string,
-    coupon_id: string,
-    body: PatchLoyaltyCouponBody,
-    options?: RequestOptions
-  ): ResponsePromise<PatchLoyaltyCouponResponse> {
-    return this.request(
-      "loyalty",
-      "patch_loyalty_coupon",
-      "patch",
-      `/loyalty/${id}/coupon/${user_id}/${coupon_id}`,
-      body,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/search - Search CDL user id by internal 500friends id
-   *
-   * @param id - Loyalty Provider id
-   * @param options - additional request options
-   */
-  get_loyalty_search(
-    id: string,
-    options: {
-      query: GetLoyaltySearchQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltySearchResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_search",
-      "get",
-      `/loyalty/${id}/search`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/users - Get all loyalty users updated after specific date
-   *
-   * @param id - Loyalty Provider id
-   * @param options - additional request options
-   */
-  get_loyalty_users(
-    id: string,
-    options: {
-      query: GetLoyaltyUsersQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyUsersResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_users",
-      "get",
-      `/loyalty/${id}/users`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /loyalty/{id}/events - Get all loyalty events updated after specific date
-   *
-   * @param id - Loyalty Provider id
-   * @param options - additional request options
-   */
-  get_loyalty_events(
-    id: string,
-    options: {
-      query: GetLoyaltyEventsQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoyaltyEventsResponse> {
-    return this.request(
-      "loyalty",
-      "get_loyalty_events",
-      "get",
-      `/loyalty/${id}/events`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /brand/{id}
-   *
-   * @param id - TODO: add parameter to swagger.json
-   * @param options - additional request options
-   */
-  get_brand(id: string, options?: RequestOptions): ResponsePromise<GetBrandResponse> {
-    return this.request("brand", "get_brand", "get", `/brand/${id}`, null, options);
-  }
-
-  /**
-   * GET /brand
-   *
-   * @param options - additional request options
-   */
-  get_brands(options?: RequestOptions): ResponsePromise<GetBrandsResponse> {
-    return this.request("brand", "get_brands", "get", `/brand`, null, options);
-  }
-
   /**
    * GET /calendar/{id}
    *
@@ -4862,152 +4341,6 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
-  /**
-   * POST /delivery/order - make reservation
-   *
-   * @param body - reservation
-   * @param options - additional request options
-   */
-  post_delivery_order(
-    body: PostDeliveryOrderBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostDeliveryOrderResponse> {
-    return this.request(
-      "delivery",
-      "post_delivery_order",
-      "post",
-      `/delivery/order`,
-      body,
-      options
-    );
-  }
-
-  /**
-   * PATCH /delivery/order/{order_id} - confirm order
-   *
-   * @param order_id - TODO: add parameter to swagger.json
-   * @param options - additional request options
-   */
-  patch_delivery_order(
-    order_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<PatchDeliveryOrderResponse> {
-    return this.request(
-      "delivery",
-      "patch_delivery_order",
-      "patch",
-      `/delivery/order/${order_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * GET /delivery/order/{order_id} - get order
-   *
-   * @param order_id - TODO: add parameter to swagger.json
-   * @param options - additional request options
-   */
-  get_delivery_order(
-    order_id: string,
-    options?: RequestOptions
-  ): ResponsePromise<GetDeliveryOrderResponse> {
-    return this.request(
-      "delivery",
-      "get_delivery_order",
-      "get",
-      `/delivery/order/${order_id}`,
-      null,
-      options
-    );
-  }
-
-  /**
-   * POST /schedule - Create a new schedule
-   *
-   * @param body
-   * @param options - additional request options
-   */
-  post_schedule(
-    body: PostScheduleBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostScheduleResponse> {
-    return this.request("schedule", "post_schedule", "post", `/schedule`, body, options);
-  }
-
-  /**
-   * GET /schedule - Get schedule
-   *
-   * @param options - additional request options
-   */
-  get_schedules(
-    options: {
-      query: GetSchedulesQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetSchedulesResponse> {
-    return this.request("schedule", "get_schedules", "get", `/schedule`, null, options);
-  }
-
-  /**
-   * GET /schedule/{id} - Get an individual schedule
-   *
-   * @param id - schedule id
-   * @param options - additional request options
-   */
-  get_schedule(id: string, options?: RequestOptions): ResponsePromise<GetScheduleResponse> {
-    return this.request("schedule", "get_schedule", "get", `/schedule/${id}`, null, options);
-  }
-
-  /**
-   * PUT /schedule/{id} - Update a schedule
-   *
-   * @param id - Id of a schedule
-   * @param body
-   * @param options - additional request options
-   */
-  put_schedule(
-    id: string,
-    body: PutScheduleBody,
-    options?: RequestOptions
-  ): ResponsePromise<PutScheduleResponse> {
-    return this.request("schedule", "put_schedule", "put", `/schedule/${id}`, body, options);
-  }
-
-  /**
-   * DELETE /schedule/{id} - Delete schedule
-   *
-   * @param id - Id of a schedule
-   * @param options - additional request options
-   */
-  delete_schedule(id: string, options?: RequestOptions): ResponsePromise<DeleteScheduleResponse> {
-    return this.request("schedule", "delete_schedule", "delete", `/schedule/${id}`, null, options);
-  }
-
-  /**
-   * POST /vote - Submit a vote for an item
-   *
-   * @param body
-   * @param options - additional request options
-   */
-  post_vote(body: PostVoteBody, options?: RequestOptions): ResponsePromise<PostVoteResponse> {
-    return this.request("vote", "post_vote", "post", `/vote`, body, options);
-  }
-
-  /**
-   * GET /vote/idfa/{idfa} - Get votes for an idfa
-   *
-   * @param idfa - TODO: add parameter to swagger.json
-   * @param options - additional request options
-   */
-  get_vote_idfa(
-    idfa: string,
-    options?: {
-      query?: GetVoteIdfaQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetVoteIdfaResponse> {
-    return this.request("vote", "get_vote_idfa", "get", `/vote/idfa/${idfa}`, null, options);
-  }
-
   /**
    * POST /file - Upload a file to CDL S3
    *
@@ -5028,51 +4361,6 @@ export class ServiceClient extends BaseServiceClient {
     return this.request("file", "delete_file", "delete", `/file`, body, options);
   }
 
-  /**
-   * POST /message - Create a Message
-   *
-   * @param body - Message object that needs to be created
-   * @param options - additional request options
-   */
-  post_message(
-    body: PostMessageBody,
-    options?: RequestOptions
-  ): ResponsePromise<PostMessageResponse> {
-    return this.request("message", "post_message", "post", `/message`, body, options);
-  }
-
-  /**
-   * GET /message/{id} - Get a Message
-   *
-   * @param id - Message CDL encoded id
-   * @param options - additional request options
-   */
-  get_message(id: string, options?: RequestOptions): ResponsePromise<GetMessageResponse> {
-    return this.request("message", "get_message", "get", `/message/${id}`, null, options);
-  }
-
-  /**
-   * GET /logger/{id}/brand/status - Get status changes of all brands
-   *
-   * @param id - action
-   * @param options - additional request options
-   */
-  get_logger_brand_status(
-    id: string,
-    options?: {
-      query?: GetLoggerBrandStatusQuery;
-    } & RequestOptions
-  ): ResponsePromise<GetLoggerBrandStatusResponse> {
-    return this.request(
-      "logger",
-      "get_logger_brand_status",
-      "get",
-      `/logger/${id}/brand/status`,
-      null,
-      options
-    );
-  }
-
   /**
    * GET /menu/client/{client_id} - Get menu client
    *