@dynamic-labs/sdk-api 0.30.0 → 0.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/apis/KybApi.cjs

@@ -516,6 +516,34 @@ class KybApi extends runtime.BaseAPI {
         const response = await this.uploadKybDocumentRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    async verifyKybOfficerConsentRaw(requestParameters, initOverrides) {
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+            throw new runtime.RequiredError('token', 'Required parameter requestParameters.token was null or undefined when calling verifyKybOfficerConsent.');
+        }
+        const queryParameters = {};
+        if (requestParameters.token !== undefined) {
+            queryParameters['token'] = requestParameters.token;
+        }
+        const headerParameters = {};
+        const response = await this.request({
+            path: `/kyb/officers/verify`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    async verifyKybOfficerConsent(requestParameters, initOverrides) {
+        await this.verifyKybOfficerConsentRaw(requestParameters, initOverrides);
+    }
 }
 
 exports.KybApi = KybApi;

package/src/apis/KybApi.d.ts

@@ -47,6 +47,9 @@ export interface UploadKybDocumentRequest {
     file: Blob;
     fileType?: string;
 }
+export interface VerifyKybOfficerConsentRequest {
+    token: string;
+}
 /**
  *
  */
@@ -125,4 +128,14 @@ export declare class KybApi extends runtime.BaseAPI {
      * Upload a single KYB business document
      */
     uploadKybDocument(requestParameters: UploadKybDocumentRequest, initOverrides?: RequestInit): Promise<KybDocumentUploadResponse>;
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    verifyKybOfficerConsentRaw(requestParameters: VerifyKybOfficerConsentRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    verifyKybOfficerConsent(requestParameters: VerifyKybOfficerConsentRequest, initOverrides?: RequestInit): Promise<void>;
 }

package/src/apis/KybApi.js

@@ -1,4 +1,4 @@
-import { BaseAPI, RequiredError, JSONApiResponse, canConsumeForm } from '../runtime.js';
+import { BaseAPI, RequiredError, JSONApiResponse, canConsumeForm, VoidApiResponse } from '../runtime.js';
 import '../models/AccessOutcomeEnum.js';
 import '../models/ExchangeKeyEnum.js';
 import '../models/AssignableBusinessAccountMemberRole.js';
@@ -512,6 +512,34 @@ class KybApi extends BaseAPI {
         const response = await this.uploadKybDocumentRaw(requestParameters, initOverrides);
         return await response.value();
     }
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    async verifyKybOfficerConsentRaw(requestParameters, initOverrides) {
+        if (requestParameters.token === null || requestParameters.token === undefined) {
+            throw new RequiredError('token', 'Required parameter requestParameters.token was null or undefined when calling verifyKybOfficerConsent.');
+        }
+        const queryParameters = {};
+        if (requestParameters.token !== undefined) {
+            queryParameters['token'] = requestParameters.token;
+        }
+        const headerParameters = {};
+        const response = await this.request({
+            path: `/kyb/officers/verify`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new VoidApiResponse(response);
+    }
+    /**
+     * Consumes the one-time token from an officer\'s invitation email and redirects to the vendor-hosted verification session.  Deliberately unauthenticated: the officer is not a Dynamic user, so the signed token in the link is the credential. It is single-use, expires with the vendor session, and its redirect target is restricted to the vendor\'s own hosts.
+     * Redirect a business officer to their identity verification session
+     */
+    async verifyKybOfficerConsent(requestParameters, initOverrides) {
+        await this.verifyKybOfficerConsentRaw(requestParameters, initOverrides);
+    }
 }
 
 export { KybApi };