diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 0cd530c8..bcc04be6 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.423.5 +speakeasyVersion: 1.431.0 sources: accounting-source: sourceNamespace: accounting-source @@ -9,8 +9,8 @@ sources: - main bank-feeds-source: sourceNamespace: bank-feeds-source - sourceRevisionDigest: sha256:4e8af09e166edeb95d268f2c1bb0d9d33401e55f5a50aedebbb6465dd005566f - sourceBlobDigest: sha256:24d837ec7ccccb55559e6de16951a64c09874b48e5ca92b7af36ea0b95b0eac2 + sourceRevisionDigest: sha256:a6479feafb8f4f49461fb9347578ab34619bcba818605cb5ab74f241dc1eb328 + sourceBlobDigest: sha256:a490b555d6f186cd37f72a06e06ba49293a0f371d145db2d9913d5081ecfc5a2 tags: - latest - main @@ -72,8 +72,8 @@ targets: bank-feeds-library: source: bank-feeds-source sourceNamespace: bank-feeds-source - sourceRevisionDigest: sha256:4e8af09e166edeb95d268f2c1bb0d9d33401e55f5a50aedebbb6465dd005566f - sourceBlobDigest: sha256:24d837ec7ccccb55559e6de16951a64c09874b48e5ca92b7af36ea0b95b0eac2 + sourceRevisionDigest: sha256:a6479feafb8f4f49461fb9347578ab34619bcba818605cb5ab74f241dc1eb328 + sourceBlobDigest: sha256:a490b555d6f186cd37f72a06e06ba49293a0f371d145db2d9913d5081ecfc5a2 banking-library: source: banking-source sourceNamespace: banking-source diff --git a/bank-feeds/.speakeasy/gen.lock b/bank-feeds/.speakeasy/gen.lock index 9e6970b3..9958f563 100755 --- a/bank-feeds/.speakeasy/gen.lock +++ b/bank-feeds/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 1f92decd-6f40-4ee5-936f-9c85d706eb7e management: - docChecksum: 013890de98917d65fc592f4de8d32cf4 + docChecksum: c57bceaa5f2d5b6d55426976a49ec69d docVersion: 3.0.0 - speakeasyVersion: 1.396.7 - generationVersion: 2.415.6 - releaseVersion: 0.2.0 - configChecksum: 685ec54060496b7b1b5d96b3e495642c + speakeasyVersion: 1.431.0 + generationVersion: 2.451.0 + releaseVersion: 1.0.0 + configChecksum: e9dddd187545257ee4cbe11d552f73a9 repoURL: https://github.com/codatio/client-sdk-java.git repoSubDirectory: bank-feeds published: true @@ -14,7 +14,7 @@ features: java: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.1 - core: 3.29.7 + core: 3.30.7 decimal: 0.0.1 deprecations: 2.81.1 examples: 2.81.3 @@ -27,7 +27,8 @@ features: nullables: 0.1.0 retries: 0.1.1 sdkHooks: 0.1.0 - unions: 0.0.5 + tests: 0.1.0 + unions: 0.0.6 webhooks: 1.0.0 generatedFiles: - .gitattributes @@ -63,6 +64,8 @@ generatedFiles: - docs/models/components/Companies.md - docs/models/components/Company.md - docs/models/components/CompanyInformation.md + - docs/models/components/CompanyReference.md + - docs/models/components/CompanyReferenceLinks.md - docs/models/components/CompanyRequestBody.md - docs/models/components/CompanySyncStatus.md - docs/models/components/Configuration.md @@ -80,7 +83,6 @@ generatedFiles: - docs/models/components/ErrorStatus.md - docs/models/components/ErrorValidation.md - docs/models/components/ErrorValidationItem.md - - docs/models/components/GroupReference.md - docs/models/components/HalRef.md - docs/models/components/Links.md - docs/models/components/Metadata.md @@ -109,7 +111,6 @@ generatedFiles: - docs/models/components/SyncAsBankFeeds.md - docs/models/components/SyncAsExpenses.md - docs/models/components/SyncConfiguration.md - - docs/models/components/Tags.md - docs/models/components/TargetAccountOption.md - docs/models/components/Type.md - docs/models/components/Validation.md @@ -165,6 +166,7 @@ generatedFiles: - docs/models/operations/ListCreateOperationsResponse.md - docs/models/operations/ListSourceAccountsRequest.md - docs/models/operations/ListSourceAccountsResponse.md + - docs/models/operations/ListSourceAccountsResponseBody.md - docs/models/operations/SetConfigurationRequest.md - docs/models/operations/SetConfigurationResponse.md - docs/models/operations/UnlinkConnectionRequest.md @@ -236,6 +238,8 @@ generatedFiles: - src/main/java/io/codat/bank_feeds/models/components/Companies.java - src/main/java/io/codat/bank_feeds/models/components/Company.java - src/main/java/io/codat/bank_feeds/models/components/CompanyInformation.java + - src/main/java/io/codat/bank_feeds/models/components/CompanyReference.java + - src/main/java/io/codat/bank_feeds/models/components/CompanyReferenceLinks.java - src/main/java/io/codat/bank_feeds/models/components/CompanyRequestBody.java - src/main/java/io/codat/bank_feeds/models/components/CompanySyncStatus.java - src/main/java/io/codat/bank_feeds/models/components/Configuration.java @@ -253,7 +257,6 @@ generatedFiles: - src/main/java/io/codat/bank_feeds/models/components/ErrorStatus.java - src/main/java/io/codat/bank_feeds/models/components/ErrorValidation.java - src/main/java/io/codat/bank_feeds/models/components/ErrorValidationItem.java - - src/main/java/io/codat/bank_feeds/models/components/GroupReference.java - src/main/java/io/codat/bank_feeds/models/components/HalRef.java - src/main/java/io/codat/bank_feeds/models/components/Links.java - src/main/java/io/codat/bank_feeds/models/components/Metadata.java @@ -282,7 +285,6 @@ generatedFiles: - src/main/java/io/codat/bank_feeds/models/components/SyncAsBankFeeds.java - src/main/java/io/codat/bank_feeds/models/components/SyncAsExpenses.java - src/main/java/io/codat/bank_feeds/models/components/SyncConfiguration.java - - src/main/java/io/codat/bank_feeds/models/components/Tags.java - src/main/java/io/codat/bank_feeds/models/components/TargetAccountOption.java - src/main/java/io/codat/bank_feeds/models/components/Type.java - src/main/java/io/codat/bank_feeds/models/components/Validation.java @@ -364,6 +366,7 @@ generatedFiles: - src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequest.java - src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequestBuilder.java - src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponse.java + - src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponseBody.java - src/main/java/io/codat/bank_feeds/models/operations/SDKMethodInterfaces.java - src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequest.java - src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequestBuilder.java @@ -425,14 +428,14 @@ examples: create-company: With no description: requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Technicalium"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Technicalium"} responses: "200": application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0"} "400": {} With a description: requestBody: - application/json: {"description": "Technology services, including web and app design and development", "groups": [], "name": "Technicalium"} + application/json: {"description": "Technology services, including web and app design and development", "name": "Technicalium"} responses: "200": application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "Technology services, including web and app design and development", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0"} @@ -446,10 +449,16 @@ examples: "400": {} Malformed query: requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Bank of Dave"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} responses: "400": application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400} + With a tag: + requestBody: + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} + responses: + "200": + application/json: {"created": "2022-11-10T10:45:18.1950523Z", "createdByUserName": "Dan Tzabar", "dataConnections": [], "description": "", "id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0", "lastSync": "2022-10-23T00:00:00Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0", "tags": {"region": "us"}} delete-company: Unauthorized: parameters: @@ -501,7 +510,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "My Test Company make testing software", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "name": "My Test Company", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "totalResults": 1} + application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "My Test Company make testing software", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "lastSync": "2022-01-01T12:30:00.000Z", "name": "My Test Company", "redirect": "https://link.codat.io/company/3fa85f64-5717-4562-b3fc-2c963f66afa6"}], "totalResults": 1} List of Companies: parameters: query: @@ -511,7 +520,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "Technology services, including web and app design and development", "id": "d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002"}, {"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [], "id": "a70bc148-dc21-46b2-a257-d9c58ac15cbb", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/096db70b-78de-4ff0-aa98-299cb5fe17a0/connections/a70bc148-dc21-46b2-a257-d9c58ac15cbb/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "A new digital agency with a passion for creating amazing digital experiences", "id": "096db70b-78de-4ff0-aa98-299cb5fe17a0", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Godata", "redirect": "https://link.codat.io/company/096db70b-78de-4ff0-aa98-299cb5fe17a0"}], "totalResults": 2} + application/json: {"_links": {"current": {"href": "/companies?page=1&pageSize=100"}, "self": {"href": "/companies"}}, "pageNumber": 1, "pageSize": 100, "results": [{"created": "2022-01-01T11:30:00Z", "createdByUserName": "Joe Bloggs", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "51baa045-4836-4317-a42e-3542e991e581", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/d1568dde-adf6-11ed-afa1-0242ac120002/connections/51baa045-4836-4317-a42e-3542e991e581/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "Technology services, including web and app design and development", "id": "d1568dde-adf6-11ed-afa1-0242ac120002", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Technicalium", "redirect": "https://link.codat.io/company/d1568dde-adf6-11ed-afa1-0242ac120002"}, {"created": "2022-01-01T11:30:00Z", "createdByUserName": "Mike Smith", "dataConnections": [{"created": "2022-01-01T11:30:00Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "a70bc148-dc21-46b2-a257-d9c58ac15cbb", "integrationId": "1c312d69-e638-46d4-ad31-72e6c3ba8390", "integrationKey": "vjms", "lastSync": "2022-01-01T12:30:00.000Z", "linkUrl": "https://link-api.codat.io/companies/096db70b-78de-4ff0-aa98-299cb5fe17a0/connections/a70bc148-dc21-46b2-a257-d9c58ac15cbb/start", "platformName": "Pandle", "sourceId": "396c3158-5dd7-481b-a7c4-a795ca31792b", "sourceType": "Accounting", "status": "Linked"}], "description": "A new digital agency with a passion for creating amazing digital experiences", "id": "096db70b-78de-4ff0-aa98-299cb5fe17a0", "lastSync": "2022-01-01T12:30:00.000Z", "name": "Godata", "redirect": "https://link.codat.io/company/096db70b-78de-4ff0-aa98-299cb5fe17a0"}], "totalResults": 2} Malformed query: parameters: query: @@ -538,27 +547,27 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "New Name"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "New Name"} responses: "200": - application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739"} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} "401": {} Update description: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Additional documents required", "groups": [], "name": "Same name"} + application/json: {"description": "Additional documents required", "name": "Same name"} responses: "200": - application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739"} + application/json: {"created": "2022-01-01T12:00:00.000Z", "createdByUserName": "string", "dataConnections": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "description": "Requested early access to the new financing scheme.", "id": "0498e921-9b53-4396-a412-4f2f5983b0a2", "lastSync": "2022-01-01T12:00:00.000Z", "name": "string", "redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739", "tags": {"region": "us", "uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"}} "401": {} Unauthorized: parameters: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" requestBody: - application/json: {"description": "Requested early access to the new financing scheme.", "groups": [], "name": "Bank of Dave"} + application/json: {"description": "Requested early access to the new financing scheme.", "name": "Bank of Dave"} responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} @@ -632,7 +641,7 @@ examples: orderBy: "-modifiedDate" responses: "200": - application/json: {"_links": {"current": {"href": "string"}, "next": {"href": "string"}, "previous": {"href": "string"}, "self": {"href": "string"}}, "pageNumber": 0, "pageSize": 0, "results": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "totalResults": 0} + application/json: {"_links": {"current": {"href": "string"}, "next": {"href": "string"}, "previous": {"href": "string"}, "self": {"href": "string"}}, "pageNumber": 0, "pageSize": 0, "results": [{"created": "2022-10-27T09:53:29Z", "dataConnectionErrors": [{"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}, {"erroredOnUtc": "2022-10-23T00:00:00Z", "resolvedOnUtc": "2022-10-23T00:00:00Z"}], "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd", "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c", "integrationKey": "dfxm", "lastSync": "2022-10-27T10:22:43.6464237Z", "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start", "platformName": "Basiq", "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee", "sourceType": "Banking", "status": "Linked"}], "totalResults": 0} Malformed query: parameters: path: @@ -688,6 +697,17 @@ examples: responses: "400": application/json: {"canBeRetried": "Unknown", "correlationId": "bc997528a9d7abb9161ef45f05d38599", "detailedErrorCode": 0, "error": "Error processing request - not valid.", "service": "PublicApi", "statusCode": 400} + Example: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + requestBody: + application/json: {"sourceAccountId": "acc-002", "targetAccountId": "account-081"} + responses: + "200": + application/json: {"error": "A feed connection already exists to this account", "sourceAccountId": "acc-002", "status": "Failed", "targetAccountId": "account-081"} + "400": {} get-bank-account-mapping: Unauthorized: parameters: @@ -697,6 +717,14 @@ examples: responses: "401": application/json: {"canBeRetried": "Unknown", "correlationId": "7eb40d6b415d7bcd99ce658268284056", "detailedErrorCode": 0, "error": "Unauthorized", "service": "PublicApi", "statusCode": 401} + Example: + parameters: + path: + companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" + connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" + responses: + "200": + application/json: [{"feedStartDate": "2022-10-23T00:00:00Z", "sourceAccountId": "account-001", "sourceAccountName": "account-001", "sourceAccountNumber": "12345670", "sourceBalance": "99.99", "sourceCurrency": "GBP", "status": "pending", "targetAccountOptions": [{"accountNumber": "789", "id": "d21e25d6-98c5-4bfb-b469-105833bea3c8", "name": "Money Bank account", "sortCode": "123456"}, {"accountNumber": "99887766", "id": "d06ff4b2-e4f2-4681-9841-014bd008cdab", "name": "Bank of Dave account", "sortCode": "998866"}, {"accountNumber": "123456789", "id": "c8f252fc-84f3-4a8b-ace8-ae99f41a81ae", "name": "LuxLend account", "sortCode": "123456"}]}] get-company-information: Malformed query: parameters: @@ -1090,7 +1118,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - accountId: "EILBDVJVNUAGVKRQ" + accountId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" query: {} requestBody: application/json: {"accountId": "49cd5a42-b311-4750-9361-52e2ed1d4653", "transactions": [{"amount": 100, "balance": -999.99, "counterparty": "ACME INC", "date": "2023-08-22T10:21:00Z", "description": "Repayment of Credit Card", "id": "716422529", "reconciled": false, "reference": "reference for transaction", "transactionType": "Credit"}, {"amount": -100, "balance": -999.99, "counterparty": "ACME INC", "date": "2023-08-22T10:22:00Z", "description": "Amazon Purchase", "id": "716422530", "reconciled": false, "reference": "reference for transaction", "transactionType": "Debit"}, {"amount": -60, "balance": -999.99, "counterparty": "ACME INC", "date": "2023-08-22T10:23:00Z", "description": "Office Supplies", "id": "716422531", "reconciled": false, "reference": "reference for transaction", "transactionType": "Debit"}]} @@ -1103,7 +1131,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - accountId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + accountId: "13d946f0-c5d5-42bc-b092-97ece17923ab" query: {} requestBody: application/json: {"accountId": "49cd5a42-b311-4750-9361-52e2ed1d4653", "transactions": [{"amount": 100, "balance": 100, "counterparty": "Bank of Example", "date": "2023-08-22T10:21:00Z", "description": "Repayment of Credit Card", "id": "716422529", "reconciled": false, "reference": "Ref-12345", "transactionType": "Credit"}, {"amount": -100, "balance": 0, "counterparty": "Amazon", "date": "2023-08-22T10:22:00Z", "description": "Amazon Purchase", "id": "716422530", "reconciled": false, "reference": "Ref-12346", "transactionType": "Debit"}, {"amount": -60, "balance": -60, "counterparty": "Office Mart", "date": "2023-08-22T10:23:00Z", "description": "Office Supplies", "id": "716422531", "reconciled": false, "reference": "Ref-12347", "transactionType": "Debit"}]} @@ -1116,7 +1144,7 @@ examples: path: companyId: "8a210b68-6988-11ed-a1eb-0242ac120002" connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171" - accountId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2" + accountId: "13d946f0-c5d5-42bc-b092-97ece17923ab" query: {} requestBody: application/json: {"accountId": "7110701885", "transactions": []} diff --git a/bank-feeds/.speakeasy/gen.yaml b/bank-feeds/.speakeasy/gen.yaml index 624e0255..0b317518 100644 --- a/bank-feeds/.speakeasy/gen.yaml +++ b/bank-feeds/.speakeasy/gen.yaml @@ -9,9 +9,10 @@ generation: requestResponseComponentNamesFeb2024: false auth: oAuth2ClientCredentialsEnabled: false + oAuth2PasswordEnabled: false telemetryEnabled: true java: - version: 0.2.0 + version: 1.0.0 additionalDependencies: [] additionalPlugins: [] artifactID: bank-feeds diff --git a/bank-feeds/README.md b/bank-feeds/README.md index 6c02fa78..b6768827 100644 --- a/bank-feeds/README.md +++ b/bank-feeds/README.md @@ -51,7 +51,7 @@ The samples below show how a published SDK artifact is used: Gradle: ```groovy -implementation 'io.codat:bank-feeds:0.2.0' +implementation 'io.codat:bank-feeds:1.0.0' ``` Maven: @@ -59,7 +59,7 @@ Maven: io.codat bank-feeds - 0.2.0 + 1.0.0 ``` @@ -89,47 +89,30 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -144,7 +127,7 @@ public class Application { ### [accountMapping()](docs/sdks/accountmapping/README.md) * [create](docs/sdks/accountmapping/README.md#create) - Create bank feed account mapping -* [get](docs/sdks/accountmapping/README.md#get) - List bank feed account mappings +* [get](docs/sdks/accountmapping/README.md#get) - List bank feed accounts ### [bankAccounts()](docs/sdks/bankaccounts/README.md) @@ -211,33 +194,27 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import io.codat.bank_feeds.utils.BackoffStrategy; import io.codat.bank_feeds.utils.RetryConfig; import java.lang.Exception; -import java.util.List; import java.util.concurrent.TimeUnit; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .retryConfig(RetryConfig.builder() .backoff(BackoffStrategy.builder() @@ -251,20 +228,9 @@ public class Application { .build()) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -275,20 +241,18 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import io.codat.bank_feeds.utils.BackoffStrategy; import io.codat.bank_feeds.utils.RetryConfig; import java.lang.Exception; -import java.util.List; import java.util.concurrent.TimeUnit; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .retryConfig(RetryConfig.builder() .backoff(BackoffStrategy.builder() .initialInterval(1L, TimeUnit.MILLISECONDS) @@ -300,35 +264,20 @@ public class Application { .build()) .build()) .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -337,12 +286,14 @@ public class Application { ## Error Handling -Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Exception type. +Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception. -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +By default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create` method throws the following exceptions: + +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ### Example @@ -351,47 +302,30 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -415,48 +349,31 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .serverIndex(0) .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -470,48 +387,31 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .serverURL("https://api.codat.io") .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -534,47 +434,30 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` diff --git a/bank-feeds/RELEASES.md b/bank-feeds/RELEASES.md index 1e8f1a62..9132d6b4 100644 --- a/bank-feeds/RELEASES.md +++ b/bank-feeds/RELEASES.md @@ -18,4 +18,14 @@ Based on: ### Generated - [java v0.2.0] bank-feeds ### Releases -- [Maven Central v0.2.0] https://central.sonatype.com/artifact/io.codat/bank-feeds/0.2.0 - bank-feeds \ No newline at end of file +- [Maven Central v0.2.0] https://central.sonatype.com/artifact/io.codat/bank-feeds/0.2.0 - bank-feeds + +## 2024-11-06 14:34:00 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.431.0 (2.451.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [java v1.0.0] bank-feeds +### Releases +- [Maven Central v1.0.0] https://central.sonatype.com/artifact/io.codat/bank-feeds/1.0.0 - bank-feeds \ No newline at end of file diff --git a/bank-feeds/USAGE.md b/bank-feeds/USAGE.md index 61bc9fd3..565deaa9 100644 --- a/bank-feeds/USAGE.md +++ b/bank-feeds/USAGE.md @@ -4,47 +4,30 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` diff --git a/bank-feeds/build.gradle b/bank-feeds/build.gradle index e28b1438..502cecba 100644 --- a/bank-feeds/build.gradle +++ b/bank-feeds/build.gradle @@ -63,7 +63,7 @@ tasks.withType(Javadoc) { } group = "io.codat" -version = "0.2.0" +version = "1.0.0" sourcesJar { archiveBaseName = "bank-feeds" @@ -101,7 +101,7 @@ publishing { maven(MavenPublication) { groupId = 'io.codat' artifactId = 'bank-feeds' - version = '0.2.0' + version = '1.0.0' from components.java diff --git a/bank-feeds/docs/models/components/AccountInfo.md b/bank-feeds/docs/models/components/AccountInfo.md index 2d75d35a..f680aeb1 100644 --- a/bank-feeds/docs/models/components/AccountInfo.md +++ b/bank-feeds/docs/models/components/AccountInfo.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountOpenDate` | *JsonNullable* | :heavy_minus_sign: | In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
```
2020-10-08
``` | 2022-10-23 | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Balance of funds available for use. This includes pending activity. | | -| `description` | *JsonNullable* | :heavy_minus_sign: | Description of the account. | | -| `nickname` | *JsonNullable* | :heavy_minus_sign: | Name given to the account by the user. Used in UIs to assist in account selection. | | \ No newline at end of file +| `accountOpenDate` | *JsonNullable\* | :heavy_minus_sign: | In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
```
2020-10-08
``` | 2022-10-23 | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Balance of funds available for use. This includes pending activity. | | +| `description` | *JsonNullable\* | :heavy_minus_sign: | Description of the account. | | +| `nickname` | *JsonNullable\* | :heavy_minus_sign: | Name given to the account by the user. Used in UIs to assist in account selection. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/AccountingBankAccount.md b/bank-feeds/docs/models/components/AccountingBankAccount.md index 8872012f..0225c76a 100644 --- a/bank-feeds/docs/models/components/AccountingBankAccount.md +++ b/bank-feeds/docs/models/components/AccountingBankAccount.md @@ -4,9 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/bank-feeds-api#/schemas/Account) - -> View the coverage for bank accounts in the Data coverage explorer. +> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/bank-feeds-api#/schemas/Account) data type. ## Overview @@ -24,20 +22,20 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `accountType` | [Optional](../../models/components/BankAccountCreateResponseBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | Balance of the bank account. | | -| `currency` | *Optional* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `iBan` | *JsonNullable* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | -| `institution` | *JsonNullable* | :heavy_minus_sign: | The institution of the bank account. | | -| `metadata` | [Optional](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | -| `overdraftLimit` | *JsonNullable* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [Optional](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | -| `supplementalData` | [Optional](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | +| `accountType` | [Optional\](../../models/components/BankAccountCreateResponseBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | Balance of the bank account. | | +| `currency` | *Optional\* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | +| `iBan` | *JsonNullable\* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | +| `institution` | *JsonNullable\* | :heavy_minus_sign: | The institution of the bank account. | | +| `metadata` | [Optional\](../../models/components/Metadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | +| `overdraftLimit` | *JsonNullable\* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional\](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | +| `supplementalData` | [Optional\](../../models/components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountCreateResponse.md b/bank-feeds/docs/models/components/BankAccountCreateResponse.md index 5e5736a3..2d351027 100644 --- a/bank-feeds/docs/models/components/BankAccountCreateResponse.md +++ b/bank-feeds/docs/models/components/BankAccountCreateResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `data` | [JsonNullable](../../models/components/AccountingBankAccount.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `data` | [JsonNullable\](../../models/components/AccountingBankAccount.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountCredentials.md b/bank-feeds/docs/models/components/BankAccountCredentials.md index 17a0f24b..71915677 100644 --- a/bank-feeds/docs/models/components/BankAccountCredentials.md +++ b/bank-feeds/docs/models/components/BankAccountCredentials.md @@ -7,5 +7,5 @@ Result of generate credentials | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `password` | *Optional* | :heavy_minus_sign: | Password to enable the bank feeds platform to securely retrieve transactions. | cO0ajh0uGyTN0Pwh | -| `username` | *Optional* | :heavy_minus_sign: | Username used by the bank feeds platform to retrieve transactions | S0MW-TR0P-7DS0 | \ No newline at end of file +| `password` | *Optional\* | :heavy_minus_sign: | Password to enable the bank feeds platform to securely retrieve transactions. | cO0ajh0uGyTN0Pwh | +| `username` | *Optional\* | :heavy_minus_sign: | Username used by the bank feeds platform to retrieve transactions | S0MW-TR0P-7DS0 | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountOption.md b/bank-feeds/docs/models/components/BankAccountOption.md index 5aea02bc..70c28288 100644 --- a/bank-feeds/docs/models/components/BankAccountOption.md +++ b/bank-feeds/docs/models/components/BankAccountOption.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `accountType` | *Optional* | :heavy_minus_sign: | The type of account. | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the bank account. | -| `name` | *Optional* | :heavy_minus_sign: | Name of bank account. | \ No newline at end of file +| `accountType` | *Optional\* | :heavy_minus_sign: | The type of account. | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for the bank account. | +| `name` | *Optional\* | :heavy_minus_sign: | Name of bank account. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountPrototype.md b/bank-feeds/docs/models/components/BankAccountPrototype.md index f2f782ee..a969c1b8 100644 --- a/bank-feeds/docs/models/components/BankAccountPrototype.md +++ b/bank-feeds/docs/models/components/BankAccountPrototype.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `accountType` | [Optional](../../models/components/BankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | Balance of the bank account. | | -| `currency` | *Optional* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `iBan` | *JsonNullable* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `institution` | *JsonNullable* | :heavy_minus_sign: | The institution of the bank account. | | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | -| `overdraftLimit` | *JsonNullable* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `status` | [Optional](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | \ No newline at end of file +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | +| `accountType` | [Optional\](../../models/components/BankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | Balance of the bank account. | | +| `currency` | *Optional\* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | +| `iBan` | *JsonNullable\* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | +| `institution` | *JsonNullable\* | :heavy_minus_sign: | The institution of the bank account. | | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | +| `overdraftLimit` | *JsonNullable\* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | +| `status` | [Optional\](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccounts.md b/bank-feeds/docs/models/components/BankAccounts.md index 4e594bda..cb3ef8e8 100644 --- a/bank-feeds/docs/models/components/BankAccounts.md +++ b/bank-feeds/docs/models/components/BankAccounts.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | -| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | -| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[BankAccountsAccountingBankAccount](../../models/components/BankAccountsAccountingBankAccount.md)> | :heavy_minus_sign: | N/A | | -| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | +| `results` | List\<[BankAccountsAccountingBankAccount](../../models/components/BankAccountsAccountingBankAccount.md)> | :heavy_minus_sign: | N/A | | +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountsAccountingBankAccount.md b/bank-feeds/docs/models/components/BankAccountsAccountingBankAccount.md index 768678ce..a1653c90 100644 --- a/bank-feeds/docs/models/components/BankAccountsAccountingBankAccount.md +++ b/bank-feeds/docs/models/components/BankAccountsAccountingBankAccount.md @@ -4,9 +4,7 @@ > > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. > -> To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/bank-feeds-api#/schemas/Account) - -> View the coverage for bank accounts in the Data coverage explorer. +> To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/bank-feeds-api#/schemas/Account) data type. ## Overview @@ -22,20 +20,20 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | -| `accountType` | [Optional](../../models/components/BankAccountsBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | -| `availableBalance` | *JsonNullable* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | Balance of the bank account. | | -| `currency` | *Optional* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `iBan` | *JsonNullable* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `id` | *Optional* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | -| `institution` | *JsonNullable* | :heavy_minus_sign: | The institution of the bank account. | | -| `metadata` | [Optional](../../models/components/BankAccountsMetadata.md) | :heavy_minus_sign: | N/A | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `nominalCode` | *JsonNullable* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | -| `overdraftLimit` | *JsonNullable* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | -| `sourceModifiedDate` | *Optional* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [Optional](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | -| `supplementalData` | [Optional](../../models/components/BankAccountsSupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | Account number for the bank account.

Xero integrations
Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.

FreeAgent integrations
For Credit accounts, only the last four digits are required. For other types, the field is optional. | | +| `accountType` | [Optional\](../../models/components/BankAccountsBankAccountType.md) | :heavy_minus_sign: | The type of transactions and balances on the account.
For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
For Debit accounts, positive balances are assets, and positive transactions **increase** assets. | | +| `availableBalance` | *JsonNullable\* | :heavy_minus_sign: | Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | Balance of the bank account. | | +| `currency` | *Optional\* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | +| `iBan` | *JsonNullable\* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | +| `id` | *Optional\* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | +| `institution` | *JsonNullable\* | :heavy_minus_sign: | The institution of the bank account. | | +| `metadata` | [Optional\](../../models/components/BankAccountsMetadata.md) | :heavy_minus_sign: | N/A | | +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `nominalCode` | *JsonNullable\* | :heavy_minus_sign: | Code used to identify each nominal account for a business. | | +| `overdraftLimit` | *JsonNullable\* | :heavy_minus_sign: | Pre-arranged overdraft limit of the account.

The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`. | | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | Sort code for the bank account.

Xero integrations
The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. | | +| `sourceModifiedDate` | *Optional\* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [Optional\](../../models/components/BankAccountStatus.md) | :heavy_minus_sign: | Status of the bank account. | Active | +| `supplementalData` | [Optional\](../../models/components/BankAccountsSupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountsMetadata.md b/bank-feeds/docs/models/components/BankAccountsMetadata.md index b5c1c169..c8cab399 100644 --- a/bank-feeds/docs/models/components/BankAccountsMetadata.md +++ b/bank-feeds/docs/models/components/BankAccountsMetadata.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `isDeleted` | *JsonNullable* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file +| `isDeleted` | *JsonNullable\* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankAccountsSupplementalData.md b/bank-feeds/docs/models/components/BankAccountsSupplementalData.md index dceb3cc2..24c4a4d3 100644 --- a/bank-feeds/docs/models/components/BankAccountsSupplementalData.md +++ b/bank-feeds/docs/models/components/BankAccountsSupplementalData.md @@ -7,6 +7,6 @@ It is referenced as a configured dynamic key value pair that is unique to the ac ## Fields -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `content` | Map> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `content` | Map\> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankFeedAccountMapping.md b/bank-feeds/docs/models/components/BankFeedAccountMapping.md index 90f4c0f8..1e6fb60d 100644 --- a/bank-feeds/docs/models/components/BankFeedAccountMapping.md +++ b/bank-feeds/docs/models/components/BankFeedAccountMapping.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | | `sourceAccountId` | *String* | :heavy_check_mark: | Unique ID for the source account | -| `targetAccountId` | *JsonNullable* | :heavy_minus_sign: | Unique ID for the target account | \ No newline at end of file +| `targetAccountId` | *JsonNullable\* | :heavy_minus_sign: | Unique ID for the target account | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankFeedAccountMappingResponse.md b/bank-feeds/docs/models/components/BankFeedAccountMappingResponse.md index 58c9283a..1a7b876b 100644 --- a/bank-feeds/docs/models/components/BankFeedAccountMappingResponse.md +++ b/bank-feeds/docs/models/components/BankFeedAccountMappingResponse.md @@ -1,13 +1,11 @@ # BankFeedAccountMappingResponse -The result from POSTing a Bank Account mapping. - ## Fields | Field | Type | Required | Description | | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `error` | *JsonNullable* | :heavy_minus_sign: | Error returned during the post request | -| `status` | *JsonNullable* | :heavy_minus_sign: | Status of the POST request. | -| `sourceAccountId` | *Optional* | :heavy_minus_sign: | Unique ID for the source account. | -| `targetAccountId` | *JsonNullable* | :heavy_minus_sign: | Unique ID for the target account. | \ No newline at end of file +| `error` | *JsonNullable\* | :heavy_minus_sign: | Error returned during the post request | +| `sourceAccountId` | *Optional\* | :heavy_minus_sign: | Unique ID for the source account. | +| `status` | *JsonNullable\* | :heavy_minus_sign: | Status of the POST request. | +| `targetAccountId` | *JsonNullable\* | :heavy_minus_sign: | Unique ID for the target account. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankFeedMapping.md b/bank-feeds/docs/models/components/BankFeedMapping.md index 4ee60379..99f68d51 100644 --- a/bank-feeds/docs/models/components/BankFeedMapping.md +++ b/bank-feeds/docs/models/components/BankFeedMapping.md @@ -7,13 +7,13 @@ A bank feed connection between a source account and a target account, including | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `feedStartDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `sourceAccountId` | *Optional* | :heavy_minus_sign: | Unique ID for the source account. | | -| `sourceAccountName` | *Optional* | :heavy_minus_sign: | Name for the source account. | | -| `sourceAccountNumber` | *Optional* | :heavy_minus_sign: | Account number for the source account. | | -| `sourceBalance` | *Optional* | :heavy_minus_sign: | Balance for the source account. | | -| `sourceCurrency` | *Optional* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `status` | *Optional* | :heavy_minus_sign: | The status. | | -| `targetAccountId` | *JsonNullable* | :heavy_minus_sign: | Unique ID for the target account in the accounting software. | | -| `targetAccountName` | *Optional* | :heavy_minus_sign: | Name for the target account in the accounting software. | | -| `targetAccountOptions` | List<[TargetAccountOption](../../models/components/TargetAccountOption.md)> | :heavy_minus_sign: | An array of potential target accounts. | | \ No newline at end of file +| `feedStartDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `sourceAccountId` | *Optional\* | :heavy_minus_sign: | Unique ID for the source account. | | +| `sourceAccountName` | *Optional\* | :heavy_minus_sign: | Name for the source account. | | +| `sourceAccountNumber` | *Optional\* | :heavy_minus_sign: | Account number for the source account. | | +| `sourceBalance` | *Optional\* | :heavy_minus_sign: | Balance for the source account. | | +| `sourceCurrency` | *Optional\* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | +| `status` | *Optional\* | :heavy_minus_sign: | The status. | | +| `targetAccountId` | *JsonNullable\* | :heavy_minus_sign: | Unique ID for the target account in the accounting software. | | +| `targetAccountName` | *Optional\* | :heavy_minus_sign: | Name for the target account in the accounting software. | | +| `targetAccountOptions` | List\<[TargetAccountOption](../../models/components/TargetAccountOption.md)> | :heavy_minus_sign: | An array of potential target accounts. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/BankTransactions.md b/bank-feeds/docs/models/components/BankTransactions.md index d7ca8abe..a1582e3e 100644 --- a/bank-feeds/docs/models/components/BankTransactions.md +++ b/bank-feeds/docs/models/components/BankTransactions.md @@ -6,11 +6,11 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | *BigDecimal* | :heavy_check_mark: | The amount transacted in the bank transaction. | 999.99 | -| `balance` | *Optional* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. This field is optional for QuickBooks Online but is required for Xero, Sage, NetSuite, Exact, and FreeAgent. | -999.99 | -| `counterparty` | *JsonNullable* | :heavy_minus_sign: | The giving or receiving party such as a person or organization. | ACME INC | +| `balance` | *Optional\* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. This field is optional for QuickBooks Online but is required for Xero, Sage, NetSuite, Exact, and FreeAgent. | -999.99 | +| `counterparty` | *JsonNullable\* | :heavy_minus_sign: | The giving or receiving party such as a person or organization. | ACME INC | | `date` | *String* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `description` | *JsonNullable* | :heavy_minus_sign: | Description of the bank transaction. | Debit for Payment Id sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60 | +| `description` | *JsonNullable\* | :heavy_minus_sign: | Description of the bank transaction. | Debit for Payment Id sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60 | | `id` | *String* | :heavy_check_mark: | Identifier for the bank account transaction, unique for the company in the accounting software. | 716422529 | -| `reconciled` | *JsonNullable* | :heavy_minus_sign: | `True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software. | false | -| `reference` | *JsonNullable* | :heavy_minus_sign: | An optional reference to the bank transaction. | reference for transaction | -| `transactionType` | [JsonNullable](../../models/components/BankTransactionType.md) | :heavy_minus_sign: | Type of transaction for the bank statement line. | | \ No newline at end of file +| `reconciled` | *JsonNullable\* | :heavy_minus_sign: | `True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software. | false | +| `reference` | *JsonNullable\* | :heavy_minus_sign: | An optional reference to the bank transaction. | reference for transaction | +| `transactionType` | [JsonNullable\](../../models/components/BankTransactionType.md) | :heavy_minus_sign: | Type of transaction for the bank statement line. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitReachedWebhook.md b/bank-feeds/docs/models/components/ClientRateLimitReachedWebhook.md index 22c74875..f03bce18 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitReachedWebhook.md +++ b/bank-feeds/docs/models/components/ClientRateLimitReachedWebhook.md @@ -7,10 +7,10 @@ Webhook request body for a client that has reached their rate limit. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional](../../models/components/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional\](../../models/components/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitReachedWebhookData.md b/bank-feeds/docs/models/components/ClientRateLimitReachedWebhookData.md index 748312f4..71963e2c 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitReachedWebhookData.md +++ b/bank-feeds/docs/models/components/ClientRateLimitReachedWebhookData.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiresUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitResetWebhook.md b/bank-feeds/docs/models/components/ClientRateLimitResetWebhook.md index 68f23dd4..a4f6e215 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitResetWebhook.md +++ b/bank-feeds/docs/models/components/ClientRateLimitResetWebhook.md @@ -7,10 +7,10 @@ Webhook request body for a client that has had their rate limit reset. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *Optional* | :heavy_minus_sign: | Unique identifier of the webhook event. | -| `clientId` | *Optional* | :heavy_minus_sign: | Unique identifier for your client in Codat. | -| `clientName` | *Optional* | :heavy_minus_sign: | Name of your client in Codat. | -| `data` | [Optional](../../models/components/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | -| `message` | *Optional* | :heavy_minus_sign: | A human-readable message about the webhook. | -| ~~`ruleId`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | -| `ruleType` | *Optional* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file +| `alertId` | *Optional\* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *Optional\* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional\](../../models/components/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional\* | :heavy_minus_sign: | A human-readable message about the webhook. | +| ~~`ruleId`~~ | *Optional\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Unique identifier for the rule. | +| `ruleType` | *Optional\* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitResetWebhookData.md b/bank-feeds/docs/models/components/ClientRateLimitResetWebhookData.md index d4f34f5f..3498735a 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitResetWebhookData.md +++ b/bank-feeds/docs/models/components/ClientRateLimitResetWebhookData.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiresUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `quotaRemaining` | *JsonNullable* | :heavy_minus_sign: | Total number of requests remaining for your client. | | -| `resetReason` | *Optional* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `quotaRemaining` | *JsonNullable\* | :heavy_minus_sign: | Total number of requests remaining for your client. | | +| `resetReason` | *Optional\* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitWebhook.md b/bank-feeds/docs/models/components/ClientRateLimitWebhook.md index f1109eb7..bfcfa438 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitWebhook.md +++ b/bank-feeds/docs/models/components/ClientRateLimitWebhook.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `eventType` | *Optional* | :heavy_minus_sign: | The type of event. | client.rateLimit.reset | -| `generatedDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b | -| `payload` | [Optional](../../models/components/ClientRateLimitWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `eventType` | *Optional\* | :heavy_minus_sign: | The type of event. | client.rateLimit.reset | +| `generatedDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b | +| `payload` | [Optional\](../../models/components/ClientRateLimitWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ClientRateLimitWebhookPayload.md b/bank-feeds/docs/models/components/ClientRateLimitWebhookPayload.md index 8edb73b2..70fdc833 100644 --- a/bank-feeds/docs/models/components/ClientRateLimitWebhookPayload.md +++ b/bank-feeds/docs/models/components/ClientRateLimitWebhookPayload.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dailyQuota` | *Optional* | :heavy_minus_sign: | The number of available requests per day. | | -| `expiryDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `quotaRemaining` | *Optional* | :heavy_minus_sign: | Total number of requests remaining for your client. | | \ No newline at end of file +| `dailyQuota` | *Optional\* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiryDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `quotaRemaining` | *Optional\* | :heavy_minus_sign: | Total number of requests remaining for your client. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Companies.md b/bank-feeds/docs/models/components/Companies.md index 3e6ef9b8..2abd4efd 100644 --- a/bank-feeds/docs/models/components/Companies.md +++ b/bank-feeds/docs/models/components/Companies.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Company](../../models/components/Company.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Company](../../models/components/Company.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Company.md b/bank-feeds/docs/models/components/Company.md index d0076d31..481462b1 100644 --- a/bank-feeds/docs/models/components/Company.md +++ b/bank-feeds/docs/models/components/Company.md @@ -11,12 +11,13 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `created` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `createdByUserName` | *JsonNullable* | :heavy_minus_sign: | Name of user that created the company in Codat. | | -| `dataConnections` | List<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | -| `description` | *Optional* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | +| `created` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `createdByUserName` | *JsonNullable\* | :heavy_minus_sign: | Name of user that created the company in Codat. | | +| `dataConnections` | List\<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | +| `description` | *Optional\* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `id` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `lastSync` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `lastSync` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `name` | *String* | :heavy_check_mark: | The name of the company | Codat Ltd. | +| `products` | List\<*String*> | :heavy_minus_sign: | An array of products that are currently enabled for the company. | | | `redirect` | *String* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | -| `tags` | [Optional](../../models/components/Tags.md) | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file +| `tags` | Map\ | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CompanyInformation.md b/bank-feeds/docs/models/components/CompanyInformation.md index 215d2d19..57e55a70 100644 --- a/bank-feeds/docs/models/components/CompanyInformation.md +++ b/bank-feeds/docs/models/components/CompanyInformation.md @@ -5,9 +5,10 @@ Information about the company from the underlying accounting software. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `baseCurrency` | *Optional* | :heavy_minus_sign: | Currency set in the accounting software of the linked company. | -| `companyName` | *Optional* | :heavy_minus_sign: | Name of the linked company. | -| `multicurrencyEnabled` | *JsonNullable* | :heavy_minus_sign: | Boolean showing if the organisation has multicurrency enabled | -| `planType` | *JsonNullable* | :heavy_minus_sign: | Accounting software subscription type such as Trial, Demo, Standard | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `baseCurrency` | *Optional\* | :heavy_minus_sign: | Currency set in the accounting software of the linked company. | +| `companyName` | *Optional\* | :heavy_minus_sign: | Name of the linked company. | +| `currencies` | List\<*String*> | :heavy_minus_sign: | Array of enabled currencies for the linked company. | +| `multicurrencyEnabled` | *Optional\* | :heavy_minus_sign: | Boolean showing if the organisation has multicurrency enabled. | +| `planType` | *JsonNullable\* | :heavy_minus_sign: | Accounting software subscription type such as Trial, Demo, Standard. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CompanyReference.md b/bank-feeds/docs/models/components/CompanyReference.md new file mode 100644 index 00000000..36df806e --- /dev/null +++ b/bank-feeds/docs/models/components/CompanyReference.md @@ -0,0 +1,12 @@ +# CompanyReference + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `description` | *Optional\* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `links` | [Optional\](../../models/components/CompanyReferenceLinks.md) | :heavy_minus_sign: | A collection of links for the company. | | +| `name` | *Optional\* | :heavy_minus_sign: | The name of the company | Codat Ltd. | +| `tags` | Map\ | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CompanyReferenceLinks.md b/bank-feeds/docs/models/components/CompanyReferenceLinks.md new file mode 100644 index 00000000..cf075bb9 --- /dev/null +++ b/bank-feeds/docs/models/components/CompanyReferenceLinks.md @@ -0,0 +1,10 @@ +# CompanyReferenceLinks + +A collection of links for the company. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `portal` | *Optional\* | :heavy_minus_sign: | Link to the company page in the portal. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CompanyRequestBody.md b/bank-feeds/docs/models/components/CompanyRequestBody.md index da236c2a..f5b32be7 100644 --- a/bank-feeds/docs/models/components/CompanyRequestBody.md +++ b/bank-feeds/docs/models/components/CompanyRequestBody.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `description` | *Optional* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | -| `groups` | List<[GroupReference](../../models/components/GroupReference.md)> | :heavy_minus_sign: | Reference to the groups that the company is assigned to. | | -| `name` | *String* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | \ No newline at end of file +| `description` | *Optional\* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | +| `name` | *String* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | +| `tags` | Map\ | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CompanySyncStatus.md b/bank-feeds/docs/models/components/CompanySyncStatus.md index 820ff8fe..577bba83 100644 --- a/bank-feeds/docs/models/components/CompanySyncStatus.md +++ b/bank-feeds/docs/models/components/CompanySyncStatus.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companyId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | d4d73051-ed31-42b6-99f6-d288cd940992 | -| `dataPushed` | *Optional* | :heavy_minus_sign: | Boolean of whether the sync resulted in data being pushed. | | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | Error message of the sync. | | -| `syncExceptionMessage` | *JsonNullable* | :heavy_minus_sign: | Exception message of the sync. | | -| `syncId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier of the sync. | a6a22aff-a43a-411d-a910-2dae73217cce | -| `syncStatus` | *JsonNullable* | :heavy_minus_sign: | Text status of the sync. | Complete | -| `syncStatusCode` | *Optional* | :heavy_minus_sign: | Status code of the sync. | 2000 | -| `syncUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | \ No newline at end of file +| `companyId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | d4d73051-ed31-42b6-99f6-d288cd940992 | +| `dataPushed` | *Optional\* | :heavy_minus_sign: | Boolean of whether the sync resulted in data being pushed. | | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | Error message of the sync. | | +| `syncExceptionMessage` | *JsonNullable\* | :heavy_minus_sign: | Exception message of the sync. | | +| `syncId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier of the sync. | a6a22aff-a43a-411d-a910-2dae73217cce | +| `syncStatus` | *JsonNullable\* | :heavy_minus_sign: | Text status of the sync. | Complete | +| `syncStatusCode` | *Optional\* | :heavy_minus_sign: | Status code of the sync. | 2000 | +| `syncUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Configuration.md b/bank-feeds/docs/models/components/Configuration.md index b1e685b6..e89904d7 100644 --- a/bank-feeds/docs/models/components/Configuration.md +++ b/bank-feeds/docs/models/components/Configuration.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `accountingSoftwareCompanyName` | *Optional* | :heavy_minus_sign: | The company name defined in the accounting software. | | -| `companyId` | *Optional* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `configuration` | [Optional](../../models/components/SyncConfiguration.md) | :heavy_minus_sign: | N/A | | -| `configured` | *Optional* | :heavy_minus_sign: | True if the company has been configured. | | -| `enabled` | *Optional* | :heavy_minus_sign: | Enabled or disable bank feeds. | | -| `schedule` | [Optional](../../models/components/ConfigurationSchedule.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `accountingSoftwareCompanyName` | *Optional\* | :heavy_minus_sign: | The company name defined in the accounting software. | | +| `companyId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `configuration` | [Optional\](../../models/components/SyncConfiguration.md) | :heavy_minus_sign: | N/A | | +| `configured` | *Optional\* | :heavy_minus_sign: | True if the company has been configured. | | +| `enabled` | *Optional\* | :heavy_minus_sign: | Enabled or disable bank feeds. | | +| `schedule` | [Optional\](../../models/components/ConfigurationSchedule.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ConfigurationContactRef.md b/bank-feeds/docs/models/components/ConfigurationContactRef.md index a7956b73..1cf4fa6d 100644 --- a/bank-feeds/docs/models/components/ConfigurationContactRef.md +++ b/bank-feeds/docs/models/components/ConfigurationContactRef.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the supplier/customer. | -| `name` | *Optional* | :heavy_minus_sign: | The supplier/customer's name. | \ No newline at end of file +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for the supplier/customer. | +| `name` | *Optional\* | :heavy_minus_sign: | The supplier/customer's name. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ConfigurationCustomer.md b/bank-feeds/docs/models/components/ConfigurationCustomer.md index 98cceb87..474fb2f3 100644 --- a/bank-feeds/docs/models/components/ConfigurationCustomer.md +++ b/bank-feeds/docs/models/components/ConfigurationCustomer.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `customerOptions` | List<[ConfigurationContactRef](../../models/components/ConfigurationContactRef.md)> | :heavy_minus_sign: | N/A | -| `selectedCustomerId` | *Optional* | :heavy_minus_sign: | Unique identifier for the customer. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `customerOptions` | List\<[ConfigurationContactRef](../../models/components/ConfigurationContactRef.md)> | :heavy_minus_sign: | N/A | +| `selectedCustomerId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the customer. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ConfigurationSchedule.md b/bank-feeds/docs/models/components/ConfigurationSchedule.md index 893cfce8..d2772687 100644 --- a/bank-feeds/docs/models/components/ConfigurationSchedule.md +++ b/bank-feeds/docs/models/components/ConfigurationSchedule.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `frequencyOptions` | List<*String*> | :heavy_minus_sign: | The available sync frequencies. | -| `selectedFrequency` | *Optional* | :heavy_minus_sign: | The sync frequency. | -| `startDate` | *Optional* | :heavy_minus_sign: | The datetime in UTC you want to start syncing from. | -| `syncHourUtc` | *Optional* | :heavy_minus_sign: | The hour in which the sync is initiated. | -| `timeZoneIanaId` | *Optional* | :heavy_minus_sign: | The [IANA](https://www.iana.org/time-zones) time zone ID. | \ No newline at end of file +| `frequencyOptions` | List\<*String*> | :heavy_minus_sign: | The available sync frequencies. | +| `selectedFrequency` | *Optional\* | :heavy_minus_sign: | The sync frequency. | +| `startDate` | *Optional\* | :heavy_minus_sign: | The datetime in UTC you want to start syncing from. | +| `syncHourUtc` | *Optional\* | :heavy_minus_sign: | The hour in which the sync is initiated. | +| `timeZoneIanaId` | *Optional\* | :heavy_minus_sign: | The [IANA](https://www.iana.org/time-zones) time zone ID. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ConfigurationSupplier.md b/bank-feeds/docs/models/components/ConfigurationSupplier.md index 123705da..1abaacf0 100644 --- a/bank-feeds/docs/models/components/ConfigurationSupplier.md +++ b/bank-feeds/docs/models/components/ConfigurationSupplier.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `selectedSupplierId` | *Optional* | :heavy_minus_sign: | Unique identifier for the supplier. | -| `supplierOptions` | List<[ConfigurationContactRef](../../models/components/ConfigurationContactRef.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `selectedSupplierId` | *Optional\* | :heavy_minus_sign: | Unique identifier for the supplier. | +| `supplierOptions` | List\<[ConfigurationContactRef](../../models/components/ConfigurationContactRef.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Connection.md b/bank-feeds/docs/models/components/Connection.md index f80c8589..f74b48a9 100644 --- a/bank-feeds/docs/models/components/Connection.md +++ b/bank-feeds/docs/models/components/Connection.md @@ -16,14 +16,13 @@ Before you can use a data connection to pull or push data, the company must gran | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additionalProperties` | *Optional* | :heavy_minus_sign: | N/A | | -| `connectionInfo` | Map | :heavy_minus_sign: | N/A | | +| `connectionInfo` | Map\ | :heavy_minus_sign: | N/A | | | `created` | *String* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `dataConnectionErrors` | List<[DataConnectionError](../../models/components/DataConnectionError.md)> | :heavy_minus_sign: | N/A | | +| `dataConnectionErrors` | List\<[DataConnectionError](../../models/components/DataConnectionError.md)> | :heavy_minus_sign: | N/A | | | `id` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integrationId` | *String* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integrationKey` | *String* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | -| `lastSync` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `lastSync` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `linkUrl` | *String* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | | `platformName` | *String* | :heavy_check_mark: | Name of integration connected to company. | | | `sourceId` | *String* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | diff --git a/bank-feeds/docs/models/components/Connections.md b/bank-feeds/docs/models/components/Connections.md index 142200ca..ea2d295a 100644 --- a/bank-feeds/docs/models/components/Connections.md +++ b/bank-feeds/docs/models/components/Connections.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[Connection](../../models/components/Connection.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CreateBankTransactions.md b/bank-feeds/docs/models/components/CreateBankTransactions.md index e3844bda..34c47862 100644 --- a/bank-feeds/docs/models/components/CreateBankTransactions.md +++ b/bank-feeds/docs/models/components/CreateBankTransactions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `accountId` | *String* | :heavy_check_mark: | Unique identifier for a bank account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `transactions` | List<[BankTransactions](../../models/components/BankTransactions.md)> | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `accountId` | *String* | :heavy_check_mark: | Unique identifier for a bank account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `transactions` | List\<[BankTransactions](../../models/components/BankTransactions.md)> | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/CreateBankTransactionsResponse.md b/bank-feeds/docs/models/components/CreateBankTransactionsResponse.md index 94e2d66a..3b2d74bf 100644 --- a/bank-feeds/docs/models/components/CreateBankTransactionsResponse.md +++ b/bank-feeds/docs/models/components/CreateBankTransactionsResponse.md @@ -5,17 +5,17 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `data` | [Optional](../../models/components/CreateBankTransactions.md) | :heavy_minus_sign: | N/A | | +| `completedOnUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `data` | [Optional\](../../models/components/CreateBankTransactions.md) | :heavy_minus_sign: | N/A | | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/DataConnectionError.md b/bank-feeds/docs/models/components/DataConnectionError.md index 30c434fc..47d52908 100644 --- a/bank-feeds/docs/models/components/DataConnectionError.md +++ b/bank-feeds/docs/models/components/DataConnectionError.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `errorMessage` | *Optional* | :heavy_minus_sign: | A message about a error returned by Codat. | | -| `erroredOnUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `resolvedOnUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `status` | [JsonNullable](../../models/components/ErrorStatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | | -| `statusCode` | *Optional* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | | -| `statusText` | *Optional* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | | \ No newline at end of file +| `errorMessage` | *Optional\* | :heavy_minus_sign: | A message about a error returned by Codat. | | +| `erroredOnUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `resolvedOnUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `status` | [JsonNullable\](../../models/components/ErrorStatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | | +| `statusCode` | *Optional\* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | | +| `statusText` | *Optional\* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ErrorValidation.md b/bank-feeds/docs/models/components/ErrorValidation.md index 8665bc8c..2cfad261 100644 --- a/bank-feeds/docs/models/components/ErrorValidation.md +++ b/bank-feeds/docs/models/components/ErrorValidation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made. If an op ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `errors` | List<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `errors` | List\<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[ErrorValidationItem](../../models/components/ErrorValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ErrorValidationItem.md b/bank-feeds/docs/models/components/ErrorValidationItem.md index 500a8de3..3c4a4160 100644 --- a/bank-feeds/docs/models/components/ErrorValidationItem.md +++ b/bank-feeds/docs/models/components/ErrorValidationItem.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for a validation item. | -| `message` | *JsonNullable* | :heavy_minus_sign: | A message outlining validation item's issue. | -| `validatorName` | *JsonNullable* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file +| `itemId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *JsonNullable\* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validatorName` | *JsonNullable\* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/GroupReference.md b/bank-feeds/docs/models/components/GroupReference.md deleted file mode 100644 index 638321db..00000000 --- a/bank-feeds/docs/models/components/GroupReference.md +++ /dev/null @@ -1,8 +0,0 @@ -# GroupReference - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for the group. | 60d2fa12-8a04-11ee-b9d1-0242ac120002 | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/HalRef.md b/bank-feeds/docs/models/components/HalRef.md index e0c97c05..b65ff569 100644 --- a/bank-feeds/docs/models/components/HalRef.md +++ b/bank-feeds/docs/models/components/HalRef.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | -| `href` | *Optional* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file +| `href` | *Optional\* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Links.md b/bank-feeds/docs/models/components/Links.md index d53255ac..d829d756 100644 --- a/bank-feeds/docs/models/components/Links.md +++ b/bank-feeds/docs/models/components/Links.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `current` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | -| `next` | [Optional](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | -| `self` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `current` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | +| `next` | [Optional\](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | +| `previous` | [Optional\](../../models/components/HalRef.md) | :heavy_minus_sign: | N/A | +| `self` | [HalRef](../../models/components/HalRef.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Metadata.md b/bank-feeds/docs/models/components/Metadata.md index 0a21d56c..89a4ad1b 100644 --- a/bank-feeds/docs/models/components/Metadata.md +++ b/bank-feeds/docs/models/components/Metadata.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `isDeleted` | *JsonNullable* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file +| `isDeleted` | *JsonNullable\* | :heavy_minus_sign: | Indicates whether the record has been deleted in the third-party system this record originated from. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushFieldValidation.md b/bank-feeds/docs/models/components/PushFieldValidation.md index 013f54b0..dab3c713 100644 --- a/bank-feeds/docs/models/components/PushFieldValidation.md +++ b/bank-feeds/docs/models/components/PushFieldValidation.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `details` | *String* | :heavy_check_mark: | Details on the validation issue. | -| `field` | *Optional* | :heavy_minus_sign: | Field name that resulted in the validation issue. | -| `ref` | *JsonNullable* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file +| `field` | *Optional\* | :heavy_minus_sign: | Field name that resulted in the validation issue. | +| `ref` | *JsonNullable\* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOperation.md b/bank-feeds/docs/models/components/PushOperation.md index a956bfcc..5211dc40 100644 --- a/bank-feeds/docs/models/components/PushOperation.md +++ b/bank-feeds/docs/models/components/PushOperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `changes` | List\<[PushOperationChange](../../models/components/PushOperationChange.md)> | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completedOnUtc` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `completedOnUtc` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `dataConnectionKey` | *String* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `errorMessage` | *JsonNullable* | :heavy_minus_sign: | A message about the error. | | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `errorMessage` | *JsonNullable\* | :heavy_minus_sign: | A message about the error. | | | `pushOperationKey` | *String* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *String* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `status` | [PushOperationStatus](../../models/components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | Push status code. | | -| `timeoutInMinutes` | *JsonNullable* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | -| ~~`timeoutInSeconds`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | -| `validation` | [Optional](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file +| `timeoutInMinutes` | *JsonNullable\* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *JsonNullable\* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | +| `validation` | [Optional\](../../models/components/Validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOperationChange.md b/bank-feeds/docs/models/components/PushOperationChange.md index 3cc2dad8..7e998d75 100644 --- a/bank-feeds/docs/models/components/PushOperationChange.md +++ b/bank-feeds/docs/models/components/PushOperationChange.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `attachmentId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | -| `recordRef` | [Optional](../../models/components/PushOperationRef.md) | :heavy_minus_sign: | N/A | -| `type` | [Optional](../../models/components/PushChangeType.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `attachmentId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | +| `recordRef` | [Optional\](../../models/components/PushOperationRef.md) | :heavy_minus_sign: | N/A | +| `type` | [Optional\](../../models/components/PushChangeType.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOperationRef.md b/bank-feeds/docs/models/components/PushOperationRef.md index af085c5d..03460545 100644 --- a/bank-feeds/docs/models/components/PushOperationRef.md +++ b/bank-feeds/docs/models/components/PushOperationRef.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `dataType` | [Optional](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `dataType` | [Optional\](../../models/components/DataType.md) | :heavy_minus_sign: | Available data types | invoices | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOperations.md b/bank-feeds/docs/models/components/PushOperations.md index 1eef6307..3b4f29e2 100644 --- a/bank-feeds/docs/models/components/PushOperations.md +++ b/bank-feeds/docs/models/components/PushOperations.md @@ -8,5 +8,5 @@ | `links` | [Links](../../models/components/Links.md) | :heavy_check_mark: | N/A | {
"self": {
"href": "/companies"
},
"current": {
"href": "/companies?page=1\u0026pageSize=10"
}
} | | `pageNumber` | *long* | :heavy_check_mark: | Current page number. | | | `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | -| `results` | List<[PushOperation](../../models/components/PushOperation.md)> | :heavy_minus_sign: | N/A | | +| `results` | List\<[PushOperation](../../models/components/PushOperation.md)> | :heavy_minus_sign: | N/A | | | `totalResults` | *long* | :heavy_check_mark: | Total number of items. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOption.md b/bank-feeds/docs/models/components/PushOption.md index 6677bd0c..606a5ebe 100644 --- a/bank-feeds/docs/models/components/PushOption.md +++ b/bank-feeds/docs/models/components/PushOption.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `description` | *Optional* | :heavy_minus_sign: | A description of the property. | -| `displayName` | *String* | :heavy_check_mark: | The property's display name. | -| `options` | List<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | -| `properties` | Map | :heavy_minus_sign: | N/A | -| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *Optional\* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *String* | :heavy_check_mark: | The property's display name. | +| `options` | List\<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | +| `properties` | Map\ | :heavy_minus_sign: | N/A | +| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional\](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOptionChoice.md b/bank-feeds/docs/models/components/PushOptionChoice.md index c35f167d..cf30d4f0 100644 --- a/bank-feeds/docs/models/components/PushOptionChoice.md +++ b/bank-feeds/docs/models/components/PushOptionChoice.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `description` | *Optional* | :heavy_minus_sign: | A description of the property. | -| `displayName` | *Optional* | :heavy_minus_sign: | The property's display name. | -| `required` | *Optional* | :heavy_minus_sign: | The property is required if `True`. | -| `type` | [Optional](../../models/components/PushOptionType.md) | :heavy_minus_sign: | The option type. | -| `value` | *Optional* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `description` | *Optional\* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *Optional\* | :heavy_minus_sign: | The property's display name. | +| `required` | *Optional\* | :heavy_minus_sign: | The property is required if `True`. | +| `type` | [Optional\](../../models/components/PushOptionType.md) | :heavy_minus_sign: | The option type. | +| `value` | *Optional\* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushOptionProperty.md b/bank-feeds/docs/models/components/PushOptionProperty.md index ddd70d65..4829813e 100644 --- a/bank-feeds/docs/models/components/PushOptionProperty.md +++ b/bank-feeds/docs/models/components/PushOptionProperty.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `description` | *String* | :heavy_check_mark: | A description of the property. | -| `displayName` | *String* | :heavy_check_mark: | The property's display name. | -| `options` | List<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | -| `properties` | Map | :heavy_minus_sign: | N/A | -| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | -| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | -| `validation` | [Optional](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `description` | *String* | :heavy_check_mark: | A description of the property. | +| `displayName` | *String* | :heavy_check_mark: | The property's display name. | +| `options` | List\<[PushOptionChoice](../../models/components/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | +| `properties` | Map\ | :heavy_minus_sign: | N/A | +| `required` | *boolean* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/components/PushOptionType.md) | :heavy_check_mark: | The option type. | +| `validation` | [Optional\](../../models/components/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/PushValidationInfo.md b/bank-feeds/docs/models/components/PushValidationInfo.md index 824a0826..8bdba81e 100644 --- a/bank-feeds/docs/models/components/PushValidationInfo.md +++ b/bank-feeds/docs/models/components/PushValidationInfo.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| `information` | List<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `information` | List\<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[PushFieldValidation](../../models/components/PushFieldValidation.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/RoutingInfo.md b/bank-feeds/docs/models/components/RoutingInfo.md index 17b0eeba..e9cd341a 100644 --- a/bank-feeds/docs/models/components/RoutingInfo.md +++ b/bank-feeds/docs/models/components/RoutingInfo.md @@ -5,7 +5,7 @@ Routing information for the bank. This does not include account number. ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `bankCode` | *JsonNullable* | :heavy_minus_sign: | The numeric identifier of the routing number | -| `type` | [JsonNullable](../../models/components/Type.md) | :heavy_minus_sign: | The type of routing number. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | +| `bankCode` | *JsonNullable\* | :heavy_minus_sign: | The numeric identifier of the routing number | +| `type` | [JsonNullable\](../../models/components/Type.md) | :heavy_minus_sign: | The type of routing number. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SourceAccount.md b/bank-feeds/docs/models/components/SourceAccount.md index 9f436529..fb2dc92f 100644 --- a/bank-feeds/docs/models/components/SourceAccount.md +++ b/bank-feeds/docs/models/components/SourceAccount.md @@ -7,13 +7,13 @@ The target bank account in a supported accounting software for ingestion into a | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountName` | *JsonNullable* | :heavy_minus_sign: | The bank account name. | | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | The account number. | | -| `accountType` | *JsonNullable* | :heavy_minus_sign: | The type of bank account e.g. Credit. | | -| `balance` | *JsonNullable* | :heavy_minus_sign: | The latest balance for the bank account. | | -| `currency` | *Optional* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `feedStartDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `accountName` | *JsonNullable\* | :heavy_minus_sign: | The bank account name. | | +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | The account number. | | +| `accountType` | *JsonNullable\* | :heavy_minus_sign: | The type of bank account e.g. Credit. | | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | The latest balance for the bank account. | | +| `currency` | *Optional\* | :heavy_minus_sign: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | +| `feedStartDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | | `id` | *String* | :heavy_check_mark: | Unique ID for the bank account. | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | The sort code. | | -| `status` | [JsonNullable](../../models/components/Status.md) | :heavy_minus_sign: | Status of the source account. | | \ No newline at end of file +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | The sort code. | | +| `status` | [JsonNullable\](../../models/components/Status.md) | :heavy_minus_sign: | Status of the source account. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SourceAccountV2.md b/bank-feeds/docs/models/components/SourceAccountV2.md index 2c14bf25..ed3cb91d 100644 --- a/bank-feeds/docs/models/components/SourceAccountV2.md +++ b/bank-feeds/docs/models/components/SourceAccountV2.md @@ -7,14 +7,14 @@ The target bank account in a supported accounting software for ingestion into a | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accountInfo` | [JsonNullable](../../models/components/AccountInfo.md) | :heavy_minus_sign: | N/A | | +| `accountInfo` | [JsonNullable\](../../models/components/AccountInfo.md) | :heavy_minus_sign: | N/A | | | `accountName` | *String* | :heavy_check_mark: | The bank account name. | | | `accountNumber` | *String* | :heavy_check_mark: | The account number. | | | `accountType` | [AccountType](../../models/components/AccountType.md) | :heavy_check_mark: | The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard. | | | `balance` | *BigDecimal* | :heavy_check_mark: | The latest balance for the bank account. | | | `currency` | *String* | :heavy_check_mark: | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.

## Unknown currencies

In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.

There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP | -| `feedStartDate` | *JsonNullable* | :heavy_minus_sign: | In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
```
2020-10-08
``` | 2022-10-23 | +| `feedStartDate` | *JsonNullable\* | :heavy_minus_sign: | In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
```
2020-10-08
``` | 2022-10-23 | | `id` | *String* | :heavy_check_mark: | Unique ID for the bank account. | | -| `modifiedDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `routingInfo` | [Optional](../../models/components/RoutingInfo.md) | :heavy_minus_sign: | Routing information for the bank. This does not include account number. | | -| `status` | [JsonNullable](../../models/components/SourceAccountV2Status.md) | :heavy_minus_sign: | Status of the source account. | | \ No newline at end of file +| `modifiedDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `routingInfo` | [Optional\](../../models/components/RoutingInfo.md) | :heavy_minus_sign: | Routing information for the bank. This does not include account number. | | +| `status` | [JsonNullable\](../../models/components/SourceAccountV2Status.md) | :heavy_minus_sign: | Status of the source account. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SourceAccountWebhook.md b/bank-feeds/docs/models/components/SourceAccountWebhook.md index 00ab4a29..29ee93d8 100644 --- a/bank-feeds/docs/models/components/SourceAccountWebhook.md +++ b/bank-feeds/docs/models/components/SourceAccountWebhook.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `eventType` | *Optional* | :heavy_minus_sign: | The type of event. | bankFeeds.sourceAccount.connected | -| `generatedDate` | *Optional* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | -| `id` | *Optional* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 | -| `payload` | [Optional](../../models/components/SourceAccountWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `eventType` | *Optional\* | :heavy_minus_sign: | The type of event. | bankFeeds.sourceAccount.connected | +| `generatedDate` | *Optional\* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23 00:00:00 +0000 UTC | +| `id` | *Optional\* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 | +| `payload` | [Optional\](../../models/components/SourceAccountWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SourceAccountWebhookPayload.md b/bank-feeds/docs/models/components/SourceAccountWebhookPayload.md index 2f06f619..92b6c6dd 100644 --- a/bank-feeds/docs/models/components/SourceAccountWebhookPayload.md +++ b/bank-feeds/docs/models/components/SourceAccountWebhookPayload.md @@ -5,6 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companyId` | *Optional* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *Optional* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `sourceAccount` | [Optional](../../models/components/SourceAccount.md) | :heavy_minus_sign: | The target bank account in a supported accounting software for ingestion into a bank feed. | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | \ No newline at end of file +| `companyId` | *Optional\* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *Optional\* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `referenceCompany` | [Optional\](../../models/components/CompanyReference.md) | :heavy_minus_sign: | N/A | | +| `sourceAccount` | [Optional\](../../models/components/SourceAccount.md) | :heavy_minus_sign: | The target bank account in a supported accounting software for ingestion into a bank feed. | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SupplementalData.md b/bank-feeds/docs/models/components/SupplementalData.md index ec0c9302..8c2b0aa1 100644 --- a/bank-feeds/docs/models/components/SupplementalData.md +++ b/bank-feeds/docs/models/components/SupplementalData.md @@ -7,6 +7,6 @@ It is referenced as a configured dynamic key value pair that is unique to the ac ## Fields -| Field | Type | Required | Description | -| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `content` | Map> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | +| `content` | Map\> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SyncAsBankFeeds.md b/bank-feeds/docs/models/components/SyncAsBankFeeds.md index e4864623..854f78bb 100644 --- a/bank-feeds/docs/models/components/SyncAsBankFeeds.md +++ b/bank-feeds/docs/models/components/SyncAsBankFeeds.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `bankAccountOptions` | List<[BankAccountOption](../../models/components/BankAccountOption.md)> | :heavy_minus_sign: | N/A | -| `enableSync` | *Optional* | :heavy_minus_sign: | True if bank feeds sync is enabled. | -| `selectedBankAccountId` | *Optional* | :heavy_minus_sign: | The bank account ID being synced. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `bankAccountOptions` | List\<[BankAccountOption](../../models/components/BankAccountOption.md)> | :heavy_minus_sign: | N/A | +| `enableSync` | *Optional\* | :heavy_minus_sign: | True if bank feeds sync is enabled. | +| `selectedBankAccountId` | *Optional\* | :heavy_minus_sign: | The bank account ID being synced. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SyncAsExpenses.md b/bank-feeds/docs/models/components/SyncAsExpenses.md index 36dea366..3032fb8a 100644 --- a/bank-feeds/docs/models/components/SyncAsExpenses.md +++ b/bank-feeds/docs/models/components/SyncAsExpenses.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `bankAccountOptions` | List<[BankAccountOption](../../models/components/BankAccountOption.md)> | :heavy_minus_sign: | N/A | -| `customer` | [Optional](../../models/components/ConfigurationCustomer.md) | :heavy_minus_sign: | N/A | -| `enableSync` | *Optional* | :heavy_minus_sign: | True if expense sync is enabled. | -| `selectedBankAccountId` | *Optional* | :heavy_minus_sign: | The bank account ID being synced. | -| `supplier` | [Optional](../../models/components/ConfigurationSupplier.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `bankAccountOptions` | List\<[BankAccountOption](../../models/components/BankAccountOption.md)> | :heavy_minus_sign: | N/A | +| `customer` | [Optional\](../../models/components/ConfigurationCustomer.md) | :heavy_minus_sign: | N/A | +| `enableSync` | *Optional\* | :heavy_minus_sign: | True if expense sync is enabled. | +| `selectedBankAccountId` | *Optional\* | :heavy_minus_sign: | The bank account ID being synced. | +| `supplier` | [Optional\](../../models/components/ConfigurationSupplier.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/SyncConfiguration.md b/bank-feeds/docs/models/components/SyncConfiguration.md index 5ca1fd81..adf7d7d9 100644 --- a/bank-feeds/docs/models/components/SyncConfiguration.md +++ b/bank-feeds/docs/models/components/SyncConfiguration.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `syncAsBankFeeds` | [Optional](../../models/components/SyncAsBankFeeds.md) | :heavy_minus_sign: | N/A | -| `syncAsExpenses` | [Optional](../../models/components/SyncAsExpenses.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `syncAsBankFeeds` | [Optional\](../../models/components/SyncAsBankFeeds.md) | :heavy_minus_sign: | N/A | +| `syncAsExpenses` | [Optional\](../../models/components/SyncAsExpenses.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Tags.md b/bank-feeds/docs/models/components/Tags.md deleted file mode 100644 index 6de993aa..00000000 --- a/bank-feeds/docs/models/components/Tags.md +++ /dev/null @@ -1,9 +0,0 @@ -# Tags - -A collection of user-defined key-value pairs that store custom metadata against the company. - - -## Fields - -| Field | Type | Required | Description | -| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/TargetAccountOption.md b/bank-feeds/docs/models/components/TargetAccountOption.md index 315a9539..a1fec045 100644 --- a/bank-feeds/docs/models/components/TargetAccountOption.md +++ b/bank-feeds/docs/models/components/TargetAccountOption.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- | -| `accountNumber` | *JsonNullable* | :heavy_minus_sign: | The account number of the account. | -| `balance` | *JsonNullable* | :heavy_minus_sign: | The balance of the account. | -| `id` | *Optional* | :heavy_minus_sign: | Id of the target account. | -| `name` | *JsonNullable* | :heavy_minus_sign: | Name of the target account. | -| `sortCode` | *JsonNullable* | :heavy_minus_sign: | The sort code of the account. | \ No newline at end of file +| `accountNumber` | *JsonNullable\* | :heavy_minus_sign: | The account number of the account. | +| `balance` | *JsonNullable\* | :heavy_minus_sign: | The balance of the account. | +| `id` | *Optional\* | :heavy_minus_sign: | Id of the target account. | +| `name` | *JsonNullable\* | :heavy_minus_sign: | Name of the target account. | +| `sortCode` | *JsonNullable\* | :heavy_minus_sign: | The sort code of the account. | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/Validation.md b/bank-feeds/docs/models/components/Validation.md index f214d48c..ad25f1d1 100644 --- a/bank-feeds/docs/models/components/Validation.md +++ b/bank-feeds/docs/models/components/Validation.md @@ -5,7 +5,7 @@ A human-readable object describing validation decisions Codat has made when push ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `errors` | List<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | -| `warnings` | List<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | +| `errors` | List\<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | +| `warnings` | List\<[ValidationItem](../../models/components/ValidationItem.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/components/ValidationItem.md b/bank-feeds/docs/models/components/ValidationItem.md index d0cc54dc..eda568c5 100644 --- a/bank-feeds/docs/models/components/ValidationItem.md +++ b/bank-feeds/docs/models/components/ValidationItem.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -| `itemId` | *JsonNullable* | :heavy_minus_sign: | Unique identifier for a validation item. | -| `message` | *JsonNullable* | :heavy_minus_sign: | A message outlining validation item's issue. | -| `validatorName` | *JsonNullable* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file +| `itemId` | *JsonNullable\* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *JsonNullable\* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validatorName` | *JsonNullable\* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/bank-feeds/docs/models/errors/ErrorMessage.md b/bank-feeds/docs/models/errors/ErrorMessage.md index fbd0a775..e10178f0 100644 --- a/bank-feeds/docs/models/errors/ErrorMessage.md +++ b/bank-feeds/docs/models/errors/ErrorMessage.md @@ -1,16 +1,16 @@ # ErrorMessage -The request made is not valid. +Your `query` parameter was not correctly formed ## Fields | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `canBeRetried` | *Optional* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | -| `correlationId` | *Optional* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | -| `detailedErrorCode` | *Optional* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | -| `error` | *Optional* | :heavy_minus_sign: | A brief description of the error. | -| `service` | *Optional* | :heavy_minus_sign: | Codat's service the returned the error. | -| `statusCode` | *Optional* | :heavy_minus_sign: | The HTTP status code returned by the error. | -| `validation` | [JsonNullable](../../models/components/ErrorValidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. | \ No newline at end of file +| `canBeRetried` | *Optional\* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlationId` | *Optional\* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailedErrorCode` | *Optional\* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *Optional\* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *Optional\* | :heavy_minus_sign: | Codat's service the returned the error. | +| `statusCode` | *Optional\* | :heavy_minus_sign: | The HTTP status code returned by the error. | +| `validation` | [JsonNullable\](../../models/components/ErrorValidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankAccountMappingRequest.md b/bank-feeds/docs/models/operations/CreateBankAccountMappingRequest.md index cf7ca265..ae115056 100644 --- a/bank-feeds/docs/models/operations/CreateBankAccountMappingRequest.md +++ b/bank-feeds/docs/models/operations/CreateBankAccountMappingRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `bankFeedAccountMapping` | [Optional](../../models/components/BankFeedAccountMapping.md) | :heavy_minus_sign: | N/A | {
"sourceAccountId": "acc-002",
"targetAccountId": "account-081"
} | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `bankFeedAccountMapping` | [Optional\](../../models/components/BankFeedAccountMapping.md) | :heavy_minus_sign: | N/A | {
"sourceAccountId": "acc-002",
"targetAccountId": "account-081"
} | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankAccountMappingResponse.md b/bank-feeds/docs/models/operations/CreateBankAccountMappingResponse.md index 385cfdd3..d2357a2b 100644 --- a/bank-feeds/docs/models/operations/CreateBankAccountMappingResponse.md +++ b/bank-feeds/docs/models/operations/CreateBankAccountMappingResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankFeedAccountMappingResponse` | [Optional](../../models/components/BankFeedAccountMappingResponse.md) | :heavy_minus_sign: | Success | {
"sourceAccountId": "acc-002",
"targetAccountId": "account-081",
"Status": "Failed",
"Error": "A feed connection already exists to this account"
} | +| `bankFeedAccountMappingResponse` | [Optional\](../../models/components/BankFeedAccountMappingResponse.md) | :heavy_minus_sign: | Success | {
"sourceAccountId": "acc-002",
"targetAccountId": "account-081",
"status": "Failed",
"error": "A feed connection already exists to this account"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankAccountRequest.md b/bank-feeds/docs/models/operations/CreateBankAccountRequest.md index 94515234..4eb01081 100644 --- a/bank-feeds/docs/models/operations/CreateBankAccountRequest.md +++ b/bank-feeds/docs/models/operations/CreateBankAccountRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `bankAccountPrototype` | [Optional](../../models/components/BankAccountPrototype.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `bankAccountPrototype` | [Optional\](../../models/components/BankAccountPrototype.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankAccountResponse.md b/bank-feeds/docs/models/operations/CreateBankAccountResponse.md index be873065..27d27275 100644 --- a/bank-feeds/docs/models/operations/CreateBankAccountResponse.md +++ b/bank-feeds/docs/models/operations/CreateBankAccountResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `bankAccountCreateResponse` | [Optional](../../models/components/BankAccountCreateResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `bankAccountCreateResponse` | [Optional\](../../models/components/BankAccountCreateResponse.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankTransactionsRequest.md b/bank-feeds/docs/models/operations/CreateBankTransactionsRequest.md index 7c03d3ae..80387bfe 100644 --- a/bank-feeds/docs/models/operations/CreateBankTransactionsRequest.md +++ b/bank-feeds/docs/models/operations/CreateBankTransactionsRequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `createBankTransactions` | [Optional](../../models/components/CreateBankTransactions.md) | :heavy_minus_sign: | N/A | | -| `accountId` | *String* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `allowSyncOnPushComplete` | *Optional* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `timeoutInMinutes` | *Optional* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `createBankTransactions` | [Optional\](../../models/components/CreateBankTransactions.md) | :heavy_minus_sign: | N/A | | +| `accountId` | *String* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `allowSyncOnPushComplete` | *Optional\* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `timeoutInMinutes` | *Optional\* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateBankTransactionsResponse.md b/bank-feeds/docs/models/operations/CreateBankTransactionsResponse.md index 373936e9..3f407855 100644 --- a/bank-feeds/docs/models/operations/CreateBankTransactionsResponse.md +++ b/bank-feeds/docs/models/operations/CreateBankTransactionsResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `createBankTransactionsResponse` | [Optional](../../models/components/CreateBankTransactionsResponse.md) | :heavy_minus_sign: | Success | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `createBankTransactionsResponse` | [Optional\](../../models/components/CreateBankTransactionsResponse.md) | :heavy_minus_sign: | Success | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateCompanyResponse.md b/bank-feeds/docs/models/operations/CreateCompanyResponse.md index 01ade6c4..f0e7fb68 100644 --- a/bank-feeds/docs/models/operations/CreateCompanyResponse.md +++ b/bank-feeds/docs/models/operations/CreateCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateConnectionRequest.md b/bank-feeds/docs/models/operations/CreateConnectionRequest.md index 9aafcbb8..9edc7d43 100644 --- a/bank-feeds/docs/models/operations/CreateConnectionRequest.md +++ b/bank-feeds/docs/models/operations/CreateConnectionRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `requestBody` | [Optional](../../models/operations/CreateConnectionRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `requestBody` | [Optional\](../../models/operations/CreateConnectionRequestBody.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateConnectionRequestBody.md b/bank-feeds/docs/models/operations/CreateConnectionRequestBody.md index f05cc6ab..da4f839d 100644 --- a/bank-feeds/docs/models/operations/CreateConnectionRequestBody.md +++ b/bank-feeds/docs/models/operations/CreateConnectionRequestBody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `platformKey` | *Optional* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file +| `platformKey` | *Optional\* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateConnectionResponse.md b/bank-feeds/docs/models/operations/CreateConnectionResponse.md index 88d793fb..b368d1db 100644 --- a/bank-feeds/docs/models/operations/CreateConnectionResponse.md +++ b/bank-feeds/docs/models/operations/CreateConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateSourceAccountRequest.md b/bank-feeds/docs/models/operations/CreateSourceAccountRequest.md index c51f3635..1fa85b90 100644 --- a/bank-feeds/docs/models/operations/CreateSourceAccountRequest.md +++ b/bank-feeds/docs/models/operations/CreateSourceAccountRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `requestBody` | [Optional](../../models/operations/CreateSourceAccountRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `requestBody` | [Optional\](../../models/operations/CreateSourceAccountRequestBody.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/CreateSourceAccountResponse.md b/bank-feeds/docs/models/operations/CreateSourceAccountResponse.md index 9467a94b..92cd5c76 100644 --- a/bank-feeds/docs/models/operations/CreateSourceAccountResponse.md +++ b/bank-feeds/docs/models/operations/CreateSourceAccountResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `oneOf` | [Optional](../../models/operations/CreateSourceAccountResponseBody.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `oneOf` | [Optional\](../../models/operations/CreateSourceAccountResponseBody.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/DeleteBankFeedCredentialsResponse.md b/bank-feeds/docs/models/operations/DeleteBankFeedCredentialsResponse.md index 6d760dbc..8f315882 100644 --- a/bank-feeds/docs/models/operations/DeleteBankFeedCredentialsResponse.md +++ b/bank-feeds/docs/models/operations/DeleteBankFeedCredentialsResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/DeleteCompanyResponse.md b/bank-feeds/docs/models/operations/DeleteCompanyResponse.md index d0feee97..ec962677 100644 --- a/bank-feeds/docs/models/operations/DeleteCompanyResponse.md +++ b/bank-feeds/docs/models/operations/DeleteCompanyResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/DeleteConnectionResponse.md b/bank-feeds/docs/models/operations/DeleteConnectionResponse.md index 1fc7d9a2..7ca58b59 100644 --- a/bank-feeds/docs/models/operations/DeleteConnectionResponse.md +++ b/bank-feeds/docs/models/operations/DeleteConnectionResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/DeleteSourceAccountResponse.md b/bank-feeds/docs/models/operations/DeleteSourceAccountResponse.md index 2543e452..7afc677e 100644 --- a/bank-feeds/docs/models/operations/DeleteSourceAccountResponse.md +++ b/bank-feeds/docs/models/operations/DeleteSourceAccountResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GenerateCredentialsResponse.md b/bank-feeds/docs/models/operations/GenerateCredentialsResponse.md index 1143b06d..a621fa4f 100644 --- a/bank-feeds/docs/models/operations/GenerateCredentialsResponse.md +++ b/bank-feeds/docs/models/operations/GenerateCredentialsResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `bankAccountCredentials` | [Optional](../../models/components/BankAccountCredentials.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `bankAccountCredentials` | [Optional\](../../models/components/BankAccountCredentials.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetBankAccountMappingResponse.md b/bank-feeds/docs/models/operations/GetBankAccountMappingResponse.md index 9c3223c8..6e02a43b 100644 --- a/bank-feeds/docs/models/operations/GetBankAccountMappingResponse.md +++ b/bank-feeds/docs/models/operations/GetBankAccountMappingResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankFeedMapping` | [Optional](../../models/components/BankFeedMapping.md) | :heavy_minus_sign: | Success | {
"sourceAccountId": "acc-002",
"targetAccountId": "account-081",
"sourceCurrency": "USD",
"status": "Success",
"feedStartDate": "2023-01-09T14:14:14.1057478Z",
"sourceAccountName": "ACME Bank",
"sourceAccountNumber": "1234-5678",
"sourceBalance": 500,
"targetAccountName": "ACME Bank"
} | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `bankFeedMappings` | List\<[BankFeedMapping](../../models/components/BankFeedMapping.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetCompanyInformationResponse.md b/bank-feeds/docs/models/operations/GetCompanyInformationResponse.md index 917f6323..f9afe432 100644 --- a/bank-feeds/docs/models/operations/GetCompanyInformationResponse.md +++ b/bank-feeds/docs/models/operations/GetCompanyInformationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companyInformation` | [Optional](../../models/components/CompanyInformation.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companyInformation` | [Optional\](../../models/components/CompanyInformation.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetCompanyResponse.md b/bank-feeds/docs/models/operations/GetCompanyResponse.md index ddc005f7..3a39749f 100644 --- a/bank-feeds/docs/models/operations/GetCompanyResponse.md +++ b/bank-feeds/docs/models/operations/GetCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetConfigurationResponse.md b/bank-feeds/docs/models/operations/GetConfigurationResponse.md index 77dd4a13..09162e33 100644 --- a/bank-feeds/docs/models/operations/GetConfigurationResponse.md +++ b/bank-feeds/docs/models/operations/GetConfigurationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Optional](../../models/components/Configuration.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `configuration` | [Optional\](../../models/components/Configuration.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetConnectionResponse.md b/bank-feeds/docs/models/operations/GetConnectionResponse.md index c4d7d3c4..fdd0cde7 100644 --- a/bank-feeds/docs/models/operations/GetConnectionResponse.md +++ b/bank-feeds/docs/models/operations/GetConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetCreateBankAccountsModelResponse.md b/bank-feeds/docs/models/operations/GetCreateBankAccountsModelResponse.md index cdc8abaa..cc1ac7bd 100644 --- a/bank-feeds/docs/models/operations/GetCreateBankAccountsModelResponse.md +++ b/bank-feeds/docs/models/operations/GetCreateBankAccountsModelResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `pushOption` | [Optional](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `pushOption` | [Optional\](../../models/components/PushOption.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetCreateOperationResponse.md b/bank-feeds/docs/models/operations/GetCreateOperationResponse.md index 0f31e2f9..4d753782 100644 --- a/bank-feeds/docs/models/operations/GetCreateOperationResponse.md +++ b/bank-feeds/docs/models/operations/GetCreateOperationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `pushOperation` | [Optional](../../models/components/PushOperation.md) | :heavy_minus_sign: | OK | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `pushOperation` | [Optional\](../../models/components/PushOperation.md) | :heavy_minus_sign: | OK | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/GetLastSuccessfulResponse.md b/bank-feeds/docs/models/operations/GetLastSuccessfulResponse.md index 02c61579..8f55387b 100644 --- a/bank-feeds/docs/models/operations/GetLastSuccessfulResponse.md +++ b/bank-feeds/docs/models/operations/GetLastSuccessfulResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `companySyncStatus` | [Optional](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `companySyncStatus` | [Optional\](../../models/components/CompanySyncStatus.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListBankAccountsRequest.md b/bank-feeds/docs/models/operations/ListBankAccountsRequest.md index 0d23f64e..4686e64e 100644 --- a/bank-feeds/docs/models/operations/ListBankAccountsRequest.md +++ b/bank-feeds/docs/models/operations/ListBankAccountsRequest.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListBankAccountsResponse.md b/bank-feeds/docs/models/operations/ListBankAccountsResponse.md index 1fdc1279..00c94973 100644 --- a/bank-feeds/docs/models/operations/ListBankAccountsResponse.md +++ b/bank-feeds/docs/models/operations/ListBankAccountsResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `bankAccounts` | [Optional](../../models/components/BankAccounts.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `bankAccounts` | [Optional\](../../models/components/BankAccounts.md) | :heavy_minus_sign: | Success | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListCompaniesRequest.md b/bank-feeds/docs/models/operations/ListCompaniesRequest.md index b5099c58..a1dd2014 100644 --- a/bank-feeds/docs/models/operations/ListCompaniesRequest.md +++ b/bank-feeds/docs/models/operations/ListCompaniesRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListCompaniesResponse.md b/bank-feeds/docs/models/operations/ListCompaniesResponse.md index 8548fc6e..9d57bf6c 100644 --- a/bank-feeds/docs/models/operations/ListCompaniesResponse.md +++ b/bank-feeds/docs/models/operations/ListCompaniesResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companies` | [Optional](../../models/components/Companies.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `companies` | [Optional\](../../models/components/Companies.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListConnectionsRequest.md b/bank-feeds/docs/models/operations/ListConnectionsRequest.md index a6f3e3d2..b2973f4e 100644 --- a/bank-feeds/docs/models/operations/ListConnectionsRequest.md +++ b/bank-feeds/docs/models/operations/ListConnectionsRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListConnectionsResponse.md b/bank-feeds/docs/models/operations/ListConnectionsResponse.md index f590878d..ceb3db80 100644 --- a/bank-feeds/docs/models/operations/ListConnectionsResponse.md +++ b/bank-feeds/docs/models/operations/ListConnectionsResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `connections` | [Optional](../../models/components/Connections.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `connections` | [Optional\](../../models/components/Connections.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListCreateOperationsRequest.md b/bank-feeds/docs/models/operations/ListCreateOperationsRequest.md index 5682b968..183a56f6 100644 --- a/bank-feeds/docs/models/operations/ListCreateOperationsRequest.md +++ b/bank-feeds/docs/models/operations/ListCreateOperationsRequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `orderBy` | *Optional* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | -| `page` | *Optional* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `pageSize` | *Optional* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `query` | *Optional* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file +| `orderBy` | *Optional\* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | +| `page` | *Optional\* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `pageSize` | *Optional\* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `query` | *Optional\* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListCreateOperationsResponse.md b/bank-feeds/docs/models/operations/ListCreateOperationsResponse.md index d94f7638..0d38f92a 100644 --- a/bank-feeds/docs/models/operations/ListCreateOperationsResponse.md +++ b/bank-feeds/docs/models/operations/ListCreateOperationsResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `pushOperations` | [Optional](../../models/components/PushOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | +| `pushOperations` | [Optional\](../../models/components/PushOperations.md) | :heavy_minus_sign: | OK | {
"pageNumber": 1,
"pageSize": 10,
"totalResults": 1,
"_links": {
"self": {
"href": "/companies/{id}/data/{dataType}"
},
"current": {
"href": "/companies/{id}/data/{dataType}?page=1\u0026pageSize=10"
}
}
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListSourceAccountsResponse.md b/bank-feeds/docs/models/operations/ListSourceAccountsResponse.md index 0318ff7f..7eb4cdaf 100644 --- a/bank-feeds/docs/models/operations/ListSourceAccountsResponse.md +++ b/bank-feeds/docs/models/operations/ListSourceAccountsResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `sourceAccounts` | List<[SourceAccountV2](../../models/components/SourceAccountV2.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `oneOf` | [Optional\](../../models/operations/ListSourceAccountsResponseBody.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/ListSourceAccountsResponseBody.md b/bank-feeds/docs/models/operations/ListSourceAccountsResponseBody.md new file mode 100644 index 00000000..e1eace73 --- /dev/null +++ b/bank-feeds/docs/models/operations/ListSourceAccountsResponseBody.md @@ -0,0 +1,4 @@ +# ListSourceAccountsResponseBody + +Success + diff --git a/bank-feeds/docs/models/operations/SetConfigurationRequest.md b/bank-feeds/docs/models/operations/SetConfigurationRequest.md index c69c57d7..fc686fd1 100644 --- a/bank-feeds/docs/models/operations/SetConfigurationRequest.md +++ b/bank-feeds/docs/models/operations/SetConfigurationRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `configuration` | [Optional](../../models/components/Configuration.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `configuration` | [Optional\](../../models/components/Configuration.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/SetConfigurationResponse.md b/bank-feeds/docs/models/operations/SetConfigurationResponse.md index c1cd579a..04407f5a 100644 --- a/bank-feeds/docs/models/operations/SetConfigurationResponse.md +++ b/bank-feeds/docs/models/operations/SetConfigurationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `configuration` | [Optional](../../models/components/Configuration.md) | :heavy_minus_sign: | Success | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `configuration` | [Optional\](../../models/components/Configuration.md) | :heavy_minus_sign: | Success | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UnlinkConnectionRequest.md b/bank-feeds/docs/models/operations/UnlinkConnectionRequest.md index 6ed76d28..72d6aa44 100644 --- a/bank-feeds/docs/models/operations/UnlinkConnectionRequest.md +++ b/bank-feeds/docs/models/operations/UnlinkConnectionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `requestBody` | [Optional](../../models/operations/UnlinkConnectionUpdateConnection.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `requestBody` | [Optional\](../../models/operations/UnlinkConnectionUpdateConnection.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UnlinkConnectionResponse.md b/bank-feeds/docs/models/operations/UnlinkConnectionResponse.md index bffb5d9e..d68063d5 100644 --- a/bank-feeds/docs/models/operations/UnlinkConnectionResponse.md +++ b/bank-feeds/docs/models/operations/UnlinkConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `connection` | [Optional](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | +| `connection` | [Optional\](../../models/components/Connection.md) | :heavy_minus_sign: | OK | {
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UnlinkConnectionUpdateConnection.md b/bank-feeds/docs/models/operations/UnlinkConnectionUpdateConnection.md index ba4b2967..ae37e303 100644 --- a/bank-feeds/docs/models/operations/UnlinkConnectionUpdateConnection.md +++ b/bank-feeds/docs/models/operations/UnlinkConnectionUpdateConnection.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `status` | [Optional](../../models/components/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `status` | [Optional\](../../models/components/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UpdateCompanyRequest.md b/bank-feeds/docs/models/operations/UpdateCompanyRequest.md index 3871c24e..aca6a51d 100644 --- a/bank-feeds/docs/models/operations/UpdateCompanyRequest.md +++ b/bank-feeds/docs/models/operations/UpdateCompanyRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `companyRequestBody` | [Optional](../../models/components/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `companyRequestBody` | [Optional\](../../models/components/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | +| `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UpdateCompanyResponse.md b/bank-feeds/docs/models/operations/UpdateCompanyResponse.md index e2a590f8..2beb7269 100644 --- a/bank-feeds/docs/models/operations/UpdateCompanyResponse.md +++ b/bank-feeds/docs/models/operations/UpdateCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `company` | [Optional](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | +| `company` | [Optional\](../../models/components/Company.md) | :heavy_minus_sign: | OK | {
"id": "0498e921-9b53-4396-a412-4f2f5983b0a2",
"name": "string",
"redirect": "https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739",
"lastSync": "2022-01-01T12:00:00.000Z",
"created": "2022-01-01T12:00:00.000Z",
"createdByUserName": "string",
"tags": {
"region": "us",
"uid": "f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c"
},
"dataConnections": [
{
"id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
"integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
"integrationKey": "dfxm",
"sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
"platformName": "Basiq",
"linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
"status": "Linked",
"lastSync": "2022-10-27T10:22:43.6464237Z",
"created": "2022-10-27T09:53:29Z",
"sourceType": "Banking"
}
]
} | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UpdateSourceAccountRequest.md b/bank-feeds/docs/models/operations/UpdateSourceAccountRequest.md index 2cefd3b0..0b8b84c0 100644 --- a/bank-feeds/docs/models/operations/UpdateSourceAccountRequest.md +++ b/bank-feeds/docs/models/operations/UpdateSourceAccountRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `sourceAccount` | [Optional](../../models/components/SourceAccount.md) | :heavy_minus_sign: | N/A | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | +| `sourceAccount` | [Optional\](../../models/components/SourceAccount.md) | :heavy_minus_sign: | N/A | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | | `accountId` | *String* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | | `companyId` | *String* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *String* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/bank-feeds/docs/models/operations/UpdateSourceAccountResponse.md b/bank-feeds/docs/models/operations/UpdateSourceAccountResponse.md index 3db5c86d..ba2da877 100644 --- a/bank-feeds/docs/models/operations/UpdateSourceAccountResponse.md +++ b/bank-feeds/docs/models/operations/UpdateSourceAccountResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | -| `sourceAccount` | [Optional](../../models/components/SourceAccount.md) | :heavy_minus_sign: | Success | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | +| `sourceAccount` | [Optional\](../../models/components/SourceAccount.md) | :heavy_minus_sign: | Success | {
"id": "acc-002",
"accountName": "account-081",
"sortCode": "123456",
"accountType": "Credit",
"accountNumber": "12345670",
"currency": "GBP",
"balance": 99.99,
"modifiedDate": "2023-01-09T14:14:14.1057478Z",
"status": "pending"
} | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountConnectedResponse.md b/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountConnectedResponse.md index 34eceb9d..2ee4b9cd 100644 --- a/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountConnectedResponse.md +++ b/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountConnectedResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountDisconnectedResponse.md b/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountDisconnectedResponse.md index 0f618e3a..132915c5 100644 --- a/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountDisconnectedResponse.md +++ b/bank-feeds/docs/models/webhooks/BankFeedsSourceAccountDisconnectedResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse.md b/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse.md index 8d81865c..1667253d 100644 --- a/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse.md +++ b/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse1.md b/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse1.md index 03b649e0..0d14c216 100644 --- a/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse1.md +++ b/bank-feeds/docs/models/webhooks/ClientRateLimitReachedResponse1.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse.md b/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse.md index ae5b2046..3f308003 100644 --- a/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse.md +++ b/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse1.md b/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse1.md index 04cbf9b7..234c58cd 100644 --- a/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse1.md +++ b/bank-feeds/docs/models/webhooks/ClientRateLimitResetResponse1.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse\](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/accountmapping/README.md b/bank-feeds/docs/sdks/accountmapping/README.md index fa0b75bb..0d64b004 100644 --- a/bank-feeds/docs/sdks/accountmapping/README.md +++ b/bank-feeds/docs/sdks/accountmapping/README.md @@ -8,17 +8,19 @@ Extra functionality for building an account management UI. ### Available Operations * [create](#create) - Create bank feed account mapping -* [get](#get) - List bank feed account mappings +* [get](#get) - List bank feed accounts ## create The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account). -A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). +A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). -To find valid target account options, first call list bank feed account mappings. +To find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint. -This endpoint is only needed if building an account management UI. +> **For custom builds only** +> +> Only use this endpoint if you are building your own account management UI. ### Example Usage @@ -27,45 +29,35 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.BankFeedAccountMapping; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateBankAccountMappingRequest; import io.codat.bank_feeds.models.operations.CreateBankAccountMappingResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateBankAccountMappingRequest req = CreateBankAccountMappingRequest.builder() + CreateBankAccountMappingRequest req = CreateBankAccountMappingRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .bankFeedAccountMapping(BankFeedAccountMapping.builder() - .sourceAccountId("") + .sourceAccountId("") + .targetAccountId("account-081") .build()) .build(); - CreateBankAccountMappingResponse res = sdk.accountMapping().create() + CreateBankAccountMappingResponse res = sdk.accountMapping().create() .request(req) .call(); - if (res.bankFeedAccountMappingResponse().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.bankFeedAccountMappingResponse().isPresent()) { + // handle response } - } } ``` @@ -82,19 +74,20 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get -The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts. +The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts. -A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). +A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). -This endpoint is only needed if building an account management UI. +> **For custom builds only** +> +> Only use this endpoint if you are building your own account management UI. ### Example Usage @@ -102,42 +95,31 @@ This endpoint is only needed if building an account management UI. package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetBankAccountMappingRequest; import io.codat.bank_feeds.models.operations.GetBankAccountMappingResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetBankAccountMappingRequest req = GetBankAccountMappingRequest.builder() + GetBankAccountMappingRequest req = GetBankAccountMappingRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetBankAccountMappingResponse res = sdk.accountMapping().get() + GetBankAccountMappingResponse res = sdk.accountMapping().get() .request(req) .call(); - if (res.bankFeedMapping().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.bankFeedMappings().isPresent()) { + // handle response } - } } ``` @@ -154,7 +136,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/bankaccounts/README.md b/bank-feeds/docs/sdks/bankaccounts/README.md index 76712dd2..f515a141 100644 --- a/bank-feeds/docs/sdks/bankaccounts/README.md +++ b/bank-feeds/docs/sdks/bankaccounts/README.md @@ -19,9 +19,7 @@ The *Create bank account* endpoint creates a new [bank account](https://docs.cod **Integration-specific behaviour** -Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/bank-feeds-api#/operations/get-create-update-bankAccounts-model). - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. +Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/bank-feeds-api#/operations/get-create-update-bankAccounts-model). ### Example Usage @@ -31,20 +29,20 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.BankAccountPrototype; import io.codat.bank_feeds.models.components.BankAccountStatus; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateBankAccountRequest; import io.codat.bank_feeds.models.operations.CreateBankAccountResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateBankAccountRequest req = CreateBankAccountRequest.builder() + CreateBankAccountRequest req = CreateBankAccountRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .bankAccountPrototype(BankAccountPrototype.builder() @@ -53,24 +51,13 @@ public class Application { .build()) .build(); - CreateBankAccountResponse res = sdk.bankAccounts().create() + CreateBankAccountResponse res = sdk.bankAccounts().create() .request(req) .call(); - if (res.bankAccountCreateResponse().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.bankAccountCreateResponse().isPresent()) { + // handle response } - } } ``` @@ -87,11 +74,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getCreateModel @@ -102,8 +88,6 @@ The *Get create/update bank account model* endpoint returns the expected data fo **Integration-specific behaviour** See the *response examples* for integration-specific indicative models. - -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. ### Example Usage @@ -112,42 +96,31 @@ Check out our [coverage explorer](https://knowledge.codat.io/supported-features/ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetCreateBankAccountsModelRequest; import io.codat.bank_feeds.models.operations.GetCreateBankAccountsModelResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCreateBankAccountsModelRequest req = GetCreateBankAccountsModelRequest.builder() + GetCreateBankAccountsModelRequest req = GetCreateBankAccountsModelRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetCreateBankAccountsModelResponse res = sdk.bankAccounts().getCreateModel() + GetCreateBankAccountsModelResponse res = sdk.bankAccounts().getCreateModel() .request(req) .call(); - if (res.pushOption().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOption().isPresent()) { + // handle response } - } } ``` @@ -164,11 +137,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -185,20 +157,20 @@ Before using this endpoint, you must have [retrieved data for the company](https package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.ListBankAccountsRequest; import io.codat.bank_feeds.models.operations.ListBankAccountsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListBankAccountsRequest req = ListBankAccountsRequest.builder() + ListBankAccountsRequest req = ListBankAccountsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .orderBy("-modifiedDate") @@ -207,24 +179,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListBankAccountsResponse res = sdk.bankAccounts().list() + ListBankAccountsResponse res = sdk.bankAccounts().list() .request(req) .call(); - if (res.bankAccounts().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.bankAccounts().isPresent()) { + // handle response } - } } ``` @@ -241,7 +202,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ----------------------------------- | ----------------------------------- | ----------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,409,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 409, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/companies/README.md b/bank-feeds/docs/sdks/companies/README.md index 8b615157..f194a706 100644 --- a/bank-feeds/docs/sdks/companies/README.md +++ b/bank-feeds/docs/sdks/companies/README.md @@ -29,47 +29,30 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CompanyRequestBody req = CompanyRequestBody.builder() + CompanyRequestBody req = CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build(); - CreateCompanyResponse res = sdk.companies().create() + CreateCompanyResponse res = sdk.companies().create() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -86,11 +69,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## delete @@ -106,39 +88,28 @@ Each company can have multiple [connections](https://docs.codat.io/bank-feeds-ap package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.DeleteCompanyRequest; import io.codat.bank_feeds.models.operations.DeleteCompanyResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteCompanyRequest req = DeleteCompanyRequest.builder() + DeleteCompanyRequest req = DeleteCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - DeleteCompanyResponse res = sdk.companies().delete() + DeleteCompanyResponse res = sdk.companies().delete() .request(req) .call(); - // handle response - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -155,11 +126,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -175,41 +145,30 @@ Each company can have multiple [connections](https://docs.codat.io/bank-feeds-ap package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetCompanyRequest; import io.codat.bank_feeds.models.operations.GetCompanyResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCompanyRequest req = GetCompanyRequest.builder() + GetCompanyRequest req = GetCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetCompanyResponse res = sdk.companies().get() + GetCompanyResponse res = sdk.companies().get() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -226,15 +185,14 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list -The *List companies* endpoint returns a list of [companies] associated to your instances. +The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances. A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -245,44 +203,33 @@ Each company can have multiple [connections](https://docs.codat.io/bank-feeds-ap package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.ListCompaniesRequest; import io.codat.bank_feeds.models.operations.ListCompaniesResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListCompaniesRequest req = ListCompaniesRequest.builder() + ListCompaniesRequest req = ListCompaniesRequest.builder() .orderBy("-modifiedDate") .page(1) .pageSize(100) .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListCompaniesResponse res = sdk.companies().list() + ListCompaniesResponse res = sdk.companies().list() .request(req) .call(); - if (res.companies().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companies().isPresent()) { + // handle response } - } } ``` @@ -299,16 +246,14 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update Use the *Update company* endpoint to update both the name and description of the company. -If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -320,51 +265,34 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.CompanyRequestBody; -import io.codat.bank_feeds.models.components.GroupReference; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.UpdateCompanyRequest; import io.codat.bank_feeds.models.operations.UpdateCompanyResponse; import java.lang.Exception; -import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateCompanyRequest req = UpdateCompanyRequest.builder() + UpdateCompanyRequest req = UpdateCompanyRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .companyRequestBody(CompanyRequestBody.builder() .name("Bank of Dave") .description("Requested early access to the new financing scheme.") - .groups(List.of( - GroupReference.builder() - .id("60d2fa12-8a04-11ee-b9d1-0242ac120002") - .build())) .build()) .build(); - UpdateCompanyResponse res = sdk.companies().update() + UpdateCompanyResponse res = sdk.companies().update() .request(req) .call(); - if (res.company().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.company().isPresent()) { + // handle response } - } } ``` @@ -381,7 +309,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/companyinformation/README.md b/bank-feeds/docs/sdks/companyinformation/README.md index a1770308..cd61f73d 100644 --- a/bank-feeds/docs/sdks/companyinformation/README.md +++ b/bank-feeds/docs/sdks/companyinformation/README.md @@ -21,42 +21,31 @@ Use the *Get company information* endpoint to return information about the compa package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetCompanyInformationRequest; import io.codat.bank_feeds.models.operations.GetCompanyInformationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCompanyInformationRequest req = GetCompanyInformationRequest.builder() + GetCompanyInformationRequest req = GetCompanyInformationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetCompanyInformationResponse res = sdk.companyInformation().get() + GetCompanyInformationResponse res = sdk.companyInformation().get() .request(req) .call(); - if (res.companyInformation().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companyInformation().isPresent()) { + // handle response } - } } ``` @@ -73,7 +62,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/configuration/README.md b/bank-feeds/docs/sdks/configuration/README.md index 48acc83f..12326296 100644 --- a/bank-feeds/docs/sdks/configuration/README.md +++ b/bank-feeds/docs/sdks/configuration/README.md @@ -20,41 +20,30 @@ Configure bank feeds for a company. package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetConfigurationRequest; import io.codat.bank_feeds.models.operations.GetConfigurationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetConfigurationRequest req = GetConfigurationRequest.builder() + GetConfigurationRequest req = GetConfigurationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetConfigurationResponse res = sdk.configuration().get() + GetConfigurationResponse res = sdk.configuration().get() .request(req) .call(); - if (res.configuration().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.configuration().isPresent()) { + // handle response } - } } ``` @@ -71,11 +60,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## set @@ -88,44 +76,33 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.Configuration; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.SetConfigurationRequest; import io.codat.bank_feeds.models.operations.SetConfigurationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - SetConfigurationRequest req = SetConfigurationRequest.builder() + SetConfigurationRequest req = SetConfigurationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .configuration(Configuration.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build()) .build(); - SetConfigurationResponse res = sdk.configuration().set() + SetConfigurationResponse res = sdk.configuration().set() .request(req) .call(); - if (res.configuration().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.configuration().isPresent()) { + // handle response } - } } ``` @@ -142,7 +119,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/connections/README.md b/bank-feeds/docs/sdks/connections/README.md index b1900a4a..f42c9e9e 100644 --- a/bank-feeds/docs/sdks/connections/README.md +++ b/bank-feeds/docs/sdks/connections/README.md @@ -17,7 +17,7 @@ Create new and manage existing data connections for a company. Creates a connection for the company by providing a valid `platformKey`. -Use the [List Integrations](https://docs.codat.io/bank-feeds-api#/operations/list-integrations) endpoint to access valid platform keys. +Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. ### Example Usage @@ -25,7 +25,7 @@ Use the [List Integrations](https://docs.codat.io/bank-feeds-api#/operations/lis package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateConnectionRequest; import io.codat.bank_feeds.models.operations.CreateConnectionRequestBody; import io.codat.bank_feeds.models.operations.CreateConnectionResponse; @@ -33,37 +33,26 @@ import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateConnectionRequest req = CreateConnectionRequest.builder() + CreateConnectionRequest req = CreateConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .requestBody(CreateConnectionRequestBody.builder() .platformKey("gbol") .build()) .build(); - CreateConnectionResponse res = sdk.connections().create() + CreateConnectionResponse res = sdk.connections().create() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -80,11 +69,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## delete @@ -97,40 +85,29 @@ This operation is not reversible. The end user would need to reauthorize a new d package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.DeleteConnectionRequest; import io.codat.bank_feeds.models.operations.DeleteConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteConnectionRequest req = DeleteConnectionRequest.builder() + DeleteConnectionRequest req = DeleteConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - DeleteConnectionResponse res = sdk.connections().delete() + DeleteConnectionResponse res = sdk.connections().delete() .request(req) .call(); - // handle response - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -147,11 +124,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## get @@ -163,42 +139,31 @@ public class Application { package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetConnectionRequest; import io.codat.bank_feeds.models.operations.GetConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetConnectionRequest req = GetConnectionRequest.builder() + GetConnectionRequest req = GetConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GetConnectionResponse res = sdk.connections().get() + GetConnectionResponse res = sdk.connections().get() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -215,11 +180,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list @@ -231,20 +195,20 @@ public class Application { package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.ListConnectionsRequest; import io.codat.bank_feeds.models.operations.ListConnectionsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListConnectionsRequest req = ListConnectionsRequest.builder() + ListConnectionsRequest req = ListConnectionsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -252,24 +216,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListConnectionsResponse res = sdk.connections().list() + ListConnectionsResponse res = sdk.connections().list() .request(req) .call(); - if (res.connections().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connections().isPresent()) { + // handle response } - } } ``` @@ -286,11 +239,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## unlink @@ -302,42 +254,31 @@ public class Application { package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.UnlinkConnectionRequest; import io.codat.bank_feeds.models.operations.UnlinkConnectionResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UnlinkConnectionRequest req = UnlinkConnectionRequest.builder() + UnlinkConnectionRequest req = UnlinkConnectionRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - UnlinkConnectionResponse res = sdk.connections().unlink() + UnlinkConnectionResponse res = sdk.connections().unlink() .request(req) .call(); - if (res.connection().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.connection().isPresent()) { + // handle response } - } } ``` @@ -354,7 +295,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/sourceaccounts/README.md b/bank-feeds/docs/sdks/sourceaccounts/README.md index 0dedfe70..b6a07bf4 100644 --- a/bank-feeds/docs/sdks/sourceaccounts/README.md +++ b/bank-feeds/docs/sdks/sourceaccounts/README.md @@ -50,8 +50,11 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.AccountInfo; import io.codat.bank_feeds.models.components.AccountType; +import io.codat.bank_feeds.models.components.RoutingInfo; import io.codat.bank_feeds.models.components.SourceAccountV2; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.components.SourceAccountV2Status; +import io.codat.bank_feeds.models.components.Type; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateSourceAccountRequest; import io.codat.bank_feeds.models.operations.CreateSourceAccountRequestBody; import io.codat.bank_feeds.models.operations.CreateSourceAccountResponse; @@ -60,48 +63,45 @@ import java.math.BigDecimal; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateSourceAccountRequest req = CreateSourceAccountRequest.builder() + CreateSourceAccountRequest req = CreateSourceAccountRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .requestBody(CreateSourceAccountRequestBody.of(SourceAccountV2.builder() .accountName("") .accountNumber("") - .accountType(AccountType.PREPAID_CARD) - .balance(new BigDecimal("4174.58")) + .accountType(AccountType.LOAN) + .balance(new BigDecimal("1343.65")) .currency("GBP") .id("") .accountInfo(AccountInfo.builder() - .accountOpenDate("2022-10-23") + .accountOpenDate("2023-05-23T00:00:00Z") + .availableBalance(new BigDecimal("400")) + .description("account description 2") + .nickname("account 1290") + .build()) + .feedStartDate("2024-05-01T00:00:00Z") + .modifiedDate("2024-08-02T00:00:00.000Z") + .routingInfo(RoutingInfo.builder() + .bankCode("21001088") + .type(Type.BANKCODE) .build()) - .feedStartDate("2022-10-23") - .modifiedDate("2022-10-23T00:00:00Z") + .status(SourceAccountV2Status.PENDING) .build())) .build(); - CreateSourceAccountResponse res = sdk.sourceAccounts().create() + CreateSourceAccountResponse res = sdk.sourceAccounts().create() .request(req) .call(); - if (res.oneOf().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.oneOf().isPresent()) { + // handle response } - } } ``` @@ -118,11 +118,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## delete @@ -137,41 +136,30 @@ Removing a source account will also remove any mapping between the source bank f package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.DeleteSourceAccountRequest; import io.codat.bank_feeds.models.operations.DeleteSourceAccountResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteSourceAccountRequest req = DeleteSourceAccountRequest.builder() - .accountId("EILBDVJVNUAGVKRQ") + DeleteSourceAccountRequest req = DeleteSourceAccountRequest.builder() + .accountId("7110701885") .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - DeleteSourceAccountResponse res = sdk.sourceAccounts().delete() + DeleteSourceAccountResponse res = sdk.sourceAccounts().delete() .request(req) .call(); - // handle response - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -188,11 +176,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## deleteCredentials @@ -206,40 +193,29 @@ In cases where multiple credential sets have been generated, a single API call t package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.DeleteBankFeedCredentialsRequest; import io.codat.bank_feeds.models.operations.DeleteBankFeedCredentialsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - DeleteBankFeedCredentialsRequest req = DeleteBankFeedCredentialsRequest.builder() + DeleteBankFeedCredentialsRequest req = DeleteBankFeedCredentialsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - DeleteBankFeedCredentialsResponse res = sdk.sourceAccounts().deleteCredentials() + DeleteBankFeedCredentialsResponse res = sdk.sourceAccounts().deleteCredentials() .request(req) .call(); - // handle response - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; - } - + // handle response } } ``` @@ -256,18 +232,20 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## generateCredentials -The _Generate Bank Account Credentials_ endpoint can be used to generate credentials for QuickBooks Online to use for authentication of the Bank Feed in their portal, each time this is used a new set of credentials will be generated. +The _Generate bank account credentials_ endpoint can be used to generate credentials for QuickBooks Online to authenticate the Bank Feed in the QBO portal. Each time this endpoint is called, a new set of credentials will be generated. The old credentials will still be valid until the revoke credentials endpoint is used, which will revoke all credentials associated to the data connection. +> **For QuickBooks Online only** +> +> Only call this endpoint when onboarding SMBs that use QuickBooks Online. ### Example Usage @@ -275,43 +253,33 @@ The old credentials will still be valid until the revoke credentials endpoint is package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GenerateCredentialsRequest; import io.codat.bank_feeds.models.operations.GenerateCredentialsResponse; import java.lang.Exception; +import java.nio.charset.StandardCharsets; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GenerateCredentialsRequest req = GenerateCredentialsRequest.builder() - .requestBody("0xeDCfFBde9E".getBytes()) + GenerateCredentialsRequest req = GenerateCredentialsRequest.builder() + .requestBody("0xeCFd9fD7b9".getBytes(StandardCharsets.UTF_8)) .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - GenerateCredentialsResponse res = sdk.sourceAccounts().generateCredentials() + GenerateCredentialsResponse res = sdk.sourceAccounts().generateCredentials() .request(req) .call(); - if (res.bankAccountCredentials().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.bankAccountCredentials().isPresent()) { + // handle response } - } } ``` @@ -328,17 +296,16 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## list The _List source accounts_ endpoint returns a list of [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) for a given company's connection. -[source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. +[Source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. > ### Versioning > If you are integrating the Bank Feeds API with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. @@ -349,42 +316,31 @@ public class Application { package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.ListSourceAccountsRequest; import io.codat.bank_feeds.models.operations.ListSourceAccountsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListSourceAccountsRequest req = ListSourceAccountsRequest.builder() + ListSourceAccountsRequest req = ListSourceAccountsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .build(); - ListSourceAccountsResponse res = sdk.sourceAccounts().list() + ListSourceAccountsResponse res = sdk.sourceAccounts().list() .request(req) .call(); - if (res.sourceAccounts().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.oneOf().isPresent()) { + // handle response } - } } ``` @@ -401,11 +357,10 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## update @@ -423,49 +378,46 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.SourceAccount; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.components.Status; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.UpdateSourceAccountRequest; import io.codat.bank_feeds.models.operations.UpdateSourceAccountResponse; import java.lang.Exception; +import java.math.BigDecimal; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - UpdateSourceAccountRequest req = UpdateSourceAccountRequest.builder() + UpdateSourceAccountRequest req = UpdateSourceAccountRequest.builder() .accountId("7110701885") .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .sourceAccount(SourceAccount.builder() .id("") - .currency("EUR") + .accountName("account-081") + .accountNumber("12345670") + .accountType("Credit") + .balance(new BigDecimal("99.99")) + .currency("GBP") .feedStartDate("2022-10-23T00:00:00Z") - .modifiedDate("2022-10-23T00:00:00Z") + .modifiedDate("2023-01-09T14:14:14.1057478Z") + .sortCode("123456") + .status(Status.PENDING) .build()) .build(); - UpdateSourceAccountResponse res = sdk.sourceAccounts().update() + UpdateSourceAccountResponse res = sdk.sourceAccounts().update() .request(req) .call(); - if (res.sourceAccount().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.sourceAccount().isPresent()) { + // handle response } - } } ``` @@ -482,7 +434,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/sync/README.md b/bank-feeds/docs/sdks/sync/README.md index a22e0d11..701530cc 100644 --- a/bank-feeds/docs/sdks/sync/README.md +++ b/bank-feeds/docs/sdks/sync/README.md @@ -19,41 +19,30 @@ Use the _Get last successful sync_ endpoint to obtain the status information for package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetLastSuccessfulRequest; import io.codat.bank_feeds.models.operations.GetLastSuccessfulResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetLastSuccessfulRequest req = GetLastSuccessfulRequest.builder() + GetLastSuccessfulRequest req = GetLastSuccessfulRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .build(); - GetLastSuccessfulResponse res = sdk.sync().getLastSuccessfulSync() + GetLastSuccessfulResponse res = sdk.sync().getLastSuccessfulSync() .request(req) .call(); - if (res.companySyncStatus().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.companySyncStatus().isPresent()) { + // handle response } - } } ``` @@ -70,7 +59,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/docs/sdks/transactions/README.md b/bank-feeds/docs/sdks/transactions/README.md index 284b2ae1..4f7ce0bc 100644 --- a/bank-feeds/docs/sdks/transactions/README.md +++ b/bank-feeds/docs/sdks/transactions/README.md @@ -21,8 +21,6 @@ Create new bank account transactions for a company's connections, and see previo Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bankTransactions-model). -Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. - ### Example Usage @@ -32,7 +30,7 @@ package hello.world; import io.codat.bank_feeds.CodatBankFeeds; import io.codat.bank_feeds.models.components.BankTransactions; import io.codat.bank_feeds.models.components.CreateBankTransactions; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.CreateBankTransactionsRequest; import io.codat.bank_feeds.models.operations.CreateBankTransactionsResponse; import java.lang.Exception; @@ -41,18 +39,18 @@ import java.util.List; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - CreateBankTransactionsRequest req = CreateBankTransactionsRequest.builder() + CreateBankTransactionsRequest req = CreateBankTransactionsRequest.builder() .accountId("9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2") .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .connectionId("2e9d2c44-f675-40ba-8049-353bfcb5e171") .createBankTransactions(CreateBankTransactions.builder() - .accountId("Checking 0202") + .accountId("EILBDVJVNUAGVKRQ") .transactions(List.of( BankTransactions.builder() .amount(new BigDecimal("999.99")) @@ -67,24 +65,13 @@ public class Application { .build()) .build(); - CreateBankTransactionsResponse res = sdk.transactions().create() + CreateBankTransactionsResponse res = sdk.transactions().create() .request(req) .call(); - if (res.createBankTransactionsResponse().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.createBankTransactionsResponse().isPresent()) { + // handle response } - } } ``` @@ -101,15 +88,18 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## getCreateOperation -Retrieve push operation. +The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. + +Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + +For bank feeds, your push operations will only relate to the `bankTransactions` data type. ### Example Usage @@ -117,42 +107,31 @@ Retrieve push operation. package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.GetCreateOperationRequest; import io.codat.bank_feeds.models.operations.GetCreateOperationResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - GetCreateOperationRequest req = GetCreateOperationRequest.builder() + GetCreateOperationRequest req = GetCreateOperationRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") - .pushOperationKey("1fb73c31-a851-46c2-ab8a-5ce6e25b57b8") + .pushOperationKey("1b33a562-bac6-42b7-8818-d55dba8df363") .build(); - GetCreateOperationResponse res = sdk.transactions().getCreateOperation() + GetCreateOperationResponse res = sdk.transactions().getCreateOperation() .request(req) .call(); - if (res.pushOperation().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOperation().isPresent()) { + // handle response } - } } ``` @@ -169,15 +148,18 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| --------------------------- | --------------------------- | --------------------------- | -| models/errors/ErrorMessage | 401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | - +| Error Type | Status Code | Content Type | +| --------------------------------- | --------------------------------- | --------------------------------- | +| models/errors/ErrorMessage | 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | ## listCreateOperations -List create operations. +The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company. + +Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + +For bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type. ### Example Usage @@ -185,20 +167,20 @@ List create operations. package hello.world; import io.codat.bank_feeds.CodatBankFeeds; -import io.codat.bank_feeds.models.errors.SDKError; +import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.operations.ListCreateOperationsRequest; import io.codat.bank_feeds.models.operations.ListCreateOperationsResponse; import java.lang.Exception; public class Application { - public static void main(String[] args) throws Exception { - try { - CodatBankFeeds sdk = CodatBankFeeds.builder() + public static void main(String[] args) throws ErrorMessage, Exception { + + CodatBankFeeds sdk = CodatBankFeeds.builder() .authHeader("Basic BASE_64_ENCODED(API_KEY)") - .build(); + .build(); - ListCreateOperationsRequest req = ListCreateOperationsRequest.builder() + ListCreateOperationsRequest req = ListCreateOperationsRequest.builder() .companyId("8a210b68-6988-11ed-a1eb-0242ac120002") .orderBy("-modifiedDate") .page(1) @@ -206,24 +188,13 @@ public class Application { .query("id=e3334455-1aed-4e71-ab43-6bccf12092ee") .build(); - ListCreateOperationsResponse res = sdk.transactions().listCreateOperations() + ListCreateOperationsResponse res = sdk.transactions().listCreateOperations() .request(req) .call(); - if (res.pushOperations().isPresent()) { - // handle response - } - } catch (io.codat.bank_feeds.models.errors.ErrorMessage e) { - // handle exception - throw e; - } catch (SDKError e) { - // handle exception - throw e; - } catch (Exception e) { - // handle exception - throw e; + if (res.pushOperations().isPresent()) { + // handle response } - } } ``` @@ -240,7 +211,7 @@ public class Application { ### Errors -| Error Object | Status Code | Content Type | -| ------------------------------- | ------------------------------- | ------------------------------- | -| models/errors/ErrorMessage | 400,401,402,403,404,429,500,503 | application/json | -| models/errors/SDKError | 4xx-5xx | \*\/* | +| Error Type | Status Code | Content Type | +| -------------------------------------- | -------------------------------------- | -------------------------------------- | +| models/errors/ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json | +| models/errors/SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/AccountMapping.java b/bank-feeds/src/main/java/io/codat/bank_feeds/AccountMapping.java index 2479e7db..bd68ba52 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/AccountMapping.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/AccountMapping.java @@ -59,11 +59,13 @@ public class AccountMapping implements * Create bank feed account mapping * The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account). * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * To find valid target account options, first call list bank feed account mappings. + * To find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint. * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @return The call builder */ public CreateBankAccountMappingRequestBuilder create() { @@ -74,11 +76,13 @@ public CreateBankAccountMappingRequestBuilder create() { * Create bank feed account mapping * The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account). * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * To find valid target account options, first call list bank feed account mappings. + * To find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint. * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -92,11 +96,13 @@ public CreateBankAccountMappingResponse create( * Create bank feed account mapping * The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting software (target account). * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * To find valid target account options, first call list bank feed account mappings. + * To find valid target account options, first call the [List bank feed account mappings](https://docs.codat.io//bank-feeds-api#/operations/get-bank-account-mapping) endpoint. * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -107,7 +113,7 @@ public CreateBankAccountMappingResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -129,7 +135,7 @@ public CreateBankAccountMappingResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -253,12 +259,14 @@ public CreateBankAccountMappingResponse create( /** - * List bank feed account mappings - * The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts. + * List bank feed accounts + * The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts. * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @return The call builder */ public GetBankAccountMappingRequestBuilder get() { @@ -266,12 +274,14 @@ public GetBankAccountMappingRequestBuilder get() { } /** - * List bank feed account mappings - * The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts. + * List bank feed accounts + * The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts. * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -282,12 +292,14 @@ public GetBankAccountMappingResponse get( } /** - * List bank feed account mappings - * The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts. + * List bank feed accounts + * The *List bank accounts* endpoint returns information about a source bank account and any current or potential target mapping accounts. * - * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end users account in the underlying platform). + * A bank feed account mapping is a specified link between the source account (provided by the Codat user) and the target account (the end user's account in the underlying software). * - * This endpoint is only needed if building an account management UI. + * > **For custom builds only** + * > + * > Only use this endpoint if you are building your own account management UI. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -298,7 +310,7 @@ public GetBankAccountMappingResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -310,7 +322,7 @@ public GetBankAccountMappingResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -389,10 +401,10 @@ public GetBankAccountMappingResponse get( if (Utils.statusCodeMatches(_httpRes.statusCode(), "200")) { if (Utils.contentTypeMatches(_contentType, "application/json")) { - BankFeedMapping _out = Utils.mapper().readValue( + List _out = Utils.mapper().readValue( Utils.toUtf8AndClose(_httpRes.body()), - new TypeReference() {}); - _res.withBankFeedMapping(Optional.ofNullable(_out)); + new TypeReference>() {}); + _res.withBankFeedMappings(Optional.ofNullable(_out)); return _res; } else { throw new SDKError( diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/BankAccounts.java b/bank-feeds/src/main/java/io/codat/bank_feeds/BankAccounts.java index d96db20e..edc92590 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/BankAccounts.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/BankAccounts.java @@ -68,8 +68,6 @@ public class BankAccounts implements * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/bank-feeds-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @return The call builder */ public CreateBankAccountRequestBuilder create() { @@ -85,8 +83,6 @@ public CreateBankAccountRequestBuilder create() { * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/bank-feeds-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -105,8 +101,6 @@ public CreateBankAccountResponse create( * **Integration-specific behaviour** * * Required data may vary by integration. To see what data to post, first call [Get create/update bank account model](https://docs.codat.io/bank-feeds-api#/operations/get-create-update-bankAccounts-model). - * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating an account. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -117,7 +111,7 @@ public CreateBankAccountResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -139,7 +133,7 @@ public CreateBankAccountResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateBankAccountRequest.class, @@ -277,8 +271,6 @@ public CreateBankAccountResponse create( * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @return The call builder */ public GetCreateBankAccountsModelRequestBuilder getCreateModel() { @@ -295,8 +287,6 @@ public GetCreateBankAccountsModelRequestBuilder getCreateModel() { * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -316,8 +306,6 @@ public GetCreateBankAccountsModelResponse getCreateModel( * * See the *response examples* for integration-specific indicative models. * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts) for integrations that support creating and updating a bank account. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -328,7 +316,7 @@ public GetCreateBankAccountsModelResponse getCreateModel( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -340,7 +328,7 @@ public GetCreateBankAccountsModelResponse getCreateModel( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -512,7 +500,7 @@ public ListBankAccountsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -524,7 +512,7 @@ public ListBankAccountsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListBankAccountsRequest.class, diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/CodatBankFeeds.java b/bank-feeds/src/main/java/io/codat/bank_feeds/CodatBankFeeds.java index 63c217e8..2e3a6a3a 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/CodatBankFeeds.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/CodatBankFeeds.java @@ -8,6 +8,7 @@ import io.codat.bank_feeds.utils.HTTPClient; import io.codat.bank_feeds.utils.RetryConfig; import io.codat.bank_feeds.utils.SpeakeasyHTTPClient; +import io.codat.bank_feeds.utils.Utils; import java.lang.String; import java.util.Map; import java.util.Optional; @@ -218,7 +219,7 @@ public Builder serverURL(String serverUrl) { * @return The builder instance. */ public Builder serverURL(String serverUrl, Map params) { - this.sdkConfiguration.serverUrl = io.codat.bank_feeds.utils.Utils.templateUrl(serverUrl, params); + this.sdkConfiguration.serverUrl = Utils.templateUrl(serverUrl, params); return this; } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/Companies.java b/bank-feeds/src/main/java/io/codat/bank_feeds/Companies.java index 62eaf177..cf341ae0 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/Companies.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/Companies.java @@ -113,7 +113,7 @@ public CreateCompanyResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -133,7 +133,7 @@ public CreateCompanyResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -302,7 +302,7 @@ public DeleteCompanyResponse delete( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -314,7 +314,7 @@ public DeleteCompanyResponse delete( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -472,7 +472,7 @@ public GetCompanyResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -484,7 +484,7 @@ public GetCompanyResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -609,7 +609,7 @@ public GetCompanyResponse get( /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -621,7 +621,7 @@ public ListCompaniesRequestBuilder list() { /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -636,7 +636,7 @@ public ListCompaniesResponse list( /** * List companies - * The *List companies* endpoint returns a list of [companies] associated to your instances. + * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -650,7 +650,7 @@ public ListCompaniesResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -660,7 +660,7 @@ public ListCompaniesResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListCompaniesRequest.class, @@ -791,7 +791,6 @@ public ListCompaniesResponse list( /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -804,7 +803,6 @@ public UpdateCompanyRequestBuilder update() { /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -820,7 +818,6 @@ public UpdateCompanyResponse update( /** * Update company * Use the *Update company* endpoint to update both the name and description of the company. - * If you use [groups](https://docs.codat.io/bank-feeds-api#/schemas/Group) to manage a set of companies, use the [Add company](https://docs.codat.io/bank-feeds-api#/operations/add-company-to-group) or [Remove company](https://docs.codat.io/bank-feeds-api#/operations/remove-company-from-group) endpoints to add or remove a company from a group. * * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data. * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data. @@ -834,7 +831,7 @@ public UpdateCompanyResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -856,7 +853,7 @@ public UpdateCompanyResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/CompanyInformation.java b/bank-feeds/src/main/java/io/codat/bank_feeds/CompanyInformation.java index 7efa37de..4267c274 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/CompanyInformation.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/CompanyInformation.java @@ -86,7 +86,7 @@ public GetCompanyInformationResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -98,7 +98,7 @@ public GetCompanyInformationResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/Configuration.java b/bank-feeds/src/main/java/io/codat/bank_feeds/Configuration.java index c21e0f87..154b96c0 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/Configuration.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/Configuration.java @@ -87,7 +87,7 @@ public GetConfigurationResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -99,7 +99,7 @@ public GetConfigurationResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -256,7 +256,7 @@ public SetConfigurationResponse set( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -278,7 +278,7 @@ public SetConfigurationResponse set( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/Connections.java b/bank-feeds/src/main/java/io/codat/bank_feeds/Connections.java index 6f00e8ee..1a923f1c 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/Connections.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/Connections.java @@ -70,7 +70,7 @@ public class Connections implements * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/bank-feeds-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @return The call builder */ public CreateConnectionRequestBuilder create() { @@ -81,7 +81,7 @@ public CreateConnectionRequestBuilder create() { * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/bank-feeds-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -95,7 +95,7 @@ public CreateConnectionResponse create( * Create connection * Creates a connection for the company by providing a valid `platformKey`. * - * Use the [List Integrations](https://docs.codat.io/bank-feeds-api#/operations/list-integrations) endpoint to access valid platform keys. + * Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -106,7 +106,7 @@ public CreateConnectionResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -128,7 +128,7 @@ public CreateConnectionResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -288,7 +288,7 @@ public DeleteConnectionResponse delete( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -300,7 +300,7 @@ public DeleteConnectionResponse delete( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -446,7 +446,7 @@ public GetConnectionResponse get( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -458,7 +458,7 @@ public GetConnectionResponse get( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -615,7 +615,7 @@ public ListConnectionsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -627,7 +627,7 @@ public ListConnectionsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListConnectionsRequest.class, @@ -789,7 +789,7 @@ public UnlinkConnectionResponse unlink( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -811,7 +811,7 @@ public UnlinkConnectionResponse unlink( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/SDKConfiguration.java b/bank-feeds/src/main/java/io/codat/bank_feeds/SDKConfiguration.java index c749f873..b29d3753 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/SDKConfiguration.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/SDKConfiguration.java @@ -21,11 +21,14 @@ public Optional securitySource() { public HTTPClient defaultClient; public String serverUrl; public int serverIdx = 0; - public String language = "java"; - public String openapiDocVersion = "3.0.0"; - public String sdkVersion = "0.2.0"; - public String genVersion = "2.415.6"; - public String userAgent = "speakeasy-sdk/java 0.2.0 2.415.6 3.0.0 io.codat.bank_feeds"; + private static final String LANGUAGE = "java"; + public static final String OPENAPI_DOC_VERSION = "3.0.0"; + public static final String SDK_VERSION = "1.0.0"; + public static final String GEN_VERSION = "2.451.0"; + private static final String BASE_PACKAGE = "io.codat.bank_feeds"; + public static final String USER_AGENT = + String.format("speakeasy-sdk/%s %s %s %s %s", + LANGUAGE, SDK_VERSION, GEN_VERSION, OPENAPI_DOC_VERSION, BASE_PACKAGE); private Hooks _hooks = createHooks(); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/SourceAccounts.java b/bank-feeds/src/main/java/io/codat/bank_feeds/SourceAccounts.java index 93597557..f7c2d736 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/SourceAccounts.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/SourceAccounts.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.core.type.TypeReference; import io.codat.bank_feeds.models.components.BankAccountCredentials; import io.codat.bank_feeds.models.components.SourceAccount; -import io.codat.bank_feeds.models.components.SourceAccountV2; import io.codat.bank_feeds.models.errors.ErrorMessage; import io.codat.bank_feeds.models.errors.SDKError; import io.codat.bank_feeds.models.operations.CreateSourceAccountRequest; @@ -26,6 +25,7 @@ import io.codat.bank_feeds.models.operations.ListSourceAccountsRequest; import io.codat.bank_feeds.models.operations.ListSourceAccountsRequestBuilder; import io.codat.bank_feeds.models.operations.ListSourceAccountsResponse; +import io.codat.bank_feeds.models.operations.ListSourceAccountsResponseBody; import io.codat.bank_feeds.models.operations.SDKMethodInterfaces.*; import io.codat.bank_feeds.models.operations.UpdateSourceAccountRequest; import io.codat.bank_feeds.models.operations.UpdateSourceAccountRequestBuilder; @@ -179,7 +179,7 @@ public CreateSourceAccountResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -201,7 +201,7 @@ public CreateSourceAccountResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -367,7 +367,7 @@ public DeleteSourceAccountResponse delete( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -379,7 +379,7 @@ public DeleteSourceAccountResponse delete( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -531,7 +531,7 @@ public DeleteBankFeedCredentialsResponse deleteCredentials( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -543,7 +543,7 @@ public DeleteBankFeedCredentialsResponse deleteCredentials( HTTPRequest _req = new HTTPRequest(_url, "DELETE"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -657,10 +657,13 @@ public DeleteBankFeedCredentialsResponse deleteCredentials( /** * Generate source account credentials - * The _Generate Bank Account Credentials_ endpoint can be used to generate credentials for QuickBooks Online to use for authentication of the Bank Feed in their portal, each time this is used a new set of credentials will be generated. + * The _Generate bank account credentials_ endpoint can be used to generate credentials for QuickBooks Online to authenticate the Bank Feed in the QBO portal. Each time this endpoint is called, a new set of credentials will be generated. * * The old credentials will still be valid until the revoke credentials endpoint is used, which will revoke all credentials associated to the data connection. * + * > **For QuickBooks Online only** + * > + * > Only call this endpoint when onboarding SMBs that use QuickBooks Online. * @return The call builder */ public GenerateCredentialsRequestBuilder generateCredentials() { @@ -669,10 +672,13 @@ public GenerateCredentialsRequestBuilder generateCredentials() { /** * Generate source account credentials - * The _Generate Bank Account Credentials_ endpoint can be used to generate credentials for QuickBooks Online to use for authentication of the Bank Feed in their portal, each time this is used a new set of credentials will be generated. + * The _Generate bank account credentials_ endpoint can be used to generate credentials for QuickBooks Online to authenticate the Bank Feed in the QBO portal. Each time this endpoint is called, a new set of credentials will be generated. * * The old credentials will still be valid until the revoke credentials endpoint is used, which will revoke all credentials associated to the data connection. * + * > **For QuickBooks Online only** + * > + * > Only call this endpoint when onboarding SMBs that use QuickBooks Online. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -684,10 +690,13 @@ public GenerateCredentialsResponse generateCredentials( /** * Generate source account credentials - * The _Generate Bank Account Credentials_ endpoint can be used to generate credentials for QuickBooks Online to use for authentication of the Bank Feed in their portal, each time this is used a new set of credentials will be generated. + * The _Generate bank account credentials_ endpoint can be used to generate credentials for QuickBooks Online to authenticate the Bank Feed in the QBO portal. Each time this endpoint is called, a new set of credentials will be generated. * * The old credentials will still be valid until the revoke credentials endpoint is used, which will revoke all credentials associated to the data connection. * + * > **For QuickBooks Online only** + * > + * > Only call this endpoint when onboarding SMBs that use QuickBooks Online. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -698,7 +707,7 @@ public GenerateCredentialsResponse generateCredentials( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -723,7 +732,7 @@ public GenerateCredentialsResponse generateCredentials( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -850,7 +859,7 @@ public GenerateCredentialsResponse generateCredentials( * List source accounts * The _List source accounts_ endpoint returns a list of [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) for a given company's connection. * - * [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. + * [Source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. * * > ### Versioning * > If you are integrating the Bank Feeds API with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. @@ -864,7 +873,7 @@ public ListSourceAccountsRequestBuilder list() { * List source accounts * The _List source accounts_ endpoint returns a list of [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) for a given company's connection. * - * [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. + * [Source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. * * > ### Versioning * > If you are integrating the Bank Feeds API with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. @@ -881,7 +890,7 @@ public ListSourceAccountsResponse list( * List source accounts * The _List source accounts_ endpoint returns a list of [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) for a given company's connection. * - * [source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. + * [Source accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankFeedAccount) are the bank's bank account within Codat's domain from which transactions are synced into the accounting platform. * * > ### Versioning * > If you are integrating the Bank Feeds API with Codat after August 1, 2024, please use the v2 version of the API, as detailed in the schema below. For integrations completed before August 1, 2024, select the v1 version from the schema dropdown below. @@ -895,7 +904,7 @@ public ListSourceAccountsResponse list( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -907,7 +916,7 @@ public ListSourceAccountsResponse list( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -986,10 +995,10 @@ public ListSourceAccountsResponse list( if (Utils.statusCodeMatches(_httpRes.statusCode(), "200")) { if (Utils.contentTypeMatches(_contentType, "application/json")) { - List _out = Utils.mapper().readValue( + ListSourceAccountsResponseBody _out = Utils.mapper().readValue( Utils.toUtf8AndClose(_httpRes.body()), - new TypeReference>() {}); - _res.withSourceAccounts(Optional.ofNullable(_out)); + new TypeReference() {}); + _res.withOneOf(Optional.ofNullable(_out)); return _res; } else { throw new SDKError( @@ -1079,7 +1088,7 @@ public UpdateSourceAccountResponse update( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -1101,7 +1110,7 @@ public UpdateSourceAccountResponse update( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/Sync.java b/bank-feeds/src/main/java/io/codat/bank_feeds/Sync.java index 3d3a32ff..bbc43b11 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/Sync.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/Sync.java @@ -81,7 +81,7 @@ public GetLastSuccessfulResponse getLastSuccessfulSync( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -93,7 +93,7 @@ public GetLastSuccessfulResponse getLastSuccessfulSync( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/Transactions.java b/bank-feeds/src/main/java/io/codat/bank_feeds/Transactions.java index e0675458..ba191e0b 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/Transactions.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/Transactions.java @@ -69,8 +69,6 @@ public class Transactions implements * * Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bankTransactions-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. - * * @return The call builder */ public CreateBankTransactionsRequestBuilder create() { @@ -87,8 +85,6 @@ public CreateBankTransactionsRequestBuilder create() { * * Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bankTransactions-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. - * * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -108,8 +104,6 @@ public CreateBankTransactionsResponse create( * * Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/bank-feeds-api#/operations/get-create-bankTransactions-model). * - * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankTransactions) for integrations that support creating a bank account transactions. - * * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -120,7 +114,7 @@ public CreateBankTransactionsResponse create( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -142,7 +136,7 @@ public CreateBankTransactionsResponse create( _req.setBody(Optional.ofNullable(_serializedRequestBody)); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( CreateBankTransactionsRequest.class, @@ -272,7 +266,11 @@ public CreateBankTransactionsResponse create( /** * Get create operation - * Retrieve push operation. + * The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, your push operations will only relate to the `bankTransactions` data type. * @return The call builder */ public GetCreateOperationRequestBuilder getCreateOperation() { @@ -281,7 +279,11 @@ public GetCreateOperationRequestBuilder getCreateOperation() { /** * Get create operation - * Retrieve push operation. + * The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, your push operations will only relate to the `bankTransactions` data type. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -293,7 +295,11 @@ public GetCreateOperationResponse getCreateOperation( /** * Get create operation - * Retrieve push operation. + * The **Get create operation** endpoint returns a specific [write operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, your push operations will only relate to the `bankTransactions` data type. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -304,7 +310,7 @@ public GetCreateOperationResponse getCreateOperation( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -316,7 +322,7 @@ public GetCreateOperationResponse getCreateOperation( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); Utils.configureSecurity(_req, this.sdkConfiguration.securitySource.getSecurity()); @@ -441,7 +447,11 @@ public GetCreateOperationResponse getCreateOperation( /** * List create operations - * List create operations. + * The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type. * @return The call builder */ public ListCreateOperationsRequestBuilder listCreateOperations() { @@ -450,7 +460,11 @@ public ListCreateOperationsRequestBuilder listCreateOperations() { /** * List create operations - * List create operations. + * The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type. * @param request The request object containing all of the parameters for the API call. * @return The response from the API call * @throws Exception if the API call fails @@ -462,7 +476,11 @@ public ListCreateOperationsResponse listCreateOperations( /** * List create operations - * List create operations. + * The **List create operations** endpoint returns a list of [write operations](/using-the-api/push) performed on the company. + * + * Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + * + * For bank feeds, use this endpoint to view write operations related to the `bankTransactions` data type. * @param request The request object containing all of the parameters for the API call. * @param options additional options * @return The response from the API call @@ -473,7 +491,7 @@ public ListCreateOperationsResponse listCreateOperations( Optional options) throws Exception { if (options.isPresent()) { - options.get().validate(Arrays.asList(io.codat.bank_feeds.utils.Options.Option.RETRY_CONFIG)); + options.get().validate(Arrays.asList(Options.Option.RETRY_CONFIG)); } String _baseUrl = this.sdkConfiguration.serverUrl; String _url = Utils.generateURL( @@ -485,7 +503,7 @@ public ListCreateOperationsResponse listCreateOperations( HTTPRequest _req = new HTTPRequest(_url, "GET"); _req.addHeader("Accept", "application/json") .addHeader("user-agent", - this.sdkConfiguration.userAgent); + SDKConfiguration.USER_AGENT); _req.addQueryParams(Utils.getQueryParams( ListCreateOperationsRequest.class, diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/AccountingBankAccount.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/AccountingBankAccount.java index 1273887f..8bd98796 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/AccountingBankAccount.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/AccountingBankAccount.java @@ -25,9 +25,7 @@ * > * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. * > - * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/bank-feeds-api#/schemas/Account) - * - * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>. + * > To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/bank-feeds-api#/schemas/Account) data type. * * ## Overview * diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankAccountsAccountingBankAccount.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankAccountsAccountingBankAccount.java index e2278094..785fd38a 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankAccountsAccountingBankAccount.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankAccountsAccountingBankAccount.java @@ -24,9 +24,7 @@ * > * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. * > - * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/bank-feeds-api#/schemas/Account) - * - * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>. + * > To view bank account data through the Banking API, please refer to the new [Banking: Account](https://docs.codat.io/bank-feeds-api#/schemas/Account) data type. * * ## Overview * diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankFeedAccountMappingResponse.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankFeedAccountMappingResponse.java index 9f5fbdcd..f794463b 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankFeedAccountMappingResponse.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/BankFeedAccountMappingResponse.java @@ -17,9 +17,6 @@ import java.util.Optional; import org.openapitools.jackson.nullable.JsonNullable; -/** - * BankFeedAccountMappingResponse - The result from POSTing a Bank Account mapping. - */ public class BankFeedAccountMappingResponse { @@ -27,22 +24,22 @@ public class BankFeedAccountMappingResponse { * Error returned during the post request */ @JsonInclude(Include.NON_ABSENT) - @JsonProperty("Error") + @JsonProperty("error") private JsonNullable error; /** - * Status of the POST request. + * Unique ID for the source account. */ @JsonInclude(Include.NON_ABSENT) - @JsonProperty("Status") - private JsonNullable status; + @JsonProperty("sourceAccountId") + private Optional sourceAccountId; /** - * Unique ID for the source account. + * Status of the POST request. */ @JsonInclude(Include.NON_ABSENT) - @JsonProperty("sourceAccountId") - private Optional sourceAccountId; + @JsonProperty("status") + private JsonNullable status; /** * Unique ID for the target account. @@ -53,22 +50,22 @@ public class BankFeedAccountMappingResponse { @JsonCreator public BankFeedAccountMappingResponse( - @JsonProperty("Error") JsonNullable error, - @JsonProperty("Status") JsonNullable status, + @JsonProperty("error") JsonNullable error, @JsonProperty("sourceAccountId") Optional sourceAccountId, + @JsonProperty("status") JsonNullable status, @JsonProperty("targetAccountId") JsonNullable targetAccountId) { Utils.checkNotNull(error, "error"); - Utils.checkNotNull(status, "status"); Utils.checkNotNull(sourceAccountId, "sourceAccountId"); + Utils.checkNotNull(status, "status"); Utils.checkNotNull(targetAccountId, "targetAccountId"); this.error = error; - this.status = status; this.sourceAccountId = sourceAccountId; + this.status = status; this.targetAccountId = targetAccountId; } public BankFeedAccountMappingResponse() { - this(JsonNullable.undefined(), JsonNullable.undefined(), Optional.empty(), JsonNullable.undefined()); + this(JsonNullable.undefined(), Optional.empty(), JsonNullable.undefined(), JsonNullable.undefined()); } /** @@ -80,19 +77,19 @@ public JsonNullable error() { } /** - * Status of the POST request. + * Unique ID for the source account. */ @JsonIgnore - public JsonNullable status() { - return status; + public Optional sourceAccountId() { + return sourceAccountId; } /** - * Unique ID for the source account. + * Status of the POST request. */ @JsonIgnore - public Optional sourceAccountId() { - return sourceAccountId; + public JsonNullable status() { + return status; } /** @@ -126,38 +123,38 @@ public BankFeedAccountMappingResponse withError(JsonNullable error) { } /** - * Status of the POST request. + * Unique ID for the source account. */ - public BankFeedAccountMappingResponse withStatus(String status) { - Utils.checkNotNull(status, "status"); - this.status = JsonNullable.of(status); + public BankFeedAccountMappingResponse withSourceAccountId(String sourceAccountId) { + Utils.checkNotNull(sourceAccountId, "sourceAccountId"); + this.sourceAccountId = Optional.ofNullable(sourceAccountId); return this; } /** - * Status of the POST request. + * Unique ID for the source account. */ - public BankFeedAccountMappingResponse withStatus(JsonNullable status) { - Utils.checkNotNull(status, "status"); - this.status = status; + public BankFeedAccountMappingResponse withSourceAccountId(Optional sourceAccountId) { + Utils.checkNotNull(sourceAccountId, "sourceAccountId"); + this.sourceAccountId = sourceAccountId; return this; } /** - * Unique ID for the source account. + * Status of the POST request. */ - public BankFeedAccountMappingResponse withSourceAccountId(String sourceAccountId) { - Utils.checkNotNull(sourceAccountId, "sourceAccountId"); - this.sourceAccountId = Optional.ofNullable(sourceAccountId); + public BankFeedAccountMappingResponse withStatus(String status) { + Utils.checkNotNull(status, "status"); + this.status = JsonNullable.of(status); return this; } /** - * Unique ID for the source account. + * Status of the POST request. */ - public BankFeedAccountMappingResponse withSourceAccountId(Optional sourceAccountId) { - Utils.checkNotNull(sourceAccountId, "sourceAccountId"); - this.sourceAccountId = sourceAccountId; + public BankFeedAccountMappingResponse withStatus(JsonNullable status) { + Utils.checkNotNull(status, "status"); + this.status = status; return this; } @@ -190,8 +187,8 @@ public boolean equals(java.lang.Object o) { BankFeedAccountMappingResponse other = (BankFeedAccountMappingResponse) o; return Objects.deepEquals(this.error, other.error) && - Objects.deepEquals(this.status, other.status) && Objects.deepEquals(this.sourceAccountId, other.sourceAccountId) && + Objects.deepEquals(this.status, other.status) && Objects.deepEquals(this.targetAccountId, other.targetAccountId); } @@ -199,8 +196,8 @@ public boolean equals(java.lang.Object o) { public int hashCode() { return Objects.hash( error, - status, sourceAccountId, + status, targetAccountId); } @@ -208,8 +205,8 @@ public int hashCode() { public String toString() { return Utils.toString(BankFeedAccountMappingResponse.class, "error", error, - "status", status, "sourceAccountId", sourceAccountId, + "status", status, "targetAccountId", targetAccountId); } @@ -217,10 +214,10 @@ public final static class Builder { private JsonNullable error = JsonNullable.undefined(); - private JsonNullable status = JsonNullable.undefined(); - private Optional sourceAccountId = Optional.empty(); + private JsonNullable status = JsonNullable.undefined(); + private JsonNullable targetAccountId = JsonNullable.undefined(); private Builder() { @@ -246,38 +243,38 @@ public Builder error(JsonNullable error) { } /** - * Status of the POST request. + * Unique ID for the source account. */ - public Builder status(String status) { - Utils.checkNotNull(status, "status"); - this.status = JsonNullable.of(status); + public Builder sourceAccountId(String sourceAccountId) { + Utils.checkNotNull(sourceAccountId, "sourceAccountId"); + this.sourceAccountId = Optional.ofNullable(sourceAccountId); return this; } /** - * Status of the POST request. + * Unique ID for the source account. */ - public Builder status(JsonNullable status) { - Utils.checkNotNull(status, "status"); - this.status = status; + public Builder sourceAccountId(Optional sourceAccountId) { + Utils.checkNotNull(sourceAccountId, "sourceAccountId"); + this.sourceAccountId = sourceAccountId; return this; } /** - * Unique ID for the source account. + * Status of the POST request. */ - public Builder sourceAccountId(String sourceAccountId) { - Utils.checkNotNull(sourceAccountId, "sourceAccountId"); - this.sourceAccountId = Optional.ofNullable(sourceAccountId); + public Builder status(String status) { + Utils.checkNotNull(status, "status"); + this.status = JsonNullable.of(status); return this; } /** - * Unique ID for the source account. + * Status of the POST request. */ - public Builder sourceAccountId(Optional sourceAccountId) { - Utils.checkNotNull(sourceAccountId, "sourceAccountId"); - this.sourceAccountId = sourceAccountId; + public Builder status(JsonNullable status) { + Utils.checkNotNull(status, "status"); + this.status = status; return this; } @@ -302,8 +299,8 @@ public Builder targetAccountId(JsonNullable targetAccountId) { public BankFeedAccountMappingResponse build() { return new BankFeedAccountMappingResponse( error, - status, sourceAccountId, + status, targetAccountId); } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Company.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Company.java index 903c01e5..83a863e1 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Company.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Company.java @@ -15,6 +15,7 @@ import java.lang.String; import java.lang.SuppressWarnings; import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Optional; import org.openapitools.jackson.nullable.JsonNullable; @@ -109,6 +110,13 @@ public class Company { @JsonProperty("name") private String name; + /** + * An array of products that are currently enabled for the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("products") + private Optional> products; + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -120,7 +128,7 @@ public class Company { */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("tags") - private Optional tags; + private Optional> tags; @JsonCreator public Company( @@ -131,8 +139,9 @@ public Company( @JsonProperty("id") String id, @JsonProperty("lastSync") Optional lastSync, @JsonProperty("name") String name, + @JsonProperty("products") Optional> products, @JsonProperty("redirect") String redirect, - @JsonProperty("tags") Optional tags) { + @JsonProperty("tags") Optional> tags) { Utils.checkNotNull(created, "created"); Utils.checkNotNull(createdByUserName, "createdByUserName"); Utils.checkNotNull(dataConnections, "dataConnections"); @@ -140,6 +149,7 @@ public Company( Utils.checkNotNull(id, "id"); Utils.checkNotNull(lastSync, "lastSync"); Utils.checkNotNull(name, "name"); + Utils.checkNotNull(products, "products"); Utils.checkNotNull(redirect, "redirect"); Utils.checkNotNull(tags, "tags"); this.created = created; @@ -149,6 +159,7 @@ public Company( this.id = id; this.lastSync = lastSync; this.name = name; + this.products = products; this.redirect = redirect; this.tags = tags; } @@ -157,7 +168,7 @@ public Company( String id, String name, String redirect) { - this(Optional.empty(), JsonNullable.undefined(), Optional.empty(), Optional.empty(), id, Optional.empty(), name, redirect, Optional.empty()); + this(Optional.empty(), JsonNullable.undefined(), Optional.empty(), Optional.empty(), id, Optional.empty(), name, Optional.empty(), redirect, Optional.empty()); } /** @@ -250,6 +261,15 @@ public String name() { return name; } + /** + * An array of products that are currently enabled for the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> products() { + return (Optional>) products; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -263,8 +283,8 @@ public String redirect() { */ @SuppressWarnings("unchecked") @JsonIgnore - public Optional tags() { - return (Optional) tags; + public Optional> tags() { + return (Optional>) tags; } public final static Builder builder() { @@ -445,6 +465,24 @@ public Company withName(String name) { return this; } + /** + * An array of products that are currently enabled for the company. + */ + public Company withProducts(List products) { + Utils.checkNotNull(products, "products"); + this.products = Optional.ofNullable(products); + return this; + } + + /** + * An array of products that are currently enabled for the company. + */ + public Company withProducts(Optional> products) { + Utils.checkNotNull(products, "products"); + this.products = products; + return this; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -457,7 +495,7 @@ public Company withRedirect(String redirect) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Company withTags(Tags tags) { + public Company withTags(Map tags) { Utils.checkNotNull(tags, "tags"); this.tags = Optional.ofNullable(tags); return this; @@ -466,7 +504,7 @@ public Company withTags(Tags tags) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Company withTags(Optional tags) { + public Company withTags(Optional> tags) { Utils.checkNotNull(tags, "tags"); this.tags = tags; return this; @@ -489,6 +527,7 @@ public boolean equals(java.lang.Object o) { Objects.deepEquals(this.id, other.id) && Objects.deepEquals(this.lastSync, other.lastSync) && Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.products, other.products) && Objects.deepEquals(this.redirect, other.redirect) && Objects.deepEquals(this.tags, other.tags); } @@ -503,6 +542,7 @@ public int hashCode() { id, lastSync, name, + products, redirect, tags); } @@ -517,6 +557,7 @@ public String toString() { "id", id, "lastSync", lastSync, "name", name, + "products", products, "redirect", redirect, "tags", tags); } @@ -537,9 +578,11 @@ public final static class Builder { private String name; + private Optional> products = Optional.empty(); + private String redirect; - private Optional tags = Optional.empty(); + private Optional> tags = Optional.empty(); private Builder() { // force use of static builder() method @@ -719,6 +762,24 @@ public Builder name(String name) { return this; } + /** + * An array of products that are currently enabled for the company. + */ + public Builder products(List products) { + Utils.checkNotNull(products, "products"); + this.products = Optional.ofNullable(products); + return this; + } + + /** + * An array of products that are currently enabled for the company. + */ + public Builder products(Optional> products) { + Utils.checkNotNull(products, "products"); + this.products = products; + return this; + } + /** * The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. */ @@ -731,7 +792,7 @@ public Builder redirect(String redirect) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder tags(Tags tags) { + public Builder tags(Map tags) { Utils.checkNotNull(tags, "tags"); this.tags = Optional.ofNullable(tags); return this; @@ -740,7 +801,7 @@ public Builder tags(Tags tags) { /** * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder tags(Optional tags) { + public Builder tags(Optional> tags) { Utils.checkNotNull(tags, "tags"); this.tags = tags; return this; @@ -755,6 +816,7 @@ public Company build() { id, lastSync, name, + products, redirect, tags); } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyInformation.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyInformation.java index d12045ca..a5fbca0d 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyInformation.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyInformation.java @@ -14,6 +14,8 @@ import java.lang.Boolean; import java.lang.Override; import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.List; import java.util.Objects; import java.util.Optional; import org.openapitools.jackson.nullable.JsonNullable; @@ -39,14 +41,21 @@ public class CompanyInformation { private Optional companyName; /** - * Boolean showing if the organisation has multicurrency enabled + * Array of enabled currencies for the linked company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("currencies") + private JsonNullable> currencies; + + /** + * Boolean showing if the organisation has multicurrency enabled. */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("multicurrencyEnabled") - private JsonNullable multicurrencyEnabled; + private Optional multicurrencyEnabled; /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ @JsonInclude(Include.NON_ABSENT) @JsonProperty("planType") @@ -56,20 +65,23 @@ public class CompanyInformation { public CompanyInformation( @JsonProperty("baseCurrency") Optional baseCurrency, @JsonProperty("companyName") Optional companyName, - @JsonProperty("multicurrencyEnabled") JsonNullable multicurrencyEnabled, + @JsonProperty("currencies") JsonNullable> currencies, + @JsonProperty("multicurrencyEnabled") Optional multicurrencyEnabled, @JsonProperty("planType") JsonNullable planType) { Utils.checkNotNull(baseCurrency, "baseCurrency"); Utils.checkNotNull(companyName, "companyName"); + Utils.checkNotNull(currencies, "currencies"); Utils.checkNotNull(multicurrencyEnabled, "multicurrencyEnabled"); Utils.checkNotNull(planType, "planType"); this.baseCurrency = baseCurrency; this.companyName = companyName; + this.currencies = currencies; this.multicurrencyEnabled = multicurrencyEnabled; this.planType = planType; } public CompanyInformation() { - this(Optional.empty(), Optional.empty(), JsonNullable.undefined(), JsonNullable.undefined()); + this(Optional.empty(), Optional.empty(), JsonNullable.undefined(), Optional.empty(), JsonNullable.undefined()); } /** @@ -89,15 +101,24 @@ public Optional companyName() { } /** - * Boolean showing if the organisation has multicurrency enabled + * Array of enabled currencies for the linked company. */ + @SuppressWarnings("unchecked") @JsonIgnore - public JsonNullable multicurrencyEnabled() { + public JsonNullable> currencies() { + return (JsonNullable>) currencies; + } + + /** + * Boolean showing if the organisation has multicurrency enabled. + */ + @JsonIgnore + public Optional multicurrencyEnabled() { return multicurrencyEnabled; } /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ @JsonIgnore public JsonNullable planType() { @@ -145,25 +166,43 @@ public CompanyInformation withCompanyName(Optional companyName) { } /** - * Boolean showing if the organisation has multicurrency enabled + * Array of enabled currencies for the linked company. + */ + public CompanyInformation withCurrencies(List currencies) { + Utils.checkNotNull(currencies, "currencies"); + this.currencies = JsonNullable.of(currencies); + return this; + } + + /** + * Array of enabled currencies for the linked company. + */ + public CompanyInformation withCurrencies(JsonNullable> currencies) { + Utils.checkNotNull(currencies, "currencies"); + this.currencies = currencies; + return this; + } + + /** + * Boolean showing if the organisation has multicurrency enabled. */ public CompanyInformation withMulticurrencyEnabled(boolean multicurrencyEnabled) { Utils.checkNotNull(multicurrencyEnabled, "multicurrencyEnabled"); - this.multicurrencyEnabled = JsonNullable.of(multicurrencyEnabled); + this.multicurrencyEnabled = Optional.ofNullable(multicurrencyEnabled); return this; } /** - * Boolean showing if the organisation has multicurrency enabled + * Boolean showing if the organisation has multicurrency enabled. */ - public CompanyInformation withMulticurrencyEnabled(JsonNullable multicurrencyEnabled) { + public CompanyInformation withMulticurrencyEnabled(Optional multicurrencyEnabled) { Utils.checkNotNull(multicurrencyEnabled, "multicurrencyEnabled"); this.multicurrencyEnabled = multicurrencyEnabled; return this; } /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ public CompanyInformation withPlanType(String planType) { Utils.checkNotNull(planType, "planType"); @@ -172,7 +211,7 @@ public CompanyInformation withPlanType(String planType) { } /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ public CompanyInformation withPlanType(JsonNullable planType) { Utils.checkNotNull(planType, "planType"); @@ -192,6 +231,7 @@ public boolean equals(java.lang.Object o) { return Objects.deepEquals(this.baseCurrency, other.baseCurrency) && Objects.deepEquals(this.companyName, other.companyName) && + Objects.deepEquals(this.currencies, other.currencies) && Objects.deepEquals(this.multicurrencyEnabled, other.multicurrencyEnabled) && Objects.deepEquals(this.planType, other.planType); } @@ -201,6 +241,7 @@ public int hashCode() { return Objects.hash( baseCurrency, companyName, + currencies, multicurrencyEnabled, planType); } @@ -210,6 +251,7 @@ public String toString() { return Utils.toString(CompanyInformation.class, "baseCurrency", baseCurrency, "companyName", companyName, + "currencies", currencies, "multicurrencyEnabled", multicurrencyEnabled, "planType", planType); } @@ -220,7 +262,9 @@ public final static class Builder { private Optional companyName = Optional.empty(); - private JsonNullable multicurrencyEnabled = JsonNullable.undefined(); + private JsonNullable> currencies = JsonNullable.undefined(); + + private Optional multicurrencyEnabled = Optional.empty(); private JsonNullable planType = JsonNullable.undefined(); @@ -265,25 +309,43 @@ public Builder companyName(Optional companyName) { } /** - * Boolean showing if the organisation has multicurrency enabled + * Array of enabled currencies for the linked company. + */ + public Builder currencies(List currencies) { + Utils.checkNotNull(currencies, "currencies"); + this.currencies = JsonNullable.of(currencies); + return this; + } + + /** + * Array of enabled currencies for the linked company. + */ + public Builder currencies(JsonNullable> currencies) { + Utils.checkNotNull(currencies, "currencies"); + this.currencies = currencies; + return this; + } + + /** + * Boolean showing if the organisation has multicurrency enabled. */ public Builder multicurrencyEnabled(boolean multicurrencyEnabled) { Utils.checkNotNull(multicurrencyEnabled, "multicurrencyEnabled"); - this.multicurrencyEnabled = JsonNullable.of(multicurrencyEnabled); + this.multicurrencyEnabled = Optional.ofNullable(multicurrencyEnabled); return this; } /** - * Boolean showing if the organisation has multicurrency enabled + * Boolean showing if the organisation has multicurrency enabled. */ - public Builder multicurrencyEnabled(JsonNullable multicurrencyEnabled) { + public Builder multicurrencyEnabled(Optional multicurrencyEnabled) { Utils.checkNotNull(multicurrencyEnabled, "multicurrencyEnabled"); this.multicurrencyEnabled = multicurrencyEnabled; return this; } /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ public Builder planType(String planType) { Utils.checkNotNull(planType, "planType"); @@ -292,7 +354,7 @@ public Builder planType(String planType) { } /** - * Accounting software subscription type such as Trial, Demo, Standard + * Accounting software subscription type such as Trial, Demo, Standard. */ public Builder planType(JsonNullable planType) { Utils.checkNotNull(planType, "planType"); @@ -304,6 +366,7 @@ public CompanyInformation build() { return new CompanyInformation( baseCurrency, companyName, + currencies, multicurrencyEnabled, planType); } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReference.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReference.java new file mode 100644 index 00000000..38fc7ce8 --- /dev/null +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReference.java @@ -0,0 +1,371 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.bank_feeds.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.bank_feeds.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; + + +public class CompanyReference { + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("description") + private Optional description; + + /** + * Unique identifier for your SMB in Codat. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("id") + private Optional id; + + /** + * A collection of links for the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("links") + private Optional links; + + /** + * The name of the company + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("name") + private Optional name; + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("tags") + private Optional> tags; + + @JsonCreator + public CompanyReference( + @JsonProperty("description") Optional description, + @JsonProperty("id") Optional id, + @JsonProperty("links") Optional links, + @JsonProperty("name") Optional name, + @JsonProperty("tags") Optional> tags) { + Utils.checkNotNull(description, "description"); + Utils.checkNotNull(id, "id"); + Utils.checkNotNull(links, "links"); + Utils.checkNotNull(name, "name"); + Utils.checkNotNull(tags, "tags"); + this.description = description; + this.id = id; + this.links = links; + this.name = name; + this.tags = tags; + } + + public CompanyReference() { + this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty()); + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + @JsonIgnore + public Optional description() { + return description; + } + + /** + * Unique identifier for your SMB in Codat. + */ + @JsonIgnore + public Optional id() { + return id; + } + + /** + * A collection of links for the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional links() { + return (Optional) links; + } + + /** + * The name of the company + */ + @JsonIgnore + public Optional name() { + return name; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> tags() { + return (Optional>) tags; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public CompanyReference withDescription(String description) { + Utils.checkNotNull(description, "description"); + this.description = Optional.ofNullable(description); + return this; + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public CompanyReference withDescription(Optional description) { + Utils.checkNotNull(description, "description"); + this.description = description; + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public CompanyReference withId(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public CompanyReference withId(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + /** + * A collection of links for the company. + */ + public CompanyReference withLinks(CompanyReferenceLinks links) { + Utils.checkNotNull(links, "links"); + this.links = Optional.ofNullable(links); + return this; + } + + /** + * A collection of links for the company. + */ + public CompanyReference withLinks(Optional links) { + Utils.checkNotNull(links, "links"); + this.links = links; + return this; + } + + /** + * The name of the company + */ + public CompanyReference withName(String name) { + Utils.checkNotNull(name, "name"); + this.name = Optional.ofNullable(name); + return this; + } + + /** + * The name of the company + */ + public CompanyReference withName(Optional name) { + Utils.checkNotNull(name, "name"); + this.name = name; + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public CompanyReference withTags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public CompanyReference withTags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompanyReference other = (CompanyReference) o; + return + Objects.deepEquals(this.description, other.description) && + Objects.deepEquals(this.id, other.id) && + Objects.deepEquals(this.links, other.links) && + Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.tags, other.tags); + } + + @Override + public int hashCode() { + return Objects.hash( + description, + id, + links, + name, + tags); + } + + @Override + public String toString() { + return Utils.toString(CompanyReference.class, + "description", description, + "id", id, + "links", links, + "name", name, + "tags", tags); + } + + public final static class Builder { + + private Optional description = Optional.empty(); + + private Optional id = Optional.empty(); + + private Optional links = Optional.empty(); + + private Optional name = Optional.empty(); + + private Optional> tags = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public Builder description(String description) { + Utils.checkNotNull(description, "description"); + this.description = Optional.ofNullable(description); + return this; + } + + /** + * Additional information about the company. This can be used to store foreign IDs, references, etc. + */ + public Builder description(Optional description) { + Utils.checkNotNull(description, "description"); + this.description = description; + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public Builder id(String id) { + Utils.checkNotNull(id, "id"); + this.id = Optional.ofNullable(id); + return this; + } + + /** + * Unique identifier for your SMB in Codat. + */ + public Builder id(Optional id) { + Utils.checkNotNull(id, "id"); + this.id = id; + return this; + } + + /** + * A collection of links for the company. + */ + public Builder links(CompanyReferenceLinks links) { + Utils.checkNotNull(links, "links"); + this.links = Optional.ofNullable(links); + return this; + } + + /** + * A collection of links for the company. + */ + public Builder links(Optional links) { + Utils.checkNotNull(links, "links"); + this.links = links; + return this; + } + + /** + * The name of the company + */ + public Builder name(String name) { + Utils.checkNotNull(name, "name"); + this.name = Optional.ofNullable(name); + return this; + } + + /** + * The name of the company + */ + public Builder name(Optional name) { + Utils.checkNotNull(name, "name"); + this.name = name; + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public Builder tags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); + return this; + } + + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + public Builder tags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; + return this; + } + + public CompanyReference build() { + return new CompanyReference( + description, + id, + links, + name, + tags); + } + } +} + diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReferenceLinks.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReferenceLinks.java new file mode 100644 index 00000000..20e22f99 --- /dev/null +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyReferenceLinks.java @@ -0,0 +1,130 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.bank_feeds.models.components; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.JsonInclude.Include; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import io.codat.bank_feeds.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.util.Objects; +import java.util.Optional; + +/** + * CompanyReferenceLinks - A collection of links for the company. + */ + +public class CompanyReferenceLinks { + + /** + * Link to the company page in the portal. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("portal") + private Optional portal; + + @JsonCreator + public CompanyReferenceLinks( + @JsonProperty("portal") Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + } + + public CompanyReferenceLinks() { + this(Optional.empty()); + } + + /** + * Link to the company page in the portal. + */ + @JsonIgnore + public Optional portal() { + return portal; + } + + public final static Builder builder() { + return new Builder(); + } + + /** + * Link to the company page in the portal. + */ + public CompanyReferenceLinks withPortal(String portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = Optional.ofNullable(portal); + return this; + } + + /** + * Link to the company page in the portal. + */ + public CompanyReferenceLinks withPortal(Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + return this; + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CompanyReferenceLinks other = (CompanyReferenceLinks) o; + return + Objects.deepEquals(this.portal, other.portal); + } + + @Override + public int hashCode() { + return Objects.hash( + portal); + } + + @Override + public String toString() { + return Utils.toString(CompanyReferenceLinks.class, + "portal", portal); + } + + public final static class Builder { + + private Optional portal = Optional.empty(); + + private Builder() { + // force use of static builder() method + } + + /** + * Link to the company page in the portal. + */ + public Builder portal(String portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = Optional.ofNullable(portal); + return this; + } + + /** + * Link to the company page in the portal. + */ + public Builder portal(Optional portal) { + Utils.checkNotNull(portal, "portal"); + this.portal = portal; + return this; + } + + public CompanyReferenceLinks build() { + return new CompanyReferenceLinks( + portal); + } + } +} + diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyRequestBody.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyRequestBody.java index 09c33c0b..c19f4fd7 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyRequestBody.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/CompanyRequestBody.java @@ -14,7 +14,7 @@ import java.lang.Override; import java.lang.String; import java.lang.SuppressWarnings; -import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Optional; @@ -28,35 +28,35 @@ public class CompanyRequestBody { @JsonProperty("description") private Optional description; - /** - * Reference to the groups that the company is assigned to. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("groups") - private Optional> groups; - /** * Name of company being connected. */ @JsonProperty("name") private String name; + /** + * A collection of user-defined key-value pairs that store custom metadata against the company. + */ + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("tags") + private Optional> tags; + @JsonCreator public CompanyRequestBody( @JsonProperty("description") Optional description, - @JsonProperty("groups") Optional> groups, - @JsonProperty("name") String name) { + @JsonProperty("name") String name, + @JsonProperty("tags") Optional> tags) { Utils.checkNotNull(description, "description"); - Utils.checkNotNull(groups, "groups"); Utils.checkNotNull(name, "name"); + Utils.checkNotNull(tags, "tags"); this.description = description; - this.groups = groups; this.name = name; + this.tags = tags; } public CompanyRequestBody( String name) { - this(Optional.empty(), Optional.empty(), name); + this(Optional.empty(), name, Optional.empty()); } /** @@ -68,20 +68,20 @@ public Optional description() { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - @SuppressWarnings("unchecked") @JsonIgnore - public Optional> groups() { - return (Optional>) groups; + public String name() { + return name; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ + @SuppressWarnings("unchecked") @JsonIgnore - public String name() { - return name; + public Optional> tags() { + return (Optional>) tags; } public final static Builder builder() { @@ -107,29 +107,29 @@ public CompanyRequestBody withDescription(Optional description) { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - public CompanyRequestBody withGroups(List groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = Optional.ofNullable(groups); + public CompanyRequestBody withName(String name) { + Utils.checkNotNull(name, "name"); + this.name = name; return this; } /** - * Reference to the groups that the company is assigned to. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public CompanyRequestBody withGroups(Optional> groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = groups; + public CompanyRequestBody withTags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); return this; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public CompanyRequestBody withName(String name) { - Utils.checkNotNull(name, "name"); - this.name = name; + public CompanyRequestBody withTags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; return this; } @@ -144,33 +144,33 @@ public boolean equals(java.lang.Object o) { CompanyRequestBody other = (CompanyRequestBody) o; return Objects.deepEquals(this.description, other.description) && - Objects.deepEquals(this.groups, other.groups) && - Objects.deepEquals(this.name, other.name); + Objects.deepEquals(this.name, other.name) && + Objects.deepEquals(this.tags, other.tags); } @Override public int hashCode() { return Objects.hash( description, - groups, - name); + name, + tags); } @Override public String toString() { return Utils.toString(CompanyRequestBody.class, "description", description, - "groups", groups, - "name", name); + "name", name, + "tags", tags); } public final static class Builder { private Optional description = Optional.empty(); - private Optional> groups = Optional.empty(); + private String name; - private String name; + private Optional> tags = Optional.empty(); private Builder() { // force use of static builder() method @@ -195,37 +195,37 @@ public Builder description(Optional description) { } /** - * Reference to the groups that the company is assigned to. + * Name of company being connected. */ - public Builder groups(List groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = Optional.ofNullable(groups); + public Builder name(String name) { + Utils.checkNotNull(name, "name"); + this.name = name; return this; } /** - * Reference to the groups that the company is assigned to. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder groups(Optional> groups) { - Utils.checkNotNull(groups, "groups"); - this.groups = groups; + public Builder tags(Map tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = Optional.ofNullable(tags); return this; } /** - * Name of company being connected. + * A collection of user-defined key-value pairs that store custom metadata against the company. */ - public Builder name(String name) { - Utils.checkNotNull(name, "name"); - this.name = name; + public Builder tags(Optional> tags) { + Utils.checkNotNull(tags, "tags"); + this.tags = tags; return this; } public CompanyRequestBody build() { return new CompanyRequestBody( description, - groups, - name); + name, + tags); } } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Connection.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Connection.java index 84e48c10..8dd50056 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Connection.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Connection.java @@ -11,7 +11,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import io.codat.bank_feeds.utils.Utils; -import java.lang.Object; import java.lang.Override; import java.lang.String; import java.lang.SuppressWarnings; @@ -19,6 +18,7 @@ import java.util.Map; import java.util.Objects; import java.util.Optional; +import org.openapitools.jackson.nullable.JsonNullable; /** * Connection - A connection represents a [company's](https://docs.codat.io/bank-feeds-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. @@ -35,13 +35,9 @@ public class Connection { - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("additionalProperties") - private Optional additionalProperties; - @JsonInclude(Include.NON_ABSENT) @JsonProperty("connectionInfo") - private Optional> connectionInfo; + private JsonNullable> connectionInfo; /** * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: @@ -69,7 +65,7 @@ public class Connection { @JsonInclude(Include.NON_ABSENT) @JsonProperty("dataConnectionErrors") - private Optional> dataConnectionErrors; + private JsonNullable> dataConnectionErrors; /** * Unique identifier for a company's data connection. @@ -146,10 +142,9 @@ public class Connection { @JsonCreator public Connection( - @JsonProperty("additionalProperties") Optional additionalProperties, - @JsonProperty("connectionInfo") Optional> connectionInfo, + @JsonProperty("connectionInfo") JsonNullable> connectionInfo, @JsonProperty("created") String created, - @JsonProperty("dataConnectionErrors") Optional> dataConnectionErrors, + @JsonProperty("dataConnectionErrors") JsonNullable> dataConnectionErrors, @JsonProperty("id") String id, @JsonProperty("integrationId") String integrationId, @JsonProperty("integrationKey") String integrationKey, @@ -159,7 +154,6 @@ public Connection( @JsonProperty("sourceId") String sourceId, @JsonProperty("sourceType") SourceType sourceType, @JsonProperty("status") DataConnectionStatus status) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); Utils.checkNotNull(connectionInfo, "connectionInfo"); Utils.checkNotNull(created, "created"); Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); @@ -172,7 +166,6 @@ public Connection( Utils.checkNotNull(sourceId, "sourceId"); Utils.checkNotNull(sourceType, "sourceType"); Utils.checkNotNull(status, "status"); - this.additionalProperties = additionalProperties; this.connectionInfo = connectionInfo; this.created = created; this.dataConnectionErrors = dataConnectionErrors; @@ -197,19 +190,13 @@ public Connection( String sourceId, SourceType sourceType, DataConnectionStatus status) { - this(Optional.empty(), Optional.empty(), created, Optional.empty(), id, integrationId, integrationKey, Optional.empty(), linkUrl, platformName, sourceId, sourceType, status); - } - - @SuppressWarnings("unchecked") - @JsonIgnore - public Optional additionalProperties() { - return (Optional) additionalProperties; + this(JsonNullable.undefined(), created, JsonNullable.undefined(), id, integrationId, integrationKey, Optional.empty(), linkUrl, platformName, sourceId, sourceType, status); } @SuppressWarnings("unchecked") @JsonIgnore - public Optional> connectionInfo() { - return (Optional>) connectionInfo; + public JsonNullable> connectionInfo() { + return (JsonNullable>) connectionInfo; } /** @@ -240,8 +227,8 @@ public String created() { @SuppressWarnings("unchecked") @JsonIgnore - public Optional> dataConnectionErrors() { - return (Optional>) dataConnectionErrors; + public JsonNullable> dataConnectionErrors() { + return (JsonNullable>) dataConnectionErrors; } /** @@ -338,25 +325,13 @@ public final static Builder builder() { return new Builder(); } - public Connection withAdditionalProperties(Object additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = Optional.ofNullable(additionalProperties); - return this; - } - - public Connection withAdditionalProperties(Optional additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = additionalProperties; - return this; - } - public Connection withConnectionInfo(Map connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); - this.connectionInfo = Optional.ofNullable(connectionInfo); + this.connectionInfo = JsonNullable.of(connectionInfo); return this; } - public Connection withConnectionInfo(Optional> connectionInfo) { + public Connection withConnectionInfo(JsonNullable> connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); this.connectionInfo = connectionInfo; return this; @@ -391,11 +366,11 @@ public Connection withCreated(String created) { public Connection withDataConnectionErrors(List dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); - this.dataConnectionErrors = Optional.ofNullable(dataConnectionErrors); + this.dataConnectionErrors = JsonNullable.of(dataConnectionErrors); return this; } - public Connection withDataConnectionErrors(Optional> dataConnectionErrors) { + public Connection withDataConnectionErrors(JsonNullable> dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); this.dataConnectionErrors = dataConnectionErrors; return this; @@ -537,7 +512,6 @@ public boolean equals(java.lang.Object o) { } Connection other = (Connection) o; return - Objects.deepEquals(this.additionalProperties, other.additionalProperties) && Objects.deepEquals(this.connectionInfo, other.connectionInfo) && Objects.deepEquals(this.created, other.created) && Objects.deepEquals(this.dataConnectionErrors, other.dataConnectionErrors) && @@ -555,7 +529,6 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { return Objects.hash( - additionalProperties, connectionInfo, created, dataConnectionErrors, @@ -573,7 +546,6 @@ public int hashCode() { @Override public String toString() { return Utils.toString(Connection.class, - "additionalProperties", additionalProperties, "connectionInfo", connectionInfo, "created", created, "dataConnectionErrors", dataConnectionErrors, @@ -590,13 +562,11 @@ public String toString() { public final static class Builder { - private Optional additionalProperties = Optional.empty(); - - private Optional> connectionInfo = Optional.empty(); + private JsonNullable> connectionInfo = JsonNullable.undefined(); private String created; - private Optional> dataConnectionErrors = Optional.empty(); + private JsonNullable> dataConnectionErrors = JsonNullable.undefined(); private String id; @@ -620,25 +590,13 @@ private Builder() { // force use of static builder() method } - public Builder additionalProperties(Object additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = Optional.ofNullable(additionalProperties); - return this; - } - - public Builder additionalProperties(Optional additionalProperties) { - Utils.checkNotNull(additionalProperties, "additionalProperties"); - this.additionalProperties = additionalProperties; - return this; - } - public Builder connectionInfo(Map connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); - this.connectionInfo = Optional.ofNullable(connectionInfo); + this.connectionInfo = JsonNullable.of(connectionInfo); return this; } - public Builder connectionInfo(Optional> connectionInfo) { + public Builder connectionInfo(JsonNullable> connectionInfo) { Utils.checkNotNull(connectionInfo, "connectionInfo"); this.connectionInfo = connectionInfo; return this; @@ -673,11 +631,11 @@ public Builder created(String created) { public Builder dataConnectionErrors(List dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); - this.dataConnectionErrors = Optional.ofNullable(dataConnectionErrors); + this.dataConnectionErrors = JsonNullable.of(dataConnectionErrors); return this; } - public Builder dataConnectionErrors(Optional> dataConnectionErrors) { + public Builder dataConnectionErrors(JsonNullable> dataConnectionErrors) { Utils.checkNotNull(dataConnectionErrors, "dataConnectionErrors"); this.dataConnectionErrors = dataConnectionErrors; return this; @@ -811,7 +769,6 @@ public Builder status(DataConnectionStatus status) { public Connection build() { return new Connection( - additionalProperties, connectionInfo, created, dataConnectionErrors, diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/GroupReference.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/GroupReference.java deleted file mode 100644 index 0259fc31..00000000 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/GroupReference.java +++ /dev/null @@ -1,127 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -package io.codat.bank_feeds.models.components; - - -import com.fasterxml.jackson.annotation.JsonCreator; -import com.fasterxml.jackson.annotation.JsonIgnore; -import com.fasterxml.jackson.annotation.JsonInclude.Include; -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import io.codat.bank_feeds.utils.Utils; -import java.lang.Override; -import java.lang.String; -import java.util.Objects; -import java.util.Optional; - - -public class GroupReference { - - /** - * Unique identifier for the group. - */ - @JsonInclude(Include.NON_ABSENT) - @JsonProperty("id") - private Optional id; - - @JsonCreator - public GroupReference( - @JsonProperty("id") Optional id) { - Utils.checkNotNull(id, "id"); - this.id = id; - } - - public GroupReference() { - this(Optional.empty()); - } - - /** - * Unique identifier for the group. - */ - @JsonIgnore - public Optional id() { - return id; - } - - public final static Builder builder() { - return new Builder(); - } - - /** - * Unique identifier for the group. - */ - public GroupReference withId(String id) { - Utils.checkNotNull(id, "id"); - this.id = Optional.ofNullable(id); - return this; - } - - /** - * Unique identifier for the group. - */ - public GroupReference withId(Optional id) { - Utils.checkNotNull(id, "id"); - this.id = id; - return this; - } - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - GroupReference other = (GroupReference) o; - return - Objects.deepEquals(this.id, other.id); - } - - @Override - public int hashCode() { - return Objects.hash( - id); - } - - @Override - public String toString() { - return Utils.toString(GroupReference.class, - "id", id); - } - - public final static class Builder { - - private Optional id = Optional.empty(); - - private Builder() { - // force use of static builder() method - } - - /** - * Unique identifier for the group. - */ - public Builder id(String id) { - Utils.checkNotNull(id, "id"); - this.id = Optional.ofNullable(id); - return this; - } - - /** - * Unique identifier for the group. - */ - public Builder id(Optional id) { - Utils.checkNotNull(id, "id"); - this.id = id; - return this; - } - - public GroupReference build() { - return new GroupReference( - id); - } - } -} - diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/SourceAccountWebhookPayload.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/SourceAccountWebhookPayload.java index c78f50b8..7d2f6f3d 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/SourceAccountWebhookPayload.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/SourceAccountWebhookPayload.java @@ -34,6 +34,10 @@ public class SourceAccountWebhookPayload { @JsonProperty("connectionId") private Optional connectionId; + @JsonInclude(Include.NON_ABSENT) + @JsonProperty("referenceCompany") + private Optional referenceCompany; + /** * The target bank account in a supported accounting software for ingestion into a bank feed. */ @@ -45,17 +49,20 @@ public class SourceAccountWebhookPayload { public SourceAccountWebhookPayload( @JsonProperty("companyId") Optional companyId, @JsonProperty("connectionId") Optional connectionId, + @JsonProperty("referenceCompany") Optional referenceCompany, @JsonProperty("sourceAccount") Optional sourceAccount) { Utils.checkNotNull(companyId, "companyId"); Utils.checkNotNull(connectionId, "connectionId"); + Utils.checkNotNull(referenceCompany, "referenceCompany"); Utils.checkNotNull(sourceAccount, "sourceAccount"); this.companyId = companyId; this.connectionId = connectionId; + this.referenceCompany = referenceCompany; this.sourceAccount = sourceAccount; } public SourceAccountWebhookPayload() { - this(Optional.empty(), Optional.empty(), Optional.empty()); + this(Optional.empty(), Optional.empty(), Optional.empty(), Optional.empty()); } /** @@ -74,6 +81,12 @@ public Optional connectionId() { return connectionId; } + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional referenceCompany() { + return (Optional) referenceCompany; + } + /** * The target bank account in a supported accounting software for ingestion into a bank feed. */ @@ -123,6 +136,18 @@ public SourceAccountWebhookPayload withConnectionId(Optional connectionI return this; } + public SourceAccountWebhookPayload withReferenceCompany(CompanyReference referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = Optional.ofNullable(referenceCompany); + return this; + } + + public SourceAccountWebhookPayload withReferenceCompany(Optional referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = referenceCompany; + return this; + } + /** * The target bank account in a supported accounting software for ingestion into a bank feed. */ @@ -153,6 +178,7 @@ public boolean equals(java.lang.Object o) { return Objects.deepEquals(this.companyId, other.companyId) && Objects.deepEquals(this.connectionId, other.connectionId) && + Objects.deepEquals(this.referenceCompany, other.referenceCompany) && Objects.deepEquals(this.sourceAccount, other.sourceAccount); } @@ -161,6 +187,7 @@ public int hashCode() { return Objects.hash( companyId, connectionId, + referenceCompany, sourceAccount); } @@ -169,6 +196,7 @@ public String toString() { return Utils.toString(SourceAccountWebhookPayload.class, "companyId", companyId, "connectionId", connectionId, + "referenceCompany", referenceCompany, "sourceAccount", sourceAccount); } @@ -178,6 +206,8 @@ public final static class Builder { private Optional connectionId = Optional.empty(); + private Optional referenceCompany = Optional.empty(); + private Optional sourceAccount = Optional.empty(); private Builder() { @@ -220,6 +250,18 @@ public Builder connectionId(Optional connectionId) { return this; } + public Builder referenceCompany(CompanyReference referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = Optional.ofNullable(referenceCompany); + return this; + } + + public Builder referenceCompany(Optional referenceCompany) { + Utils.checkNotNull(referenceCompany, "referenceCompany"); + this.referenceCompany = referenceCompany; + return this; + } + /** * The target bank account in a supported accounting software for ingestion into a bank feed. */ @@ -242,6 +284,7 @@ public SourceAccountWebhookPayload build() { return new SourceAccountWebhookPayload( companyId, connectionId, + referenceCompany, sourceAccount); } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Tags.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Tags.java deleted file mode 100644 index 21301990..00000000 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/components/Tags.java +++ /dev/null @@ -1,64 +0,0 @@ -/* - * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. - */ - -package io.codat.bank_feeds.models.components; - - -import com.fasterxml.jackson.annotation.JsonCreator; -import io.codat.bank_feeds.utils.Utils; -import java.lang.Override; -import java.lang.String; -import java.util.Objects; - -/** - * Tags - A collection of user-defined key-value pairs that store custom metadata against the company. - */ - -public class Tags { - - @JsonCreator - public Tags() { - - - } - - public final static Builder builder() { - return new Builder(); - } - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - return true; - } - - @Override - public int hashCode() { - return Objects.hash( - ); - } - - @Override - public String toString() { - return Utils.toString(Tags.class); - } - - public final static class Builder { - - private Builder() { - // force use of static builder() method - } - - public Tags build() { - return new Tags( - ); - } - } -} - diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/errors/ErrorMessage.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/errors/ErrorMessage.java index bffdfba8..9a78fd15 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/errors/ErrorMessage.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/errors/ErrorMessage.java @@ -19,8 +19,9 @@ import org.openapitools.jackson.nullable.JsonNullable; /** - * ErrorMessage - The request made is not valid. + * ErrorMessage - Your `query` parameter was not correctly formed */ +@SuppressWarnings("serial") public class ErrorMessage extends RuntimeException { /** diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountMappingRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountMappingRequestBuilder.java index d0336db1..89077c5e 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountMappingRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountMappingRequestBuilder.java @@ -19,19 +19,19 @@ public CreateBankAccountMappingRequestBuilder(SDKMethodInterfaces.MethodCallCrea this.sdk = sdk; } - public CreateBankAccountMappingRequestBuilder request(io.codat.bank_feeds.models.operations.CreateBankAccountMappingRequest request) { + public CreateBankAccountMappingRequestBuilder request(CreateBankAccountMappingRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateBankAccountMappingRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateBankAccountMappingRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateBankAccountMappingRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateBankAccountMappingRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountRequestBuilder.java index 0e4e4352..f28423b8 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankAccountRequestBuilder.java @@ -19,19 +19,19 @@ public CreateBankAccountRequestBuilder(SDKMethodInterfaces.MethodCallCreateBankA this.sdk = sdk; } - public CreateBankAccountRequestBuilder request(io.codat.bank_feeds.models.operations.CreateBankAccountRequest request) { + public CreateBankAccountRequestBuilder request(CreateBankAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateBankAccountRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateBankAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateBankAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateBankAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankTransactionsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankTransactionsRequestBuilder.java index bb32cbda..97f0dd3f 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankTransactionsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateBankTransactionsRequestBuilder.java @@ -19,19 +19,19 @@ public CreateBankTransactionsRequestBuilder(SDKMethodInterfaces.MethodCallCreate this.sdk = sdk; } - public CreateBankTransactionsRequestBuilder request(io.codat.bank_feeds.models.operations.CreateBankTransactionsRequest request) { + public CreateBankTransactionsRequestBuilder request(CreateBankTransactionsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateBankTransactionsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateBankTransactionsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateBankTransactionsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateBankTransactionsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateCompanyRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateCompanyRequestBuilder.java index 9249fdb4..83e3a939 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateCompanyRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateCompanyRequestBuilder.java @@ -20,25 +20,25 @@ public CreateCompanyRequestBuilder(SDKMethodInterfaces.MethodCallCreateCompany s this.sdk = sdk; } - public CreateCompanyRequestBuilder request(io.codat.bank_feeds.models.components.CompanyRequestBody request) { + public CreateCompanyRequestBuilder request(CompanyRequestBody request) { Utils.checkNotNull(request, "request"); this.request = Optional.of(request); return this; } - public CreateCompanyRequestBuilder request(java.util.Optional request) { + public CreateCompanyRequestBuilder request(Optional request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateCompanyRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateConnectionRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateConnectionRequestBuilder.java index e6584167..52e57fa7 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateConnectionRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public CreateConnectionRequestBuilder(SDKMethodInterfaces.MethodCallCreateConnec this.sdk = sdk; } - public CreateConnectionRequestBuilder request(io.codat.bank_feeds.models.operations.CreateConnectionRequest request) { + public CreateConnectionRequestBuilder request(CreateConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateConnectionRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBody.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBody.java index b28bb0cf..20469b48 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBody.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBody.java @@ -85,8 +85,8 @@ public static final class _Deserializer extends OneOfDeserializer() {}, JsonShape.DEFAULT), - TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT)); + TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT), + TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT)); } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBuilder.java index 2a980a10..57a9b6ea 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountRequestBuilder.java @@ -19,19 +19,19 @@ public CreateSourceAccountRequestBuilder(SDKMethodInterfaces.MethodCallCreateSou this.sdk = sdk; } - public CreateSourceAccountRequestBuilder request(io.codat.bank_feeds.models.operations.CreateSourceAccountRequest request) { + public CreateSourceAccountRequestBuilder request(CreateSourceAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public CreateSourceAccountRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public CreateSourceAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public CreateSourceAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public CreateSourceAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountResponseBody.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountResponseBody.java index 015843fc..6740f9ee 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountResponseBody.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/CreateSourceAccountResponseBody.java @@ -88,8 +88,8 @@ public static final class _Deserializer extends OneOfDeserializer() {}, JsonShape.DEFAULT), - TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT)); + TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT), + TypeReferenceWithShape.of(new TypeReference() {}, JsonShape.DEFAULT)); } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteBankFeedCredentialsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteBankFeedCredentialsRequestBuilder.java index ce21d6db..90312a48 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteBankFeedCredentialsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteBankFeedCredentialsRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteBankFeedCredentialsRequestBuilder(SDKMethodInterfaces.MethodCallDel this.sdk = sdk; } - public DeleteBankFeedCredentialsRequestBuilder request(io.codat.bank_feeds.models.operations.DeleteBankFeedCredentialsRequest request) { + public DeleteBankFeedCredentialsRequestBuilder request(DeleteBankFeedCredentialsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteBankFeedCredentialsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public DeleteBankFeedCredentialsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteBankFeedCredentialsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteBankFeedCredentialsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteCompanyRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteCompanyRequestBuilder.java index 511a3621..8f693f52 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteCompanyRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteCompanyRequestBuilder(SDKMethodInterfaces.MethodCallDeleteCompany s this.sdk = sdk; } - public DeleteCompanyRequestBuilder request(io.codat.bank_feeds.models.operations.DeleteCompanyRequest request) { + public DeleteCompanyRequestBuilder request(DeleteCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteCompanyRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public DeleteCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteConnectionRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteConnectionRequestBuilder.java index 66e62d16..a1701598 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteConnectionRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteConnectionRequestBuilder(SDKMethodInterfaces.MethodCallDeleteConnec this.sdk = sdk; } - public DeleteConnectionRequestBuilder request(io.codat.bank_feeds.models.operations.DeleteConnectionRequest request) { + public DeleteConnectionRequestBuilder request(DeleteConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteConnectionRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public DeleteConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteSourceAccountRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteSourceAccountRequestBuilder.java index e7373f88..56a287c8 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteSourceAccountRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/DeleteSourceAccountRequestBuilder.java @@ -19,19 +19,19 @@ public DeleteSourceAccountRequestBuilder(SDKMethodInterfaces.MethodCallDeleteSou this.sdk = sdk; } - public DeleteSourceAccountRequestBuilder request(io.codat.bank_feeds.models.operations.DeleteSourceAccountRequest request) { + public DeleteSourceAccountRequestBuilder request(DeleteSourceAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public DeleteSourceAccountRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public DeleteSourceAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public DeleteSourceAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public DeleteSourceAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GenerateCredentialsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GenerateCredentialsRequestBuilder.java index 3c2c1752..8dc60a9d 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GenerateCredentialsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GenerateCredentialsRequestBuilder.java @@ -19,19 +19,19 @@ public GenerateCredentialsRequestBuilder(SDKMethodInterfaces.MethodCallGenerateC this.sdk = sdk; } - public GenerateCredentialsRequestBuilder request(io.codat.bank_feeds.models.operations.GenerateCredentialsRequest request) { + public GenerateCredentialsRequestBuilder request(GenerateCredentialsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GenerateCredentialsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GenerateCredentialsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GenerateCredentialsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GenerateCredentialsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingRequestBuilder.java index cb298f45..a9437f34 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingRequestBuilder.java @@ -19,19 +19,19 @@ public GetBankAccountMappingRequestBuilder(SDKMethodInterfaces.MethodCallGetBank this.sdk = sdk; } - public GetBankAccountMappingRequestBuilder request(io.codat.bank_feeds.models.operations.GetBankAccountMappingRequest request) { + public GetBankAccountMappingRequestBuilder request(GetBankAccountMappingRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetBankAccountMappingRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetBankAccountMappingRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetBankAccountMappingRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetBankAccountMappingRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingResponse.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingResponse.java index 50152001..e14dc605 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingResponse.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetBankAccountMappingResponse.java @@ -16,17 +16,13 @@ import java.lang.String; import java.lang.SuppressWarnings; import java.net.http.HttpResponse; +import java.util.List; import java.util.Objects; import java.util.Optional; public class GetBankAccountMappingResponse implements Response { - /** - * Success - */ - private Optional bankFeedMapping; - /** * HTTP response content type for this operation */ @@ -42,36 +38,32 @@ public class GetBankAccountMappingResponse implements Response { */ private HttpResponse rawResponse; + /** + * Success + */ + private Optional> bankFeedMappings; + @JsonCreator public GetBankAccountMappingResponse( - Optional bankFeedMapping, String contentType, int statusCode, - HttpResponse rawResponse) { - Utils.checkNotNull(bankFeedMapping, "bankFeedMapping"); + HttpResponse rawResponse, + Optional> bankFeedMappings) { Utils.checkNotNull(contentType, "contentType"); Utils.checkNotNull(statusCode, "statusCode"); Utils.checkNotNull(rawResponse, "rawResponse"); - this.bankFeedMapping = bankFeedMapping; + Utils.checkNotNull(bankFeedMappings, "bankFeedMappings"); this.contentType = contentType; this.statusCode = statusCode; this.rawResponse = rawResponse; + this.bankFeedMappings = bankFeedMappings; } public GetBankAccountMappingResponse( String contentType, int statusCode, HttpResponse rawResponse) { - this(Optional.empty(), contentType, statusCode, rawResponse); - } - - /** - * Success - */ - @SuppressWarnings("unchecked") - @JsonIgnore - public Optional bankFeedMapping() { - return (Optional) bankFeedMapping; + this(contentType, statusCode, rawResponse, Optional.empty()); } /** @@ -98,26 +90,17 @@ public HttpResponse rawResponse() { return rawResponse; } - public final static Builder builder() { - return new Builder(); - } - /** * Success */ - public GetBankAccountMappingResponse withBankFeedMapping(BankFeedMapping bankFeedMapping) { - Utils.checkNotNull(bankFeedMapping, "bankFeedMapping"); - this.bankFeedMapping = Optional.ofNullable(bankFeedMapping); - return this; + @SuppressWarnings("unchecked") + @JsonIgnore + public Optional> bankFeedMappings() { + return (Optional>) bankFeedMappings; } - /** - * Success - */ - public GetBankAccountMappingResponse withBankFeedMapping(Optional bankFeedMapping) { - Utils.checkNotNull(bankFeedMapping, "bankFeedMapping"); - this.bankFeedMapping = bankFeedMapping; - return this; + public final static Builder builder() { + return new Builder(); } /** @@ -146,6 +129,24 @@ public GetBankAccountMappingResponse withRawResponse(HttpResponse r this.rawResponse = rawResponse; return this; } + + /** + * Success + */ + public GetBankAccountMappingResponse withBankFeedMappings(List bankFeedMappings) { + Utils.checkNotNull(bankFeedMappings, "bankFeedMappings"); + this.bankFeedMappings = Optional.ofNullable(bankFeedMappings); + return this; + } + + /** + * Success + */ + public GetBankAccountMappingResponse withBankFeedMappings(Optional> bankFeedMappings) { + Utils.checkNotNull(bankFeedMappings, "bankFeedMappings"); + this.bankFeedMappings = bankFeedMappings; + return this; + } @Override public boolean equals(java.lang.Object o) { @@ -157,62 +158,44 @@ public boolean equals(java.lang.Object o) { } GetBankAccountMappingResponse other = (GetBankAccountMappingResponse) o; return - Objects.deepEquals(this.bankFeedMapping, other.bankFeedMapping) && Objects.deepEquals(this.contentType, other.contentType) && Objects.deepEquals(this.statusCode, other.statusCode) && - Objects.deepEquals(this.rawResponse, other.rawResponse); + Objects.deepEquals(this.rawResponse, other.rawResponse) && + Objects.deepEquals(this.bankFeedMappings, other.bankFeedMappings); } @Override public int hashCode() { return Objects.hash( - bankFeedMapping, contentType, statusCode, - rawResponse); + rawResponse, + bankFeedMappings); } @Override public String toString() { return Utils.toString(GetBankAccountMappingResponse.class, - "bankFeedMapping", bankFeedMapping, "contentType", contentType, "statusCode", statusCode, - "rawResponse", rawResponse); + "rawResponse", rawResponse, + "bankFeedMappings", bankFeedMappings); } public final static class Builder { - private Optional bankFeedMapping = Optional.empty(); - private String contentType; private Integer statusCode; - private HttpResponse rawResponse; + private HttpResponse rawResponse; + + private Optional> bankFeedMappings = Optional.empty(); private Builder() { // force use of static builder() method } - /** - * Success - */ - public Builder bankFeedMapping(BankFeedMapping bankFeedMapping) { - Utils.checkNotNull(bankFeedMapping, "bankFeedMapping"); - this.bankFeedMapping = Optional.ofNullable(bankFeedMapping); - return this; - } - - /** - * Success - */ - public Builder bankFeedMapping(Optional bankFeedMapping) { - Utils.checkNotNull(bankFeedMapping, "bankFeedMapping"); - this.bankFeedMapping = bankFeedMapping; - return this; - } - /** * HTTP response content type for this operation */ @@ -239,13 +222,31 @@ public Builder rawResponse(HttpResponse rawResponse) { this.rawResponse = rawResponse; return this; } + + /** + * Success + */ + public Builder bankFeedMappings(List bankFeedMappings) { + Utils.checkNotNull(bankFeedMappings, "bankFeedMappings"); + this.bankFeedMappings = Optional.ofNullable(bankFeedMappings); + return this; + } + + /** + * Success + */ + public Builder bankFeedMappings(Optional> bankFeedMappings) { + Utils.checkNotNull(bankFeedMappings, "bankFeedMappings"); + this.bankFeedMappings = bankFeedMappings; + return this; + } public GetBankAccountMappingResponse build() { return new GetBankAccountMappingResponse( - bankFeedMapping, contentType, statusCode, - rawResponse); + rawResponse, + bankFeedMappings); } } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyInformationRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyInformationRequestBuilder.java index 7384d781..4195eddb 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyInformationRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyInformationRequestBuilder.java @@ -19,19 +19,19 @@ public GetCompanyInformationRequestBuilder(SDKMethodInterfaces.MethodCallGetComp this.sdk = sdk; } - public GetCompanyInformationRequestBuilder request(io.codat.bank_feeds.models.operations.GetCompanyInformationRequest request) { + public GetCompanyInformationRequestBuilder request(GetCompanyInformationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCompanyInformationRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetCompanyInformationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCompanyInformationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCompanyInformationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyRequestBuilder.java index f862b523..ec53487a 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public GetCompanyRequestBuilder(SDKMethodInterfaces.MethodCallGetCompany sdk) { this.sdk = sdk; } - public GetCompanyRequestBuilder request(io.codat.bank_feeds.models.operations.GetCompanyRequest request) { + public GetCompanyRequestBuilder request(GetCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCompanyRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConfigurationRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConfigurationRequestBuilder.java index 465c4db0..442269bd 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConfigurationRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConfigurationRequestBuilder.java @@ -19,19 +19,19 @@ public GetConfigurationRequestBuilder(SDKMethodInterfaces.MethodCallGetConfigura this.sdk = sdk; } - public GetConfigurationRequestBuilder request(io.codat.bank_feeds.models.operations.GetConfigurationRequest request) { + public GetConfigurationRequestBuilder request(GetConfigurationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetConfigurationRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetConfigurationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetConfigurationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetConfigurationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConnectionRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConnectionRequestBuilder.java index f28c0f51..7775b313 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConnectionRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public GetConnectionRequestBuilder(SDKMethodInterfaces.MethodCallGetConnection s this.sdk = sdk; } - public GetConnectionRequestBuilder request(io.codat.bank_feeds.models.operations.GetConnectionRequest request) { + public GetConnectionRequestBuilder request(GetConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetConnectionRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateBankAccountsModelRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateBankAccountsModelRequestBuilder.java index 16beaceb..542a7fc4 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateBankAccountsModelRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateBankAccountsModelRequestBuilder.java @@ -19,19 +19,19 @@ public GetCreateBankAccountsModelRequestBuilder(SDKMethodInterfaces.MethodCallGe this.sdk = sdk; } - public GetCreateBankAccountsModelRequestBuilder request(io.codat.bank_feeds.models.operations.GetCreateBankAccountsModelRequest request) { + public GetCreateBankAccountsModelRequestBuilder request(GetCreateBankAccountsModelRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCreateBankAccountsModelRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetCreateBankAccountsModelRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCreateBankAccountsModelRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCreateBankAccountsModelRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateOperationRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateOperationRequestBuilder.java index 29288614..bb2c198d 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateOperationRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetCreateOperationRequestBuilder.java @@ -19,19 +19,19 @@ public GetCreateOperationRequestBuilder(SDKMethodInterfaces.MethodCallGetCreateO this.sdk = sdk; } - public GetCreateOperationRequestBuilder request(io.codat.bank_feeds.models.operations.GetCreateOperationRequest request) { + public GetCreateOperationRequestBuilder request(GetCreateOperationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetCreateOperationRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetCreateOperationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetCreateOperationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetCreateOperationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetLastSuccessfulRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetLastSuccessfulRequestBuilder.java index 787434a9..968c1345 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetLastSuccessfulRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/GetLastSuccessfulRequestBuilder.java @@ -19,19 +19,19 @@ public GetLastSuccessfulRequestBuilder(SDKMethodInterfaces.MethodCallGetLastSucc this.sdk = sdk; } - public GetLastSuccessfulRequestBuilder request(io.codat.bank_feeds.models.operations.GetLastSuccessfulRequest request) { + public GetLastSuccessfulRequestBuilder request(GetLastSuccessfulRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public GetLastSuccessfulRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public GetLastSuccessfulRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public GetLastSuccessfulRequestBuilder retryConfig(java.util.Optional retryConfig) { + public GetLastSuccessfulRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListBankAccountsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListBankAccountsRequestBuilder.java index f55929e5..779462de 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListBankAccountsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListBankAccountsRequestBuilder.java @@ -19,19 +19,19 @@ public ListBankAccountsRequestBuilder(SDKMethodInterfaces.MethodCallListBankAcco this.sdk = sdk; } - public ListBankAccountsRequestBuilder request(io.codat.bank_feeds.models.operations.ListBankAccountsRequest request) { + public ListBankAccountsRequestBuilder request(ListBankAccountsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListBankAccountsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public ListBankAccountsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListBankAccountsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListBankAccountsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCompaniesRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCompaniesRequestBuilder.java index 8d590a2d..cb773275 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCompaniesRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCompaniesRequestBuilder.java @@ -19,19 +19,19 @@ public ListCompaniesRequestBuilder(SDKMethodInterfaces.MethodCallListCompanies s this.sdk = sdk; } - public ListCompaniesRequestBuilder request(io.codat.bank_feeds.models.operations.ListCompaniesRequest request) { + public ListCompaniesRequestBuilder request(ListCompaniesRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListCompaniesRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public ListCompaniesRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListCompaniesRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListCompaniesRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListConnectionsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListConnectionsRequestBuilder.java index a4087d30..db0e8505 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListConnectionsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListConnectionsRequestBuilder.java @@ -19,19 +19,19 @@ public ListConnectionsRequestBuilder(SDKMethodInterfaces.MethodCallListConnectio this.sdk = sdk; } - public ListConnectionsRequestBuilder request(io.codat.bank_feeds.models.operations.ListConnectionsRequest request) { + public ListConnectionsRequestBuilder request(ListConnectionsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListConnectionsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public ListConnectionsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListConnectionsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListConnectionsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCreateOperationsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCreateOperationsRequestBuilder.java index a5fbdf05..6c5b3fce 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCreateOperationsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListCreateOperationsRequestBuilder.java @@ -19,19 +19,19 @@ public ListCreateOperationsRequestBuilder(SDKMethodInterfaces.MethodCallListCrea this.sdk = sdk; } - public ListCreateOperationsRequestBuilder request(io.codat.bank_feeds.models.operations.ListCreateOperationsRequest request) { + public ListCreateOperationsRequestBuilder request(ListCreateOperationsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListCreateOperationsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public ListCreateOperationsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListCreateOperationsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListCreateOperationsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequestBuilder.java index fac3a6f2..b46b43ed 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsRequestBuilder.java @@ -19,19 +19,19 @@ public ListSourceAccountsRequestBuilder(SDKMethodInterfaces.MethodCallListSource this.sdk = sdk; } - public ListSourceAccountsRequestBuilder request(io.codat.bank_feeds.models.operations.ListSourceAccountsRequest request) { + public ListSourceAccountsRequestBuilder request(ListSourceAccountsRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public ListSourceAccountsRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public ListSourceAccountsRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public ListSourceAccountsRequestBuilder retryConfig(java.util.Optional retryConfig) { + public ListSourceAccountsRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponse.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponse.java index a0385f75..c4e4d73e 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponse.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponse.java @@ -7,7 +7,6 @@ import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonIgnore; -import io.codat.bank_feeds.models.components.SourceAccountV2; import io.codat.bank_feeds.utils.Response; import io.codat.bank_feeds.utils.Utils; import java.io.InputStream; @@ -16,7 +15,6 @@ import java.lang.String; import java.lang.SuppressWarnings; import java.net.http.HttpResponse; -import java.util.List; import java.util.Objects; import java.util.Optional; @@ -41,22 +39,22 @@ public class ListSourceAccountsResponse implements Response { /** * Success */ - private Optional> sourceAccounts; + private Optional oneOf; @JsonCreator public ListSourceAccountsResponse( String contentType, int statusCode, HttpResponse rawResponse, - Optional> sourceAccounts) { + Optional oneOf) { Utils.checkNotNull(contentType, "contentType"); Utils.checkNotNull(statusCode, "statusCode"); Utils.checkNotNull(rawResponse, "rawResponse"); - Utils.checkNotNull(sourceAccounts, "sourceAccounts"); + Utils.checkNotNull(oneOf, "oneOf"); this.contentType = contentType; this.statusCode = statusCode; this.rawResponse = rawResponse; - this.sourceAccounts = sourceAccounts; + this.oneOf = oneOf; } public ListSourceAccountsResponse( @@ -95,8 +93,8 @@ public HttpResponse rawResponse() { */ @SuppressWarnings("unchecked") @JsonIgnore - public Optional> sourceAccounts() { - return (Optional>) sourceAccounts; + public Optional oneOf() { + return (Optional) oneOf; } public final static Builder builder() { @@ -133,18 +131,18 @@ public ListSourceAccountsResponse withRawResponse(HttpResponse rawR /** * Success */ - public ListSourceAccountsResponse withSourceAccounts(List sourceAccounts) { - Utils.checkNotNull(sourceAccounts, "sourceAccounts"); - this.sourceAccounts = Optional.ofNullable(sourceAccounts); + public ListSourceAccountsResponse withOneOf(ListSourceAccountsResponseBody oneOf) { + Utils.checkNotNull(oneOf, "oneOf"); + this.oneOf = Optional.ofNullable(oneOf); return this; } /** * Success */ - public ListSourceAccountsResponse withSourceAccounts(Optional> sourceAccounts) { - Utils.checkNotNull(sourceAccounts, "sourceAccounts"); - this.sourceAccounts = sourceAccounts; + public ListSourceAccountsResponse withOneOf(Optional oneOf) { + Utils.checkNotNull(oneOf, "oneOf"); + this.oneOf = oneOf; return this; } @@ -161,7 +159,7 @@ public boolean equals(java.lang.Object o) { Objects.deepEquals(this.contentType, other.contentType) && Objects.deepEquals(this.statusCode, other.statusCode) && Objects.deepEquals(this.rawResponse, other.rawResponse) && - Objects.deepEquals(this.sourceAccounts, other.sourceAccounts); + Objects.deepEquals(this.oneOf, other.oneOf); } @Override @@ -170,7 +168,7 @@ public int hashCode() { contentType, statusCode, rawResponse, - sourceAccounts); + oneOf); } @Override @@ -179,7 +177,7 @@ public String toString() { "contentType", contentType, "statusCode", statusCode, "rawResponse", rawResponse, - "sourceAccounts", sourceAccounts); + "oneOf", oneOf); } public final static class Builder { @@ -190,7 +188,7 @@ public final static class Builder { private HttpResponse rawResponse; - private Optional> sourceAccounts = Optional.empty(); + private Optional oneOf = Optional.empty(); private Builder() { // force use of static builder() method @@ -226,18 +224,18 @@ public Builder rawResponse(HttpResponse rawResponse) { /** * Success */ - public Builder sourceAccounts(List sourceAccounts) { - Utils.checkNotNull(sourceAccounts, "sourceAccounts"); - this.sourceAccounts = Optional.ofNullable(sourceAccounts); + public Builder oneOf(ListSourceAccountsResponseBody oneOf) { + Utils.checkNotNull(oneOf, "oneOf"); + this.oneOf = Optional.ofNullable(oneOf); return this; } /** * Success */ - public Builder sourceAccounts(Optional> sourceAccounts) { - Utils.checkNotNull(sourceAccounts, "sourceAccounts"); - this.sourceAccounts = sourceAccounts; + public Builder oneOf(Optional oneOf) { + Utils.checkNotNull(oneOf, "oneOf"); + this.oneOf = oneOf; return this; } @@ -246,7 +244,7 @@ public ListSourceAccountsResponse build() { contentType, statusCode, rawResponse, - sourceAccounts); + oneOf); } } } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponseBody.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponseBody.java new file mode 100644 index 00000000..436e7147 --- /dev/null +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/ListSourceAccountsResponseBody.java @@ -0,0 +1,103 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +package io.codat.bank_feeds.models.operations; + + +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.core.type.TypeReference; +import com.fasterxml.jackson.databind.annotation.JsonDeserialize; +import io.codat.bank_feeds.models.components.SourceAccount; +import io.codat.bank_feeds.models.components.SourceAccountV2; +import io.codat.bank_feeds.utils.OneOfDeserializer; +import io.codat.bank_feeds.utils.TypedObject; +import io.codat.bank_feeds.utils.Utils.JsonShape; +import io.codat.bank_feeds.utils.Utils.TypeReferenceWithShape; +import io.codat.bank_feeds.utils.Utils; +import java.lang.Override; +import java.lang.String; +import java.lang.SuppressWarnings; +import java.util.List; +import java.util.Objects; + +/** + * ListSourceAccountsResponseBody - Success + */ + +@JsonDeserialize(using = ListSourceAccountsResponseBody._Deserializer.class) +public class ListSourceAccountsResponseBody { + + @JsonValue + private TypedObject value; + + private ListSourceAccountsResponseBody(TypedObject value) { + this.value = value; + } + + public static ListSourceAccountsResponseBody ofSourceAccountV2(List value) { + Utils.checkNotNull(value, "value"); + return new ListSourceAccountsResponseBody(TypedObject.of(value, JsonShape.DEFAULT, new TypeReference>(){})); + } + + public static ListSourceAccountsResponseBody ofSourceAccount(List value) { + Utils.checkNotNull(value, "value"); + return new ListSourceAccountsResponseBody(TypedObject.of(value, JsonShape.DEFAULT, new TypeReference>(){})); + } + + /** + * Returns an instance of one of these types: + *
    + *
  • {@code java.util.List}
    • + *
  • {@code java.util.List}
    • + *
+ * + *

Use {@code instanceof} to determine what type is returned. For example: + * + * 

+     * if (obj.value() instanceof String) {
+     *     String answer = (String) obj.value();
+     *     System.out.println("answer=" + answer);
+     * }
+     *
+ * + * @return value of oneOf type + **/ + public java.lang.Object value() { + return value.value(); + } + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ListSourceAccountsResponseBody other = (ListSourceAccountsResponseBody) o; + return Objects.deepEquals(this.value.value(), other.value.value()); + } + + @Override + public int hashCode() { + return Objects.hash(value.value()); + } + + @SuppressWarnings("serial") + public static final class _Deserializer extends OneOfDeserializer { + + public _Deserializer() { + super(ListSourceAccountsResponseBody.class, false, + TypeReferenceWithShape.of(new TypeReference>() {}, JsonShape.DEFAULT), + TypeReferenceWithShape.of(new TypeReference>() {}, JsonShape.DEFAULT)); + } + } + + @Override + public String toString() { + return Utils.toString(ListSourceAccountsResponseBody.class, + "value", value); + } + +} diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SDKMethodInterfaces.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SDKMethodInterfaces.java index 11a8162e..1371db3c 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SDKMethodInterfaces.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SDKMethodInterfaces.java @@ -6,202 +6,203 @@ import io.codat.bank_feeds.models.components.CompanyRequestBody; import io.codat.bank_feeds.utils.Options; +import java.lang.Exception; import java.util.Optional; public class SDKMethodInterfaces { public interface MethodCallCreateCompany { - io.codat.bank_feeds.models.operations.CreateCompanyResponse create( + CreateCompanyResponse create( Optional request, Optional options) throws Exception; } public interface MethodCallDeleteCompany { - io.codat.bank_feeds.models.operations.DeleteCompanyResponse delete( + DeleteCompanyResponse delete( DeleteCompanyRequest request, Optional options) throws Exception; } public interface MethodCallGetCompany { - io.codat.bank_feeds.models.operations.GetCompanyResponse get( + GetCompanyResponse get( GetCompanyRequest request, Optional options) throws Exception; } public interface MethodCallListCompanies { - io.codat.bank_feeds.models.operations.ListCompaniesResponse list( + ListCompaniesResponse list( ListCompaniesRequest request, Optional options) throws Exception; } public interface MethodCallUpdateCompany { - io.codat.bank_feeds.models.operations.UpdateCompanyResponse update( + UpdateCompanyResponse update( UpdateCompanyRequest request, Optional options) throws Exception; } public interface MethodCallCreateConnection { - io.codat.bank_feeds.models.operations.CreateConnectionResponse create( + CreateConnectionResponse create( CreateConnectionRequest request, Optional options) throws Exception; } public interface MethodCallDeleteConnection { - io.codat.bank_feeds.models.operations.DeleteConnectionResponse delete( + DeleteConnectionResponse delete( DeleteConnectionRequest request, Optional options) throws Exception; } public interface MethodCallGetConnection { - io.codat.bank_feeds.models.operations.GetConnectionResponse get( + GetConnectionResponse get( GetConnectionRequest request, Optional options) throws Exception; } public interface MethodCallListConnections { - io.codat.bank_feeds.models.operations.ListConnectionsResponse list( + ListConnectionsResponse list( ListConnectionsRequest request, Optional options) throws Exception; } public interface MethodCallUnlinkConnection { - io.codat.bank_feeds.models.operations.UnlinkConnectionResponse unlink( + UnlinkConnectionResponse unlink( UnlinkConnectionRequest request, Optional options) throws Exception; } public interface MethodCallCreateBankAccountMapping { - io.codat.bank_feeds.models.operations.CreateBankAccountMappingResponse create( + CreateBankAccountMappingResponse create( CreateBankAccountMappingRequest request, Optional options) throws Exception; } public interface MethodCallGetBankAccountMapping { - io.codat.bank_feeds.models.operations.GetBankAccountMappingResponse get( + GetBankAccountMappingResponse get( GetBankAccountMappingRequest request, Optional options) throws Exception; } public interface MethodCallGetCompanyInformation { - io.codat.bank_feeds.models.operations.GetCompanyInformationResponse get( + GetCompanyInformationResponse get( GetCompanyInformationRequest request, Optional options) throws Exception; } public interface MethodCallCreateSourceAccount { - io.codat.bank_feeds.models.operations.CreateSourceAccountResponse create( + CreateSourceAccountResponse create( CreateSourceAccountRequest request, Optional options) throws Exception; } public interface MethodCallDeleteSourceAccount { - io.codat.bank_feeds.models.operations.DeleteSourceAccountResponse delete( + DeleteSourceAccountResponse delete( DeleteSourceAccountRequest request, Optional options) throws Exception; } public interface MethodCallDeleteBankFeedCredentials { - io.codat.bank_feeds.models.operations.DeleteBankFeedCredentialsResponse deleteCredentials( + DeleteBankFeedCredentialsResponse deleteCredentials( DeleteBankFeedCredentialsRequest request, Optional options) throws Exception; } public interface MethodCallGenerateCredentials { - io.codat.bank_feeds.models.operations.GenerateCredentialsResponse generateCredentials( + GenerateCredentialsResponse generateCredentials( GenerateCredentialsRequest request, Optional options) throws Exception; } public interface MethodCallListSourceAccounts { - io.codat.bank_feeds.models.operations.ListSourceAccountsResponse list( + ListSourceAccountsResponse list( ListSourceAccountsRequest request, Optional options) throws Exception; } public interface MethodCallUpdateSourceAccount { - io.codat.bank_feeds.models.operations.UpdateSourceAccountResponse update( + UpdateSourceAccountResponse update( UpdateSourceAccountRequest request, Optional options) throws Exception; } public interface MethodCallCreateBankAccount { - io.codat.bank_feeds.models.operations.CreateBankAccountResponse create( + CreateBankAccountResponse create( CreateBankAccountRequest request, Optional options) throws Exception; } public interface MethodCallGetCreateBankAccountsModel { - io.codat.bank_feeds.models.operations.GetCreateBankAccountsModelResponse getCreateModel( + GetCreateBankAccountsModelResponse getCreateModel( GetCreateBankAccountsModelRequest request, Optional options) throws Exception; } public interface MethodCallListBankAccounts { - io.codat.bank_feeds.models.operations.ListBankAccountsResponse list( + ListBankAccountsResponse list( ListBankAccountsRequest request, Optional options) throws Exception; } public interface MethodCallCreateBankTransactions { - io.codat.bank_feeds.models.operations.CreateBankTransactionsResponse create( + CreateBankTransactionsResponse create( CreateBankTransactionsRequest request, Optional options) throws Exception; } public interface MethodCallGetCreateOperation { - io.codat.bank_feeds.models.operations.GetCreateOperationResponse getCreateOperation( + GetCreateOperationResponse getCreateOperation( GetCreateOperationRequest request, Optional options) throws Exception; } public interface MethodCallListCreateOperations { - io.codat.bank_feeds.models.operations.ListCreateOperationsResponse listCreateOperations( + ListCreateOperationsResponse listCreateOperations( ListCreateOperationsRequest request, Optional options) throws Exception; } public interface MethodCallGetConfiguration { - io.codat.bank_feeds.models.operations.GetConfigurationResponse get( + GetConfigurationResponse get( GetConfigurationRequest request, Optional options) throws Exception; } public interface MethodCallSetConfiguration { - io.codat.bank_feeds.models.operations.SetConfigurationResponse set( + SetConfigurationResponse set( SetConfigurationRequest request, Optional options) throws Exception; } public interface MethodCallGetLastSuccessful { - io.codat.bank_feeds.models.operations.GetLastSuccessfulResponse getLastSuccessfulSync( + GetLastSuccessfulResponse getLastSuccessfulSync( GetLastSuccessfulRequest request, Optional options) throws Exception; } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequestBuilder.java index 38e531c0..aebdff85 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/SetConfigurationRequestBuilder.java @@ -19,19 +19,19 @@ public SetConfigurationRequestBuilder(SDKMethodInterfaces.MethodCallSetConfigura this.sdk = sdk; } - public SetConfigurationRequestBuilder request(io.codat.bank_feeds.models.operations.SetConfigurationRequest request) { + public SetConfigurationRequestBuilder request(SetConfigurationRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public SetConfigurationRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public SetConfigurationRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public SetConfigurationRequestBuilder retryConfig(java.util.Optional retryConfig) { + public SetConfigurationRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UnlinkConnectionRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UnlinkConnectionRequestBuilder.java index 7ec3fa4a..ce7e4f15 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UnlinkConnectionRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UnlinkConnectionRequestBuilder.java @@ -19,19 +19,19 @@ public UnlinkConnectionRequestBuilder(SDKMethodInterfaces.MethodCallUnlinkConnec this.sdk = sdk; } - public UnlinkConnectionRequestBuilder request(io.codat.bank_feeds.models.operations.UnlinkConnectionRequest request) { + public UnlinkConnectionRequestBuilder request(UnlinkConnectionRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UnlinkConnectionRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public UnlinkConnectionRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UnlinkConnectionRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UnlinkConnectionRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateCompanyRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateCompanyRequestBuilder.java index 5da9d87b..65214752 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateCompanyRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateCompanyRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateCompanyRequestBuilder(SDKMethodInterfaces.MethodCallUpdateCompany s this.sdk = sdk; } - public UpdateCompanyRequestBuilder request(io.codat.bank_feeds.models.operations.UpdateCompanyRequest request) { + public UpdateCompanyRequestBuilder request(UpdateCompanyRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateCompanyRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public UpdateCompanyRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateCompanyRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateCompanyRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateSourceAccountRequestBuilder.java b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateSourceAccountRequestBuilder.java index 006f027a..7543a0b3 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateSourceAccountRequestBuilder.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/models/operations/UpdateSourceAccountRequestBuilder.java @@ -19,19 +19,19 @@ public UpdateSourceAccountRequestBuilder(SDKMethodInterfaces.MethodCallUpdateSou this.sdk = sdk; } - public UpdateSourceAccountRequestBuilder request(io.codat.bank_feeds.models.operations.UpdateSourceAccountRequest request) { + public UpdateSourceAccountRequestBuilder request(UpdateSourceAccountRequest request) { Utils.checkNotNull(request, "request"); this.request = request; return this; } - public UpdateSourceAccountRequestBuilder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) { + public UpdateSourceAccountRequestBuilder retryConfig(RetryConfig retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public UpdateSourceAccountRequestBuilder retryConfig(java.util.Optional retryConfig) { + public UpdateSourceAccountRequestBuilder retryConfig(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/EventStream.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/EventStream.java index 38bcbbbe..2e1c4bd2 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/EventStream.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/EventStream.java @@ -33,12 +33,14 @@ public final class EventStream implements AutoCloseable { private final EventStreamReader reader; private final TypeReference typeReference; private final ObjectMapper mapper; + private final Optional terminalMessage; // Internal use only - public EventStream(InputStream in, TypeReference typeReference, ObjectMapper mapper) { + public EventStream(InputStream in, TypeReference typeReference, ObjectMapper mapper, Optional terminalMessage) { this.reader = new EventStreamReader(in); this.typeReference = typeReference; this.mapper = mapper; + this.terminalMessage = terminalMessage; } /** @@ -50,6 +52,7 @@ public EventStream(InputStream in, TypeReference typeReference, ObjectMapper */ public Optional next() throws IOException { return reader.readMessage() // + .filter(x -> !terminalMessage.isPresent() || !terminalMessage.get().equals(x.data())) // .map(x -> Utils.asType(x, mapper, typeReference)); } @@ -124,3 +127,4 @@ public void close() throws Exception { } } + diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/OneOfDeserializer.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/OneOfDeserializer.java index ef82e926..fe3a2621 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/OneOfDeserializer.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/OneOfDeserializer.java @@ -35,7 +35,7 @@ public class OneOfDeserializer extends StdDeserializer { private static final long serialVersionUID = -1; - private final List typeReferences; // oneOf subschemas + private final transient List typeReferences; // oneOf subschemas private final Class cls; private final boolean strict; private final ObjectMapper mapper; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Options.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Options.java index 679e003f..620fb7cc 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Options.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Options.java @@ -13,14 +13,14 @@ public enum Option { RETRY_CONFIG; } - private Optional retryConfig = Optional.empty(); + private Optional retryConfig = Optional.empty(); - private Options(Optional retryConfig) { + private Options(Optional retryConfig) { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; } - public Optional retryConfig() { + public Optional retryConfig() { return retryConfig; } @@ -36,17 +36,17 @@ public final static Builder builder() { public final static class Builder { - private Optional retryConfig = Optional.empty(); + private Optional retryConfig = Optional.empty(); private Builder() {} - public Builder retryConfig(io.codat.bank_feeds.utils.RetryConfig retryConfig) throws IllegalArgumentException { + public Builder retryConfig(RetryConfig retryConfig) throws IllegalArgumentException { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = Optional.of(retryConfig); return this; } - public Builder retryConfig(Optional retryConfig) throws IllegalArgumentException { + public Builder retryConfig(Optional retryConfig) throws IllegalArgumentException { Utils.checkNotNull(retryConfig, "retryConfig"); this.retryConfig = retryConfig; return this; diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/QueryParameters.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/QueryParameters.java index 7056ec86..aff3f177 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/QueryParameters.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/QueryParameters.java @@ -61,6 +61,8 @@ public static List parseQueryParams(Class t List pipeDelimitedParams = parseDelimitedParams(queryParamsMetadata, value, "|"); allParams.addAll(pipeDelimitedParams); break; + default: + break; } } } @@ -71,16 +73,15 @@ public static List parseQueryParams(Class t private static List parseSerializedParams(QueryParamsMetadata queryParamsMetadata, Object value) throws JsonProcessingException { List params = new ArrayList<>(); - switch (queryParamsMetadata.serialization) { case "json": ObjectMapper mapper = JSON.getMapper(); String json = mapper.writeValueAsString(value); - params.add(new BasicNameValuePair(queryParamsMetadata.name, json)); break; + default: + break; } - return params; } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Security.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Security.java index a4dd6a5d..6affb5ac 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Security.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Security.java @@ -5,6 +5,7 @@ package io.codat.bank_feeds.utils; import java.lang.reflect.Field; +import java.nio.charset.StandardCharsets; import java.util.Base64; public final class Security { @@ -122,7 +123,9 @@ private static void parseSecuritySchemeValue(HTTPRequest request, SecurityMetada request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); break; case "oauth2": - request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); + if (!"client_credentials".equals(schemeMetadata.subtype)) { + request.addHeader(securityMetadata.name, Utils.prefixBearer(Utils.valToString(value))); + } break; case "http": switch (schemeMetadata.subtype) { @@ -171,6 +174,9 @@ private static void parseBasicAuthScheme(HTTPRequest requestBuilder, Object sche } requestBuilder.addHeader("Authorization", - "Basic " + Base64.getEncoder().encodeToString(String.format("%s:%s", username, password).getBytes())); + "Basic " + + Base64.getEncoder() + .encodeToString(String.format("%s:%s", username, password) + .getBytes(StandardCharsets.UTF_8))); } } \ No newline at end of file diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/TypedObject.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/TypedObject.java index cad8d440..435f6d5d 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/TypedObject.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/TypedObject.java @@ -37,7 +37,12 @@ public TypeReference typeReference() { public JsonShape shape() { return shape; } - + + @Override + public String toString() { + return String.valueOf(value); + } + public static TypedObject of(T value, JsonShape shape, TypeReference typeReference) { return new TypedObject(value, shape, typeReference); } diff --git a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Utils.java b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Utils.java index 5e82fd49..3277c66e 100644 --- a/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Utils.java +++ b/bank-feeds/src/main/java/io/codat/bank_feeds/utils/Utils.java @@ -4,36 +4,44 @@ package io.codat.bank_feeds.utils; -import java.io.InputStream; import java.io.ByteArrayInputStream; +import java.io.File; import java.io.IOException; +import java.io.InputStream; +import java.io.UncheckedIOException; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.math.BigDecimal; import java.math.BigInteger; import java.net.URI; +import java.net.URISyntaxException; import java.net.URLEncoder; import java.net.http.HttpClient.Version; import java.net.http.HttpHeaders; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.nio.file.StandardOpenOption; import java.time.LocalDate; import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; -import java.util.concurrent.Callable; -import java.util.function.BiPredicate; import java.util.HashMap; import java.util.Iterator; +import java.util.LinkedHashMap; import java.util.List; import java.util.Locale; import java.util.Map; import java.util.Map.Entry; import java.util.NoSuchElementException; import java.util.Optional; +import java.util.UUID; +import java.util.concurrent.Callable; +import java.util.function.BiPredicate; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Collectors; @@ -44,7 +52,6 @@ import org.apache.commons.io.IOUtils; import org.apache.http.NameValuePair; - import org.openapitools.jackson.nullable.JsonNullable; import com.fasterxml.jackson.core.JsonProcessingException; @@ -137,7 +144,7 @@ public static String generateURL(Class type, String baseURL, String path, pathParams.put(pathParamsMetadata.name, String.join(",", - array.stream().map(v -> Utils.valToString(v)) + array.stream().map(v -> valToString(v)) .collect(Collectors.toList()))); break; case MAP: @@ -149,17 +156,17 @@ public static String generateURL(Class type, String baseURL, String path, pathParams.put(pathParamsMetadata.name, String.join(",", map.entrySet().stream().map(e -> { if (pathParamsMetadata.explode) { - return String.format("%s=%s", Utils.valToString(e.getKey()), - Utils.valToString(e.getValue())); + return String.format("%s=%s", valToString(e.getKey()), + valToString(e.getValue())); } else { - return String.format("%s,%s", Utils.valToString(e.getKey()), - Utils.valToString(e.getValue())); + return String.format("%s,%s", valToString(e.getKey()), + valToString(e.getValue())); } }).collect(Collectors.toList()))); break; case OBJECT: if (!allowIntrospection(value.getClass())) { - pathParams.put(pathParamsMetadata.name, Utils.valToString(value)); + pathParams.put(pathParamsMetadata.name, valToString(value)); break; } List values = new ArrayList<>(); @@ -180,17 +187,17 @@ public static String generateURL(Class type, String baseURL, String path, if (pathParamsMetadata.explode) { values.add(String.format("%s=%s", valuePathParamsMetadata.name, - Utils.valToString(val))); + valToString(val))); } else { values.add(String.format("%s,%s", valuePathParamsMetadata.name, - Utils.valToString(val))); + valToString(val))); } } pathParams.put(pathParamsMetadata.name, String.join(",", values)); break; default: - pathParams.put(pathParamsMetadata.name, Utils.valToString(value)); + pathParams.put(pathParamsMetadata.name, valToString(value)); break; } } @@ -287,7 +294,7 @@ public static String templateUrl(String url, Map params) { String key = match.substring(1, match.length() - 1); String value = params.get(key); if (value != null) { - m.appendReplacement(sb, value); + m.appendReplacement(sb, URLEncoder.encode(value, StandardCharsets.UTF_8)); } } m.appendTail(sb); @@ -344,10 +351,10 @@ public static Map> getHeadersFromMetadata(Object headers, M if (headerMetadata.explode) { items.add( String.format("%s=%s", valueHeaderMetadata.name, - Utils.valToString(valueFieldValue))); + valToString(valueFieldValue))); } else { items.add(valueHeaderMetadata.name); - items.add(Utils.valToString(valueFieldValue)); + items.add(valToString(valueFieldValue)); } } @@ -370,11 +377,11 @@ public static Map> getHeadersFromMetadata(Object headers, M for (Map.Entry entry : map.entrySet()) { if (headerMetadata.explode) { - items.add(String.format("%s=%s", Utils.valToString(entry.getKey()), - Utils.valToString(entry.getValue()))); + items.add(String.format("%s=%s", valToString(entry.getKey()), + valToString(entry.getValue()))); } else { - items.add(Utils.valToString(entry.getKey())); - items.add(Utils.valToString(entry.getValue())); + items.add(valToString(entry.getKey())); + items.add(valToString(entry.getValue())); } } @@ -397,7 +404,7 @@ public static Map> getHeadersFromMetadata(Object headers, M List items = new ArrayList<>(); for (Object item : array) { - items.add(Utils.valToString(item)); + items.add(valToString(item)); } if (!result.containsKey(headerMetadata.name)) { @@ -415,7 +422,7 @@ public static Map> getHeadersFromMetadata(Object headers, M } List values = result.get(headerMetadata.name); - values.add(Utils.valToString(value)); + values.add(valToString(value)); break; } } @@ -425,17 +432,16 @@ public static Map> getHeadersFromMetadata(Object headers, M } public static String valToString(Object value) { - switch (Types.getType(value.getClass())) { - case ENUM: - try { - Field field = value.getClass().getDeclaredField("value"); - field.setAccessible(true); - return String.valueOf(field.get(value)); - } catch (Exception e) { - return "ERROR_UNKNOWN_VALUE"; - } - default: - return String.valueOf(resolveOptionals(value)); + if (value.getClass().isEnum()) { + try { + Field field = value.getClass().getDeclaredField("value"); + field.setAccessible(true); + return String.valueOf(field.get(value)); + } catch (IllegalArgumentException | IllegalAccessException | NoSuchFieldException | SecurityException e) { + return "ERROR_UNKNOWN_VALUE"; + } + } else { + return String.valueOf(resolveOptionals(value)); } } @@ -464,16 +470,15 @@ public static Object populateGlobal(Object value, String fieldName, String param private static Map parseSerializedParams(PathParamsMetadata pathParamsMetadata, Object value) throws JsonProcessingException { Map params = new HashMap<>(); - switch (pathParamsMetadata.serialization) { case "json": ObjectMapper mapper = JSON.getMapper(); String json = mapper.writeValueAsString(value); - - params.put(pathParamsMetadata.name, URLEncoder.encode(json, StandardCharsets.UTF_8)); + params.put(pathParamsMetadata.name, json); + break; + default: break; } - return params; } @@ -961,7 +966,7 @@ public static final class HttpResponseCached implements HttpResponse response) throws IOException { this.response = response; - this.bytes = Utils.toByteArrayAndClose(response.body()); + this.bytes = toByteArrayAndClose(response.body()); } public String bodyAsUtf8() { @@ -1050,4 +1055,130 @@ public static String discriminatorToString(Object o) { return (String) o; } } + + public static void recordTest(String id) { + try { + new File("build").mkdir(); + Files.writeString(Paths.get("build/test-javav2-record.txt"), id + "\n", StandardOpenOption.CREATE, + StandardOpenOption.APPEND); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + /** + * Returns an equivalent url with query parameters sorted by name. Sort is + * stable in that parameters with the same name will not be reordered. + * + * @param url input + * @return url with query parameters sorted by name + */ + public static String sortQueryParameters(String url) { + if (url == null || url.isBlank()) { + return ""; + } + String[] parts = url.split("\\?"); + if (parts.length == 1) { + return url; + } + String query = parts[1]; + String[] params = query.split("&"); + sortByDelimitedKey(params, "="); + return parts[0] + "?" + Arrays.stream(params).collect(Collectors.joining("&")); + } + + public static Object sortSerializedMaps(Object input, String regex, String delim) { + if (input == null) { + return input; + } else if (input instanceof String) { + return sortMapString((String) input, regex, delim); + } else if (input.getClass().isArray()) { + Object[] a = (Object[]) input; + String[] b = new String[a.length]; + for (int i = 0; i < a.length; i++) { + if (!(a[i] instanceof String)) { + throw new IllegalArgumentException("expected array item type of String, found " + a[i]); + } + b[i] = sortMapString((String) a[i], regex, delim); + } + return b; + } else if (input instanceof Map) { + @SuppressWarnings("unchecked") + Map a = (Map) input; + Map b = new LinkedHashMap<>(); + for (Entry entry: a.entrySet()) { + if (!(entry.getKey() instanceof String)) { + throw new IllegalArgumentException("expected map key type of String, found " + entry.getKey()); + } + if (!(entry.getValue() instanceof String)) { + throw new IllegalArgumentException("expected map value type of String, found " + entry.getValue()); + } + b.put((String) entry.getKey(), sortMapString((String) entry.getValue(), regex, delim)); + } + return b; + } else { + throw new IllegalArgumentException("unexpected type: " + input.getClass()); + } + } + + private static String sortMapString(String input, String regex, String delim) { + return Pattern.compile(regex).matcher(input).replaceAll(m -> { + String escapedDelim = Pattern.quote(delim); + String result = m.group(); + for (int i = 1; i <= m.groupCount(); i++) { + final String match = m.group(i); + String[] pairs; + if (match.contains("=")) { + pairs = match.split(escapedDelim); + sortByDelimitedKey(pairs, "="); + } else { + String[] values = match.split(escapedDelim); + if (values.length == 1) { + pairs = values; + } else { + pairs = new String[values.length / 2]; + for (int j = 0; j < values.length; j += 2) { + pairs[j / 2] = values[j] + delim + values[j + 1]; + } + } + sortByDelimitedKey(pairs, delim); + } + String joined = Arrays.stream(pairs).collect(Collectors.joining(delim)); + result = result.replace(m.group(i), joined); + } + return result; + }); + } + + private static void sortByDelimitedKey(String[] array, String delim) { + Arrays.sort(array, (a, b) -> { + String escapedDelim = Pattern.quote(delim); + String aKey = a.split(escapedDelim)[0]; + String bKey = b.split(escapedDelim)[0]; + return aKey.compareTo(bKey); + }); + } + + public static boolean isPresentAndNotNull(Optional x) { + return x.isPresent(); + } + + public static boolean isPresentAndNotNull(JsonNullable x) { + return x.isPresent() && x.get() != null; + } + + private static final String OPEN_BRACKET_MARKER = UUID.randomUUID().toString().replace("-", ""); + private static final String CLOSE_BRACKET_MARKER = UUID.randomUUID().toString().replace("-", ""); + + public static String urlEncode(String s) { + // Ensure that complies with RFC 2732 (URLEncoder does not and we don't want to + // encode [, ] chars) + return URLEncoder.encode( // + s.replace("[", OPEN_BRACKET_MARKER) // + .replace("]", CLOSE_BRACKET_MARKER), // + StandardCharsets.UTF_8) // + .replace(OPEN_BRACKET_MARKER, "[") // + .replace(CLOSE_BRACKET_MARKER, "]"); + } + }