From 7b3be2ee4647a36243b2d5f8bf1e4a18210c7735 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 18 Sep 2023 21:44:41 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc 3.0.0, Speakeay CLI 1.87.0 --- bank-feeds/README.md | 10 ++--- bank-feeds/RELEASES.md | 12 +++++- .../shared/clientratelimitreachedwebhook.md | 16 +++++++ .../clientratelimitreachedwebhookdata.md | 9 ++++ .../shared/clientratelimitresetwebhook.md | 16 +++++++ .../shared/clientratelimitresetwebhookdata.md | 11 +++++ .../shared/createbanktransactionsresponse.md | 2 +- .../docs/models/shared/pushoperation.md | 2 +- .../docs/models/shared/pushoperationstatus.md | 2 +- .../clientratelimitreachedresponse.md | 10 +++++ .../webhooks/clientratelimitresetresponse.md | 10 +++++ bank-feeds/docs/sdks/accountmapping/README.md | 2 +- bank-feeds/docs/sdks/companies/README.md | 2 +- bank-feeds/docs/sdks/connections/README.md | 2 +- bank-feeds/docs/sdks/sourceaccounts/README.md | 2 +- bank-feeds/docs/sdks/transactions/README.md | 2 +- bank-feeds/files.gen | 13 ++++++ bank-feeds/gen.yaml | 10 ++--- bank-feeds/setup.py | 2 +- .../codatbankfeeds/models/shared/__init__.py | 6 ++- .../shared/clientratelimitreachedwebhook.py | 30 +++++++++++++ .../clientratelimitreachedwebhookdata.py | 38 +++++++++++++++++ .../shared/clientratelimitresetwebhook.py | 30 +++++++++++++ .../shared/clientratelimitresetwebhookdata.py | 42 +++++++++++++++++++ .../shared/createbanktransactionsresponse.py | 2 +- .../models/shared/pushoperation.py | 2 +- .../models/shared/pushoperationstatus.py | 2 +- .../models/webhooks/__init__.py | 6 +++ .../webhooks/client_rate_limit_reached.py | 16 +++++++ .../webhooks/client_rate_limit_reset.py | 16 +++++++ .../src/codatbankfeeds/sdkconfiguration.py | 4 +- 31 files changed, 303 insertions(+), 26 deletions(-) create mode 100755 bank-feeds/docs/models/shared/clientratelimitreachedwebhook.md create mode 100755 bank-feeds/docs/models/shared/clientratelimitreachedwebhookdata.md create mode 100755 bank-feeds/docs/models/shared/clientratelimitresetwebhook.md create mode 100755 bank-feeds/docs/models/shared/clientratelimitresetwebhookdata.md create mode 100755 bank-feeds/docs/models/webhooks/clientratelimitreachedresponse.md create mode 100755 bank-feeds/docs/models/webhooks/clientratelimitresetresponse.md create mode 100755 bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhook.py create mode 100755 bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhookdata.py create mode 100755 bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhook.py create mode 100755 bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhookdata.py create mode 100755 bank-feeds/src/codatbankfeeds/models/webhooks/__init__.py create mode 100755 bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reached.py create mode 100755 bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reset.py diff --git a/bank-feeds/README.md b/bank-feeds/README.md index be8ff4087..37ec90386 100755 --- a/bank-feeds/README.md +++ b/bank-feeds/README.md @@ -45,12 +45,12 @@ if res.bank_feed_account_mapping_response is not None: ## Available Resources and Operations -### [account_mapping](docs/sdks/accountmapping/README.md) +### [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 -### [companies](docs/sdks/companies/README.md) +### [Companies](docs/sdks/companies/README.md) * [create](docs/sdks/companies/README.md#create) - Create company * [delete](docs/sdks/companies/README.md#delete) - Delete a company @@ -58,7 +58,7 @@ if res.bank_feed_account_mapping_response is not None: * [list](docs/sdks/companies/README.md#list) - List companies * [update](docs/sdks/companies/README.md#update) - Update company -### [connections](docs/sdks/connections/README.md) +### [Connections](docs/sdks/connections/README.md) * [create](docs/sdks/connections/README.md#create) - Create connection * [delete](docs/sdks/connections/README.md#delete) - Delete connection @@ -66,7 +66,7 @@ if res.bank_feed_account_mapping_response is not None: * [list](docs/sdks/connections/README.md#list) - List connections * [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection -### [source_accounts](docs/sdks/sourceaccounts/README.md) +### [SourceAccounts](docs/sdks/sourceaccounts/README.md) * [create](docs/sdks/sourceaccounts/README.md#create) - Create source account * [delete](docs/sdks/sourceaccounts/README.md#delete) - Delete source account @@ -75,7 +75,7 @@ if res.bank_feed_account_mapping_response is not None: * [list](docs/sdks/sourceaccounts/README.md#list) - List source accounts * [update](docs/sdks/sourceaccounts/README.md#update) - Update source account -### [transactions](docs/sdks/transactions/README.md) +### [Transactions](docs/sdks/transactions/README.md) * [create](docs/sdks/transactions/README.md#create) - Create bank transactions * [get_create_operation](docs/sdks/transactions/README.md#get_create_operation) - Get create operation diff --git a/bank-feeds/RELEASES.md b/bank-feeds/RELEASES.md index 816e9c7d3..aaa886eb6 100644 --- a/bank-feeds/RELEASES.md +++ b/bank-feeds/RELEASES.md @@ -708,4 +708,14 @@ Based on: ### Generated - [python v2.0.0] bank-feeds ### Releases -- [PyPI v2.0.0] https://pypi.org/project/codat-bankfeeds/2.0.0 - bank-feeds \ No newline at end of file +- [PyPI v2.0.0] https://pypi.org/project/codat-bankfeeds/2.0.0 - bank-feeds + +## 2023-09-18 21:44:22 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml +- Speakeasy CLI 1.87.0 (2.116.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v3.1.0] bank-feeds +### Releases +- [PyPI v3.1.0] https://pypi.org/project/codat-bankfeeds/3.1.0 - bank-feeds \ No newline at end of file diff --git a/bank-feeds/docs/models/shared/clientratelimitreachedwebhook.md b/bank-feeds/docs/models/shared/clientratelimitreachedwebhook.md new file mode 100755 index 000000000..3d7030310 --- /dev/null +++ b/bank-feeds/docs/models/shared/clientratelimitreachedwebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitReachedWebhook + +Webhook request body for a client that has reached their rate limit. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitReachedWebhookData]](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/bank-feeds/docs/models/shared/clientratelimitreachedwebhookdata.md b/bank-feeds/docs/models/shared/clientratelimitreachedwebhookdata.md new file mode 100755 index 000000000..caa124b1b --- /dev/null +++ b/bank-feeds/docs/models/shared/clientratelimitreachedwebhookdata.md @@ -0,0 +1,9 @@ +# ClientRateLimitReachedWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daily_quota` | *Optional[int]* | :heavy_minus_sign: | The number of available requests per day. | | +| `expires_utc` | *Optional[str]* | :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-23T00:00:00.000Z | \ No newline at end of file diff --git a/bank-feeds/docs/models/shared/clientratelimitresetwebhook.md b/bank-feeds/docs/models/shared/clientratelimitresetwebhook.md new file mode 100755 index 000000000..7336566a4 --- /dev/null +++ b/bank-feeds/docs/models/shared/clientratelimitresetwebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitResetWebhook + +Webhook request body for a client that has had their rate limit reset. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitResetWebhookData]](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/bank-feeds/docs/models/shared/clientratelimitresetwebhookdata.md b/bank-feeds/docs/models/shared/clientratelimitresetwebhookdata.md new file mode 100755 index 000000000..1b2b1eb58 --- /dev/null +++ b/bank-feeds/docs/models/shared/clientratelimitresetwebhookdata.md @@ -0,0 +1,11 @@ +# ClientRateLimitResetWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daily_quota` | *Optional[int]* | :heavy_minus_sign: | The number of available requests per day. | | +| `expires_utc` | *Optional[str]* | :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-23T00:00:00.000Z | +| `quota_remaining` | *Optional[int]* | :heavy_minus_sign: | Total number of request remaining for your client. | | +| `reset_reason` | *Optional[str]* | :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/shared/createbanktransactionsresponse.md b/bank-feeds/docs/models/shared/createbanktransactionsresponse.md index b5fbd987e..215fc4cdd 100755 --- a/bank-feeds/docs/models/shared/createbanktransactionsresponse.md +++ b/bank-feeds/docs/models/shared/createbanktransactionsresponse.md @@ -14,7 +14,7 @@ | `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `push_operation_key` | *str* | :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. | | | `requested_on_utc` | *str* | :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-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `status_code` | *int* | :heavy_check_mark: | N/A | | | `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | | ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/bank-feeds/docs/models/shared/pushoperation.md b/bank-feeds/docs/models/shared/pushoperation.md index 8537a2c10..c89b853f7 100755 --- a/bank-feeds/docs/models/shared/pushoperation.md +++ b/bank-feeds/docs/models/shared/pushoperation.md @@ -13,7 +13,7 @@ | `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `push_operation_key` | *str* | :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. | | | `requested_on_utc` | *str* | :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-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `status_code` | *int* | :heavy_check_mark: | N/A | | | `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | | ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/bank-feeds/docs/models/shared/pushoperationstatus.md b/bank-feeds/docs/models/shared/pushoperationstatus.md index 4125ba6a3..721aaa76b 100755 --- a/bank-feeds/docs/models/shared/pushoperationstatus.md +++ b/bank-feeds/docs/models/shared/pushoperationstatus.md @@ -1,6 +1,6 @@ # PushOperationStatus -The status of the push operation. +The current status of the push operation. ## Values diff --git a/bank-feeds/docs/models/webhooks/clientratelimitreachedresponse.md b/bank-feeds/docs/models/webhooks/clientratelimitreachedresponse.md new file mode 100755 index 000000000..a5368aedf --- /dev/null +++ b/bank-feeds/docs/models/webhooks/clientratelimitreachedresponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitReachedResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/bank-feeds/docs/models/webhooks/clientratelimitresetresponse.md b/bank-feeds/docs/models/webhooks/clientratelimitresetresponse.md new file mode 100755 index 000000000..d5db35b1b --- /dev/null +++ b/bank-feeds/docs/models/webhooks/clientratelimitresetresponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitResetResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ 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 fc423fb2c..d3fe38e1d 100755 --- a/bank-feeds/docs/sdks/accountmapping/README.md +++ b/bank-feeds/docs/sdks/accountmapping/README.md @@ -1,4 +1,4 @@ -# account_mapping +# AccountMapping ## Overview diff --git a/bank-feeds/docs/sdks/companies/README.md b/bank-feeds/docs/sdks/companies/README.md index 2aabbdd9f..fd59c97f3 100755 --- a/bank-feeds/docs/sdks/companies/README.md +++ b/bank-feeds/docs/sdks/companies/README.md @@ -1,4 +1,4 @@ -# companies +# Companies ## Overview diff --git a/bank-feeds/docs/sdks/connections/README.md b/bank-feeds/docs/sdks/connections/README.md index aebdcdd61..b49385f03 100755 --- a/bank-feeds/docs/sdks/connections/README.md +++ b/bank-feeds/docs/sdks/connections/README.md @@ -1,4 +1,4 @@ -# connections +# Connections ## Overview diff --git a/bank-feeds/docs/sdks/sourceaccounts/README.md b/bank-feeds/docs/sdks/sourceaccounts/README.md index 7535bbaae..0ec364bda 100755 --- a/bank-feeds/docs/sdks/sourceaccounts/README.md +++ b/bank-feeds/docs/sdks/sourceaccounts/README.md @@ -1,4 +1,4 @@ -# source_accounts +# SourceAccounts ## Overview diff --git a/bank-feeds/docs/sdks/transactions/README.md b/bank-feeds/docs/sdks/transactions/README.md index 51e3943b5..7bdae18d5 100755 --- a/bank-feeds/docs/sdks/transactions/README.md +++ b/bank-feeds/docs/sdks/transactions/README.md @@ -1,4 +1,4 @@ -# transactions +# Transactions ## Overview diff --git a/bank-feeds/files.gen b/bank-feeds/files.gen index f7ada86f6..e037f79eb 100755 --- a/bank-feeds/files.gen +++ b/bank-feeds/files.gen @@ -63,7 +63,14 @@ src/codatbankfeeds/models/shared/pushoperationref.py src/codatbankfeeds/models/shared/pushoperation.py src/codatbankfeeds/models/shared/pushoperations.py src/codatbankfeeds/models/shared/security.py +src/codatbankfeeds/models/shared/clientratelimitreachedwebhook.py +src/codatbankfeeds/models/shared/clientratelimitreachedwebhookdata.py +src/codatbankfeeds/models/shared/clientratelimitresetwebhook.py +src/codatbankfeeds/models/shared/clientratelimitresetwebhookdata.py src/codatbankfeeds/models/shared/__init__.py +src/codatbankfeeds/models/webhooks/client_rate_limit_reached.py +src/codatbankfeeds/models/webhooks/client_rate_limit_reset.py +src/codatbankfeeds/models/webhooks/__init__.py src/codatbankfeeds/models/errors/__init__.py docs/sdks/codatbankfeeds/README.md docs/models/utils/retryconfig.md @@ -146,4 +153,10 @@ docs/models/shared/pushoperationref.md docs/models/shared/pushoperation.md docs/models/shared/pushoperations.md docs/models/shared/security.md +docs/models/shared/clientratelimitreachedwebhook.md +docs/models/shared/clientratelimitreachedwebhookdata.md +docs/models/shared/clientratelimitresetwebhook.md +docs/models/shared/clientratelimitresetwebhookdata.md +docs/models/webhooks/clientratelimitreachedresponse.md +docs/models/webhooks/clientratelimitresetresponse.md .gitattributes \ No newline at end of file diff --git a/bank-feeds/gen.yaml b/bank-feeds/gen.yaml index dccb6e80a..8dd8dbe56 100644 --- a/bank-feeds/gen.yaml +++ b/bank-feeds/gen.yaml @@ -1,16 +1,16 @@ configVersion: 1.0.0 management: - docChecksum: 7815cab00193c62a7c7b468e85607ca1 + docChecksum: 3eb0f99edd359c8e932479051a25a5f4 docVersion: 3.0.0 - speakeasyVersion: 1.82.5 - generationVersion: 2.108.3 + speakeasyVersion: 1.87.0 + generationVersion: 2.116.0 generation: sdkClassName: CodatBankFeeds singleTagPerOp: false telemetryEnabled: true features: python: - core: 2.85.4 + core: 2.85.5 deprecations: 2.81.1 examples: 2.81.2 globalSecurity: 2.81.1 @@ -18,7 +18,7 @@ features: nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 3.0.0 + version: 3.1.0 author: Codat description: Set up bank feeds from accounts in your application to supported accounting platforms. maxMethodParams: 0 diff --git a/bank-feeds/setup.py b/bank-feeds/setup.py index e734b3f66..3ac2d5d1d 100755 --- a/bank-feeds/setup.py +++ b/bank-feeds/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="codat-bankfeeds", - version="2.0.0", + version="3.1.0", author="Codat", description="Set up bank feeds from accounts in your application to supported accounting platforms.", long_description=long_description, diff --git a/bank-feeds/src/codatbankfeeds/models/shared/__init__.py b/bank-feeds/src/codatbankfeeds/models/shared/__init__.py index c4caa38ab..5617fadf4 100755 --- a/bank-feeds/src/codatbankfeeds/models/shared/__init__.py +++ b/bank-feeds/src/codatbankfeeds/models/shared/__init__.py @@ -3,6 +3,10 @@ from .bankaccountcredentials import * from .bankfeedaccountmappingresponse import * from .bankfeedmapping import * +from .clientratelimitreachedwebhook import * +from .clientratelimitreachedwebhookdata import * +from .clientratelimitresetwebhook import * +from .clientratelimitresetwebhookdata import * from .companies import * from .company import * from .companyrequestbody import * @@ -29,4 +33,4 @@ from .validation import * from .validationitem import * -__all__ = ["BankAccountCredentials","BankFeedAccountMappingResponse","BankFeedMapping","Companies","Company","CompanyRequestBody","Connection","ConnectionSourceType","Connections","CreateBankTransaction","CreateBankTransactions","CreateBankTransactionsResponse","DataConnectionError","DataConnectionStatus","DataType","ErrorMessage","HalRef","Links","PushChangeType","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","Security","SourceAccount","TargetAccountOption","Validation","ValidationItem"] +__all__ = ["BankAccountCredentials","BankFeedAccountMappingResponse","BankFeedMapping","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyRequestBody","Connection","ConnectionSourceType","Connections","CreateBankTransaction","CreateBankTransactions","CreateBankTransactionsResponse","DataConnectionError","DataConnectionStatus","DataType","ErrorMessage","HalRef","Links","PushChangeType","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperations","Security","SourceAccount","TargetAccountOption","Validation","ValidationItem"] diff --git a/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhook.py b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhook.py new file mode 100755 index 000000000..f3a1bd150 --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhook.py @@ -0,0 +1,30 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import clientratelimitreachedwebhookdata as shared_clientratelimitreachedwebhookdata +from codatbankfeeds import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitReachedWebhook: + r"""Webhook request body for a client that has reached their rate limit.""" + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" + data: Optional[shared_clientratelimitreachedwebhookdata.ClientRateLimitReachedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) + r"""A human readable message about the webhook.""" + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the rule.""" + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) + r"""The type of rule.""" + + diff --git a/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhookdata.py b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhookdata.py new file mode 100755 index 000000000..2bc2762c3 --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitreachedwebhookdata.py @@ -0,0 +1,38 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatbankfeeds import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitReachedWebhookData: + daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) + r"""The number of available requests per day.""" + expires_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ExpiresUtc'), 'exclude': lambda f: f is None }}) + r"""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. + """ + + diff --git a/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhook.py b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhook.py new file mode 100755 index 000000000..46da9741e --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhook.py @@ -0,0 +1,30 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import clientratelimitresetwebhookdata as shared_clientratelimitresetwebhookdata +from codatbankfeeds import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitResetWebhook: + r"""Webhook request body for a client that has had their rate limit reset.""" + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" + data: Optional[shared_clientratelimitresetwebhookdata.ClientRateLimitResetWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) + r"""A human readable message about the webhook.""" + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the rule.""" + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) + r"""The type of rule.""" + + diff --git a/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhookdata.py b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhookdata.py new file mode 100755 index 000000000..ed838e147 --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/shared/clientratelimitresetwebhookdata.py @@ -0,0 +1,42 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatbankfeeds import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitResetWebhookData: + daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) + r"""The number of available requests per day.""" + expires_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ExpiresUtc'), 'exclude': lambda f: f is None }}) + r"""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. + """ + quota_remaining: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('QuotaRemaining'), 'exclude': lambda f: f is None }}) + r"""Total number of request remaining for your client.""" + reset_reason: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ResetReason'), 'exclude': lambda f: f is None }}) + r"""The reason for your rate limit quota being reset.""" + + diff --git a/bank-feeds/src/codatbankfeeds/models/shared/createbanktransactionsresponse.py b/bank-feeds/src/codatbankfeeds/models/shared/createbanktransactionsresponse.py index 4a5274f8c..2dd589b7e 100755 --- a/bank-feeds/src/codatbankfeeds/models/shared/createbanktransactionsresponse.py +++ b/bank-feeds/src/codatbankfeeds/models/shared/createbanktransactionsresponse.py @@ -44,7 +44,7 @@ class CreateBankTransactionsResponse: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" diff --git a/bank-feeds/src/codatbankfeeds/models/shared/pushoperation.py b/bank-feeds/src/codatbankfeeds/models/shared/pushoperation.py index fa9c1e1c5..bf8e94f36 100755 --- a/bank-feeds/src/codatbankfeeds/models/shared/pushoperation.py +++ b/bank-feeds/src/codatbankfeeds/models/shared/pushoperation.py @@ -43,7 +43,7 @@ class PushOperation: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" diff --git a/bank-feeds/src/codatbankfeeds/models/shared/pushoperationstatus.py b/bank-feeds/src/codatbankfeeds/models/shared/pushoperationstatus.py index fc391b0a2..5b3fabf24 100755 --- a/bank-feeds/src/codatbankfeeds/models/shared/pushoperationstatus.py +++ b/bank-feeds/src/codatbankfeeds/models/shared/pushoperationstatus.py @@ -4,7 +4,7 @@ from enum import Enum class PushOperationStatus(str, Enum): - r"""The status of the push operation.""" + r"""The current status of the push operation.""" PENDING = 'Pending' FAILED = 'Failed' SUCCESS = 'Success' diff --git a/bank-feeds/src/codatbankfeeds/models/webhooks/__init__.py b/bank-feeds/src/codatbankfeeds/models/webhooks/__init__.py new file mode 100755 index 000000000..5731c1dfd --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/webhooks/__init__.py @@ -0,0 +1,6 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .client_rate_limit_reached import * +from .client_rate_limit_reset import * + +__all__ = ["ClientRateLimitReachedResponse","ClientRateLimitResetResponse"] diff --git a/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reached.py b/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reached.py new file mode 100755 index 000000000..8ce5abf44 --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reached.py @@ -0,0 +1,16 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from typing import Optional + + + +@dataclasses.dataclass +class ClientRateLimitReachedResponse: + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + + diff --git a/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reset.py b/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reset.py new file mode 100755 index 000000000..df91ac429 --- /dev/null +++ b/bank-feeds/src/codatbankfeeds/models/webhooks/client_rate_limit_reset.py @@ -0,0 +1,16 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from typing import Optional + + + +@dataclasses.dataclass +class ClientRateLimitResetResponse: + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + + diff --git a/bank-feeds/src/codatbankfeeds/sdkconfiguration.py b/bank-feeds/src/codatbankfeeds/sdkconfiguration.py index 8085cf332..0235b21ef 100755 --- a/bank-feeds/src/codatbankfeeds/sdkconfiguration.py +++ b/bank-feeds/src/codatbankfeeds/sdkconfiguration.py @@ -20,8 +20,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '3.0.0' - sdk_version: str = '2.0.0' - gen_version: str = '2.108.3' + sdk_version: str = '3.1.0' + gen_version: str = '2.116.0' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: