@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/VerificationProfilesApi.md

@@ -0,0 +1,339 @@
+# VerificationProfilesApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createVerificationProfile**](VerificationProfilesApi.md#createverificationprofile) | **POST** /api/valpha/verification-profiles | Create Verification Profile |
+| [**getVerificationProfileByExternalId**](VerificationProfilesApi.md#getverificationprofilebyexternalid) | **GET** /api/valpha/verification-profiles/external-ids/{externalId} | Get Verification Profile by External ID |
+| [**getVerificationProfileById**](VerificationProfilesApi.md#getverificationprofilebyid) | **GET** /api/valpha/verification-profiles/{id} | Get Verification Profile |
+| [**listVerificationProfiles**](VerificationProfilesApi.md#listverificationprofiles) | **GET** /api/valpha/verification-profiles | List Verification Profiles |
+
+
+
+## createVerificationProfile
+
+> CreateVerificationProfileResponse createVerificationProfile(alias, brandName, primaryColor, externalId, providers, logo, redactionPeriod, sessionExpiration, isProductionUsage)
+
+Create Verification Profile
+
+Creates a new verification profile within your organization.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VerificationProfilesApi,
+} from '@trinsic/api';
+import type { CreateVerificationProfileRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VerificationProfilesApi(config);
+
+  const body = {
+    // string | An alias of the verification profile shown to developers and administrators.
+    alias: alias_example,
+    // string | The brand name of the verification profile shown to end-users.
+    brandName: brandName_example,
+    // string | The primary color of the verification profile. Must be a 6-character hex string prefixed with a \\\'#\\\' character. Example: #000000 (optional)
+    primaryColor: primaryColor_example,
+    // string | A customer-defined external ID for this verification profile. Must be unique within your organization and be at most 255 characters long. (optional)
+    externalId: externalId_example,
+    // Array<string> | The list of providers you\\\'d like to select for this profile. We will not currently enable any providers. (optional)
+    providers: ...,
+    // Blob | The logo of the verification profile. (optional)
+    logo: BINARY_DATA_HERE,
+    // string | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days. (optional)
+    redactionPeriod: redactionPeriod_example,
+    // string | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified. (optional)
+    sessionExpiration: sessionExpiration_example,
+    // boolean | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo). (optional)
+    isProductionUsage: true,
+  } satisfies CreateVerificationProfileRequest;
+
+  try {
+    const data = await api.createVerificationProfile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **alias** | `string` | An alias of the verification profile shown to developers and administrators. | [Defaults to `undefined`] |
+| **brandName** | `string` | The brand name of the verification profile shown to end-users. | [Defaults to `undefined`] |
+| **primaryColor** | `string` | The primary color of the verification profile. Must be a 6-character hex string prefixed with a \\\&#39;#\\\&#39; character. Example: #000000 | [Optional] [Defaults to `undefined`] |
+| **externalId** | `string` | A customer-defined external ID for this verification profile. Must be unique within your organization and be at most 255 characters long. | [Optional] [Defaults to `undefined`] |
+| **providers** | `Array<string>` | The list of providers you\\\&#39;d like to select for this profile. We will not currently enable any providers. | [Optional] |
+| **logo** | `Blob` | The logo of the verification profile. | [Optional] [Defaults to `undefined`] |
+| **redactionPeriod** | `string` | The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days. | [Optional] [Defaults to `undefined`] |
+| **sessionExpiration** | `string` | The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified. | [Optional] [Defaults to `undefined`] |
+| **isProductionUsage** | `boolean` | Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo). | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**CreateVerificationProfileResponse**](CreateVerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getVerificationProfileByExternalId
+
+> VerificationProfileResponse getVerificationProfileByExternalId(externalId)
+
+Get Verification Profile by External ID
+
+Gets a specific verification profile by its customer-defined external ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VerificationProfilesApi,
+} from '@trinsic/api';
+import type { GetVerificationProfileByExternalIdRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VerificationProfilesApi(config);
+
+  const body = {
+    // string | Customer-defined external ID
+    externalId: externalId_example,
+  } satisfies GetVerificationProfileByExternalIdRequest;
+
+  try {
+    const data = await api.getVerificationProfileByExternalId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **externalId** | `string` | Customer-defined external ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**VerificationProfileResponse**](VerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getVerificationProfileById
+
+> VerificationProfileResponse getVerificationProfileById(id)
+
+Get Verification Profile
+
+Gets a specific verification profile by ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VerificationProfilesApi,
+} from '@trinsic/api';
+import type { GetVerificationProfileByIdRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VerificationProfilesApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetVerificationProfileByIdRequest;
+
+  try {
+    const data = await api.getVerificationProfileById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**VerificationProfileResponse**](VerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listVerificationProfiles
+
+> ListVerificationProfilesResponse listVerificationProfiles(page, pageSize)
+
+List Verification Profiles
+
+List the verification profiles for the current organization and environment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VerificationProfilesApi,
+} from '@trinsic/api';
+import type { ListVerificationProfilesRequest } from '@trinsic/api';
+
+async function example() {
+  console.log("🚀 Testing @trinsic/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Bearer
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new VerificationProfilesApi(config);
+
+  const body = {
+    // number |  (optional)
+    page: 56,
+    // number | Size of the list to be returned. Accepted range from 1 to 100 (optional)
+    pageSize: 56,
+  } satisfies ListVerificationProfilesRequest;
+
+  try {
+    const data = await api.listVerificationProfiles(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Size of the list to be returned. Accepted range from 1 to 100 | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**ListVerificationProfilesResponse**](ListVerificationProfilesResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`, `text/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Bad request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **500** | Internal server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/YotiDeeplinkProviderOutput.md

@@ -0,0 +1,57 @@
+
+# YotiDeeplinkProviderOutput
+
+Exposed properties for the `yoti-deeplink` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rememberMeId` | string
+`email` | string
+`givenName` | string
+`familyName` | string
+`fullName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationality` | string
+`mobileNumber` | string
+`structuredPostalAddress` | [YotiStructuredPostalAddress](YotiStructuredPostalAddress.md)
+`postalAddress` | string
+`documentDetails` | [YotiDocumentDetails](YotiDocumentDetails.md)
+
+## Example
+
+```typescript
+import type { YotiDeeplinkProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rememberMeId": 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  "email": johndoe@example.com,
+  "givenName": John Alvin,
+  "familyName": Doe,
+  "fullName": John Alvin Doe,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "gender": MALE,
+  "nationality": GBR,
+  "mobileNumber": +447777123456,
+  "structuredPostalAddress": null,
+  "postalAddress": 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  "documentDetails": null,
+} satisfies YotiDeeplinkProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as YotiDeeplinkProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/YotiDocumentDetails.md

@@ -0,0 +1,42 @@
+
+# YotiDocumentDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`issuingCountry` | string
+`documentNumber` | string
+`expirationDate` | Date
+`issuingAuthority` | string
+
+## Example
+
+```typescript
+import type { YotiDocumentDetails } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": PASSPORT,
+  "issuingCountry": GBR,
+  "documentNumber": 123456789,
+  "expirationDate": Mon Mar 21 00:00:00 UTC 2016,
+  "issuingAuthority": GBR,
+} satisfies YotiDocumentDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as YotiDocumentDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/YotiProviderOutput.md

@@ -0,0 +1,57 @@
+
+# YotiProviderOutput
+
+Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rememberMeId` | string
+`email` | string
+`givenName` | string
+`familyName` | string
+`fullName` | string
+`dateOfBirth` | Date
+`gender` | string
+`nationality` | string
+`mobileNumber` | string
+`structuredPostalAddress` | [YotiStructuredPostalAddress](YotiStructuredPostalAddress.md)
+`postalAddress` | string
+`documentDetails` | [YotiDocumentDetails](YotiDocumentDetails.md)
+
+## Example
+
+```typescript
+import type { YotiProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rememberMeId": 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  "email": johndoe@example.com,
+  "givenName": John Alvin,
+  "familyName": Doe,
+  "fullName": John Alvin Doe,
+  "dateOfBirth": Thu Jan 31 00:00:00 UTC 1985,
+  "gender": MALE,
+  "nationality": GBR,
+  "mobileNumber": +447777123456,
+  "structuredPostalAddress": null,
+  "postalAddress": 6th Floor, 107 Leadenhall St, London, EC3A 4AF,
+  "documentDetails": null,
+} satisfies YotiProviderOutput
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as YotiProviderOutput
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/YotiStructuredPostalAddress.md

@@ -0,0 +1,72 @@
+
+# YotiStructuredPostalAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`country` | string
+`countryIso` | string
+`formattedAddress` | string
+`line1` | string
+`line2` | string
+`line3` | string
+`line4` | string
+`townCity` | string
+`state` | string
+`postalCode` | string
+`buildingNumber` | string
+`building` | string
+`subBuilding` | string
+`locality` | string
+`deliveryPointReferenceNumber` | string
+`landmark` | string
+`subdistrict` | string
+`district` | string
+`postOffice` | string
+`careOf` | string
+
+## Example
+
+```typescript
+import type { YotiStructuredPostalAddress } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "country": UK,
+  "countryIso": USA,
+  "formattedAddress": 15a North Street\nCARSHALTON\nSM5 2HW\nUK,
+  "line1": 15a North Street,
+  "line2": 15a North Street,
+  "line3": 15a North Street,
+  "line4": 15a North Street,
+  "townCity": Los Angeles,
+  "state": CA,
+  "postalCode": SM5 2HW,
+  "buildingNumber": 15a,
+  "building": House No.86-A,
+  "subBuilding": Apt 4B,
+  "locality": FRAMINGHAM PIGOT,
+  "deliveryPointReferenceNumber": 23747208,
+  "landmark": Behind Bank XYZ,
+  "subdistrict": Ludhiana,
+  "district": Ludhiana,
+  "postOffice": Rajguru Nagar,
+  "careOf": Jane Doe,
+} satisfies YotiStructuredPostalAddress
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as YotiStructuredPostalAddress
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ZimbabweNidLookup2Input.md

@@ -0,0 +1,34 @@
+
+# ZimbabweNidLookup2Input
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idNumber` | string
+
+## Example
+
+```typescript
+import type { ZimbabweNidLookup2Input } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idNumber": null,
+} satisfies ZimbabweNidLookup2Input
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZimbabweNidLookup2Input
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trinsic/api",
-  "version": "3.0.1",
+  "version": "3.1.0-preview1",
   "description": "Trinsic API TypeScript library.",
   "author": "Trinsic",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "https://github.com/trinsic-id/sdk"
   },
   "main": "./dist/index.js",
-  "typings": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "module": "./dist/esm/index.js",
   "sideEffects": false,
   "scripts": {