Skip to content

Commit 31bf1e3

Browse files
github-actions[bot]speakeasybot
github-actions[bot]
and
speakeasybot
authored
ci: regenerated with OpenAPI Doc 3.0.0, Speakeay CLI 1.87.0 (#85)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent 663f6d0 commit 31bf1e3

File tree

194 files changed

+2257
-2139
lines changed

Some content is hidden

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

194 files changed

+2257
-2139
lines changed

‎platform/CodatPlatform/CodatPlatform.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.Platform</PackageId>
5-
<Version>0.5.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>

‎platform/CodatPlatform/CodatPlatformSDK.cs

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,67 @@ namespace CodatPlatform
1717
using System.Threading.Tasks;
1818
using System;
1919

20+
/// <summary>
21+
/// Platform API: Platform API
22+
///
23+
/// <remarks>
24+
/// An API for the common components of all of Codat&apos;s products.<br/>
25+
/// <br/>
26+
/// These end points cover creating and managing your companies, data connections, and integrations.<br/>
27+
/// <br/>
28+
/// <a href="https://docs.codat.io/core-concepts/companies">Read about the building blocks of Codat...</a><br/>
29+
/// <br/>
30+
/// <a href="https://github.com/codatio/oas">See our OpenAPI spec</a>
31+
/// </remarks>
32+
/// </summary>
2033
public interface ICodatPlatformSDK
2134
{
35+
36+
/// <summary>
37+
/// Create and manage your Codat companies.
38+
/// </summary>
2239
public ICompaniesSDK Companies { get; }
40+
41+
/// <summary>
42+
/// Manage your companies&amp;apos; data connections.
43+
/// </summary>
2344
public IConnectionsSDK Connections { get; }
45+
46+
/// <summary>
47+
/// View and manage your available integrations in Codat.
48+
/// </summary>
2449
public IIntegrationsSDK Integrations { get; }
50+
51+
/// <summary>
52+
/// View push options and get push statuses.
53+
/// </summary>
2554
public IPushDataSDK PushData { get; }
55+
56+
/// <summary>
57+
/// Asynchronously retrieve data from an integration to refresh data in Codat.
58+
/// </summary>
2659
public IRefreshDataSDK RefreshData { get; }
60+
61+
/// <summary>
62+
/// Manage your Codat instance.
63+
/// </summary>
2764
public ISettingsSDK Settings { get; }
65+
66+
/// <summary>
67+
/// View and configure supplemental data for supported data types.
68+
/// </summary>
2869
public ISupplementalDataSDK SupplementalData { get; }
70+
71+
/// <summary>
72+
/// Manage webhooks, rules, and events.
73+
/// </summary>
2974
public IWebhooksSDK Webhooks { get; }
3075
}
3176

3277
public class SDKConfig
3378
{
3479
}
3580

36-
/// <summary>
37-
/// Platform API: Platform API
38-
///
39-
/// <remarks>
40-
/// An API for the common components of all of Codat's products.
41-
///
42-
/// These end points cover creating and managing your companies, data connections, and integrations.
43-
///
44-
/// [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies)
45-
///
46-
/// [See our OpenAPI spec](https://github.com/codatio/oas)
47-
/// </remarks>
48-
/// </summary>
4981
public class CodatPlatformSDK: ICodatPlatformSDK
5082
{
5183
public SDKConfig Config { get; private set; }
@@ -55,43 +87,19 @@ public class CodatPlatformSDK: ICodatPlatformSDK
5587
};
5688

5789
private const string _language = "csharp";
58-
private const string _sdkVersion = "0.5.0";
59-
private const string _sdkGenVersion = "2.113.0";
90+
private const string _sdkVersion = "1.1.0";
91+
private const string _sdkGenVersion = "2.116.0";
6092
private const string _openapiDocVersion = "3.0.0";
6193
private string _serverUrl = "";
6294
private ISpeakeasyHttpClient _defaultClient;
6395
private ISpeakeasyHttpClient _securityClient;
64-
/// <summary>
65-
/// Create and manage your Codat companies.
66-
/// </summary>
6796
public ICompaniesSDK Companies { get; private set; }
68-
/// <summary>
69-
/// Manage your companies' data connections.
70-
/// </summary>
7197
public IConnectionsSDK Connections { get; private set; }
72-
/// <summary>
73-
/// View and manage your available integrations in Codat.
74-
/// </summary>
7598
public IIntegrationsSDK Integrations { get; private set; }
76-
/// <summary>
77-
/// View push options and get push statuses.
78-
/// </summary>
7999
public IPushDataSDK PushData { get; private set; }
80-
/// <summary>
81-
/// Asynchronously retrieve data from an integration to refresh data in Codat.
82-
/// </summary>
83100
public IRefreshDataSDK RefreshData { get; private set; }
84-
/// <summary>
85-
/// Manage your Codat instance.
86-
/// </summary>
87101
public ISettingsSDK Settings { get; private set; }
88-
/// <summary>
89-
/// View and configure supplemental data for supported data types.
90-
/// </summary>
91102
public ISupplementalDataSDK SupplementalData { get; private set; }
92-
/// <summary>
93-
/// Manage webhooks, rules, and events.
94-
/// </summary>
95103
public IWebhooksSDK Webhooks { get; private set; }
96104

97105
public CodatPlatformSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null)

‎platform/CodatPlatform/Companies.cs

Lines changed: 50 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,69 @@ namespace CodatPlatform
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/codat-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.5.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/codat-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)