@compassdigital/sdk.typescript 3.21.0 → 3.22.0

package/src/index.ts

@@ -529,6 +529,43 @@ import {
   DeletePermissionRoleUserResponse,
 } from "./interface/permission";
 
+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 { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
 export * from "./base";
 
@@ -5387,4 +5424,448 @@ export class ServiceClient extends BaseServiceClient {
       options
     );
   }
+
+  /**
+   * 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
+    );
+  }
 }