Skip to content

Commit 159d099

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 (#90)
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
1 parent 2d5d224 commit 159d099

File tree

183 files changed

+2796
-2802
lines changed

Some content is hidden

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

183 files changed

+2796
-2802
lines changed

‎sync-for-payroll/CodatSyncPayroll/Accounts.cs

Lines changed: 66 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,84 @@ namespace CodatSyncPayroll
1919
using System.Threading.Tasks;
2020
using System;
2121

22+
/// <summary>
23+
/// Accounts
24+
/// </summary>
2225
public interface IAccountsSDK
2326
{
27+
28+
/// <summary>
29+
/// Create account
30+
///
31+
/// <remarks>
32+
/// The *Create account* endpoint creates a new <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">account</a> for a given company&apos;s connection.<br/>
33+
/// <br/>
34+
/// <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">Accounts</a> are the categories a business uses to record accounting transactions.<br/>
35+
/// <br/>
36+
/// **Integration-specific behaviour**<br/>
37+
/// <br/>
38+
/// Required data may vary by integration. To see what data to post, first call <a href="https://docs.codat.io/sync-for-payroll-api#/operations/get-create-chartOfAccounts-model">Get create account model</a>.<br/>
39+
/// <br/>
40+
/// Check out our <a href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&amp;dataType=chartOfAccounts">coverage explorer</a> for integrations that support creating an account.<br/>
41+
///
42+
/// </remarks>
43+
/// </summary>
2444
Task<Models.Operations.CreateAccountResponse> CreateAsync(CreateAccountRequest? request = null);
45+
46+
/// <summary>
47+
/// Get account
48+
///
49+
/// <remarks>
50+
/// The *Get account* endpoint returns a single account for a given `accountId`.<br/>
51+
/// <br/>
52+
/// <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">Accounts</a> are the categories a business uses to record accounting transactions.<br/>
53+
/// <br/>
54+
/// Check out our <a href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&amp;dataType=chartOfAccounts">coverage explorer</a> for integrations that support getting a specific account.<br/>
55+
/// <br/>
56+
/// Before using this endpoint, you must have <a href="https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data">retrieved data for the company</a>.<br/>
57+
///
58+
/// </remarks>
59+
/// </summary>
2560
Task<GetAccountResponse> GetAsync(GetAccountRequest? request = null);
61+
62+
/// <summary>
63+
/// Get create account model
64+
///
65+
/// <remarks>
66+
/// The *Get create account model* endpoint returns the expected data for the request payload when creating an <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">account</a> for a given company and integration.<br/>
67+
/// <br/>
68+
/// <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">Accounts</a> are the categories a business uses to record accounting transactions.<br/>
69+
/// <br/>
70+
/// **Integration-specific behaviour**<br/>
71+
/// <br/>
72+
/// See the *response examples* for integration-specific indicative models.<br/>
73+
/// <br/>
74+
/// Check out our <a href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&amp;dataType=chartOfAccounts">coverage explorer</a> for integrations that support creating an account.<br/>
75+
///
76+
/// </remarks>
77+
/// </summary>
2678
Task<GetCreateAccountsModelResponse> GetCreateModelAsync(GetCreateAccountsModelRequest? request = null);
79+
80+
/// <summary>
81+
/// List accounts
82+
///
83+
/// <remarks>
84+
/// The *List accounts* endpoint returns a list of <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">accounts</a> for a given company&apos;s connection.<br/>
85+
/// <br/>
86+
/// <a href="https://docs.codat.io/sync-for-payroll-api#/schemas/Account">Accounts</a> are the categories a business uses to record accounting transactions.<br/>
87+
/// <br/>
88+
/// Before using this endpoint, you must have <a href="https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data">retrieved data for the company</a>.
89+
/// </remarks>
90+
/// </summary>
2791
Task<ListAccountsResponse> ListAsync(ListAccountsRequest? request = null);
2892
}
2993

30-
/// <summary>
31-
/// Accounts
32-
/// </summary>
3394
public class AccountsSDK: IAccountsSDK
3495
{
3596
public SDKConfig Config { get; private set; }
3697
private const string _language = "csharp";
37-
private const string _sdkVersion = "0.4.0";
38-
private const string _sdkGenVersion = "2.113.0";
98+
private const string _sdkVersion = "1.1.0";
99+
private const string _sdkGenVersion = "2.116.0";
39100
private const string _openapiDocVersion = "3.0.0";
40101
private string _serverUrl = "";
41102
private ISpeakeasyHttpClient _defaultClient;
@@ -50,22 +111,6 @@ public AccountsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu
50111
}
51112

52113

53-
/// <summary>
54-
/// Create account
55-
///
56-
/// <remarks>
57-
/// The *Create account* endpoint creates a new [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection.
58-
///
59-
/// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.
60-
///
61-
/// **Integration-specific behaviour**
62-
///
63-
/// Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/sync-for-payroll-api#/operations/get-create-chartOfAccounts-model).
64-
///
65-
/// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.
66-
///
67-
/// </remarks>
68-
/// </summary>
69114
public async Task<Models.Operations.CreateAccountResponse> CreateAsync(CreateAccountRequest? request = null)
70115
{
71116
string baseUrl = _serverUrl;
@@ -119,20 +164,6 @@ public AccountsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu
119164
}
120165

121166

122-
/// <summary>
123-
/// Get account
124-
///
125-
/// <remarks>
126-
/// The *Get account* endpoint returns a single account for a given `accountId`.
127-
///
128-
/// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.
129-
///
130-
/// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support getting a specific account.
131-
///
132-
/// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).
133-
///
134-
/// </remarks>
135-
/// </summary>
136167
public async Task<GetAccountResponse> GetAsync(GetAccountRequest? request = null)
137168
{
138169
string baseUrl = _serverUrl;
@@ -181,22 +212,6 @@ public async Task<GetAccountResponse> GetAsync(GetAccountRequest? request = null
181212
}
182213

183214

184-
/// <summary>
185-
/// Get create account model
186-
///
187-
/// <remarks>
188-
/// The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company and integration.
189-
///
190-
/// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.
191-
///
192-
/// **Integration-specific behaviour**
193-
///
194-
/// See the *response examples* for integration-specific indicative models.
195-
///
196-
/// Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts) for integrations that support creating an account.
197-
///
198-
/// </remarks>
199-
/// </summary>
200215
public async Task<GetCreateAccountsModelResponse> GetCreateModelAsync(GetCreateAccountsModelRequest? request = null)
201216
{
202217
string baseUrl = _serverUrl;
@@ -245,17 +260,6 @@ public async Task<GetCreateAccountsModelResponse> GetCreateModelAsync(GetCreateA
245260
}
246261

247262

248-
/// <summary>
249-
/// List accounts
250-
///
251-
/// <remarks>
252-
/// The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) for a given company's connection.
253-
///
254-
/// [Accounts](https://docs.codat.io/sync-for-payroll-api#/schemas/Account) are the categories a business uses to record accounting transactions.
255-
///
256-
/// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/sync-for-payroll-api#/operations/refresh-company-data).
257-
/// </remarks>
258-
/// </summary>
259263
public async Task<ListAccountsResponse> ListAsync(ListAccountsRequest? request = null)
260264
{
261265
string baseUrl = _serverUrl;

‎sync-for-payroll/CodatSyncPayroll/CodatSyncPayroll.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.Payroll</PackageId>
5-
<Version>0.4.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-payroll/CodatSyncPayroll/CodatSyncPayrollSDK.cs

Lines changed: 59 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,79 @@ namespace CodatSyncPayroll
1717
using System.Threading.Tasks;
1818
using System;
1919

20+
/// <summary>
21+
/// Sync for Payroll: The API for Sync for Payroll. &lt;br/&gt;
22+
///
23+
/// <remarks>
24+
/// <br/>
25+
/// Sync for Payroll is an API and a set of supporting tools built to help integrate your customers&apos; payroll data from their HR and payroll platforms into their accounting platforms and to support its reconciliation.<br/>
26+
/// <br/>
27+
/// <a href="https://docs.codat.io/payroll/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+
/// | Accounts | Get, create, and update Accounts. |<br/>
38+
/// | Journal entries | Get, create, and update Journal entries. |<br/>
39+
/// | Journals | Get, create, and update Journals. |<br/>
40+
/// | Tracking categories | Get, create, and update Tracking Categories for additional categorization of payroll components. |<br/>
41+
/// | Company info | View company profile from the source platform. |<br/>
42+
/// | Manage data | Control how data is retrieved from an integration. |
43+
/// </remarks>
44+
/// </summary>
2045
public interface ICodatSyncPayrollSDK
2146
{
47+
48+
/// <summary>
49+
/// Accounts
50+
/// </summary>
2251
public IAccountsSDK Accounts { get; }
52+
53+
/// <summary>
54+
/// Create and manage your Codat companies.
55+
/// </summary>
2356
public ICompaniesSDK Companies { get; }
57+
58+
/// <summary>
59+
/// View company information fetched from the source platform.
60+
/// </summary>
2461
public ICompanyInfoSDK CompanyInfo { get; }
62+
63+
/// <summary>
64+
/// Manage your companies&amp;apos; data connections.
65+
/// </summary>
2566
public IConnectionsSDK Connections { get; }
67+
68+
/// <summary>
69+
/// Journal entries
70+
/// </summary>
2671
public IJournalEntriesSDK JournalEntries { get; }
72+
73+
/// <summary>
74+
/// Journals
75+
/// </summary>
2776
public IJournalsSDK Journals { get; }
77+
78+
/// <summary>
79+
/// Asynchronously retrieve data from an integration to refresh data in Codat.
80+
/// </summary>
2881
public IManageDataSDK ManageData { get; }
82+
83+
/// <summary>
84+
/// Tracking categories
85+
/// </summary>
2986
public ITrackingCategoriesSDK TrackingCategories { get; }
3087
}
3188

3289
public class SDKConfig
3390
{
3491
}
3592

36-
/// <summary>
37-
/// Sync for Payroll: The API for Sync for Payroll.
38-
///
39-
/// <remarks>
40-
///
41-
/// Sync for Payroll is an API and a set of supporting tools built to help integrate your customers' payroll data from their HR and payroll platforms into their accounting platforms and to support its reconciliation.
42-
///
43-
/// [Explore product](https://docs.codat.io/payroll/overview) | [See OpenAPI spec](https://github.com/codatio/oas)
44-
///
45-
/// ---
46-
///
47-
/// ## Endpoints
48-
///
49-
/// | Endpoints | Description |
50-
/// |:---------------------|:-----------------------------------------------------------------------------------------------------------|
51-
/// | Companies | Create and manage your SMB users' companies. |
52-
/// | Connections | Create new and manage existing data connections for a company. |
53-
/// | Accounts | Get, create, and update Accounts. |
54-
/// | Journal entries | Get, create, and update Journal entries. |
55-
/// | Journals | Get, create, and update Journals. |
56-
/// | Tracking categories | Get, create, and update Tracking Categories for additional categorization of payroll components. |
57-
/// | Company info | View company profile from the source platform. |
58-
/// | Manage data | Control how data is retrieved from an integration. |
59-
/// </remarks>
60-
/// </summary>
6193
public class CodatSyncPayrollSDK: ICodatSyncPayrollSDK
6294
{
6395
public SDKConfig Config { get; private set; }
@@ -67,43 +99,19 @@ public class CodatSyncPayrollSDK: ICodatSyncPayrollSDK
6799
};
68100

69101
private const string _language = "csharp";
70-
private const string _sdkVersion = "0.4.0";
71-
private const string _sdkGenVersion = "2.113.0";
102+
private const string _sdkVersion = "1.1.0";
103+
private const string _sdkGenVersion = "2.116.0";
72104
private const string _openapiDocVersion = "3.0.0";
73105
private string _serverUrl = "";
74106
private ISpeakeasyHttpClient _defaultClient;
75107
private ISpeakeasyHttpClient _securityClient;
76-
/// <summary>
77-
/// Accounts
78-
/// </summary>
79108
public IAccountsSDK Accounts { get; private set; }
80-
/// <summary>
81-
/// Create and manage your Codat companies.
82-
/// </summary>
83109
public ICompaniesSDK Companies { get; private set; }
84-
/// <summary>
85-
/// View company information fetched from the source platform.
86-
/// </summary>
87110
public ICompanyInfoSDK CompanyInfo { get; private set; }
88-
/// <summary>
89-
/// Manage your companies' data connections.
90-
/// </summary>
91111
public IConnectionsSDK Connections { get; private set; }
92-
/// <summary>
93-
/// Journal entries
94-
/// </summary>
95112
public IJournalEntriesSDK JournalEntries { get; private set; }
96-
/// <summary>
97-
/// Journals
98-
/// </summary>
99113
public IJournalsSDK Journals { get; private set; }
100-
/// <summary>
101-
/// Asynchronously retrieve data from an integration to refresh data in Codat.
102-
/// </summary>
103114
public IManageDataSDK ManageData { get; private set; }
104-
/// <summary>
105-
/// Tracking categories
106-
/// </summary>
107115
public ITrackingCategoriesSDK TrackingCategories { get; private set; }
108116

109117
public CodatSyncPayrollSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null)

0 commit comments

Comments
 (0)