@compassdigital/sdk.typescript 4.66.0 → 4.68.0

package/src/interface/vendor.ts

@@ -1,201 +1,201 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface Error {
-  message?: string;
-  code?: number;
-  data?: Record<string, any>;
+	message?: string;
+	code?: number;
+	data?: Record<string, any>;
 }
 
 export interface ApplicationPostBody {
-  name: string;
-  phone: string;
-  description?: string;
-  email: string;
-  // Property to store any additional data
-  meta?: {
-    website?: string;
-    // Contact info
-    contact?: {
-      first_name?: string;
-      last_name?: string;
-      phone_number?: string;
-    };
-    [index: string]: any;
-  };
-  captcha_token: string;
+	name: string;
+	phone: string;
+	description?: string;
+	email: string;
+	// Property to store any additional data
+	meta?: {
+		website?: string;
+		// Contact info
+		contact?: {
+			first_name?: string;
+			last_name?: string;
+			phone_number?: string;
+		};
+		[index: string]: any;
+	};
+	captcha_token: string;
 }
 
 export interface ApplicationPatchBody {
-  // application
-  id?: string;
-  name?: string;
-  description?: string;
-  email?: string;
-  phone?: string;
-  // Property to store any additional data
-  meta?: {
-    website?: string;
-    // Contact info
-    contact?: {
-      first_name?: string;
-      last_name?: string;
-      phone_number?: string;
-    };
-    [index: string]: any;
-  };
-  status?: "pending" | "approved" | "rejected";
+	// application
+	id?: string;
+	name?: string;
+	description?: string;
+	email?: string;
+	phone?: string;
+	// Property to store any additional data
+	meta?: {
+		website?: string;
+		// Contact info
+		contact?: {
+			first_name?: string;
+			last_name?: string;
+			phone_number?: string;
+		};
+		[index: string]: any;
+	};
+	status?: 'pending' | 'approved' | 'rejected';
 }
 
 export interface Application {
-  // application
-  id?: string;
-  date_created?: string;
-  date_modified?: string;
-  name?: string;
-  description?: string;
-  email?: string;
-  phone?: string;
-  // Property to store any additional data
-  meta?: {
-    website?: string;
-    // Contact info
-    contact?: {
-      first_name?: string;
-      last_name?: string;
-      phone_number?: string;
-    };
-    // vendor
-    vendor_id?: string;
-    [index: string]: any;
-  };
-  status?: "pending" | "approved" | "rejected";
+	// application
+	id?: string;
+	date_created?: string;
+	date_modified?: string;
+	name?: string;
+	description?: string;
+	email?: string;
+	phone?: string;
+	// Property to store any additional data
+	meta?: {
+		website?: string;
+		// Contact info
+		contact?: {
+			first_name?: string;
+			last_name?: string;
+			phone_number?: string;
+		};
+		// vendor
+		vendor_id?: string;
+		[index: string]: any;
+	};
+	status?: 'pending' | 'approved' | 'rejected';
 }
 
 export interface Applications {
-  last_evaluated_key?: string;
-  applications: Application[];
+	last_evaluated_key?: string;
+	applications: Application[];
 }
 
 export interface Vendor {
-  // vendor
-  id?: string;
-  name?: string;
-  description?: string;
-  email?: string;
-  phone?: string;
-  // Property to store any additional data
-  meta?: {
-    legacy_token?: {
-      dev?: string;
-      staging?: string;
-      v1?: string;
-    };
-    website?: string;
-    // Contact info
-    contact?: {
-      first_name?: string;
-      last_name?: string;
-      phone_number?: string;
-    };
-    reset_token?: string;
-    [index: string]: any;
-  };
-  domain?: string;
+	// vendor
+	id?: string;
+	name?: string;
+	description?: string;
+	email?: string;
+	phone?: string;
+	// Property to store any additional data
+	meta?: {
+		legacy_token?: {
+			dev?: string;
+			staging?: string;
+			v1?: string;
+		};
+		website?: string;
+		// Contact info
+		contact?: {
+			first_name?: string;
+			last_name?: string;
+			phone_number?: string;
+		};
+		reset_token?: string;
+		[index: string]: any;
+	};
+	domain?: string;
 }
 
 export interface VendorPostBody {
-  name: string;
-  description?: string;
-  email: string;
-  domain?: string;
-  phone?: string;
-  // Property to store any additional data
-  meta?: {
-    legacy_token?: {
-      dev?: string;
-      staging?: string;
-      v1?: string;
-    };
-    website?: string;
-    reset_token?: string;
-    // Contact info
-    contact?: {
-      first_name?: string;
-      last_name?: string;
-      phone_number?: string;
-    };
-    [index: string]: any;
-  };
+	name: string;
+	description?: string;
+	email: string;
+	domain?: string;
+	phone?: string;
+	// Property to store any additional data
+	meta?: {
+		legacy_token?: {
+			dev?: string;
+			staging?: string;
+			v1?: string;
+		};
+		website?: string;
+		reset_token?: string;
+		// Contact info
+		contact?: {
+			first_name?: string;
+			last_name?: string;
+			phone_number?: string;
+		};
+		[index: string]: any;
+	};
 }
 
 export interface Vendors {
-  vendors: Vendor[];
+	vendors: Vendor[];
 }
 
 export interface Key {
-  // key
-  id: string;
-  date_created?: string;
-  date_modified?: string;
-  // Unique client id for this key. Will remain same on rotation
-  client_id?: string;
-  // Unique password for this key.
-  client_password?: string;
-  // Date the key becomes expired
-  date_expires?: string;
-  environment?: "dev" | "staging" | "v1";
-  permissions?: string[];
-  // Flag identifying if the key is latest
-  active?: boolean;
-  domain?: string;
+	// key
+	id: string;
+	date_created?: string;
+	date_modified?: string;
+	// Unique client id for this key. Will remain same on rotation
+	client_id?: string;
+	// Unique password for this key.
+	client_password?: string;
+	// Date the key becomes expired
+	date_expires?: string;
+	environment?: 'dev' | 'staging' | 'v1';
+	permissions?: string[];
+	// Flag identifying if the key is latest
+	active?: boolean;
+	domain?: string;
 }
 
 export interface KeyPostBody {
-  // vendor
-  vendor_id: string;
-  // Date the key becomes expired
-  date_expires: string;
-  environment: "dev" | "staging" | "v1";
-  permissions: string[];
+	// vendor
+	vendor_id: string;
+	// Date the key becomes expired
+	date_expires: string;
+	environment: 'dev' | 'staging' | 'v1';
+	permissions: string[];
 }
 
 export interface KeyPatchBody {
-  // Date the key becomes expired
-  date_expires?: string;
-  permissions?: string[];
+	// Date the key becomes expired
+	date_expires?: string;
+	permissions?: string[];
 }
 
 export interface Keys {
-  last_evaluated_key?: string;
-  keys: Key[];
+	last_evaluated_key?: string;
+	keys: Key[];
 }
 
 export interface Success {
-  success?: boolean;
+	success?: boolean;
 }
 
 export interface Auth {
-  access: {
-    token?: string;
-    expires?: string;
-  };
-  refresh: {
-    token?: string;
-    expires?: string;
-  };
+	access: {
+		token?: string;
+		expires?: string;
+	};
+	refresh: {
+		token?: string;
+		expires?: string;
+	};
 }
 
 export interface RefreshPayload {
-  access_token: string;
-  refresh_token: string;
+	access_token: string;
+	refresh_token: string;
 }
 
 export interface ResetPassword {
-  reset_token: string;
-  password: string;
+	reset_token: string;
+	password: string;
 }
 
 // POST /vendor/application - Create a new application for review
@@ -205,29 +205,29 @@ export type PostVendorApplicationBody = ApplicationPostBody;
 export type PostVendorApplicationResponse = Application;
 
 export interface PostVendorApplicationRequest extends BaseRequest {
-  body: PostVendorApplicationBody;
+	body: PostVendorApplicationBody;
 }
 
 // GET /vendor/application - Get a list of all applications
 
 export interface GetVendorApplicationQuery {
-  status?: "pending" | "approved" | "rejected";
-  // Pagination token to start query from
-  last_evaluated_key?: string;
-  // Graphql query string
-  _query?: string;
+	status?: 'pending' | 'approved' | 'rejected';
+	// Pagination token to start query from
+	last_evaluated_key?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorApplicationResponse = Applications;
 
 export interface GetVendorApplicationRequest
-  extends BaseRequest,
-    RequestQuery<GetVendorApplicationQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetVendorApplicationQuery> {}
 
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
 export interface PatchVendorApplicationPath {
-  id: string;
+	id: string;
 }
 
 export type PatchVendorApplicationBody = ApplicationPatchBody;
@@ -235,7 +235,7 @@ export type PatchVendorApplicationBody = ApplicationPatchBody;
 export type PatchVendorApplicationResponse = Application;
 
 export interface PatchVendorApplicationRequest extends BaseRequest, PatchVendorApplicationPath {
-  body: PatchVendorApplicationBody;
+	body: PatchVendorApplicationBody;
 }
 
 // POST /vendor - Create new vendor
@@ -245,14 +245,14 @@ export type PostVendorBody = VendorPostBody;
 export type PostVendorResponse = Vendor;
 
 export interface PostVendorRequest extends BaseRequest {
-  body: PostVendorBody;
+	body: PostVendorBody;
 }
 
 // GET /vendor - Get all Vendors
 
 export interface GetVendorsQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorsResponse = Vendors;
@@ -262,27 +262,27 @@ export interface GetVendorsRequest extends BaseRequest, RequestQuery<GetVendorsQ
 // GET /vendor/{id} - Get info about the Vendor
 
 export interface GetVendorPath {
-  // vendor
-  id: string;
+	// vendor
+	id: string;
 }
 
 export interface GetVendorQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorResponse = Vendor;
 
 export interface GetVendorRequest
-  extends BaseRequest,
-    RequestQuery<GetVendorQuery>,
-    GetVendorPath {}
+	extends BaseRequest,
+		RequestQuery<GetVendorQuery>,
+		GetVendorPath {}
 
 // PATCH /vendor/{id} - Update info about the Vendor
 
 export interface PatchVendorPath {
-  // vendor
-  id: string;
+	// vendor
+	id: string;
 }
 
 export type PatchVendorBody = Vendor;
@@ -290,14 +290,14 @@ export type PatchVendorBody = Vendor;
 export type PatchVendorResponse = Vendor;
 
 export interface PatchVendorRequest extends BaseRequest, PatchVendorPath {
-  body: PatchVendorBody;
+	body: PatchVendorBody;
 }
 
 // GET /vendor/auth - Get access/refresh tokens for accessing our APIs
 
 export interface GetVendorAuthQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorAuthResponse = Auth;
@@ -311,33 +311,33 @@ export type PostVendorAuthBody = RefreshPayload;
 export type PostVendorAuthResponse = Auth;
 
 export interface PostVendorAuthRequest extends BaseRequest {
-  body: PostVendorAuthBody;
+	body: PostVendorAuthBody;
 }
 
 // GET /vendor/{id}/key - Get list of Vendor keys
 
 export interface GetVendorKeysPath {
-  // vendor
-  id: string;
+	// vendor
+	id: string;
 }
 
 export interface GetVendorKeysQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorKeysResponse = Keys;
 
 export interface GetVendorKeysRequest
-  extends BaseRequest,
-    RequestQuery<GetVendorKeysQuery>,
-    GetVendorKeysPath {}
+	extends BaseRequest,
+		RequestQuery<GetVendorKeysQuery>,
+		GetVendorKeysPath {}
 
 // POST /vendor/{id}/key - Create new key for the vendor
 
 export interface PostVendorKeyPath {
-  // vendor
-  id: string;
+	// vendor
+	id: string;
 }
 
 export type PostVendorKeyBody = KeyPostBody;
@@ -345,39 +345,39 @@ export type PostVendorKeyBody = KeyPostBody;
 export type PostVendorKeyResponse = Key;
 
 export interface PostVendorKeyRequest extends BaseRequest, PostVendorKeyPath {
-  body: PostVendorKeyBody;
+	body: PostVendorKeyBody;
 }
 
 // GET /vendor/{id}/key/{key} - Get info about vendor key
 
 export interface GetVendorKeyPath {
-  // vendor
-  id: string;
-  // key
-  key: string;
+	// vendor
+	id: string;
+	// key
+	key: string;
 }
 
 export interface GetVendorKeyQuery {
-  // Pagination token to start query from
-  last_evaluated_key?: string;
-  // Graphql query string
-  _query?: string;
+	// Pagination token to start query from
+	last_evaluated_key?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetVendorKeyResponse = Key;
 
 export interface GetVendorKeyRequest
-  extends BaseRequest,
-    RequestQuery<GetVendorKeyQuery>,
-    GetVendorKeyPath {}
+	extends BaseRequest,
+		RequestQuery<GetVendorKeyQuery>,
+		GetVendorKeyPath {}
 
 // PATCH /vendor/{id}/key/{key} - Update info for vendor key
 
 export interface PatchVendorKeyPath {
-  // vendor
-  id: string;
-  // key
-  key: string;
+	// vendor
+	id: string;
+	// key
+	key: string;
 }
 
 export type PatchVendorKeyBody = KeyPatchBody;
@@ -385,16 +385,16 @@ export type PatchVendorKeyBody = KeyPatchBody;
 export type PatchVendorKeyResponse = Key;
 
 export interface PatchVendorKeyRequest extends BaseRequest, PatchVendorKeyPath {
-  body: PatchVendorKeyBody;
+	body: PatchVendorKeyBody;
 }
 
 // DELETE /vendor/{id}/key/{key} - Mark key as expired
 
 export interface DeleteVendorKeyPath {
-  // vendor
-  id: string;
-  // key
-  key: string;
+	// vendor
+	id: string;
+	// key
+	key: string;
 }
 
 export type DeleteVendorKeyResponse = Key;
@@ -404,28 +404,28 @@ export interface DeleteVendorKeyRequest extends BaseRequest, DeleteVendorKeyPath
 // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
 
 export interface PostVendorKeyRotatePath {
-  // vendor
-  id: string;
-  // key
-  key: string;
+	// vendor
+	id: string;
+	// key
+	key: string;
 }
 
 export interface PostVendorKeyRotateQuery {
-  date_expires?: string;
+	date_expires?: string;
 }
 
 export type PostVendorKeyRotateResponse = Success;
 
 export interface PostVendorKeyRotateRequest
-  extends BaseRequest,
-    RequestQuery<PostVendorKeyRotateQuery>,
-    PostVendorKeyRotatePath {}
+	extends BaseRequest,
+		RequestQuery<PostVendorKeyRotateQuery>,
+		PostVendorKeyRotatePath {}
 
 // POST /vendor/{id}/reset/password - Reset the existing password for vendor
 
 export interface PostVendorResetPasswordPath {
-  // vendor
-  id: string;
+	// vendor
+	id: string;
 }
 
 export type PostVendorResetPasswordBody = ResetPassword;
@@ -433,5 +433,5 @@ export type PostVendorResetPasswordBody = ResetPassword;
 export type PostVendorResetPasswordResponse = Success;
 
 export interface PostVendorResetPasswordRequest extends BaseRequest, PostVendorResetPasswordPath {
-  body: PostVendorResetPasswordBody;
+	body: PostVendorResetPasswordBody;
 }