@compassdigital/sdk.typescript 3.77.0 → 4.0.0

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/announcement.ts

@@ -62,7 +62,7 @@ export interface PostAnnouncementRequest extends BaseRequest {
 // GET /announcement/resource/{id} - Get Announcements
 
 export interface GetAnnouncementResourcePath {
-  // Id of the entity to which announcement is specifically related.; TODO: mark parameter as required in swagger
+  // Id of the entity to which announcement is specifically related.
   id: string;
 }
 

package/src/interface/calendar.ts

@@ -117,7 +117,7 @@ export interface GetCalendarCdlPath {
 
 export interface GetCalendarCdlQuery {
   // Start date in ms to get 7 day calendar from. Defaults now.
-  start_date?: number;
+  start_date?: string;
   // Graphql query string
   _query?: string;
 }

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/delivery.ts

@@ -57,13 +57,26 @@ export interface Delivery {
   };
   customer?: string;
   loading_code?: string;
-  state?: string;
+  state?:
+    | "RESERVED"
+    | "CONFIRMED"
+    | "ENROUTE_LOADING_AREA"
+    | "ARRIVING_LOADING_AREA"
+    | "WAITING_LOADING"
+    | "LOADING"
+    | "ENROUTE_CUSTOMER"
+    | "ARRIVING_CUSTOMER"
+    | "WAITING_CUSTOMER"
+    | "UNLOADING"
+    | "COMPLETED"
+    | "CANCELLED"
+    | "CUSTOMER_NO_SHOW";
   state_reason?: string;
   tracker_url?: string;
 }
 
 export interface Available {
-  deliverable: boolean;
+  deliverable: true;
 }
 
 export interface PostAvailabilityBody {

package/src/interface/file.ts

@@ -21,7 +21,7 @@ export interface PostFileBody {
   // If not specified, random name+timestamp will be generated, otherwise filename+timestamp format is used
   file_name?: string;
   // Set custom bucket to save in. Defaults to images.compassdigital.org
-  bucket_name?: string;
+  bucket_name?: "images.compassdigital.org" | "assets.compassdigital.org";
 }
 
 export type PostFileResponse = File;

package/src/interface/frictionless.ts

@@ -13,7 +13,7 @@ export interface StandardCognitionEvent {
 
 export interface FrictionlessSupportResponse {
   supported: boolean;
-  version?: string;
+  version?: "NFC" | "QR";
 }
 
 export interface ForbiddenErrorDTO {
@@ -67,95 +67,89 @@ export interface FailedCheckInDTO {
 }
 
 export interface CheckCheckInStatusResponseDTO {
-  status: string;
+  status: "CREATING" | "ACTIVE" | "ERROR" | "CANCELED" | "PROCESSING" | "COMPLETED";
 }
 
 // POST /frictionless/webhook/standardcognition - Receive frictionless standard cognition events
 
-export type PostFrictionlessStandardCognitionEventWebhookControllerExecuteBody =
-  StandardCognitionEvent;
+export type StandardCognitionEventWebhookControllerExecuteBody = StandardCognitionEvent;
 
-export type PostFrictionlessStandardCognitionEventWebhookControllerExecuteResponse = any;
+export type StandardCognitionEventWebhookControllerExecuteResponse = {};
 
-export interface PostFrictionlessStandardCognitionEventWebhookControllerExecuteRequest
-  extends BaseRequest {
-  body: PostFrictionlessStandardCognitionEventWebhookControllerExecuteBody;
+export interface StandardCognitionEventWebhookControllerExecuteRequest extends BaseRequest {
+  body: StandardCognitionEventWebhookControllerExecuteBody;
 }
 
 // GET /frictionless/brand/{id_brand}/frictionless-status - Check frictionless support of a given brand
 
-export interface GetFrictionlessCheckFrictionlessSupportControllerExecutePath {
+export interface CheckFrictionlessSupportControllerExecutePath {
   // Brand ID as Encoded CDL ID
   id_brand: string;
 }
 
-export interface GetFrictionlessCheckFrictionlessSupportControllerExecuteQuery {
+export interface CheckFrictionlessSupportControllerExecuteQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetFrictionlessCheckFrictionlessSupportControllerExecuteResponse =
-  FrictionlessSupportResponse;
+export type CheckFrictionlessSupportControllerExecuteResponse = FrictionlessSupportResponse;
 
-export interface GetFrictionlessCheckFrictionlessSupportControllerExecuteRequest
+export interface CheckFrictionlessSupportControllerExecuteRequest
   extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckFrictionlessSupportControllerExecuteQuery>,
-    GetFrictionlessCheckFrictionlessSupportControllerExecutePath {}
+    RequestQuery<CheckFrictionlessSupportControllerExecuteQuery>,
+    CheckFrictionlessSupportControllerExecutePath {}
 
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
 
-export type PostFrictionlessCreateQRCodeUserCheckInControllerExecuteBody =
-  CreateFrictionlessQRCodeCommand;
+export type CreateQRCodeUserCheckInControllerExecuteBody = CreateFrictionlessQRCodeCommand;
 
-export type PostFrictionlessCreateQRCodeUserCheckInControllerExecuteResponse = {};
+export type CreateQRCodeUserCheckInControllerExecuteResponse = {};
 
-export interface PostFrictionlessCreateQRCodeUserCheckInControllerExecuteRequest
-  extends BaseRequest {
-  body: PostFrictionlessCreateQRCodeUserCheckInControllerExecuteBody;
+export interface CreateQRCodeUserCheckInControllerExecuteRequest extends BaseRequest {
+  body: CreateQRCodeUserCheckInControllerExecuteBody;
 }
 
 // GET /frictionless/failed-checkins - List check-ins on error
 
-export interface GetFrictionlessListFailedCheckinsControllerExecuteQuery {
+export interface ListFailedCheckinsControllerExecuteQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetFrictionlessListFailedCheckinsControllerExecuteResponse = FailedCheckInDTO[];
+export type ListFailedCheckinsControllerExecuteResponse = FailedCheckInDTO[];
 
-export interface GetFrictionlessListFailedCheckinsControllerExecuteRequest
+export interface ListFailedCheckinsControllerExecuteRequest
   extends BaseRequest,
-    RequestQuery<GetFrictionlessListFailedCheckinsControllerExecuteQuery> {}
+    RequestQuery<ListFailedCheckinsControllerExecuteQuery> {}
 
 // POST /frictionless/checkin/{id_checkin}/reprocess - Reprocess checkin on error
 
-export interface PostFrictionlessReprocessCheckinOnErrorControllerExecutePath {
+export interface ReprocessCheckinOnErrorControllerExecutePath {
   // TODO: add parameter to swagger.json
   id_checkin: string;
 }
 
-export type PostFrictionlessReprocessCheckinOnErrorControllerExecuteResponse = {};
+export type ReprocessCheckinOnErrorControllerExecuteResponse = {};
 
-export interface PostFrictionlessReprocessCheckinOnErrorControllerExecuteRequest
+export interface ReprocessCheckinOnErrorControllerExecuteRequest
   extends BaseRequest,
-    PostFrictionlessReprocessCheckinOnErrorControllerExecutePath {}
+    ReprocessCheckinOnErrorControllerExecutePath {}
 
 // GET /frictionless/checkin/{id_checkin}/status - Fetch CheckIn status
 
-export interface GetFrictionlessCheckCheckinStatusControllerExecutePath {
+export interface CheckCheckinStatusControllerExecutePath {
   // TODO: add parameter to swagger.json
   id_checkin: string;
 }
 
-export interface GetFrictionlessCheckCheckinStatusControllerExecuteQuery {
+export interface CheckCheckinStatusControllerExecuteQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetFrictionlessCheckCheckinStatusControllerExecuteResponse =
-  CheckCheckInStatusResponseDTO;
+export type CheckCheckinStatusControllerExecuteResponse = CheckCheckInStatusResponseDTO;
 
-export interface GetFrictionlessCheckCheckinStatusControllerExecuteRequest
+export interface CheckCheckinStatusControllerExecuteRequest
   extends BaseRequest,
-    RequestQuery<GetFrictionlessCheckCheckinStatusControllerExecuteQuery>,
-    GetFrictionlessCheckCheckinStatusControllerExecutePath {}
+    RequestQuery<CheckCheckinStatusControllerExecuteQuery>,
+    CheckCheckinStatusControllerExecutePath {}

package/src/interface/location.ts

@@ -416,7 +416,11 @@ export interface BadRequest {
   error?: string;
 }
 
-export type PartnerStatus = string;
+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
@@ -427,7 +431,11 @@ export interface WaitTime {
   ready_time: number;
 }
 
-export type BrandOrMenuState = string;
+enum BrandOrMenuState {
+  OPEN = "open",
+  CLOSED = "closed",
+  PREORDER = "preorder",
+}
 
 export interface MenuAssociations {
   menu_associations?: MenuAssociation[];
@@ -470,9 +478,9 @@ export interface GetLocationsRequest extends BaseRequest, RequestQuery<GetLocati
 // GET /location/search - Gets Location within a radius of the provided point
 
 export interface GetLocationSearchQuery {
-  // The latitude to be used
+  //@deprecated
   lat?: number;
-  // The longitude to be used
+  //@deprecated
   long?: number;
   // Operation id to be used
   operation_id?: number;
@@ -1285,13 +1293,13 @@ export interface GetLocationV2GroupsQuery {
   // Filter groups by multigroup id. Should be like an array of string
   id_multigroups?: string;
   // The number of items per page to return
-  limit?: number;
+  limit?: string;
   // ASC or DESC
-  sortOrder?: string;
+  sortOrder?: "ASC" | "DESC";
   // The page number to return
-  page?: number;
+  page?: string;
   // Expand group results with children locations and brands
-  expanded?: boolean;
+  expanded?: string;
   // Filter groups by given string
   filter?: string;
   // Graphql query string
@@ -1318,38 +1326,38 @@ export interface GetLocationV2GroupsRequest
 
 // GET /location/menu_association/{id}/brand - Get menu association for a brand
 
-export interface GetLocationMenu_associationBrandPath {
+export interface GetLocationMenuAssociationBrandPath {
   // brand id
   id: string;
 }
 
-export interface GetLocationMenu_associationBrandQuery {
+export interface GetLocationMenuAssociationBrandQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetLocationMenu_associationBrandResponse = MenuAssociations;
+export type GetLocationMenuAssociationBrandResponse = MenuAssociations;
 
-export interface GetLocationMenu_associationBrandRequest
+export interface GetLocationMenuAssociationBrandRequest
   extends BaseRequest,
-    RequestQuery<GetLocationMenu_associationBrandQuery>,
-    GetLocationMenu_associationBrandPath {}
+    RequestQuery<GetLocationMenuAssociationBrandQuery>,
+    GetLocationMenuAssociationBrandPath {}
 
 // GET /location/menu_association/{id}/menu - Get menu association for a brand
 
-export interface GetLocationMenu_associationMenuPath {
+export interface GetLocationMenuAssociationMenuPath {
   // menu id
   id: string;
 }
 
-export interface GetLocationMenu_associationMenuQuery {
+export interface GetLocationMenuAssociationMenuQuery {
   // Graphql query string
   _query?: string;
 }
 
-export type GetLocationMenu_associationMenuResponse = MenuAssociations;
+export type GetLocationMenuAssociationMenuResponse = MenuAssociations;
 
-export interface GetLocationMenu_associationMenuRequest
+export interface GetLocationMenuAssociationMenuRequest
   extends BaseRequest,
-    RequestQuery<GetLocationMenu_associationMenuQuery>,
-    GetLocationMenu_associationMenuPath {}
+    RequestQuery<GetLocationMenuAssociationMenuQuery>,
+    GetLocationMenuAssociationMenuPath {}

package/src/interface/mealplan.ts

@@ -19,12 +19,14 @@ export interface Tender {
   balance?: number;
   amount?: number;
   type?: string;
-  is?: {
-    validated?: boolean;
-  };
+  is?: TenderIs;
   currency?: string;
 }
 
+export interface TenderIs {
+  validated?: boolean;
+}
+
 export interface TendersAndAuth {
   tenders?: Tender[];
   auth?: {
@@ -198,7 +200,7 @@ export interface DeleteMealplanTenderResponse {
   id?: string;
   name?: string;
   balance?: number;
-  is?: Tender["is"];
+  is?: TenderIs;
   transaction_id?: string;
   tender_id?: number;
   currency?: string;
@@ -272,7 +274,7 @@ export interface PutMealplanVerifyRequest extends BaseRequest, PutMealplanVerify
 // POST /mealplan/{id}/authorize - Authorize Transaction
 
 export interface PostMealplanAuthorizePath {
-  // TODO: add parameter to swagger.json
+  // Meal plan ID
   id: string;
 }
 
@@ -288,7 +290,7 @@ export interface PostMealplanAuthorizeResponse {
   id?: string;
   name?: string;
   balance?: number;
-  is?: Tender["is"];
+  is?: TenderIs;
   transaction_id?: string;
   currency?: string;
 }