Skip to content

Commit 663f6d0

Browse files
ci: regenerated with OpenAPI Doc 1.1, Speakeay CLI 1.87.0 (#86)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent af29bcc commit 663f6d0

File tree

117 files changed

+1122
-1256
lines changed

Some content is hidden

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

117 files changed

+1122
-1256
lines changed

sync-for-commerce/CodatSyncCommerce/AdvancedControls.cs

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,55 @@ namespace CodatSyncCommerce
1919
using System.Threading.Tasks;
2020
using System;
2121

22+
/// <summary>
23+
/// Advanced company management and sync preferences.
24+
/// </summary>
2225
public interface IAdvancedControlsSDK
2326
{
27+
28+
/// <summary>
29+
/// Create company
30+
///
31+
/// <remarks>
32+
/// Creates a Codat company..
33+
/// </remarks>
34+
/// </summary>
2435
Task<CreateCompanyResponse> CreateCompanyAsync(CreateCompany? request = null);
36+
37+
/// <summary>
38+
/// Get company configuration
39+
///
40+
/// <remarks>
41+
/// Returns a company&apos;s commerce sync configuration&apos;.
42+
/// </remarks>
43+
/// </summary>
2544
Task<GetConfigurationResponse> GetConfigurationAsync(GetConfigurationRequest? request = null);
45+
46+
/// <summary>
47+
/// List companies
48+
///
49+
/// <remarks>
50+
/// Returns a list of companies.
51+
/// </remarks>
52+
/// </summary>
2653
Task<ListCompaniesResponse> ListCompaniesAsync(ListCompaniesRequest? request = null);
54+
55+
/// <summary>
56+
/// Set configuration
57+
///
58+
/// <remarks>
59+
/// Sets a company&apos;s commerce sync configuration.
60+
/// </remarks>
61+
/// </summary>
2762
Task<SetConfigurationResponse> SetConfigurationAsync(SetConfigurationRequest? request = null);
2863
}
2964

30-
/// <summary>
31-
/// Advanced company management and sync preferences.
32-
/// </summary>
3365
public class AdvancedControlsSDK: IAdvancedControlsSDK
3466
{
3567
public SDKConfig Config { get; private set; }
3668
private const string _language = "csharp";
37-
private const string _sdkVersion = "0.6.0";
38-
private const string _sdkGenVersion = "2.113.0";
69+
private const string _sdkVersion = "1.1.0";
70+
private const string _sdkGenVersion = "2.116.0";
3971
private const string _openapiDocVersion = "1.1";
4072
private string _serverUrl = "";
4173
private ISpeakeasyHttpClient _defaultClient;
@@ -50,13 +82,6 @@ public AdvancedControlsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpCli
5082
}
5183

5284

53-
/// <summary>
54-
/// Create company
55-
///
56-
/// <remarks>
57-
/// Creates a Codat company..
58-
/// </remarks>
59-
/// </summary>
6085
public async Task<CreateCompanyResponse> CreateCompanyAsync(CreateCompany? request = null)
6186
{
6287
string baseUrl = _serverUrl;
@@ -101,13 +126,6 @@ public async Task<CreateCompanyResponse> CreateCompanyAsync(CreateCompany? reque
101126
}
102127

103128

104-
/// <summary>
105-
/// Get company configuration
106-
///
107-
/// <remarks>
108-
/// Returns a company's commerce sync configuration'.
109-
/// </remarks>
110-
/// </summary>
111129
public async Task<GetConfigurationResponse> GetConfigurationAsync(GetConfigurationRequest? request = null)
112130
{
113131
string baseUrl = _serverUrl;
@@ -147,13 +165,6 @@ public async Task<GetConfigurationResponse> GetConfigurationAsync(GetConfigurati
147165
}
148166

149167

150-
/// <summary>
151-
/// List companies
152-
///
153-
/// <remarks>
154-
/// Returns a list of companies.
155-
/// </remarks>
156-
/// </summary>
157168
public async Task<ListCompaniesResponse> ListCompaniesAsync(ListCompaniesRequest? request = null)
158169
{
159170
string baseUrl = _serverUrl;
@@ -193,13 +204,6 @@ public async Task<ListCompaniesResponse> ListCompaniesAsync(ListCompaniesRequest
193204
}
194205

195206

196-
/// <summary>
197-
/// Set configuration
198-
///
199-
/// <remarks>
200-
/// Sets a company's commerce sync configuration.
201-
/// </remarks>
202-
/// </summary>
203207
public async Task<SetConfigurationResponse> SetConfigurationAsync(SetConfigurationRequest? request = null)
204208
{
205209
string baseUrl = _serverUrl;

sync-for-commerce/CodatSyncCommerce/CodatSyncCommerce.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.Sync.Commerce</PackageId>
5-
<Version>0.6.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>

sync-for-commerce/CodatSyncCommerce/CodatSyncCommerceSDK.cs

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,51 @@ namespace CodatSyncCommerce
1717
using System.Threading.Tasks;
1818
using System;
1919

20+
/// <summary>
21+
/// Sync for Commerce: The API for Sync for Commerce. &lt;br/&gt;
22+
///
23+
/// <remarks>
24+
/// <br/>
25+
/// Sync for Commerce automatically replicates and reconciles sales data from a merchant’s source PoS, Payments, and eCommerce systems into their accounting software. This eliminates manual processing by merchants and transforms their ability to run and grow their business.<br/>
26+
/// <br/>
27+
/// <a href="https://docs.codat.io/commerce/overview">Read More...</a><br/>
28+
/// <br/>
29+
/// Not seeing the endpoints you&apos;re expecting? We&apos;ve <a href="https://docs.codat.io/updates/230901-new-products">reorganized our products</a>, and you may be using a <a href="https://docs.codat.io/sync-for-commerce-v1-api#/">different version of Sync for Commerce</a>.
30+
/// </remarks>
31+
/// </summary>
2032
public interface ICodatSyncCommerceSDK
2133
{
34+
35+
/// <summary>
36+
/// Advanced company management and sync preferences.
37+
/// </summary>
2238
public IAdvancedControlsSDK AdvancedControls { get; }
39+
40+
/// <summary>
41+
/// Create new and manage existing Sync for Commerce connections using the Sync flow UI.
42+
/// </summary>
2343
public IConnectionsSDK Connections { get; }
44+
45+
/// <summary>
46+
/// View useful information about codat&amp;apos;s integrations.
47+
/// </summary>
2448
public IIntegrationsSDK Integrations { get; }
49+
50+
/// <summary>
51+
/// Initiate and monitor the sync of company data into accounting software.
52+
/// </summary>
2553
public ISyncSDK Sync { get; }
54+
55+
/// <summary>
56+
/// Configure preferences for any given Sync for Commerce company using sync flow.
57+
/// </summary>
2658
public ISyncFlowSettingsSDK SyncFlowSettings { get; }
2759
}
2860

2961
public class SDKConfig
3062
{
3163
}
3264

33-
/// <summary>
34-
/// Sync for Commerce: The API for Sync for Commerce.
35-
///
36-
/// <remarks>
37-
///
38-
/// Sync for Commerce automatically replicates and reconciles sales data from a merchant’s source PoS, Payments, and eCommerce systems into their accounting software. This eliminates manual processing by merchants and transforms their ability to run and grow their business.
39-
///
40-
/// [Read More...](https://docs.codat.io/commerce/overview)
41-
///
42-
/// Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Commerce](https://docs.codat.io/sync-for-commerce-v1-api#/).
43-
/// </remarks>
44-
/// </summary>
4565
public class CodatSyncCommerceSDK: ICodatSyncCommerceSDK
4666
{
4767
public SDKConfig Config { get; private set; }
@@ -51,31 +71,16 @@ public class CodatSyncCommerceSDK: ICodatSyncCommerceSDK
5171
};
5272

5373
private const string _language = "csharp";
54-
private const string _sdkVersion = "0.6.0";
55-
private const string _sdkGenVersion = "2.113.0";
74+
private const string _sdkVersion = "1.1.0";
75+
private const string _sdkGenVersion = "2.116.0";
5676
private const string _openapiDocVersion = "1.1";
5777
private string _serverUrl = "";
5878
private ISpeakeasyHttpClient _defaultClient;
5979
private ISpeakeasyHttpClient _securityClient;
60-
/// <summary>
61-
/// Advanced company management and sync preferences.
62-
/// </summary>
6380
public IAdvancedControlsSDK AdvancedControls { get; private set; }
64-
/// <summary>
65-
/// Create new and manage existing Sync for Commerce connections using the Sync flow UI.
66-
/// </summary>
6781
public IConnectionsSDK Connections { get; private set; }
68-
/// <summary>
69-
/// View useful information about codat's integrations.
70-
/// </summary>
7182
public IIntegrationsSDK Integrations { get; private set; }
72-
/// <summary>
73-
/// Initiate and monitor the sync of company data into accounting software.
74-
/// </summary>
7583
public ISyncSDK Sync { get; private set; }
76-
/// <summary>
77-
/// Configure preferences for any given Sync for Commerce company using sync flow.
78-
/// </summary>
7984
public ISyncFlowSettingsSDK SyncFlowSettings { get; private set; }
8085

8186
public CodatSyncCommerceSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null)

sync-for-commerce/CodatSyncCommerce/Connections.cs

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,66 @@ namespace CodatSyncCommerce
1919
using System.Threading.Tasks;
2020
using System;
2121

22+
/// <summary>
23+
/// Create new and manage existing Sync for Commerce connections using the Sync flow UI.
24+
/// </summary>
2225
public interface IConnectionsSDK
2326
{
27+
28+
/// <summary>
29+
/// Create connection
30+
///
31+
/// <remarks>
32+
/// Creates a connection for the company by providing a valid `platformKey`. <br/>
33+
/// <br/>
34+
/// Use the <a href="https://docs.codat.io/sync-for-commerce-api#/operations/list-integrations">List Integrations</a> endpoint to access valid platform keys.
35+
/// </remarks>
36+
/// </summary>
2437
Task<CreateConnectionResponse> CreateAsync(CreateConnectionRequest? request = null);
38+
39+
/// <summary>
40+
/// Start new sync flow
41+
///
42+
/// <remarks>
43+
/// Create a new company and connections. Get a URL for Sync Flow, including a one time passcode.
44+
/// </remarks>
45+
/// </summary>
2546
Task<GetSyncFlowUrlResponse> GetSyncFlowUrlAsync(GetSyncFlowUrlRequest? request = null);
47+
48+
/// <summary>
49+
/// List connections
50+
///
51+
/// <remarks>
52+
/// List the connections for a company.
53+
/// </remarks>
54+
/// </summary>
2655
Task<ListConnectionsResponse> ListAsync(ListConnectionsRequest? request = null);
56+
57+
/// <summary>
58+
/// Update authorization
59+
///
60+
/// <remarks>
61+
/// Update data connection&apos;s authorization.
62+
/// </remarks>
63+
/// </summary>
2764
Task<UpdateConnectionAuthorizationResponse> UpdateAuthorizationAsync(UpdateConnectionAuthorizationRequest? request = null);
65+
66+
/// <summary>
67+
/// Update connection
68+
///
69+
/// <remarks>
70+
/// Update a data connection
71+
/// </remarks>
72+
/// </summary>
2873
Task<UpdateConnectionResponse> UpdateConnectionAsync(UpdateConnectionRequest? request = null);
2974
}
3075

31-
/// <summary>
32-
/// Create new and manage existing Sync for Commerce connections using the Sync flow UI.
33-
/// </summary>
3476
public class ConnectionsSDK: IConnectionsSDK
3577
{
3678
public SDKConfig Config { get; private set; }
3779
private const string _language = "csharp";
38-
private const string _sdkVersion = "0.6.0";
39-
private const string _sdkGenVersion = "2.113.0";
80+
private const string _sdkVersion = "1.1.0";
81+
private const string _sdkGenVersion = "2.116.0";
4082
private const string _openapiDocVersion = "1.1";
4183
private string _serverUrl = "";
4284
private ISpeakeasyHttpClient _defaultClient;
@@ -51,15 +93,6 @@ public ConnectionsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient s
5193
}
5294

5395

54-
/// <summary>
55-
/// Create connection
56-
///
57-
/// <remarks>
58-
/// Creates a connection for the company by providing a valid `platformKey`.
59-
///
60-
/// Use the [List Integrations](https://docs.codat.io/sync-for-commerce-api#/operations/list-integrations) endpoint to access valid platform keys.
61-
/// </remarks>
62-
/// </summary>
6396
public async Task<CreateConnectionResponse> CreateAsync(CreateConnectionRequest? request = null)
6497
{
6598
string baseUrl = _serverUrl;
@@ -113,13 +146,6 @@ public async Task<CreateConnectionResponse> CreateAsync(CreateConnectionRequest?
113146
}
114147

115148

116-
/// <summary>
117-
/// Start new sync flow
118-
///
119-
/// <remarks>
120-
/// Create a new company and connections. Get a URL for Sync Flow, including a one time passcode.
121-
/// </remarks>
122-
/// </summary>
123149
public async Task<GetSyncFlowUrlResponse> GetSyncFlowUrlAsync(GetSyncFlowUrlRequest? request = null)
124150
{
125151
string baseUrl = _serverUrl;
@@ -159,13 +185,6 @@ public async Task<GetSyncFlowUrlResponse> GetSyncFlowUrlAsync(GetSyncFlowUrlRequ
159185
}
160186

161187

162-
/// <summary>
163-
/// List connections
164-
///
165-
/// <remarks>
166-
/// List the connections for a company.
167-
/// </remarks>
168-
/// </summary>
169188
public async Task<ListConnectionsResponse> ListAsync(ListConnectionsRequest? request = null)
170189
{
171190
string baseUrl = _serverUrl;
@@ -214,13 +233,6 @@ public async Task<ListConnectionsResponse> ListAsync(ListConnectionsRequest? req
214233
}
215234

216235

217-
/// <summary>
218-
/// Update authorization
219-
///
220-
/// <remarks>
221-
/// Update data connection's authorization.
222-
/// </remarks>
223-
/// </summary>
224236
public async Task<UpdateConnectionAuthorizationResponse> UpdateAuthorizationAsync(UpdateConnectionAuthorizationRequest? request = null)
225237
{
226238
string baseUrl = _serverUrl;
@@ -265,13 +277,6 @@ public async Task<UpdateConnectionAuthorizationResponse> UpdateAuthorizationAsyn
265277
}
266278

267279

268-
/// <summary>
269-
/// Update connection
270-
///
271-
/// <remarks>
272-
/// Update a data connection
273-
/// </remarks>
274-
/// </summary>
275280
public async Task<UpdateConnectionResponse> UpdateConnectionAsync(UpdateConnectionRequest? request = null)
276281
{
277282
string baseUrl = _serverUrl;

0 commit comments

Comments
 (0)