diff --git a/generators/python/README.md b/generators/python/README.md
index 7b669ffa8de..1316f7ab4c1 100644
--- a/generators/python/README.md
+++ b/generators/python/README.md
@@ -1,7 +1,7 @@
- 
+ 
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertParameters.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertParameters.ts
index b2a18deb15a..b0803ca4e08 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertParameters.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/endpoint/convertParameters.ts
@@ -63,7 +63,7 @@ export function convertParameters({
const availability = convertAvailability(resolvedParameter);
const parameterBreadcrumbs = [...requestBreadcrumbs, resolvedParameter.name];
- const generatedName = getGeneratedTypeName(parameterBreadcrumbs);
+ const generatedName = getGeneratedTypeName(parameterBreadcrumbs, context.options.preserveSchemaIds);
let schema =
resolvedParameter.schema != null
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertAsyncSyncOperation.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertAsyncSyncOperation.ts
index 460573cd163..0701018e7fe 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertAsyncSyncOperation.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertAsyncSyncOperation.ts
@@ -69,7 +69,7 @@ export function convertAsyncSyncOperation({
name: headerToIgnore,
schema: SchemaWithExample.literal({
nameOverride: undefined,
- generatedName: getGeneratedTypeName([headerToIgnore]),
+ generatedName: getGeneratedTypeName([headerToIgnore], context.options.preserveSchemaIds),
title: undefined,
description: undefined,
availability: undefined,
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertHttpOperation.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertHttpOperation.ts
index c69febdce1d..c01c372bf7a 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertHttpOperation.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertHttpOperation.ts
@@ -121,7 +121,7 @@ export function convertHttpOperation({
queryParameters: convertedParameters.queryParameters,
headers: convertedParameters.headers,
requestNameOverride: requestNameOverride ?? undefined,
- generatedRequestName: getGeneratedTypeName(requestBreadcrumbs),
+ generatedRequestName: getGeneratedTypeName(requestBreadcrumbs, context.options.preserveSchemaIds),
request: convertedRequest,
response: convertedResponse.value,
errors: convertedResponse.errors,
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertWebhookOperation.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertWebhookOperation.ts
index ee5f1a984b8..13968c1df3d 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertWebhookOperation.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/operation/convertWebhookOperation.ts
@@ -64,7 +64,7 @@ export function convertWebhookOperation({
operationId: operation.operationId,
tags: context.resolveTagsToTagIds(operation.tags),
headers: convertedParameters.headers,
- generatedPayloadName: getGeneratedTypeName(payloadBreadcrumbs),
+ generatedPayloadName: getGeneratedTypeName(payloadBreadcrumbs, context.options.preserveSchemaIds),
payload: convertedPayload.schema,
description: operation.description,
examples: convertWebhookExamples(convertedPayload.fullExamples),
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/extensions/getVariableDefinitions.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/extensions/getVariableDefinitions.ts
index 8a3d27de161..e6de1fe8d5a 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/extensions/getVariableDefinitions.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/extensions/getVariableDefinitions.ts
@@ -5,7 +5,10 @@ import { getDefaultAsString } from "../../../schema/defaults/getDefault";
import { getGeneratedTypeName } from "../../../schema/utils/getSchemaName";
import { FernOpenAPIExtension } from "./fernExtensions";
-export function getVariableDefinitions(document: OpenAPIV3.Document): Record
{
+export function getVariableDefinitions(
+ document: OpenAPIV3.Document,
+ preserveSchemaIds: boolean
+): Record {
const variables = getExtension>(
document,
FernOpenAPIExtension.SDK_VARIABLES
@@ -22,7 +25,7 @@ export function getVariableDefinitions(document: OpenAPIV3.Document): Record(schema, FernOpenAPIExtension.TYPE_NAME);
- const generatedName = getGeneratedTypeName(breadcrumbs);
+ const generatedName = getGeneratedTypeName(breadcrumbs, preserveSchemaIds);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const description = (schema as any).description;
const availability = convertAvailability(schema);
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/convertUndiscriminatedOneOf.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/convertUndiscriminatedOneOf.ts
index eb99f23f498..34aabed2039 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/convertUndiscriminatedOneOf.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/convertUndiscriminatedOneOf.ts
@@ -66,7 +66,7 @@ export function convertUndiscriminatedOneOf({
return schema.enum.map((enumValue) => {
return SchemaWithExample.literal({
nameOverride: undefined,
- generatedName: getGeneratedTypeName([generatedName, enumValue]),
+ generatedName: getGeneratedTypeName([generatedName, enumValue], context.options.preserveSchemaIds),
title: undefined,
value: LiteralSchemaValue.string(enumValue),
groupName: undefined,
@@ -201,7 +201,10 @@ export function convertUndiscriminatedOneOfWithDiscriminant({
subtypeReference.properties = {
[discriminator.propertyName]: SchemaWithExample.literal({
nameOverride: undefined,
- generatedName: getGeneratedTypeName([generatedName, discriminantValue]),
+ generatedName: getGeneratedTypeName(
+ [generatedName, discriminantValue],
+ context.options.preserveSchemaIds
+ ),
title: undefined,
value: LiteralSchemaValue.string(discriminantValue),
groupName: undefined,
diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/utils/getSchemaName.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/utils/getSchemaName.ts
index b854ffaa1db..d8cd9a88d84 100644
--- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/utils/getSchemaName.ts
+++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/schema/utils/getSchemaName.ts
@@ -1,9 +1,17 @@
import { camelCase, upperFirst } from "lodash-es";
import { replaceStartingNumber } from "./replaceStartingNumber";
-export function getGeneratedTypeName(breadcrumbs: string[]): string {
- const underscoreDelimeted = breadcrumbs.join("_");
- const name = upperFirst(camelCase(underscoreDelimeted));
+export function getGeneratedTypeName(breadcrumbs: string[], useOriginalSchemaIds: boolean): string {
+ const processedTokens = breadcrumbs.map((token) => {
+ if (/^[^a-zA-Z0-9]+$/.test(token)) {
+ return token;
+ } else {
+ return upperFirst(camelCase(token));
+ }
+ });
+
+ const name = processedTokens.join("");
+
if (/^\d/.test(name)) {
return replaceStartingNumber(name) ?? name;
}
@@ -11,6 +19,6 @@ export function getGeneratedTypeName(breadcrumbs: string[]): string {
}
export function getGeneratedPropertyName(breadcrumbs: string[]): string {
- const underscoreDelimeted = breadcrumbs.join("_");
- return camelCase(underscoreDelimeted);
+ const underscoreDelimited = breadcrumbs.join("_");
+ return camelCase(underscoreDelimited);
}
diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json
new file mode 100644
index 00000000000..da9a04af27f
--- /dev/null
+++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json
@@ -0,0 +1,10921 @@
+{
+ "absoluteFilePath": "/DUMMY_PATH",
+ "importedDefinitions": {},
+ "namedDefinitionFiles": {
+ "__package__.yml": {
+ "absoluteFilepath": "/DUMMY_PATH",
+ "contents": {
+ "errors": {
+ "CreateAccountHolderV3AccountHoldersPostRequestBadRequestError": {
+ "docs": "Account holder with the provided id already exists.",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "CreateAccountHolderV3AccountHoldersPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "CustomCategoriesPostV3CategoriesAccountHolderTypePostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteAccountHolderV3AccountHoldersIdDeleteRequestNotFoundError": {
+ "docs": "Account holder with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "DeleteAccountHolderV3AccountHoldersIdDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteBankStatementV3BankStatementsIdDeleteRequestNotFoundError": {
+ "docs": "Bank statement with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "DeleteBankStatementV3BankStatementsIdDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteCustomCategorySetV3CategoriesAccountHolderTypeResetPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteReportV3ReportsIdDeleteRequestNotFoundError": {
+ "docs": "Report with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "DeleteReportV3ReportsIdDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteTransactionV3TransactionsIdDeleteRequestNotFoundError": {
+ "docs": "Transaction with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "DeleteTransactionV3TransactionsIdDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "DeleteWebhookV3WebhooksIdDeleteRequestNotFoundError": {
+ "docs": "Webhook with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "DeleteWebhookV3WebhooksIdDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "FilterAppendV3RulesAppendPostRequestBadRequestError": {
+ "docs": "Provided rule has invalid structure",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "FilterAppendV3RulesAppendPostRequestContentTooLargeError": {
+ "docs": "Ruleset after append was larger than 50KiB",
+ "status-code": 413,
+ "type": "unknown",
+ },
+ "FilterAppendV3RulesAppendPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "FilterDeleteV3RulesIndexDeleteRequestBadRequestError": {
+ "docs": "Provided index does not exist in ruleset",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "FilterDeleteV3RulesIndexDeleteRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "FilterGetV3RulesGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "FilterPatchV3RulesIndexPatchRequestBadRequestError": {
+ "docs": "Provided index does not exist in ruleset",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "FilterPatchV3RulesIndexPatchRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "FilterPostV3RulesPostRequestBadRequestError": {
+ "docs": "Provided ruleset has invalid structure",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "FilterPostV3RulesPostRequestContentTooLargeError": {
+ "docs": "Ruleset was larger than 50KiB",
+ "status-code": 413,
+ "type": "unknown",
+ },
+ "FilterPostV3RulesPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetAccountHolderRecurringPaymentsV3AccountHoldersIdRecurringGroupsPostRequestNotFoundError": {
+ "docs": "Account holder with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetAccountHolderRecurringPaymentsV3AccountHoldersIdRecurringGroupsPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetAccountHolderV3AccountHoldersIdGetRequestNotFoundError": {
+ "docs": "Account holder with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetAccountHolderV3AccountHoldersIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetAccountHoldersV3AccountHoldersGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBankStatementResultV3BankStatementsIdResultsGetRequestNotFoundError": {
+ "docs": "Bank statement with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetBankStatementResultV3BankStatementsIdResultsGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBankStatementStatementInfoV3BankStatementsIdOverviewPostRequestNotFoundError": {
+ "docs": "Bank statement with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetBankStatementStatementInfoV3BankStatementsIdOverviewPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBankStatementV3BankStatementsIdGetRequestNotFoundError": {
+ "docs": "Bank statement with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetBankStatementV3BankStatementsIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBankStatementsV3BankStatementsGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBatchResultsV3BatchesIdResultsGetRequestNotFoundError": {
+ "docs": "Batch with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetBatchResultsV3BatchesIdResultsGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetBatchesV3BatchesGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetCategorySetV3CategoriesAccountHolderTypeGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetEntityByIdV3EntitiesIdGetRequestBadRequestError": {
+ "docs": "Bad request.",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "GetEntityByIdV3EntitiesIdGetRequestNotFoundError": {
+ "docs": "Entity does not exist for ID",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetEntityByIdV3EntitiesIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetReportV3ReportsIdGetRequestNotFoundError": {
+ "docs": "Report with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetReportV3ReportsIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetReportsV3ReportsGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetSingleBatchV3BatchesIdGetRequestNotFoundError": {
+ "docs": "Batch with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetSingleBatchV3BatchesIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetTransactionV3TransactionsIdGetRequestNotFoundError": {
+ "docs": "Transaction with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "GetTransactionV3TransactionsIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetWebhookV3WebhooksIdGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "GetWebhooksV3WebhooksGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "ListTransactionsV3TransactionsGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PatchWebhookV3WebhooksIdPatchRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PostBankStatementV3BankStatementsPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PostBatchV3BatchesPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PostReportV3ReportsPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PostTransactionsV3TransactionsPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "PostWebhookV3WebhooksPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "SearchEntityV3EntitiesLookupGetRequestBadRequestError": {
+ "docs": "Bad request.",
+ "status-code": 400,
+ "type": "unknown",
+ },
+ "SearchEntityV3EntitiesLookupGetRequestLockedError": {
+ "docs": "Not enough credits.",
+ "status-code": 423,
+ "type": "unknown",
+ },
+ "SearchEntityV3EntitiesLookupGetRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ "SetTransactionAhV3TransactionsIdAssignPostRequestNotFoundError": {
+ "docs": "Transaction or account holder with the provided id not found.",
+ "status-code": 404,
+ "type": "unknown",
+ },
+ "SetTransactionAhV3TransactionsIdAssignPostRequestUnprocessableEntityError": {
+ "docs": "Validation Error",
+ "examples": [
+ {
+ "docs": undefined,
+ "name": undefined,
+ "value": {},
+ },
+ ],
+ "status-code": 422,
+ "type": "HTTPValidationError",
+ },
+ },
+ "types": {
+ "Account": {
+ "docs": undefined,
+ "properties": {
+ "closing_balance": {
+ "type": "optional",
+ },
+ "iso_currency_code": {
+ "type": "optional",
+ },
+ "number": {
+ "type": "optional",
+ },
+ "opening_balance": {
+ "type": "optional",
+ },
+ "type": {
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "AccountHolder": {
+ "docs": undefined,
+ "properties": {
+ "address": {
+ "type": "optional",
+ },
+ "name": {
+ "type": "optional",
+ },
+ "type": {
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "AccountHolderExternal": {
+ "docs": undefined,
+ "properties": {
+ "created_at": {
+ "docs": "The timestamp of when the account holder was created.",
+ "type": "datetime",
+ },
+ "id": {
+ "docs": "The unique ID of the account holder of the transaction",
+ "type": "string",
+ "validation": {
+ "format": undefined,
+ "maxLength": undefined,
+ "minLength": 1,
+ "pattern": undefined,
+ },
+ },
+ "name": {
+ "docs": "The name of the account holder",
+ "type": "optional",
+ },
+ "type": {
+ "docs": "The type of the account holder. ",
+ "type": "AccountHolderType",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "AccountHolderType": {
+ "docs": "An enumeration.",
+ "enum": [
+ "consumer",
+ "business",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "AccountType": {
+ "docs": "An enumeration.",
+ "enum": [
+ "consumer",
+ "business",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "AccountingCategory": {
+ "docs": "An enumeration.",
+ "enum": [
+ {
+ "name": "OperationalExpenses",
+ "value": "operational expenses",
+ },
+ {
+ "name": "CostOfGoodsSold",
+ "value": "cost of goods sold",
+ },
+ "revenue",
+ "financing",
+ "taxes",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ActionModel": {
+ "type": "action",
+ },
+ "Address": {
+ "docs": undefined,
+ "properties": {
+ "city": {
+ "type": "optional",
+ },
+ "country": {
+ "type": "optional",
+ },
+ "postcode": {
+ "type": "optional",
+ },
+ "state": {
+ "type": "optional",
+ },
+ "street": {
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatement": {
+ "docs": "Represents a bank statement with details about the file and its status.",
+ "properties": {
+ "created_at": {
+ "docs": "The date and time when the job was created.",
+ "type": "datetime",
+ },
+ "error": {
+ "type": "optional",
+ },
+ "file": {
+ "docs": "Information about the bank statement file being processed.",
+ "type": "BankStatementFile",
+ },
+ "id": {
+ "docs": "A unique identifier for the bank statement job.",
+ "type": "string",
+ },
+ "name": {
+ "docs": "The name of the bank statement file, if available.",
+ "type": "optional",
+ },
+ "status": {
+ "docs": "The current status of the document.",
+ "type": "BankStatementStatus",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementAccount": {
+ "docs": undefined,
+ "properties": {
+ "closing_balance": {
+ "docs": "The closing balance of the account for the statement period.",
+ "type": "optional",
+ },
+ "end_date": {
+ "docs": "The end date of the statement period.",
+ "type": "optional",
+ "validation": {
+ "format": "date",
+ "maxLength": undefined,
+ "minLength": undefined,
+ "pattern": undefined,
+ },
+ },
+ "is_balance_reconciled": {
+ "docs": "Indicates whether the balance has been reconciled.",
+ "type": "optional",
+ },
+ "number": {
+ "docs": "The account number, if available.",
+ "type": "optional",
+ },
+ "opening_balance": {
+ "docs": "The opening balance of the account for the statement period.",
+ "type": "optional",
+ },
+ "start_date": {
+ "docs": "The start date of the statement period.",
+ "type": "optional",
+ "validation": {
+ "format": "date",
+ "maxLength": undefined,
+ "minLength": undefined,
+ "pattern": undefined,
+ },
+ },
+ "total_incoming": {
+ "docs": "The sum of amounts of all incoming transactions.",
+ "type": "optional",
+ },
+ "total_outgoing": {
+ "docs": "The sum of amounts of all outgoing transactions.",
+ "type": "optional",
+ },
+ "transactions": {
+ "docs": "List of transactions for this account.",
+ "type": "list",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementError": {
+ "docs": undefined,
+ "properties": {
+ "code": {
+ "type": "BankStatementErrorCode",
+ },
+ "message": "string",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementErrorCode": {
+ "docs": "An enumeration.",
+ "enum": [
+ "invalid_bank_statement",
+ "internal_error",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementFile": {
+ "docs": undefined,
+ "properties": {
+ "no_pages": {
+ "docs": "The number of pages in the bank statement file.",
+ "type": "integer",
+ },
+ "size": {
+ "docs": "The size of the bank statement file in bytes, if available.",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementResults": {
+ "docs": undefined,
+ "properties": {
+ "accounts": {
+ "docs": "List of accounts in the bank statement.",
+ "type": "list",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementStatus": {
+ "docs": "An enumeration.",
+ "enum": [
+ "processing",
+ "completed",
+ "error",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BankStatementTransaction": {
+ "docs": undefined,
+ "properties": {
+ "amount": {
+ "docs": "The amount of the transaction in the `currency`. Must be a positive value. For example, if the `currency` is USD, then it's the amount in dollars.",
+ "type": "double",
+ "validation": {
+ "exclusiveMax": undefined,
+ "exclusiveMin": undefined,
+ "max": undefined,
+ "min": 0,
+ "multipleOf": undefined,
+ },
+ },
+ "currency": {
+ "docs": "The currency of the transaction in ISO 4217 format",
+ "type": "Currency",
+ },
+ "date": {
+ "docs": "The date that the transaction was posted. Uses ISO 8601 format (YYYY-MM-DD)",
+ "type": "string",
+ "validation": {
+ "format": "date",
+ "maxLength": undefined,
+ "minLength": undefined,
+ "pattern": undefined,
+ },
+ },
+ "description": {
+ "docs": "The description string of the transaction",
+ "type": "string",
+ "validation": {
+ "format": undefined,
+ "maxLength": 1024,
+ "minLength": 0,
+ "pattern": undefined,
+ },
+ },
+ "entry_type": {
+ "docs": "The direction of the flow of the money from the perspective of the account holder. `outgoing` to represent money leaving the account, such as purchases or fees, while `incoming` represents money entering the account, such as income or refunds.",
+ "type": "EntryType",
+ },
+ "id": {
+ "docs": "A unique identifier of the transaction",
+ "type": "string",
+ "validation": {
+ "format": undefined,
+ "maxLength": undefined,
+ "minLength": 1,
+ "pattern": undefined,
+ },
+ },
+ "running_balance": {
+ "docs": "The account's balance when this transaction was performed",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Batch": {
+ "docs": "The `Batch` object represents the status and progress of an asynchronous batch enrichment job.",
+ "properties": {
+ "created_at": {
+ "docs": "The timestamp of when the batch was created.",
+ "type": "datetime",
+ },
+ "id": {
+ "docs": "A unique identifier for the batch.",
+ "type": "string",
+ },
+ "progress": {
+ "docs": "The number of transactions processed so far.",
+ "type": "integer",
+ },
+ "status": {
+ "docs": "The current status of the batch. A batch will error if at least one of the transactions contains an error.",
+ "type": "BatchStatus",
+ },
+ "total": {
+ "docs": "The total number of transactions in the batch.",
+ "type": "integer",
+ },
+ "updated_at": {
+ "docs": "The timestamp of when the batch was last updated.",
+ "type": "datetime",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BatchResult": {
+ "docs": "The `BatchResult` object represents the result of a batch enrichment job, including its status and
+enriched transactions.",
+ "properties": {
+ "id": {
+ "docs": "A unique identifier for the batch.",
+ "type": "string",
+ },
+ "results": {
+ "type": "EnrichmentResult",
+ },
+ "status": {
+ "docs": "The current status of the batch job.",
+ "type": "BatchStatus",
+ },
+ "total": {
+ "docs": "The total number of transactions in the batch result.",
+ "type": "integer",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "BatchStatus": {
+ "docs": "An enumeration.",
+ "enum": [
+ "processing",
+ "completed",
+ "error",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Categories": {
+ "docs": undefined,
+ "properties": {
+ "accounting": {
+ "docs": "The corresponding accounting category. Only available for `business` transactions.",
+ "type": "optional",
+ },
+ "general": {
+ "docs": "The category of the transaction. View the valid set of categories for your key [here](./docs/v3/enrichment/entities).",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "CategoryConfidence": {
+ "docs": "An enumeration.",
+ "enum": [
+ "high",
+ "medium",
+ "low",
+ "unknown",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "CategorySet": {
+ "docs": undefined,
+ "properties": {
+ "incoming": {
+ "type": "list",
+ },
+ "outgoing": {
+ "type": "list",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Counterparty": {
+ "docs": undefined,
+ "properties": {
+ "id": {
+ "docs": "The unique UUID identifier of the entity",
+ "type": "optional",
+ },
+ "logo": {
+ "docs": "Logo's URL",
+ "type": "optional",
+ },
+ "mccs": {
+ "docs": "A list of [Merchant Category Codes](https://en.wikipedia.org/wiki/Merchant_category_code)",
+ "type": "optional>",
+ },
+ "name": {
+ "docs": "The name of the entity",
+ "type": "optional",
+ },
+ "type": {
+ "type": "CounterpartyType",
+ },
+ "website": {
+ "docs": "The website URL of the entity",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "CounterpartyType": {
+ "docs": "An enumeration.",
+ "enum": [
+ "person",
+ "organization",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Country": {
+ "docs": "An enumeration.",
+ "enum": [
+ "AD",
+ "AE",
+ "AF",
+ "AG",
+ "AI",
+ "AL",
+ "AM",
+ "AO",
+ "AR",
+ "AS",
+ "AT",
+ "AU",
+ "AW",
+ "AZ",
+ "BA",
+ "BB",
+ "BD",
+ "BE",
+ "BF",
+ "BG",
+ "BH",
+ "BI",
+ "BJ",
+ "BL",
+ "BM",
+ "BN",
+ "BO",
+ "BQ",
+ "BR",
+ "BS",
+ "BT",
+ "BV",
+ "BW",
+ "BY",
+ "BZ",
+ "CA",
+ "CC",
+ "CD",
+ "CF",
+ "CG",
+ "CH",
+ "CI",
+ "CK",
+ "CL",
+ "CM",
+ "CN",
+ "CO",
+ "CR",
+ "CU",
+ "CV",
+ "CW",
+ "CX",
+ "CY",
+ "CZ",
+ "DE",
+ "DJ",
+ "DK",
+ "DM",
+ "DO",
+ "DZ",
+ "EC",
+ "EE",
+ "EG",
+ "EH",
+ "ER",
+ "ES",
+ "ET",
+ "FI",
+ "FJ",
+ "FK",
+ "FM",
+ "FR",
+ "GA",
+ "GB",
+ "GD",
+ "GE",
+ "GF",
+ "GG",
+ "GH",
+ "GI",
+ "GL",
+ "GM",
+ "GN",
+ "GP",
+ "GQ",
+ "GR",
+ "GS",
+ "GT",
+ "GU",
+ "GW",
+ "GY",
+ "HK",
+ "HM",
+ "HN",
+ "HR",
+ "HT",
+ "HU",
+ "ID",
+ "IE",
+ "IL",
+ "IM",
+ "IN",
+ "IO",
+ "IQ",
+ "IR",
+ "IS",
+ "IT",
+ "JE",
+ "JM",
+ "JO",
+ "JP",
+ "KE",
+ "KG",
+ "KH",
+ "KI",
+ "KM",
+ "KN",
+ "KP",
+ "KR",
+ "KW",
+ "KY",
+ "KZ",
+ "LA",
+ "LB",
+ "LC",
+ "LI",
+ "LK",
+ "LR",
+ "LS",
+ "LT",
+ "LU",
+ "LV",
+ "LY",
+ "MA",
+ "MC",
+ "MD",
+ "ME",
+ "MF",
+ "MG",
+ "MH",
+ "MK",
+ "ML",
+ "MM",
+ "MN",
+ "MO",
+ "MP",
+ "MQ",
+ "MR",
+ "MS",
+ "MT",
+ "MU",
+ "MV",
+ "MW",
+ "MX",
+ "MY",
+ "MZ",
+ "NA",
+ "NC",
+ "NE",
+ "NF",
+ "NG",
+ "NI",
+ "NL",
+ "NO",
+ "NP",
+ "NR",
+ "NU",
+ "NZ",
+ "OM",
+ "PA",
+ "PE",
+ "PF",
+ "PG",
+ "PH",
+ "PK",
+ "PL",
+ "PM",
+ "PN",
+ "PR",
+ "PS",
+ "PT",
+ "PW",
+ "PY",
+ "QA",
+ "RE",
+ "RO",
+ "RS",
+ "RU",
+ "RW",
+ "SA",
+ "SB",
+ "SC",
+ "SD",
+ "SE",
+ "SG",
+ "SH",
+ "SI",
+ "SJ",
+ "SK",
+ "SL",
+ "SM",
+ "SN",
+ "SO",
+ "SR",
+ "SS",
+ "ST",
+ "SV",
+ "SX",
+ "SY",
+ "SZ",
+ "TC",
+ "TD",
+ "TG",
+ "TH",
+ "TJ",
+ "TK",
+ "TL",
+ "TM",
+ "TN",
+ "TO",
+ "TR",
+ "TT",
+ "TV",
+ "TW",
+ "TZ",
+ "UA",
+ "UG",
+ "UM",
+ "US",
+ "UY",
+ "UZ",
+ "VC",
+ "VE",
+ "VG",
+ "VI",
+ "VN",
+ "VU",
+ "WF",
+ "WS",
+ "YE",
+ "YT",
+ "ZA",
+ "ZM",
+ "ZW",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Currency": {
+ "docs": "An enumeration.",
+ "enum": [
+ "EUR",
+ "AED",
+ "AFN",
+ "XCD",
+ "ALL",
+ "AMD",
+ "AOA",
+ "ARS",
+ "USD",
+ "AUD",
+ "AWG",
+ "AZN",
+ "BAM",
+ "BBD",
+ "BDT",
+ "XOF",
+ "BGN",
+ "BHD",
+ "BIF",
+ "BMD",
+ "BND",
+ "BOB",
+ "BRL",
+ "BSD",
+ "INR",
+ "NOK",
+ "BWP",
+ "BYR",
+ "BZD",
+ "CAD",
+ "CDF",
+ "XAF",
+ "CHF",
+ "NZD",
+ "CLP",
+ "CNY",
+ "COP",
+ "CRC",
+ "CUP",
+ "CVE",
+ "ANG",
+ "CZK",
+ "DJF",
+ "DKK",
+ "DOP",
+ "DZD",
+ "EGP",
+ "MAD",
+ "ERN",
+ "ETB",
+ "FJD",
+ "FKP",
+ "GBP",
+ "GEL",
+ "GHS",
+ "GIP",
+ "GMD",
+ "GNF",
+ "GTQ",
+ "GYD",
+ "HKD",
+ "HNL",
+ "HUF",
+ "IDR",
+ "ILS",
+ "IQD",
+ "IRR",
+ "ISK",
+ "JMD",
+ "JOD",
+ "JPY",
+ "KES",
+ "KGS",
+ "KHR",
+ "KMF",
+ "KPW",
+ "KRW",
+ "KWD",
+ "KYD",
+ "KZT",
+ "LAK",
+ "LBP",
+ "LKR",
+ "LRD",
+ "ZAR",
+ "LYD",
+ "MDL",
+ "MGA",
+ "MKD",
+ "MMK",
+ "MNT",
+ "MOP",
+ "MRO",
+ "MUR",
+ "MVR",
+ "MWK",
+ "MXN",
+ "MYR",
+ "MZN",
+ "XPF",
+ "NGN",
+ "NIO",
+ "NPR",
+ "OMR",
+ "PEN",
+ "PGK",
+ "PHP",
+ "PKR",
+ "PLN",
+ "PYG",
+ "QAR",
+ "RON",
+ "RSD",
+ "RUB",
+ "RWF",
+ "SAR",
+ "SBD",
+ "SCR",
+ "SDG",
+ "SEK",
+ "SGD",
+ "SHP",
+ "SLL",
+ "SOS",
+ "SRD",
+ "SSP",
+ "STD",
+ "SYP",
+ "SZL",
+ "THB",
+ "TJS",
+ "TMT",
+ "TND",
+ "TOP",
+ "TRY",
+ "TTD",
+ "TWD",
+ "TZS",
+ "UAH",
+ "UGX",
+ "UYU",
+ "UZS",
+ "VEF",
+ "VND",
+ "VUV",
+ "WST",
+ "YER",
+ "ZMW",
+ "ZWL",
+ "HRK",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "CustomCategorySet": {
+ "docs": undefined,
+ "properties": {
+ "incoming": {
+ "type": "list",
+ },
+ "outgoing": {
+ "type": "list",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "DocumentStatus": {
+ "docs": "An enumeration.",
+ "enum": [
+ "queued",
+ "processing",
+ "processed",
+ "failed",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "EditableTxProp": {
+ "enum": [
+ "logo",
+ "website",
+ "merchant",
+ "merchant_id",
+ "location",
+ "person",
+ "transaction_type",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "EnrichedTransaction": {
+ "docs": undefined,
+ "properties": {
+ "categories": {
+ "type": "optional",
+ },
+ "created_at": {
+ "docs": "The timestamp of when the account holder was created.",
+ "type": "datetime",
+ },
+ "entities": {
+ "type": "optional",
+ },
+ "error": {
+ "type": "optional",
+ },
+ "id": {
+ "docs": "A unique identifier for the transaction. If two transactions are submitted with the same `id` the most recent one will replace the previous one.",
+ "type": "string",
+ "validation": {
+ "format": undefined,
+ "maxLength": undefined,
+ "minLength": 1,
+ "pattern": undefined,
+ },
+ },
+ "location": {
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "EnrichmentResult": {
+ "docs": undefined,
+ "properties": {
+ "transactions": {
+ "docs": "A list of enriched transactions resulting from the enrichment of this batch.",
+ "type": "list",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Entities": {
+ "docs": "Entities found by identity identification",
+ "properties": {
+ "counterparty": {
+ "type": "optional",
+ },
+ "intermediaries": {
+ "type": "optional>",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Entity": {
+ "docs": undefined,
+ "properties": {
+ "id": {
+ "docs": "The unique UUID identifier of the entity",
+ "type": "optional",
+ },
+ "logo": {
+ "docs": "Logo's URL",
+ "type": "optional",
+ },
+ "mccs": {
+ "docs": "A list of [Merchant Category Codes](https://en.wikipedia.org/wiki/Merchant_category_code)",
+ "type": "optional>",
+ },
+ "name": {
+ "docs": "The name of the entity",
+ "type": "optional",
+ },
+ "website": {
+ "docs": "The website URL of the entity",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "EntryType": {
+ "docs": "An enumeration.",
+ "enum": [
+ "incoming",
+ "outgoing",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Filter": {
+ "type": "list",
+ },
+ "FilterModel": {
+ "type": "Filter",
+ },
+ "FnCall": {
+ "discriminated": false,
+ "docs": undefined,
+ "encoding": undefined,
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ "union": [
+ {
+ "type": "FnCall&&",
+ },
+ {
+ "type": "FnCall||",
+ },
+ {
+ "type": "FnCall==",
+ },
+ {
+ "type": "FnCall+",
+ },
+ {
+ "type": "FnCall-",
+ },
+ {
+ "type": "FnCall*",
+ },
+ {
+ "type": "FnCall/",
+ },
+ {
+ "type": "FnCall//",
+ },
+ {
+ "type": "FnCall<",
+ },
+ {
+ "type": "FnCall<=",
+ },
+ {
+ "type": "FnCall>",
+ },
+ {
+ "type": "FnCall>=",
+ },
+ {
+ "type": "FnCall!",
+ },
+ {
+ "type": "FnCallIsSubstring",
+ },
+ {
+ "type": "FnCallStartsWith",
+ },
+ {
+ "type": "FnCallEndsWith",
+ },
+ {
+ "type": "FnCallToLower",
+ },
+ {
+ "type": "FnCallToUpper",
+ },
+ {
+ "type": "FnCallHasLabel",
+ },
+ {
+ "type": "FnCallHasMcc",
+ },
+ {
+ "type": "FnCallGet",
+ },
+ ],
+ },
+ "FnCall!": {
+ "docs": undefined,
+ "properties": {
+ "!": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall&&": {
+ "docs": undefined,
+ "properties": {
+ "&&": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall*": {
+ "docs": undefined,
+ "properties": {
+ "*": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall+": {
+ "docs": undefined,
+ "properties": {
+ "+": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall-": {
+ "docs": undefined,
+ "properties": {
+ "-": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall/": {
+ "docs": undefined,
+ "properties": {
+ "/": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall//": {
+ "docs": undefined,
+ "properties": {
+ "//": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall<": {
+ "docs": undefined,
+ "properties": {
+ "<": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall<=": {
+ "docs": undefined,
+ "properties": {
+ "<=": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall==": {
+ "docs": undefined,
+ "properties": {
+ "==": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall>": {
+ "docs": undefined,
+ "properties": {
+ ">": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall>=": {
+ "docs": undefined,
+ "properties": {
+ ">=": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallEndsWith": {
+ "docs": undefined,
+ "properties": {
+ "ends_with": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallGet": {
+ "docs": undefined,
+ "properties": {
+ "get": {
+ "type": "properties",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallHasLabel": {
+ "docs": undefined,
+ "properties": {
+ "has_label": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallHasMcc": {
+ "docs": undefined,
+ "properties": {
+ "has_mcc": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallIsSubstring": {
+ "docs": undefined,
+ "properties": {
+ "is_substring": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallStartsWith": {
+ "docs": undefined,
+ "properties": {
+ "starts_with": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallToLower": {
+ "docs": undefined,
+ "properties": {
+ "to_lower": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCallToUpper": {
+ "docs": undefined,
+ "properties": {
+ "to_upper": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "FnCall||": {
+ "docs": undefined,
+ "properties": {
+ "||": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "HTTPValidationError": {
+ "docs": undefined,
+ "properties": {
+ "detail": {
+ "type": "optional>",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Intermediary": {
+ "docs": undefined,
+ "properties": {
+ "id": {
+ "docs": "The unique UUID identifier of the entity",
+ "type": "optional",
+ },
+ "logo": {
+ "docs": "Logo's URL",
+ "type": "optional",
+ },
+ "mccs": {
+ "docs": "A list of [Merchant Category Codes](https://en.wikipedia.org/wiki/Merchant_category_code)",
+ "type": "optional>",
+ },
+ "name": {
+ "docs": "The name of the entity",
+ "type": "optional",
+ },
+ "type": {
+ "type": "IntermediaryType",
+ },
+ "website": {
+ "docs": "The website URL of the entity",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "IntermediaryType": {
+ "docs": "An enumeration.",
+ "enum": [
+ "delivery_service",
+ "payment_processor",
+ ],
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "Location": {
+ "docs": undefined,
+ "properties": {
+ "raw_address": {
+ "docs": "An unstructured string containing the address",
+ "type": "optional",
+ },
+ "structured": {
+ "docs": "When raw is set, a structured representation of it.",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "LocationInput": {
+ "docs": "Location of where the transaction has taken place. This can greatly improve entity identification, especially
+under ambiguity.",
+ "properties": {
+ "country": {
+ "docs": "The country where the transaction was made in ISO 3166-2 format",
+ "type": "Country",
+ },
+ "raw_address": {
+ "docs": "An unstructured string containing the address",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "LocationStructured": {
+ "docs": undefined,
+ "properties": {
+ "apple_maps_url": {
+ "docs": "A URL link to view the location on Apple Maps",
+ "type": "optional",
+ },
+ "city": {
+ "docs": "The city where the location is situated",
+ "type": "optional",
+ },
+ "country": {
+ "docs": "The full name of the country",
+ "type": "optional",
+ },
+ "country_code": {
+ "docs": "The country code of the location in ISO 3166-2 format",
+ "type": "optional",
+ },
+ "google_maps_url": {
+ "docs": "A URL link to view the location on Google Maps",
+ "type": "optional",
+ },
+ "latitude": {
+ "docs": "The latitude coordinate of the location",
+ "type": "optional",
+ },
+ "longitude": {
+ "docs": "The longitude coordinate of the location",
+ "type": "optional",
+ },
+ "postcode": {
+ "docs": "The postal code or ZIP code of the location",
+ "type": "optional",
+ },
+ "state": {
+ "docs": "The state or region of the location",
+ "type": "optional",
+ },
+ "store_number": {
+ "docs": "A unique identifier for a specific store or branch, if applicable",
+ "type": "optional",
+ },
+ "street": {
+ "docs": "The street name and number of the location",
+ "type": "optional",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabels": {
+ "discriminated": false,
+ "docs": undefined,
+ "encoding": undefined,
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ "union": [
+ {
+ "type": "ModifyLabelsAddLabel",
+ },
+ {
+ "type": "ModifyLabelsRemoveLabel",
+ },
+ {
+ "type": "ModifyLabelsSetLabels",
+ },
+ {
+ "type": "ModifyLabelsAddMcc",
+ },
+ {
+ "type": "ModifyLabelsRemoveMcc",
+ },
+ {
+ "type": "ModifyLabelsSetMcc",
+ },
+ ],
+ },
+ "ModifyLabelsAddLabel": {
+ "docs": undefined,
+ "properties": {
+ "add_label": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabelsAddMcc": {
+ "docs": undefined,
+ "properties": {
+ "add_mcc": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabelsRemoveLabel": {
+ "docs": undefined,
+ "properties": {
+ "remove_label": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabelsRemoveMcc": {
+ "docs": undefined,
+ "properties": {
+ "remove_mcc": {
+ "type": "expression",
+ },
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabelsSetLabels": {
+ "docs": undefined,
+ "properties": {
+ "set_labels": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "ModifyLabelsSetMcc": {
+ "docs": undefined,
+ "properties": {
+ "set_mcc": "list",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "PagedResponseAccountHolderExternal": {
+ "docs": undefined,
+ "properties": {
+ "data": {
+ "type": "list",
+ },
+ "next_cursor": "string",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "PagedResponseBankStatement": {
+ "docs": undefined,
+ "properties": {
+ "data": {
+ "type": "list",
+ },
+ "next_cursor": "string",
+ },
+ "source": {
+ "openapi": "../openapi.yml",
+ },
+ },
+ "PagedResponseBatch": {
+ "docs": undefined,
+ "properties": {
+ "data": {
+ "type": "list 
-
+ 