@compassdigital/sdk.typescript 3.12.0 → 3.12.1

package/src/interface/report.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Success {
   success?: boolean;
@@ -384,7 +384,7 @@ export interface GetReportAnalyticsGroupQuery {
 export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
 
 export interface GetReportAnalyticsGroupRequest
-  extends WithStringProps<GetReportAnalyticsGroupQuery>,
+  extends RequestQuery<GetReportAnalyticsGroupQuery>,
     GetReportAnalyticsGroupPath {}
 
 // GET /report/analytics/combined/group/{location_group}
@@ -405,7 +405,7 @@ export interface GetReportAnalyticsCombinedGroupQuery {
 export type GetReportAnalyticsCombinedGroupResponse = SAReport;
 
 export interface GetReportAnalyticsCombinedGroupRequest
-  extends WithStringProps<GetReportAnalyticsCombinedGroupQuery>,
+  extends RequestQuery<GetReportAnalyticsCombinedGroupQuery>,
     GetReportAnalyticsCombinedGroupPath {}
 
 // GET /report/analytics/exactmobile/totals
@@ -420,7 +420,7 @@ export interface GetReportAnalyticsExactmobileTotalsQuery {
 export type GetReportAnalyticsExactmobileTotalsResponse = DiscrepancyTotals;
 
 export interface GetReportAnalyticsExactmobileTotalsRequest
-  extends WithStringProps<GetReportAnalyticsExactmobileTotalsQuery> {}
+  extends RequestQuery<GetReportAnalyticsExactmobileTotalsQuery> {}
 
 // GET /report/analytics/exactmobile/transactions
 
@@ -434,7 +434,7 @@ export interface GetReportAnalyticsExactmobileTransactionsQuery {
 export type GetReportAnalyticsExactmobileTransactionsResponse = DiscrepancyTranscation;
 
 export interface GetReportAnalyticsExactmobileTransactionsRequest
-  extends WithStringProps<GetReportAnalyticsExactmobileTransactionsQuery> {}
+  extends RequestQuery<GetReportAnalyticsExactmobileTransactionsQuery> {}
 
 // GET /report/analytics/exactmobile/discrepancies
 
@@ -448,7 +448,7 @@ export interface GetReportAnalyticsExactmobileDiscrepanciesQuery {
 export type GetReportAnalyticsExactmobileDiscrepanciesResponse = DiscrepancyCount;
 
 export interface GetReportAnalyticsExactmobileDiscrepanciesRequest
-  extends WithStringProps<GetReportAnalyticsExactmobileDiscrepanciesQuery> {}
+  extends RequestQuery<GetReportAnalyticsExactmobileDiscrepanciesQuery> {}
 
 // GET /report/analytics/tracker/report/{id}
 
@@ -482,7 +482,7 @@ export interface GetReportEodGroupQuery {
 export type GetReportEodGroupResponse = EODReports;
 
 export interface GetReportEodGroupRequest
-  extends WithStringProps<GetReportEodGroupQuery>,
+  extends RequestQuery<GetReportEodGroupQuery>,
     GetReportEodGroupPath {}
 
 // GET /report/eod/group/{id}/subscribers - Get reports for selected location group
@@ -543,7 +543,7 @@ export interface GetReportDiscrepancySubscribersQuery {
 export type GetReportDiscrepancySubscribersResponse = DiscrepancySubscriber;
 
 export interface GetReportDiscrepancySubscribersRequest
-  extends WithStringProps<GetReportDiscrepancySubscribersQuery> {}
+  extends RequestQuery<GetReportDiscrepancySubscribersQuery> {}
 
 // DELETE /report/discrepancy/subscribers - deletes subscriber from discrepency
 
@@ -554,7 +554,7 @@ export interface DeleteReportDiscrepancySubscribersQuery {
 export type DeleteReportDiscrepancySubscribersResponse = Success;
 
 export interface DeleteReportDiscrepancySubscribersRequest
-  extends WithStringProps<DeleteReportDiscrepancySubscribersQuery> {}
+  extends RequestQuery<DeleteReportDiscrepancySubscribersQuery> {}
 
 // POST /report/discrepancy/subscribers - Create new discrepancy subscriber
 

package/src/interface/schedule.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Error {
   message?: string;
@@ -99,7 +99,7 @@ export interface GetSchedulesQuery {
 
 export type GetSchedulesResponse = Schedules;
 
-export interface GetSchedulesRequest extends WithStringProps<GetSchedulesQuery> {}
+export interface GetSchedulesRequest extends RequestQuery<GetSchedulesQuery> {}
 
 // GET /schedule/{id} - Get an individual schedule
 

package/src/interface/shoppingcart.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Error {
   message?: string;

package/src/interface/sms.ts

@@ -1,3 +1,3 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";

package/src/interface/task.ts

@@ -1,8 +1,8 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
-export interface location {
+export interface TaskLocation {
   // Location ID
   location_id: string;
   // Location latitude
@@ -42,8 +42,8 @@ export interface Task {
     order_details?: any;
     delivery_instructions?: string;
   };
-  pickup_details?: location;
-  dropoff_details?: location;
+  pickup_details?: TaskLocation;
+  dropoff_details?: TaskLocation;
   // Task Status
   status?: string;
   // Any related metadata information about this Task
@@ -88,8 +88,8 @@ export interface TaskCreate {
     order_details?: any;
     delivery_instructions?: string;
   };
-  pickup_details: location;
-  dropoff_details: location;
+  pickup_details: TaskLocation;
+  dropoff_details: TaskLocation;
   // Task Status
   status: string;
   // Any related metadata information about this Task
@@ -115,8 +115,8 @@ export interface TaskUpdate {
     order_details?: any;
     delivery_instructions?: string;
   };
-  pickup_details?: location;
-  dropoff_details?: location;
+  pickup_details?: TaskLocation;
+  dropoff_details?: TaskLocation;
   // Task Status
   status?: string;
   // Any related metadata information about this Task
@@ -241,7 +241,7 @@ export interface GetTaskAssigneeQuery {
 export type GetTaskAssigneeResponse = Tasks;
 
 export interface GetTaskAssigneeRequest
-  extends WithStringProps<GetTaskAssigneeQuery>,
+  extends RequestQuery<GetTaskAssigneeQuery>,
     GetTaskAssigneePath {}
 
 // GET /task/location/brand/{id} - Get location brand tasks
@@ -271,7 +271,7 @@ export interface GetTaskLocationBrandQuery {
 export type GetTaskLocationBrandResponse = Tasks;
 
 export interface GetTaskLocationBrandRequest
-  extends WithStringProps<GetTaskLocationBrandQuery>,
+  extends RequestQuery<GetTaskLocationBrandQuery>,
     GetTaskLocationBrandPath {}
 
 // GET /task/location/group/{id} - Get location group tasks
@@ -301,5 +301,5 @@ export interface GetTaskLocationGroupQuery {
 export type GetTaskLocationGroupResponse = Tasks;
 
 export interface GetTaskLocationGroupRequest
-  extends WithStringProps<GetTaskLocationGroupQuery>,
+  extends RequestQuery<GetTaskLocationGroupQuery>,
     GetTaskLocationGroupPath {}

package/src/interface/user.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Error {
   message?: string;
@@ -227,7 +227,7 @@ export interface GetUserAuthQuery {
 
 export type GetUserAuthResponse = auth;
 
-export interface GetUserAuthRequest extends WithStringProps<GetUserAuthQuery> {}
+export interface GetUserAuthRequest extends RequestQuery<GetUserAuthQuery> {}
 
 // POST /user/auth - Use refresh token to generate a new access token and refresh token
 
@@ -258,7 +258,7 @@ export type PostUserBody = User;
 
 export type PostUserResponse = User;
 
-export interface PostUserRequest extends WithStringProps<PostUserQuery> {
+export interface PostUserRequest extends RequestQuery<PostUserQuery> {
   body: PostUserBody;
 }
 
@@ -276,7 +276,7 @@ export interface GetUserQuery {
 
 export type GetUserResponse = User;
 
-export interface GetUserRequest extends WithStringProps<GetUserQuery>, GetUserPath {}
+export interface GetUserRequest extends RequestQuery<GetUserQuery>, GetUserPath {}
 
 // PUT /user/{id} - Update an individual user
 
@@ -294,7 +294,7 @@ export type PutUserBody = User;
 
 export type PutUserResponse = User;
 
-export interface PutUserRequest extends WithStringProps<PutUserQuery>, PutUserPath {
+export interface PutUserRequest extends RequestQuery<PutUserQuery>, PutUserPath {
   body: PutUserBody;
 }
 
@@ -314,7 +314,7 @@ export type PatchUserBody = User;
 
 export type PatchUserResponse = User;
 
-export interface PatchUserRequest extends WithStringProps<PatchUserQuery>, PatchUserPath {
+export interface PatchUserRequest extends RequestQuery<PatchUserQuery>, PatchUserPath {
   body: PatchUserBody;
 }
 
@@ -332,7 +332,7 @@ export interface DeleteUserQuery {
 
 export type DeleteUserResponse = success;
 
-export interface DeleteUserRequest extends WithStringProps<DeleteUserQuery>, DeleteUserPath {}
+export interface DeleteUserRequest extends RequestQuery<DeleteUserQuery>, DeleteUserPath {}
 
 // POST /user/device/auth - Endpoint for generating/retrieving KDS device token
 
@@ -352,7 +352,7 @@ export interface GetUserKdsTokenQuery {
 
 export type GetUserKdsTokenResponse = KDSDevices;
 
-export interface GetUserKdsTokenRequest extends WithStringProps<GetUserKdsTokenQuery> {}
+export interface GetUserKdsTokenRequest extends RequestQuery<GetUserKdsTokenQuery> {}
 
 // DELETE /user/device/auth/{device_id} - Endpoint for deleting a device by specified device_id
 
@@ -444,7 +444,7 @@ export type PostUserResetPasswordBody = Forgotpassword;
 
 export type PostUserResetPasswordResponse = success;
 
-export interface PostUserResetPasswordRequest extends WithStringProps<PostUserResetPasswordQuery> {
+export interface PostUserResetPasswordRequest extends RequestQuery<PostUserResetPasswordQuery> {
   body: PostUserResetPasswordBody;
 }
 
@@ -465,7 +465,7 @@ export type PostUserResetPasswordTokenBody = Resetpassword;
 export type PostUserResetPasswordTokenResponse = success;
 
 export interface PostUserResetPasswordTokenRequest
-  extends WithStringProps<PostUserResetPasswordTokenQuery>,
+  extends RequestQuery<PostUserResetPasswordTokenQuery>,
     PostUserResetPasswordTokenPath {
   body: PostUserResetPasswordTokenBody;
 }
@@ -489,7 +489,7 @@ export interface GetUserRealmUsersQuery {
 export type GetUserRealmUsersResponse = Users;
 
 export interface GetUserRealmUsersRequest
-  extends WithStringProps<GetUserRealmUsersQuery>,
+  extends RequestQuery<GetUserRealmUsersQuery>,
     GetUserRealmUsersPath {}
 
 // GET /user/{id}/permissions - Get user permissions
@@ -507,7 +507,7 @@ export interface GetUserPermissionsQuery {
 export type GetUserPermissionsResponse = User;
 
 export interface GetUserPermissionsRequest
-  extends WithStringProps<GetUserPermissionsQuery>,
+  extends RequestQuery<GetUserPermissionsQuery>,
     GetUserPermissionsPath {}
 
 // PUT /user/{id}/permissions - Update user permissions
@@ -529,7 +529,7 @@ export interface PutUserPermissionsBody {
 export type PutUserPermissionsResponse = User;
 
 export interface PutUserPermissionsRequest
-  extends WithStringProps<PutUserPermissionsQuery>,
+  extends RequestQuery<PutUserPermissionsQuery>,
     PutUserPermissionsPath {
   body: PutUserPermissionsBody;
 }
@@ -577,7 +577,7 @@ export interface GetUserSearchCheckInQuery {
 
 export type GetUserSearchCheckInResponse = Checkin;
 
-export interface GetUserSearchCheckInRequest extends WithStringProps<GetUserSearchCheckInQuery> {}
+export interface GetUserSearchCheckInRequest extends RequestQuery<GetUserSearchCheckInQuery> {}
 
 // POST /user/{id}/verification - Send email verification to user
 
@@ -624,7 +624,7 @@ export interface PostUserVerificationPhoneBody {
 export type PostUserVerificationPhoneResponse = success;
 
 export interface PostUserVerificationPhoneRequest
-  extends WithStringProps<PostUserVerificationPhoneQuery>,
+  extends RequestQuery<PostUserVerificationPhoneQuery>,
     PostUserVerificationPhonePath {
   body: PostUserVerificationPhoneBody;
 }

package/src/interface/util.ts

@@ -1,7 +1,6 @@
-
 /**
- * Convert all properties of T to be of type string.
+ * Convert number query parameters to string.
  */
-export type WithStringProps<T extends object> = {
-	[K in keyof T]: string;
+export type RequestQuery<T extends object> = {
+	[K in keyof T]: T[K] extends number ? string : T[K];
 }

package/src/interface/vendor.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Error {
   message?: string;
@@ -216,7 +216,7 @@ export interface GetVendorApplicationQuery {
 
 export type GetVendorApplicationResponse = Applications;
 
-export interface GetVendorApplicationRequest extends WithStringProps<GetVendorApplicationQuery> {}
+export interface GetVendorApplicationRequest extends RequestQuery<GetVendorApplicationQuery> {}
 
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
@@ -333,7 +333,7 @@ export interface GetVendorKeyQuery {
 
 export type GetVendorKeyResponse = Key;
 
-export interface GetVendorKeyRequest extends WithStringProps<GetVendorKeyQuery>, GetVendorKeyPath {}
+export interface GetVendorKeyRequest extends RequestQuery<GetVendorKeyQuery>, GetVendorKeyPath {}
 
 // PATCH /vendor/{id}/key/{key} - Update info for vendor key
 
@@ -381,7 +381,7 @@ export interface PostVendorKeyRotateQuery {
 export type PostVendorKeyRotateResponse = Success;
 
 export interface PostVendorKeyRotateRequest
-  extends WithStringProps<PostVendorKeyRotateQuery>,
+  extends RequestQuery<PostVendorKeyRotateQuery>,
     PostVendorKeyRotatePath {}
 
 // POST /vendor/{id}/reset/password - Reset the existing password for vendor

package/src/interface/vote.ts

@@ -1,6 +1,6 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { WithStringProps } from "./util";
+import { RequestQuery } from "./util";
 
 export interface Error {
   message?: string;
@@ -72,4 +72,4 @@ export interface GetVoteIdfaResponse {
   votes?: Vote[];
 }
 
-export interface GetVoteIdfaRequest extends WithStringProps<GetVoteIdfaQuery>, GetVoteIdfaPath {}
+export interface GetVoteIdfaRequest extends RequestQuery<GetVoteIdfaQuery>, GetVoteIdfaPath {}