Skip to content

Commit

Permalink
Merge pull request #502 from codatio/speakeasy-sdk-regen-1700565540
Browse files Browse the repository at this point in the history 
chore: 🐝 Update SDK - Generate Bank Feeds library
  • Loading branch information
@dcoplowe
dcoplowe authored Nov 21, 2023
2 parents df5c157 + b5e00c2 commit 546efd1
Show file tree
Hide file tree
Showing 169 changed files with 1,070 additions and 564 deletions.
Empty file modified bank-feeds/.gitattributes
100755 → 100644
View file
Empty file.
253 changes: 239 additions & 14 deletions bank-feeds/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,26 @@ pip install codat-bankfeeds

## Example Usage
<!-- Start SDK Example Usage -->
### Example

```python
import codatbankfeeds
from codatbankfeeds.models import operations, shared
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = operations.CreateBankAccountMappingRequest(
request_body=operations.CreateBankAccountMappingBankFeedAccountMapping(
feed_start_date='2022-10-23T00:00:00.000Z',
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.account_mapping.create(req)
res = s.companies.create(req)

if res.bank_feed_account_mapping_response is not None:
if res.company is not None:
# handle response
pass
```
Expand All @@ -44,11 +43,6 @@ if res.bank_feed_account_mapping_response is not None:
## Available Resources and Operations


### [account_mapping](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)

* [create](docs/sdks/companies/README.md#create) - Create company
Expand All @@ -65,6 +59,11 @@ 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

### [account_mapping](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

### [source_accounts](docs/sdks/sourceaccounts/README.md)

* [create](docs/sdks/sourceaccounts/README.md#create) - Create source account
Expand All @@ -89,6 +88,232 @@ if res.bank_feed_account_mapping_response is not None:

<!-- End Dev Containers -->



<!-- Start Retries -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```python
import codatbankfeeds
from codatbankfeeds.models import shared
from codatbankfeeds.utils import BackoffStrategy, RetryConfig

s = codatbankfeeds.CodatBankFeeds(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.companies.create(req,
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))

if res.company is not None:
# handle response
pass
```

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```python
import codatbankfeeds
from codatbankfeeds.models import shared
from codatbankfeeds.utils import BackoffStrategy, RetryConfig

s = codatbankfeeds.CodatBankFeeds(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.companies.create(req)

if res.company is not None:
# handle response
pass
```
<!-- End Retries -->



<!-- Start Error Handling -->
## 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 raise the appropriate Error type.

| Error Object | Status Code | Content Type |
| --------------------------- | --------------------------- | --------------------------- |
| errors.ErrorMessage | 400,401,402,403,429,500,503 | application/json |
| errors.SDKError | 400-600 | */* |

### Example

```python
import codatbankfeeds
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = None
try:
res = s.companies.create(req)
except (errors.ErrorMessage) as e:
print(e) # handle exception

except (errors.SDKError) as e:
print(e) # handle exception


if res.company is not None:
# handle response
pass
```

<!-- End Error Handling -->



<!-- Start Server Selection -->
## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.codat.io` | None |

#### Example

```python
import codatbankfeeds
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.companies.create(req)

if res.company is not None:
# handle response
pass
```


### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import codatbankfeeds
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.companies.create(req)

if res.company is not None:
# handle response
pass
```
<!-- End Server Selection -->



<!-- Start Custom HTTP Client -->
## Custom HTTP Client

The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.

For example, you could specify a header for every request that this sdk makes as follows:
```python
import codatbankfeeds
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatbankfeeds.CodatBankFeeds(client: http_client)
```
<!-- End Custom HTTP Client -->



<!-- Start Authentication -->

## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `auth_header` | apiKey | API key |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```python
import codatbankfeeds
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.companies.create(req)

if res.company is not None:
# handle response
pass
```
<!-- End Authentication -->

<!-- Placeholder for Future Speakeasy SDK Sections -->


Expand Down
12 changes: 11 additions & 1 deletion bank-feeds/RELEASES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -728,4 +728,14 @@ Based on:
### Generated
- [python v4.0.0] bank-feeds
### Releases
- [PyPI v4.0.0] https://pypi.org/project/codat-bankfeeds/4.0.0 - bank-feeds
- [PyPI v4.0.0] https://pypi.org/project/codat-bankfeeds/4.0.0 - bank-feeds

## 2023-11-21 11:18:56
### Changes
Based on:
- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Bank-Feeds.yaml
- Speakeasy CLI 1.121.3 (2.195.2) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v5.0.0] bank-feeds
### Releases
- [PyPI v5.0.0] https://pypi.org/project/codat-bankfeeds/5.0.0 - bank-feeds
17 changes: 6 additions & 11 deletions bank-feeds/USAGE.md
100755 → 100644
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,22 @@
<!-- Start SDK Example Usage -->


```python
import codatbankfeeds
from codatbankfeeds.models import operations, shared
from codatbankfeeds.models import shared

s = codatbankfeeds.CodatBankFeeds(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)

req = operations.CreateBankAccountMappingRequest(
request_body=operations.CreateBankAccountMappingBankFeedAccountMapping(
feed_start_date='2022-10-23T00:00:00.000Z',
),
company_id='8a210b68-6988-11ed-a1eb-0242ac120002',
connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171',
req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)

res = s.account_mapping.create(req)
res = s.companies.create(req)

if res.bank_feed_account_mapping_response is not None:
if res.company is not None:
# handle response
pass
```
Expand Down
2 changes: 2 additions & 0 deletions ...-feeds/docs/models/shared/errormessage.md → ...-feeds/docs/models/errors/errormessage.md
100755 → 100644
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ErrorMessage

Your `query` parameter was not correctly formed


## Fields

Expand Down
10 changes: 5 additions & 5 deletions bank-feeds/docs/models/operations/createbankaccountmappingrequest.md
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `request_body` | [Optional[CreateBankAccountMappingBankFeedAccountMapping]](../../models/operations/createbankaccountmappingbankfeedaccountmapping.md) | :heavy_minus_sign: | N/A | |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
| Field | Type | Required | Description | Example |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `zero` | [Optional[shared.Zero]](../../models/shared/zero.md) | :heavy_minus_sign: | N/A | |
| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
3 changes: 1 addition & 2 deletions bank-feeds/docs/models/operations/createbankaccountmappingresponse.md
100755 → 100644
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `bank_feed_account_mapping_response` | [Optional[shared.BankFeedAccountMappingResponse]](../../models/shared/bankfeedaccountmappingresponse.md) | :heavy_minus_sign: | Success |
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
| `error_message` | [Optional[shared.ErrorMessage]](../../models/shared/errormessage.md) | :heavy_minus_sign: | The request made is not valid. |
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |
Empty file modified bank-feeds/docs/models/operations/createbanktransactionsrequest.md
100755 → 100644
View file
Empty file.
Loading

0 comments on commit 546efd1

Please sign in to comment.