diff --git a/.release.json b/.release.json index 79f3c57..9607969 100644 --- a/.release.json +++ b/.release.json @@ -1,9 +1,9 @@ { "source": { "repo_url": "https://github.com/onfido/onfido-openapi-spec", - "short_sha": "30c4d08", - "long_sha": "30c4d08a018e09bc02d87e6c04a137c371541163", - "version": "v5.6.0" + "short_sha": "90238b7", + "long_sha": "90238b7dbd5a07f2cbab2813dc8b6478ccd599b4", + "version": "v5.7.0" }, - "release": "v5.6.0" + "release": "v5.7.0" } diff --git a/api.ts b/api.ts index 900ad83..8a95682 100644 --- a/api.ts +++ b/api.ts @@ -7559,6 +7559,87 @@ export interface MotionCapturesList { */ 'motion_captures': Array; } +/** + * + * @export + * @interface Passkey + */ +export interface Passkey { + /** + * Passkey identifier. + * @type {string} + * @memberof Passkey + */ + 'id': string; + /** + * domain that the passkey is registered to, the rpId. + * @type {string} + * @memberof Passkey + */ + 'application_domain': string; + /** + * Current passkey state. + * @type {string} + * @memberof Passkey + */ + 'state': PasskeyStateEnum; + /** + * Timestamp when the passkey was created. + * @type {string} + * @memberof Passkey + */ + 'created_at': string; + /** + * Timestamp when the passkey was last used. + * @type {string} + * @memberof Passkey + */ + 'last_used_at'?: string; +} + +export const PasskeyStateEnum = { + Active: 'ACTIVE', + Inactive: 'INACTIVE', + UnknownDefaultOpenApi: '11184809' +} as const; + +export type PasskeyStateEnum = typeof PasskeyStateEnum[keyof typeof PasskeyStateEnum]; + +/** + * + * @export + * @interface PasskeyUpdater + */ +export interface PasskeyUpdater { + /** + * Desired passkey state value. + * @type {string} + * @memberof PasskeyUpdater + */ + 'state': PasskeyUpdaterStateEnum; +} + +export const PasskeyUpdaterStateEnum = { + Active: 'ACTIVE', + Inactive: 'INACTIVE', + UnknownDefaultOpenApi: '11184809' +} as const; + +export type PasskeyUpdaterStateEnum = typeof PasskeyUpdaterStateEnum[keyof typeof PasskeyUpdaterStateEnum]; + +/** + * + * @export + * @interface PasskeysList + */ +export interface PasskeysList { + /** + * + * @type {Array} + * @memberof PasskeysList + */ + 'passkeys': Array; +} /** * * @export @@ -8379,6 +8460,136 @@ export interface SdkTokenResponse { */ 'token': string; } +/** + * + * @export + * @interface SigningDocument + */ +export interface SigningDocument { + /** + * The ID of the applicant whose signing document is being uploaded. + * @type {string} + * @memberof SigningDocument + */ + 'applicant_id'?: string; + /** + * The unique identifier for the signing document + * @type {string} + * @memberof SigningDocument + */ + 'id': string; + /** + * The date and time at which the signing document was uploaded + * @type {string} + * @memberof SigningDocument + */ + 'created_at'?: string; + /** + * The uri of this resource + * @type {string} + * @memberof SigningDocument + */ + 'href'?: string; + /** + * The uri that can be used to download the signing document + * @type {string} + * @memberof SigningDocument + */ + 'download_href'?: string; + /** + * The file type of the uploaded file + * @type {string} + * @memberof SigningDocument + */ + 'file_type'?: string; + /** + * The name of the uploaded file + * @type {string} + * @memberof SigningDocument + */ + 'file_name'?: string; + /** + * The size of the file in bytes + * @type {number} + * @memberof SigningDocument + */ + 'file_size'?: number; +} +/** + * + * @export + * @interface SigningDocumentResponse + */ +export interface SigningDocumentResponse { + /** + * The unique identifier for the signing document + * @type {string} + * @memberof SigningDocumentResponse + */ + 'id': string; + /** + * The date and time at which the signing document was uploaded + * @type {string} + * @memberof SigningDocumentResponse + */ + 'created_at'?: string; + /** + * The uri of this resource + * @type {string} + * @memberof SigningDocumentResponse + */ + 'href'?: string; + /** + * The uri that can be used to download the signing document + * @type {string} + * @memberof SigningDocumentResponse + */ + 'download_href'?: string; + /** + * The file type of the uploaded file + * @type {string} + * @memberof SigningDocumentResponse + */ + 'file_type'?: string; + /** + * The name of the uploaded file + * @type {string} + * @memberof SigningDocumentResponse + */ + 'file_name'?: string; + /** + * The size of the file in bytes + * @type {number} + * @memberof SigningDocumentResponse + */ + 'file_size'?: number; +} +/** + * + * @export + * @interface SigningDocumentShared + */ +export interface SigningDocumentShared { + /** + * The ID of the applicant whose signing document is being uploaded. + * @type {string} + * @memberof SigningDocumentShared + */ + 'applicant_id'?: string; +} +/** + * + * @export + * @interface SigningDocumentsList + */ +export interface SigningDocumentsList { + /** + * + * @type {Array} + * @memberof SigningDocumentsList + */ + 'signing_documents': Array; +} /** * * @export @@ -11519,6 +11730,84 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Deletes a passkey. + * @summary Delete passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deletePasskey: async (username: string, passkeyId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists('deletePasskey', 'username', username) + // verify required parameter 'passkeyId' is not null or undefined + assertParamExists('deletePasskey', 'passkeyId', passkeyId) + const localVarPath = `/passkeys/{username}/{passkey_id}` + .replace(`{${"username"}}`, encodeURIComponent(String(username))) + .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Removes every passkey for the username. + * @summary Delete passkeys + * @param {string} username Username whose passkeys will be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deletePasskeys: async (username: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists('deletePasskeys', 'username', username) + const localVarPath = `/passkeys/{username}` + .replace(`{${"username"}}`, encodeURIComponent(String(username))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -12104,17 +12393,19 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Retrieves the signed evidence file for the designated Workflow Run - * @summary Retrieve Workflow Run Evidence Summary File - * @param {string} workflowRunId Workflow Run ID + * Retrieves the signed document or signing transaction receipt depending on the id provided. + * @summary Retrieves the signed document or signing transaction receipt + * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document. + * @param {string} id The unique identifier of the file which you want to retrieve. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - downloadSignedEvidenceFile: async (workflowRunId: string, options: RawAxiosRequestConfig = {}): Promise => { + downloadSesDocument: async (workflowRunId: string, id: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'workflowRunId' is not null or undefined - assertParamExists('downloadSignedEvidenceFile', 'workflowRunId', workflowRunId) - const localVarPath = `/workflow_runs/{workflow_run_id}/signed_evidence_file` - .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId))); + assertParamExists('downloadSesDocument', 'workflowRunId', workflowRunId) + // verify required parameter 'id' is not null or undefined + assertParamExists('downloadSesDocument', 'id', id) + const localVarPath = `/simple_electronic_signature/documents`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -12129,6 +12420,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication Token required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + if (workflowRunId !== undefined) { + localVarQueryParameter['workflow_run_id'] = workflowRunId; + } + + if (id !== undefined) { + localVarQueryParameter['id'] = id; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -12141,16 +12440,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Extract information from a document - * @summary Autofill - * @param {ExtractRequest} extractRequest + * Retrieves the signed evidence file for the designated Workflow Run + * @summary Retrieve Workflow Run Evidence Summary File + * @param {string} workflowRunId Workflow Run ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ - extract: async (extractRequest: ExtractRequest, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'extractRequest' is not null or undefined - assertParamExists('extract', 'extractRequest', extractRequest) - const localVarPath = `/extractions`; + downloadSignedEvidenceFile: async (workflowRunId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'workflowRunId' is not null or undefined + assertParamExists('downloadSignedEvidenceFile', 'workflowRunId', workflowRunId) + const localVarPath = `/workflow_runs/{workflow_run_id}/signed_evidence_file` + .replace(`{${"workflow_run_id"}}`, encodeURIComponent(String(workflowRunId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -12158,7 +12458,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -12167,12 +12467,9 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati - localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - localVarRequestOptions.data = serializeDataIfNeeded(extractRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), @@ -12180,16 +12477,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Search for addresses by postcode - * @summary Address Picker - * @param {string} postcode + * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. + * @summary Download signing document + * @param {string} signingDocumentId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - findAddresses: async (postcode: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'postcode' is not null or undefined - assertParamExists('findAddresses', 'postcode', postcode) - const localVarPath = `/addresses/pick`; + downloadSigningDocument: async (signingDocumentId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'signingDocumentId' is not null or undefined + assertParamExists('downloadSigningDocument', 'signingDocumentId', signingDocumentId) + const localVarPath = `/signing_documents/{signing_document_id}/download` + .replace(`{${"signing_document_id"}}`, encodeURIComponent(String(signingDocumentId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -12204,10 +12502,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication Token required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (postcode !== undefined) { - localVarQueryParameter['postcode'] = postcode; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -12220,11 +12514,90 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Retrieves a single applicant. Returns an applicant object. - * @summary Retrieve Applicant - * @param {string} applicantId - * @param {*} [options] Override http request option. - * @throws {RequiredError} + * Extract information from a document + * @summary Autofill + * @param {ExtractRequest} extractRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + extract: async (extractRequest: ExtractRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'extractRequest' is not null or undefined + assertParamExists('extract', 'extractRequest', extractRequest) + const localVarPath = `/extractions`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(extractRequest, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Search for addresses by postcode + * @summary Address Picker + * @param {string} postcode + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + findAddresses: async (postcode: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'postcode' is not null or undefined + assertParamExists('findAddresses', 'postcode', postcode) + const localVarPath = `/addresses/pick`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (postcode !== undefined) { + localVarQueryParameter['postcode'] = postcode; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Retrieves a single applicant. Returns an applicant object. + * @summary Retrieve Applicant + * @param {string} applicantId + * @param {*} [options] Override http request option. + * @throws {RequiredError} */ findApplicant: async (applicantId: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'applicantId' is not null or undefined @@ -12506,6 +12879,47 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns a passkey\'s details. + * @summary Retrieve passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + findPasskey: async (username: string, passkeyId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists('findPasskey', 'username', username) + // verify required parameter 'passkeyId' is not null or undefined + assertParamExists('findPasskey', 'passkeyId', passkeyId) + const localVarPath = `/passkeys/{username}/{passkey_id}` + .replace(`{${"username"}}`, encodeURIComponent(String(username))) + .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -12543,6 +12957,43 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier. + * @summary Retrieve signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + findSigningDocument: async (signingDocumentId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'signingDocumentId' is not null or undefined + assertParamExists('findSigningDocument', 'signingDocumentId', signingDocumentId) + const localVarPath = `/signing_documents/{signing_document_id}` + .replace(`{${"signing_document_id"}}`, encodeURIComponent(String(signingDocumentId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -13100,6 +13551,43 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Returns every passkey registered under the supplied username. + * @summary List passkeys + * @param {string} username Username that owns the passkeys. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listPasskeys: async (username: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists('listPasskeys', 'username', username) + const localVarPath = `/passkeys/{username}` + .replace(`{${"username"}}`, encodeURIComponent(String(username))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -13177,6 +13665,46 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * All signing documents belonging to an applicant can be listed from this endpoint + * @summary List signing documents + * @param {string} applicantId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listSigningDocuments: async (applicantId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'applicantId' is not null or undefined + assertParamExists('listSigningDocuments', 'applicantId', applicantId) + const localVarPath = `/signing_documents`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + if (applicantId !== undefined) { + localVarQueryParameter['applicant_id'] = applicantId; + } + + + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; @@ -13670,6 +14198,53 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + /** + * Updates a passkey\'s state. + * @summary Update passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {PasskeyUpdater} passkeyUpdater Passkey update payload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePasskey: async (username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'username' is not null or undefined + assertParamExists('updatePasskey', 'username', username) + // verify required parameter 'passkeyId' is not null or undefined + assertParamExists('updatePasskey', 'passkeyId', passkeyId) + // verify required parameter 'passkeyUpdater' is not null or undefined + assertParamExists('updatePasskey', 'passkeyUpdater', passkeyUpdater) + const localVarPath = `/passkeys/{username}/{passkey_id}` + .replace(`{${"username"}}`, encodeURIComponent(String(username))) + .replace(`{${"passkey_id"}}`, encodeURIComponent(String(passkeyId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = serializeDataIfNeeded(passkeyUpdater, localVarRequestOptions, configuration) + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Update the status of the given matches * @summary Set match status (BETA) @@ -13926,6 +14501,57 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati } + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + localVarRequestOptions.data = localVarFormParams; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. + * @summary Upload a signing document + * @param {string} applicantId The ID of the applicant whose signing document is being uploaded. + * @param {FileTransfer} file The file to be uploaded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + uploadSigningDocument: async (applicantId: string, file: FileTransfer, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'applicantId' is not null or undefined + assertParamExists('uploadSigningDocument', 'applicantId', applicantId) + // verify required parameter 'file' is not null or undefined + assertParamExists('uploadSigningDocument', 'file', file) + const localVarPath = `/signing_documents`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + // authentication Token required + await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) + + + if (applicantId !== undefined) { + localVarFormParams.append('applicant_id', applicantId as any); + } + + if (file !== undefined) { + localVarFormParams.append('file', file.buffer as any, file.filename); + } + + localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -14067,6 +14693,33 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.deleteApplicant']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Deletes a passkey. + * @summary Delete passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasskey(username, passkeyId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.deletePasskey']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Removes every passkey for the username. + * @summary Delete passkeys + * @param {string} username Username whose passkeys will be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deletePasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deletePasskeys(username, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.deletePasskeys']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Deactivates the given monitor * @summary Delete monitor @@ -14264,6 +14917,20 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadQesDocument']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Retrieves the signed document or signing transaction receipt depending on the id provided. + * @summary Retrieves the signed document or signing transaction receipt + * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document. + * @param {string} id The unique identifier of the file which you want to retrieve. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.downloadSesDocument(workflowRunId, id, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadSesDocument']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Retrieves the signed evidence file for the designated Workflow Run * @summary Retrieve Workflow Run Evidence Summary File @@ -14277,6 +14944,19 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadSignedEvidenceFile']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. + * @summary Download signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.downloadSigningDocument(signingDocumentId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadSigningDocument']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Extract information from a document * @summary Autofill @@ -14407,6 +15087,20 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.findMotionCapture']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Returns a passkey\'s details. + * @summary Retrieve passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.findPasskey(username, passkeyId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.findPasskey']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * A single report can be retrieved using this endpoint with the corresponding unique identifier. * @summary Retrieve report @@ -14420,6 +15114,19 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.findReport']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier. + * @summary Retrieve signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.findSigningDocument(signingDocumentId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.findSigningDocument']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. * @summary Retrieve Task @@ -14606,6 +15313,19 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.listMotionCaptures']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Returns every passkey registered under the supplied username. + * @summary List passkeys + * @param {string} username Username that owns the passkeys. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listPasskeys(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listPasskeys(username, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.listPasskeys']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Returns all repeat attempts for a given Document report * @summary Retrieve repeat attempts @@ -14632,6 +15352,19 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.listReports']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * All signing documents belonging to an applicant can be listed from this endpoint + * @summary List signing documents + * @param {string} applicantId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listSigningDocuments(applicantId, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.listSigningDocuments']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. * @summary List Tasks @@ -14793,6 +15526,21 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.updateApplicant']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Updates a passkey\'s state. + * @summary Update passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {PasskeyUpdater} passkeyUpdater Passkey update payload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updatePasskey(username, passkeyId, passkeyUpdater, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.updatePasskey']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Update the status of the given matches * @summary Set match status (BETA) @@ -14870,6 +15618,20 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.uploadLivePhoto']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. + * @summary Upload a signing document + * @param {string} applicantId The ID of the applicant whose signing document is being uploaded. + * @param {FileTransfer} file The file to be uploaded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.uploadSigningDocument(applicantId, file, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.uploadSigningDocument']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, } }; @@ -14972,6 +15734,27 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa deleteApplicant(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteApplicant(applicantId, options).then((request) => request(axios, basePath)); }, + /** + * Deletes a passkey. + * @summary Delete passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deletePasskey(username, passkeyId, options).then((request) => request(axios, basePath)); + }, + /** + * Removes every passkey for the username. + * @summary Delete passkeys + * @param {string} username Username whose passkeys will be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deletePasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deletePasskeys(username, options).then((request) => request(axios, basePath)); + }, /** * Deactivates the given monitor * @summary Delete monitor @@ -15124,6 +15907,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath)); }, + /** + * Retrieves the signed document or signing transaction receipt depending on the id provided. + * @summary Retrieves the signed document or signing transaction receipt + * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document. + * @param {string} id The unique identifier of the file which you want to retrieve. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.downloadSesDocument(workflowRunId, id, options).then((request) => request(axios, basePath)); + }, /** * Retrieves the signed evidence file for the designated Workflow Run * @summary Retrieve Workflow Run Evidence Summary File @@ -15134,6 +15928,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa downloadSignedEvidenceFile(workflowRunId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.downloadSignedEvidenceFile(workflowRunId, options).then((request) => request(axios, basePath)); }, + /** + * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. + * @summary Download signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.downloadSigningDocument(signingDocumentId, options).then((request) => request(axios, basePath)); + }, /** * Extract information from a document * @summary Autofill @@ -15234,6 +16038,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa findMotionCapture(motionCaptureId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.findMotionCapture(motionCaptureId, options).then((request) => request(axios, basePath)); }, + /** + * Returns a passkey\'s details. + * @summary Retrieve passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.findPasskey(username, passkeyId, options).then((request) => request(axios, basePath)); + }, /** * A single report can be retrieved using this endpoint with the corresponding unique identifier. * @summary Retrieve report @@ -15244,6 +16059,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa findReport(reportId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.findReport(reportId, options).then((request) => request(axios, basePath)); }, + /** + * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier. + * @summary Retrieve signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.findSigningDocument(signingDocumentId, options).then((request) => request(axios, basePath)); + }, /** * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. * @summary Retrieve Task @@ -15388,6 +16213,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa listMotionCaptures(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.listMotionCaptures(applicantId, options).then((request) => request(axios, basePath)); }, + /** + * Returns every passkey registered under the supplied username. + * @summary List passkeys + * @param {string} username Username that owns the passkeys. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listPasskeys(username: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listPasskeys(username, options).then((request) => request(axios, basePath)); + }, /** * Returns all repeat attempts for a given Document report * @summary Retrieve repeat attempts @@ -15408,6 +16243,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa listReports(checkId: string, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.listReports(checkId, options).then((request) => request(axios, basePath)); }, + /** + * All signing documents belonging to an applicant can be listed from this endpoint + * @summary List signing documents + * @param {string} applicantId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listSigningDocuments(applicantId, options).then((request) => request(axios, basePath)); + }, /** * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. * @summary List Tasks @@ -15533,6 +16378,18 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa updateApplicant(applicantId: string, applicantUpdater: ApplicantUpdater, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateApplicant(applicantId, applicantUpdater, options).then((request) => request(axios, basePath)); }, + /** + * Updates a passkey\'s state. + * @summary Update passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {PasskeyUpdater} passkeyUpdater Passkey update payload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updatePasskey(username, passkeyId, passkeyUpdater, options).then((request) => request(axios, basePath)); + }, /** * Update the status of the given matches * @summary Set match status (BETA) @@ -15595,6 +16452,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.uploadLivePhoto(applicantId, file, advancedValidation, options).then((request) => request(axios, basePath)); }, + /** + * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. + * @summary Upload a signing document + * @param {string} applicantId The ID of the applicant whose signing document is being uploaded. + * @param {FileTransfer} file The file to be uploaded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.uploadSigningDocument(applicantId, file, options).then((request) => request(axios, basePath)); + }, }; }; @@ -15715,6 +16583,31 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).deleteApplicant(applicantId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Deletes a passkey. + * @summary Delete passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public deletePasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).deletePasskey(username, passkeyId, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Removes every passkey for the username. + * @summary Delete passkeys + * @param {string} username Username whose passkeys will be deleted. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public deletePasskeys(username: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).deletePasskeys(username, options).then((request) => request(this.axios, this.basePath)); + } + /** * Deactivates the given monitor * @summary Delete monitor @@ -15897,6 +16790,19 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Retrieves the signed document or signing transaction receipt depending on the id provided. + * @summary Retrieves the signed document or signing transaction receipt + * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document. + * @param {string} id The unique identifier of the file which you want to retrieve. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public downloadSesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).downloadSesDocument(workflowRunId, id, options).then((request) => request(this.axios, this.basePath)); + } + /** * Retrieves the signed evidence file for the designated Workflow Run * @summary Retrieve Workflow Run Evidence Summary File @@ -15909,6 +16815,18 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).downloadSignedEvidenceFile(workflowRunId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Downloads specific signing documents belonging to an applicant. If successful, the response will be the binary data representing the pdf. + * @summary Download signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public downloadSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).downloadSigningDocument(signingDocumentId, options).then((request) => request(this.axios, this.basePath)); + } + /** * Extract information from a document * @summary Autofill @@ -16029,6 +16947,19 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).findMotionCapture(motionCaptureId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Returns a passkey\'s details. + * @summary Retrieve passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public findPasskey(username: string, passkeyId: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).findPasskey(username, passkeyId, options).then((request) => request(this.axios, this.basePath)); + } + /** * A single report can be retrieved using this endpoint with the corresponding unique identifier. * @summary Retrieve report @@ -16041,6 +16972,18 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).findReport(reportId, options).then((request) => request(this.axios, this.basePath)); } + /** + * A single signing document can be retrieved by calling this endpoint with the signing document\'s unique identifier. + * @summary Retrieve signing document + * @param {string} signingDocumentId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public findSigningDocument(signingDocumentId: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).findSigningDocument(signingDocumentId, options).then((request) => request(this.axios, this.basePath)); + } + /** * A single task can be retrieved by calling this endpoint with the unique identifier of the Task and Workflow Run. * @summary Retrieve Task @@ -16213,6 +17156,18 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).listMotionCaptures(applicantId, options).then((request) => request(this.axios, this.basePath)); } + /** + * Returns every passkey registered under the supplied username. + * @summary List passkeys + * @param {string} username Username that owns the passkeys. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public listPasskeys(username: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).listPasskeys(username, options).then((request) => request(this.axios, this.basePath)); + } + /** * Returns all repeat attempts for a given Document report * @summary Retrieve repeat attempts @@ -16237,6 +17192,18 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).listReports(checkId, options).then((request) => request(this.axios, this.basePath)); } + /** + * All signing documents belonging to an applicant can be listed from this endpoint + * @summary List signing documents + * @param {string} applicantId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public listSigningDocuments(applicantId: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).listSigningDocuments(applicantId, options).then((request) => request(this.axios, this.basePath)); + } + /** * The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. * @summary List Tasks @@ -16386,6 +17353,20 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).updateApplicant(applicantId, applicantUpdater, options).then((request) => request(this.axios, this.basePath)); } + /** + * Updates a passkey\'s state. + * @summary Update passkey + * @param {string} username Username that owns the passkey. + * @param {string} passkeyId Passkey ID. + * @param {PasskeyUpdater} passkeyUpdater Passkey update payload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public updatePasskey(username: string, passkeyId: string, passkeyUpdater: PasskeyUpdater, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).updatePasskey(username, passkeyId, passkeyUpdater, options).then((request) => request(this.axios, this.basePath)); + } + /** * Update the status of the given matches * @summary Set match status (BETA) @@ -16457,6 +17438,19 @@ export class DefaultApi extends BaseAPI { public uploadLivePhoto(applicantId?: string, file?: FileTransfer, advancedValidation?: boolean, options?: RawAxiosRequestConfig) { return DefaultApiFp(this.configuration).uploadLivePhoto(applicantId, file, advancedValidation, options).then((request) => request(this.axios, this.basePath)); } + + /** + * Signing documents are uploaded using this endpoint. Signing documents must be uploaded as a multipart form. The only valid file type is pdf. The file size must be between 2KB and 3MB. + * @summary Upload a signing document + * @param {string} applicantId The ID of the applicant whose signing document is being uploaded. + * @param {FileTransfer} file The file to be uploaded. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public uploadSigningDocument(applicantId: string, file: FileTransfer, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).uploadSigningDocument(applicantId, file, options).then((request) => request(this.axios, this.basePath)); + } } /** diff --git a/configuration.ts b/configuration.ts index 6afd5da..de05bb3 100644 --- a/configuration.ts +++ b/configuration.ts @@ -101,7 +101,7 @@ export class Configuration { this.baseOptions = {...{ timeout: 30_000 }, ...param.baseOptions, headers: {...param.baseOptions?.headers, - 'User-Agent': "onfido-node/5.6.0" + 'User-Agent': "onfido-node/5.7.0" }, }; this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed) diff --git a/package-lock.json b/package-lock.json index 8d8ddc7..e50ae52 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@onfido/api", - "version": "5.6.0", + "version": "5.7.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@onfido/api", - "version": "5.6.0", + "version": "5.7.0", "license": "MIT", "dependencies": { "axios": "^1.7.4" @@ -1381,9 +1381,9 @@ } }, "node_modules/baseline-browser-mapping": { - "version": "2.9.14", - "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.9.14.tgz", - "integrity": "sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg==", + "version": "2.9.17", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.9.17.tgz", + "integrity": "sha512-agD0MgJFUP/4nvjqzIB29zRPUuCF7Ge6mEv9s8dHrtYD7QWXRcx75rOADE/d5ah1NI+0vkDl0yorDd5U852IQQ==", "dev": true, "license": "Apache-2.0", "bin": { @@ -1540,9 +1540,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001764", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001764.tgz", - "integrity": "sha512-9JGuzl2M+vPL+pz70gtMF9sHdMFbY9FJaQBi186cHKH3pSzDvzoUJUPV6fqiKIMyXbud9ZLg4F3Yza1vJ1+93g==", + "version": "1.0.30001766", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001766.tgz", + "integrity": "sha512-4C0lfJ0/YPjJQHagaE9x2Elb69CIqEPZeG0anQt9SIvIoOH4a4uaRl73IavyO+0qZh6MDLH//DrXThEYKHkmYA==", "dev": true, "funding": [ { @@ -1974,9 +1974,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.267", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.267.tgz", - "integrity": "sha512-0Drusm6MVRXSOJpGbaSVgcQsuB4hEkMpHXaVstcPmhu5LIedxs1xNK/nIxmQIU/RPC0+1/o0AVZfBTkTNJOdUw==", + "version": "1.5.277", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.277.tgz", + "integrity": "sha512-wKXFZw4erWmmOz5N/grBoJ2XrNJGDFMu2+W5ACHza5rHtvsqrK4gb6rnLC7XxKB9WlJ+RmyQatuEXmtm86xbnw==", "dev": true, "license": "ISC" }, @@ -3936,9 +3936,9 @@ } }, "node_modules/lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", "dev": true, "license": "MIT" }, diff --git a/package.json b/package.json index 9c5fd99..4731c06 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@onfido/api", - "version": "5.6.0", + "version": "5.7.0", "description": "Node.js library for the Onfido API", "author": "OpenAPI-Generator Contributors", "repository": {