@compassdigital/sdk.typescript 4.15.0 → 4.16.0

package/src/index.ts

@@ -371,6 +371,7 @@ import {
   PutReportGroupConfigResponse,
   GetReportGroupConfigQuery,
   GetReportGroupConfigResponse,
+  DeleteReportGroupConfigResponse,
 } from "./interface/report";
 
 import {
@@ -883,6 +884,8 @@ import {
   GetFrictionlessUsersPaymentIssuesResponse,
   PostFrictionlessCheckinReprocessPaymentBody,
   PostFrictionlessCheckinReprocessPaymentResponse,
+  GetFrictionlessCheckinQuery,
+  GetFrictionlessCheckinResponse,
 } from "./interface/frictionless";
 
 import {
@@ -899,6 +902,12 @@ import {
   PostCentricosAiItemImageResponse,
   PostCentricosOrdersExportQuery,
   PostCentricosOrdersExportResponse,
+  GetCentricosReportGroupConfigQuery,
+  GetCentricosReportGroupConfigResponse,
+  PutCentricosReportGroupConfigBody,
+  PutCentricosReportGroupConfigResponse,
+  GetCentricosReportConfigDefaultQuery,
+  GetCentricosReportConfigDefaultResponse,
 } from "./interface/centricos";
 
 import { BaseServiceClient, RequestOptions, ResponsePromise } from "./base";
@@ -4169,7 +4178,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * PUT /report/group/{location_group}/config - Update report configuration for a location group
+   * PUT /report/group/{location_group}/config - Update report configuration for a location group. Times are in UTC.
    *
    * @param location_group
    * @param body
@@ -4191,7 +4200,7 @@ export class ServiceClient extends BaseServiceClient {
   }
 
   /**
-   * GET /report/group/{location_group}/config - Get report configuration for a location group
+   * GET /report/group/{location_group}/config - Get report configuration for a location group. Times are in UTC.
    *
    * @param location_group
    * @param options - additional request options
@@ -4212,6 +4221,26 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * DELETE /report/group/{location_group}/config - Delete report configuration for a location group
+   *
+   * @param location_group
+   * @param options - additional request options
+   */
+  delete_report_group_config(
+    location_group: string,
+    options?: RequestOptions
+  ): ResponsePromise<DeleteReportGroupConfigResponse> {
+    return this.request(
+      "report",
+      "delete_report_group_config",
+      "delete",
+      `/report/group/${location_group}/config`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /user/auth - Gets the JWT token for a user
    *
@@ -9093,6 +9122,28 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
+   *
+   * @param id_checkin
+   * @param options - additional request options
+   */
+  get_frictionless_checkin(
+    id_checkin: string,
+    options?: {
+      query?: GetFrictionlessCheckinQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetFrictionlessCheckinResponse> {
+    return this.request(
+      "frictionless",
+      "get_frictionless_checkin",
+      "get",
+      `/frictionless/checkin/${id_checkin}`,
+      null,
+      options
+    );
+  }
+
   /**
    * POST /ai/language/generate - Generate text from a given prompt
    *
@@ -9192,4 +9243,68 @@ export class ServiceClient extends BaseServiceClient {
       options
     );
   }
+
+  /**
+   * GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in UTC.
+   *
+   * @param location_group - TODO: add parameter to swagger.json
+   * @param options - additional request options
+   */
+  get_centricos_report_group_config(
+    location_group: string,
+    options?: {
+      query?: GetCentricosReportGroupConfigQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetCentricosReportGroupConfigResponse> {
+    return this.request(
+      "centricos",
+      "get_centricos_report_group_config",
+      "get",
+      `/centricos/report/group/${location_group}/config`,
+      null,
+      options
+    );
+  }
+
+  /**
+   * PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in UTC.
+   *
+   * @param location_group - TODO: add parameter to swagger.json
+   * @param body
+   * @param options - additional request options
+   */
+  put_centricos_report_group_config(
+    location_group: string,
+    body: PutCentricosReportGroupConfigBody,
+    options?: RequestOptions
+  ): ResponsePromise<PutCentricosReportGroupConfigResponse> {
+    return this.request(
+      "centricos",
+      "put_centricos_report_group_config",
+      "put",
+      `/centricos/report/group/${location_group}/config`,
+      body,
+      options
+    );
+  }
+
+  /**
+   * GET /centricos/report/config/default - Get default report configuration. Times are in UTC.
+   *
+   * @param options - additional request options
+   */
+  get_centricos_report_config_default(
+    options?: {
+      query?: GetCentricosReportConfigDefaultQuery;
+    } & RequestOptions
+  ): ResponsePromise<GetCentricosReportConfigDefaultResponse> {
+    return this.request(
+      "centricos",
+      "get_centricos_report_config_default",
+      "get",
+      `/centricos/report/config/default`,
+      null,
+      options
+    );
+  }
 }

package/src/interface/ai.ts

@@ -25,16 +25,16 @@ export interface GenerateTextResponse {
 export interface BadRequestErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface UnauthorizedErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
-export type InternalServerErrorException = Record<string, any>;
+export type InternalServerErrorException = any;
 
 export interface GenerateImageRequest {
   prompt: string;

package/src/interface/announcement.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Success {
@@ -33,7 +33,7 @@ export interface Announcement {
     en?: Announcement_info;
     fr?: Announcement_info;
   };
-  date?: Record<string, any>;
+  date?: any;
   [index: string]: any;
 }
 

package/src/interface/calendar.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Event {

package/src/interface/centricos.ts

@@ -15,16 +15,16 @@ export interface AIItemDescriptionResponse {
 export interface BadRequestErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface UnauthorizedErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
-export type InternalServerErrorException = Record<string, any>;
+export type InternalServerErrorException = any;
 
 export interface AIItemImageRequest {
   name?: string;
@@ -50,6 +50,29 @@ export interface OrdersExportResponse {
   fileName: string;
 }
 
+export interface DayPart {
+  label: string;
+  start: string;
+  end: string;
+}
+
+export interface ReportGroupConfigResponse {
+  location_group_id: string;
+  day_start: string;
+  day_parts: DayPart[];
+  is_default: boolean;
+}
+
+export interface ReportGroupConfigRequest {
+  day_start: string;
+  day_parts: DayPart[];
+}
+
+export interface ReportDefaultConfigResponse {
+  day_start: string;
+  day_parts: DayPart[];
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -90,7 +113,7 @@ export interface PostCentricosOrdersExportQuery {
   // Filter orders by payment category
   payment_category?: ("digital wallet" | "badge pay" | "credit card" | "mealplan")[];
   // Search order by refund_status
-  refund_status?: ("partial" | "full")[];
+  refund_status?: ("partial" | "full" | "")[];
   // Return items sorted by this column
   sortBy?:
     | "date_created"
@@ -118,3 +141,52 @@ export type PostCentricosOrdersExportResponse = OrdersExportResponse;
 export interface PostCentricosOrdersExportRequest
   extends BaseRequest,
     RequestQuery<PostCentricosOrdersExportQuery> {}
+
+// GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in UTC.
+
+export interface GetCentricosReportGroupConfigPath {
+  // TODO: add parameter to swagger.json
+  location_group: string;
+}
+
+export interface GetCentricosReportGroupConfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
+
+export interface GetCentricosReportGroupConfigRequest
+  extends BaseRequest,
+    RequestQuery<GetCentricosReportGroupConfigQuery>,
+    GetCentricosReportGroupConfigPath {}
+
+// PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in UTC.
+
+export interface PutCentricosReportGroupConfigPath {
+  // TODO: add parameter to swagger.json
+  location_group: string;
+}
+
+export type PutCentricosReportGroupConfigBody = ReportGroupConfigRequest;
+
+export type PutCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
+
+export interface PutCentricosReportGroupConfigRequest
+  extends BaseRequest,
+    PutCentricosReportGroupConfigPath {
+  body: PutCentricosReportGroupConfigBody;
+}
+
+// GET /centricos/report/config/default - Get default report configuration. Times are in UTC.
+
+export interface GetCentricosReportConfigDefaultQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetCentricosReportConfigDefaultResponse = ReportDefaultConfigResponse;
+
+export interface GetCentricosReportConfigDefaultRequest
+  extends BaseRequest,
+    RequestQuery<GetCentricosReportConfigDefaultQuery> {}

package/src/interface/compassconnect.ts

@@ -13,7 +13,7 @@ export interface OMSRequest {
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Auth {

package/src/interface/config.ts

@@ -3,7 +3,7 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
-export type CreateConfig = Record<string, any>;
+export type CreateConfig = any;
 
 export interface Config {
   [index: string]: any;
@@ -12,7 +12,7 @@ export interface Config {
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Success {

package/src/interface/datalake.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface QueryBody {
@@ -34,7 +34,7 @@ export interface GetDatalakeSwaggerQuery {
   _query?: string;
 }
 
-export type GetDatalakeSwaggerResponse = Record<string, any>;
+export type GetDatalakeSwaggerResponse = any;
 
 export interface GetDatalakeSwaggerRequest
   extends BaseRequest,

package/src/interface/delivery.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Delivery {

package/src/interface/email.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Success {
@@ -20,7 +20,7 @@ export interface EmailPayload {
   // Text of an email instead of template_id/data
   text?: string;
   template_id?: string;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 // POST /email - Send an email

package/src/interface/file.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   message?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface File {

package/src/interface/frictionless.ts

@@ -12,8 +12,11 @@ export interface StandardCognitionEvent {
 }
 
 export interface AmazonJWOAuthEventDTO {
+  // Value that uniquely identifies each authorization event that occurs when a shopper interacts with a JWO gate
   id: string;
+  // Contains the timestamp when the	authorization event took place
   timestamp: string;
+  // Contains an enumerated string that tells the system where the authorization event took place. Current values are ENTRY for the JWO Entry Gate and EXIT for the Exit Gate
   location: "ENTRY" | "EXIT";
 }
 
@@ -36,39 +39,49 @@ export interface AmazonJWOIdentityKeysResponseDTO {
 export interface BadRequestErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface UnauthorizedErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface ShoppingTrip {
+  // Contains a timestamp for the time the shopping trip starts. This value is not validated on our service.
   startTime: string;
+  // Contains a timestamp for the time the shopping trip ends. This value is not validated on our service.
   endTime: string;
   authEvents: AmazonJWOAuthEventDTO[];
 }
 
 export interface Quantity {
+  // Contains the number of each item the shopper purchased
   value: string;
-  unit: string;
+  // Contains the type of unique identifier your store uses to identify each item in the cart
+  unit: "unit" | "each";
 }
 
 export interface CartItem {
+  // Contain a unique identifier for the item in the cart. This identifier will be an SKU for Compass
   id: string;
-  type: string;
+  // Contains the type of unique identifier the store uses to identify each item in the cart. This field will be always SKU for Compass
+  type: "SKU";
   quantity: Quantity;
 }
 
 export interface ShopperIdentity {
+  // Contains a unique identifier for each	shopper AWS sends back. Refers to our CheckIn ID.
   id: string;
 }
 
 export interface AmazonJWOOrderingRequestDTO {
+  // Contains a UUID for each checkout request. Amazon generates this UUID for	each request. If Amazon has to send the same request more than once, the requestId will be different for each request. Compare the requestId to the idempotentShoppingTripId field, which	remains the same throughout the shopping trip.
   requestId: string;
+  // Contains a Universally Unique ID (UUID) for the current	shopping trip. Amazon generates this UUID for each shopping trip
   idempotentShoppingTripId: string;
+  // The storeId field contains a unique identifier for your store on AWS system
   storeId: string;
   shoppingTrip: ShoppingTrip;
   cartItems: CartItem[];
@@ -87,13 +100,13 @@ export interface FrictionlessSupportResponse {
 export interface ForbiddenErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface NotFoundErrorDTO {
   message: string;
   code: number;
-  data: Record<string, any>;
+  data: any;
 }
 
 export interface MealplanDTO {
@@ -164,6 +177,17 @@ export interface CheckInPaymentRequiredDTO {
   id: string;
 }
 
+export interface GetCheckinResponseDTO {
+  id: string;
+  provider: string;
+  status: string;
+  reasonOfFail?: string;
+  thirdPartyCorrelatedID?: string;
+  shoppingCartID?: string;
+  brandID: string;
+  userID: string;
+}
+
 // POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
 
 export type PostFrictionlessWebhookStandardcognitionBody = StandardCognitionEvent;
@@ -221,7 +245,7 @@ export interface GetFrictionlessBrandFrictionlessStatusRequest
 
 export type PostFrictionlessQrCodeBody = CreateFrictionlessQRCodeCommand;
 
-export type PostFrictionlessQrCodeResponse = QRCodeCreationResponse;
+export type PostFrictionlessQrCodeResponse = {};
 
 export interface PostFrictionlessQrCodeRequest extends BaseRequest {
   body: PostFrictionlessQrCodeBody;
@@ -303,3 +327,21 @@ export interface PostFrictionlessCheckinReprocessPaymentRequest
     PostFrictionlessCheckinReprocessPaymentPath {
   body: PostFrictionlessCheckinReprocessPaymentBody;
 }
+
+// GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
+
+export interface GetFrictionlessCheckinPath {
+  id_checkin: string;
+}
+
+export interface GetFrictionlessCheckinQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
+
+export interface GetFrictionlessCheckinRequest
+  extends BaseRequest,
+    RequestQuery<GetFrictionlessCheckinQuery>,
+    GetFrictionlessCheckinPath {}

package/src/interface/kds.ts

@@ -11,7 +11,7 @@ export interface Error {
   error?: string;
   message?: string;
   code: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Device {

package/src/interface/location.ts

@@ -95,10 +95,10 @@ export interface Brand {
   };
   hours?: Hours[];
   deliveryHours?: DeliveryHours[];
-  style?: Record<string, any>;
+  style?: any;
   // pos
   pos?: string;
-  terminals?: Record<string, any>[];
+  terminals?: any[];
   timeslots?: {
     time?: string;
     averagePrepTime?: string;
@@ -145,8 +145,8 @@ export interface Brand {
   // company
   company?: string;
   config?: {
-    private?: Record<string, any>;
-    public?: Record<string, any>;
+    private?: any;
+    public?: any;
   };
   tax_rate?: number;
   meta?: {
@@ -254,8 +254,8 @@ export interface Location {
       en?: string;
       fr?: string;
     };
-    hours?: Record<string, any>;
-    deliveryHours?: Record<string, any>;
+    hours?: any;
+    deliveryHours?: any;
     service_fee?: {
       type?: string;
       value?: number;
@@ -280,7 +280,7 @@ export interface Group {
   meta?: {
     [index: string]: any;
   };
-  style?: Record<string, any>;
+  style?: any;
   [index: string]: any;
 }
 
@@ -299,7 +299,7 @@ export interface success {
 export interface Error {
   error?: string;
   code?: number;
-  data?: Record<string, any>;
+  data?: any;
 }
 
 export interface Sector {
@@ -418,7 +418,11 @@ export interface BadRequest {
   error?: string;
 }
 
-export type PartnerStatus = "await_partner" | "await_scout" | "completed";
+enum PartnerStatus {
+  AWAIT_PARTNER = "await_partner",
+  AWAIT_SCOUT = "await_scout",
+  COMPLETED = "completed",
+}
 
 export interface WaitTime {
   // maxium wait time to the next time slot in minutes
@@ -429,7 +433,11 @@ export interface WaitTime {
   ready_time: number;
 }
 
-export type BrandOrMenuState = "open" | "closed" | "preorder";
+enum BrandOrMenuState {
+  OPEN = "open",
+  CLOSED = "closed",
+  PREORDER = "preorder",
+}
 
 export interface MenuAssociations {
   menu_associations?: MenuAssociation[];
@@ -499,7 +507,7 @@ export interface GetLocationQuery {
   // When fetching location, brands will come with private and public configs
   include_brands_config?: boolean;
   // active cafes
-  active_cafes?: Record<string, any>[];
+  active_cafes?: any[];
   // show additional hidden properties/entities
   extended?: boolean;
   // Graphql query string
@@ -1215,7 +1223,7 @@ export interface PostLocationCompanyBody {
   name: string;
   // sector
   sector: string;
-  label?: Record<string, any>;
+  label?: any;
   is?: {
     global_images_enabled?: boolean;
   };

package/src/interface/mealplan.ts

@@ -6,7 +6,7 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
-  data?: Record<string, any>;
+  data?: any;
   headers?: {
     Location?: string;
   };