@compassdigital/sdk.typescript 3.37.0 → 3.39.0

package/src/interface/task.ts

@@ -154,9 +154,14 @@ export interface GetTaskPath {
   id: string;
 }
 
+export interface GetTaskQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetTaskResponse = Task;
 
-export interface GetTaskRequest extends BaseRequest, GetTaskPath {}
+export interface GetTaskRequest extends BaseRequest, RequestQuery<GetTaskQuery>, GetTaskPath {}
 
 // PATCH /task/{id} - Update Task
 
@@ -191,9 +196,17 @@ export interface GetTaskOrderPath {
   id: string;
 }
 
+export interface GetTaskOrderQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetTaskOrderResponse = Task;
 
-export interface GetTaskOrderRequest extends BaseRequest, GetTaskOrderPath {}
+export interface GetTaskOrderRequest
+  extends BaseRequest,
+    RequestQuery<GetTaskOrderQuery>,
+    GetTaskOrderPath {}
 
 // GET /task/order/{id}/kds - Get KDS tasks based on passed order ID
 
@@ -202,9 +215,17 @@ export interface GetTaskOrderKdsPath {
   id: string;
 }
 
+export interface GetTaskOrderKdsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetTaskOrderKdsResponse = Tasks;
 
-export interface GetTaskOrderKdsRequest extends BaseRequest, GetTaskOrderKdsPath {}
+export interface GetTaskOrderKdsRequest
+  extends BaseRequest,
+    RequestQuery<GetTaskOrderKdsQuery>,
+    GetTaskOrderKdsPath {}
 
 // PATCH /task/order/{id}/kds - Update an order and its associated tasks
 
@@ -239,6 +260,8 @@ export interface GetTaskAssigneeQuery {
   started?: number;
   // Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
   completed?: number;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetTaskAssigneeResponse = Tasks;
@@ -270,6 +293,8 @@ export interface GetTaskLocationBrandQuery {
   pickup_time?: number;
   // The type of task that will be searched on. The default is: 'bolter'
   query_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetTaskLocationBrandResponse = Tasks;
@@ -301,6 +326,8 @@ export interface GetTaskLocationGroupQuery {
   pickup_time?: number;
   // The type of task that will be searched on. The default is: 'bolter'
   query_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetTaskLocationGroupResponse = Tasks;

package/src/interface/user.ts

@@ -267,6 +267,8 @@ export interface Acl {
 export interface GetUserAuthQuery {
   // realm
   realm?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserAuthResponse = auth;
@@ -285,11 +287,16 @@ export interface PostUserAuthRequest extends BaseRequest {
 
 // GET /user/zendesk - Get zendesk JWT token to allow web widget to search restricted articles
 
+export interface GetUserZendeskQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetUserZendeskResponse {
   token: string;
 }
 
-export interface GetUserZendeskRequest extends BaseRequest {}
+export interface GetUserZendeskRequest extends BaseRequest, RequestQuery<GetUserZendeskQuery> {}
 
 // POST /user - Create an User
 
@@ -316,6 +323,8 @@ export interface GetUserPath {
 export interface GetUserQuery {
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserResponse = User;
@@ -395,6 +404,8 @@ export interface PostUserKdsTokenRequest extends BaseRequest {
 
 export interface GetUserKdsTokenQuery {
   authorized?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserKdsTokenResponse = KDSDevices;
@@ -468,11 +479,19 @@ export interface GetUserSecretPath {
   key: string;
 }
 
+export interface GetUserSecretQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetUserSecretResponse {
   [index: string]: any;
 }
 
-export interface GetUserSecretRequest extends BaseRequest, GetUserSecretPath {}
+export interface GetUserSecretRequest
+  extends BaseRequest,
+    RequestQuery<GetUserSecretQuery>,
+    GetUserSecretPath {}
 
 // POST /user/forgotpassword - Reset the users password
 
@@ -530,6 +549,8 @@ export interface GetUserRealmUsersQuery {
   lastmodified_start?: string;
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserRealmUsersResponse = Users;
@@ -549,6 +570,8 @@ export interface GetUserPermissionsPath {
 export interface GetUserPermissionsQuery {
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserPermissionsResponse = User;
@@ -622,6 +645,8 @@ export interface GetUserSearchCheckInQuery {
   checkin_uuid?: string;
   // Visit UUID that corresponds to the check-in
   visit_uuid?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserSearchCheckInResponse = Checkin;

package/src/interface/vendor.ts

@@ -212,6 +212,8 @@ export interface GetVendorApplicationQuery {
   status?: string;
   // Pagination token to start query from
   last_evaluated_key?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetVendorApplicationResponse = Applications;
@@ -247,9 +249,14 @@ export interface PostVendorRequest extends BaseRequest {
 
 // GET /vendor - Get all Vendors
 
+export interface GetVendorsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetVendorsResponse = Vendors;
 
-export interface GetVendorsRequest extends BaseRequest {}
+export interface GetVendorsRequest extends BaseRequest, RequestQuery<GetVendorsQuery> {}
 
 // GET /vendor/{id} - Get info about the Vendor
 
@@ -258,9 +265,17 @@ export interface GetVendorPath {
   id: string;
 }
 
+export interface GetVendorQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetVendorResponse = Vendor;
 
-export interface GetVendorRequest extends BaseRequest, GetVendorPath {}
+export interface GetVendorRequest
+  extends BaseRequest,
+    RequestQuery<GetVendorQuery>,
+    GetVendorPath {}
 
 // PATCH /vendor/{id} - Update info about the Vendor
 
@@ -279,9 +294,14 @@ export interface PatchVendorRequest extends BaseRequest, PatchVendorPath {
 
 // GET /vendor/auth - Get access/refresh tokens for accessing our APIs
 
+export interface GetVendorAuthQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetVendorAuthResponse = Auth;
 
-export interface GetVendorAuthRequest extends BaseRequest {}
+export interface GetVendorAuthRequest extends BaseRequest, RequestQuery<GetVendorAuthQuery> {}
 
 // POST /vendor/auth - Get new access token using refresh token and previous token
 
@@ -300,9 +320,17 @@ export interface GetVendorKeysPath {
   id: string;
 }
 
+export interface GetVendorKeysQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetVendorKeysResponse = Keys;
 
-export interface GetVendorKeysRequest extends BaseRequest, GetVendorKeysPath {}
+export interface GetVendorKeysRequest
+  extends BaseRequest,
+    RequestQuery<GetVendorKeysQuery>,
+    GetVendorKeysPath {}
 
 // POST /vendor/{id}/key - Create new key for the vendor
 
@@ -331,6 +359,8 @@ export interface GetVendorKeyPath {
 export interface GetVendorKeyQuery {
   // Pagination token to start query from
   last_evaluated_key?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetVendorKeyResponse = Key;