@compassdigital/sdk.typescript 4.27.0 → 4.29.0

package/src/index.ts

@@ -876,29 +876,36 @@ import {
 } from "./interface/delivery";
 
 import {
-  PostFrictionlessWebhookStandardcognitionBody,
-  PostFrictionlessWebhookStandardcognitionResponse,
-  PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody,
-  PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse,
-  PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody,
-  PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse,
   GetFrictionlessBrandFrictionlessStatusQuery,
   GetFrictionlessBrandFrictionlessStatusResponse,
   PostFrictionlessQrCodeBody,
   PostFrictionlessQrCodeResponse,
-  GetFrictionlessFailedCheckinsQuery,
-  GetFrictionlessFailedCheckinsResponse,
-  PostFrictionlessCheckinsReprocessResponse,
   GetFrictionlessCheckinStatusQuery,
   GetFrictionlessCheckinStatusResponse,
+  GetFrictionlessCheckinQuery,
+  GetFrictionlessCheckinResponse,
   GetFrictionlessUsersPaymentIssuesQuery,
   GetFrictionlessUsersPaymentIssuesResponse,
+  GetFrictionlessFailedCheckinsQuery,
+  GetFrictionlessFailedCheckinsResponse,
+  PostFrictionlessCheckinsReprocessResponse,
   PostFrictionlessCheckinReprocessPaymentBody,
   PostFrictionlessCheckinReprocessPaymentResponse,
-  GetFrictionlessCheckinQuery,
-  GetFrictionlessCheckinResponse,
+  PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody,
+  PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse,
+  PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody,
+  PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse,
+  PostFrictionlessWebhookStandardcognitionBody,
+  PostFrictionlessWebhookStandardcognitionResponse,
 } from "./interface/frictionless";
 
+import {
+  HealthCheckControllerExecuteQuery,
+  HealthCheckControllerExecuteResponse,
+  GetPaymentListByBrandQuery,
+  GetPaymentListByBrandResponse,
+} from "./interface/consumer";
+
 import {
   PostAiLanguageGenerateBody,
   PostAiLanguageGenerateResponse,
@@ -8722,7 +8729,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * PATCH /vendor/application/{id} - Update an application (or update status)
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id
    * @param body
    * @param options - additional request options
    */
@@ -9028,103 +9035,109 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
+   * GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
    *
-   * @param body
+   * @param id_brand - Brand ID as Encoded CDL ID
    * @param options - additional request options
    */
-  post_frictionless_webhook_standardcognition(
-    body: PostFrictionlessWebhookStandardcognitionBody,
-    options?: RequestOptions,
-  ): ResponsePromise<PostFrictionlessWebhookStandardcognitionResponse> {
+  get_frictionless_brand_frictionless_status(
+    id_brand: string,
+    options?: {
+      query?: GetFrictionlessBrandFrictionlessStatusQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetFrictionlessBrandFrictionlessStatusResponse> {
     return this.request(
       "frictionless",
-      "post_frictionless_webhook_standardcognition",
-      "post",
-      `/frictionless/webhook/standardcognition`,
-      body,
+      "get_frictionless_brand_frictionless_status",
+      "get",
+      `/frictionless/brand/${id_brand}/frictionless-status`,
+      null,
       options,
     );
   }
 
   /**
-   * POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
+   * POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
    *
    * @param body
    * @param options - additional request options
    */
-  post_frictionless_amazon_jwo_connector_v1_identity_identity_keys(
-    body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody,
+  post_frictionless_qr_code(
+    body: PostFrictionlessQrCodeBody,
     options?: RequestOptions,
-  ): ResponsePromise<PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse> {
+  ): ResponsePromise<PostFrictionlessQrCodeResponse> {
     return this.request(
       "frictionless",
-      "post_frictionless_amazon_jwo_connector_v1_identity_identity_keys",
+      "post_frictionless_qr_code",
       "post",
-      `/frictionless/amazon-jwo-connector/v1/identity/identity-keys`,
+      `/frictionless/qrcode`,
       body,
       options,
     );
   }
 
   /**
-   * POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
+   * GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
    *
-   * @param body
+   * @param id_checkin
    * @param options - additional request options
    */
-  post_frictionless_amazon_jwo_connector_v1_order_purchases(
-    body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody,
-    options?: RequestOptions,
-  ): ResponsePromise<PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse> {
+  get_frictionless_checkin_status(
+    id_checkin: string,
+    options?: {
+      query?: GetFrictionlessCheckinStatusQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetFrictionlessCheckinStatusResponse> {
     return this.request(
       "frictionless",
-      "post_frictionless_amazon_jwo_connector_v1_order_purchases",
-      "post",
-      `/frictionless/amazon-jwo-connector/v1/order/purchases`,
-      body,
+      "get_frictionless_checkin_status",
+      "get",
+      `/frictionless/checkin/${id_checkin}/status`,
+      null,
       options,
     );
   }
 
   /**
-   * GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
+   * GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
    *
-   * @param id_brand - Brand ID as Encoded CDL ID
+   * @param id_checkin
    * @param options - additional request options
    */
-  get_frictionless_brand_frictionless_status(
-    id_brand: string,
+  get_frictionless_checkin(
+    id_checkin: string,
     options?: {
-      query?: GetFrictionlessBrandFrictionlessStatusQuery;
+      query?: GetFrictionlessCheckinQuery;
     } & RequestOptions,
-  ): ResponsePromise<GetFrictionlessBrandFrictionlessStatusResponse> {
+  ): ResponsePromise<GetFrictionlessCheckinResponse> {
     return this.request(
       "frictionless",
-      "get_frictionless_brand_frictionless_status",
+      "get_frictionless_checkin",
       "get",
-      `/frictionless/brand/${id_brand}/frictionless-status`,
+      `/frictionless/checkin/${id_checkin}`,
       null,
       options,
     );
   }
 
   /**
-   * POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
+   * GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
    *
-   * @param body
+   * @param user_id
    * @param options - additional request options
    */
-  post_frictionless_qr_code(
-    body: PostFrictionlessQrCodeBody,
-    options?: RequestOptions,
-  ): ResponsePromise<PostFrictionlessQrCodeResponse> {
+  get_frictionless_users_payment_issues(
+    user_id: string,
+    options?: {
+      query?: GetFrictionlessUsersPaymentIssuesQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetFrictionlessUsersPaymentIssuesResponse> {
     return this.request(
       "frictionless",
-      "post_frictionless_qr_code",
-      "post",
-      `/frictionless/qrcode`,
-      body,
+      "get_frictionless_users_payment_issues",
+      "get",
+      `/frictionless/users/${user_id}/checkins/payment-issues`,
+      null,
       options,
     );
   }
@@ -9170,88 +9183,122 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn Status
+   * POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
    *
-   * @param id_checkin
+   * @param checkin_id
+   * @param body
    * @param options - additional request options
    */
-  get_frictionless_checkin_status(
-    id_checkin: string,
-    options?: {
-      query?: GetFrictionlessCheckinStatusQuery;
-    } & RequestOptions,
-  ): ResponsePromise<GetFrictionlessCheckinStatusResponse> {
+  post_frictionless_checkin_reprocess_payment(
+    checkin_id: string,
+    body: PostFrictionlessCheckinReprocessPaymentBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostFrictionlessCheckinReprocessPaymentResponse> {
     return this.request(
       "frictionless",
-      "get_frictionless_checkin_status",
-      "get",
-      `/frictionless/checkin/${id_checkin}/status`,
-      null,
+      "post_frictionless_checkin_reprocess_payment",
+      "post",
+      `/frictionless/checkins/${checkin_id}/reprocess-payment`,
+      body,
       options,
     );
   }
 
   /**
-   * GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
+   * POST /frictionless/amazon-jwo-connector/v1/identity/identity-keys - Amazon JWO Identity Key Connector
    *
-   * @param user_id
+   * @param body
    * @param options - additional request options
    */
-  get_frictionless_users_payment_issues(
-    user_id: string,
-    options?: {
-      query?: GetFrictionlessUsersPaymentIssuesQuery;
-    } & RequestOptions,
-  ): ResponsePromise<GetFrictionlessUsersPaymentIssuesResponse> {
+  post_frictionless_amazon_jwo_connector_v1_identity_identity_keys(
+    body: PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse> {
     return this.request(
       "frictionless",
-      "get_frictionless_users_payment_issues",
-      "get",
-      `/frictionless/users/${user_id}/checkins/payment-issues`,
-      null,
+      "post_frictionless_amazon_jwo_connector_v1_identity_identity_keys",
+      "post",
+      `/frictionless/amazon-jwo-connector/v1/identity/identity-keys`,
+      body,
       options,
     );
   }
 
   /**
-   * POST /frictionless/checkins/{checkin_id}/reprocess-payment - Update payment at checkin and trigger reprocessing
+   * POST /frictionless/amazon-jwo-connector/v1/order/purchases - Amazon JWO Ordering Connector
    *
-   * @param checkin_id
    * @param body
    * @param options - additional request options
    */
-  post_frictionless_checkin_reprocess_payment(
-    checkin_id: string,
-    body: PostFrictionlessCheckinReprocessPaymentBody,
+  post_frictionless_amazon_jwo_connector_v1_order_purchases(
+    body: PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody,
     options?: RequestOptions,
-  ): ResponsePromise<PostFrictionlessCheckinReprocessPaymentResponse> {
+  ): ResponsePromise<PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse> {
     return this.request(
       "frictionless",
-      "post_frictionless_checkin_reprocess_payment",
+      "post_frictionless_amazon_jwo_connector_v1_order_purchases",
       "post",
-      `/frictionless/checkins/${checkin_id}/reprocess-payment`,
+      `/frictionless/amazon-jwo-connector/v1/order/purchases`,
       body,
       options,
     );
   }
 
   /**
-   * GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
+   * POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
    *
-   * @param id_checkin
+   * @param body
    * @param options - additional request options
    */
-  get_frictionless_checkin(
-    id_checkin: string,
+  post_frictionless_webhook_standardcognition(
+    body: PostFrictionlessWebhookStandardcognitionBody,
+    options?: RequestOptions,
+  ): ResponsePromise<PostFrictionlessWebhookStandardcognitionResponse> {
+    return this.request(
+      "frictionless",
+      "post_frictionless_webhook_standardcognition",
+      "post",
+      `/frictionless/webhook/standardcognition`,
+      body,
+      options,
+    );
+  }
+
+  /**
+   * GET /dev/consumer/v1/health-check
+   *
+   * @param options - additional request options
+   */
+  HealthCheckController_execute(
     options?: {
-      query?: GetFrictionlessCheckinQuery;
+      query?: HealthCheckControllerExecuteQuery;
     } & RequestOptions,
-  ): ResponsePromise<GetFrictionlessCheckinResponse> {
+  ): ResponsePromise<HealthCheckControllerExecuteResponse> {
     return this.request(
-      "frictionless",
-      "get_frictionless_checkin",
+      "consumer",
+      "HealthCheckController_execute",
       "get",
-      `/frictionless/checkin/${id_checkin}`,
+      `/consumer/v1/health-check`,
+      null,
+      options,
+    );
+  }
+
+  /**
+   * GET /dev/consumer/v1/payment-methods - List payment methods available in a given brand
+   *
+   * @param options - additional request options
+   */
+  get_payment_list_by_brand(
+    options: {
+      query: GetPaymentListByBrandQuery;
+    } & RequestOptions,
+  ): ResponsePromise<GetPaymentListByBrandResponse> {
+    return this.request(
+      "consumer",
+      "get_payment_list_by_brand",
+      "get",
+      `/consumer/v1/payment-methods`,
       null,
       options,
     );

package/src/interface/consumer.ts

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