Skip to content

Commit f9e7f35

Browse files
authored
Merge pull request #638 from codatio/speakeasy-sdk-regen-1732634522
chore: 🐝 Update SDK - Generate Bank Feeds library BANK-FEEDS-LIBRARY 7.0.0
2 parents 6d3b5f7 + c5674b9 commit f9e7f35

File tree

200 files changed

+4986
-386
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+4986
-386
lines changed

.speakeasy/workflow.lock

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@ speakeasyVersion: 1.446.1
22
sources:
33
bank-feeds-source:
44
sourceNamespace: bank-feeds-source
5-
sourceRevisionDigest: sha256:d75c52690ab81c6b279b7460cf7b63d0372d9aaea085e2e577846ad173258706
6-
sourceBlobDigest: sha256:a490b555d6f186cd37f72a06e06ba49293a0f371d145db2d9913d5081ecfc5a2
5+
sourceRevisionDigest: sha256:794384f882ec38027d43f5ef6794d221688d9a8bc8834315e5ecda8fdc920aef
6+
sourceBlobDigest: sha256:b5233f0bab180b8aae271a0d5ab149316931ec9e84a140e1c073a2025305eb7d
77
tags:
88
- latest
9-
- main
9+
- speakeasy-sdk-regen-1732634522
10+
- 3.0.0
1011
lending-source:
1112
sourceNamespace: lending-source
1213
sourceRevisionDigest: sha256:b3548be46af843e3792df7d5d24e0b1cbf514587a99c9f58d2ad68781f4568bd
@@ -61,8 +62,10 @@ targets:
6162
bank-feeds-library:
6263
source: bank-feeds-source
6364
sourceNamespace: bank-feeds-source
64-
sourceRevisionDigest: sha256:d75c52690ab81c6b279b7460cf7b63d0372d9aaea085e2e577846ad173258706
65-
sourceBlobDigest: sha256:a490b555d6f186cd37f72a06e06ba49293a0f371d145db2d9913d5081ecfc5a2
65+
sourceRevisionDigest: sha256:794384f882ec38027d43f5ef6794d221688d9a8bc8834315e5ecda8fdc920aef
66+
sourceBlobDigest: sha256:b5233f0bab180b8aae271a0d5ab149316931ec9e84a140e1c073a2025305eb7d
67+
codeSamplesNamespace: bank-feeds-source-code-samples
68+
codeSamplesRevisionDigest: sha256:292d7c6cf9313dbb735b86d693a9b86446fbc42ffe0c25c6b5ae82f888ee8205
6669
lending-library:
6770
source: lending-source
6871
sourceNamespace: lending-source

bank-feeds/.speakeasy/gen.lock

Lines changed: 110 additions & 36 deletions
Large diffs are not rendered by default.

bank-feeds/.speakeasy/gen.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ generation:
1414
oAuth2PasswordEnabled: false
1515
telemetryEnabled: true
1616
typescript:
17-
version: 6.0.0
17+
version: 7.0.0
1818
additionalDependencies:
1919
dependencies: {}
2020
devDependencies: {}
2121
peerDependencies: {}
2222
additionalPackageJSON: {}
2323
author: Codat
2424
clientServerStatusCodesAsErrors: true
25+
defaultErrorName: SDKError
2526
description: Set up bank feeds from accounts in your application to supported accounting platforms.
2627
enumFormat: union
2728
flattenGlobalSecurity: true

bank-feeds/README.md

Lines changed: 16 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ run();
131131
* [get](docs/sdks/companies/README.md#get) - Get company
132132
* [delete](docs/sdks/companies/README.md#delete) - Delete a company
133133
* [update](docs/sdks/companies/README.md#update) - Update company
134+
* [getAccessToken](docs/sdks/companies/README.md#getaccesstoken) - Get company access token
134135

135136
### [companyInformation](docs/sdks/companyinformation/README.md)
136137

@@ -151,7 +152,8 @@ run();
151152

152153
### [sourceAccounts](docs/sdks/sourceaccounts/README.md)
153154

154-
* [create](docs/sdks/sourceaccounts/README.md#create) - Create source account
155+
* [createBatch](docs/sdks/sourceaccounts/README.md#createbatch) - Create source accounts
156+
* [create](docs/sdks/sourceaccounts/README.md#create) - Create single source account
155157
* [list](docs/sdks/sourceaccounts/README.md#list) - List source accounts
156158
* [update](docs/sdks/sourceaccounts/README.md#update) - Update source account
157159
* [delete](docs/sdks/sourceaccounts/README.md#delete) - Delete source account
@@ -165,6 +167,7 @@ run();
165167
### [transactions](docs/sdks/transactions/README.md)
166168

167169
* [create](docs/sdks/transactions/README.md#create) - Create bank transactions
170+
* [getCreateModel](docs/sdks/transactions/README.md#getcreatemodel) - Get create bank transactions model
168171
* [getCreateOperation](docs/sdks/transactions/README.md#getcreateoperation) - Get create operation
169172
* [listCreateOperations](docs/sdks/transactions/README.md#listcreateoperations) - List create operations
170173

@@ -265,10 +268,10 @@ If a HTTP request fails, an operation my also throw an error from the `sdk/model
265268

266269
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `create` method may throw the following errors:
267270

268-
| Error Type | Status Code | Content Type |
269-
| --------------------------------- | --------------------------------- | --------------------------------- |
270-
| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json |
271-
| errors.SDKError | 4XX, 5XX | \*/\* |
271+
| Error Type | Status Code | Content Type |
272+
| ------------------- | --------------------------------- | ---------------- |
273+
| errors.ErrorMessage | 400, 401, 402, 403, 429, 500, 503 | application/json |
274+
| errors.SDKError | 4XX, 5XX | \*/\* |
272275

273276
```typescript
274277
import { CodatBankFeeds } from "@codat/bank-feeds";
@@ -324,41 +327,9 @@ Validation errors can also occur when either method arguments or data returned f
324327
<!-- Start Server Selection [server] -->
325328
## Server Selection
326329

327-
### Select Server by Index
328-
329-
You can override the default server globally by passing a server index to the `serverIdx` 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:
330-
331-
| # | Server | Variables |
332-
| - | ------ | --------- |
333-
| 0 | `https://api.codat.io` | None |
334-
335-
```typescript
336-
import { CodatBankFeeds } from "@codat/bank-feeds";
337-
338-
const codatBankFeeds = new CodatBankFeeds({
339-
serverIdx: 0,
340-
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
341-
});
342-
343-
async function run() {
344-
const result = await codatBankFeeds.companies.create({
345-
name: "Technicalium",
346-
description: "Requested early access to the new financing scheme.",
347-
});
348-
349-
// Handle the result
350-
console.log(result);
351-
}
352-
353-
run();
354-
355-
```
356-
357-
358330
### Override Server URL Per-Client
359331

360-
The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
361-
332+
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
362333
```typescript
363334
import { CodatBankFeeds } from "@codat/bank-feeds";
364335

@@ -442,9 +413,9 @@ const sdk = new CodatBankFeeds({ httpClient });
442413

443414
This SDK supports the following security scheme globally:
444415

445-
| Name | Type | Scheme |
446-
| ------------ | ------------ | ------------ |
447-
| `authHeader` | apiKey | API key |
416+
| Name | Type | Scheme |
417+
| ------------ | ------ | ------- |
418+
| `authHeader` | apiKey | API key |
448419

449420
To authenticate with the API the `authHeader` parameter must be set when initializing the SDK client instance. For example:
450421
```typescript
@@ -498,6 +469,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
498469
- [`companiesCreate`](docs/sdks/companies/README.md#create) - Create company
499470
- [`companiesDelete`](docs/sdks/companies/README.md#delete) - Delete a company
500471
- [`companiesGet`](docs/sdks/companies/README.md#get) - Get company
472+
- [`companiesGetAccessToken`](docs/sdks/companies/README.md#getaccesstoken) - Get company access token
501473
- [`companiesList`](docs/sdks/companies/README.md#list) - List companies
502474
- [`companiesUpdate`](docs/sdks/companies/README.md#update) - Update company
503475
- [`companyInformationGet`](docs/sdks/companyinformation/README.md#get) - Get company information
@@ -508,14 +480,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
508480
- [`connectionsGet`](docs/sdks/connections/README.md#get) - Get connection
509481
- [`connectionsList`](docs/sdks/connections/README.md#list) - List connections
510482
- [`connectionsUnlink`](docs/sdks/connections/README.md#unlink) - Unlink connection
511-
- [`sourceAccountsCreate`](docs/sdks/sourceaccounts/README.md#create) - Create source account
483+
- [`sourceAccountsCreate`](docs/sdks/sourceaccounts/README.md#create) - Create single source account
484+
- [`sourceAccountsCreateBatch`](docs/sdks/sourceaccounts/README.md#createbatch) - Create source accounts
512485
- [`sourceAccountsDelete`](docs/sdks/sourceaccounts/README.md#delete) - Delete source account
513486
- [`sourceAccountsDeleteCredentials`](docs/sdks/sourceaccounts/README.md#deletecredentials) - Delete all source account credentials
514487
- [`sourceAccountsGenerateCredentials`](docs/sdks/sourceaccounts/README.md#generatecredentials) - Generate source account credentials
515488
- [`sourceAccountsList`](docs/sdks/sourceaccounts/README.md#list) - List source accounts
516489
- [`sourceAccountsUpdate`](docs/sdks/sourceaccounts/README.md#update) - Update source account
517490
- [`syncGetLastSuccessfulSync`](docs/sdks/sync/README.md#getlastsuccessfulsync) - Get last successful sync
518491
- [`transactionsCreate`](docs/sdks/transactions/README.md#create) - Create bank transactions
492+
- [`transactionsGetCreateModel`](docs/sdks/transactions/README.md#getcreatemodel) - Get create bank transactions model
519493
- [`transactionsGetCreateOperation`](docs/sdks/transactions/README.md#getcreateoperation) - Get create operation
520494
- [`transactionsListCreateOperations`](docs/sdks/transactions/README.md#listcreateoperations) - List create operations
521495

bank-feeds/RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -746,4 +746,14 @@ Based on:
746746
### Generated
747747
- [typescript v6.0.0] bank-feeds
748748
### Releases
749-
- [NPM v6.0.0] https://www.npmjs.com/package/@codat/bank-feeds/v/6.0.0 - bank-feeds
749+
- [NPM v6.0.0] https://www.npmjs.com/package/@codat/bank-feeds/v/6.0.0 - bank-feeds
750+
751+
## 2024-11-26 15:21:52
752+
### Changes
753+
Based on:
754+
- OpenAPI Doc
755+
- Speakeasy CLI 1.446.1 (2.462.1) https://github.com/speakeasy-api/speakeasy
756+
### Generated
757+
- [typescript v7.0.0] bank-feeds
758+
### Releases
759+
- [NPM v7.0.0] https://www.npmjs.com/package/@codat/bank-feeds/v/7.0.0 - bank-feeds

bank-feeds/docs/sdk/models/operations/createbankaccountrequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ let value: CreateBankAccountRequest = {
99
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
1010
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
1111
bankAccountPrototype: {
12-
currency: "EUR",
12+
currency: "GBP",
1313
status: "Active",
1414
},
1515
};

bank-feeds/docs/sdk/models/operations/createbanktransactionsrequest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import { Decimal } from "@codat/bank-feeds/sdk/types";
99
let value: CreateBankTransactionsRequest = {
1010
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
1111
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
12-
accountId: "9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2",
12+
accountId: "EILBDVJVNUAGVKRQ",
1313
createBankTransactions: {
14-
accountId: "Checking 0202",
14+
accountId: "EILBDVJVNUAGVKRQ",
1515
transactions: [
1616
{
1717
id: "716422529",
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# CreateBatchSourceAccountRequest
2+
3+
## Example Usage
4+
5+
```typescript
6+
import { CreateBatchSourceAccountRequest } from "@codat/bank-feeds/sdk/models/operations";
7+
import { Decimal } from "@codat/bank-feeds/sdk/types";
8+
9+
let value: CreateBatchSourceAccountRequest = {
10+
companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
11+
connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
12+
requestBody: [
13+
{
14+
id: "acc-001",
15+
accountName: "account-081",
16+
accountType: "checking",
17+
accountNumber: "12345670",
18+
routingInfo: {
19+
bankCode: "21001088",
20+
type: "bankcode",
21+
},
22+
currency: "GBP",
23+
balance: new Decimal("99.99"),
24+
accountInfo: {
25+
description: "account description 1",
26+
nickname: "account 123",
27+
accountOpenDate: "2023-05-06T00:00:00Z",
28+
availableBalance: new Decimal("10"),
29+
},
30+
modifiedDate: "2024-08-02T00:00:00.000Z",
31+
status: "pending",
32+
feedStartDate: "2024-05-01T00:00:00Z",
33+
},
34+
{
35+
id: "acc-002",
36+
accountName: "account-083",
37+
accountType: "savings",
38+
accountNumber: "23456789",
39+
routingInfo: {
40+
bankCode: "21001088",
41+
type: "bankcode",
42+
},
43+
currency: "GBP",
44+
balance: new Decimal("400"),
45+
accountInfo: {
46+
description: "account description 2",
47+
nickname: "account 1290",
48+
accountOpenDate: "2023-05-23T00:00:00Z",
49+
availableBalance: new Decimal("400"),
50+
},
51+
modifiedDate: "2024-08-02T00:00:00.000Z",
52+
status: "pending",
53+
feedStartDate: "2024-05-01T00:00:00Z",
54+
},
55+
],
56+
};
57+
```
58+
59+
## Fields
60+
61+
| Field | Type | Required | Description | Example |
62+
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
63+
| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
64+
| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 |
65+
| `requestBody` | *operations.CreateBatchSourceAccountRequestBody* | :heavy_minus_sign: | N/A | |
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# CreateBatchSourceAccountRequestBody
2+
3+
4+
## Supported Types
5+
6+
### `shared.SourceAccountV2[]`
7+
8+
```typescript
9+
const value: shared.SourceAccountV2[] = [
10+
{
11+
id: "acc-001",
12+
accountName: "account-081",
13+
accountType: "checking",
14+
accountNumber: "12345670",
15+
routingInfo: {
16+
bankCode: "21001088",
17+
type: "bankcode",
18+
},
19+
currency: "GBP",
20+
balance: new Decimal("99.99"),
21+
accountInfo: {
22+
description: "account description 1",
23+
nickname: "account 123",
24+
accountOpenDate: "2023-05-06T00:00:00Z",
25+
availableBalance: new Decimal("10"),
26+
},
27+
modifiedDate: "2024-08-02T00:00:00.000Z",
28+
status: "pending",
29+
feedStartDate: "2024-05-01T00:00:00Z",
30+
},
31+
{
32+
id: "acc-002",
33+
accountName: "account-083",
34+
accountType: "savings",
35+
accountNumber: "23456789",
36+
routingInfo: {
37+
bankCode: "21001088",
38+
type: "bankcode",
39+
},
40+
currency: "GBP",
41+
balance: new Decimal("400"),
42+
accountInfo: {
43+
description: "account description 2",
44+
nickname: "account 1290",
45+
accountOpenDate: "2023-05-23T00:00:00Z",
46+
availableBalance: new Decimal("400"),
47+
},
48+
modifiedDate: "2024-08-02T00:00:00.000Z",
49+
status: "pending",
50+
feedStartDate: "2024-05-01T00:00:00Z",
51+
},
52+
];
53+
```
54+
55+
### `shared.SourceAccount[]`
56+
57+
```typescript
58+
const value: shared.SourceAccount[] = [
59+
{
60+
id: "acc-002",
61+
accountName: "account-081",
62+
accountType: "Credit",
63+
accountNumber: "12345670",
64+
sortCode: "123456",
65+
currency: "GBP",
66+
balance: new Decimal("99.99"),
67+
modifiedDate: "2023-01-09T14:14:14.1057478Z",
68+
status: "pending",
69+
},
70+
{
71+
id: "acc-003",
72+
accountName: "account-095",
73+
accountType: "Credit",
74+
accountNumber: "12345671",
75+
sortCode: "123456",
76+
currency: "USD",
77+
balance: new Decimal("0"),
78+
modifiedDate: "2023-01-09T14:14:14.1057478Z",
79+
status: "pending",
80+
},
81+
];
82+
```
83+

0 commit comments

Comments
 (0)