@compassdigital/sdk.typescript 3.10.0 → 3.11.0

package/src/interface/vendor.ts

@@ -5,6 +5,76 @@ export interface Error {
   code?: number;
 }
 
+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;
+}
+
+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?: string;
+}
+
+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?: string;
+}
+
+export interface Applications {
+  last_evaluated_key?: string;
+  applications: Application[];
+}
+
 export interface Vendor {
   // vendor
   id?: string;
@@ -19,6 +89,14 @@ export interface Vendor {
       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;
@@ -30,6 +108,23 @@ export interface VendorPostBody {
   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 {
@@ -70,6 +165,7 @@ export interface KeyPatchBody {
 }
 
 export interface Keys {
+  last_evaluated_key?: string;
   keys: Key[];
 }
 
@@ -93,6 +189,48 @@ export interface RefreshPayload {
   refresh_token: string;
 }
 
+export interface ResetPassword {
+  reset_token: string;
+  password: string;
+}
+
+// POST /vendor/application - Create a new application for review
+
+export type PostVendorApplicationBody = ApplicationPostBody;
+
+export type PostVendorApplicationResponse = Application;
+
+export interface PostVendorApplicationRequest {
+  body: PostVendorApplicationBody;
+}
+
+// GET /vendor/application - Get a list of all applications
+
+export interface GetVendorApplicationQuery {
+  status?: string;
+  // Pagination token to start query from
+  last_evaluated_key?: string;
+}
+
+export type GetVendorApplicationResponse = Applications;
+
+export interface GetVendorApplicationRequest extends GetVendorApplicationQuery {}
+
+// PATCH /vendor/application/{id} - Update an application (or update status)
+
+export interface PatchVendorApplicationPath {
+  // TODO: add parameter to swagger.json
+  id: string;
+}
+
+export type PatchVendorApplicationBody = ApplicationPatchBody;
+
+export type PatchVendorApplicationResponse = Application;
+
+export interface PatchVendorApplicationRequest extends PatchVendorApplicationPath {
+  body: PatchVendorApplicationBody;
+}
+
 // POST /vendor - Create new vendor
 
 export type PostVendorBody = VendorPostBody;
@@ -243,3 +381,18 @@ export type PostVendorKeyRotateResponse = Success;
 export interface PostVendorKeyRotateRequest
   extends PostVendorKeyRotateQuery,
     PostVendorKeyRotatePath {}
+
+// POST /vendor/{id}/reset/password - Reset the existing password for vendor
+
+export interface PostVendorResetPasswordPath {
+  // vendor
+  id: string;
+}
+
+export type PostVendorResetPasswordBody = ResetPassword;
+
+export type PostVendorResetPasswordResponse = Success;
+
+export interface PostVendorResetPasswordRequest extends PostVendorResetPasswordPath {
+  body: PostVendorResetPasswordBody;
+}