@trinsic/api 3.0.1 → 3.1.0-preview1

package/docs/ProvidersApi.md

@@ -0,0 +1,160 @@
+# ProvidersApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getProvider**](ProvidersApi.md#getprovider) | **GET** /api/v1/providers/{providerId} | Get Provider |
+| [**listProviders**](ProvidersApi.md#listproviders) | **GET** /api/v1/providers | List Providers |
+
+
+
+## getProvider
+
+> GetProviderResponse getProvider(providerId)
+
+Get Provider
+
+Get a single identity provider by ID, including its license status.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProvidersApi,
+} from '@trinsic/api';
+import type { GetProviderRequest } 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 ProvidersApi(config);
+
+  const body = {
+    // string | The ID of the provider to retrieve
+    providerId: providerId_example,
+  } satisfies GetProviderRequest;
+
+  try {
+    const data = await api.getProvider(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **providerId** | `string` | The ID of the provider to retrieve | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetProviderResponse**](GetProviderResponse.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)
+
+
+## listProviders
+
+> ListProvidersResponse listProviders(licensed)
+
+List Providers
+
+List all identity providers available to your Organization, including their license status.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ProvidersApi,
+} from '@trinsic/api';
+import type { ListProvidersRequest } 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 ProvidersApi(config);
+
+  const body = {
+    // boolean | Filter by license status. If not specified, returns all providers. (optional)
+    licensed: true,
+  } satisfies ListProvidersRequest;
+
+  try {
+    const data = await api.listProviders(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **licensed** | `boolean` | Filter by license status. If not specified, returns all providers. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListProvidersResponse**](ListProvidersResponse.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/Raw18013DocumentRequest.md

@@ -0,0 +1,36 @@
+
+# Raw18013DocumentRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentType` | string
+`nameSpaces` | { [key: string]: { [key: string]: boolean; }; }
+
+## Example
+
+```typescript
+import type { Raw18013DocumentRequest } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentType": org.iso.18013.5.1.mDL,
+  "nameSpaces": {"org.iso.18013.5.1":{"given_name":true,"family_name":true,"portrait":false},"org.iso.18013.5.1.aamva":{"name_suffix":true}},
+} satisfies Raw18013DocumentRequest
+
+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 Raw18013DocumentRequest
+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/Raw18013RequestInput.md

@@ -0,0 +1,35 @@
+
+# Raw18013RequestInput
+
+A raw 18013-7 exchange request.              Use this to specify a raw 18013-7 exchange against an arbitrary document type, namespace, and set of fields.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentRequests` | [Array<Raw18013DocumentRequest>](Raw18013DocumentRequest.md)
+
+## Example
+
+```typescript
+import type { Raw18013RequestInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentRequests": null,
+} satisfies Raw18013RequestInput
+
+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 Raw18013RequestInput
+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/RecommendProviderHealthOption.md

@@ -0,0 +1,32 @@
+
+# RecommendProviderHealthOption
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RecommendProviderHealthOption } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RecommendProviderHealthOption
+
+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 RecommendProviderHealthOption
+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/RecommendProviderInformation.md

@@ -0,0 +1,50 @@
+
+# RecommendProviderInformation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`logoUrl` | string
+`subtext` | string
+`health` | string
+`subProviders` | [Array<SubProviderMetadata>](SubProviderMetadata.md)
+`regions` | Array<string>
+`countries` | Array<string>
+`subdivisions` | Array<string>
+
+## Example
+
+```typescript
+import type { RecommendProviderInformation } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "logoUrl": null,
+  "subtext": dmv.ca.gov,
+  "health": online | offline,
+  "subProviders": null,
+  "regions": Europe,
+  "countries": US,
+  "subdivisions": US-CA,
+} satisfies RecommendProviderInformation
+
+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 RecommendProviderInformation
+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/RecommendProvidersRequest.md

@@ -0,0 +1,38 @@
+
+# RecommendProvidersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`verificationProfileId` | string
+`recommendationInfo` | [RecommendationInfo](RecommendationInfo.md)
+`health` | [RecommendProviderHealthOption](RecommendProviderHealthOption.md)
+
+## Example
+
+```typescript
+import type { RecommendProvidersRequest } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "verificationProfileId": null,
+  "recommendationInfo": null,
+  "health": null,
+} satisfies RecommendProvidersRequest
+
+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 RecommendProvidersRequest
+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/RecommendProvidersResponse.md

@@ -0,0 +1,36 @@
+
+# RecommendProvidersResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`recommendedProviders` | [Array<RecommendProviderInformation>](RecommendProviderInformation.md)
+`remainder` | [Array<RecommendProviderInformation>](RecommendProviderInformation.md)
+
+## Example
+
+```typescript
+import type { RecommendProvidersResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "recommendedProviders": null,
+  "remainder": null,
+} satisfies RecommendProvidersResponse
+
+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 RecommendProvidersResponse
+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/RecommendationInfo.md

@@ -0,0 +1,41 @@
+
+# RecommendationInfo
+
+Information relating to a user; used to generated Identity Provider recommendations.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`phoneNumber` | string
+`countries` | Array<string>
+`subdivisions` | Array<string>
+`ipAddresses` | Array<string>
+
+## Example
+
+```typescript
+import type { RecommendationInfo } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "phoneNumber": null,
+  "countries": null,
+  "subdivisions": null,
+  "ipAddresses": null,
+} satisfies RecommendationInfo
+
+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 RecommendationInfo
+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/RedirectUriResponse.md

@@ -0,0 +1,36 @@
+
+# RedirectUriResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`uri` | string
+
+## Example
+
+```typescript
+import type { RedirectUriResponse } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "uri": null,
+} satisfies RedirectUriResponse
+
+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 RedirectUriResponse
+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/RedirectUrisApi.md

@@ -0,0 +1,239 @@
+# RedirectUrisApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**_delete**](RedirectUrisApi.md#_delete) | **DELETE** /api/valpha/redirect-uris/{id} | Delete Redirect URI |
+| [**add**](RedirectUrisApi.md#add) | **POST** /api/valpha/redirect-uris | Add Redirect URI |
+| [**list**](RedirectUrisApi.md#list) | **GET** /api/valpha/redirect-uris | List Redirect URIs |
+
+
+
+## _delete
+
+> _delete(id)
+
+Delete Redirect URI
+
+Delete a redirect uri from the environment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RedirectUrisApi,
+} from '@trinsic/api';
+import type { DeleteRequest } 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 RedirectUrisApi(config);
+
+  const body = {
+    // string | The id of the redirect uri to delete.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteRequest;
+
+  try {
+    const data = await api._delete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | The id of the redirect uri to delete. | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+| **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)
+
+
+## add
+
+> AddRedirectUriResponse add(addRedirectUriRequest)
+
+Add Redirect URI
+
+Add a new redirect uri to the authenticated environment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RedirectUrisApi,
+} from '@trinsic/api';
+import type { AddRequest } 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 RedirectUrisApi(config);
+
+  const body = {
+    // AddRedirectUriRequest | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted. (optional)
+    addRedirectUriRequest: ...,
+  } satisfies AddRequest;
+
+  try {
+    const data = await api.add(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **addRedirectUriRequest** | [AddRedirectUriRequest](AddRedirectUriRequest.md) | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted. | [Optional] |
+
+### Return type
+
+[**AddRedirectUriResponse**](AddRedirectUriResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`, `text/json`, `application/*+json`
+- **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)
+
+
+## list
+
+> ListRedirectUrisResponse list(page, pageSize)
+
+List Redirect URIs
+
+List registered Redirect URIs for the authenticated environment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RedirectUrisApi,
+} from '@trinsic/api';
+import type { ListRequest } 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 RedirectUrisApi(config);
+
+  const body = {
+    // number | Number of pages of uris to return. (optional)
+    page: 56,
+    // number | Size of the list to be returned. Accepted range from 1 to 100 (optional)
+    pageSize: 56,
+  } satisfies ListRequest;
+
+  try {
+    const data = await api.list(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Number of pages of uris to return. | [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
+
+[**ListRedirectUrisResponse**](ListRedirectUrisResponse.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)
+