@compassdigital/sdk.typescript 3.77.1 → 4.1.0

package/src/index.ts

@@ -723,6 +723,7 @@ import {
   PostMenuV3DraftModifierGroupsResponse,
   GetMenuV3DraftModifierGroupsCountQuery,
   GetMenuV3DraftModifierGroupsCountResponse,
+  PostMenuV3DraftModifierGroupDuplicateResponse,
   GetMenuV3ModifierGroupQuery,
   GetMenuV3ModifierGroupResponse,
   GetMenuV3ModifierGroupsQuery,
@@ -3327,7 +3328,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * POST /mealplan/{id}/authorize - Authorize Transaction
    *
-   * @param id - TODO: add parameter to swagger.json
+   * @param id - Meal plan ID
    * @param body
    * @param options - additional request options
    */
@@ -3828,7 +3829,7 @@ export class ServiceClient extends BaseServiceClient {
   /**
    * GET /announcement/resource/{id} - Get Announcements
    *
-   * @param id - Id of the entity to which announcement is specifically related.; TODO: mark parameter as required in swagger
+   * @param id - Id of the entity to which announcement is specifically related.
    * @param options - additional request options
    */
   get_announcement_resource(
@@ -3940,7 +3941,7 @@ export class ServiceClient extends BaseServiceClient {
    */
   get_report_analytics_group(
     location_group: string,
-    report_type: string,
+    report_type: "bills" | "sales" | "transactions" | "top-items",
     options: {
       query: GetReportAnalyticsGroupQuery;
     } & RequestOptions
@@ -6084,7 +6085,7 @@ export class ServiceClient extends BaseServiceClient {
    */
   post_menu_v3_brand_attachment(
     id: string,
-    name: string,
+    name: "thumbnail",
     options?: {
       query?: PostMenuV3BrandAttachmentQuery;
     } & RequestOptions
@@ -7134,7 +7135,7 @@ export class ServiceClient extends BaseServiceClient {
    */
   post_menu_v3_item_attachment(
     id: string,
-    name: string,
+    name: "thumbnail",
     options?: {
       query?: PostMenuV3ItemAttachmentQuery;
     } & RequestOptions
@@ -7567,6 +7568,26 @@ export class ServiceClient extends BaseServiceClient {
     );
   }
 
+  /**
+   * POST /menu/v3/draft/modifier-group/{id}/duplicate
+   *
+   * @param id
+   * @param options - additional request options
+   */
+  post_menu_v3_draft_modifier_group_duplicate(
+    id: string,
+    options?: RequestOptions
+  ): ResponsePromise<PostMenuV3DraftModifierGroupDuplicateResponse> {
+    return this.request(
+      "menu",
+      "post_menu_v3_draft_modifier_group_duplicate",
+      "post",
+      `/menu/v3/draft/modifier-group/${id}/duplicate`,
+      null,
+      options
+    );
+  }
+
   /**
    * GET /menu/v3/modifier-group/{id}
    *

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/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,14 +67,14 @@ 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 StandardCognitionEventWebhookControllerExecuteBody = StandardCognitionEvent;
 
-export type StandardCognitionEventWebhookControllerExecuteResponse = any;
+export type StandardCognitionEventWebhookControllerExecuteResponse = {};
 
 export interface StandardCognitionEventWebhookControllerExecuteRequest extends BaseRequest {
   body: StandardCognitionEventWebhookControllerExecuteBody;

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

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;
 }