Skip to content

Commit ff73429

Browse files
ci: regenerated with OpenAPI Doc 3.0.0, Speakeay CLI 1.87.0 (#84)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent 31bf1e3 commit ff73429

File tree

104 files changed

+1425
-1267
lines changed

Some content is hidden

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

104 files changed

+1425
-1267
lines changed

bank-feeds/CodatBankFeeds/AccountMapping.cs

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,47 @@ namespace CodatBankFeeds
1919
using System.Threading.Tasks;
2020
using System;
2121

22+
/// <summary>
23+
/// Bank feed bank account mapping.
24+
/// </summary>
2225
public interface IAccountMappingSDK
2326
{
27+
28+
/// <summary>
29+
/// Create bank feed account mapping
30+
///
31+
/// <remarks>
32+
/// The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting platform (target account).<br/>
33+
/// <br/>
34+
/// 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).<br/>
35+
/// <br/>
36+
/// To find valid target account options, first call list bank feed account mappings.<br/>
37+
/// <br/>
38+
/// This endpoint is only needed if building an account management UI.
39+
/// </remarks>
40+
/// </summary>
2441
Task<CreateBankAccountMappingResponse> CreateAsync(CreateBankAccountMappingRequest? request = null);
42+
43+
/// <summary>
44+
/// List bank feed account mappings
45+
///
46+
/// <remarks>
47+
/// The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts.<br/>
48+
/// <br/>
49+
/// 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).<br/>
50+
/// <br/>
51+
/// This endpoint is only needed if building an account management UI.
52+
/// </remarks>
53+
/// </summary>
2554
Task<GetBankAccountMappingResponse> GetAsync(GetBankAccountMappingRequest? request = null);
2655
}
2756

28-
/// <summary>
29-
/// Bank feed bank account mapping.
30-
/// </summary>
3157
public class AccountMappingSDK: IAccountMappingSDK
3258
{
3359
public SDKConfig Config { get; private set; }
3460
private const string _language = "csharp";
35-
private const string _sdkVersion = "0.8.0";
36-
private const string _sdkGenVersion = "2.113.0";
61+
private const string _sdkVersion = "1.1.0";
62+
private const string _sdkGenVersion = "2.116.0";
3763
private const string _openapiDocVersion = "3.0.0";
3864
private string _serverUrl = "";
3965
private ISpeakeasyHttpClient _defaultClient;
@@ -48,19 +74,6 @@ public AccountMappingSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClien
4874
}
4975

5076

51-
/// <summary>
52-
/// Create bank feed account mapping
53-
///
54-
/// <remarks>
55-
/// The *Create bank account mapping* endpoint creates a new mapping between a source bank account and a potential account in the accounting platform (target account).
56-
///
57-
/// 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).
58-
///
59-
/// To find valid target account options, first call list bank feed account mappings.
60-
///
61-
/// This endpoint is only needed if building an account management UI.
62-
/// </remarks>
63-
/// </summary>
6477
public async Task<CreateBankAccountMappingResponse> CreateAsync(CreateBankAccountMappingRequest? request = null)
6578
{
6679
string baseUrl = _serverUrl;
@@ -114,17 +127,6 @@ public async Task<CreateBankAccountMappingResponse> CreateAsync(CreateBankAccoun
114127
}
115128

116129

117-
/// <summary>
118-
/// List bank feed account mappings
119-
///
120-
/// <remarks>
121-
/// The *List bank account mappings* endpoint returns information about a source bank account and any current or potential target mapping accounts.
122-
///
123-
/// 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).
124-
///
125-
/// This endpoint is only needed if building an account management UI.
126-
/// </remarks>
127-
/// </summary>
128130
public async Task<GetBankAccountMappingResponse> GetAsync(GetBankAccountMappingRequest? request = null)
129131
{
130132
string baseUrl = _serverUrl;

bank-feeds/CodatBankFeeds/CodatBankFeeds.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
<PropertyGroup>
33
<IsPackable>true</IsPackable>
44
<PackageId>Codat.BankFeeds</PackageId>
5-
<Version>0.8.0</Version>
5+
<Version>1.1.0</Version>
66
<Authors>Codat</Authors>
77
<TargetFramework>net6.0</TargetFramework>
88
<Nullable>enable</Nullable>
99
<PackageReadmeFile>README.md</PackageReadmeFile>
10+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1011
</PropertyGroup>
1112

1213
<ItemGroup>

bank-feeds/CodatBankFeeds/CodatBankFeedsSDK.cs

Lines changed: 44 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -17,41 +17,61 @@ namespace CodatBankFeeds
1717
using System.Threading.Tasks;
1818
using System;
1919

20+
/// <summary>
21+
/// Bank Feeds API: Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.&lt;br/&gt;
22+
///
23+
/// <remarks>
24+
/// <br/>
25+
/// A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting package.<br/>
26+
/// <br/>
27+
/// <a href="https://docs.codat.io/bank-feeds-api/overview">Explore product</a> | <a href="https://github.com/codatio/oas">See OpenAPI spec</a><br/>
28+
/// <br/>
29+
/// ---<br/>
30+
/// <br/>
31+
/// ## Endpoints<br/>
32+
/// <br/>
33+
/// | Endpoints | Description |<br/>
34+
/// | :- | :- |<br/>
35+
/// | Companies | Create and manage your SMB users&apos; companies. |<br/>
36+
/// | Connections | Create new and manage existing data connections for a company. |<br/>
37+
/// | Source accounts | Provide and manage lists of source bank accounts. |<br/>
38+
/// | Transactions | Create new bank account transactions for a company&apos;s connections, and see previous operations. |<br/>
39+
/// | Account mapping | Extra functionality for building an account management UI |
40+
/// </remarks>
41+
/// </summary>
2042
public interface ICodatBankFeedsSDK
2143
{
44+
45+
/// <summary>
46+
/// Bank feed bank account mapping.
47+
/// </summary>
2248
public IAccountMappingSDK AccountMapping { get; }
49+
50+
/// <summary>
51+
/// Create and manage your Codat companies.
52+
/// </summary>
2353
public ICompaniesSDK Companies { get; }
54+
55+
/// <summary>
56+
/// Manage your companies&amp;apos; data connections.
57+
/// </summary>
2458
public IConnectionsSDK Connections { get; }
59+
60+
/// <summary>
61+
/// Source accounts act as a bridge to bank accounts in accounting software.
62+
/// </summary>
2563
public ISourceAccountsSDK SourceAccounts { get; }
64+
65+
/// <summary>
66+
/// Transactions represent debits and credits from a source account.
67+
/// </summary>
2668
public ITransactionsSDK Transactions { get; }
2769
}
2870

2971
public class SDKConfig
3072
{
3173
}
3274

33-
/// <summary>
34-
/// Bank Feeds API: Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.
35-
///
36-
/// <remarks>
37-
///
38-
/// A bank feed is a connection between a source bank account in your application and a target bank account in a supported accounting package.
39-
///
40-
/// [Explore product](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas)
41-
///
42-
/// ---
43-
///
44-
/// ## Endpoints
45-
///
46-
/// | Endpoints | Description |
47-
/// | :- | :- |
48-
/// | Companies | Create and manage your SMB users' companies. |
49-
/// | Connections | Create new and manage existing data connections for a company. |
50-
/// | Source accounts | Provide and manage lists of source bank accounts. |
51-
/// | Transactions | Create new bank account transactions for a company's connections, and see previous operations. |
52-
/// | Account mapping | Extra functionality for building an account management UI |
53-
/// </remarks>
54-
/// </summary>
5575
public class CodatBankFeedsSDK: ICodatBankFeedsSDK
5676
{
5777
public SDKConfig Config { get; private set; }
@@ -61,31 +81,16 @@ public class CodatBankFeedsSDK: ICodatBankFeedsSDK
6181
};
6282

6383
private const string _language = "csharp";
64-
private const string _sdkVersion = "0.8.0";
65-
private const string _sdkGenVersion = "2.113.0";
84+
private const string _sdkVersion = "1.1.0";
85+
private const string _sdkGenVersion = "2.116.0";
6686
private const string _openapiDocVersion = "3.0.0";
6787
private string _serverUrl = "";
6888
private ISpeakeasyHttpClient _defaultClient;
6989
private ISpeakeasyHttpClient _securityClient;
70-
/// <summary>
71-
/// Bank feed bank account mapping.
72-
/// </summary>
7390
public IAccountMappingSDK AccountMapping { get; private set; }
74-
/// <summary>
75-
/// Create and manage your Codat companies.
76-
/// </summary>
7791
public ICompaniesSDK Companies { get; private set; }
78-
/// <summary>
79-
/// Manage your companies' data connections.
80-
/// </summary>
8192
public IConnectionsSDK Connections { get; private set; }
82-
/// <summary>
83-
/// Source accounts act as a bridge to bank accounts in accounting software.
84-
/// </summary>
8593
public ISourceAccountsSDK SourceAccounts { get; private set; }
86-
/// <summary>
87-
/// Transactions represent debits and credits from a source account.
88-
/// </summary>
8994
public ITransactionsSDK Transactions { get; private set; }
9095

9196
public CodatBankFeedsSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null)

bank-feeds/CodatBankFeeds/Companies.cs

Lines changed: 50 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,69 @@ namespace CodatBankFeeds
1919
using System.Threading.Tasks;
2020
using System;
2121

22+
/// <summary>
23+
/// Create and manage your Codat companies.
24+
/// </summary>
2225
public interface ICompaniesSDK
2326
{
27+
28+
/// <summary>
29+
/// Create company
30+
///
31+
/// <remarks>
32+
/// Creates a new company that can be used to assign connections to. <br/>
33+
/// <br/>
34+
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.<br/>
35+
/// <br/>
36+
///
37+
/// </remarks>
38+
/// </summary>
2439
Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request = null);
40+
41+
/// <summary>
42+
/// Delete a company
43+
///
44+
/// <remarks>
45+
/// <br/>
46+
/// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
47+
/// </remarks>
48+
/// </summary>
2549
Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? request = null);
50+
51+
/// <summary>
52+
/// Get company
53+
///
54+
/// <remarks>
55+
/// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
56+
/// </remarks>
57+
/// </summary>
2658
Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null);
59+
60+
/// <summary>
61+
/// List companies
62+
///
63+
/// <remarks>
64+
/// Returns a list of your companies. The company schema contains a list of <a href="https://docs.codat.io/bank-feeds-api#/schemas/Connection">connections</a> related to the company.
65+
/// </remarks>
66+
/// </summary>
2767
Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request = null);
68+
69+
/// <summary>
70+
/// Update company
71+
///
72+
/// <remarks>
73+
/// Updates both the name and description of the company.
74+
/// </remarks>
75+
/// </summary>
2876
Task<UpdateCompanyResponse> UpdateAsync(UpdateCompanyRequest? request = null);
2977
}
3078

31-
/// <summary>
32-
/// Create and manage your Codat companies.
33-
/// </summary>
3479
public class CompaniesSDK: ICompaniesSDK
3580
{
3681
public SDKConfig Config { get; private set; }
3782
private const string _language = "csharp";
38-
private const string _sdkVersion = "0.8.0";
39-
private const string _sdkGenVersion = "2.113.0";
83+
private const string _sdkVersion = "1.1.0";
84+
private const string _sdkGenVersion = "2.116.0";
4085
private const string _openapiDocVersion = "3.0.0";
4186
private string _serverUrl = "";
4287
private ISpeakeasyHttpClient _defaultClient;
@@ -51,17 +96,6 @@ public CompaniesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient sec
5196
}
5297

5398

54-
/// <summary>
55-
/// Create company
56-
///
57-
/// <remarks>
58-
/// Creates a new company that can be used to assign connections to.
59-
///
60-
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
61-
///
62-
///
63-
/// </remarks>
64-
/// </summary>
6599
public async Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request = null)
66100
{
67101
string baseUrl = _serverUrl;
@@ -115,14 +149,6 @@ public async Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request
115149
}
116150

117151

118-
/// <summary>
119-
/// Delete a company
120-
///
121-
/// <remarks>
122-
///
123-
/// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
124-
/// </remarks>
125-
/// </summary>
126152
public async Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? request = null)
127153
{
128154
string baseUrl = _serverUrl;
@@ -167,13 +193,6 @@ public async Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? reque
167193
}
168194

169195

170-
/// <summary>
171-
/// Get company
172-
///
173-
/// <remarks>
174-
/// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
175-
/// </remarks>
176-
/// </summary>
177196
public async Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null)
178197
{
179198
string baseUrl = _serverUrl;
@@ -222,13 +241,6 @@ public async Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null
222241
}
223242

224243

225-
/// <summary>
226-
/// List companies
227-
///
228-
/// <remarks>
229-
/// Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) related to the company.
230-
/// </remarks>
231-
/// </summary>
232244
public async Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request = null)
233245
{
234246
string baseUrl = _serverUrl;
@@ -277,13 +289,6 @@ public async Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request
277289
}
278290

279291

280-
/// <summary>
281-
/// Update company
282-
///
283-
/// <remarks>
284-
/// Updates both the name and description of the company.
285-
/// </remarks>
286-
/// </summary>
287292
public async Task<UpdateCompanyResponse> UpdateAsync(UpdateCompanyRequest? request = null)
288293
{
289294
string baseUrl = _serverUrl;

0 commit comments

Comments
 (0)