@compassdigital/sdk.typescript 3.76.0 → 3.77.1

package/src/interface/ai.ts

@@ -0,0 +1,72 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface OptionsDTO {
+  temperature?: number;
+  max_tokens?: number;
+}
+
+export interface MessageDTO {
+  actor: string;
+  content: string;
+}
+
+export interface GenerateTextRequest {
+  options?: OptionsDTO;
+  messages: MessageDTO[];
+}
+
+export interface GenerateTextResponse {
+  messages: MessageDTO[];
+}
+
+export interface BadRequestErrorDTO {
+  message: string;
+  code: number;
+  data: any;
+}
+
+export interface UnauthorizedErrorDTO {
+  message: string;
+  code: number;
+  data: any;
+}
+
+export type InternalServerErrorException = any;
+
+export interface GenerateImageRequest {
+  prompt: string;
+  number_of_images?: number;
+  negative_prompt?: string;
+}
+
+export interface ImageDTO {
+  data: string;
+  mime_type: string;
+}
+
+export interface GenerateImageResponse {
+  images: ImageDTO[];
+}
+
+// POST /ai/language/generate - Generate text from a given prompt
+
+export type PostAiLanguageGenerateBody = GenerateTextRequest;
+
+export type PostAiLanguageGenerateResponse = GenerateTextResponse;
+
+export interface PostAiLanguageGenerateRequest extends BaseRequest {
+  body: PostAiLanguageGenerateBody;
+}
+
+// POST /ai/image/generate - Generate image from a given prompt
+
+export type PostAiImageGenerateBody = GenerateImageRequest;
+
+export type PostAiImageGenerateResponse = GenerateImageResponse;
+
+export interface PostAiImageGenerateRequest extends BaseRequest {
+  body: PostAiImageGenerateBody;
+}

package/src/interface/datalake.ts

@@ -29,11 +29,13 @@ export interface PostDatalakeSqlRequest extends BaseRequest {
 
 // GET /swagger.json
 
-export interface GetSwaggerQuery {
+export interface GetDatalakeSwaggerQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetSwaggerResponse = any;
+export type GetDatalakeSwaggerResponse = any;
 
-export interface GetSwaggerRequest extends BaseRequest, RequestQuery<GetSwaggerQuery> {}
+export interface GetDatalakeSwaggerRequest
+  extends BaseRequest,
+    RequestQuery<GetDatalakeSwaggerQuery> {}

package/src/interface/frictionless.ts

@@ -0,0 +1,155 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from "./util";
+
+export interface StandardCognitionEvent {
+  event_id: string;
+  event_type: string;
+  external_customer_id: string;
+  tenant_id: string;
+  order_id: string;
+}
+
+export interface FrictionlessSupportResponse {
+  supported: boolean;
+  version?: string;
+}
+
+export interface ForbiddenErrorDTO {
+  statusCode: number;
+  timestamp: string;
+  message: string;
+}
+
+export interface NotFoundErrorDTO {
+  statusCode: number;
+  timestamp: string;
+  message: string;
+}
+
+export type MealplanDTO = any;
+
+export interface CreditCardDTO {
+  cardType: string;
+  last4: string;
+}
+
+export interface PaymentMethod {
+  mealplan?: MealplanDTO;
+  creditCard?: CreditCardDTO;
+  token: string;
+}
+
+export interface CreateFrictionlessQRCodeCommand {
+  brandID: string;
+  userID: string;
+  paymentMethod: PaymentMethod;
+}
+
+export interface QRCodeCreationResponse {
+  qrcode: string;
+  expiration: number;
+  id: string;
+}
+
+export interface UnprocessableEntityErrorDTO {
+  statusCode: number;
+  timestamp: string;
+  message: string;
+}
+
+export interface FailedCheckInDTO {
+  id: string;
+  shopperID: string;
+  brandID: string;
+  reason: string;
+}
+
+export interface CheckCheckInStatusResponseDTO {
+  status: string;
+}
+
+// POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
+
+export type StandardCognitionEventWebhookControllerExecuteBody = StandardCognitionEvent;
+
+export type StandardCognitionEventWebhookControllerExecuteResponse = any;
+
+export interface StandardCognitionEventWebhookControllerExecuteRequest extends BaseRequest {
+  body: StandardCognitionEventWebhookControllerExecuteBody;
+}
+
+// GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
+
+export interface CheckFrictionlessSupportControllerExecutePath {
+  // Brand ID as Encoded CDL ID
+  id_brand: string;
+}
+
+export interface CheckFrictionlessSupportControllerExecuteQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type CheckFrictionlessSupportControllerExecuteResponse = FrictionlessSupportResponse;
+
+export interface CheckFrictionlessSupportControllerExecuteRequest
+  extends BaseRequest,
+    RequestQuery<CheckFrictionlessSupportControllerExecuteQuery>,
+    CheckFrictionlessSupportControllerExecutePath {}
+
+// POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
+
+export type CreateQRCodeUserCheckInControllerExecuteBody = CreateFrictionlessQRCodeCommand;
+
+export type CreateQRCodeUserCheckInControllerExecuteResponse = {};
+
+export interface CreateQRCodeUserCheckInControllerExecuteRequest extends BaseRequest {
+  body: CreateQRCodeUserCheckInControllerExecuteBody;
+}
+
+// GET /frictionless/failed-checkins - List check-ins on error
+
+export interface ListFailedCheckinsControllerExecuteQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type ListFailedCheckinsControllerExecuteResponse = FailedCheckInDTO[];
+
+export interface ListFailedCheckinsControllerExecuteRequest
+  extends BaseRequest,
+    RequestQuery<ListFailedCheckinsControllerExecuteQuery> {}
+
+// POST /frictionless/checkin/{id_checkin}/reprocess - Reprocess checkin on error
+
+export interface ReprocessCheckinOnErrorControllerExecutePath {
+  // TODO: add parameter to swagger.json
+  id_checkin: string;
+}
+
+export type ReprocessCheckinOnErrorControllerExecuteResponse = {};
+
+export interface ReprocessCheckinOnErrorControllerExecuteRequest
+  extends BaseRequest,
+    ReprocessCheckinOnErrorControllerExecutePath {}
+
+// GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn status
+
+export interface CheckCheckinStatusControllerExecutePath {
+  // TODO: add parameter to swagger.json
+  id_checkin: string;
+}
+
+export interface CheckCheckinStatusControllerExecuteQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type CheckCheckinStatusControllerExecuteResponse = CheckCheckInStatusResponseDTO;
+
+export interface CheckCheckinStatusControllerExecuteRequest
+  extends BaseRequest,
+    RequestQuery<CheckCheckinStatusControllerExecuteQuery>,
+    CheckCheckinStatusControllerExecutePath {}

package/src/interface/location.ts

@@ -3,15 +3,6 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
-export interface POS {
-  // pos
-  id?: string;
-  type?: string;
-  meta?: {
-    [index: string]: any;
-  };
-}
-
 export interface MenuHours {
   // menu
   id?: string;
@@ -205,23 +196,6 @@ export interface Brand {
   [index: string]: any;
 }
 
-export interface BrandDocument {
-  // CDL id
-  id?: string;
-  type?: string;
-  url?: string;
-  is_archived?: boolean;
-  // UTC timestamp
-  upload_date?: number;
-  name?: string;
-}
-
-export type BrandDocuments = BrandDocument[];
-
-export interface BrandDocumentsResponse {
-  documents?: BrandDocuments;
-}
-
 export type Brands = Brand[];
 
 export interface Location {
@@ -455,6 +429,23 @@ export interface WaitTime {
 
 export type BrandOrMenuState = string;
 
+export interface MenuAssociations {
+  menu_associations?: MenuAssociation[];
+}
+
+export interface MenuAssociation {
+  // CDL id
+  id?: string;
+  // CDL id
+  brand?: string;
+  // CDL id
+  menu?: string;
+  // CDL id
+  group?: string;
+  created?: string;
+  [index: string]: any;
+}
+
 // POST /location - Create a new location
 
 export type PostLocationBody = Location;
@@ -569,40 +560,6 @@ export interface PatchLocationRequest extends BaseRequest, PatchLocationPath {
   body: PatchLocationBody;
 }
 
-// GET /location/pos/{id} - Get information about a POS
-
-export interface GetLocationPosPath {
-  // POS ID
-  id: string;
-}
-
-export interface GetLocationPosQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetLocationPosResponse = POS;
-
-export interface GetLocationPosRequest
-  extends BaseRequest,
-    RequestQuery<GetLocationPosQuery>,
-    GetLocationPosPath {}
-
-// PUT /location/pos/{id} - Set information about a POS
-
-export interface PutLocationPosPath {
-  // POS ID
-  id: string;
-}
-
-export type PutLocationPosBody = POS;
-
-export type PutLocationPosResponse = POS;
-
-export interface PutLocationPosRequest extends BaseRequest, PutLocationPosPath {
-  body: PutLocationPosBody;
-}
-
 // GET /location/multigroup - Get all the top level multigroups
 
 export interface GetLocationMultigroupsQuery {
@@ -933,30 +890,6 @@ export interface GetLocationGroupDeliverydestinationRequest
     RequestQuery<GetLocationGroupDeliverydestinationQuery>,
     GetLocationGroupDeliverydestinationPath {}
 
-// GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
-
-export interface GetLocationUserGroupPath {
-  // group
-  id: string;
-  // user
-  user_id: string;
-}
-
-export interface GetLocationUserGroupQuery {
-  latitude?: number;
-  longitude?: number;
-  // Graphql query string
-  _query?: string;
-  nocache?: boolean;
-}
-
-export type GetLocationUserGroupResponse = Group;
-
-export interface GetLocationUserGroupRequest
-  extends BaseRequest,
-    RequestQuery<GetLocationUserGroupQuery>,
-    GetLocationUserGroupPath {}
-
 // GET /location/brands - Get all location brands
 
 export interface GetLocationBrandsQuery {
@@ -991,77 +924,6 @@ export interface GetLocationBrandDestinationsRequest
     RequestQuery<GetLocationBrandDestinationsQuery>,
     GetLocationBrandDestinationsPath {}
 
-// POST /location/brand/{id}/document - Attach document to a brand
-
-export interface PostLocationBrandDocumentPath {
-  // Brand ID
-  id: string;
-}
-
-export interface PostLocationBrandDocumentBody {
-  document_name?: string;
-  document_type?: string;
-  // base64 string
-  document?: string;
-}
-
-export type PostLocationBrandDocumentResponse = BrandDocumentsResponse;
-
-export interface PostLocationBrandDocumentRequest
-  extends BaseRequest,
-    PostLocationBrandDocumentPath {
-  body: PostLocationBrandDocumentBody;
-}
-
-// PATCH /location/brand/{id}/document - Edit location document
-
-export interface PatchLocationBrandDocumentPath {
-  // Brand ID
-  id: string;
-}
-
-export interface PatchLocationBrandDocumentResponse {
-  document?: BrandDocument;
-}
-
-export interface PatchLocationBrandDocumentRequest
-  extends BaseRequest,
-    PatchLocationBrandDocumentPath {}
-
-// DELETE /location/brand/{id}/document - Deleted brand document
-
-export interface DeleteLocationBrandDocumentPath {
-  // Brand ID
-  id: string;
-}
-
-export interface DeleteLocationBrandDocumentResponse {
-  deleted_document?: BrandDocument;
-}
-
-export interface DeleteLocationBrandDocumentRequest
-  extends BaseRequest,
-    DeleteLocationBrandDocumentPath {}
-
-// GET /location/brand/{id}/documents - Get location brand attached documents
-
-export interface GetLocationBrandDocumentsPath {
-  // Brand ID
-  id: string;
-}
-
-export interface GetLocationBrandDocumentsQuery {
-  // Graphql query string
-  _query?: string;
-}
-
-export type GetLocationBrandDocumentsResponse = BrandDocumentsResponse;
-
-export interface GetLocationBrandDocumentsRequest
-  extends BaseRequest,
-    RequestQuery<GetLocationBrandDocumentsQuery>,
-    GetLocationBrandDocumentsPath {}
-
 // GET /location/brand/{id}/timeslots - Get location brand timeslots
 
 export interface GetLocationBrandTimeslotsPath {
@@ -1453,3 +1315,41 @@ export interface GetLocationV2GroupsResponse {
 export interface GetLocationV2GroupsRequest
   extends BaseRequest,
     RequestQuery<GetLocationV2GroupsQuery> {}
+
+// GET /location/menu_association/{id}/brand - Get menu association for a brand
+
+export interface GetLocationMenuAssociationBrandPath {
+  // brand id
+  id: string;
+}
+
+export interface GetLocationMenuAssociationBrandQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetLocationMenuAssociationBrandResponse = MenuAssociations;
+
+export interface GetLocationMenuAssociationBrandRequest
+  extends BaseRequest,
+    RequestQuery<GetLocationMenuAssociationBrandQuery>,
+    GetLocationMenuAssociationBrandPath {}
+
+// GET /location/menu_association/{id}/menu - Get menu association for a brand
+
+export interface GetLocationMenuAssociationMenuPath {
+  // menu id
+  id: string;
+}
+
+export interface GetLocationMenuAssociationMenuQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetLocationMenuAssociationMenuResponse = MenuAssociations;
+
+export interface GetLocationMenuAssociationMenuRequest
+  extends BaseRequest,
+    RequestQuery<GetLocationMenuAssociationMenuQuery>,
+    GetLocationMenuAssociationMenuPath {}