@compassdigital/sdk.typescript 3.11.0 → 3.12.1

package/src/interface/partner.ts

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

package/src/interface/payment.ts

@@ -1,5 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+import { RequestQuery } from "./util";
+
 export interface Transaction {
   success?: boolean;
   [index: string]: any;
@@ -262,7 +264,9 @@ export interface GetPaymentMethodResponse {
   payment_methods?: PaymentMethod[];
 }
 
-export interface GetPaymentMethodRequest extends GetPaymentMethodQuery, GetPaymentMethodPath {}
+export interface GetPaymentMethodRequest
+  extends RequestQuery<GetPaymentMethodQuery>,
+    GetPaymentMethodPath {}
 
 // DELETE /payment/{id}/method/{method_id}
 
@@ -301,7 +305,7 @@ export interface GetPaymentTokenQuery {
 
 export type GetPaymentTokenResponse = TokenInformation;
 
-export interface GetPaymentTokenRequest extends GetPaymentTokenQuery {}
+export interface GetPaymentTokenRequest extends RequestQuery<GetPaymentTokenQuery> {}
 
 // POST /payment/token
 
@@ -370,7 +374,7 @@ export interface GetPaymentMethodsResponse {
   recordsTotal?: number;
 }
 
-export interface GetPaymentMethodsRequest extends GetPaymentMethodsQuery {}
+export interface GetPaymentMethodsRequest extends RequestQuery<GetPaymentMethodsQuery> {}
 
 // GET /payment/hpc
 
@@ -386,4 +390,4 @@ export interface GetPaymentHpcResponse {
   sessionKey?: string;
 }
 
-export interface GetPaymentHpcRequest extends GetPaymentHpcQuery {}
+export interface GetPaymentHpcRequest extends RequestQuery<GetPaymentHpcQuery> {}

package/src/interface/permission.ts

@@ -1,5 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+import { RequestQuery } from "./util";
+
 export interface Success {
   success?: boolean;
 }
@@ -148,7 +150,7 @@ export interface GetPermissionRoleQuery {
 
 export type GetPermissionRoleResponse = Roles;
 
-export interface GetPermissionRoleRequest extends GetPermissionRoleQuery {}
+export interface GetPermissionRoleRequest extends RequestQuery<GetPermissionRoleQuery> {}
 
 // POST /permission/role - Create a new role
 
@@ -192,7 +194,7 @@ export interface GetPermissionRecipientQuery {
 export type GetPermissionRecipientResponse = Permissions;
 
 export interface GetPermissionRecipientRequest
-  extends GetPermissionRecipientQuery,
+  extends RequestQuery<GetPermissionRecipientQuery>,
     GetPermissionRecipientPath {}
 
 // GET /permission/role/user/{user_id} - Get a list of role assignments for a user

package/src/interface/promo.ts

@@ -1,5 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+import { RequestQuery } from "./util";
+
 export interface Error {
   message?: string;
   code?: number;
@@ -259,7 +261,7 @@ export interface GetPromosQuery {
 
 export type GetPromosResponse = Promotions;
 
-export interface GetPromosRequest extends GetPromosQuery {}
+export interface GetPromosRequest extends RequestQuery<GetPromosQuery> {}
 
 // GET /promo/{id} - Get an individual promotion
 
@@ -275,7 +277,7 @@ export interface GetPromoQuery {
 
 export type GetPromoResponse = Promotion;
 
-export interface GetPromoRequest extends GetPromoQuery, GetPromoPath {}
+export interface GetPromoRequest extends RequestQuery<GetPromoQuery>, GetPromoPath {}
 
 // PUT /promo/{id} - Update a promotion
 
@@ -321,7 +323,7 @@ export interface GetPromoCompanyLocationGroupQuery {
 export type GetPromoCompanyLocationGroupResponse = Promotions;
 
 export interface GetPromoCompanyLocationGroupRequest
-  extends GetPromoCompanyLocationGroupQuery,
+  extends RequestQuery<GetPromoCompanyLocationGroupQuery>,
     GetPromoCompanyLocationGroupPath {}
 
 // POST /promo/validate/voucher - Validate a promo voucher
@@ -386,7 +388,7 @@ export interface DeletePromoVoucherResponse {
 }
 
 export interface DeletePromoVoucherRequest
-  extends DeletePromoVoucherQuery,
+  extends RequestQuery<DeletePromoVoucherQuery>,
     DeletePromoVoucherPath {}
 
 // POST /promo/customer/ - Add user to voucherify

package/src/interface/report.ts

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

package/src/interface/schedule.ts

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

package/src/interface/shoppingcart.ts

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

package/src/interface/sms.ts

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

package/src/interface/task.ts

@@ -1,6 +1,8 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-export interface location {
+import { RequestQuery } from "./util";
+
+export interface TaskLocation {
   // Location ID
   location_id: string;
   // Location latitude
@@ -40,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
@@ -86,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
@@ -113,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
@@ -238,7 +240,9 @@ export interface GetTaskAssigneeQuery {
 
 export type GetTaskAssigneeResponse = Tasks;
 
-export interface GetTaskAssigneeRequest extends GetTaskAssigneeQuery, GetTaskAssigneePath {}
+export interface GetTaskAssigneeRequest
+  extends RequestQuery<GetTaskAssigneeQuery>,
+    GetTaskAssigneePath {}
 
 // GET /task/location/brand/{id} - Get location brand tasks
 
@@ -267,7 +271,7 @@ export interface GetTaskLocationBrandQuery {
 export type GetTaskLocationBrandResponse = Tasks;
 
 export interface GetTaskLocationBrandRequest
-  extends GetTaskLocationBrandQuery,
+  extends RequestQuery<GetTaskLocationBrandQuery>,
     GetTaskLocationBrandPath {}
 
 // GET /task/location/group/{id} - Get location group tasks
@@ -297,5 +301,5 @@ export interface GetTaskLocationGroupQuery {
 export type GetTaskLocationGroupResponse = Tasks;
 
 export interface GetTaskLocationGroupRequest
-  extends GetTaskLocationGroupQuery,
+  extends RequestQuery<GetTaskLocationGroupQuery>,
     GetTaskLocationGroupPath {}

package/src/interface/user.ts

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

package/src/interface/util.ts

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

package/src/interface/vendor.ts

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

package/src/interface/vote.ts

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