diff --git a/platform/CodatPlatform/CodatPlatform.csproj b/platform/CodatPlatform/CodatPlatform.csproj index ea5ad994b..76ba719eb 100755 --- a/platform/CodatPlatform/CodatPlatform.csproj +++ b/platform/CodatPlatform/CodatPlatform.csproj @@ -2,11 +2,12 @@ true Codat.Platform - 0.5.0 + 1.1.0 Codat net6.0 enable README.md + true diff --git a/platform/CodatPlatform/CodatPlatformSDK.cs b/platform/CodatPlatform/CodatPlatformSDK.cs index 8e2e15bd1..1f842dad1 100755 --- a/platform/CodatPlatform/CodatPlatformSDK.cs +++ b/platform/CodatPlatform/CodatPlatformSDK.cs @@ -17,15 +17,60 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Platform API: Platform API + /// + /// + /// An API for the common components of all of Codat's products.
+ ///
+ /// These end points cover creating and managing your companies, data connections, and integrations.
+ ///
+ /// Read about the building blocks of Codat...
+ ///
+ /// See our OpenAPI spec + ///
+ ///
public interface ICodatPlatformSDK { + + /// + /// Create and manage your Codat companies. + /// public ICompaniesSDK Companies { get; } + + /// + /// Manage your companies' data connections. + /// public IConnectionsSDK Connections { get; } + + /// + /// View and manage your available integrations in Codat. + /// public IIntegrationsSDK Integrations { get; } + + /// + /// View push options and get push statuses. + /// public IPushDataSDK PushData { get; } + + /// + /// Asynchronously retrieve data from an integration to refresh data in Codat. + /// public IRefreshDataSDK RefreshData { get; } + + /// + /// Manage your Codat instance. + /// public ISettingsSDK Settings { get; } + + /// + /// View and configure supplemental data for supported data types. + /// public ISupplementalDataSDK SupplementalData { get; } + + /// + /// Manage webhooks, rules, and events. + /// public IWebhooksSDK Webhooks { get; } } @@ -33,19 +78,6 @@ public class SDKConfig { } - /// - /// Platform API: Platform API - /// - /// - /// An API for the common components of all of Codat's products. - /// - /// These end points cover creating and managing your companies, data connections, and integrations. - /// - /// [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) - /// - /// [See our OpenAPI spec](https://github.com/codatio/oas) - /// - /// public class CodatPlatformSDK: ICodatPlatformSDK { public SDKConfig Config { get; private set; } @@ -55,43 +87,19 @@ public class CodatPlatformSDK: ICodatPlatformSDK }; private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; private ISpeakeasyHttpClient _securityClient; - /// - /// Create and manage your Codat companies. - /// public ICompaniesSDK Companies { get; private set; } - /// - /// Manage your companies' data connections. - /// public IConnectionsSDK Connections { get; private set; } - /// - /// View and manage your available integrations in Codat. - /// public IIntegrationsSDK Integrations { get; private set; } - /// - /// View push options and get push statuses. - /// public IPushDataSDK PushData { get; private set; } - /// - /// Asynchronously retrieve data from an integration to refresh data in Codat. - /// public IRefreshDataSDK RefreshData { get; private set; } - /// - /// Manage your Codat instance. - /// public ISettingsSDK Settings { get; private set; } - /// - /// View and configure supplemental data for supported data types. - /// public ISupplementalDataSDK SupplementalData { get; private set; } - /// - /// Manage webhooks, rules, and events. - /// public IWebhooksSDK Webhooks { get; private set; } public CodatPlatformSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null) diff --git a/platform/CodatPlatform/Companies.cs b/platform/CodatPlatform/Companies.cs index b0fb815df..552e51c7b 100755 --- a/platform/CodatPlatform/Companies.cs +++ b/platform/CodatPlatform/Companies.cs @@ -19,24 +19,69 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Create and manage your Codat companies. + /// public interface ICompaniesSDK { + + /// + /// Create company + /// + /// + /// Creates a new company that can be used to assign connections to.
+ ///
+ /// 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`.
+ ///
+ /// + ///
+ ///
Task CreateAsync(CompanyRequestBody? request = null); + + /// + /// Delete a company + /// + /// + ///
+ /// 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. + ///
+ ///
Task DeleteAsync(DeleteCompanyRequest? request = null); + + /// + /// Get company + /// + /// + /// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. + /// + /// Task GetAsync(GetCompanyRequest? request = null); + + /// + /// List companies + /// + /// + /// Returns a list of your companies. The company schema contains a list of connections related to the company. + /// + /// Task ListAsync(ListCompaniesRequest? request = null); + + /// + /// Update company + /// + /// + /// Updates both the name and description of the company. + /// + /// Task UpdateAsync(UpdateCompanyRequest? request = null); } - /// - /// Create and manage your Codat companies. - /// public class CompaniesSDK: ICompaniesSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -51,17 +96,6 @@ public CompaniesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient sec } - /// - /// Create company - /// - /// - /// Creates a new company that can be used to assign connections to. - /// - /// 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`. - /// - /// - /// - /// public async Task CreateAsync(CompanyRequestBody? request = null) { string baseUrl = _serverUrl; @@ -115,14 +149,6 @@ public async Task CreateAsync(CompanyRequestBody? request } - /// - /// Delete a company - /// - /// - /// - /// 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. - /// - /// public async Task DeleteAsync(DeleteCompanyRequest? request = null) { string baseUrl = _serverUrl; @@ -167,13 +193,6 @@ public async Task DeleteAsync(DeleteCompanyRequest? reque } - /// - /// Get company - /// - /// - /// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned. - /// - /// public async Task GetAsync(GetCompanyRequest? request = null) { string baseUrl = _serverUrl; @@ -222,13 +241,6 @@ public async Task GetAsync(GetCompanyRequest? request = null } - /// - /// List companies - /// - /// - /// 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. - /// - /// public async Task ListAsync(ListCompaniesRequest? request = null) { string baseUrl = _serverUrl; @@ -277,13 +289,6 @@ public async Task ListAsync(ListCompaniesRequest? request } - /// - /// Update company - /// - /// - /// Updates both the name and description of the company. - /// - /// public async Task UpdateAsync(UpdateCompanyRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/Connections.cs b/platform/CodatPlatform/Connections.cs index 8bb79a69e..5f11b1feb 100755 --- a/platform/CodatPlatform/Connections.cs +++ b/platform/CodatPlatform/Connections.cs @@ -19,25 +19,76 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Manage your companies' data connections. + /// public interface IConnectionsSDK { + + /// + /// Create connection + /// + /// + /// Creates a connection for the company by providing a valid `platformKey`.
+ ///
+ /// Use the List Integrations endpoint to access valid platform keys. + ///
+ ///
Task CreateAsync(CreateConnectionRequest? request = null); + + /// + /// Delete connection + /// + /// + /// Revoke and remove a connection from a company.
+ /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. + ///
+ ///
Task DeleteAsync(DeleteConnectionRequest? request = null); + + /// + /// Get connection + /// + /// + /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. + /// + /// Task GetAsync(GetConnectionRequest? request = null); + + /// + /// List connections + /// + /// + /// List the connections for a company. + /// + /// Task ListAsync(ListConnectionsRequest? request = null); + + /// + /// Unlink connection + /// + /// + /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. + /// + /// Task UnlinkAsync(UnlinkConnectionRequest? request = null); + + /// + /// Update authorization + /// + /// + /// Update data connection's authorization. + /// + /// Task UpdateAuthorizationAsync(UpdateConnectionAuthorizationRequest? request = null); } - /// - /// Manage your companies' data connections. - /// public class ConnectionsSDK: IConnectionsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -52,15 +103,6 @@ public ConnectionsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient s } - /// - /// Create connection - /// - /// - /// Creates a connection for the company by providing a valid `platformKey`. - /// - /// Use the [List Integrations](https://docs.codat.io/codat-api#/operations/list-integrations) endpoint to access valid platform keys. - /// - /// public async Task CreateAsync(CreateConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -114,14 +156,6 @@ public async Task CreateAsync(CreateConnectionRequest? } - /// - /// Delete connection - /// - /// - /// Revoke and remove a connection from a company. - /// This operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company. - /// - /// public async Task DeleteAsync(DeleteConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -166,13 +200,6 @@ public async Task DeleteAsync(DeleteConnectionRequest? } - /// - /// Get connection - /// - /// - /// Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned. - /// - /// public async Task GetAsync(GetConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -221,13 +248,6 @@ public async Task GetAsync(GetConnectionRequest? request } - /// - /// List connections - /// - /// - /// List the connections for a company. - /// - /// public async Task ListAsync(ListConnectionsRequest? request = null) { string baseUrl = _serverUrl; @@ -276,13 +296,6 @@ public async Task ListAsync(ListConnectionsRequest? req } - /// - /// Unlink connection - /// - /// - /// This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data. - /// - /// public async Task UnlinkAsync(UnlinkConnectionRequest? request = null) { string baseUrl = _serverUrl; @@ -336,13 +349,6 @@ public async Task UnlinkAsync(UnlinkConnectionRequest? } - /// - /// Update authorization - /// - /// - /// Update data connection's authorization. - /// - /// public async Task UpdateAuthorizationAsync(UpdateConnectionAuthorizationRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/Integrations.cs b/platform/CodatPlatform/Integrations.cs index 273b169fd..111407036 100755 --- a/platform/CodatPlatform/Integrations.cs +++ b/platform/CodatPlatform/Integrations.cs @@ -19,22 +19,46 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// View and manage your available integrations in Codat. + /// public interface IIntegrationsSDK { + + /// + /// Get integration + /// + /// + /// Get single integration, by platformKey + /// + /// Task GetAsync(GetIntegrationRequest? request = null); + + /// + /// Get branding + /// + /// + /// Get branding for platform. + /// + /// Task GetBrandingAsync(GetIntegrationsBrandingRequest? request = null); + + /// + /// List integrations + /// + /// + /// List your available integrations + /// + /// Task ListAsync(ListIntegrationsRequest? request = null); } - /// - /// View and manage your available integrations in Codat. - /// public class IntegrationsSDK: IIntegrationsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -49,13 +73,6 @@ public IntegrationsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient } - /// - /// Get integration - /// - /// - /// Get single integration, by platformKey - /// - /// public async Task GetAsync(GetIntegrationRequest? request = null) { string baseUrl = _serverUrl; @@ -104,13 +121,6 @@ public async Task GetAsync(GetIntegrationRequest? reques } - /// - /// Get branding - /// - /// - /// Get branding for platform. - /// - /// public async Task GetBrandingAsync(GetIntegrationsBrandingRequest? request = null) { string baseUrl = _serverUrl; @@ -159,13 +169,6 @@ public async Task GetBrandingAsync(GetIntegrati } - /// - /// List integrations - /// - /// - /// List your available integrations - /// - /// public async Task ListAsync(ListIntegrationsRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs index f0f501672..d615c5e5d 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs @@ -13,56 +13,55 @@ namespace CodatPlatform.Models.Operations using Newtonsoft.Json; using System; - /// /// Data types that support supplemental data /// public enum ConfigureSupplementalDataDataType { - [JsonProperty("chartOfAccounts")] - ChartOfAccounts, - [JsonProperty("bills")] - Bills, - [JsonProperty("company")] - Company, - [JsonProperty("creditNotes")] - CreditNotes, - [JsonProperty("customers")] - Customers, - [JsonProperty("invoices")] - Invoices, - [JsonProperty("items")] - Items, - [JsonProperty("journalEntries")] - JournalEntries, - [JsonProperty("suppliers")] - Suppliers, - [JsonProperty("taxRates")] - TaxRates, - [JsonProperty("commerce-companyInfo")] - CommerceCompanyInfo, - [JsonProperty("commerce-customers")] - CommerceCustomers, - [JsonProperty("commerce-disputes")] - CommerceDisputes, - [JsonProperty("commerce-locations")] - CommerceLocations, - [JsonProperty("commerce-orders")] - CommerceOrders, - [JsonProperty("commerce-payments")] - CommercePayments, - [JsonProperty("commerce-paymentMethods")] - CommercePaymentMethods, - [JsonProperty("commerce-products")] - CommerceProducts, - [JsonProperty("commerce-productCategories")] - CommerceProductCategories, - [JsonProperty("commerce-taxComponents")] - CommerceTaxComponents, - [JsonProperty("commerce-transactions")] - CommerceTransactions, + [JsonProperty("chartOfAccounts")] + ChartOfAccounts, + [JsonProperty("bills")] + Bills, + [JsonProperty("company")] + Company, + [JsonProperty("creditNotes")] + CreditNotes, + [JsonProperty("customers")] + Customers, + [JsonProperty("invoices")] + Invoices, + [JsonProperty("items")] + Items, + [JsonProperty("journalEntries")] + JournalEntries, + [JsonProperty("suppliers")] + Suppliers, + [JsonProperty("taxRates")] + TaxRates, + [JsonProperty("commerce-companyInfo")] + CommerceCompanyInfo, + [JsonProperty("commerce-customers")] + CommerceCustomers, + [JsonProperty("commerce-disputes")] + CommerceDisputes, + [JsonProperty("commerce-locations")] + CommerceLocations, + [JsonProperty("commerce-orders")] + CommerceOrders, + [JsonProperty("commerce-payments")] + CommercePayments, + [JsonProperty("commerce-paymentMethods")] + CommercePaymentMethods, + [JsonProperty("commerce-products")] + CommerceProducts, + [JsonProperty("commerce-productCategories")] + CommerceProductCategories, + [JsonProperty("commerce-taxComponents")] + CommerceTaxComponents, + [JsonProperty("commerce-transactions")] + CommerceTransactions, } - + public static class ConfigureSupplementalDataDataTypeExtension { public static string Value(this ConfigureSupplementalDataDataType value) @@ -89,5 +88,4 @@ public static ConfigureSupplementalDataDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum ConfigureSupplementalDataDataType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs index 235d4d27c..bd498f12d 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Models.Shared; using CodatPlatform.Utils; - public class ConfigureSupplementalDataRequest { + /// /// The configuration for the specified platform and data type. /// [SpeakeasyMetadata("request:mediaType=application/json")] public SupplementalDataConfiguration? SupplementalDataConfiguration { get; set; } - + /// /// Data types that support supplemental data /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public ConfigureSupplementalDataDataType DataType { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs index 3dce90a93..c993a9c0c 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ConfigureSupplementalDataResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs b/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs index 8e73e77f0..8d6707f7d 100755 --- a/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class CreateApiKeyResponse { + /// /// Success /// - public ApiKeyDetails? ApiKeyDetails { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Bad Request /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs index 9d0f26974..c20f0dec9 100755 --- a/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class CreateCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// The request made is not valid. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs b/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs index 28238ecfe..2b22af4ed 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class CreateConnectionRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public CreateConnectionRequestBody? RequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs b/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs index 9cdaf41f4..9d7a59859 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using Newtonsoft.Json; - public class CreateConnectionRequestBody { + [JsonProperty("platformKey")] public string? PlatformKey { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs index d99cf4bd9..750a7197a 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class CreateConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs b/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs index d0e2cfca6..c4b44d059 100755 --- a/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class CreateRuleResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// OK /// - public Webhook? Webhook { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteApiKeyRequest.cs b/platform/CodatPlatform/Models/Operations/DeleteApiKeyRequest.cs index d1a74625e..25e357eca 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteApiKeyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteApiKeyRequest.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class DeleteApiKeyRequest { + /// /// Unique identifier for api key. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=apiKeyId")] public string ApiKeyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs index 6a0c77178..50d96c6f8 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class DeleteApiKeyResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs b/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs index aba34f819..eb12eb9ff 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class DeleteCompanyRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs index 0a26e5e45..040252795 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class DeleteCompanyResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs b/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs index 8d5d24ab9..a5a7fe723 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class DeleteConnectionRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs index c247e6620..63fbb8384 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class DeleteConnectionResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs index 3cbcdaf04..36d70eeee 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetCompanyDataStatusRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs index c61a3e880..9facbd0e7 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs @@ -15,30 +15,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetCompanyDataStatusResponse { - + public string? ContentType { get; set; } = default!; - + /// /// OK /// - public Dictionary? DataStatuses { get; set; } - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs index 976514f66..b92b5e600 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs @@ -12,36 +12,34 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetCompanyPushHistoryRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs index 41c25e366..540d0c6b0 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetCompanyPushHistoryResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOperations? PushOperations { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs b/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs index 06007e6d1..aed77efec 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetCompanyRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs index 7c73c9e32..560e7f7d3 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs b/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs index 02f198309..923fc8f7a 100755 --- a/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetConnectionRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs index 501b09e65..c8f8d3b94 100755 --- a/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs index cbbd0fd9a..ed851b3bb 100755 --- a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs @@ -13,21 +13,19 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Models.Shared; using CodatPlatform.Utils; - public class GetCreateUpdateModelOptionsByDataTypeRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - + /// /// The key of a Codat data type /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public DataType DataType { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs index cb12400c4..e9239d271 100755 --- a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetCreateUpdateModelOptionsByDataTypeResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOption? PushOption { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs index 74eeafad3..44d0b462e 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetIntegrationRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs index f77f07847..209e6aafb 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetIntegrationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public Integration? Integration { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs index 770bbc6e3..d66ff84dd 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetIntegrationsBrandingRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs index 61eeeb9be..e4daead82 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetIntegrationsBrandingResponse { + /// /// OK /// - public Branding? Branding { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs b/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs index f90b5ead8..98c58bc31 100755 --- a/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetProfileResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public Profile? Profile { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs b/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs index 91a00b959..9cd813365 100755 --- a/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetProfileSyncSettingsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// OK /// - public SyncSettings? SyncSettings { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs b/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs index c5498ebba..361e88d33 100755 --- a/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetPullOperationRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Unique ID of a dataset or pull operation. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=datasetId")] public string DatasetId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs b/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs index 3c8a284f0..ac1fc896a 100755 --- a/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetPullOperationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperation? PullOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs b/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs index 9e8fee679..5ba1e5316 100755 --- a/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetPushOperationRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Push operation key. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=pushOperationKey")] public string PushOperationKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs b/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs index 85691aa66..5c66dacc2 100755 --- a/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetPushOperationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PushOperation? PushOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs index 786eade0f..33130a544 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs @@ -13,56 +13,55 @@ namespace CodatPlatform.Models.Operations using Newtonsoft.Json; using System; - /// /// Data types that support supplemental data /// public enum GetSupplementalDataConfigurationDataType { - [JsonProperty("chartOfAccounts")] - ChartOfAccounts, - [JsonProperty("bills")] - Bills, - [JsonProperty("company")] - Company, - [JsonProperty("creditNotes")] - CreditNotes, - [JsonProperty("customers")] - Customers, - [JsonProperty("invoices")] - Invoices, - [JsonProperty("items")] - Items, - [JsonProperty("journalEntries")] - JournalEntries, - [JsonProperty("suppliers")] - Suppliers, - [JsonProperty("taxRates")] - TaxRates, - [JsonProperty("commerce-companyInfo")] - CommerceCompanyInfo, - [JsonProperty("commerce-customers")] - CommerceCustomers, - [JsonProperty("commerce-disputes")] - CommerceDisputes, - [JsonProperty("commerce-locations")] - CommerceLocations, - [JsonProperty("commerce-orders")] - CommerceOrders, - [JsonProperty("commerce-payments")] - CommercePayments, - [JsonProperty("commerce-paymentMethods")] - CommercePaymentMethods, - [JsonProperty("commerce-products")] - CommerceProducts, - [JsonProperty("commerce-productCategories")] - CommerceProductCategories, - [JsonProperty("commerce-taxComponents")] - CommerceTaxComponents, - [JsonProperty("commerce-transactions")] - CommerceTransactions, + [JsonProperty("chartOfAccounts")] + ChartOfAccounts, + [JsonProperty("bills")] + Bills, + [JsonProperty("company")] + Company, + [JsonProperty("creditNotes")] + CreditNotes, + [JsonProperty("customers")] + Customers, + [JsonProperty("invoices")] + Invoices, + [JsonProperty("items")] + Items, + [JsonProperty("journalEntries")] + JournalEntries, + [JsonProperty("suppliers")] + Suppliers, + [JsonProperty("taxRates")] + TaxRates, + [JsonProperty("commerce-companyInfo")] + CommerceCompanyInfo, + [JsonProperty("commerce-customers")] + CommerceCustomers, + [JsonProperty("commerce-disputes")] + CommerceDisputes, + [JsonProperty("commerce-locations")] + CommerceLocations, + [JsonProperty("commerce-orders")] + CommerceOrders, + [JsonProperty("commerce-payments")] + CommercePayments, + [JsonProperty("commerce-paymentMethods")] + CommercePaymentMethods, + [JsonProperty("commerce-products")] + CommerceProducts, + [JsonProperty("commerce-productCategories")] + CommerceProductCategories, + [JsonProperty("commerce-taxComponents")] + CommerceTaxComponents, + [JsonProperty("commerce-transactions")] + CommerceTransactions, } - + public static class GetSupplementalDataConfigurationDataTypeExtension { public static string Value(this GetSupplementalDataConfigurationDataType value) @@ -89,5 +88,4 @@ public static GetSupplementalDataConfigurationDataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum GetSupplementalDataConfigurationDataType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs index a1f5138ae..b0b8d75ba 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetSupplementalDataConfigurationRequest { + /// /// Data types that support supplemental data /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public GetSupplementalDataConfigurationDataType DataType { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs index 8dd5e3b18..7cbe50fb4 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetSupplementalDataConfigurationResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// OK /// - public SupplementalDataConfiguration? SupplementalDataConfiguration { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetWebhookRequest.cs b/platform/CodatPlatform/Models/Operations/GetWebhookRequest.cs index db145424b..0c7be66a7 100755 --- a/platform/CodatPlatform/Models/Operations/GetWebhookRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetWebhookRequest.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class GetWebhookRequest { + /// /// Unique ID of the webhook or rule. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=ruleId")] public string RuleId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs b/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs index f28a640c4..76069aadc 100755 --- a/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class GetWebhookResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// OK /// - public Webhook? Webhook { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs b/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs index c177a1d23..18743d4cd 100755 --- a/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListApiKeysResponse { + /// /// Success /// - public ApiKeys? ApiKeys { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListCompaniesRequest.cs b/platform/CodatPlatform/Models/Operations/ListCompaniesRequest.cs index e28ecc401..cae8891a7 100755 --- a/platform/CodatPlatform/Models/Operations/ListCompaniesRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListCompaniesRequest.cs @@ -12,33 +12,31 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class ListCompaniesRequest { + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs b/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs index 75d427904..0c9dbfe3d 100755 --- a/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListCompaniesResponse { + /// /// OK /// - public Companies? Companies { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs b/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs index 25b97df14..49c9deed4 100755 --- a/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs @@ -12,36 +12,34 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class ListConnectionsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs b/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs index 835511341..cb8855489 100755 --- a/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListConnectionsResponse { + /// /// OK /// - public Connections? Connections { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListIntegrationsRequest.cs b/platform/CodatPlatform/Models/Operations/ListIntegrationsRequest.cs index 28147f9b1..2b00d45d7 100755 --- a/platform/CodatPlatform/Models/Operations/ListIntegrationsRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListIntegrationsRequest.cs @@ -12,33 +12,31 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class ListIntegrationsRequest { + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs b/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs index ea61de870..85e4705e7 100755 --- a/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListIntegrationsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public Integrations? Integrations { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs b/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs index 58eb4b369..3d686315c 100755 --- a/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs @@ -12,36 +12,34 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class ListPullOperationsRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs b/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs index 3e42424ab..032e49e73 100755 --- a/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListPullOperationsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperations? PullOperations { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListRulesRequest.cs b/platform/CodatPlatform/Models/Operations/ListRulesRequest.cs index ab44c6835..fb54d5032 100755 --- a/platform/CodatPlatform/Models/Operations/ListRulesRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListRulesRequest.cs @@ -12,33 +12,31 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class ListRulesRequest { + /// - /// Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). + /// Field to order results by. <a href="https://docs.codat.io/using-the-api/ordering-results">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=orderBy")] public string? OrderBy { get; set; } - + /// - /// Page number. [Read more](https://docs.codat.io/using-the-api/paging). + /// Page number. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=page")] public int? Page { get; set; } - + /// - /// Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). + /// Number of records to return in a page. <a href="https://docs.codat.io/using-the-api/paging">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=pageSize")] public int? PageSize { get; set; } - + /// - /// Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). + /// Codat query string. <a href="https://docs.codat.io/using-the-api/querying">Read more</a>. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=query")] public string? Query { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs b/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs index 24076ab6d..bd0dc4b98 100755 --- a/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class ListRulesResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your `query` parameter was not correctly formed /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - + /// /// OK /// - public Webhooks? Webhooks { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs index 7c6ecc2ad..2be8a8bb7 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Operations { using CodatPlatform.Utils; - public class RefreshCompanyDataRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs index 6cb655ddf..a26698212 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class RefreshCompanyDataResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs b/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs index 14fe4eb24..307f2dafd 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Models.Shared; using CodatPlatform.Utils; - public class RefreshDataTypeRequest { + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + /// /// Optionally, provide a data connection id to only queue pull operations on that connection. /// [SpeakeasyMetadata("queryParam:style=form,explode=true,name=connectionId")] public string? ConnectionId { get; set; } - + /// /// The key of a Codat data type /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public DataType DataType { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs b/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs index 6eb472054..6bb40c5fb 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class RefreshDataTypeResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public PullOperation? PullOperation { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs b/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs index 24423c229..fc7dc286c 100755 --- a/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs @@ -13,18 +13,16 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Models.Shared; using CodatPlatform.Utils; - public class UnlinkConnectionRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public UpdateConnectionStatus? UpdateConnectionStatus { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs index 8c314ec90..f41f043e8 100755 --- a/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class UnlinkConnectionResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs b/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs index 4e97c5d4e..7a1582773 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs @@ -13,15 +13,13 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Models.Shared; using CodatPlatform.Utils; - public class UpdateCompanyRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public CompanyRequestBody? CompanyRequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs index b279766d0..70ff7f733 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class UpdateCompanyResponse { + /// /// OK /// - public Company? Company { get; set; } - - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs index bbb33331b..a1032e5f5 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs @@ -13,18 +13,16 @@ namespace CodatPlatform.Models.Operations using CodatPlatform.Utils; using System.Collections.Generic; - public class UpdateConnectionAuthorizationRequest { + [SpeakeasyMetadata("request:mediaType=application/json")] public Dictionary? RequestBody { get; set; } - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; - + [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs index c81b7566e..b03356281 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class UpdateConnectionAuthorizationResponse { + /// /// OK /// - public Connection? Connection { get; set; } - - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs index ed77a17d9..8ef777edc 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs @@ -14,30 +14,23 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class UpdateProfileResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - + /// /// OK /// - public Profile? Profile { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs index abbab960f..1fe5433ec 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs @@ -14,25 +14,23 @@ namespace CodatPlatform.Models.Operations using Newtonsoft.Json; using System.Collections.Generic; - /// - /// Include a `syncSetting` object for each data type. + /// Include a `syncSetting` object for each data type.<br/> /// /// - /// `syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. + /// `syncFromWindow`, `syncFromUTC` & `monthsToSync` only need to be included if you wish to set a value for them. /// /// public class UpdateProfileSyncSettingsRequestBody { + [JsonProperty("clientId")] public string ClientId { get; set; } = default!; - + [JsonProperty("overridesDefaults")] public bool OverridesDefaults { get; set; } = default!; - + [JsonProperty("settings")] public List Settings { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs index 049aeb67f..18a64bf46 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs @@ -14,24 +14,18 @@ namespace CodatPlatform.Models.Operations using System.Net.Http; using System; - public class UpdateProfileSyncSettingsResponse { - + public string? ContentType { get; set; } = default!; - + /// /// Your API request was not properly authorized. /// - public ErrorMessage? ErrorMessage { get; set; } - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ApiKeyDetails.cs b/platform/CodatPlatform/Models/Shared/ApiKeyDetails.cs index 9cc967d82..58f7e373e 100755 --- a/platform/CodatPlatform/Models/Shared/ApiKeyDetails.cs +++ b/platform/CodatPlatform/Models/Shared/ApiKeyDetails.cs @@ -12,57 +12,55 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Datetime in UTC the API key was created. The created date will be null if the API key created before YYYY-MM-DD. /// public class ApiKeyDetails { + /// /// The API key value used to make authenticated http requests. /// [JsonProperty("apiKey")] public string? ApiKey { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("createdDate")] public string? CreatedDate { get; set; } - + /// /// Unique identifier for the API key. /// [JsonProperty("id")] public string? Id { get; set; } - + /// /// A meaningful name assigned to the API key. /// [JsonProperty("name")] public string? Name { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ApiKeys.cs b/platform/CodatPlatform/Models/Shared/ApiKeys.cs index 6f41f3e3e..529780609 100755 --- a/platform/CodatPlatform/Models/Shared/ApiKeys.cs +++ b/platform/CodatPlatform/Models/Shared/ApiKeys.cs @@ -13,12 +13,10 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class ApiKeys { + [JsonProperty("results")] public List? Results { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Branding.cs b/platform/CodatPlatform/Models/Shared/Branding.cs index 6280bdc47..806ddfe27 100755 --- a/platform/CodatPlatform/Models/Shared/Branding.cs +++ b/platform/CodatPlatform/Models/Shared/Branding.cs @@ -12,27 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class Branding { + /// /// Button branding references. /// [JsonProperty("button")] public BrandingButton? Button { get; set; } - + /// /// Logo branding references. /// [JsonProperty("logo")] public BrandingLogo? Logo { get; set; } - + /// /// A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. /// [JsonProperty("sourceId")] public string? SourceId { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/BrandingButton.cs b/platform/CodatPlatform/Models/Shared/BrandingButton.cs index 9ed0d96f6..6b915b38f 100755 --- a/platform/CodatPlatform/Models/Shared/BrandingButton.cs +++ b/platform/CodatPlatform/Models/Shared/BrandingButton.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Button branding references. /// public class BrandingButton { + [JsonProperty("default")] public BrandingImage? Default { get; set; } - + [JsonProperty("hover")] public BrandingImage? Hover { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/BrandingImage.cs b/platform/CodatPlatform/Models/Shared/BrandingImage.cs index 6eaca72ca..9141fcf2d 100755 --- a/platform/CodatPlatform/Models/Shared/BrandingImage.cs +++ b/platform/CodatPlatform/Models/Shared/BrandingImage.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class BrandingImage { + /// /// Image reference. /// [JsonProperty("image")] public ImageReference? Image { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/BrandingLogo.cs b/platform/CodatPlatform/Models/Shared/BrandingLogo.cs index 419591562..71cc4a037 100755 --- a/platform/CodatPlatform/Models/Shared/BrandingLogo.cs +++ b/platform/CodatPlatform/Models/Shared/BrandingLogo.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Logo branding references. /// public class BrandingLogo { + [JsonProperty("full")] public BrandingImage? Full { get; set; } - + [JsonProperty("square")] public BrandingImage? Square { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhook.cs b/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhook.cs new file mode 100755 index 000000000..d8f429187 --- /dev/null +++ b/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhook.cs @@ -0,0 +1,60 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Shared +{ + using Newtonsoft.Json; + + /// + /// Webhook request body for a client that has reached their rate limit. + /// + public class ClientRateLimitReachedWebhook + { + + /// + /// Unique identifier of the webhook event. + /// + [JsonProperty("AlertId")] + public string? AlertId { get; set; } + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + + [JsonProperty("Data")] + public ClientRateLimitReachedWebhookData? Data { get; set; } + + /// + /// A human readable message about the webhook. + /// + [JsonProperty("Message")] + public string? Message { get; set; } + + /// + /// Unique identifier for the rule. + /// + [JsonProperty("RuleId")] + public string? RuleId { get; set; } + + /// + /// The type of rule. + /// + [JsonProperty("RuleType")] + public string? RuleType { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhookData.cs b/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhookData.cs new file mode 100755 index 000000000..16f0cc353 --- /dev/null +++ b/platform/CodatPlatform/Models/Shared/ClientRateLimitReachedWebhookData.cs @@ -0,0 +1,51 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Shared +{ + using Newtonsoft.Json; + + public class ClientRateLimitReachedWebhookData + { + + /// + /// The number of available requests per day. + /// + [JsonProperty("DailyQuota")] + public long? DailyQuota { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ ///
+ [JsonProperty("ExpiresUtc")] + public string? ExpiresUtc { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhook.cs b/platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhook.cs similarity index 67% rename from platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhook.cs rename to platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhook.cs index 090b1d346..7d83feb0b 100755 --- a/platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhook.cs @@ -12,45 +12,49 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// - /// Webhook request body for a company's data connection status changed. + /// Webhook request body for a client that has had their rate limit reset. /// - public class CompanyDataConnectionStatusChangedWebhook + public class ClientRateLimitResetWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + /// - /// Unique identifier for your SMB in Codat. + /// Name of your client in Codat. /// - [JsonProperty("CompanyId")] - public string? CompanyId { get; set; } - + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + [JsonProperty("Data")] - public CompanyDataConnectionStatusChangedWebhookData? Data { get; set; } - + public ClientRateLimitResetWebhookData? Data { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhookData.cs b/platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhookData.cs new file mode 100755 index 000000000..ef02749c2 --- /dev/null +++ b/platform/CodatPlatform/Models/Shared/ClientRateLimitResetWebhookData.cs @@ -0,0 +1,63 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Shared +{ + using Newtonsoft.Json; + + public class ClientRateLimitResetWebhookData + { + + /// + /// The number of available requests per day. + /// + [JsonProperty("DailyQuota")] + public long? DailyQuota { get; set; } + + /// + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> + /// + /// + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ ///
+ [JsonProperty("ExpiresUtc")] + public string? ExpiresUtc { get; set; } + + /// + /// Total number of request remaining for your client. + /// + [JsonProperty("QuotaRemaining")] + public long? QuotaRemaining { get; set; } + + /// + /// The reason for your rate limit quota being reset. + /// + [JsonProperty("ResetReason")] + public string? ResetReason { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Companies.cs b/platform/CodatPlatform/Models/Shared/Companies.cs index 2875ff854..f6ece6aca 100755 --- a/platform/CodatPlatform/Models/Shared/Companies.cs +++ b/platform/CodatPlatform/Models/Shared/Companies.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Companies { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Company.cs b/platform/CodatPlatform/Models/Shared/Company.cs index a7ff063d0..89c242a70 100755 --- a/platform/CodatPlatform/Models/Shared/Company.cs +++ b/platform/CodatPlatform/Models/Shared/Company.cs @@ -14,107 +14,105 @@ namespace CodatPlatform.Models.Shared using System.Collections.Generic; using System; - /// - /// In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/codat-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data. + /// In Codat, a company represents a business sharing access to their data. Each company can have multiple <a href="https://docs.codat.io/codat-api#/schemas/Connection">connections</a> to different data sources such as one connection to <a href="https://docs.codat.io/integrations/accounting/xero/accounting-xero">Xero</a> for accounting data, two connections to <a href="https://docs.codat.io/integrations/banking/plaid/banking-plaid">Plaid</a> for two bank accounts and a connection to <a href="https://docs.codat.io/integrations/commerce/zettle/commerce-zettle">Zettle</a> for POS data.<br/> /// /// - /// - /// Typically each company is one of your customers. - /// + ///
+ /// Typically each company is one of your customers.
+ ///
/// When you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company. ///
///
public class Company { + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("created")] public string? Created { get; set; } - + [JsonProperty("createdByUserName")] public string? CreatedByUserName { get; set; } - + [JsonProperty("dataConnections")] public List? DataConnections { get; set; } - + /// /// Additional information about the company. This can be used to store foreign IDs, references, etc. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("id")] public string Id { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("lastSync")] public string? LastSync { get; set; } - + /// /// The name of the company /// [JsonProperty("name")] public string Name { get; set; } = default!; - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("platform")] public string? Platform { get; set; } - + /// - /// The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. + /// The `redirect` <a href="https://docs.codat.io/auth-flow/authorize-hosted-link">Link URL</a> enabling the customer to start their auth flow journey for the company. /// [JsonProperty("redirect")] public string Redirect { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CompanyRequestBody.cs b/platform/CodatPlatform/Models/Shared/CompanyRequestBody.cs index 312886e79..3cd150c3c 100755 --- a/platform/CodatPlatform/Models/Shared/CompanyRequestBody.cs +++ b/platform/CodatPlatform/Models/Shared/CompanyRequestBody.cs @@ -12,21 +12,19 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class CompanyRequestBody { + /// /// Additional information about the company. This can be used to store foreign IDs, references, etc. /// [JsonProperty("description")] public string? Description { get; set; } - + /// /// Name of company being connected. /// [JsonProperty("name")] public string Name { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Connection.cs b/platform/CodatPlatform/Models/Shared/Connection.cs index 68705bc70..26fa1f29c 100755 --- a/platform/CodatPlatform/Models/Shared/Connection.cs +++ b/platform/CodatPlatform/Models/Shared/Connection.cs @@ -13,129 +13,127 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// A connection represents a [company's](https://docs.codat.io/codat-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source. + /// A connection represents a <a href="https://docs.codat.io/codat-api#/schemas/Company">company&apos;s</a> connection to a data source and allows you to synchronize data (pull and/or push) with that source.<br/> /// /// - /// - /// A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to: - /// - /// - [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection. - /// - [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections. - /// - [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections. - /// Any combination of accounting, banking, and commerce data connections is allowed. - /// - /// Before you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview). + ///
+ /// A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:
+ ///
+ /// - Accounting data - 1 active connection.
+ /// - Banking data - Multiple active connections.
+ /// - Commerce data - Multiple active connections.
+ /// Any combination of accounting, banking, and commerce data connections is allowed.
+ ///
+ /// Before you can use a data connection to pull or push data, the company must grant you access to their business data by linking the connection. ///
///
public class Connection { + [JsonProperty("additionalProperties")] public object? AdditionalProperties { get; set; } - + [JsonProperty("connectionInfo")] public Dictionary? ConnectionInfo { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("created")] public string Created { get; set; } = default!; - + [JsonProperty("dataConnectionErrors")] public List? DataConnectionErrors { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("id")] public string Id { get; set; } = default!; - + /// /// A Codat ID representing the integration. /// [JsonProperty("integrationId")] public string IntegrationId { get; set; } = default!; - + /// - /// A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. + /// A unique four-character ID that identifies the platform of the company&apos;s data connection. This ensures continuity if the platform changes its name in the future. /// [JsonProperty("integrationKey")] public string IntegrationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("lastSync")] public string? LastSync { get; set; } - + [JsonProperty("linkUrl")] public string LinkUrl { get; set; } = default!; - + [JsonProperty("platformName")] public string PlatformName { get; set; } = default!; - + /// /// A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. /// [JsonProperty("sourceId")] public string SourceId { get; set; } = default!; - + /// /// The type of platform of the connection. /// [JsonProperty("sourceType")] public SourceType SourceType { get; set; } = default!; - + /// /// The current authorization status of the data connection. /// [JsonProperty("status")] public DataConnectionStatus Status { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhook.cs b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhook.cs new file mode 100755 index 000000000..8e58cedb9 --- /dev/null +++ b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhook.cs @@ -0,0 +1,72 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Shared +{ + using Newtonsoft.Json; + + /// + /// Webhook request body for a company&apos;s data connection status changed. + /// + public class ConnectionStatusChangedWebhook + { + + /// + /// Unique identifier of the webhook event. + /// + [JsonProperty("AlertId")] + public string? AlertId { get; set; } + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + + /// + /// Unique identifier for your SMB in Codat. + /// + [JsonProperty("CompanyId")] + public string? CompanyId { get; set; } + + [JsonProperty("Data")] + public ConnectionStatusChangedWebhookData? Data { get; set; } + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + + /// + /// A human readable message about the webhook. + /// + [JsonProperty("Message")] + public string? Message { get; set; } + + /// + /// Unique identifier for the rule. + /// + [JsonProperty("RuleId")] + public string? RuleId { get; set; } + + /// + /// The type of rule. + /// + [JsonProperty("RuleType")] + public string? RuleType { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhookData.cs b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs similarity index 71% rename from platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhookData.cs rename to platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs index 0aeef526a..c459330a1 100755 --- a/platform/CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs @@ -12,33 +12,31 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - - public class CompanyDataConnectionStatusChangedWebhookData + public class ConnectionStatusChangedWebhookData { + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionId")] public string? DataConnectionId { get; set; } - + /// /// The current authorization status of the data connection. /// [JsonProperty("newStatus")] public DataConnectionStatus? NewStatus { get; set; } - + /// /// The current authorization status of the data connection. /// [JsonProperty("oldStatus")] public DataConnectionStatus? OldStatus { get; set; } - + /// - /// A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/accounting-platform-keys), [banking](https://docs.codat.io/integrations/banking/banking-platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/commerce-platform-keys) platform keys. + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/accounting-platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/banking-platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/commerce-platform-keys">commerce</a> platform keys. /// [JsonProperty("platformKey")] public string? PlatformKey { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Connections.cs b/platform/CodatPlatform/Models/Shared/Connections.cs index f9320c5f2..e48335bed 100755 --- a/platform/CodatPlatform/Models/Shared/Connections.cs +++ b/platform/CodatPlatform/Models/Shared/Connections.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Connections { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CreateApiKey.cs b/platform/CodatPlatform/Models/Shared/CreateApiKey.cs index 9316a70f8..4241c64db 100755 --- a/platform/CodatPlatform/Models/Shared/CreateApiKey.cs +++ b/platform/CodatPlatform/Models/Shared/CreateApiKey.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Details of the API key. /// public class CreateApiKey { + /// /// A meaningful name assigned to the API key. /// [JsonProperty("name")] public string? Name { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CreateRule.cs b/platform/CodatPlatform/Models/Shared/CreateRule.cs index f2211cfee..410c4e9a5 100755 --- a/platform/CodatPlatform/Models/Shared/CreateRule.cs +++ b/platform/CodatPlatform/Models/Shared/CreateRule.cs @@ -12,21 +12,19 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Create an event notification to a URL or list of email addresses based on the given type or condition. /// public class CreateRule { + [JsonProperty("companyId")] public string? CompanyId { get; set; } - + [JsonProperty("notifiers")] public CreateRuleNotifiers Notifiers { get; set; } = default!; - + [JsonProperty("type")] public string Type { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs b/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs index f83579997..262954420 100755 --- a/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs +++ b/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs @@ -13,15 +13,13 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class CreateRuleNotifiers { + [JsonProperty("emails")] public List? Emails { get; set; } - + [JsonProperty("webhook")] public string? Webhook { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataConnectionError.cs b/platform/CodatPlatform/Models/Shared/DataConnectionError.cs index 6d137b0e9..16965f937 100755 --- a/platform/CodatPlatform/Models/Shared/DataConnectionError.cs +++ b/platform/CodatPlatform/Models/Shared/DataConnectionError.cs @@ -12,45 +12,43 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class DataConnectionError { + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("erroredOnUtc")] public string? ErroredOnUtc { get; set; } - + [JsonProperty("statusCode")] public string? StatusCode { get; set; } - + [JsonProperty("statusText")] public string? StatusText { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs b/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs index 840058227..2d61f7ebb 100755 --- a/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs +++ b/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs @@ -13,22 +13,21 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - /// /// The current authorization status of the data connection. /// public enum DataConnectionStatus { - [JsonProperty("PendingAuth")] - PendingAuth, - [JsonProperty("Linked")] - Linked, - [JsonProperty("Unlinked")] - Unlinked, - [JsonProperty("Deauthorized")] - Deauthorized, + [JsonProperty("PendingAuth")] + PendingAuth, + [JsonProperty("Linked")] + Linked, + [JsonProperty("Unlinked")] + Unlinked, + [JsonProperty("Deauthorized")] + Deauthorized, } - + public static class DataConnectionStatusExtension { public static string Value(this DataConnectionStatus value) @@ -55,5 +54,4 @@ public static DataConnectionStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataConnectionStatus"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataStatus.cs b/platform/CodatPlatform/Models/Shared/DataStatus.cs index a97758343..df0be592d 100755 --- a/platform/CodatPlatform/Models/Shared/DataStatus.cs +++ b/platform/CodatPlatform/Models/Shared/DataStatus.cs @@ -12,51 +12,49 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Describes the state of data in the Codat cache for a company and data type /// public class DataStatus { + [JsonProperty("currentStatus")] public string CurrentStatus { get; set; } = default!; - + [JsonProperty("dataType")] public string DataType { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("lastSuccessfulSync")] public string LastSuccessfulSync { get; set; } = default!; - + [JsonProperty("latestSuccessfulSyncId")] public string? LatestSuccessfulSyncId { get; set; } - + [JsonProperty("latestSyncId")] public string? LatestSyncId { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhook.cs b/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhook.cs index a57c15b34..c031e9379 100755 --- a/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhook.cs @@ -12,63 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body to notify the completion of a data sync. /// public class DataSyncCompletedWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + /// /// Unique identifier for your client in Codat. /// [JsonProperty("ClientId")] public string? ClientId { get; set; } - + /// /// Name of your client in Codat. /// [JsonProperty("ClientName")] public string? ClientName { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + [JsonProperty("Data")] public DataSyncCompletedWebhookData? Data { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("DataConnectionId")] public string? DataConnectionId { get; set; } - + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs b/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs index afd1cba0a..ac8fb8a1e 100755 --- a/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs @@ -12,21 +12,19 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class DataSyncCompletedWebhookData { + /// - /// Data type the sync completed for. + /// Available Data types /// [JsonProperty("dataType")] - public string? DataType { get; set; } - + public DataType? DataType { get; set; } + /// /// Unique identifier for the dataset that completed its sync. /// [JsonProperty("datasetId")] public string? DatasetId { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataType.cs b/platform/CodatPlatform/Models/Shared/DataType.cs index 1a01cf699..cadb0fc5a 100755 --- a/platform/CodatPlatform/Models/Shared/DataType.cs +++ b/platform/CodatPlatform/Models/Shared/DataType.cs @@ -13,98 +13,97 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - /// /// Available Data types /// public enum DataType { - [JsonProperty("accountTransactions")] - AccountTransactions, - [JsonProperty("balanceSheet")] - BalanceSheet, - [JsonProperty("bankAccounts")] - BankAccounts, - [JsonProperty("bankTransactions")] - BankTransactions, - [JsonProperty("billCreditNotes")] - BillCreditNotes, - [JsonProperty("billPayments")] - BillPayments, - [JsonProperty("bills")] - Bills, - [JsonProperty("cashFlowStatement")] - CashFlowStatement, - [JsonProperty("chartOfAccounts")] - ChartOfAccounts, - [JsonProperty("company")] - Company, - [JsonProperty("creditNotes")] - CreditNotes, - [JsonProperty("customers")] - Customers, - [JsonProperty("directCosts")] - DirectCosts, - [JsonProperty("directIncomes")] - DirectIncomes, - [JsonProperty("invoices")] - Invoices, - [JsonProperty("items")] - Items, - [JsonProperty("journalEntries")] - JournalEntries, - [JsonProperty("journals")] - Journals, - [JsonProperty("paymentMethods")] - PaymentMethods, - [JsonProperty("payments")] - Payments, - [JsonProperty("profitAndLoss")] - ProfitAndLoss, - [JsonProperty("purchaseOrders")] - PurchaseOrders, - [JsonProperty("salesOrders")] - SalesOrders, - [JsonProperty("suppliers")] - Suppliers, - [JsonProperty("taxRates")] - TaxRates, - [JsonProperty("trackingCategories")] - TrackingCategories, - [JsonProperty("transfers")] - Transfers, - [JsonProperty("banking-accountBalances")] - BankingAccountBalances, - [JsonProperty("banking-accounts")] - BankingAccounts, - [JsonProperty("banking-transactionCategories")] - BankingTransactionCategories, - [JsonProperty("banking-transactions")] - BankingTransactions, - [JsonProperty("commerce-companyInfo")] - CommerceCompanyInfo, - [JsonProperty("commerce-customers")] - CommerceCustomers, - [JsonProperty("commerce-disputes")] - CommerceDisputes, - [JsonProperty("commerce-locations")] - CommerceLocations, - [JsonProperty("commerce-orders")] - CommerceOrders, - [JsonProperty("commerce-paymentMethods")] - CommercePaymentMethods, - [JsonProperty("commerce-payments")] - CommercePayments, - [JsonProperty("commerce-productCategories")] - CommerceProductCategories, - [JsonProperty("commerce-products")] - CommerceProducts, - [JsonProperty("commerce-taxComponents")] - CommerceTaxComponents, - [JsonProperty("commerce-transactions")] - CommerceTransactions, + [JsonProperty("accountTransactions")] + AccountTransactions, + [JsonProperty("balanceSheet")] + BalanceSheet, + [JsonProperty("bankAccounts")] + BankAccounts, + [JsonProperty("bankTransactions")] + BankTransactions, + [JsonProperty("billCreditNotes")] + BillCreditNotes, + [JsonProperty("billPayments")] + BillPayments, + [JsonProperty("bills")] + Bills, + [JsonProperty("cashFlowStatement")] + CashFlowStatement, + [JsonProperty("chartOfAccounts")] + ChartOfAccounts, + [JsonProperty("company")] + Company, + [JsonProperty("creditNotes")] + CreditNotes, + [JsonProperty("customers")] + Customers, + [JsonProperty("directCosts")] + DirectCosts, + [JsonProperty("directIncomes")] + DirectIncomes, + [JsonProperty("invoices")] + Invoices, + [JsonProperty("items")] + Items, + [JsonProperty("journalEntries")] + JournalEntries, + [JsonProperty("journals")] + Journals, + [JsonProperty("paymentMethods")] + PaymentMethods, + [JsonProperty("payments")] + Payments, + [JsonProperty("profitAndLoss")] + ProfitAndLoss, + [JsonProperty("purchaseOrders")] + PurchaseOrders, + [JsonProperty("salesOrders")] + SalesOrders, + [JsonProperty("suppliers")] + Suppliers, + [JsonProperty("taxRates")] + TaxRates, + [JsonProperty("trackingCategories")] + TrackingCategories, + [JsonProperty("transfers")] + Transfers, + [JsonProperty("banking-accountBalances")] + BankingAccountBalances, + [JsonProperty("banking-accounts")] + BankingAccounts, + [JsonProperty("banking-transactionCategories")] + BankingTransactionCategories, + [JsonProperty("banking-transactions")] + BankingTransactions, + [JsonProperty("commerce-companyInfo")] + CommerceCompanyInfo, + [JsonProperty("commerce-customers")] + CommerceCustomers, + [JsonProperty("commerce-disputes")] + CommerceDisputes, + [JsonProperty("commerce-locations")] + CommerceLocations, + [JsonProperty("commerce-orders")] + CommerceOrders, + [JsonProperty("commerce-paymentMethods")] + CommercePaymentMethods, + [JsonProperty("commerce-payments")] + CommercePayments, + [JsonProperty("commerce-productCategories")] + CommerceProductCategories, + [JsonProperty("commerce-products")] + CommerceProducts, + [JsonProperty("commerce-taxComponents")] + CommerceTaxComponents, + [JsonProperty("commerce-transactions")] + CommerceTransactions, } - + public static class DataTypeExtension { public static string Value(this DataType value) @@ -131,5 +130,4 @@ public static DataType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum DataType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataTypeFeature.cs b/platform/CodatPlatform/Models/Shared/DataTypeFeature.cs index 0c53925ee..5a89b0503 100755 --- a/platform/CodatPlatform/Models/Shared/DataTypeFeature.cs +++ b/platform/CodatPlatform/Models/Shared/DataTypeFeature.cs @@ -13,21 +13,19 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// Describes support for a given datatype and associated operations /// public class DataTypeFeature { + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("supportedFeatures")] public List SupportedFeatures { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhook.cs b/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhook.cs index 518036d2d..89c4d362d 100755 --- a/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhook.cs @@ -12,45 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body to notify that a data synchronization has completed. /// public class DatasetDataChangedWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + [JsonProperty("Data")] - public DatasetDataChangedWebhookData? Data { get; set; } - + public DatasetDataChangedWebhookDatasetDataChangedWebhookData? Data { get; set; } + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookData.cs b/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.cs similarity index 82% rename from platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookData.cs rename to platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.cs index ef371d73e..22c223025 100755 --- a/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.cs @@ -12,21 +12,19 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - - public class DatasetDataChangedWebhookData + public class DatasetDataChangedWebhookDatasetDataChangedWebhookData { + /// - /// Data type the sync completed for. + /// Available Data types /// [JsonProperty("dataType")] - public string? DataType { get; set; } - + public DataType? DataType { get; set; } + /// /// Unique identifier for the dataset that completed its sync. /// [JsonProperty("datasetId")] public string? DatasetId { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhook.cs b/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhook.cs index f4efdffda..ce6c0d97c 100755 --- a/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhook.cs @@ -12,45 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body to notify that a data synchronization has completed. /// public class DatasetStatusChangedErrorWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + [JsonProperty("Data")] public DatasetStatusChangedErrorWebhookData? Data { get; set; } - + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs b/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs index a1dfb7136..0f0e8b70d 100755 --- a/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs @@ -12,27 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class DatasetStatusChangedErrorWebhookData { + /// - /// Data type the sync completed for. + /// Available Data types /// [JsonProperty("dataType")] - public string? DataType { get; set; } - + public DataType? DataType { get; set; } + /// /// Unique identifier for the dataset that completed its sync. /// [JsonProperty("datasetId")] public string? DatasetId { get; set; } - + /// - /// The current status of the dataset's sync. + /// The current status of the dataset&apos;s sync. /// [JsonProperty("datasetStatus")] public string? DatasetStatus { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ErrorMessage.cs b/platform/CodatPlatform/Models/Shared/ErrorMessage.cs index f62d3421d..c7675165e 100755 --- a/platform/CodatPlatform/Models/Shared/ErrorMessage.cs +++ b/platform/CodatPlatform/Models/Shared/ErrorMessage.cs @@ -12,27 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class ErrorMessage { + [JsonProperty("canBeRetried")] public string? CanBeRetried { get; set; } - + [JsonProperty("correlationId")] public string? CorrelationId { get; set; } - + [JsonProperty("detailedErrorCode")] public long? DetailedErrorCode { get; set; } - + [JsonProperty("error")] public string? Error { get; set; } - + [JsonProperty("service")] public string? Service { get; set; } - + [JsonProperty("statusCode")] public long? StatusCode { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/FeatureState.cs b/platform/CodatPlatform/Models/Shared/FeatureState.cs index ee59770de..401400fd4 100755 --- a/platform/CodatPlatform/Models/Shared/FeatureState.cs +++ b/platform/CodatPlatform/Models/Shared/FeatureState.cs @@ -13,23 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - public enum FeatureState { - [JsonProperty("Release")] - Release, - [JsonProperty("Alpha")] - Alpha, - [JsonProperty("Beta")] - Beta, - [JsonProperty("Deprecated")] - Deprecated, - [JsonProperty("NotSupported")] - NotSupported, - [JsonProperty("NotImplemented")] - NotImplemented, + [JsonProperty("Release")] + Release, + [JsonProperty("Alpha")] + Alpha, + [JsonProperty("Beta")] + Beta, + [JsonProperty("Deprecated")] + Deprecated, + [JsonProperty("NotSupported")] + NotSupported, + [JsonProperty("NotImplemented")] + NotImplemented, } - + public static class FeatureStateExtension { public static string Value(this FeatureState value) @@ -56,5 +55,4 @@ public static FeatureState ToEnum(this string value) throw new Exception($"Unknown value {value} for enum FeatureState"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/FeatureType.cs b/platform/CodatPlatform/Models/Shared/FeatureType.cs index b6f54dff5..f75bfa79a 100755 --- a/platform/CodatPlatform/Models/Shared/FeatureType.cs +++ b/platform/CodatPlatform/Models/Shared/FeatureType.cs @@ -13,31 +13,30 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - public enum FeatureType { - [JsonProperty("Get")] - Get, - [JsonProperty("Post")] - Post, - [JsonProperty("Categorization")] - Categorization, - [JsonProperty("Delete")] - Delete, - [JsonProperty("Put")] - Put, - [JsonProperty("GetAsPdf")] - GetAsPdf, - [JsonProperty("DownloadAttachment")] - DownloadAttachment, - [JsonProperty("GetAttachment")] - GetAttachment, - [JsonProperty("GetAttachments")] - GetAttachments, - [JsonProperty("UploadAttachment")] - UploadAttachment, + [JsonProperty("Get")] + Get, + [JsonProperty("Post")] + Post, + [JsonProperty("Categorization")] + Categorization, + [JsonProperty("Delete")] + Delete, + [JsonProperty("Put")] + Put, + [JsonProperty("GetAsPdf")] + GetAsPdf, + [JsonProperty("DownloadAttachment")] + DownloadAttachment, + [JsonProperty("GetAttachment")] + GetAttachment, + [JsonProperty("GetAttachments")] + GetAttachments, + [JsonProperty("UploadAttachment")] + UploadAttachment, } - + public static class FeatureTypeExtension { public static string Value(this FeatureType value) @@ -64,5 +63,4 @@ public static FeatureType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum FeatureType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/HalRef.cs b/platform/CodatPlatform/Models/Shared/HalRef.cs index 40e4f83e3..e49de01dd 100755 --- a/platform/CodatPlatform/Models/Shared/HalRef.cs +++ b/platform/CodatPlatform/Models/Shared/HalRef.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class HalRef { + [JsonProperty("href")] public string? Href { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ImageReference.cs b/platform/CodatPlatform/Models/Shared/ImageReference.cs index 293eb1395..ad47c9e9e 100755 --- a/platform/CodatPlatform/Models/Shared/ImageReference.cs +++ b/platform/CodatPlatform/Models/Shared/ImageReference.cs @@ -12,24 +12,22 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Image reference. /// public class ImageReference { + /// /// Alternative text when image is not available. /// [JsonProperty("alt")] public string? Alt { get; set; } - + /// /// Source URL for image. /// [JsonProperty("src")] public string? Src { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Integration.cs b/platform/CodatPlatform/Models/Shared/Integration.cs index d57f4f352..dd725b43b 100755 --- a/platform/CodatPlatform/Models/Shared/Integration.cs +++ b/platform/CodatPlatform/Models/Shared/Integration.cs @@ -13,60 +13,58 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// An integration that Codat supports /// public class Integration { + [JsonProperty("dataProvidedBy")] public string? DataProvidedBy { get; set; } - + [JsonProperty("datatypeFeatures")] public List? DatatypeFeatures { get; set; } - + /// /// Whether this integration is enabled for your customers to use /// [JsonProperty("enabled")] public bool Enabled { get; set; } = default!; - + /// /// A Codat ID representing the integration. /// [JsonProperty("integrationId")] public string? IntegrationId { get; set; } - + [JsonProperty("isBeta")] public bool? IsBeta { get; set; } - + [JsonProperty("isOfflineConnector")] public bool? IsOfflineConnector { get; set; } - + /// - /// A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/accounting-platform-keys), [banking](https://docs.codat.io/integrations/banking/banking-platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/commerce-platform-keys) platform keys. + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/accounting-platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/banking-platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/commerce-platform-keys">commerce</a> platform keys. /// [JsonProperty("key")] public string Key { get; set; } = default!; - + [JsonProperty("logoUrl")] public string LogoUrl { get; set; } = default!; - + [JsonProperty("name")] public string Name { get; set; } = default!; - + /// /// A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. /// [JsonProperty("sourceId")] public string? SourceId { get; set; } - + /// /// The type of platform of the connection. /// [JsonProperty("sourceType")] public SourceType? SourceType { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Integrations.cs b/platform/CodatPlatform/Models/Shared/Integrations.cs index 8de8d9736..6390a9c25 100755 --- a/platform/CodatPlatform/Models/Shared/Integrations.cs +++ b/platform/CodatPlatform/Models/Shared/Integrations.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Integrations { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Links.cs b/platform/CodatPlatform/Models/Shared/Links.cs index 17d4c8f9f..9ec77c653 100755 --- a/platform/CodatPlatform/Models/Shared/Links.cs +++ b/platform/CodatPlatform/Models/Shared/Links.cs @@ -12,21 +12,19 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class Links { + [JsonProperty("current")] public HalRef Current { get; set; } = default!; - + [JsonProperty("next")] public HalRef? Next { get; set; } - + [JsonProperty("previous")] public HalRef? Previous { get; set; } - + [JsonProperty("self")] public HalRef Self { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhook.cs b/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhook.cs index 5f3acc0d1..deb50f042 100755 --- a/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhook.cs @@ -12,42 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body to notify that a new company has successfully synchronized at least one dataType for the first time. /// public class NewCompanySynchronizedWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + + [JsonProperty("Data")] + public NewCompanySynchronizedWebhookData? Data { get; set; } + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhookData.cs b/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhookData.cs new file mode 100755 index 000000000..83cd30716 --- /dev/null +++ b/platform/CodatPlatform/Models/Shared/NewCompanySynchronizedWebhookData.cs @@ -0,0 +1,17 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Shared +{ + + public class NewCompanySynchronizedWebhookData + { + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Profile.cs b/platform/CodatPlatform/Models/Shared/Profile.cs index 6b940091a..36960de4b 100755 --- a/platform/CodatPlatform/Models/Shared/Profile.cs +++ b/platform/CodatPlatform/Models/Shared/Profile.cs @@ -14,38 +14,36 @@ namespace CodatPlatform.Models.Shared using System.Collections.Generic; using System; - /// /// Describes your Codat client instance /// public class Profile { + [JsonProperty("alertAuthHeader")] public string? AlertAuthHeader { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("apiKey")] public string? ApiKey { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("confirmCompanyName")] public bool? ConfirmCompanyName { get; set; } - + [JsonProperty("iconUrl")] public string? IconUrl { get; set; } - + [JsonProperty("logoUrl")] public string? LogoUrl { get; set; } - + [JsonProperty("name")] public string Name { get; set; } = default!; - + [JsonProperty("redirectUrl")] public string RedirectUrl { get; set; } = default!; - + [JsonProperty("whiteListUrls")] public List? WhiteListUrls { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PullOperation.cs b/platform/CodatPlatform/Models/Shared/PullOperation.cs index 9cfb87104..2741fd3ef 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperation.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperation.cs @@ -12,9 +12,8 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// - /// Information about a queued, in progress or completed pull operation. + /// Information about a queued, in progress or completed pull operation.<br/> /// /// /// *Formally called `dataset`* @@ -22,57 +21,56 @@ namespace CodatPlatform.Models.Shared /// public class PullOperation { + [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + [JsonProperty("connectionId")] public string ConnectionId { get; set; } = default!; - + [JsonProperty("dataType")] public string DataType { get; set; } = default!; - + [JsonProperty("id")] public string Id { get; set; } = default!; - + [JsonProperty("isCompleted")] public bool IsCompleted { get; set; } = default!; - + [JsonProperty("isErrored")] public bool IsErrored { get; set; } = default!; - + [JsonProperty("progress")] public long Progress { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("requested")] public string Requested { get; set; } = default!; - + [JsonProperty("status")] public PullOperationStatus Status { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs b/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs index fe42eb22d..3fa68e442 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs @@ -13,57 +13,56 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - public enum PullOperationStatus { - [JsonProperty("Initial")] - Initial, - [JsonProperty("Queued")] - Queued, - [JsonProperty("Fetching")] - Fetching, - [JsonProperty("MapQueued")] - MapQueued, - [JsonProperty("Mapping")] - Mapping, - [JsonProperty("Complete")] - Complete, - [JsonProperty("FetchError")] - FetchError, - [JsonProperty("MapError")] - MapError, - [JsonProperty("InternalError")] - InternalError, - [JsonProperty("ProcessingQueued")] - ProcessingQueued, - [JsonProperty("Processing")] - Processing, - [JsonProperty("ProcessingError")] - ProcessingError, - [JsonProperty("ValidationQueued")] - ValidationQueued, - [JsonProperty("Validating")] - Validating, - [JsonProperty("ValidationError")] - ValidationError, - [JsonProperty("AuthError")] - AuthError, - [JsonProperty("Cancelled")] - Cancelled, - [JsonProperty("Routing")] - Routing, - [JsonProperty("RoutingError")] - RoutingError, - [JsonProperty("NotSupported")] - NotSupported, - [JsonProperty("RateLimitError")] - RateLimitError, - [JsonProperty("PermissionsError")] - PermissionsError, - [JsonProperty("PrerequisiteNotMet")] - PrerequisiteNotMet, + [JsonProperty("Initial")] + Initial, + [JsonProperty("Queued")] + Queued, + [JsonProperty("Fetching")] + Fetching, + [JsonProperty("MapQueued")] + MapQueued, + [JsonProperty("Mapping")] + Mapping, + [JsonProperty("Complete")] + Complete, + [JsonProperty("FetchError")] + FetchError, + [JsonProperty("MapError")] + MapError, + [JsonProperty("InternalError")] + InternalError, + [JsonProperty("ProcessingQueued")] + ProcessingQueued, + [JsonProperty("Processing")] + Processing, + [JsonProperty("ProcessingError")] + ProcessingError, + [JsonProperty("ValidationQueued")] + ValidationQueued, + [JsonProperty("Validating")] + Validating, + [JsonProperty("ValidationError")] + ValidationError, + [JsonProperty("AuthError")] + AuthError, + [JsonProperty("Cancelled")] + Cancelled, + [JsonProperty("Routing")] + Routing, + [JsonProperty("RoutingError")] + RoutingError, + [JsonProperty("NotSupported")] + NotSupported, + [JsonProperty("RateLimitError")] + RateLimitError, + [JsonProperty("PermissionsError")] + PermissionsError, + [JsonProperty("PrerequisiteNotMet")] + PrerequisiteNotMet, } - + public static class PullOperationStatusExtension { public static string Value(this PullOperationStatus value) @@ -90,5 +89,4 @@ public static PullOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PullOperationStatus"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PullOperations.cs b/platform/CodatPlatform/Models/Shared/PullOperations.cs index 4caf484f5..ce98f4b1a 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperations.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperations.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PullOperations { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushChangeType.cs b/platform/CodatPlatform/Models/Shared/PushChangeType.cs index 3d3b3a0cb..7321e1bc3 100755 --- a/platform/CodatPlatform/Models/Shared/PushChangeType.cs +++ b/platform/CodatPlatform/Models/Shared/PushChangeType.cs @@ -13,21 +13,20 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - public enum PushChangeType { - [JsonProperty("Unknown")] - Unknown, - [JsonProperty("Created")] - Created, - [JsonProperty("Modified")] - Modified, - [JsonProperty("Deleted")] - Deleted, - [JsonProperty("AttachmentUploaded")] - AttachmentUploaded, + [JsonProperty("Unknown")] + Unknown, + [JsonProperty("Created")] + Created, + [JsonProperty("Modified")] + Modified, + [JsonProperty("Deleted")] + Deleted, + [JsonProperty("AttachmentUploaded")] + AttachmentUploaded, } - + public static class PushChangeTypeExtension { public static string Value(this PushChangeType value) @@ -54,5 +53,4 @@ public static PushChangeType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushChangeType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs b/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs index efbe4f023..7f6495472 100755 --- a/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs +++ b/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushFieldValidation { + [JsonProperty("details")] public string Details { get; set; } = default!; - + [JsonProperty("field")] public string? Field { get; set; } - + [JsonProperty("ref")] public string? Ref { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperation.cs b/platform/CodatPlatform/Models/Shared/PushOperation.cs index c480f2386..725949099 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperation.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperation.cs @@ -14,118 +14,116 @@ namespace CodatPlatform.Models.Shared using System.Collections.Generic; using System; - public class PushOperation { + /// /// Contains a single entry that communicates which record has changed and the manner in which it changed. /// [JsonProperty("changes")] public List? Changes { get; set; } - + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("completedOnUtc")] public string? CompletedOnUtc { get; set; } - + /// - /// Unique identifier for a company's data connection. + /// Unique identifier for a company&apos;s data connection. /// [JsonProperty("dataConnectionKey")] public string DataConnectionKey { get; set; } = default!; - + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } - + /// /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string PushOperationKey { get; set; } = default!; - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("requestedOnUtc")] public string RequestedOnUtc { get; set; } = default!; - + /// - /// The status of the push operation. + /// The current status of the push operation. /// [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; - + [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; - + [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } - + [Obsolete("This field will be removed in a future release, please migrate away from it as soon as possible")] [JsonProperty("timeoutInSeconds")] public int? TimeoutInSeconds { get; set; } - + /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// [JsonProperty("validation")] public Validation? Validation { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationChange.cs b/platform/CodatPlatform/Models/Shared/PushOperationChange.cs index 18e3107ba..da8245076 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationChange.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationChange.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushOperationChange { + [JsonProperty("attachmentId")] public string? AttachmentId { get; set; } - + [JsonProperty("recordRef")] public PushOperationRef? RecordRef { get; set; } - + [JsonProperty("type")] public PushChangeType? Type { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationRef.cs b/platform/CodatPlatform/Models/Shared/PushOperationRef.cs index 3e829a476..21ba133b3 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationRef.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationRef.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushOperationRef { + /// /// Available Data types /// [JsonProperty("dataType")] public DataType? DataType { get; set; } - + [JsonProperty("id")] public string? Id { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs b/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs index 122780066..35ea01824 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs @@ -13,22 +13,21 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - /// - /// The status of the push operation. + /// The current status of the push operation. /// public enum PushOperationStatus { - [JsonProperty("Pending")] - Pending, - [JsonProperty("Failed")] - Failed, - [JsonProperty("Success")] - Success, - [JsonProperty("TimedOut")] - TimedOut, + [JsonProperty("Pending")] + Pending, + [JsonProperty("Failed")] + Failed, + [JsonProperty("Success")] + Success, + [JsonProperty("TimedOut")] + TimedOut, } - + public static class PushOperationStatusExtension { public static string Value(this PushOperationStatus value) @@ -55,5 +54,4 @@ public static PushOperationStatus ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOperationStatus"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhook.cs b/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhook.cs index 2eeabeb00..d0c5c8f86 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhook.cs @@ -12,45 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body for a push operation status change. /// public class PushOperationStatusChangedWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + [JsonProperty("Data")] public PushOperationStatusChangedWebhookData? Data { get; set; } - + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs b/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs index 30073b38a..aff6c3b64 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs @@ -12,27 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushOperationStatusChangedWebhookData { + /// - /// Data type used in the push operation. + /// Available Data types /// [JsonProperty("dataType")] - public string? DataType { get; set; } - + public DataType? DataType { get; set; } + /// - /// Unique identifier for the push operation. + /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string? PushOperationKey { get; set; } - + /// /// The current status of the push operation. /// [JsonProperty("status")] - public string? Status { get; set; } - + public PushOperationStatus? Status { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhook.cs b/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhook.cs index ef0d9f728..5eade5d6e 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhook.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhook.cs @@ -12,45 +12,61 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Webhook request body notifying that a push push operation has timed out. /// public class PushOperationTimedOutWebhook { + /// /// Unique identifier of the webhook event. /// [JsonProperty("AlertId")] public string? AlertId { get; set; } - + + /// + /// Unique identifier for your client in Codat. + /// + [JsonProperty("ClientId")] + public string? ClientId { get; set; } + + /// + /// Name of your client in Codat. + /// + [JsonProperty("ClientName")] + public string? ClientName { get; set; } + /// /// Unique identifier for your SMB in Codat. /// [JsonProperty("CompanyId")] public string? CompanyId { get; set; } - + [JsonProperty("Data")] public PushOperationTimedOutWebhookData? Data { get; set; } - + + /// + /// Unique identifier for a company&apos;s data connection. + /// + [JsonProperty("DataConnectionId")] + public string? DataConnectionId { get; set; } + /// /// A human readable message about the webhook. /// [JsonProperty("Message")] public string? Message { get; set; } - + /// /// Unique identifier for the rule. /// [JsonProperty("RuleId")] public string? RuleId { get; set; } - + /// /// The type of rule. /// - [JsonProperty("Type")] - public string? Type { get; set; } - + [JsonProperty("RuleType")] + public string? RuleType { get; set; } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs b/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs index e35f9d44e..d163e7b2a 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs @@ -12,21 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushOperationTimedOutWebhookData { + /// - /// Data type used in the push operation. + /// Available Data types /// [JsonProperty("dataType")] - public string? DataType { get; set; } - + public DataType? DataType { get; set; } + /// - /// Unique identifier for the push operation. + /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. + /// + [JsonProperty("pushOperationGuid")] + public string? PushOperationGuid { get; set; } + + /// + /// A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. /// [JsonProperty("pushOperationKey")] public string? PushOperationKey { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOperations.cs b/platform/CodatPlatform/Models/Shared/PushOperations.cs index 79fa40386..02bd70250 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperations.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperations.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOperations { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOption.cs b/platform/CodatPlatform/Models/Shared/PushOption.cs index cd3b6a495..40e0dac19 100755 --- a/platform/CodatPlatform/Models/Shared/PushOption.cs +++ b/platform/CodatPlatform/Models/Shared/PushOption.cs @@ -13,30 +13,28 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOption { + [JsonProperty("description")] public string? Description { get; set; } - + [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; - + [JsonProperty("options")] public List? Options { get; set; } - + [JsonProperty("properties")] public Dictionary? Properties { get; set; } - + [JsonProperty("required")] public bool Required { get; set; } = default!; - + [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; - + [JsonProperty("validation")] public PushValidationInfo? Validation { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs b/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs index bf8e2b3d6..f42bfa3f0 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs @@ -12,27 +12,25 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class PushOptionChoice { + [JsonProperty("description")] public string? Description { get; set; } - + [JsonProperty("displayName")] public string? DisplayName { get; set; } - + [JsonProperty("required")] public bool? Required { get; set; } - + [JsonProperty("type")] public PushOptionType? Type { get; set; } - + /// /// Allowed value for field. /// [JsonProperty("value")] public string? Value { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs b/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs index 2983984b4..739c328c2 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs @@ -13,30 +13,28 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushOptionProperty { + [JsonProperty("description")] public string Description { get; set; } = default!; - + [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; - + [JsonProperty("options")] public List? Options { get; set; } - + [JsonProperty("properties")] public Dictionary? Properties { get; set; } - + [JsonProperty("required")] public bool Required { get; set; } = default!; - + [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; - + [JsonProperty("validation")] public PushValidationInfo? Validation { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushOptionType.cs b/platform/CodatPlatform/Models/Shared/PushOptionType.cs index 02d5559dc..b24ce8ca2 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionType.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionType.cs @@ -13,27 +13,26 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - public enum PushOptionType { - [JsonProperty("Array")] - Array, - [JsonProperty("Object")] - Object, - [JsonProperty("String")] - String, - [JsonProperty("Number")] - Number, - [JsonProperty("Boolean")] - Boolean, - [JsonProperty("DateTime")] - DateTime, - [JsonProperty("File")] - File, - [JsonProperty("MultiPart")] - MultiPart, + [JsonProperty("Array")] + Array, + [JsonProperty("Object")] + Object, + [JsonProperty("String")] + String, + [JsonProperty("Number")] + Number, + [JsonProperty("Boolean")] + Boolean, + [JsonProperty("DateTime")] + DateTime, + [JsonProperty("File")] + File, + [JsonProperty("MultiPart")] + MultiPart, } - + public static class PushOptionTypeExtension { public static string Value(this PushOptionType value) @@ -60,5 +59,4 @@ public static PushOptionType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum PushOptionType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/PushValidationInfo.cs b/platform/CodatPlatform/Models/Shared/PushValidationInfo.cs index 1cd86935c..942d96594 100755 --- a/platform/CodatPlatform/Models/Shared/PushValidationInfo.cs +++ b/platform/CodatPlatform/Models/Shared/PushValidationInfo.cs @@ -13,15 +13,13 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class PushValidationInfo { + [JsonProperty("information")] public List? Information { get; set; } - + [JsonProperty("warnings")] public List? Warnings { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Security.cs b/platform/CodatPlatform/Models/Shared/Security.cs index d87d42b60..d598cf04f 100755 --- a/platform/CodatPlatform/Models/Shared/Security.cs +++ b/platform/CodatPlatform/Models/Shared/Security.cs @@ -12,12 +12,10 @@ namespace CodatPlatform.Models.Shared { using CodatPlatform.Utils; - public class Security { + [SpeakeasyMetadata("security:scheme=true,type=apiKey,subType=header,name=Authorization")] public string AuthHeader { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SourceType.cs b/platform/CodatPlatform/Models/Shared/SourceType.cs index 3c5384d72..174279514 100755 --- a/platform/CodatPlatform/Models/Shared/SourceType.cs +++ b/platform/CodatPlatform/Models/Shared/SourceType.cs @@ -13,24 +13,23 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - /// /// The type of platform of the connection. /// public enum SourceType { - [JsonProperty("Accounting")] - Accounting, - [JsonProperty("Banking")] - Banking, - [JsonProperty("Commerce")] - Commerce, - [JsonProperty("Other")] - Other, - [JsonProperty("Unknown")] - Unknown, + [JsonProperty("Accounting")] + Accounting, + [JsonProperty("Banking")] + Banking, + [JsonProperty("Commerce")] + Commerce, + [JsonProperty("Other")] + Other, + [JsonProperty("Unknown")] + Unknown, } - + public static class SourceTypeExtension { public static string Value(this SourceType value) @@ -57,5 +56,4 @@ public static SourceType ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SourceType"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SupplementalDataConfiguration.cs b/platform/CodatPlatform/Models/Shared/SupplementalDataConfiguration.cs index 30872c714..d59579a4f 100755 --- a/platform/CodatPlatform/Models/Shared/SupplementalDataConfiguration.cs +++ b/platform/CodatPlatform/Models/Shared/SupplementalDataConfiguration.cs @@ -13,12 +13,10 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class SupplementalDataConfiguration { + [JsonProperty("supplementalDataConfig")] public Dictionary? SupplementalDataConfig { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.cs b/platform/CodatPlatform/Models/Shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.cs index 9f05a20a7..500729f5b 100755 --- a/platform/CodatPlatform/Models/Shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.cs +++ b/platform/CodatPlatform/Models/Shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.cs @@ -13,30 +13,28 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// - /// The client's defined name for the object. + /// The client&apos;s defined name for the object. /// public class SupplementalDataConfigurationSupplementalDataSourceConfiguration { + /// /// The underlying endpoint of the source system which the configuration is targeting. /// [JsonProperty("dataSource")] public string? DataSource { get; set; } - + /// /// The additional properties that are required when pulling records. /// [JsonProperty("pullData")] public Dictionary? PullData { get; set; } - + /// /// The additional properties that are required to create and/or update records. /// [JsonProperty("pushData")] public Dictionary? PushData { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SupportedFeature.cs b/platform/CodatPlatform/Models/Shared/SupportedFeature.cs index 67b0a976a..4a61f3ca2 100755 --- a/platform/CodatPlatform/Models/Shared/SupportedFeature.cs +++ b/platform/CodatPlatform/Models/Shared/SupportedFeature.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class SupportedFeature { + [JsonProperty("featureState")] public FeatureState FeatureState { get; set; } = default!; - + [JsonProperty("featureType")] public FeatureType FeatureType { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SyncSetting.cs b/platform/CodatPlatform/Models/Shared/SyncSetting.cs index 0d37932da..6aacaa49d 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSetting.cs +++ b/platform/CodatPlatform/Models/Shared/SyncSetting.cs @@ -12,75 +12,73 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued. /// public class SyncSetting { + /// /// Available Data types /// [JsonProperty("dataType")] public SyncSettingDataTypes DataType { get; set; } = default!; - + /// /// Whether this data type should be queued after a company has authorized a connection. /// [JsonProperty("fetchOnFirstLink")] public bool FetchOnFirstLink { get; set; } = default!; - + [JsonProperty("isLocked")] public bool? IsLocked { get; set; } - + /// - /// Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only. + /// Months of data to fetch, for report data types (`balanceSheet` &amp; `profitAndLoss`) only. /// [JsonProperty("monthsToSync")] public long? MonthsToSync { get; set; } - + /// - /// In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + /// In Codat&apos;s data model, dates and times are represented using the &lt;a class=&quot;external&quot; href=&quot;https://en.wikipedia.org/wiki/ISO_8601&quot; target=&quot;_blank&quot;&gt;ISO 8601 standard&lt;/a&gt;. Date and time fields are formatted as strings; for example:<br/> /// /// - /// - /// ``` - /// 2020-10-08T22:40:50Z - /// 2021-01-01T00:00:00 - /// ``` - /// - /// - /// - /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - /// - /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - /// - Unqualified local time: `2021-11-15T01:00:00` - /// - UTC time offsets: `2021-11-15T01:00:00-05:00` - /// - /// > Time zones - /// > - /// > Not all dates from Codat will contain information about time zones. - /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + ///
+ /// ```
+ /// 2020-10-08T22:40:50Z
+ /// 2021-01-01T00:00:00
+ /// ```
+ ///
+ ///
+ ///
+ /// When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+ ///
+ /// - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+ /// - Unqualified local time: `2021-11-15T01:00:00`
+ /// - UTC time offsets: `2021-11-15T01:00:00-05:00`
+ ///
+ /// > Time zones
+ /// >
+ /// > Not all dates from Codat will contain information about time zones.
+ /// > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. ///
///
[JsonProperty("syncFromUtc")] public string? SyncFromUtc { get; set; } - + /// /// Number of months of data to be fetched. Set this *or* `syncFromUTC` /// [JsonProperty("syncFromWindow")] public long? SyncFromWindow { get; set; } - + [JsonProperty("syncOrder")] public long SyncOrder { get; set; } = default!; - + /// /// Number of hours after which this data type should be refreshed. /// [JsonProperty("syncSchedule")] public long SyncSchedule { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs b/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs index 353de2f13..1f9b8f769 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs +++ b/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs @@ -13,98 +13,97 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; - /// /// Available Data types /// public enum SyncSettingDataTypes { - [JsonProperty("accountTransactions")] - AccountTransactions, - [JsonProperty("balanceSheet")] - BalanceSheet, - [JsonProperty("bankAccounts")] - BankAccounts, - [JsonProperty("bankTransactions")] - BankTransactions, - [JsonProperty("billCreditNotes")] - BillCreditNotes, - [JsonProperty("billPayments")] - BillPayments, - [JsonProperty("bills")] - Bills, - [JsonProperty("cashFlowStatement")] - CashFlowStatement, - [JsonProperty("chartOfAccounts")] - ChartOfAccounts, - [JsonProperty("company")] - Company, - [JsonProperty("creditNotes")] - CreditNotes, - [JsonProperty("customers")] - Customers, - [JsonProperty("directCosts")] - DirectCosts, - [JsonProperty("directIncomes")] - DirectIncomes, - [JsonProperty("invoices")] - Invoices, - [JsonProperty("items")] - Items, - [JsonProperty("journalEntries")] - JournalEntries, - [JsonProperty("journals")] - Journals, - [JsonProperty("paymentMethods")] - PaymentMethods, - [JsonProperty("payments")] - Payments, - [JsonProperty("profitAndLoss")] - ProfitAndLoss, - [JsonProperty("purchaseOrders")] - PurchaseOrders, - [JsonProperty("salesOrders")] - SalesOrders, - [JsonProperty("suppliers")] - Suppliers, - [JsonProperty("taxRates")] - TaxRates, - [JsonProperty("trackingCategories")] - TrackingCategories, - [JsonProperty("transfers")] - Transfers, - [JsonProperty("banking-accountBalances")] - BankingAccountBalances, - [JsonProperty("banking-accounts")] - BankingAccounts, - [JsonProperty("banking-transactionCategories")] - BankingTransactionCategories, - [JsonProperty("banking-transactions")] - BankingTransactions, - [JsonProperty("commerce-companyInfo")] - CommerceCompanyInfo, - [JsonProperty("commerce-customers")] - CommerceCustomers, - [JsonProperty("commerce-disputes")] - CommerceDisputes, - [JsonProperty("commerce-locations")] - CommerceLocations, - [JsonProperty("commerce-orders")] - CommerceOrders, - [JsonProperty("commerce-paymentMethods")] - CommercePaymentMethods, - [JsonProperty("commerce-payments")] - CommercePayments, - [JsonProperty("commerce-productCategories")] - CommerceProductCategories, - [JsonProperty("commerce-products")] - CommerceProducts, - [JsonProperty("commerce-taxComponents")] - CommerceTaxComponents, - [JsonProperty("commerce-transactions")] - CommerceTransactions, + [JsonProperty("accountTransactions")] + AccountTransactions, + [JsonProperty("balanceSheet")] + BalanceSheet, + [JsonProperty("bankAccounts")] + BankAccounts, + [JsonProperty("bankTransactions")] + BankTransactions, + [JsonProperty("billCreditNotes")] + BillCreditNotes, + [JsonProperty("billPayments")] + BillPayments, + [JsonProperty("bills")] + Bills, + [JsonProperty("cashFlowStatement")] + CashFlowStatement, + [JsonProperty("chartOfAccounts")] + ChartOfAccounts, + [JsonProperty("company")] + Company, + [JsonProperty("creditNotes")] + CreditNotes, + [JsonProperty("customers")] + Customers, + [JsonProperty("directCosts")] + DirectCosts, + [JsonProperty("directIncomes")] + DirectIncomes, + [JsonProperty("invoices")] + Invoices, + [JsonProperty("items")] + Items, + [JsonProperty("journalEntries")] + JournalEntries, + [JsonProperty("journals")] + Journals, + [JsonProperty("paymentMethods")] + PaymentMethods, + [JsonProperty("payments")] + Payments, + [JsonProperty("profitAndLoss")] + ProfitAndLoss, + [JsonProperty("purchaseOrders")] + PurchaseOrders, + [JsonProperty("salesOrders")] + SalesOrders, + [JsonProperty("suppliers")] + Suppliers, + [JsonProperty("taxRates")] + TaxRates, + [JsonProperty("trackingCategories")] + TrackingCategories, + [JsonProperty("transfers")] + Transfers, + [JsonProperty("banking-accountBalances")] + BankingAccountBalances, + [JsonProperty("banking-accounts")] + BankingAccounts, + [JsonProperty("banking-transactionCategories")] + BankingTransactionCategories, + [JsonProperty("banking-transactions")] + BankingTransactions, + [JsonProperty("commerce-companyInfo")] + CommerceCompanyInfo, + [JsonProperty("commerce-customers")] + CommerceCustomers, + [JsonProperty("commerce-disputes")] + CommerceDisputes, + [JsonProperty("commerce-locations")] + CommerceLocations, + [JsonProperty("commerce-orders")] + CommerceOrders, + [JsonProperty("commerce-paymentMethods")] + CommercePaymentMethods, + [JsonProperty("commerce-payments")] + CommercePayments, + [JsonProperty("commerce-productCategories")] + CommerceProductCategories, + [JsonProperty("commerce-products")] + CommerceProducts, + [JsonProperty("commerce-taxComponents")] + CommerceTaxComponents, + [JsonProperty("commerce-transactions")] + CommerceTransactions, } - + public static class SyncSettingDataTypesExtension { public static string Value(this SyncSettingDataTypes value) @@ -131,5 +130,4 @@ public static SyncSettingDataTypes ToEnum(this string value) throw new Exception($"Unknown value {value} for enum SyncSettingDataTypes"); } } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/SyncSettings.cs b/platform/CodatPlatform/Models/Shared/SyncSettings.cs index 4a52ff8df..9a18798e5 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSettings.cs +++ b/platform/CodatPlatform/Models/Shared/SyncSettings.cs @@ -13,18 +13,16 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class SyncSettings { + [JsonProperty("clientId")] public string? ClientId { get; set; } - + [JsonProperty("overridesDefaults")] public bool? OverridesDefaults { get; set; } - + [JsonProperty("settings")] public List? Settings { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/UpdateConnectionStatus.cs b/platform/CodatPlatform/Models/Shared/UpdateConnectionStatus.cs index 96275eda1..576732ee5 100755 --- a/platform/CodatPlatform/Models/Shared/UpdateConnectionStatus.cs +++ b/platform/CodatPlatform/Models/Shared/UpdateConnectionStatus.cs @@ -12,15 +12,13 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class UpdateConnectionStatus { + /// /// The current authorization status of the data connection. /// [JsonProperty("status")] public DataConnectionStatus? Status { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Validation.cs b/platform/CodatPlatform/Models/Shared/Validation.cs index feaf26988..26b266c78 100755 --- a/platform/CodatPlatform/Models/Shared/Validation.cs +++ b/platform/CodatPlatform/Models/Shared/Validation.cs @@ -13,18 +13,16 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - /// /// A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. /// public class Validation { + [JsonProperty("errors")] public List? Errors { get; set; } - + [JsonProperty("warnings")] public List? Warnings { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/ValidationItem.cs b/platform/CodatPlatform/Models/Shared/ValidationItem.cs index e84102d74..8e0effd49 100755 --- a/platform/CodatPlatform/Models/Shared/ValidationItem.cs +++ b/platform/CodatPlatform/Models/Shared/ValidationItem.cs @@ -12,18 +12,16 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - public class ValidationItem { + [JsonProperty("itemId")] public string? ItemId { get; set; } - + [JsonProperty("message")] public string? Message { get; set; } - + [JsonProperty("validatorName")] public string? ValidatorName { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Webhook.cs b/platform/CodatPlatform/Models/Shared/Webhook.cs index 225706613..77f9cdc96 100755 --- a/platform/CodatPlatform/Models/Shared/Webhook.cs +++ b/platform/CodatPlatform/Models/Shared/Webhook.cs @@ -12,24 +12,22 @@ namespace CodatPlatform.Models.Shared { using Newtonsoft.Json; - /// /// Create an event notification to a URL or list of email addresses based on the given type or condition. /// public class Webhook { + [JsonProperty("companyId")] public string? CompanyId { get; set; } - + [JsonProperty("id")] public string? Id { get; set; } - + [JsonProperty("notifiers")] public WebhookNotifiers Notifiers { get; set; } = default!; - + [JsonProperty("type")] public string Type { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs b/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs index 696b7bd01..6753947d2 100755 --- a/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs +++ b/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs @@ -13,15 +13,13 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class WebhookNotifiers { + [JsonProperty("emails")] public List? Emails { get; set; } - + [JsonProperty("webhook")] public string? Webhook { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/Webhooks.cs b/platform/CodatPlatform/Models/Shared/Webhooks.cs index 9df17a386..a26573dc3 100755 --- a/platform/CodatPlatform/Models/Shared/Webhooks.cs +++ b/platform/CodatPlatform/Models/Shared/Webhooks.cs @@ -13,24 +13,22 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class Webhooks { + [JsonProperty("_links")] public Links Links { get; set; } = default!; - + [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; - + [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; - + [JsonProperty("results")] public List? Results { get; set; } - + [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs new file mode 100755 index 000000000..2bbbcda35 --- /dev/null +++ b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Webhooks +{ + using System.Net.Http; + using System; + + public class ClientRateLimitReachedResponse + { + + public string? ContentType { get; set; } = default!; + + public int StatusCode { get; set; } = default!; + + public HttpResponseMessage? RawResponse { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs new file mode 100755 index 000000000..e51a11899 --- /dev/null +++ b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs @@ -0,0 +1,25 @@ + +//------------------------------------------------------------------------------ +// +// This code was generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT. +// +// Changes to this file may cause incorrect behavior and will be lost when +// the code is regenerated. +// +//------------------------------------------------------------------------------ +#nullable enable +namespace CodatPlatform.Models.Webhooks +{ + using System.Net.Http; + using System; + + public class ClientRateLimitResetResponse + { + + public string? ContentType { get; set; } = default!; + + public int StatusCode { get; set; } = default!; + + public HttpResponseMessage? RawResponse { get; set; } + } +} \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs b/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs index 874c5219a..4fabb0e8f 100755 --- a/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class CompanyDataConnectionStatusChangedResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs b/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs index bd68b8a0f..3237db3f0 100755 --- a/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class DataSyncCompletedResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs b/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs index d3b62c2ae..a4cc6f233 100755 --- a/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class DatasetDataChangedResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs b/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs index 7dcc1625d..54e4426e3 100755 --- a/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class DatasetStatusHasChangedToAnErrorStateResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs b/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs index bad67e6da..592a68696 100755 --- a/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class NewCompanySynchronizedResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs b/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs index 602d05b2d..a83fe7f26 100755 --- a/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class PushOperationHasTimedOutResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs b/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs index c797c3ab2..0bdecca11 100755 --- a/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs @@ -13,18 +13,13 @@ namespace CodatPlatform.Models.Webhooks using System.Net.Http; using System; - public class PushOperationStatusHasChangedResponse { - + public string? ContentType { get; set; } = default!; - - + public int StatusCode { get; set; } = default!; - - + public HttpResponseMessage? RawResponse { get; set; } - } - } \ No newline at end of file diff --git a/platform/CodatPlatform/PushData.cs b/platform/CodatPlatform/PushData.cs index 6b4e927a2..38a180136 100755 --- a/platform/CodatPlatform/PushData.cs +++ b/platform/CodatPlatform/PushData.cs @@ -19,22 +19,55 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// View push options and get push statuses. + /// public interface IPushDataSDK { + + /// + /// Get push options + /// + /// + /// This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information.
+ ///
+ /// Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting packages. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear.
+ ///
+ /// Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field.
+ ///
+ ///
+ /// > **Supported Integrations**
+ /// >
+ /// > Check out our coverage explorer for integrations that support push (POST/PUT methods). + ///
+ ///
Task GetModelOptionsAsync(GetCreateUpdateModelOptionsByDataTypeRequest? request = null); + + /// + /// Get push operation + /// + /// + /// Retrieve push operation. + /// + /// Task GetOperationAsync(GetPushOperationRequest? request = null); + + /// + /// List push operations + /// + /// + /// List push operation records. + /// + /// Task ListOperationsAsync(GetCompanyPushHistoryRequest? request = null); } - /// - /// View push options and get push statuses. - /// public class PushDataSDK: IPushDataSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -49,22 +82,6 @@ public PushDataSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Get push options - /// - /// - /// This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. - /// - /// Before pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting packages. A good example of this is specifying where on the balance sheet/profit and loss reports the user would like a newly-created nominal account to appear. - /// - /// Codat tries not to limit users to pushing to a very limited number of standard categories, so we have implemented "options" endpoints, which allow us to expose to our clients the fields which are required to be pushed for a specific linked company, and the options which may be selected for each field. - /// - /// - /// > **Supported Integrations** - /// > - /// > Check out our [coverage explorer](https://knowledge.codat.io/) for integrations that support push (POST/PUT methods). - /// - /// public async Task GetModelOptionsAsync(GetCreateUpdateModelOptionsByDataTypeRequest? request = null) { string baseUrl = _serverUrl; @@ -113,13 +130,6 @@ public async Task GetModelOptions } - /// - /// Get push operation - /// - /// - /// Retrieve push operation. - /// - /// public async Task GetOperationAsync(GetPushOperationRequest? request = null) { string baseUrl = _serverUrl; @@ -168,13 +178,6 @@ public async Task GetOperationAsync(GetPushOperationRe } - /// - /// List push operations - /// - /// - /// List push operation records. - /// - /// public async Task ListOperationsAsync(GetCompanyPushHistoryRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/RefreshData.cs b/platform/CodatPlatform/RefreshData.cs index 9018779e3..e7f9fb1c9 100755 --- a/platform/CodatPlatform/RefreshData.cs +++ b/platform/CodatPlatform/RefreshData.cs @@ -20,24 +20,70 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Asynchronously retrieve data from an integration to refresh data in Codat. + /// public interface IRefreshDataSDK { + + /// + /// Refresh all data + /// + /// + /// Refreshes all data types with `fetch on first link` set to `true` for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view.
+ ///
+ /// Read more about data type settings and `fetch on first link`. + ///
+ ///
Task AllAsync(RefreshCompanyDataRequest? request = null); + + /// + /// Refresh data type + /// + /// + /// Refreshes a given data type for a given company.
+ ///
+ /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + ///
+ ///
Task ByDataTypeAsync(RefreshDataTypeRequest? request = null); + + /// + /// Get data status + /// + /// + /// Get the state of each data type for a company + /// + /// Task GetAsync(GetCompanyDataStatusRequest? request = null); + + /// + /// Get pull operation + /// + /// + /// Retrieve information about a single dataset or pull operation. + /// + /// Task GetPullOperationAsync(GetPullOperationRequest? request = null); + + /// + /// List pull operations + /// + /// + /// Gets the pull operation history (datasets) for a given company. + /// + /// Task ListPullOperationsAsync(ListPullOperationsRequest? request = null); } - /// - /// Asynchronously retrieve data from an integration to refresh data in Codat. - /// public class RefreshDataSDK: IRefreshDataSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -52,17 +98,6 @@ public RefreshDataSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient s } - /// - /// Refresh all data - /// - /// - /// Refreshes all data types with `fetch on first link` set to `true` for a given company. - /// - /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. - /// - /// [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. - /// - /// public async Task AllAsync(RefreshCompanyDataRequest? request = null) { string baseUrl = _serverUrl; @@ -107,15 +142,6 @@ public async Task AllAsync(RefreshCompanyDataRequest } - /// - /// Refresh data type - /// - /// - /// Refreshes a given data type for a given company. - /// - /// This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. - /// - /// public async Task ByDataTypeAsync(RefreshDataTypeRequest? request = null) { string baseUrl = _serverUrl; @@ -164,13 +190,6 @@ public async Task ByDataTypeAsync(RefreshDataTypeReques } - /// - /// Get data status - /// - /// - /// Get the state of each data type for a company - /// - /// public async Task GetAsync(GetCompanyDataStatusRequest? request = null) { string baseUrl = _serverUrl; @@ -219,13 +238,6 @@ public async Task GetAsync(GetCompanyDataStatusReq } - /// - /// Get pull operation - /// - /// - /// Retrieve information about a single dataset or pull operation. - /// - /// public async Task GetPullOperationAsync(GetPullOperationRequest? request = null) { string baseUrl = _serverUrl; @@ -274,13 +286,6 @@ public async Task GetPullOperationAsync(GetPullOperati } - /// - /// List pull operations - /// - /// - /// Gets the pull operation history (datasets) for a given company. - /// - /// public async Task ListPullOperationsAsync(ListPullOperationsRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/Settings.cs b/platform/CodatPlatform/Settings.cs index ffd9e0d26..2a0d1d310 100755 --- a/platform/CodatPlatform/Settings.cs +++ b/platform/CodatPlatform/Settings.cs @@ -19,26 +19,105 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Manage your Codat instance. + /// public interface ISettingsSDK { + + /// + /// Create API key + /// + /// + /// Use the *Create API keys* endpoint to generate a new API key for your client.
+ ///
+ /// API keys are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+ ///
+ /// You can read more about authentication at Codat and managing API keys via the Portal UI or API.
+ ///
+ /// ### Tips and pitfalls
+ ///
+ /// * Your first API key is created for you. Access this key via Codat's Portal.
+ /// * If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint.
+ /// * The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first. + ///
+ ///
Task CreateApiKeyAsync(CreateApiKey? request = null); + + /// + /// Delete api key + /// + /// + /// Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible.
+ ///
+ /// API keys are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+ ///
+ /// You can read more about authentication at Codat and managing API keys via the Portal UI or API.
+ ///
+ /// ### Tips and pitfalls
+ ///
+ /// * It is possible to delete the last remaining API key. If this happens, a new key can be created via the API key management page of the Portal.
+ /// * It is possible to delete the API key used to authenticate the *Delete API key* request. + ///
+ ///
Task DeleteApiKeyAsync(DeleteApiKeyRequest? request = null); + + /// + /// Get profile + /// + /// + /// Fetch your Codat profile. + /// + /// Task GetProfileAsync(); + + /// + /// Get sync settings + /// + /// + /// Retrieve the sync settings for your client. This includes how often data types should be queued to be updated, and how much history should be fetched. + /// + /// Task GetSyncSettingsAsync(); + + /// + /// List API keys + /// + /// + /// Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint.
+ ///
+ /// API keys are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key.
+ ///
+ /// You can read more about authentication at Codat and managing API keys via the Portal UI or API. + ///
+ ///
Task ListApiKeysAsync(); + + /// + /// Update profile + /// + /// + /// Update your Codat profile + /// + /// Task UpdateProfileAsync(Profile? request = null); + + /// + /// Update all sync settings + /// + /// + /// Update sync settings for all data types. + /// + /// Task UpdateSyncSettingsAsync(UpdateProfileSyncSettingsRequestBody? request = null); } - /// - /// Manage your Codat instance. - /// public class SettingsSDK: ISettingsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -53,23 +132,6 @@ public SettingsSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Create API key - /// - /// - /// Use the *Create API keys* endpoint to generate a new API key for your client. - /// - /// [API keys](https://docs.codat.io/codat-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - /// - /// You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - /// - /// ### Tips and pitfalls - /// - /// * Your first API key is created for you. Access this key via [Codat's Portal](https://app.codat.io/developers/api-keys). - /// * If you require multiple API keys, perform multiple calls to the *Create API keys* endpoint. - /// * The number of API keys is limited to 10. If you have reached the maximum amount of keys, use the *Delete API key* endpoint to delete an unused key first. - /// - /// public async Task CreateApiKeyAsync(CreateApiKey? request = null) { string baseUrl = _serverUrl; @@ -123,22 +185,6 @@ public async Task CreateApiKeyAsync(CreateApiKey? request } - /// - /// Delete api key - /// - /// - /// Use the *Delete API keys* endpoint to delete an existing API key, providing its valid `id` as a parameter. Note that this operation is not reversible. - /// - /// [API keys](https://docs.codat.io/accounting-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - /// - /// You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - /// - /// ### Tips and pitfalls - /// - /// * It is possible to delete the last remaining API key. If this happens, a new key can be created via the [API key management page](https://app.codat.io/developers/api-keys) of the Portal. - /// * It is possible to delete the API key used to authenticate the *Delete API key* request. - /// - /// public async Task DeleteApiKeyAsync(DeleteApiKeyRequest? request = null) { string baseUrl = _serverUrl; @@ -183,13 +229,6 @@ public async Task DeleteApiKeyAsync(DeleteApiKeyRequest? r } - /// - /// Get profile - /// - /// - /// Fetch your Codat profile. - /// - /// [Obsolete("This method will be removed in a future release, please migrate away from it as soon as possible")] public async Task GetProfileAsync() { @@ -239,13 +278,6 @@ public async Task GetProfileAsync() } - /// - /// Get sync settings - /// - /// - /// Retrieve the sync settings for your client. This includes how often data types should be queued to be updated, and how much history should be fetched. - /// - /// public async Task GetSyncSettingsAsync() { string baseUrl = _serverUrl; @@ -294,17 +326,6 @@ public async Task GetSyncSettingsAsync() } - /// - /// List API keys - /// - /// - /// Use the *List API keys* endpoint to return a list of all API keys that currently exist for your client. This includes keys created via the Portal UI or the *Create API keys* endpoint. - /// - /// [API keys](https://docs.codat.io/accounting-api#/schemas/apiKeys) are tokens used to control access to the API. Include this token in the `Authorization` header parameter when making API calls, following the word "Basic" and a space with your API key. - /// - /// You can [read more](https://docs.codat.io/using-the-api/authentication) about authentication at Codat and managing API keys via the Portal UI or API. - /// - /// public async Task ListApiKeysAsync() { string baseUrl = _serverUrl; @@ -353,13 +374,6 @@ public async Task ListApiKeysAsync() } - /// - /// Update profile - /// - /// - /// Update your Codat profile - /// - /// public async Task UpdateProfileAsync(Profile? request = null) { string baseUrl = _serverUrl; @@ -413,13 +427,6 @@ public async Task UpdateProfileAsync(Profile? request = n } - /// - /// Update all sync settings - /// - /// - /// Update sync settings for all data types. - /// - /// public async Task UpdateSyncSettingsAsync(UpdateProfileSyncSettingsRequestBody? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/SupplementalData.cs b/platform/CodatPlatform/SupplementalData.cs index 9a50e9ee2..4a6fd5942 100755 --- a/platform/CodatPlatform/SupplementalData.cs +++ b/platform/CodatPlatform/SupplementalData.cs @@ -19,21 +19,44 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// View and configure supplemental data for supported data types. + /// public interface ISupplementalDataSDK { + + /// + /// Configure + /// + /// + /// The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination.
+ ///
+ /// Supplemental data is additional data you can include in Codat's standard data types.
+ ///
+ /// **Integration-specific behaviour**
+ /// See the *examples* for integration-specific frequently requested properties. + ///
+ ///
Task ConfigureAsync(ConfigureSupplementalDataRequest? request = null); + + /// + /// Get configuration + /// + /// + /// The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination.
+ ///
+ /// Supplemental data is additional data you can include in Codat's standard data types. + ///
+ ///
Task GetConfigurationAsync(GetSupplementalDataConfigurationRequest? request = null); } - /// - /// View and configure supplemental data for supported data types. - /// public class SupplementalDataSDK: ISupplementalDataSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -48,18 +71,6 @@ public SupplementalDataSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpCli } - /// - /// Configure - /// - /// - /// The *Configure* endpoint allows you to maintain or change configuration required to return supplemental data for each integration and data type combination. - /// - /// [Supplemental data](https://docs.codat.io/using-the-api/additional-data) is additional data you can include in Codat's standard data types. - /// - /// **Integration-specific behaviour** - /// See the *examples* for integration-specific frequently requested properties. - /// - /// public async Task ConfigureAsync(ConfigureSupplementalDataRequest? request = null) { string baseUrl = _serverUrl; @@ -109,15 +120,6 @@ public async Task ConfigureAsync(ConfigureSup } - /// - /// Get configuration - /// - /// - /// The *Get configuration* endpoint returns supplemental data configuration previously created for each integration and data type combination. - /// - /// [Supplemental data](https://docs.codat.io/using-the-api/additional-data) is additional data you can include in Codat's standard data types. - /// - /// public async Task GetConfigurationAsync(GetSupplementalDataConfigurationRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/CodatPlatform/Webhooks.cs b/platform/CodatPlatform/Webhooks.cs index d2b55b0c7..6e34fcded 100755 --- a/platform/CodatPlatform/Webhooks.cs +++ b/platform/CodatPlatform/Webhooks.cs @@ -19,22 +19,46 @@ namespace CodatPlatform using System.Threading.Tasks; using System; + /// + /// Manage webhooks, rules, and events. + /// public interface IWebhooksSDK { + + /// + /// Create webhook + /// + /// + /// Create a new webhook configuration + /// + /// Task CreateAsync(CreateRule? request = null); + + /// + /// Get webhook + /// + /// + /// Get a single webhook + /// + /// Task GetAsync(GetWebhookRequest? request = null); + + /// + /// List webhooks + /// + /// + /// List webhooks that you are subscribed to. + /// + /// Task ListAsync(ListRulesRequest? request = null); } - /// - /// Manage webhooks, rules, and events. - /// public class WebhooksSDK: IWebhooksSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "0.5.0"; - private const string _sdkGenVersion = "2.113.0"; + private const string _sdkVersion = "1.1.0"; + private const string _sdkGenVersion = "2.116.0"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -49,13 +73,6 @@ public WebhooksSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient secu } - /// - /// Create webhook - /// - /// - /// Create a new webhook configuration - /// - /// public async Task CreateAsync(CreateRule? request = null) { string baseUrl = _serverUrl; @@ -109,13 +126,6 @@ public async Task CreateAsync(CreateRule? request = null) } - /// - /// Get webhook - /// - /// - /// Get a single webhook - /// - /// public async Task GetAsync(GetWebhookRequest? request = null) { string baseUrl = _serverUrl; @@ -164,13 +174,6 @@ public async Task GetAsync(GetWebhookRequest? request = null } - /// - /// List webhooks - /// - /// - /// List webhooks that you are subscribed to. - /// - /// public async Task ListAsync(ListRulesRequest? request = null) { string baseUrl = _serverUrl; diff --git a/platform/README.md b/platform/README.md index c7fd674ee..0352313ff 100644 --- a/platform/README.md +++ b/platform/README.md @@ -37,7 +37,7 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { ## Available Resources and Operations -### [companies](docs/sdks/companies/README.md) +### [Companies](docs/sdks/companies/README.md) * [Create](docs/sdks/companies/README.md#create) - Create company * [Delete](docs/sdks/companies/README.md#delete) - Delete a company @@ -45,7 +45,7 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { * [List](docs/sdks/companies/README.md#list) - List companies * [Update](docs/sdks/companies/README.md#update) - Update company -### [connections](docs/sdks/connections/README.md) +### [Connections](docs/sdks/connections/README.md) * [Create](docs/sdks/connections/README.md#create) - Create connection * [Delete](docs/sdks/connections/README.md#delete) - Delete connection @@ -54,19 +54,19 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { * [Unlink](docs/sdks/connections/README.md#unlink) - Unlink connection * [UpdateAuthorization](docs/sdks/connections/README.md#updateauthorization) - Update authorization -### [integrations](docs/sdks/integrations/README.md) +### [Integrations](docs/sdks/integrations/README.md) * [Get](docs/sdks/integrations/README.md#get) - Get integration * [GetBranding](docs/sdks/integrations/README.md#getbranding) - Get branding * [List](docs/sdks/integrations/README.md#list) - List integrations -### [pushData](docs/sdks/pushdata/README.md) +### [PushData](docs/sdks/pushdata/README.md) * [GetModelOptions](docs/sdks/pushdata/README.md#getmodeloptions) - Get push options * [GetOperation](docs/sdks/pushdata/README.md#getoperation) - Get push operation * [ListOperations](docs/sdks/pushdata/README.md#listoperations) - List push operations -### [refreshData](docs/sdks/refreshdata/README.md) +### [RefreshData](docs/sdks/refreshdata/README.md) * [All](docs/sdks/refreshdata/README.md#all) - Refresh all data * [ByDataType](docs/sdks/refreshdata/README.md#bydatatype) - Refresh data type @@ -74,7 +74,7 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { * [GetPullOperation](docs/sdks/refreshdata/README.md#getpulloperation) - Get pull operation * [ListPullOperations](docs/sdks/refreshdata/README.md#listpulloperations) - List pull operations -### [settings](docs/sdks/settings/README.md) +### [Settings](docs/sdks/settings/README.md) * [CreateApiKey](docs/sdks/settings/README.md#createapikey) - Create API key * [DeleteApiKey](docs/sdks/settings/README.md#deleteapikey) - Delete api key @@ -84,12 +84,12 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { * [UpdateProfile](docs/sdks/settings/README.md#updateprofile) - Update profile * [UpdateSyncSettings](docs/sdks/settings/README.md#updatesyncsettings) - Update all sync settings -### [supplementalData](docs/sdks/supplementaldata/README.md) +### [SupplementalData](docs/sdks/supplementaldata/README.md) * [Configure](docs/sdks/supplementaldata/README.md#configure) - Configure * [GetConfiguration](docs/sdks/supplementaldata/README.md#getconfiguration) - Get configuration -### [webhooks](docs/sdks/webhooks/README.md) +### [Webhooks](docs/sdks/webhooks/README.md) * [Create](docs/sdks/webhooks/README.md#create) - Create webhook * [Get](docs/sdks/webhooks/README.md#get) - Get webhook diff --git a/platform/RELEASES.md b/platform/RELEASES.md index fa0abaa9d..8158f5a37 100644 --- a/platform/RELEASES.md +++ b/platform/RELEASES.md @@ -46,4 +46,14 @@ Based on: ### Generated - [csharp v0.5.0] platform ### Releases -- [NuGet v0.5.0] https://www.nuget.org/packages/Codat.Platform/0.5.0 - platform \ No newline at end of file +- [NuGet v0.5.0] https://www.nuget.org/packages/Codat.Platform/0.5.0 - platform + +## 2023-09-18 21:53:58 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml +- Speakeasy CLI 1.87.0 (2.116.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v1.1.0] platform +### Releases +- [NuGet v1.1.0] https://www.nuget.org/packages/Codat.Platform/1.1.0 - platform \ No newline at end of file diff --git a/platform/docs/models/shared/ClientRateLimitReachedWebhook.md b/platform/docs/models/shared/ClientRateLimitReachedWebhook.md new file mode 100755 index 000000000..8964c7a69 --- /dev/null +++ b/platform/docs/models/shared/ClientRateLimitReachedWebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitReachedWebhook + +Webhook request body for a client that has reached their rate limit. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [ClientRateLimitReachedWebhookData](../../models/shared/ClientRateLimitReachedWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/platform/docs/models/shared/ClientRateLimitReachedWebhookData.md b/platform/docs/models/shared/ClientRateLimitReachedWebhookData.md new file mode 100755 index 000000000..ce6df4f7a --- /dev/null +++ b/platform/docs/models/shared/ClientRateLimitReachedWebhookData.md @@ -0,0 +1,9 @@ +# ClientRateLimitReachedWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/platform/docs/models/shared/ClientRateLimitResetWebhook.md b/platform/docs/models/shared/ClientRateLimitResetWebhook.md new file mode 100755 index 000000000..50d8ba967 --- /dev/null +++ b/platform/docs/models/shared/ClientRateLimitResetWebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitResetWebhook + +Webhook request body for a client that has had their rate limit reset. + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [ClientRateLimitResetWebhookData](../../models/shared/ClientRateLimitResetWebhookData.md) | :heavy_minus_sign: | N/A | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/platform/docs/models/shared/ClientRateLimitResetWebhookData.md b/platform/docs/models/shared/ClientRateLimitResetWebhookData.md new file mode 100755 index 000000000..17286b07d --- /dev/null +++ b/platform/docs/models/shared/ClientRateLimitResetWebhookData.md @@ -0,0 +1,11 @@ +# ClientRateLimitResetWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | +| `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `quotaRemaining` | *long* | :heavy_minus_sign: | Total number of request remaining for your client. | | +| `resetReason` | *string* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file diff --git a/platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhook.md b/platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhook.md deleted file mode 100755 index 5cde81f8a..000000000 --- a/platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhook.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompanyDataConnectionStatusChangedWebhook - -Webhook request body for a company's data connection status changed. - - -## Fields - -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [CompanyDataConnectionStatusChangedWebhookData](../../models/shared/CompanyDataConnectionStatusChangedWebhookData.md) | :heavy_minus_sign: | N/A | | -| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/ConnectionStatusChangedWebhook.md b/platform/docs/models/shared/ConnectionStatusChangedWebhook.md new file mode 100755 index 000000000..d6ab787c5 --- /dev/null +++ b/platform/docs/models/shared/ConnectionStatusChangedWebhook.md @@ -0,0 +1,18 @@ +# ConnectionStatusChangedWebhook + +Webhook request body for a company's data connection status changed. + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | +| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [ConnectionStatusChangedWebhookData](../../models/shared/ConnectionStatusChangedWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhookData.md b/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md similarity index 99% rename from platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhookData.md rename to platform/docs/models/shared/ConnectionStatusChangedWebhookData.md index f6279aa25..0bba6c472 100755 --- a/platform/docs/models/shared/CompanyDataConnectionStatusChangedWebhookData.md +++ b/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md @@ -1,4 +1,4 @@ -# CompanyDataConnectionStatusChangedWebhookData +# ConnectionStatusChangedWebhookData ## Fields diff --git a/platform/docs/models/shared/DataSyncCompletedWebhook.md b/platform/docs/models/shared/DataSyncCompletedWebhook.md index de16826cd..5baad37c4 100755 --- a/platform/docs/models/shared/DataSyncCompletedWebhook.md +++ b/platform/docs/models/shared/DataSyncCompletedWebhook.md @@ -15,4 +15,4 @@ Webhook request body to notify the completion of a data sync. | `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DataSyncCompletedWebhookData.md b/platform/docs/models/shared/DataSyncCompletedWebhookData.md index c5246e685..11c2af6ce 100755 --- a/platform/docs/models/shared/DataSyncCompletedWebhookData.md +++ b/platform/docs/models/shared/DataSyncCompletedWebhookData.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `dataType` | *string* | :heavy_minus_sign: | Data type the sync completed for. | -| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | +| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DatasetDataChangedWebhook.md b/platform/docs/models/shared/DatasetDataChangedWebhook.md index 26ad0a386..258584b45 100755 --- a/platform/docs/models/shared/DatasetDataChangedWebhook.md +++ b/platform/docs/models/shared/DatasetDataChangedWebhook.md @@ -5,11 +5,14 @@ Webhook request body to notify that a data synchronization has completed. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [DatasetDataChangedWebhookData](../../models/shared/DatasetDataChangedWebhookData.md) | :heavy_minus_sign: | N/A | | -| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | +| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [DatasetDataChangedWebhookDatasetDataChangedWebhookData](../../models/shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DatasetDataChangedWebhookData.md b/platform/docs/models/shared/DatasetDataChangedWebhookData.md deleted file mode 100755 index f8654a8ff..000000000 --- a/platform/docs/models/shared/DatasetDataChangedWebhookData.md +++ /dev/null @@ -1,9 +0,0 @@ -# DatasetDataChangedWebhookData - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `dataType` | *string* | :heavy_minus_sign: | Data type the sync completed for. | -| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | \ No newline at end of file diff --git a/platform/docs/models/shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.md b/platform/docs/models/shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.md new file mode 100755 index 000000000..f44cb010b --- /dev/null +++ b/platform/docs/models/shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.md @@ -0,0 +1,9 @@ +# DatasetDataChangedWebhookDatasetDataChangedWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | +| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DatasetStatusChangedErrorWebhook.md b/platform/docs/models/shared/DatasetStatusChangedErrorWebhook.md index b3dded947..683c4729a 100755 --- a/platform/docs/models/shared/DatasetStatusChangedErrorWebhook.md +++ b/platform/docs/models/shared/DatasetStatusChangedErrorWebhook.md @@ -8,8 +8,11 @@ Webhook request body to notify that a data synchronization has completed. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | | `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [DatasetStatusChangedErrorWebhookData](../../models/shared/DatasetStatusChangedErrorWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DatasetStatusChangedErrorWebhookData.md b/platform/docs/models/shared/DatasetStatusChangedErrorWebhookData.md index 9ea87f714..a9df73d26 100755 --- a/platform/docs/models/shared/DatasetStatusChangedErrorWebhookData.md +++ b/platform/docs/models/shared/DatasetStatusChangedErrorWebhookData.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `dataType` | *string* | :heavy_minus_sign: | Data type the sync completed for. | -| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | -| `datasetStatus` | *string* | :heavy_minus_sign: | The current status of the dataset's sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | +| `datasetId` | *string* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | +| `datasetStatus` | *string* | :heavy_minus_sign: | The current status of the dataset's sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/NewCompanySynchronizedWebhook.md b/platform/docs/models/shared/NewCompanySynchronizedWebhook.md index c854b3789..68574af31 100755 --- a/platform/docs/models/shared/NewCompanySynchronizedWebhook.md +++ b/platform/docs/models/shared/NewCompanySynchronizedWebhook.md @@ -5,10 +5,14 @@ Webhook request body to notify that a new company has successfully synchronized ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | +| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [NewCompanySynchronizedWebhookData](../../models/shared/NewCompanySynchronizedWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/NewCompanySynchronizedWebhookData.md b/platform/docs/models/shared/NewCompanySynchronizedWebhookData.md new file mode 100755 index 000000000..874203b26 --- /dev/null +++ b/platform/docs/models/shared/NewCompanySynchronizedWebhookData.md @@ -0,0 +1,7 @@ +# NewCompanySynchronizedWebhookData + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperation.md b/platform/docs/models/shared/PushOperation.md index 577e3bbfa..b7b0e1a98 100755 --- a/platform/docs/models/shared/PushOperation.md +++ b/platform/docs/models/shared/PushOperation.md @@ -13,7 +13,7 @@ | `errorMessage` | *string* | :heavy_minus_sign: | N/A | | | `pushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requestedOnUtc` | *string* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `statusCode` | *long* | :heavy_check_mark: | N/A | | | `timeoutInMinutes` | *int* | :heavy_minus_sign: | N/A | | | ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/platform/docs/models/shared/PushOperationStatus.md b/platform/docs/models/shared/PushOperationStatus.md index 3adf5a3ae..4e041b534 100755 --- a/platform/docs/models/shared/PushOperationStatus.md +++ b/platform/docs/models/shared/PushOperationStatus.md @@ -1,6 +1,6 @@ # PushOperationStatus -The status of the push operation. +The current status of the push operation. ## Values diff --git a/platform/docs/models/shared/PushOperationStatusChangedWebhook.md b/platform/docs/models/shared/PushOperationStatusChangedWebhook.md index c865ff0c8..54833889a 100755 --- a/platform/docs/models/shared/PushOperationStatusChangedWebhook.md +++ b/platform/docs/models/shared/PushOperationStatusChangedWebhook.md @@ -8,8 +8,11 @@ Webhook request body for a push operation status change. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | | `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [PushOperationStatusChangedWebhookData](../../models/shared/PushOperationStatusChangedWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperationStatusChangedWebhookData.md b/platform/docs/models/shared/PushOperationStatusChangedWebhookData.md index c4ef4cc78..f1683977d 100755 --- a/platform/docs/models/shared/PushOperationStatusChangedWebhookData.md +++ b/platform/docs/models/shared/PushOperationStatusChangedWebhookData.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `dataType` | *string* | :heavy_minus_sign: | Data type used in the push operation. | -| `pushOperationKey` | *string* | :heavy_minus_sign: | Unique identifier for the push operation. | -| `status` | *string* | :heavy_minus_sign: | The current status of the push operation. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | +| `pushOperationKey` | *string* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `status` | [PushOperationStatus](../../models/shared/PushOperationStatus.md) | :heavy_minus_sign: | The current status of the push operation. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperationTimedOutWebhook.md b/platform/docs/models/shared/PushOperationTimedOutWebhook.md index 8e441b81a..56f9a7fa6 100755 --- a/platform/docs/models/shared/PushOperationTimedOutWebhook.md +++ b/platform/docs/models/shared/PushOperationTimedOutWebhook.md @@ -8,8 +8,11 @@ Webhook request body notifying that a push push operation has timed out. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. | | | `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [PushOperationTimedOutWebhookData](../../models/shared/PushOperationTimedOutWebhookData.md) | :heavy_minus_sign: | N/A | | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. | | | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `ruleType` | *string* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperationTimedOutWebhookData.md b/platform/docs/models/shared/PushOperationTimedOutWebhookData.md index 24015e48d..a869a833d 100755 --- a/platform/docs/models/shared/PushOperationTimedOutWebhookData.md +++ b/platform/docs/models/shared/PushOperationTimedOutWebhookData.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `dataType` | *string* | :heavy_minus_sign: | Data type used in the push operation. | -| `pushOperationKey` | *string* | :heavy_minus_sign: | Unique identifier for the push operation. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | +| `pushOperationGuid` | *string* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `pushOperationKey` | *string* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | \ No newline at end of file diff --git a/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md b/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md new file mode 100755 index 000000000..f63a6471a --- /dev/null +++ b/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitReachedResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | N/A | +| `statusCode` | *int* | :heavy_check_mark: | N/A | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/webhooks/ClientRateLimitResetResponse.md b/platform/docs/models/webhooks/ClientRateLimitResetResponse.md new file mode 100755 index 000000000..c24fe522c --- /dev/null +++ b/platform/docs/models/webhooks/ClientRateLimitResetResponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitResetResponse + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | N/A | +| `statusCode` | *int* | :heavy_check_mark: | N/A | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/sdks/companies/README.md b/platform/docs/sdks/companies/README.md index a6c75e230..a7c159e47 100755 --- a/platform/docs/sdks/companies/README.md +++ b/platform/docs/sdks/companies/README.md @@ -1,4 +1,4 @@ -# companies +# Companies ## Overview diff --git a/platform/docs/sdks/connections/README.md b/platform/docs/sdks/connections/README.md index e6c0da09f..43a63830e 100755 --- a/platform/docs/sdks/connections/README.md +++ b/platform/docs/sdks/connections/README.md @@ -1,4 +1,4 @@ -# connections +# Connections ## Overview diff --git a/platform/docs/sdks/integrations/README.md b/platform/docs/sdks/integrations/README.md index 07ae4e6c7..758bc9391 100755 --- a/platform/docs/sdks/integrations/README.md +++ b/platform/docs/sdks/integrations/README.md @@ -1,4 +1,4 @@ -# integrations +# Integrations ## Overview diff --git a/platform/docs/sdks/pushdata/README.md b/platform/docs/sdks/pushdata/README.md index 9c2fc6a80..1d728e1f9 100755 --- a/platform/docs/sdks/pushdata/README.md +++ b/platform/docs/sdks/pushdata/README.md @@ -1,4 +1,4 @@ -# pushData +# PushData ## Overview diff --git a/platform/docs/sdks/refreshdata/README.md b/platform/docs/sdks/refreshdata/README.md index a672e5bfc..e2fb09686 100755 --- a/platform/docs/sdks/refreshdata/README.md +++ b/platform/docs/sdks/refreshdata/README.md @@ -1,4 +1,4 @@ -# refreshData +# RefreshData ## Overview diff --git a/platform/docs/sdks/settings/README.md b/platform/docs/sdks/settings/README.md index b1ea7a565..9b35dac2e 100755 --- a/platform/docs/sdks/settings/README.md +++ b/platform/docs/sdks/settings/README.md @@ -1,4 +1,4 @@ -# settings +# Settings ## Overview diff --git a/platform/docs/sdks/supplementaldata/README.md b/platform/docs/sdks/supplementaldata/README.md index ad5665aa4..238364c9e 100755 --- a/platform/docs/sdks/supplementaldata/README.md +++ b/platform/docs/sdks/supplementaldata/README.md @@ -1,4 +1,4 @@ -# supplementalData +# SupplementalData ## Overview diff --git a/platform/docs/sdks/webhooks/README.md b/platform/docs/sdks/webhooks/README.md index 413a700df..b68e685c0 100755 --- a/platform/docs/sdks/webhooks/README.md +++ b/platform/docs/sdks/webhooks/README.md @@ -1,4 +1,4 @@ -# webhooks +# Webhooks ## Overview diff --git a/platform/files.gen b/platform/files.gen index ccca05ff7..e03066940 100755 --- a/platform/files.gen +++ b/platform/files.gen @@ -142,19 +142,26 @@ CodatPlatform/Models/Shared/CreateRuleNotifiers.cs CodatPlatform/Models/Shared/CreateRule.cs CodatPlatform/Models/Shared/Webhooks.cs CodatPlatform/Models/Shared/Security.cs -CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhookData.cs -CodatPlatform/Models/Shared/CompanyDataConnectionStatusChangedWebhook.cs -CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs +CodatPlatform/Models/Shared/ClientRateLimitReachedWebhook.cs +CodatPlatform/Models/Shared/ClientRateLimitReachedWebhookData.cs +CodatPlatform/Models/Shared/ClientRateLimitResetWebhook.cs +CodatPlatform/Models/Shared/ClientRateLimitResetWebhookData.cs +CodatPlatform/Models/Shared/ConnectionStatusChangedWebhook.cs +CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs CodatPlatform/Models/Shared/DataSyncCompletedWebhook.cs -CodatPlatform/Models/Shared/DatasetDataChangedWebhookData.cs +CodatPlatform/Models/Shared/DataSyncCompletedWebhookData.cs +CodatPlatform/Models/Shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.cs CodatPlatform/Models/Shared/DatasetDataChangedWebhook.cs -CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhook.cs +CodatPlatform/Models/Shared/DatasetStatusChangedErrorWebhookData.cs CodatPlatform/Models/Shared/NewCompanySynchronizedWebhook.cs -CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs +CodatPlatform/Models/Shared/NewCompanySynchronizedWebhookData.cs CodatPlatform/Models/Shared/PushOperationTimedOutWebhook.cs -CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs +CodatPlatform/Models/Shared/PushOperationTimedOutWebhookData.cs CodatPlatform/Models/Shared/PushOperationStatusChangedWebhook.cs +CodatPlatform/Models/Shared/PushOperationStatusChangedWebhookData.cs +CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs +CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs @@ -293,19 +300,26 @@ docs/models/shared/CreateRuleNotifiers.md docs/models/shared/CreateRule.md docs/models/shared/Webhooks.md docs/models/shared/Security.md -docs/models/shared/CompanyDataConnectionStatusChangedWebhookData.md -docs/models/shared/CompanyDataConnectionStatusChangedWebhook.md -docs/models/shared/DataSyncCompletedWebhookData.md +docs/models/shared/ClientRateLimitReachedWebhook.md +docs/models/shared/ClientRateLimitReachedWebhookData.md +docs/models/shared/ClientRateLimitResetWebhook.md +docs/models/shared/ClientRateLimitResetWebhookData.md +docs/models/shared/ConnectionStatusChangedWebhook.md +docs/models/shared/ConnectionStatusChangedWebhookData.md docs/models/shared/DataSyncCompletedWebhook.md -docs/models/shared/DatasetDataChangedWebhookData.md +docs/models/shared/DataSyncCompletedWebhookData.md +docs/models/shared/DatasetDataChangedWebhookDatasetDataChangedWebhookData.md docs/models/shared/DatasetDataChangedWebhook.md -docs/models/shared/DatasetStatusChangedErrorWebhookData.md docs/models/shared/DatasetStatusChangedErrorWebhook.md +docs/models/shared/DatasetStatusChangedErrorWebhookData.md docs/models/shared/NewCompanySynchronizedWebhook.md -docs/models/shared/PushOperationTimedOutWebhookData.md +docs/models/shared/NewCompanySynchronizedWebhookData.md docs/models/shared/PushOperationTimedOutWebhook.md -docs/models/shared/PushOperationStatusChangedWebhookData.md +docs/models/shared/PushOperationTimedOutWebhookData.md docs/models/shared/PushOperationStatusChangedWebhook.md +docs/models/shared/PushOperationStatusChangedWebhookData.md +docs/models/webhooks/ClientRateLimitReachedResponse.md +docs/models/webhooks/ClientRateLimitResetResponse.md docs/models/webhooks/CompanyDataConnectionStatusChangedResponse.md docs/models/webhooks/DataSyncCompletedResponse.md docs/models/webhooks/DatasetDataChangedResponse.md diff --git a/platform/gen.yaml b/platform/gen.yaml index 28e0eb44a..860d25c62 100644 --- a/platform/gen.yaml +++ b/platform/gen.yaml @@ -1,23 +1,23 @@ configVersion: 1.0.0 management: - docChecksum: 6f41b61f64ea1dcaee9df6bc1e3cb37c + docChecksum: 22588f231182e4787ffec29bd112d175 docVersion: 3.0.0 - speakeasyVersion: 1.84.0 - generationVersion: 2.113.0 + speakeasyVersion: 1.87.0 + generationVersion: 2.116.0 generation: sdkClassName: Codat.Platform singleTagPerOp: false telemetryEnabled: true features: csharp: - core: 2.85.7 + core: 2.85.8 deprecations: 2.81.1 examples: 2.81.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 nameOverrides: 2.81.1 csharp: - version: 1.0.0 + version: 1.1.0 author: Codat description: Manage the building blocks of Codat, including companies, connections, and more. dotnetVersion: net6.0