@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/docs/FranceIdentiteProviderOutput.md

@@ -0,0 +1,35 @@
+
+# FranceIdentiteProviderOutput
+
+Exposed properties for the `france-identite` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`raw18013Output` | [MdlOutput](MdlOutput.md)
+
+## Example
+
+```typescript
+import type { FranceIdentiteProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "raw18013Output": null,
+} satisfies FranceIdentiteProviderOutput
+
+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 FranceIdentiteProviderOutput
+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/FrejaIndirectProviderOutput.md

@@ -0,0 +1,41 @@
+
+# FrejaIndirectProviderOutput
+
+Exposed properties for the `a-freja-eid-login` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`personalNumber` | string
+`personalNumberCountry` | string
+
+## Example
+
+```typescript
+import type { FrejaIndirectProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": John,
+  "lastName": Doe,
+  "personalNumber": 200003276624,
+  "personalNumberCountry": SE,
+} satisfies FrejaIndirectProviderOutput
+
+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 FrejaIndirectProviderOutput
+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/FrejaProviderOutput.md

@@ -0,0 +1,69 @@
+
+# FrejaProviderOutput
+
+Exposed properties for the `freja` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`givenName` | string
+`familyName` | string
+`dateOfBirth` | Date
+`email` | string
+`emailVerified` | boolean
+`allEmailAddresses` | Array<string>
+`primaryPhysicalAddress` | [OutputFrejaAddress](OutputFrejaAddress.md)
+`allPhysicalAddresses` | [Array<OutputFrejaAddress>](OutputFrejaAddress.md)
+`age` | number
+`phoneNumber` | string
+`phoneNumberVerified` | boolean
+`personalIdentityNumber` | string
+`country` | string
+`document` | [OutputFrejaDocument](OutputFrejaDocument.md)
+`registrationLevel` | string
+`relyingPartyUserId` | string
+`transactionReference` | string
+
+## Example
+
+```typescript
+import type { FrejaProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Ada Lovelace,
+  "givenName": Ada,
+  "familyName": Lovelace,
+  "dateOfBirth": Mon Jan 01 00:00:00 UTC 1990,
+  "email": ada.lovelace@example.com,
+  "emailVerified": true,
+  "allEmailAddresses": ["ada.lovelace@example.com","ada@example.org"],
+  "primaryPhysicalAddress": null,
+  "allPhysicalAddresses": [{"line1":"123 Residential St","city":"Townsville","postalCode":"12345","country":"US"},{"line1":"456 Billing St","city":"Citysville","postalCode":"67890","country":"US"}],
+  "age": 35,
+  "phoneNumber": +1234567890,
+  "phoneNumberVerified": true,
+  "personalIdentityNumber": A1234567890,
+  "country": SE,
+  "document": null,
+  "registrationLevel": EXTENDED,
+  "relyingPartyUserId": FA9C4BAF97489D51B5A97B41F46AB1B514D66757DBBE8AA66EAD010262B2CCE3,
+  "transactionReference": hstRVGtMdQ-HLN8huVYY3HOfq0RS7BSZhgANDyk80UF-JLh8q8lS9Y7tVM44HLkg,
+} satisfies FrejaProviderOutput
+
+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 FrejaProviderOutput
+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/FrenchNumeriqueGivenName.md

@@ -0,0 +1,39 @@
+
+# FrenchNumeriqueGivenName
+
+Given name information including the full given name and its structured components.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullGivenName` | string
+`firstName` | string
+`middleName` | string
+
+## Example
+
+```typescript
+import type { FrenchNumeriqueGivenName } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullGivenName": Jean Pierre,
+  "firstName": Jean,
+  "middleName": Pierre,
+} satisfies FrenchNumeriqueGivenName
+
+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 FrenchNumeriqueGivenName
+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/FrenchNumeriqueNationality.md

@@ -0,0 +1,37 @@
+
+# FrenchNumeriqueNationality
+
+Nationality information with ISO 3166 alpha-3 code and French label.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`label` | string
+
+## Example
+
+```typescript
+import type { FrenchNumeriqueNationality } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": FRA,
+  "label": Française,
+} satisfies FrenchNumeriqueNationality
+
+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 FrenchNumeriqueNationality
+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/FrenchNumeriquePhone.md

@@ -0,0 +1,39 @@
+
+# FrenchNumeriquePhone
+
+Phone number information including the full phone number and its structured components.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fullPhoneNumber` | string
+`countryPrefix` | string
+`nationalNumber` | string
+
+## Example
+
+```typescript
+import type { FrenchNumeriquePhone } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fullPhoneNumber": +33606060606,
+  "countryPrefix": +33,
+  "nationalNumber": 601020304,
+} satisfies FrenchNumeriquePhone
+
+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 FrenchNumeriquePhone
+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/FrenchNumeriqueProviderOutput.md

@@ -0,0 +1,83 @@
+
+# FrenchNumeriqueProviderOutput
+
+Exposed properties for the `france-identite-numerique` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`givenName` | [FrenchNumeriqueGivenName](FrenchNumeriqueGivenName.md)
+`familyName` | string
+`preferredSurname` | string
+`birthdate` | string
+`nationality` | [FrenchNumeriqueNationality](FrenchNumeriqueNationality.md)
+`sex` | string
+`majority` | boolean
+`phoneNumber` | [FrenchNumeriquePhone](FrenchNumeriquePhone.md)
+`phoneNumberVerified` | boolean
+`email` | string
+`emailVerified` | boolean
+`birthplace` | string
+`birthplaceLabel` | string
+`birthCountry` | string
+`birthCountryIso` | string
+`birthCountryLabel` | string
+`birthDepartment` | string
+`digitalIdentityCreationDate` | Date
+`digitalIdentityExpirationDate` | Date
+`identityDocumentType` | string
+`identityDocumentNumber` | string
+`identityDocumentEmittingDate` | Date
+`identityDocumentExpirationDate` | Date
+`identityDocumentEmittingCountry` | string
+`identityDocumentMrz` | string
+
+## Example
+
+```typescript
+import type { FrenchNumeriqueProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "givenName": null,
+  "familyName": Dupont,
+  "preferredSurname": Martin,
+  "birthdate": 1990-01-15,
+  "nationality": null,
+  "sex": Male,
+  "majority": true,
+  "phoneNumber": null,
+  "phoneNumberVerified": true,
+  "email": jean.dupont@example.fr,
+  "emailVerified": true,
+  "birthplace": 75056,
+  "birthplaceLabel": PARIS-9E-ARRONDISSEMENT,
+  "birthCountry": 99100,
+  "birthCountryIso": FRA,
+  "birthCountryLabel": France,
+  "birthDepartment": 75,
+  "digitalIdentityCreationDate": Thu Jun 15 00:00:00 UTC 2023,
+  "digitalIdentityExpirationDate": Thu Jun 15 00:00:00 UTC 2028,
+  "identityDocumentType": PASSPORT,
+  "identityDocumentNumber": 51RF501150,
+  "identityDocumentEmittingDate": Wed Mar 24 00:00:00 UTC 2021,
+  "identityDocumentExpirationDate": Mon Mar 24 00:00:00 UTC 2031,
+  "identityDocumentEmittingCountry": FRA,
+  "identityDocumentMrz": P<FRASPECIMEN<<NATACHA<<<<<<<<<<<<<<<<<<<<<<<<<51RF501150FRA7307122F2203242<<<<<<<<<<<<<<<02,
+} satisfies FrenchNumeriqueProviderOutput
+
+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 FrenchNumeriqueProviderOutput
+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/GetAttachmentRequest.md

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

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

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

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

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

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

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

@@ -0,0 +1,35 @@
+
+# GoogleWalletProviderOutput
+
+Exposed properties for the `google-wallet` Provider which do not directly map to the normalized IdentityData model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rawMdlOutput` | [MdlOutput](MdlOutput.md)
+
+## Example
+
+```typescript
+import type { GoogleWalletProviderOutput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rawMdlOutput": null,
+} satisfies GoogleWalletProviderOutput
+
+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 GoogleWalletProviderOutput
+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/GuatemalaCuiLookupInput.md

@@ -0,0 +1,34 @@
+
+# GuatemalaCuiLookupInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`documentNumber` | string
+
+## Example
+
+```typescript
+import type { GuatemalaCuiLookupInput } from '@trinsic/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "documentNumber": 1234567890101,
+} satisfies GuatemalaCuiLookupInput
+
+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 GuatemalaCuiLookupInput
+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)
+
+