@compassdigital/sdk.typescript 3.38.0 → 3.40.0

package/src/interface/payment.ts

@@ -171,10 +171,8 @@ export interface PostPaymentTransactionRefundPath {
 export interface PostPaymentTransactionRefundBody {
   // The amount to refund for the transaction
   amount: string;
-  // The payment method token to use for the payment (FreedomPay + Exact)
-  payment_method_token?: string;
-  transaction?: Transaction;
-  options?: Options;
+  transaction: Transaction;
+  options: Options;
 }
 
 export type PostPaymentTransactionRefundResponse = Refund;
@@ -192,9 +190,17 @@ export interface GetPaymentClienttokenPath {
   id: string;
 }
 
+export interface GetPaymentClienttokenQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPaymentClienttokenResponse = ClientToken;
 
-export interface GetPaymentClienttokenRequest extends BaseRequest, GetPaymentClienttokenPath {}
+export interface GetPaymentClienttokenRequest
+  extends BaseRequest,
+    RequestQuery<GetPaymentClienttokenQuery>,
+    GetPaymentClienttokenPath {}
 
 // POST /payment/{id}/paymenttoken
 
@@ -267,6 +273,8 @@ export interface GetPaymentMethodPath {
 export interface GetPaymentMethodQuery {
   // The user id
   user_id: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentMethodResponse {
@@ -311,6 +319,8 @@ export interface GetPaymentTokenQuery {
   terminalId: string;
   // name on card
   nameOnCard: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPaymentTokenResponse = TokenInformation;
@@ -375,6 +385,8 @@ export interface GetPaymentMethodsQuery {
   storeId: any[];
   // FP TerminalId
   terminalId: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentMethodsResponse {
@@ -393,6 +405,8 @@ export interface GetPaymentHpcQuery {
   storeId: string;
   // FP TerminalId
   terminalId: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentHpcResponse {
@@ -407,6 +421,8 @@ export interface GetPaymentHpcRequest extends BaseRequest, RequestQuery<GetPayme
 export interface GetPaymentHcaptchaVerifyQuery {
   // hCaptcha response key
   responseKey?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export interface GetPaymentHcaptchaVerifyResponse {
@@ -424,11 +440,19 @@ export interface GetPaymentBadgepayPath {
   id: string;
 }
 
+export interface GetPaymentBadgepayQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPaymentBadgepayResponse {
   tenders?: BadgePayTender[];
 }
 
-export interface GetPaymentBadgepayRequest extends BaseRequest, GetPaymentBadgepayPath {}
+export interface GetPaymentBadgepayRequest
+  extends BaseRequest,
+    RequestQuery<GetPaymentBadgepayQuery>,
+    GetPaymentBadgepayPath {}
 
 // POST /payment/{id}/badgepay
 

package/src/interface/permission.ts

@@ -146,6 +146,8 @@ export interface GetPermissionRoleQuery {
   status?: string;
   // Key for pagination, retrieves the next page of items
   start_at?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPermissionRoleResponse = Roles;
@@ -191,6 +193,8 @@ export interface GetPermissionRecipientPath {
 export interface GetPermissionRecipientQuery {
   // Show additional meta fields
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPermissionRecipientResponse = Permissions;
@@ -207,9 +211,17 @@ export interface GetPermissionRoleUserPath {
   user_id: string;
 }
 
+export interface GetPermissionRoleUserQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPermissionRoleUserResponse = RoleAssignments;
 
-export interface GetPermissionRoleUserRequest extends BaseRequest, GetPermissionRoleUserPath {}
+export interface GetPermissionRoleUserRequest
+  extends BaseRequest,
+    RequestQuery<GetPermissionRoleUserQuery>,
+    GetPermissionRoleUserPath {}
 
 // POST /permission/role/user/{user_id} - Assign a role to a user
 

package/src/interface/promo.ts

@@ -257,6 +257,8 @@ export interface PostPromoRequest extends BaseRequest {
 export interface GetPromosQuery {
   // Limit to promotions in selected multigroup
   multigroup?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPromosResponse = Promotions;
@@ -273,6 +275,8 @@ export interface GetPromoPath {
 export interface GetPromoQuery {
   // Show all props of the promotion(ex., location_group_ids)
   extended?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetPromoResponse = Promotion;
@@ -317,6 +321,8 @@ export interface GetPromoCompanyLocationGroupPath {
 export interface GetPromoCompanyLocationGroupQuery {
   // Return only promos of certain status.
   status?: string;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -446,6 +452,13 @@ export interface PostPromoVoucherifyActivityExecuteRequest extends BaseRequest {
 
 // GET /promo/voucherify/activity/config.json - Get SFMC Journey Custom Activity configuration
 
+export interface GetPromoVoucherifyActivityConfigQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPromoVoucherifyActivityConfigResponse = SFMCConfig;
 
-export interface GetPromoVoucherifyActivityConfigRequest extends BaseRequest {}
+export interface GetPromoVoucherifyActivityConfigRequest
+  extends BaseRequest,
+    RequestQuery<GetPromoVoucherifyActivityConfigQuery> {}

package/src/interface/report.ts

@@ -319,6 +319,8 @@ export interface GetReportAnalyticsGroupQuery {
   end_date: string;
   time_frame: string;
   order_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetReportAnalyticsGroupResponse = P2AnalyticsReport;
@@ -341,6 +343,8 @@ export interface GetReportAnalyticsCombinedGroupQuery {
   end_date: string;
   time_frame: string;
   order_type?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetReportAnalyticsCombinedGroupResponse = SAReport;
@@ -365,6 +369,8 @@ export interface GetReportEodGroupQuery {
   format?: string;
   // Location IDs, comma-separated
   locations?: string;
+  // Graphql query string
+  _query?: string;
   nocache?: boolean;
 }
 
@@ -381,10 +387,16 @@ export interface GetReportEodGroupSubscribersPath {
   id: string;
 }
 
+export interface GetReportEodGroupSubscribersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetReportEodGroupSubscribersResponse = EODSubscribers;
 
 export interface GetReportEodGroupSubscribersRequest
   extends BaseRequest,
+    RequestQuery<GetReportEodGroupSubscribersQuery>,
     GetReportEodGroupSubscribersPath {}
 
 // POST /report/eod/group/{id}/subscribers - Add emails to selected location group

package/src/interface/shoppingcart.ts

@@ -319,9 +319,17 @@ export interface GetShoppingcartCartPath {
   id: string;
 }
 
+export interface GetShoppingcartCartQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetShoppingcartCartResponse = ShoppingCartResponse;
 
-export interface GetShoppingcartCartRequest extends BaseRequest, GetShoppingcartCartPath {}
+export interface GetShoppingcartCartRequest
+  extends BaseRequest,
+    RequestQuery<GetShoppingcartCartQuery>,
+    GetShoppingcartCartPath {}
 
 // PATCH /shoppingcart/{id} - Update a ShoppingCart
 

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

@@ -193,6 +193,7 @@ export interface Checkin {
   date_queued?: string;
   // The state of the user association process (attaching). Present for NFC check-ins only
   state?: string;
+  meta?: CheckinMeta;
 }
 
 export interface PatchCheckin {
@@ -200,6 +201,20 @@ export interface PatchCheckin {
   date_queued?: number;
   // The state of the user association process (attaching). Present for NFC check-ins only
   state?: string;
+  meta?: CheckinMeta;
+}
+
+export interface CheckinMeta {
+  order_id?: string;
+  status?: string;
+  logs?: {
+    code?: number;
+    date?: string;
+    message?: string;
+    type?: string;
+    [index: string]: any;
+  }[];
+  [index: string]: any;
 }
 
 export interface RefreshToken {
@@ -267,6 +282,8 @@ export interface Acl {
 export interface GetUserAuthQuery {
   // realm
   realm?: string;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserAuthResponse = auth;
@@ -285,11 +302,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 +338,8 @@ export interface GetUserPath {
 export interface GetUserQuery {
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserResponse = User;
@@ -395,6 +419,8 @@ export interface PostUserKdsTokenRequest extends BaseRequest {
 
 export interface GetUserKdsTokenQuery {
   authorized?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserKdsTokenResponse = KDSDevices;
@@ -468,11 +494,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 +564,8 @@ export interface GetUserRealmUsersQuery {
   lastmodified_start?: string;
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserRealmUsersResponse = Users;
@@ -549,6 +585,8 @@ export interface GetUserPermissionsPath {
 export interface GetUserPermissionsQuery {
   // Use ACL permission system
   acl?: boolean;
+  // Graphql query string
+  _query?: string;
 }
 
 export type GetUserPermissionsResponse = User;
@@ -622,6 +660,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;