From 4e1b4ac1c4c85ac85f4a9ba574c0ca9f59a8bbb1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 25 Sep 2023 18:30:13 +0100 Subject: [PATCH] ci: regenerated with OpenAPI Doc 3.0.0, Speakeay CLI 1.91.0 (#124) Co-authored-by: speakeasybot --- platform/CodatPlatform/CodatPlatform.csproj | 2 +- platform/CodatPlatform/CodatPlatformSDK.cs | 17 +++++- platform/CodatPlatform/Companies.cs | 25 +++++---- platform/CodatPlatform/Connections.cs | 27 +++++----- platform/CodatPlatform/Integrations.cs | 19 ++++--- .../ConfigureSupplementalDataDataType.cs | 8 ++- .../ConfigureSupplementalDataRequest.cs | 5 +- .../ConfigureSupplementalDataResponse.cs | 9 ++++ .../Models/Operations/CreateApiKeyResponse.cs | 9 ++++ .../Operations/CreateCompanyResponse.cs | 9 ++++ .../Operations/CreateConnectionRequest.cs | 3 ++ .../Operations/CreateConnectionRequestBody.cs | 3 ++ .../Operations/CreateConnectionResponse.cs | 9 ++++ .../Models/Operations/CreateRuleResponse.cs | 9 ++++ .../Models/Operations/DeleteApiKeyResponse.cs | 9 ++++ .../Models/Operations/DeleteCompanyRequest.cs | 3 ++ .../Operations/DeleteCompanyResponse.cs | 9 ++++ .../Operations/DeleteConnectionRequest.cs | 6 +++ .../Operations/DeleteConnectionResponse.cs | 9 ++++ .../Operations/GetCompanyDataStatusRequest.cs | 3 ++ .../GetCompanyDataStatusResponse.cs | 9 ++++ .../GetCompanyPushHistoryRequest.cs | 3 ++ .../GetCompanyPushHistoryResponse.cs | 9 ++++ .../Models/Operations/GetCompanyRequest.cs | 3 ++ .../Models/Operations/GetCompanyResponse.cs | 9 ++++ .../Models/Operations/GetConnectionRequest.cs | 6 +++ .../Operations/GetConnectionResponse.cs | 9 ++++ ...eateUpdateModelOptionsByDataTypeRequest.cs | 6 +++ ...ateUpdateModelOptionsByDataTypeResponse.cs | 9 ++++ .../Operations/GetIntegrationRequest.cs | 3 ++ .../Operations/GetIntegrationResponse.cs | 9 ++++ .../GetIntegrationsBrandingRequest.cs | 3 ++ .../GetIntegrationsBrandingResponse.cs | 9 ++++ .../Models/Operations/GetProfileResponse.cs | 9 ++++ .../GetProfileSyncSettingsResponse.cs | 9 ++++ .../Operations/GetPullOperationRequest.cs | 5 +- .../Operations/GetPullOperationResponse.cs | 9 ++++ .../Operations/GetPushOperationRequest.cs | 3 ++ .../Operations/GetPushOperationResponse.cs | 9 ++++ ...etSupplementalDataConfigurationDataType.cs | 8 ++- ...GetSupplementalDataConfigurationRequest.cs | 5 +- ...etSupplementalDataConfigurationResponse.cs | 9 ++++ .../Models/Operations/GetWebhookResponse.cs | 9 ++++ .../Models/Operations/ListApiKeysResponse.cs | 9 ++++ .../Operations/ListCompaniesResponse.cs | 9 ++++ .../Operations/ListConnectionsRequest.cs | 3 ++ .../Operations/ListConnectionsResponse.cs | 9 ++++ .../Operations/ListIntegrationsResponse.cs | 9 ++++ .../Operations/ListPullOperationsRequest.cs | 3 ++ .../Operations/ListPullOperationsResponse.cs | 9 ++++ .../Models/Operations/ListRulesResponse.cs | 9 ++++ .../Operations/RefreshCompanyDataRequest.cs | 3 ++ .../Operations/RefreshCompanyDataResponse.cs | 9 ++++ .../Operations/RefreshDataTypeRequest.cs | 3 ++ .../Operations/RefreshDataTypeResponse.cs | 9 ++++ .../Operations/UnlinkConnectionRequest.cs | 6 +++ .../Operations/UnlinkConnectionResponse.cs | 9 ++++ .../Models/Operations/UpdateCompanyRequest.cs | 3 ++ .../Operations/UpdateCompanyResponse.cs | 9 ++++ .../UpdateConnectionAuthorizationRequest.cs | 6 +++ .../UpdateConnectionAuthorizationResponse.cs | 9 ++++ .../Operations/UpdateProfileResponse.cs | 9 ++++ .../UpdateProfileSyncSettingsRequestBody.cs | 8 ++- .../UpdateProfileSyncSettingsResponse.cs | 9 ++++ .../CodatPlatform/Models/Shared/Companies.cs | 9 ++++ .../CodatPlatform/Models/Shared/Company.cs | 6 +++ .../CodatPlatform/Models/Shared/Connection.cs | 6 +++ .../ConnectionStatusChangedWebhookData.cs | 2 +- .../Models/Shared/Connections.cs | 9 ++++ .../Models/Shared/CreateApiKey.cs | 2 +- .../CodatPlatform/Models/Shared/CreateRule.cs | 8 ++- .../Models/Shared/DataConnectionError.cs | 9 ++++ .../Models/Shared/DataConnectionStatus.cs | 8 ++- .../CodatPlatform/Models/Shared/DataStatus.cs | 14 ++++- ...ingDataTypes.cs => DataStatusDataTypes.cs} | 24 +++++---- .../CodatPlatform/Models/Shared/DataType.cs | 8 ++- .../Models/Shared/ErrorMessage.cs | 18 +++++++ .../Models/Shared/FeatureState.cs | 11 +++- .../Models/Shared/FeatureType.cs | 11 +++- .../CodatPlatform/Models/Shared/HalRef.cs | 3 ++ .../Models/Shared/Integration.cs | 19 ++++++- .../Models/Shared/Integrations.cs | 9 ++++ .../CodatPlatform/Models/Shared/Profile.cs | 24 +++++++++ .../Models/Shared/PullOperation.cs | 26 ++++++++- .../Models/Shared/PullOperationStatus.cs | 11 +++- .../Models/Shared/PullOperations.cs | 9 ++++ .../Models/Shared/PushChangeType.cs | 11 +++- .../Models/Shared/PushFieldValidation.cs | 9 ++++ .../Models/Shared/PushOperation.cs | 12 +++++ .../Models/Shared/PushOperationChange.cs | 6 +++ .../Models/Shared/PushOperationRef.cs | 3 ++ .../Models/Shared/PushOperationStatus.cs | 8 ++- .../Models/Shared/PushOperations.cs | 9 ++++ .../CodatPlatform/Models/Shared/PushOption.cs | 12 +++++ .../Models/Shared/PushOptionChoice.cs | 12 +++++ .../Models/Shared/PushOptionProperty.cs | 12 +++++ .../Models/Shared/PushOptionType.cs | 11 +++- .../CodatPlatform/Models/Shared/SourceType.cs | 8 ++- .../Models/Shared/SupportedFeature.cs | 6 +++ .../Models/Shared/SyncSetting.cs | 10 +++- .../Models/Shared/SyncSettings.cs | 6 +++ .../Models/Shared/ValidationItem.cs | 9 ++++ .../CodatPlatform/Models/Shared/Webhook.cs | 11 +++- ...ateRuleNotifiers.cs => WebhookNotifier.cs} | 5 +- .../Models/Shared/WebhookNotifiers.cs | 25 --------- .../CodatPlatform/Models/Shared/Webhooks.cs | 9 ++++ .../ClientRateLimitReachedResponse.cs | 9 ++++ .../Webhooks/ClientRateLimitResetResponse.cs | 9 ++++ ...panyDataConnectionStatusChangedResponse.cs | 9 ++++ .../Webhooks/DataSyncCompletedResponse.cs | 9 ++++ .../Webhooks/DatasetDataChangedResponse.cs | 9 ++++ ...tStatusHasChangedToAnErrorStateResponse.cs | 9 ++++ .../NewCompanySynchronizedResponse.cs | 9 ++++ .../PushOperationHasTimedOutResponse.cs | 9 ++++ .../PushOperationStatusHasChangedResponse.cs | 9 ++++ platform/CodatPlatform/PushData.cs | 19 ++++--- platform/CodatPlatform/RefreshData.cs | 25 +++++---- platform/CodatPlatform/Settings.cs | 33 ++++++------ platform/CodatPlatform/SupplementalData.cs | 13 +++-- .../CodatPlatform/Utils/EnumSerializer.cs | 53 ++++++++++++------- platform/CodatPlatform/Webhooks.cs | 19 ++++--- platform/README.md | 14 ++++- platform/RELEASES.md | 12 ++++- .../ConfigureSupplementalDataRequest.md | 10 ++-- .../ConfigureSupplementalDataResponse.md | 6 +-- .../models/operations/CreateApiKeyResponse.md | 6 +-- .../operations/CreateCompanyResponse.md | 6 +-- .../operations/CreateConnectionRequest.md | 2 +- .../operations/CreateConnectionRequestBody.md | 6 +-- .../operations/CreateConnectionResponse.md | 6 +-- .../models/operations/CreateRuleResponse.md | 6 +-- .../models/operations/DeleteApiKeyResponse.md | 6 +-- .../models/operations/DeleteCompanyRequest.md | 2 +- .../operations/DeleteCompanyResponse.md | 6 +-- .../operations/DeleteConnectionRequest.md | 4 +- .../operations/DeleteConnectionResponse.md | 6 +-- .../operations/GetCompanyDataStatusRequest.md | 2 +- .../GetCompanyDataStatusResponse.md | 6 +-- .../GetCompanyPushHistoryRequest.md | 2 +- .../GetCompanyPushHistoryResponse.md | 6 +-- .../models/operations/GetCompanyRequest.md | 2 +- .../models/operations/GetCompanyResponse.md | 6 +-- .../models/operations/GetConnectionRequest.md | 4 +- .../operations/GetConnectionResponse.md | 6 +-- ...eateUpdateModelOptionsByDataTypeRequest.md | 4 +- ...ateUpdateModelOptionsByDataTypeResponse.md | 6 +-- .../operations/GetIntegrationRequest.md | 6 +-- .../operations/GetIntegrationResponse.md | 6 +-- .../GetIntegrationsBrandingRequest.md | 6 +-- .../GetIntegrationsBrandingResponse.md | 6 +-- .../models/operations/GetProfileResponse.md | 6 +-- .../GetProfileSyncSettingsResponse.md | 6 +-- .../operations/GetPullOperationRequest.md | 8 +-- .../operations/GetPullOperationResponse.md | 6 +-- .../operations/GetPushOperationRequest.md | 2 +- .../operations/GetPushOperationResponse.md | 6 +-- ...GetSupplementalDataConfigurationRequest.md | 8 +-- ...etSupplementalDataConfigurationResponse.md | 6 +-- .../models/operations/GetWebhookResponse.md | 6 +-- .../models/operations/ListApiKeysResponse.md | 6 +-- .../operations/ListCompaniesResponse.md | 6 +-- .../operations/ListConnectionsRequest.md | 2 +- .../operations/ListConnectionsResponse.md | 6 +-- .../operations/ListIntegrationsResponse.md | 6 +-- .../operations/ListPullOperationsRequest.md | 2 +- .../operations/ListPullOperationsResponse.md | 6 +-- .../models/operations/ListRulesResponse.md | 6 +-- .../operations/RefreshCompanyDataRequest.md | 2 +- .../operations/RefreshCompanyDataResponse.md | 6 +-- .../operations/RefreshDataTypeRequest.md | 2 +- .../operations/RefreshDataTypeResponse.md | 6 +-- .../operations/UnlinkConnectionRequest.md | 4 +- .../operations/UnlinkConnectionResponse.md | 6 +-- .../models/operations/UpdateCompanyRequest.md | 2 +- .../operations/UpdateCompanyResponse.md | 6 +-- .../UpdateConnectionAuthorizationRequest.md | 4 +- .../UpdateConnectionAuthorizationResponse.md | 6 +-- .../operations/UpdateProfileResponse.md | 6 +-- .../UpdateProfileSyncSettingsRequestBody.md | 10 ++-- .../UpdateProfileSyncSettingsResponse.md | 6 +-- platform/docs/models/shared/Companies.md | 6 +-- platform/docs/models/shared/Company.md | 4 +- platform/docs/models/shared/Connection.md | 4 +- .../ConnectionStatusChangedWebhookData.md | 12 ++--- platform/docs/models/shared/Connections.md | 6 +-- platform/docs/models/shared/CreateApiKey.md | 2 +- platform/docs/models/shared/CreateRule.md | 10 ++-- .../docs/models/shared/CreateRuleNotifiers.md | 9 ---- .../docs/models/shared/DataConnectionError.md | 6 +-- platform/docs/models/shared/DataStatus.md | 8 +-- ...ingDataTypes.md => DataStatusDataTypes.md} | 2 +- platform/docs/models/shared/ErrorMessage.md | 16 +++--- platform/docs/models/shared/FeatureState.md | 2 + platform/docs/models/shared/FeatureType.md | 2 + platform/docs/models/shared/HalRef.md | 6 +-- platform/docs/models/shared/Integration.md | 26 ++++----- platform/docs/models/shared/Integrations.md | 6 +-- platform/docs/models/shared/Profile.md | 20 +++---- platform/docs/models/shared/PullOperation.md | 16 +++--- .../docs/models/shared/PullOperationStatus.md | 2 + platform/docs/models/shared/PullOperations.md | 6 +-- platform/docs/models/shared/PushChangeType.md | 2 + .../docs/models/shared/PushFieldValidation.md | 10 ++-- platform/docs/models/shared/PushOperation.md | 8 +-- .../docs/models/shared/PushOperationChange.md | 10 ++-- .../docs/models/shared/PushOperationRef.md | 2 +- platform/docs/models/shared/PushOperations.md | 6 +-- platform/docs/models/shared/PushOption.md | 8 +-- .../docs/models/shared/PushOptionChoice.md | 8 +-- .../docs/models/shared/PushOptionProperty.md | 8 +-- platform/docs/models/shared/PushOptionType.md | 2 + .../docs/models/shared/SupportedFeature.md | 4 +- platform/docs/models/shared/SyncSetting.md | 8 +-- platform/docs/models/shared/SyncSettings.md | 10 ++-- platform/docs/models/shared/ValidationItem.md | 10 ++-- platform/docs/models/shared/Webhook.md | 12 ++--- .../docs/models/shared/WebhookNotifier.md | 9 ++++ .../docs/models/shared/WebhookNotifiers.md | 9 ---- platform/docs/models/shared/Webhooks.md | 6 +-- .../ClientRateLimitReachedResponse.md | 6 +-- .../webhooks/ClientRateLimitResetResponse.md | 6 +-- ...panyDataConnectionStatusChangedResponse.md | 6 +-- .../webhooks/DataSyncCompletedResponse.md | 6 +-- .../webhooks/DatasetDataChangedResponse.md | 6 +-- ...tStatusHasChangedToAnErrorStateResponse.md | 6 +-- .../NewCompanySynchronizedResponse.md | 6 +-- .../PushOperationHasTimedOutResponse.md | 6 +-- .../PushOperationStatusHasChangedResponse.md | 6 +-- platform/docs/sdks/connections/README.md | 8 +-- platform/docs/sdks/integrations/README.md | 2 +- platform/docs/sdks/pushdata/README.md | 4 +- platform/docs/sdks/refreshdata/README.md | 6 +-- platform/docs/sdks/settings/README.md | 8 +-- platform/docs/sdks/supplementaldata/README.md | 12 ++--- platform/docs/sdks/webhooks/README.md | 8 +-- platform/files.gen | 28 +++++----- platform/gen.yaml | 10 ++-- 237 files changed, 1425 insertions(+), 534 deletions(-) rename platform/CodatPlatform/Models/Shared/{SyncSettingDataTypes.cs => DataStatusDataTypes.cs} (84%) rename platform/CodatPlatform/Models/Shared/{CreateRuleNotifiers.cs => WebhookNotifier.cs} (83%) delete mode 100755 platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs delete mode 100755 platform/docs/models/shared/CreateRuleNotifiers.md rename platform/docs/models/shared/{SyncSettingDataTypes.md => DataStatusDataTypes.md} (99%) create mode 100755 platform/docs/models/shared/WebhookNotifier.md delete mode 100755 platform/docs/models/shared/WebhookNotifiers.md diff --git a/platform/CodatPlatform/CodatPlatform.csproj b/platform/CodatPlatform/CodatPlatform.csproj index 76ba719eb..7686bf892 100755 --- a/platform/CodatPlatform/CodatPlatform.csproj +++ b/platform/CodatPlatform/CodatPlatform.csproj @@ -2,7 +2,7 @@ true Codat.Platform - 1.1.0 + 2.1.0 Codat net6.0 enable diff --git a/platform/CodatPlatform/CodatPlatformSDK.cs b/platform/CodatPlatform/CodatPlatformSDK.cs index 1f842dad1..9b6a00e2e 100755 --- a/platform/CodatPlatform/CodatPlatformSDK.cs +++ b/platform/CodatPlatform/CodatPlatformSDK.cs @@ -78,6 +78,19 @@ 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...
+ ///
+ /// See our OpenAPI spec + ///
+ ///
public class CodatPlatformSDK: ICodatPlatformSDK { public SDKConfig Config { get; private set; } @@ -87,8 +100,8 @@ public class CodatPlatformSDK: ICodatPlatformSDK }; private const string _language = "csharp"; - private const string _sdkVersion = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; diff --git a/platform/CodatPlatform/Companies.cs b/platform/CodatPlatform/Companies.cs index 552e51c7b..03e2bb299 100755 --- a/platform/CodatPlatform/Companies.cs +++ b/platform/CodatPlatform/Companies.cs @@ -76,12 +76,15 @@ public interface ICompaniesSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -131,7 +134,7 @@ public async Task CreateAsync(CompanyRequestBody? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -140,7 +143,7 @@ public async Task CreateAsync(CompanyRequestBody? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -184,7 +187,7 @@ public async Task DeleteAsync(DeleteCompanyRequest? reque { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -223,7 +226,7 @@ public async Task GetAsync(GetCompanyRequest? request = null { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -232,7 +235,7 @@ public async Task GetAsync(GetCompanyRequest? request = null { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -271,7 +274,7 @@ public async Task ListAsync(ListCompaniesRequest? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Companies = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Companies = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -280,7 +283,7 @@ public async Task ListAsync(ListCompaniesRequest? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -324,7 +327,7 @@ public async Task UpdateAsync(UpdateCompanyRequest? reque { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Company = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -333,7 +336,7 @@ public async Task UpdateAsync(UpdateCompanyRequest? reque { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/Connections.cs b/platform/CodatPlatform/Connections.cs index 5f11b1feb..b56d8e8b9 100755 --- a/platform/CodatPlatform/Connections.cs +++ b/platform/CodatPlatform/Connections.cs @@ -83,12 +83,15 @@ public interface IConnectionsSDK Task UpdateAuthorizationAsync(UpdateConnectionAuthorizationRequest? request = null); } + /// + /// Manage your companies&apos; data connections. + /// public class ConnectionsSDK: IConnectionsSDK { public SDKConfig Config { get; private set; } private const string _language = "csharp"; - private const string _sdkVersion = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -138,7 +141,7 @@ public async Task CreateAsync(CreateConnectionRequest? { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -147,7 +150,7 @@ public async Task CreateAsync(CreateConnectionRequest? { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -191,7 +194,7 @@ public async Task DeleteAsync(DeleteConnectionRequest? { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -230,7 +233,7 @@ public async Task GetAsync(GetConnectionRequest? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -239,7 +242,7 @@ public async Task GetAsync(GetConnectionRequest? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -278,7 +281,7 @@ public async Task ListAsync(ListConnectionsRequest? req { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Connections = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Connections = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -287,7 +290,7 @@ public async Task ListAsync(ListConnectionsRequest? req { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -331,7 +334,7 @@ public async Task UnlinkAsync(UnlinkConnectionRequest? { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -340,7 +343,7 @@ public async Task UnlinkAsync(UnlinkConnectionRequest? { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -384,7 +387,7 @@ public async Task UpdateAuthorizationAsyn { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Connection = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/Integrations.cs b/platform/CodatPlatform/Integrations.cs index 111407036..b5fdb7c4b 100755 --- a/platform/CodatPlatform/Integrations.cs +++ b/platform/CodatPlatform/Integrations.cs @@ -53,12 +53,15 @@ public interface IIntegrationsSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -103,7 +106,7 @@ public async Task GetAsync(GetIntegrationRequest? reques { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Integration = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Integration = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -112,7 +115,7 @@ public async Task GetAsync(GetIntegrationRequest? reques { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -151,7 +154,7 @@ public async Task GetBrandingAsync(GetIntegrati { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Branding = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Branding = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -160,7 +163,7 @@ public async Task GetBrandingAsync(GetIntegrati { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -199,7 +202,7 @@ public async Task ListAsync(ListIntegrationsRequest? r { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Integrations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Integrations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -208,7 +211,7 @@ public async Task ListAsync(ListIntegrationsRequest? r { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs index d615c5e5d..5349acafd 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataDataType.cs @@ -73,7 +73,13 @@ public static ConfigureSupplementalDataDataType ToEnum(this string value) { foreach(var field in typeof(ConfigureSupplementalDataDataType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs index bd498f12d..40e9c7b44 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataRequest.cs @@ -23,11 +23,14 @@ public class ConfigureSupplementalDataRequest public SupplementalDataConfiguration? SupplementalDataConfiguration { get; set; } /// - /// Data types that support supplemental data + /// Supported supplemental data data type. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public ConfigureSupplementalDataDataType DataType { get; set; } = default!; + /// + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs index c993a9c0c..a857669d4 100755 --- a/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ConfigureSupplementalDataResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class ConfigureSupplementalDataResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class ConfigureSupplementalDataResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 8d6707f7d..851f6e19e 100755 --- a/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateApiKeyResponse.cs @@ -22,6 +22,9 @@ public class CreateApiKeyResponse /// public ApiKeyDetails? ApiKeyDetails { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class CreateApiKeyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 c20f0dec9..8932c57e2 100755 --- a/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateCompanyResponse.cs @@ -22,6 +22,9 @@ public class CreateCompanyResponse /// public Company? Company { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class CreateCompanyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 2b22af4ed..cd7ff9889 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionRequest.cs @@ -18,6 +18,9 @@ public class CreateConnectionRequest [SpeakeasyMetadata("request:mediaType=application/json")] public CreateConnectionRequestBody? RequestBody { get; set; } + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs b/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs index 9d7a59859..7f0f6248e 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionRequestBody.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class CreateConnectionRequestBody { + /// + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. + /// [JsonProperty("platformKey")] public string? PlatformKey { get; set; } } diff --git a/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs index 750a7197a..3815b1da9 100755 --- a/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateConnectionResponse.cs @@ -22,6 +22,9 @@ public class CreateConnectionResponse /// public Connection? Connection { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class CreateConnectionResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 c4b44d059..b4abc01c6 100755 --- a/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs +++ b/platform/CodatPlatform/Models/Operations/CreateRuleResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class CreateRuleResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class CreateRuleResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } /// diff --git a/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs index 50d96c6f8..519540560 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteApiKeyResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class DeleteApiKeyResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class DeleteApiKeyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 eb12eb9ff..ec94eb5c2 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteCompanyRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class DeleteCompanyRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs index 040252795..1b3652e1e 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteCompanyResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class DeleteCompanyResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class DeleteCompanyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 a5a7fe723..379298e5d 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteConnectionRequest.cs @@ -15,9 +15,15 @@ namespace CodatPlatform.Models.Operations public class DeleteConnectionRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier for a connection. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs index 63fbb8384..a361b2d8e 100755 --- a/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/DeleteConnectionResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class DeleteConnectionResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class DeleteConnectionResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 36d70eeee..031902b5e 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetCompanyDataStatusRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs index 9facbd0e7..2e9d9046b 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyDataStatusResponse.cs @@ -18,6 +18,9 @@ namespace CodatPlatform.Models.Operations public class GetCompanyDataStatusResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -30,8 +33,14 @@ public class GetCompanyDataStatusResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 b92b5e600..50ee5c3f3 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetCompanyPushHistoryRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs index 540d0c6b0..61e9e11b3 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyPushHistoryResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetCompanyPushHistoryResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetCompanyPushHistoryResponse /// public PushOperations? PushOperations { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 aed77efec..dfd1face9 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetCompanyRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs index 560e7f7d3..803eacab1 100755 --- a/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCompanyResponse.cs @@ -22,6 +22,9 @@ public class GetCompanyResponse /// public Company? Company { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetCompanyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 923fc8f7a..ad29bdcee 100755 --- a/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetConnectionRequest.cs @@ -15,9 +15,15 @@ namespace CodatPlatform.Models.Operations public class GetConnectionRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier for a connection. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs index c8f8d3b94..9f1a94e04 100755 --- a/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetConnectionResponse.cs @@ -22,6 +22,9 @@ public class GetConnectionResponse /// public Connection? Connection { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetConnectionResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 ed851b3bb..7b674f732 100755 --- a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeRequest.cs @@ -16,9 +16,15 @@ namespace CodatPlatform.Models.Operations public class GetCreateUpdateModelOptionsByDataTypeRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier for a connection. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs index e9239d271..c909f73e0 100755 --- a/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetCreateUpdateModelOptionsByDataTypeResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetCreateUpdateModelOptionsByDataTypeResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetCreateUpdateModelOptionsByDataTypeResponse /// public PushOption? PushOption { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 44d0b462e..a1b091b8b 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetIntegrationRequest { + /// + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs index 209e6aafb..e7b6d66aa 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetIntegrationResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetIntegrationResponse /// public Integration? Integration { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 d66ff84dd..736385ee2 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetIntegrationsBrandingRequest { + /// + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs index e4daead82..d0ceaaf2e 100755 --- a/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetIntegrationsBrandingResponse.cs @@ -22,6 +22,9 @@ public class GetIntegrationsBrandingResponse /// public Branding? Branding { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetIntegrationsBrandingResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 98c58bc31..005b475a0 100755 --- a/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetProfileResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetProfileResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetProfileResponse /// public Profile? Profile { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 9cd813365..d79aed9e6 100755 --- a/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetProfileSyncSettingsResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetProfileSyncSettingsResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class GetProfileSyncSettingsResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } /// diff --git a/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs b/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs index 361e88d33..cdb2d463b 100755 --- a/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetPullOperationRequest.cs @@ -15,11 +15,14 @@ namespace CodatPlatform.Models.Operations public class GetPullOperationRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; /// - /// Unique ID of a dataset or pull operation. + /// Unique identifier for the dataset that completed its sync. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=datasetId")] public string DatasetId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs b/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs index ac1fc896a..44b16377f 100755 --- a/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetPullOperationResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetPullOperationResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetPullOperationResponse /// public PullOperation? PullOperation { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 5ba1e5316..05d32b1fa 100755 --- a/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetPushOperationRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class GetPushOperationRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs b/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs index 5c66dacc2..043d95854 100755 --- a/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetPushOperationResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetPushOperationResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class GetPushOperationResponse /// public PushOperation? PushOperation { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 33130a544..9a48c78e8 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationDataType.cs @@ -73,7 +73,13 @@ public static GetSupplementalDataConfigurationDataType ToEnum(this string value) { foreach(var field in typeof(GetSupplementalDataConfigurationDataType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs index b0b8d75ba..b2a187ab7 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationRequest.cs @@ -16,11 +16,14 @@ public class GetSupplementalDataConfigurationRequest { /// - /// Data types that support supplemental data + /// Supported supplemental data data type. /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=dataType")] public GetSupplementalDataConfigurationDataType DataType { get; set; } = default!; + /// + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=platformKey")] public string PlatformKey { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs index 7cbe50fb4..e2d758f51 100755 --- a/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetSupplementalDataConfigurationResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetSupplementalDataConfigurationResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class GetSupplementalDataConfigurationResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } /// diff --git a/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs b/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs index 76069aadc..f09f9f34d 100755 --- a/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs +++ b/platform/CodatPlatform/Models/Operations/GetWebhookResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class GetWebhookResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class GetWebhookResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } /// diff --git a/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs b/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs index 18743d4cd..421a05f14 100755 --- a/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListApiKeysResponse.cs @@ -22,6 +22,9 @@ public class ListApiKeysResponse /// public ApiKeys? ApiKeys { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class ListApiKeysResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { 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 0c9dbfe3d..1817aec9e 100755 --- a/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListCompaniesResponse.cs @@ -22,6 +22,9 @@ public class ListCompaniesResponse /// public Companies? Companies { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class ListCompaniesResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 49c9deed4..cac2229ee 100755 --- a/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListConnectionsRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class ListConnectionsRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs b/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs index cb8855489..e0dc67d0d 100755 --- a/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListConnectionsResponse.cs @@ -22,6 +22,9 @@ public class ListConnectionsResponse /// public Connections? Connections { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class ListConnectionsResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { 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 85e4705e7..3ddb509d9 100755 --- a/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListIntegrationsResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class ListIntegrationsResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class ListIntegrationsResponse /// public Integrations? Integrations { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 3d686315c..818ca5bfc 100755 --- a/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs +++ b/platform/CodatPlatform/Models/Operations/ListPullOperationsRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class ListPullOperationsRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs b/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs index 032e49e73..8669a8d87 100755 --- a/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListPullOperationsResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class ListPullOperationsResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class ListPullOperationsResponse /// public PullOperations? PullOperations { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { 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 bd0dc4b98..653358686 100755 --- a/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs +++ b/platform/CodatPlatform/Models/Operations/ListRulesResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class ListRulesResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class ListRulesResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } /// diff --git a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs index 2be8a8bb7..f19adef8f 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataRequest.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Operations public class RefreshCompanyDataRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs index a26698212..dbfeaba9e 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshCompanyDataResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class RefreshCompanyDataResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class RefreshCompanyDataResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 307f2dafd..316e38422 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshDataTypeRequest.cs @@ -16,6 +16,9 @@ namespace CodatPlatform.Models.Operations public class RefreshDataTypeRequest { + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs b/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs index 6bb40c5fb..de942df8d 100755 --- a/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs +++ b/platform/CodatPlatform/Models/Operations/RefreshDataTypeResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class RefreshDataTypeResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class RefreshDataTypeResponse /// public PullOperation? PullOperation { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 fc7dc286c..61b468228 100755 --- a/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UnlinkConnectionRequest.cs @@ -19,9 +19,15 @@ public class UnlinkConnectionRequest [SpeakeasyMetadata("request:mediaType=application/json")] public UpdateConnectionStatus? UpdateConnectionStatus { get; set; } + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier for a connection. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs b/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs index f41f043e8..601640353 100755 --- a/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UnlinkConnectionResponse.cs @@ -22,6 +22,9 @@ public class UnlinkConnectionResponse /// public Connection? Connection { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class UnlinkConnectionResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 7a1582773..d55b59872 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateCompanyRequest.cs @@ -19,6 +19,9 @@ public class UpdateCompanyRequest [SpeakeasyMetadata("request:mediaType=application/json")] public CompanyRequestBody? CompanyRequestBody { get; set; } + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs index 70ff7f733..9a9ad4369 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateCompanyResponse.cs @@ -22,6 +22,9 @@ public class UpdateCompanyResponse /// public Company? Company { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class UpdateCompanyResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 a1032e5f5..3ab5c3c79 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationRequest.cs @@ -19,9 +19,15 @@ public class UpdateConnectionAuthorizationRequest [SpeakeasyMetadata("request:mediaType=application/json")] public Dictionary? RequestBody { get; set; } + /// + /// Unique identifier for a company. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier for a connection. + /// [SpeakeasyMetadata("pathParam:style=simple,explode=false,name=connectionId")] public string ConnectionId { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs index b03356281..567e1554f 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateConnectionAuthorizationResponse.cs @@ -22,10 +22,19 @@ public class UpdateConnectionAuthorizationResponse /// public Connection? Connection { get; set; } + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 8ef777edc..6e9aeb49c 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class UpdateProfileResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -29,8 +32,14 @@ public class UpdateProfileResponse /// public Profile? Profile { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 1fe5433ec..f79f4abf0 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsRequestBody.cs @@ -24,11 +24,17 @@ namespace CodatPlatform.Models.Operations public class UpdateProfileSyncSettingsRequestBody { + /// + /// Unique identifier for your client in Codat. + /// [JsonProperty("clientId")] public string ClientId { get; set; } = default!; + /// + /// Set to `True` if you want to override default <a href="https://docs.codat.io/knowledge-base/advanced-sync-settings">sync settings</a>. + /// [JsonProperty("overridesDefaults")] - public bool OverridesDefaults { get; set; } = default!; + public bool? OverridesDefaults { get; set; } [JsonProperty("settings")] public List Settings { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs index 18a64bf46..a25eda9ac 100755 --- a/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs +++ b/platform/CodatPlatform/Models/Operations/UpdateProfileSyncSettingsResponse.cs @@ -17,6 +17,9 @@ namespace CodatPlatform.Models.Operations public class UpdateProfileSyncSettingsResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; /// @@ -24,8 +27,14 @@ public class UpdateProfileSyncSettingsResponse /// public ErrorMessage? ErrorMessage { get; set; } + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { 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 f6ece6aca..86fa63c93 100755 --- a/platform/CodatPlatform/Models/Shared/Companies.cs +++ b/platform/CodatPlatform/Models/Shared/Companies.cs @@ -19,15 +19,24 @@ public class Companies [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/Company.cs b/platform/CodatPlatform/Models/Shared/Company.cs index 89c242a70..b78ba99e0 100755 --- a/platform/CodatPlatform/Models/Shared/Company.cs +++ b/platform/CodatPlatform/Models/Shared/Company.cs @@ -54,6 +54,9 @@ public class Company [JsonProperty("created")] public string? Created { get; set; } + /// + /// Name of user that created the company in Codat. + /// [JsonProperty("createdByUserName")] public string? CreatedByUserName { get; set; } @@ -105,6 +108,9 @@ public class Company [JsonProperty("name")] public string Name { get; set; } = default!; + /// + /// `platformKeys` name used when creating the company. + /// [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; } diff --git a/platform/CodatPlatform/Models/Shared/Connection.cs b/platform/CodatPlatform/Models/Shared/Connection.cs index 26fa1f29c..0df9e809a 100755 --- a/platform/CodatPlatform/Models/Shared/Connection.cs +++ b/platform/CodatPlatform/Models/Shared/Connection.cs @@ -112,9 +112,15 @@ public class Connection [JsonProperty("lastSync")] public string? LastSync { get; set; } + /// + /// The link URL your customers can use to authorize access to their business application. + /// [JsonProperty("linkUrl")] public string LinkUrl { get; set; } = default!; + /// + /// Name of integration connected to company. + /// [JsonProperty("platformName")] public string PlatformName { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs index c459330a1..50bce92cd 100755 --- a/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs +++ b/platform/CodatPlatform/Models/Shared/ConnectionStatusChangedWebhookData.cs @@ -34,7 +34,7 @@ public class ConnectionStatusChangedWebhookData public DataConnectionStatus? OldStatus { get; set; } /// - /// 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. + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. /// [JsonProperty("platformKey")] public string? PlatformKey { get; set; } diff --git a/platform/CodatPlatform/Models/Shared/Connections.cs b/platform/CodatPlatform/Models/Shared/Connections.cs index e48335bed..65ed9cb51 100755 --- a/platform/CodatPlatform/Models/Shared/Connections.cs +++ b/platform/CodatPlatform/Models/Shared/Connections.cs @@ -19,15 +19,24 @@ public class Connections [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/CreateApiKey.cs b/platform/CodatPlatform/Models/Shared/CreateApiKey.cs index 4241c64db..29d68a19e 100755 --- a/platform/CodatPlatform/Models/Shared/CreateApiKey.cs +++ b/platform/CodatPlatform/Models/Shared/CreateApiKey.cs @@ -13,7 +13,7 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; /// - /// Details of the API key. + /// Details about the newly created API key. /// public class CreateApiKey { diff --git a/platform/CodatPlatform/Models/Shared/CreateRule.cs b/platform/CodatPlatform/Models/Shared/CreateRule.cs index 410c4e9a5..d8ab93792 100755 --- a/platform/CodatPlatform/Models/Shared/CreateRule.cs +++ b/platform/CodatPlatform/Models/Shared/CreateRule.cs @@ -18,12 +18,18 @@ namespace CodatPlatform.Models.Shared public class CreateRule { + /// + /// Unique identifier for your SMB in Codat. + /// [JsonProperty("companyId")] public string? CompanyId { get; set; } [JsonProperty("notifiers")] - public CreateRuleNotifiers Notifiers { get; set; } = default!; + public WebhookNotifier Notifiers { get; set; } = default!; + /// + /// The type of webhook. + /// [JsonProperty("type")] public string Type { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/DataConnectionError.cs b/platform/CodatPlatform/Models/Shared/DataConnectionError.cs index 16965f937..8d67c8390 100755 --- a/platform/CodatPlatform/Models/Shared/DataConnectionError.cs +++ b/platform/CodatPlatform/Models/Shared/DataConnectionError.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Shared public class DataConnectionError { + /// + /// A brief message about the error. + /// [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } @@ -45,9 +48,15 @@ public class DataConnectionError [JsonProperty("erroredOnUtc")] public string? ErroredOnUtc { get; set; } + /// + /// The HTTP status code returned by the error. + /// [JsonProperty("statusCode")] public string? StatusCode { get; set; } + /// + /// A non-numeric status code/text. + /// [JsonProperty("statusText")] public string? StatusText { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs b/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs index 2d61f7ebb..7c3cd9008 100755 --- a/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs +++ b/platform/CodatPlatform/Models/Shared/DataConnectionStatus.cs @@ -39,7 +39,13 @@ public static DataConnectionStatus ToEnum(this string value) { foreach(var field in typeof(DataConnectionStatus).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/DataStatus.cs b/platform/CodatPlatform/Models/Shared/DataStatus.cs index df0be592d..df6a26ad2 100755 --- a/platform/CodatPlatform/Models/Shared/DataStatus.cs +++ b/platform/CodatPlatform/Models/Shared/DataStatus.cs @@ -18,11 +18,17 @@ namespace CodatPlatform.Models.Shared public class DataStatus { + /// + /// The current status of the dataset in Codat&apos;s cache. + /// [JsonProperty("currentStatus")] public string CurrentStatus { get; set; } = default!; + /// + /// Available Data types + /// [JsonProperty("dataType")] - public string DataType { get; set; } = default!; + public DataStatusDataTypes DataType { get; set; } = default!; /// /// 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/> @@ -51,9 +57,15 @@ public class DataStatus [JsonProperty("lastSuccessfulSync")] public string LastSuccessfulSync { get; set; } = default!; + /// + /// Unique identifier for the most recent successful sync of data type. + /// [JsonProperty("latestSuccessfulSyncId")] public string? LatestSuccessfulSyncId { get; set; } + /// + /// Unique identifier for most recent sync of data type. + /// [JsonProperty("latestSyncId")] public string? LatestSyncId { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs b/platform/CodatPlatform/Models/Shared/DataStatusDataTypes.cs similarity index 84% rename from platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs rename to platform/CodatPlatform/Models/Shared/DataStatusDataTypes.cs index 1f9b8f769..9bfe63559 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSettingDataTypes.cs +++ b/platform/CodatPlatform/Models/Shared/DataStatusDataTypes.cs @@ -16,7 +16,7 @@ namespace CodatPlatform.Models.Shared /// /// Available Data types /// - public enum SyncSettingDataTypes + public enum DataStatusDataTypes { [JsonProperty("accountTransactions")] AccountTransactions, @@ -104,30 +104,36 @@ public enum SyncSettingDataTypes CommerceTransactions, } - public static class SyncSettingDataTypesExtension + public static class DataStatusDataTypesExtension { - public static string Value(this SyncSettingDataTypes value) + public static string Value(this DataStatusDataTypes value) { return ((JsonPropertyAttribute)value.GetType().GetMember(value.ToString())[0].GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0]).PropertyName ?? value.ToString(); } - public static SyncSettingDataTypes ToEnum(this string value) + public static DataStatusDataTypes ToEnum(this string value) { - foreach(var field in typeof(SyncSettingDataTypes).GetFields()) + foreach(var field in typeof(DataStatusDataTypes).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); - if (enumVal is SyncSettingDataTypes) + if (enumVal is DataStatusDataTypes) { - return (SyncSettingDataTypes)enumVal; + return (DataStatusDataTypes)enumVal; } } } - throw new Exception($"Unknown value {value} for enum SyncSettingDataTypes"); + throw new Exception($"Unknown value {value} for enum DataStatusDataTypes"); } } } \ No newline at end of file diff --git a/platform/CodatPlatform/Models/Shared/DataType.cs b/platform/CodatPlatform/Models/Shared/DataType.cs index cadb0fc5a..1bd04fd2e 100755 --- a/platform/CodatPlatform/Models/Shared/DataType.cs +++ b/platform/CodatPlatform/Models/Shared/DataType.cs @@ -115,7 +115,13 @@ public static DataType ToEnum(this string value) { foreach(var field in typeof(DataType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/ErrorMessage.cs b/platform/CodatPlatform/Models/Shared/ErrorMessage.cs index c7675165e..ef1745d7e 100755 --- a/platform/CodatPlatform/Models/Shared/ErrorMessage.cs +++ b/platform/CodatPlatform/Models/Shared/ErrorMessage.cs @@ -15,21 +15,39 @@ namespace CodatPlatform.Models.Shared public class ErrorMessage { + /// + /// `True` if the error occurred transiently and can be retried. + /// [JsonProperty("canBeRetried")] public string? CanBeRetried { get; set; } + /// + /// Unique identifier used to propagate to all downstream services and determine the source of the error. + /// [JsonProperty("correlationId")] public string? CorrelationId { get; set; } + /// + /// Machine readable error code used to automate processes based on the code returned. + /// [JsonProperty("detailedErrorCode")] public long? DetailedErrorCode { get; set; } + /// + /// A brief description of the error. + /// [JsonProperty("error")] public string? Error { get; set; } + /// + /// Codat&apos;s service the returned the error. + /// [JsonProperty("service")] public string? Service { get; set; } + /// + /// The HTTP status code returned by the error. + /// [JsonProperty("statusCode")] public long? StatusCode { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/FeatureState.cs b/platform/CodatPlatform/Models/Shared/FeatureState.cs index 401400fd4..bae079798 100755 --- a/platform/CodatPlatform/Models/Shared/FeatureState.cs +++ b/platform/CodatPlatform/Models/Shared/FeatureState.cs @@ -13,6 +13,9 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; + /// + /// The current release state of the feature. + /// public enum FeatureState { [JsonProperty("Release")] @@ -40,7 +43,13 @@ public static FeatureState ToEnum(this string value) { foreach(var field in typeof(FeatureState).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/FeatureType.cs b/platform/CodatPlatform/Models/Shared/FeatureType.cs index f75bfa79a..1dca6e971 100755 --- a/platform/CodatPlatform/Models/Shared/FeatureType.cs +++ b/platform/CodatPlatform/Models/Shared/FeatureType.cs @@ -13,6 +13,9 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; + /// + /// The type of feature. + /// public enum FeatureType { [JsonProperty("Get")] @@ -48,7 +51,13 @@ public static FeatureType ToEnum(this string value) { foreach(var field in typeof(FeatureType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/HalRef.cs b/platform/CodatPlatform/Models/Shared/HalRef.cs index e49de01dd..f8e2b2151 100755 --- a/platform/CodatPlatform/Models/Shared/HalRef.cs +++ b/platform/CodatPlatform/Models/Shared/HalRef.cs @@ -15,6 +15,9 @@ namespace CodatPlatform.Models.Shared public class HalRef { + /// + /// Uri hypertext reference. + /// [JsonProperty("href")] public string? Href { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/Integration.cs b/platform/CodatPlatform/Models/Shared/Integration.cs index dd725b43b..cf9345d31 100755 --- a/platform/CodatPlatform/Models/Shared/Integration.cs +++ b/platform/CodatPlatform/Models/Shared/Integration.cs @@ -19,6 +19,9 @@ namespace CodatPlatform.Models.Shared public class Integration { + /// + /// The name of the data provider. + /// [JsonProperty("dataProvidedBy")] public string? DataProvidedBy { get; set; } @@ -26,7 +29,7 @@ public class Integration public List? DatatypeFeatures { get; set; } /// - /// Whether this integration is enabled for your customers to use + /// Whether this integration is enabled for your customers to use. /// [JsonProperty("enabled")] public bool Enabled { get; set; } = default!; @@ -37,21 +40,33 @@ public class Integration [JsonProperty("integrationId")] public string? IntegrationId { get; set; } + /// + /// `True` if the integration is currently in beta release. + /// [JsonProperty("isBeta")] public bool? IsBeta { get; set; } + /// + /// `True` if the integration is to an application installed and run locally on an SMBs computer. + /// [JsonProperty("isOfflineConnector")] public bool? IsOfflineConnector { get; set; } /// - /// 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. + /// A unique 4-letter key to represent a platform in each integration. View <a href="https://docs.codat.io/integrations/accounting/overview#platform-keys">accounting</a>, <a href="https://docs.codat.io/integrations/banking/overview#platform-keys">banking</a>, and <a href="https://docs.codat.io/integrations/commerce/overview#platform-keys">commerce</a> platform keys. /// [JsonProperty("key")] public string Key { get; set; } = default!; + /// + /// Static url for integration&apos;s logo. + /// [JsonProperty("logoUrl")] public string LogoUrl { get; set; } = default!; + /// + /// Name of integration. + /// [JsonProperty("name")] public string Name { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Shared/Integrations.cs b/platform/CodatPlatform/Models/Shared/Integrations.cs index 6390a9c25..5127c24f3 100755 --- a/platform/CodatPlatform/Models/Shared/Integrations.cs +++ b/platform/CodatPlatform/Models/Shared/Integrations.cs @@ -19,15 +19,24 @@ public class Integrations [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/Profile.cs b/platform/CodatPlatform/Models/Shared/Profile.cs index 36960de4b..70cff3455 100755 --- a/platform/CodatPlatform/Models/Shared/Profile.cs +++ b/platform/CodatPlatform/Models/Shared/Profile.cs @@ -20,29 +20,53 @@ namespace CodatPlatform.Models.Shared public class Profile { + /// + /// Alert or webhooks authorization header. + /// [JsonProperty("alertAuthHeader")] public string? AlertAuthHeader { get; set; } + /// + /// The API key for this Codat instance. + /// [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; } + /// + /// `True` if the company name has been confirmed. + /// [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; } + /// + /// Static url to your organization&apos;s icon. + /// [JsonProperty("iconUrl")] public string? IconUrl { get; set; } + /// + /// Static url to your organization&apos;s logo. + /// [JsonProperty("logoUrl")] public string? LogoUrl { get; set; } + /// + /// The name given to the instance. + /// [JsonProperty("name")] public string Name { get; set; } = default!; + /// + /// The redirect URL pasted on to the SMB once Codat&apos;s <a href="https://docs.codat.io/auth-flow/authorize-hosted-link">Hosted Link</a> has been completed by the SMB. + /// [JsonProperty("redirectUrl")] public string RedirectUrl { get; set; } = default!; + /// + /// A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. + /// [JsonProperty("whiteListUrls")] public List? WhiteListUrls { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/PullOperation.cs b/platform/CodatPlatform/Models/Shared/PullOperation.cs index 2741fd3ef..fd5a93910 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperation.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperation.cs @@ -22,24 +22,45 @@ namespace CodatPlatform.Models.Shared public class PullOperation { + /// + /// Unique identifier of the company associated to this pull operation. + /// [JsonProperty("companyId")] public string CompanyId { get; set; } = default!; + /// + /// Unique identifier of the connection associated to this pull operation. + /// [JsonProperty("connectionId")] public string ConnectionId { get; set; } = default!; + /// + /// Available Data types + /// [JsonProperty("dataType")] - public string DataType { get; set; } = default!; + public DataType DataType { get; set; } = default!; + /// + /// Unique identifier of the pull operation. + /// [JsonProperty("id")] public string Id { get; set; } = default!; + /// + /// `True` if the pull operation completed successfully. + /// [JsonProperty("isCompleted")] public bool IsCompleted { get; set; } = default!; + /// + /// `True` if the pull operation entered an error state. + /// [JsonProperty("isErrored")] public bool IsErrored { get; set; } = default!; + /// + /// An integer signifying the progress of the pull operation. + /// [JsonProperty("progress")] public long Progress { get; set; } = default!; @@ -70,6 +91,9 @@ public class PullOperation [JsonProperty("requested")] public string Requested { get; set; } = default!; + /// + /// The current status of the pull operation. + /// [JsonProperty("status")] public PullOperationStatus Status { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs b/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs index 3fa68e442..77247450f 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperationStatus.cs @@ -13,6 +13,9 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; + /// + /// The current status of the pull operation. + /// public enum PullOperationStatus { [JsonProperty("Initial")] @@ -74,7 +77,13 @@ public static PullOperationStatus ToEnum(this string value) { foreach(var field in typeof(PullOperationStatus).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/PullOperations.cs b/platform/CodatPlatform/Models/Shared/PullOperations.cs index ce98f4b1a..e6ce809e8 100755 --- a/platform/CodatPlatform/Models/Shared/PullOperations.cs +++ b/platform/CodatPlatform/Models/Shared/PullOperations.cs @@ -19,15 +19,24 @@ public class PullOperations [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/PushChangeType.cs b/platform/CodatPlatform/Models/Shared/PushChangeType.cs index 7321e1bc3..66466d05b 100755 --- a/platform/CodatPlatform/Models/Shared/PushChangeType.cs +++ b/platform/CodatPlatform/Models/Shared/PushChangeType.cs @@ -13,6 +13,9 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; + /// + /// Type of change being applied to record in third party platform. + /// public enum PushChangeType { [JsonProperty("Unknown")] @@ -38,7 +41,13 @@ public static PushChangeType ToEnum(this string value) { foreach(var field in typeof(PushChangeType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs b/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs index 7f6495472..6080f5d13 100755 --- a/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs +++ b/platform/CodatPlatform/Models/Shared/PushFieldValidation.cs @@ -15,12 +15,21 @@ namespace CodatPlatform.Models.Shared public class PushFieldValidation { + /// + /// Details on the validation issue. + /// [JsonProperty("details")] public string Details { get; set; } = default!; + /// + /// Field name that resulted in the validation issue. + /// [JsonProperty("field")] public string? Field { get; set; } + /// + /// Unique reference identifier for the validation issue. + /// [JsonProperty("ref")] public string? Ref { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/PushOperation.cs b/platform/CodatPlatform/Models/Shared/PushOperation.cs index 725949099..2067d3843 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperation.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperation.cs @@ -68,6 +68,9 @@ public class PushOperation [JsonProperty("dataType")] public DataType? DataType { get; set; } + /// + /// A message about the error. + /// [JsonProperty("errorMessage")] public string? ErrorMessage { get; set; } @@ -110,12 +113,21 @@ public class PushOperation [JsonProperty("status")] public PushOperationStatus Status { get; set; } = default!; + /// + /// Push status code. + /// [JsonProperty("statusCode")] public long StatusCode { get; set; } = default!; + /// + /// Number of minutes the push operation must complete within before it times out. + /// [JsonProperty("timeoutInMinutes")] public int? TimeoutInMinutes { get; set; } + /// + /// Number of seconds the push operation must complete within before it times out. + /// [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; } diff --git a/platform/CodatPlatform/Models/Shared/PushOperationChange.cs b/platform/CodatPlatform/Models/Shared/PushOperationChange.cs index da8245076..9bdcd4322 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationChange.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationChange.cs @@ -15,12 +15,18 @@ namespace CodatPlatform.Models.Shared public class PushOperationChange { + /// + /// Unique identifier for the attachment created otherwise null. + /// [JsonProperty("attachmentId")] public string? AttachmentId { get; set; } [JsonProperty("recordRef")] public PushOperationRef? RecordRef { get; set; } + /// + /// Type of change being applied to record in third party platform. + /// [JsonProperty("type")] public PushChangeType? Type { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/PushOperationRef.cs b/platform/CodatPlatform/Models/Shared/PushOperationRef.cs index 21ba133b3..4f880529a 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationRef.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationRef.cs @@ -21,6 +21,9 @@ public class PushOperationRef [JsonProperty("dataType")] public DataType? DataType { get; set; } + /// + /// Unique identifier for a push operation. + /// [JsonProperty("id")] public string? Id { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs b/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs index 35ea01824..c96b0d8d7 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperationStatus.cs @@ -39,7 +39,13 @@ public static PushOperationStatus ToEnum(this string value) { foreach(var field in typeof(PushOperationStatus).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/PushOperations.cs b/platform/CodatPlatform/Models/Shared/PushOperations.cs index 02bd70250..b453c092d 100755 --- a/platform/CodatPlatform/Models/Shared/PushOperations.cs +++ b/platform/CodatPlatform/Models/Shared/PushOperations.cs @@ -19,15 +19,24 @@ public class PushOperations [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/PushOption.cs b/platform/CodatPlatform/Models/Shared/PushOption.cs index 40e0dac19..4aaca2a3d 100755 --- a/platform/CodatPlatform/Models/Shared/PushOption.cs +++ b/platform/CodatPlatform/Models/Shared/PushOption.cs @@ -16,9 +16,15 @@ namespace CodatPlatform.Models.Shared public class PushOption { + /// + /// A description of the property. + /// [JsonProperty("description")] public string? Description { get; set; } + /// + /// The property&apos;s display name. + /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; @@ -28,9 +34,15 @@ public class PushOption [JsonProperty("properties")] public Dictionary? Properties { get; set; } + /// + /// The property is required if `True`. + /// [JsonProperty("required")] public bool Required { get; set; } = default!; + /// + /// The option type. + /// [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs b/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs index f42bfa3f0..4224c5eb2 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionChoice.cs @@ -15,15 +15,27 @@ namespace CodatPlatform.Models.Shared public class PushOptionChoice { + /// + /// A description of the property. + /// [JsonProperty("description")] public string? Description { get; set; } + /// + /// The property&apos;s display name. + /// [JsonProperty("displayName")] public string? DisplayName { get; set; } + /// + /// The property is required if `True`. + /// [JsonProperty("required")] public bool? Required { get; set; } + /// + /// The option type. + /// [JsonProperty("type")] public PushOptionType? Type { get; set; } diff --git a/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs b/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs index 739c328c2..cdc92d064 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionProperty.cs @@ -16,9 +16,15 @@ namespace CodatPlatform.Models.Shared public class PushOptionProperty { + /// + /// A description of the property. + /// [JsonProperty("description")] public string Description { get; set; } = default!; + /// + /// The property&apos;s display name. + /// [JsonProperty("displayName")] public string DisplayName { get; set; } = default!; @@ -28,9 +34,15 @@ public class PushOptionProperty [JsonProperty("properties")] public Dictionary? Properties { get; set; } + /// + /// The property is required if `True`. + /// [JsonProperty("required")] public bool Required { get; set; } = default!; + /// + /// The option type. + /// [JsonProperty("type")] public PushOptionType Type { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Shared/PushOptionType.cs b/platform/CodatPlatform/Models/Shared/PushOptionType.cs index b24ce8ca2..7caee3b7d 100755 --- a/platform/CodatPlatform/Models/Shared/PushOptionType.cs +++ b/platform/CodatPlatform/Models/Shared/PushOptionType.cs @@ -13,6 +13,9 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System; + /// + /// The option type. + /// public enum PushOptionType { [JsonProperty("Array")] @@ -44,7 +47,13 @@ public static PushOptionType ToEnum(this string value) { foreach(var field in typeof(PushOptionType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/SourceType.cs b/platform/CodatPlatform/Models/Shared/SourceType.cs index 174279514..0ed6f25d0 100755 --- a/platform/CodatPlatform/Models/Shared/SourceType.cs +++ b/platform/CodatPlatform/Models/Shared/SourceType.cs @@ -41,7 +41,13 @@ public static SourceType ToEnum(this string value) { foreach(var field in typeof(SourceType).GetFields()) { - var attribute = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false)[0] as JsonPropertyAttribute; + var attributes = field.GetCustomAttributes(typeof(JsonPropertyAttribute), false); + if (attributes.Length == 0) + { + continue; + } + + var attribute = attributes[0] as JsonPropertyAttribute; if (attribute != null && attribute.PropertyName == value) { var enumVal = field.GetValue(null); diff --git a/platform/CodatPlatform/Models/Shared/SupportedFeature.cs b/platform/CodatPlatform/Models/Shared/SupportedFeature.cs index 4a61f3ca2..23871828c 100755 --- a/platform/CodatPlatform/Models/Shared/SupportedFeature.cs +++ b/platform/CodatPlatform/Models/Shared/SupportedFeature.cs @@ -15,9 +15,15 @@ namespace CodatPlatform.Models.Shared public class SupportedFeature { + /// + /// The current release state of the feature. + /// [JsonProperty("featureState")] public FeatureState FeatureState { get; set; } = default!; + /// + /// The type of feature. + /// [JsonProperty("featureType")] public FeatureType FeatureType { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/SyncSetting.cs b/platform/CodatPlatform/Models/Shared/SyncSetting.cs index 6aacaa49d..e8b289a40 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSetting.cs +++ b/platform/CodatPlatform/Models/Shared/SyncSetting.cs @@ -22,7 +22,7 @@ public class SyncSetting /// Available Data types /// [JsonProperty("dataType")] - public SyncSettingDataTypes DataType { get; set; } = default!; + public DataType DataType { get; set; } = default!; /// /// Whether this data type should be queued after a company has authorized a connection. @@ -30,6 +30,9 @@ public class SyncSetting [JsonProperty("fetchOnFirstLink")] public bool FetchOnFirstLink { get; set; } = default!; + /// + /// `True` if the <a href="https://docs.codat.io/knowledge-base/advanced-sync-settings">sync setting</a> is locked. + /// [JsonProperty("isLocked")] public bool? IsLocked { get; set; } @@ -67,11 +70,14 @@ public class SyncSetting public string? SyncFromUtc { get; set; } /// - /// Number of months of data to be fetched. Set this *or* `syncFromUTC` + /// Number of months of data to be fetched. Set this *or* `syncFromUTC`. /// [JsonProperty("syncFromWindow")] public long? SyncFromWindow { get; set; } + /// + /// The sync in which data types are queued for a sync. + /// [JsonProperty("syncOrder")] public long SyncOrder { get; set; } = default!; diff --git a/platform/CodatPlatform/Models/Shared/SyncSettings.cs b/platform/CodatPlatform/Models/Shared/SyncSettings.cs index 9a18798e5..998bfbf63 100755 --- a/platform/CodatPlatform/Models/Shared/SyncSettings.cs +++ b/platform/CodatPlatform/Models/Shared/SyncSettings.cs @@ -16,9 +16,15 @@ namespace CodatPlatform.Models.Shared public class SyncSettings { + /// + /// Unique identifier for your client in Codat. + /// [JsonProperty("clientId")] public string? ClientId { get; set; } + /// + /// Set to `True` if you want to override the default <a href="https://docs.codat.io/knowledge-base/advanced-sync-settings">sync settings</a>. + /// [JsonProperty("overridesDefaults")] public bool? OverridesDefaults { get; set; } diff --git a/platform/CodatPlatform/Models/Shared/ValidationItem.cs b/platform/CodatPlatform/Models/Shared/ValidationItem.cs index 8e0effd49..1d7a9a859 100755 --- a/platform/CodatPlatform/Models/Shared/ValidationItem.cs +++ b/platform/CodatPlatform/Models/Shared/ValidationItem.cs @@ -15,12 +15,21 @@ namespace CodatPlatform.Models.Shared public class ValidationItem { + /// + /// Unique identifier for a validation item. + /// [JsonProperty("itemId")] public string? ItemId { get; set; } + /// + /// A message outlining validation item&apos;s issue. + /// [JsonProperty("message")] public string? Message { get; set; } + /// + /// Name of validator. + /// [JsonProperty("validatorName")] public string? ValidatorName { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/Webhook.cs b/platform/CodatPlatform/Models/Shared/Webhook.cs index 77f9cdc96..c26cdf81c 100755 --- a/platform/CodatPlatform/Models/Shared/Webhook.cs +++ b/platform/CodatPlatform/Models/Shared/Webhook.cs @@ -18,15 +18,24 @@ namespace CodatPlatform.Models.Shared public class Webhook { + /// + /// Unique identifier for your SMB in Codat. + /// [JsonProperty("companyId")] public string? CompanyId { get; set; } + /// + /// Unique identifier for the configured notification. + /// [JsonProperty("id")] public string? Id { get; set; } [JsonProperty("notifiers")] - public WebhookNotifiers Notifiers { get; set; } = default!; + public WebhookNotifier Notifiers { get; set; } = default!; + /// + /// The type of webhook. + /// [JsonProperty("type")] public string Type { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs b/platform/CodatPlatform/Models/Shared/WebhookNotifier.cs similarity index 83% rename from platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs rename to platform/CodatPlatform/Models/Shared/WebhookNotifier.cs index 262954420..7ada7c43b 100755 --- a/platform/CodatPlatform/Models/Shared/CreateRuleNotifiers.cs +++ b/platform/CodatPlatform/Models/Shared/WebhookNotifier.cs @@ -13,12 +13,15 @@ namespace CodatPlatform.Models.Shared using Newtonsoft.Json; using System.Collections.Generic; - public class CreateRuleNotifiers + public class WebhookNotifier { [JsonProperty("emails")] public List? Emails { get; set; } + /// + /// The URI the webhook service will POST events. + /// [JsonProperty("webhook")] public string? Webhook { get; set; } } diff --git a/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs b/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs deleted file mode 100755 index 6753947d2..000000000 --- a/platform/CodatPlatform/Models/Shared/WebhookNotifiers.cs +++ /dev/null @@ -1,25 +0,0 @@ - -//------------------------------------------------------------------------------ -// -// 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; - 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 a26573dc3..c8dcfd140 100755 --- a/platform/CodatPlatform/Models/Shared/Webhooks.cs +++ b/platform/CodatPlatform/Models/Shared/Webhooks.cs @@ -19,15 +19,24 @@ public class Webhooks [JsonProperty("_links")] public Links Links { get; set; } = default!; + /// + /// Current page number. + /// [JsonProperty("pageNumber")] public long PageNumber { get; set; } = default!; + /// + /// Number of items to return in results array. + /// [JsonProperty("pageSize")] public long PageSize { get; set; } = default!; [JsonProperty("results")] public List? Results { get; set; } + /// + /// Total number of items. + /// [JsonProperty("totalResults")] public long TotalResults { get; set; } = default!; } diff --git a/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs index 2bbbcda35..b255a20e5 100755 --- a/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitReachedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class ClientRateLimitReachedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 index e51a11899..a20830966 100755 --- a/platform/CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/ClientRateLimitResetResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class ClientRateLimitResetResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 4fabb0e8f..52e29bb89 100755 --- a/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/CompanyDataConnectionStatusChangedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class CompanyDataConnectionStatusChangedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 3237db3f0..a16b1a07d 100755 --- a/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DataSyncCompletedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class DataSyncCompletedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 a4cc6f233..5afafd6c1 100755 --- a/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DatasetDataChangedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class DatasetDataChangedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 54e4426e3..2ca3412b9 100755 --- a/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class DatasetStatusHasChangedToAnErrorStateResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 592a68696..a1a8ff671 100755 --- a/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class NewCompanySynchronizedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 a83fe7f26..272b7e776 100755 --- a/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class PushOperationHasTimedOutResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// 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 0bdecca11..737ff1042 100755 --- a/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs +++ b/platform/CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs @@ -16,10 +16,19 @@ namespace CodatPlatform.Models.Webhooks public class PushOperationStatusHasChangedResponse { + /// + /// HTTP response content type for this operation + /// public string? ContentType { get; set; } = default!; + /// + /// HTTP response status code for this operation + /// public int StatusCode { get; set; } = default!; + /// + /// Raw HTTP response; suitable for custom response parsing + /// public HttpResponseMessage? RawResponse { get; set; } } } \ No newline at end of file diff --git a/platform/CodatPlatform/PushData.cs b/platform/CodatPlatform/PushData.cs index 38a180136..0a3f52392 100755 --- a/platform/CodatPlatform/PushData.cs +++ b/platform/CodatPlatform/PushData.cs @@ -62,12 +62,15 @@ public interface IPushDataSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -112,7 +115,7 @@ public async Task GetModelOptions { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PushOption = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PushOption = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -121,7 +124,7 @@ public async Task GetModelOptions { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -160,7 +163,7 @@ public async Task GetOperationAsync(GetPushOperationRe { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PushOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PushOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -169,7 +172,7 @@ public async Task GetOperationAsync(GetPushOperationRe { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -208,7 +211,7 @@ public async Task ListOperationsAsync(GetCompanyP { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PushOperations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PushOperations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -217,7 +220,7 @@ public async Task ListOperationsAsync(GetCompanyP { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/RefreshData.cs b/platform/CodatPlatform/RefreshData.cs index e7f9fb1c9..5bde2d47a 100755 --- a/platform/CodatPlatform/RefreshData.cs +++ b/platform/CodatPlatform/RefreshData.cs @@ -78,12 +78,15 @@ public interface IRefreshDataSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -133,7 +136,7 @@ public async Task AllAsync(RefreshCompanyDataRequest { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -172,7 +175,7 @@ public async Task ByDataTypeAsync(RefreshDataTypeReques { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PullOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PullOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -181,7 +184,7 @@ public async Task ByDataTypeAsync(RefreshDataTypeReques { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -220,7 +223,7 @@ public async Task GetAsync(GetCompanyDataStatusReq { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.DataStatuses = JsonConvert.DeserializeObject>(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.DataStatuses = JsonConvert.DeserializeObject>(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -229,7 +232,7 @@ public async Task GetAsync(GetCompanyDataStatusReq { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -268,7 +271,7 @@ public async Task GetPullOperationAsync(GetPullOperati { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PullOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PullOperation = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -277,7 +280,7 @@ public async Task GetPullOperationAsync(GetPullOperati { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -316,7 +319,7 @@ public async Task ListPullOperationsAsync(ListPullOp { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.PullOperations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.PullOperations = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -325,7 +328,7 @@ public async Task ListPullOperationsAsync(ListPullOp { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/Settings.cs b/platform/CodatPlatform/Settings.cs index 2a0d1d310..1f10cde28 100755 --- a/platform/CodatPlatform/Settings.cs +++ b/platform/CodatPlatform/Settings.cs @@ -75,7 +75,7 @@ public interface ISettingsSDK /// 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. + /// 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(); @@ -112,12 +112,15 @@ public interface ISettingsSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -167,7 +170,7 @@ public async Task CreateApiKeyAsync(CreateApiKey? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ApiKeyDetails = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ApiKeyDetails = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -176,7 +179,7 @@ public async Task CreateApiKeyAsync(CreateApiKey? request { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -220,7 +223,7 @@ public async Task DeleteApiKeyAsync(DeleteApiKeyRequest? r { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -260,7 +263,7 @@ public async Task GetProfileAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Profile = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Profile = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -269,7 +272,7 @@ public async Task GetProfileAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -308,7 +311,7 @@ public async Task GetSyncSettingsAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.SyncSettings = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.SyncSettings = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -317,7 +320,7 @@ public async Task GetSyncSettingsAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -356,7 +359,7 @@ public async Task ListApiKeysAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ApiKeys = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ApiKeys = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -365,7 +368,7 @@ public async Task ListApiKeysAsync() { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -409,7 +412,7 @@ public async Task UpdateProfileAsync(Profile? request = n { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Profile = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Profile = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -418,7 +421,7 @@ public async Task UpdateProfileAsync(Profile? request = n { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -467,7 +470,7 @@ public async Task UpdateSyncSettingsAsync(Upd { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/SupplementalData.cs b/platform/CodatPlatform/SupplementalData.cs index 4a6fd5942..fe5d7ead7 100755 --- a/platform/CodatPlatform/SupplementalData.cs +++ b/platform/CodatPlatform/SupplementalData.cs @@ -51,12 +51,15 @@ public interface ISupplementalDataSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -111,7 +114,7 @@ public async Task ConfigureAsync(ConfigureSup { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -150,7 +153,7 @@ public async Task GetConfigurationAsyn { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.SupplementalDataConfiguration = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.SupplementalDataConfiguration = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -159,7 +162,7 @@ public async Task GetConfigurationAsyn { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/CodatPlatform/Utils/EnumSerializer.cs b/platform/CodatPlatform/Utils/EnumSerializer.cs index 7a323a333..8b1dce2c9 100755 --- a/platform/CodatPlatform/Utils/EnumSerializer.cs +++ b/platform/CodatPlatform/Utils/EnumSerializer.cs @@ -9,20 +9,42 @@ //------------------------------------------------------------------------------ #nullable enable using System; -using System.Linq; using Newtonsoft.Json; namespace CodatPlatform.Utils { - internal class EnumSerializer: JsonConverter + internal class EnumSerializer : JsonConverter { - public override bool CanConvert(Type objectType) => - objectType.IsEnum; + public override bool CanConvert(Type objectType) => objectType.IsEnum; - public override bool CanRead => false; + public override bool CanRead => true; - public override object? ReadJson(JsonReader reader, Type objectType, object? existingValue, JsonSerializer serializer) => - throw new NotImplementedException(); + public override object? ReadJson( + JsonReader reader, + Type objectType, + object? existingValue, + JsonSerializer serializer + ) + { + if (reader.Value == null) + { + throw new ArgumentNullException(nameof(reader.Value)); + } + + var extensionType = Type.GetType(objectType.FullName + "Extension"); + if (extensionType == null) + { + return Enum.ToObject(objectType, reader.Value); + } + + var method = extensionType.GetMethod("ToEnum"); + if (method == null) + { + throw new Exception($"Unable to find ToEnum method on {extensionType.FullName}"); + } + + return method.Invoke(null, new[] { (string)reader.Value }); + } public override void WriteJson(JsonWriter writer, object? value, JsonSerializer serializer) { @@ -32,19 +54,14 @@ public override void WriteJson(JsonWriter writer, object? value, JsonSerializer return; } - var isInt = false; - var attributes = value.GetType().GetMember(value.ToString() ?? "").First().CustomAttributes; - if(attributes.Count() == 0 || attributes.First().ConstructorArguments.Count() == 0) + var extensionType = Type.GetType(value.GetType().FullName + "Extension"); + if (extensionType == null) { - isInt = true; - } - var parsedValue = Utilities.ToString(value); - if(isInt) - { - writer.WriteValue(int.Parse(parsedValue)); + writer.WriteValue(value); return; } - writer.WriteValue(parsedValue); + + writer.WriteValue(Utilities.ToString(value)); } } -} \ No newline at end of file +} diff --git a/platform/CodatPlatform/Webhooks.cs b/platform/CodatPlatform/Webhooks.cs index 6e34fcded..b55d19cd8 100755 --- a/platform/CodatPlatform/Webhooks.cs +++ b/platform/CodatPlatform/Webhooks.cs @@ -53,12 +53,15 @@ public interface IWebhooksSDK 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 = "1.1.0"; - private const string _sdkGenVersion = "2.116.0"; + private const string _sdkVersion = "2.1.0"; + private const string _sdkGenVersion = "2.129.1"; private const string _openapiDocVersion = "3.0.0"; private string _serverUrl = ""; private ISpeakeasyHttpClient _defaultClient; @@ -108,7 +111,7 @@ public async Task CreateAsync(CreateRule? request = null) { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Webhook = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Webhook = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -117,7 +120,7 @@ public async Task CreateAsync(CreateRule? request = null) { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -156,7 +159,7 @@ public async Task GetAsync(GetWebhookRequest? request = null { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Webhook = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Webhook = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -165,7 +168,7 @@ public async Task GetAsync(GetWebhookRequest? request = null { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -204,7 +207,7 @@ public async Task ListAsync(ListRulesRequest? request = null) { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.Webhooks = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.Webhooks = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; @@ -213,7 +216,7 @@ public async Task ListAsync(ListRulesRequest? request = null) { if(Utilities.IsContentTypeMatch("application/json", response.ContentType)) { - response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer() }}); + response.ErrorMessage = JsonConvert.DeserializeObject(await httpResponse.Content.ReadAsStringAsync(), new JsonSerializerSettings(){ NullValueHandling = NullValueHandling.Ignore, Converters = new JsonConverter[] { new FlexibleObjectDeserializer(), new EnumSerializer() }}); } return response; diff --git a/platform/README.md b/platform/README.md index 0352313ff..2582000c5 100644 --- a/platform/README.md +++ b/platform/README.md @@ -12,8 +12,6 @@ dotnet add package Codat.Platform ## Example Usage - - ```csharp using CodatPlatform; using CodatPlatform.Models.Shared; @@ -95,4 +93,16 @@ var res = await sdk.Companies.CreateAsync(new CompanyRequestBody() { * [Get](docs/sdks/webhooks/README.md#get) - Get webhook * [List](docs/sdks/webhooks/README.md#list) - List webhooks + + + + + + + + + + + + ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/platform/RELEASES.md b/platform/RELEASES.md index 8158f5a37..e067476bb 100644 --- a/platform/RELEASES.md +++ b/platform/RELEASES.md @@ -56,4 +56,14 @@ Based on: ### 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 +- [NuGet v1.1.0] https://www.nuget.org/packages/Codat.Platform/1.1.0 - platform + +## 2023-09-25 17:12:34 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml +- Speakeasy CLI 1.91.0 (2.129.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v2.1.0] platform +### Releases +- [NuGet v2.1.0] https://www.nuget.org/packages/Codat.Platform/2.1.0 - platform \ No newline at end of file diff --git a/platform/docs/models/operations/ConfigureSupplementalDataRequest.md b/platform/docs/models/operations/ConfigureSupplementalDataRequest.md index 6906bd95a..b73b5d3f7 100755 --- a/platform/docs/models/operations/ConfigureSupplementalDataRequest.md +++ b/platform/docs/models/operations/ConfigureSupplementalDataRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `supplementalDataConfiguration` | [SupplementalDataConfiguration](../../models/shared/SupplementalDataConfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | | -| `dataType` | [ConfigureSupplementalDataDataType](../../models/operations/ConfigureSupplementalDataDataType.md) | :heavy_check_mark: | Data types that support supplemental data | invoices | -| `platformKey` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `supplementalDataConfiguration` | [SupplementalDataConfiguration](../../models/shared/SupplementalDataConfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | | +| `dataType` | [ConfigureSupplementalDataDataType](../../models/operations/ConfigureSupplementalDataDataType.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices | +| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/operations/ConfigureSupplementalDataResponse.md b/platform/docs/models/operations/ConfigureSupplementalDataResponse.md index a889e7188..72ddc0b5a 100755 --- a/platform/docs/models/operations/ConfigureSupplementalDataResponse.md +++ b/platform/docs/models/operations/ConfigureSupplementalDataResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateApiKeyResponse.md b/platform/docs/models/operations/CreateApiKeyResponse.md index a1684922b..0061f9e1b 100755 --- a/platform/docs/models/operations/CreateApiKeyResponse.md +++ b/platform/docs/models/operations/CreateApiKeyResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `apiKeyDetails` | [ApiKeyDetails](../../models/shared/ApiKeyDetails.md) | :heavy_minus_sign: | Success | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Bad Request | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateCompanyResponse.md b/platform/docs/models/operations/CreateCompanyResponse.md index ac3bf49f5..cc27cd06e 100755 --- a/platform/docs/models/operations/CreateCompanyResponse.md +++ b/platform/docs/models/operations/CreateCompanyResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `company` | [Company](../../models/shared/Company.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | The request made is not valid. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateConnectionRequest.md b/platform/docs/models/operations/CreateConnectionRequest.md index 39ccb26af..a3d536164 100755 --- a/platform/docs/models/operations/CreateConnectionRequest.md +++ b/platform/docs/models/operations/CreateConnectionRequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `requestBody` | [CreateConnectionRequestBody](../../models/operations/CreateConnectionRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateConnectionRequestBody.md b/platform/docs/models/operations/CreateConnectionRequestBody.md index eeac22694..509321abe 100755 --- a/platform/docs/models/operations/CreateConnectionRequestBody.md +++ b/platform/docs/models/operations/CreateConnectionRequestBody.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `platformKey` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `platformKey` | *string* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateConnectionResponse.md b/platform/docs/models/operations/CreateConnectionResponse.md index 936578c89..116e9c1ad 100755 --- a/platform/docs/models/operations/CreateConnectionResponse.md +++ b/platform/docs/models/operations/CreateConnectionResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `connection` | [Connection](../../models/shared/Connection.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/CreateRuleResponse.md b/platform/docs/models/operations/CreateRuleResponse.md index b4684321e..e0e511e00 100755 --- a/platform/docs/models/operations/CreateRuleResponse.md +++ b/platform/docs/models/operations/CreateRuleResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `webhook` | [Webhook](../../models/shared/Webhook.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/DeleteApiKeyResponse.md b/platform/docs/models/operations/DeleteApiKeyResponse.md index 3c597c30f..8ed66190e 100755 --- a/platform/docs/models/operations/DeleteApiKeyResponse.md +++ b/platform/docs/models/operations/DeleteApiKeyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/DeleteCompanyRequest.md b/platform/docs/models/operations/DeleteCompanyRequest.md index 1bdbce512..98229acfd 100755 --- a/platform/docs/models/operations/DeleteCompanyRequest.md +++ b/platform/docs/models/operations/DeleteCompanyRequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/DeleteCompanyResponse.md b/platform/docs/models/operations/DeleteCompanyResponse.md index 14efe1a7f..dc2950afa 100755 --- a/platform/docs/models/operations/DeleteCompanyResponse.md +++ b/platform/docs/models/operations/DeleteCompanyResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/DeleteConnectionRequest.md b/platform/docs/models/operations/DeleteConnectionRequest.md index cfe904cdb..d0c939061 100755 --- a/platform/docs/models/operations/DeleteConnectionRequest.md +++ b/platform/docs/models/operations/DeleteConnectionRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/platform/docs/models/operations/DeleteConnectionResponse.md b/platform/docs/models/operations/DeleteConnectionResponse.md index fa097756f..ffca41f43 100755 --- a/platform/docs/models/operations/DeleteConnectionResponse.md +++ b/platform/docs/models/operations/DeleteConnectionResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCompanyDataStatusRequest.md b/platform/docs/models/operations/GetCompanyDataStatusRequest.md index 30e104cf0..b2de4efb4 100755 --- a/platform/docs/models/operations/GetCompanyDataStatusRequest.md +++ b/platform/docs/models/operations/GetCompanyDataStatusRequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCompanyDataStatusResponse.md b/platform/docs/models/operations/GetCompanyDataStatusResponse.md index 84a9d8c47..70de082d9 100755 --- a/platform/docs/models/operations/GetCompanyDataStatusResponse.md +++ b/platform/docs/models/operations/GetCompanyDataStatusResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `dataStatuses` | Dictionary | :heavy_minus_sign: | OK | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCompanyPushHistoryRequest.md b/platform/docs/models/operations/GetCompanyPushHistoryRequest.md index 69bb0a757..4174d3dd3 100755 --- a/platform/docs/models/operations/GetCompanyPushHistoryRequest.md +++ b/platform/docs/models/operations/GetCompanyPushHistoryRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *int* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `pageSize` | *int* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/platform/docs/models/operations/GetCompanyPushHistoryResponse.md b/platform/docs/models/operations/GetCompanyPushHistoryResponse.md index 582188fbe..62f0bf456 100755 --- a/platform/docs/models/operations/GetCompanyPushHistoryResponse.md +++ b/platform/docs/models/operations/GetCompanyPushHistoryResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `pushOperations` | [PushOperations](../../models/shared/PushOperations.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCompanyRequest.md b/platform/docs/models/operations/GetCompanyRequest.md index 125430571..7f66ad0c6 100755 --- a/platform/docs/models/operations/GetCompanyRequest.md +++ b/platform/docs/models/operations/GetCompanyRequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCompanyResponse.md b/platform/docs/models/operations/GetCompanyResponse.md index c3c7bbea9..1093d1ccd 100755 --- a/platform/docs/models/operations/GetCompanyResponse.md +++ b/platform/docs/models/operations/GetCompanyResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `company` | [Company](../../models/shared/Company.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetConnectionRequest.md b/platform/docs/models/operations/GetConnectionRequest.md index 99068c884..332a3226e 100755 --- a/platform/docs/models/operations/GetConnectionRequest.md +++ b/platform/docs/models/operations/GetConnectionRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/platform/docs/models/operations/GetConnectionResponse.md b/platform/docs/models/operations/GetConnectionResponse.md index 786574b55..02e8bbe2c 100755 --- a/platform/docs/models/operations/GetConnectionResponse.md +++ b/platform/docs/models/operations/GetConnectionResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `connection` | [Connection](../../models/shared/Connection.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeRequest.md b/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeRequest.md index 11373c44b..72e5c4d51 100755 --- a/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeRequest.md +++ b/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file diff --git a/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeResponse.md b/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeResponse.md index 7183eb75a..81a0dc440 100755 --- a/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeResponse.md +++ b/platform/docs/models/operations/GetCreateUpdateModelOptionsByDataTypeResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pushOption` | [PushOption](../../models/shared/PushOption.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetIntegrationRequest.md b/platform/docs/models/operations/GetIntegrationRequest.md index 2eb81ac6d..b29ed130b 100755 --- a/platform/docs/models/operations/GetIntegrationRequest.md +++ b/platform/docs/models/operations/GetIntegrationRequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `platformKey` | *string* | :heavy_check_mark: | N/A | gbol | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/operations/GetIntegrationResponse.md b/platform/docs/models/operations/GetIntegrationResponse.md index 5b55051d0..e33462a5c 100755 --- a/platform/docs/models/operations/GetIntegrationResponse.md +++ b/platform/docs/models/operations/GetIntegrationResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `integration` | [Integration](../../models/shared/Integration.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetIntegrationsBrandingRequest.md b/platform/docs/models/operations/GetIntegrationsBrandingRequest.md index fe758598b..ea3ebf8b7 100755 --- a/platform/docs/models/operations/GetIntegrationsBrandingRequest.md +++ b/platform/docs/models/operations/GetIntegrationsBrandingRequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | -| `platformKey` | *string* | :heavy_check_mark: | N/A | gbol | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/operations/GetIntegrationsBrandingResponse.md b/platform/docs/models/operations/GetIntegrationsBrandingResponse.md index ec3a8fb6d..4e8a6915c 100755 --- a/platform/docs/models/operations/GetIntegrationsBrandingResponse.md +++ b/platform/docs/models/operations/GetIntegrationsBrandingResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `branding` | [Branding](../../models/shared/Branding.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetProfileResponse.md b/platform/docs/models/operations/GetProfileResponse.md index a70796e05..e2c056f44 100755 --- a/platform/docs/models/operations/GetProfileResponse.md +++ b/platform/docs/models/operations/GetProfileResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `profile` | [Profile](../../models/shared/Profile.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetProfileSyncSettingsResponse.md b/platform/docs/models/operations/GetProfileSyncSettingsResponse.md index 87740c3a4..2335995ca 100755 --- a/platform/docs/models/operations/GetProfileSyncSettingsResponse.md +++ b/platform/docs/models/operations/GetProfileSyncSettingsResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `syncSettings` | [SyncSettings](../../models/shared/SyncSettings.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/GetPullOperationRequest.md b/platform/docs/models/operations/GetPullOperationRequest.md index f9f17313b..ccba0ec81 100755 --- a/platform/docs/models/operations/GetPullOperationRequest.md +++ b/platform/docs/models/operations/GetPullOperationRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `datasetId` | *string* | :heavy_check_mark: | Unique ID of a dataset or pull operation. | eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `datasetId` | *string* | :heavy_check_mark: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/platform/docs/models/operations/GetPullOperationResponse.md b/platform/docs/models/operations/GetPullOperationResponse.md index ce78491c2..b27393d86 100755 --- a/platform/docs/models/operations/GetPullOperationResponse.md +++ b/platform/docs/models/operations/GetPullOperationResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pullOperation` | [PullOperation](../../models/shared/PullOperation.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetPushOperationRequest.md b/platform/docs/models/operations/GetPushOperationRequest.md index 6c905d05f..153f6740e 100755 --- a/platform/docs/models/operations/GetPushOperationRequest.md +++ b/platform/docs/models/operations/GetPushOperationRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `pushOperationKey` | *string* | :heavy_check_mark: | Push operation key. | | \ No newline at end of file diff --git a/platform/docs/models/operations/GetPushOperationResponse.md b/platform/docs/models/operations/GetPushOperationResponse.md index 8b6dbd3a3..3890091c2 100755 --- a/platform/docs/models/operations/GetPushOperationResponse.md +++ b/platform/docs/models/operations/GetPushOperationResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pushOperation` | [PushOperation](../../models/shared/PushOperation.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/GetSupplementalDataConfigurationRequest.md b/platform/docs/models/operations/GetSupplementalDataConfigurationRequest.md index f5440b21e..33e29b7f1 100755 --- a/platform/docs/models/operations/GetSupplementalDataConfigurationRequest.md +++ b/platform/docs/models/operations/GetSupplementalDataConfigurationRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `dataType` | [GetSupplementalDataConfigurationDataType](../../models/operations/GetSupplementalDataConfigurationDataType.md) | :heavy_check_mark: | Data types that support supplemental data | invoices | -| `platformKey` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dataType` | [GetSupplementalDataConfigurationDataType](../../models/operations/GetSupplementalDataConfigurationDataType.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices | +| `platformKey` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/operations/GetSupplementalDataConfigurationResponse.md b/platform/docs/models/operations/GetSupplementalDataConfigurationResponse.md index e779151d0..1ea8ea5a9 100755 --- a/platform/docs/models/operations/GetSupplementalDataConfigurationResponse.md +++ b/platform/docs/models/operations/GetSupplementalDataConfigurationResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `supplementalDataConfiguration` | [SupplementalDataConfiguration](../../models/shared/SupplementalDataConfiguration.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/GetWebhookResponse.md b/platform/docs/models/operations/GetWebhookResponse.md index 43c3e999a..2532c12a4 100755 --- a/platform/docs/models/operations/GetWebhookResponse.md +++ b/platform/docs/models/operations/GetWebhookResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `webhook` | [Webhook](../../models/shared/Webhook.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/ListApiKeysResponse.md b/platform/docs/models/operations/ListApiKeysResponse.md index 57c450e11..7a71a62f9 100755 --- a/platform/docs/models/operations/ListApiKeysResponse.md +++ b/platform/docs/models/operations/ListApiKeysResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `apiKeys` | [ApiKeys](../../models/shared/ApiKeys.md) | :heavy_minus_sign: | Success | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/ListCompaniesResponse.md b/platform/docs/models/operations/ListCompaniesResponse.md index e1b882fc1..49280b1be 100755 --- a/platform/docs/models/operations/ListCompaniesResponse.md +++ b/platform/docs/models/operations/ListCompaniesResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `companies` | [Companies](../../models/shared/Companies.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/ListConnectionsRequest.md b/platform/docs/models/operations/ListConnectionsRequest.md index dd04a1fa1..28caf4c21 100755 --- a/platform/docs/models/operations/ListConnectionsRequest.md +++ b/platform/docs/models/operations/ListConnectionsRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *int* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `pageSize` | *int* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/platform/docs/models/operations/ListConnectionsResponse.md b/platform/docs/models/operations/ListConnectionsResponse.md index f469c5f66..eb934eb3d 100755 --- a/platform/docs/models/operations/ListConnectionsResponse.md +++ b/platform/docs/models/operations/ListConnectionsResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `connections` | [Connections](../../models/shared/Connections.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/ListIntegrationsResponse.md b/platform/docs/models/operations/ListIntegrationsResponse.md index 7f09d7f85..8d227f44b 100755 --- a/platform/docs/models/operations/ListIntegrationsResponse.md +++ b/platform/docs/models/operations/ListIntegrationsResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `integrations` | [Integrations](../../models/shared/Integrations.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/ListPullOperationsRequest.md b/platform/docs/models/operations/ListPullOperationsRequest.md index aa1a1e339..6b04f1372 100755 --- a/platform/docs/models/operations/ListPullOperationsRequest.md +++ b/platform/docs/models/operations/ListPullOperationsRequest.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `orderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | | `page` | *int* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | | `pageSize` | *int* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | diff --git a/platform/docs/models/operations/ListPullOperationsResponse.md b/platform/docs/models/operations/ListPullOperationsResponse.md index e46a944f6..f074fa840 100755 --- a/platform/docs/models/operations/ListPullOperationsResponse.md +++ b/platform/docs/models/operations/ListPullOperationsResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | | `pullOperations` | [PullOperations](../../models/shared/PullOperations.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/ListRulesResponse.md b/platform/docs/models/operations/ListRulesResponse.md index 6477e9b41..662b455dd 100755 --- a/platform/docs/models/operations/ListRulesResponse.md +++ b/platform/docs/models/operations/ListRulesResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your `query` parameter was not correctly formed | -| `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 | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | | `webhooks` | [Webhooks](../../models/shared/Webhooks.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/RefreshCompanyDataRequest.md b/platform/docs/models/operations/RefreshCompanyDataRequest.md index 258fc5aa2..728ae1550 100755 --- a/platform/docs/models/operations/RefreshCompanyDataRequest.md +++ b/platform/docs/models/operations/RefreshCompanyDataRequest.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/RefreshCompanyDataResponse.md b/platform/docs/models/operations/RefreshCompanyDataResponse.md index 0694dbd41..5fcca209c 100755 --- a/platform/docs/models/operations/RefreshCompanyDataResponse.md +++ b/platform/docs/models/operations/RefreshCompanyDataResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/RefreshDataTypeRequest.md b/platform/docs/models/operations/RefreshDataTypeRequest.md index b363995d2..cacbfb389 100755 --- a/platform/docs/models/operations/RefreshDataTypeRequest.md +++ b/platform/docs/models/operations/RefreshDataTypeRequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `connectionId` | *string* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | | `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file diff --git a/platform/docs/models/operations/RefreshDataTypeResponse.md b/platform/docs/models/operations/RefreshDataTypeResponse.md index 202a1840c..dfad634bf 100755 --- a/platform/docs/models/operations/RefreshDataTypeResponse.md +++ b/platform/docs/models/operations/RefreshDataTypeResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `pullOperation` | [PullOperation](../../models/shared/PullOperation.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/UnlinkConnectionRequest.md b/platform/docs/models/operations/UnlinkConnectionRequest.md index 06b54bcca..434c5f481 100755 --- a/platform/docs/models/operations/UnlinkConnectionRequest.md +++ b/platform/docs/models/operations/UnlinkConnectionRequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `updateConnectionStatus` | [UpdateConnectionStatus](../../models/shared/UpdateConnectionStatus.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/platform/docs/models/operations/UnlinkConnectionResponse.md b/platform/docs/models/operations/UnlinkConnectionResponse.md index bd47b0cc4..a7d2a66bb 100755 --- a/platform/docs/models/operations/UnlinkConnectionResponse.md +++ b/platform/docs/models/operations/UnlinkConnectionResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `connection` | [Connection](../../models/shared/Connection.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateCompanyRequest.md b/platform/docs/models/operations/UpdateCompanyRequest.md index dc485cb84..1576acb53 100755 --- a/platform/docs/models/operations/UpdateCompanyRequest.md +++ b/platform/docs/models/operations/UpdateCompanyRequest.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | | `companyRequestBody` | [CompanyRequestBody](../../models/shared/CompanyRequestBody.md) | :heavy_minus_sign: | N/A | | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateCompanyResponse.md b/platform/docs/models/operations/UpdateCompanyResponse.md index e4bae50cb..362275c57 100755 --- a/platform/docs/models/operations/UpdateCompanyResponse.md +++ b/platform/docs/models/operations/UpdateCompanyResponse.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `company` | [Company](../../models/shared/Company.md) | :heavy_minus_sign: | OK | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateConnectionAuthorizationRequest.md b/platform/docs/models/operations/UpdateConnectionAuthorizationRequest.md index d8229e476..e40289587 100755 --- a/platform/docs/models/operations/UpdateConnectionAuthorizationRequest.md +++ b/platform/docs/models/operations/UpdateConnectionAuthorizationRequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | | `requestBody` | Dictionary | :heavy_minus_sign: | N/A | | -| `companyId` | *string* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateConnectionAuthorizationResponse.md b/platform/docs/models/operations/UpdateConnectionAuthorizationResponse.md index 3ce76d2e8..9f47446e7 100755 --- a/platform/docs/models/operations/UpdateConnectionAuthorizationResponse.md +++ b/platform/docs/models/operations/UpdateConnectionAuthorizationResponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `connection` | [Connection](../../models/shared/Connection.md) | :heavy_minus_sign: | OK | -| `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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateProfileResponse.md b/platform/docs/models/operations/UpdateProfileResponse.md index b853ae821..adc265fc8 100755 --- a/platform/docs/models/operations/UpdateProfileResponse.md +++ b/platform/docs/models/operations/UpdateProfileResponse.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | | `profile` | [Profile](../../models/shared/Profile.md) | :heavy_minus_sign: | OK | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateProfileSyncSettingsRequestBody.md b/platform/docs/models/operations/UpdateProfileSyncSettingsRequestBody.md index 743c0c2d1..be0d0da8b 100755 --- a/platform/docs/models/operations/UpdateProfileSyncSettingsRequestBody.md +++ b/platform/docs/models/operations/UpdateProfileSyncSettingsRequestBody.md @@ -6,8 +6,8 @@ Include a `syncSetting` object for each data type. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `clientId` | *string* | :heavy_check_mark: | N/A | 367f7975-267b-439b-90c6-a6040ee680f3 | -| `overridesDefaults` | *bool* | :heavy_check_mark: | N/A | | -| `settings` | List<[SyncSetting](../../models/shared/SyncSetting.md)> | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `clientId` | *string* | :heavy_check_mark: | Unique identifier for your client in Codat. | +| `overridesDefaults` | *bool* | :heavy_minus_sign: | Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | +| `settings` | List<[SyncSetting](../../models/shared/SyncSetting.md)> | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/platform/docs/models/operations/UpdateProfileSyncSettingsResponse.md b/platform/docs/models/operations/UpdateProfileSyncSettingsResponse.md index 2583e970c..ea54d6844 100755 --- a/platform/docs/models/operations/UpdateProfileSyncSettingsResponse.md +++ b/platform/docs/models/operations/UpdateProfileSyncSettingsResponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | N/A | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | `errorMessage` | [ErrorMessage](../../models/shared/ErrorMessage.md) | :heavy_minus_sign: | Your API request was not properly authorized. | -| `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 +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/shared/Companies.md b/platform/docs/models/shared/Companies.md index 2ee5373cb..1a48d605a 100755 --- a/platform/docs/models/shared/Companies.md +++ b/platform/docs/models/shared/Companies.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[Company](../../models/shared/Company.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/shared/Company.md b/platform/docs/models/shared/Company.md index 7fe66fcda..54b694e54 100755 --- a/platform/docs/models/shared/Company.md +++ b/platform/docs/models/shared/Company.md @@ -12,11 +12,11 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `created` | *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 | -| `createdByUserName` | *string* | :heavy_minus_sign: | N/A | | +| `createdByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | | | `dataConnections` | List<[Connection](../../models/shared/Connection.md)> | :heavy_minus_sign: | N/A | | | `description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `id` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `lastSync` | *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 | | `name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. | -| ~~`platform`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | Xero | +| ~~`platform`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`platformKeys` name used when creating the company. | Xero | | `redirect` | *string* | :heavy_check_mark: | 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. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | \ No newline at end of file diff --git a/platform/docs/models/shared/Connection.md b/platform/docs/models/shared/Connection.md index f612756cb..c07cafde1 100755 --- a/platform/docs/models/shared/Connection.md +++ b/platform/docs/models/shared/Connection.md @@ -24,8 +24,8 @@ Before you can use a data connection to pull or push data, the company must gran | `integrationId` | *string* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integrationKey` | *string* | :heavy_check_mark: | 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. | | | `lastSync` | *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 | -| `linkUrl` | *string* | :heavy_check_mark: | N/A | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | -| `platformName` | *string* | :heavy_check_mark: | N/A | | +| `linkUrl` | *string* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | +| `platformName` | *string* | :heavy_check_mark: | Name of integration connected to company. | | | `sourceId` | *string* | :heavy_check_mark: | 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`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `sourceType` | [SourceType](../../models/shared/SourceType.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | | `status` | [DataConnectionStatus](../../models/shared/DataConnectionStatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | \ No newline at end of file diff --git a/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md b/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md index 0bba6c472..05eb20b1c 100755 --- a/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md +++ b/platform/docs/models/shared/ConnectionStatusChangedWebhookData.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `newStatus` | [DataConnectionStatus](../../models/shared/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | | -| `oldStatus` | [DataConnectionStatus](../../models/shared/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | | -| `platformKey` | *string* | :heavy_minus_sign: | 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. | gbol | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `newStatus` | [DataConnectionStatus](../../models/shared/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | | +| `oldStatus` | [DataConnectionStatus](../../models/shared/DataConnectionStatus.md) | :heavy_minus_sign: | The current authorization status of the data connection. | | +| `platformKey` | *string* | :heavy_minus_sign: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file diff --git a/platform/docs/models/shared/Connections.md b/platform/docs/models/shared/Connections.md index 70c5dc232..2d5310dc2 100755 --- a/platform/docs/models/shared/Connections.md +++ b/platform/docs/models/shared/Connections.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[Connection](../../models/shared/Connection.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/shared/CreateApiKey.md b/platform/docs/models/shared/CreateApiKey.md index 78b4a53ca..ea6974b1d 100755 --- a/platform/docs/models/shared/CreateApiKey.md +++ b/platform/docs/models/shared/CreateApiKey.md @@ -1,6 +1,6 @@ # CreateApiKey -Details of the API key. +Details about the newly created API key. ## Fields diff --git a/platform/docs/models/shared/CreateRule.md b/platform/docs/models/shared/CreateRule.md index 6b51b58ab..d721114ee 100755 --- a/platform/docs/models/shared/CreateRule.md +++ b/platform/docs/models/shared/CreateRule.md @@ -5,8 +5,8 @@ Create an event notification to a URL or list of email addresses based on the gi ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | -| `companyId` | *string* | :heavy_minus_sign: | N/A | 39b73b17-cc2e-429e-915d-71654e9dcd1e | -| `notifiers` | [CreateRuleNotifiers](../../models/shared/CreateRuleNotifiers.md) | :heavy_check_mark: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `notifiers` | [WebhookNotifier](../../models/shared/WebhookNotifier.md) | :heavy_check_mark: | N/A | | +| `type` | *string* | :heavy_check_mark: | The type of webhook. | | \ No newline at end of file diff --git a/platform/docs/models/shared/CreateRuleNotifiers.md b/platform/docs/models/shared/CreateRuleNotifiers.md deleted file mode 100755 index 34674d2da..000000000 --- a/platform/docs/models/shared/CreateRuleNotifiers.md +++ /dev/null @@ -1,9 +0,0 @@ -# CreateRuleNotifiers - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `emails` | List<*string*> | :heavy_minus_sign: | N/A | | -| `webhook` | *string* | :heavy_minus_sign: | N/A | https://webhook.client.com | \ No newline at end of file diff --git a/platform/docs/models/shared/DataConnectionError.md b/platform/docs/models/shared/DataConnectionError.md index 1cb39bf0f..dd54e2182 100755 --- a/platform/docs/models/shared/DataConnectionError.md +++ b/platform/docs/models/shared/DataConnectionError.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `errorMessage` | *string* | :heavy_minus_sign: | N/A | | +| `errorMessage` | *string* | :heavy_minus_sign: | A brief message about the error. | | | `erroredOnUtc` | *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 | -| `statusCode` | *string* | :heavy_minus_sign: | N/A | | -| `statusText` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `statusCode` | *string* | :heavy_minus_sign: | The HTTP status code returned by the error. | | +| `statusText` | *string* | :heavy_minus_sign: | A non-numeric status code/text. | | \ No newline at end of file diff --git a/platform/docs/models/shared/DataStatus.md b/platform/docs/models/shared/DataStatus.md index 910caaaa3..43df443d4 100755 --- a/platform/docs/models/shared/DataStatus.md +++ b/platform/docs/models/shared/DataStatus.md @@ -7,8 +7,8 @@ Describes the state of data in the Codat cache for a company and data type | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `currentStatus` | *string* | :heavy_check_mark: | N/A | | -| `dataType` | *string* | :heavy_check_mark: | N/A | | +| `currentStatus` | *string* | :heavy_check_mark: | The current status of the dataset in Codat's cache. | | +| `dataType` | [DataStatusDataTypes](../../models/shared/DataStatusDataTypes.md) | :heavy_check_mark: | Available Data types | invoices | | `lastSuccessfulSync` | *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 | -| `latestSuccessfulSyncId` | *string* | :heavy_minus_sign: | N/A | 8220fc90-55b6-47bc-9417-48ac6ea93101 | -| `latestSyncId` | *string* | :heavy_minus_sign: | N/A | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file +| `latestSuccessfulSyncId` | *string* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | +| `latestSyncId` | *string* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | \ No newline at end of file diff --git a/platform/docs/models/shared/SyncSettingDataTypes.md b/platform/docs/models/shared/DataStatusDataTypes.md similarity index 99% rename from platform/docs/models/shared/SyncSettingDataTypes.md rename to platform/docs/models/shared/DataStatusDataTypes.md index 3384a8d4f..5824a434e 100755 --- a/platform/docs/models/shared/SyncSettingDataTypes.md +++ b/platform/docs/models/shared/DataStatusDataTypes.md @@ -1,4 +1,4 @@ -# SyncSettingDataTypes +# DataStatusDataTypes Available Data types diff --git a/platform/docs/models/shared/ErrorMessage.md b/platform/docs/models/shared/ErrorMessage.md index 4ac5e8947..0e1b472b1 100755 --- a/platform/docs/models/shared/ErrorMessage.md +++ b/platform/docs/models/shared/ErrorMessage.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------- | ------------------- | ------------------- | ------------------- | -| `canBeRetried` | *string* | :heavy_minus_sign: | N/A | -| `correlationId` | *string* | :heavy_minus_sign: | N/A | -| `detailedErrorCode` | *long* | :heavy_minus_sign: | N/A | -| `error` | *string* | :heavy_minus_sign: | N/A | -| `service` | *string* | :heavy_minus_sign: | N/A | -| `statusCode` | *long* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `canBeRetried` | *string* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlationId` | *string* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailedErrorCode` | *long* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *string* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *string* | :heavy_minus_sign: | Codat's service the returned the error. | +| `statusCode` | *long* | :heavy_minus_sign: | The HTTP status code returned by the error. | \ No newline at end of file diff --git a/platform/docs/models/shared/FeatureState.md b/platform/docs/models/shared/FeatureState.md index 87c8979aa..58431e74e 100755 --- a/platform/docs/models/shared/FeatureState.md +++ b/platform/docs/models/shared/FeatureState.md @@ -1,5 +1,7 @@ # FeatureState +The current release state of the feature. + ## Values diff --git a/platform/docs/models/shared/FeatureType.md b/platform/docs/models/shared/FeatureType.md index 2fbbce898..358892c67 100755 --- a/platform/docs/models/shared/FeatureType.md +++ b/platform/docs/models/shared/FeatureType.md @@ -1,5 +1,7 @@ # FeatureType +The type of feature. + ## Values diff --git a/platform/docs/models/shared/HalRef.md b/platform/docs/models/shared/HalRef.md index e31d9646b..a19023707 100755 --- a/platform/docs/models/shared/HalRef.md +++ b/platform/docs/models/shared/HalRef.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `href` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `href` | *string* | :heavy_minus_sign: | Uri hypertext reference. | \ No newline at end of file diff --git a/platform/docs/models/shared/Integration.md b/platform/docs/models/shared/Integration.md index 7f71ba24e..622090b27 100755 --- a/platform/docs/models/shared/Integration.md +++ b/platform/docs/models/shared/Integration.md @@ -5,16 +5,16 @@ An integration that Codat supports ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataProvidedBy` | *string* | :heavy_minus_sign: | N/A | | -| `datatypeFeatures` | List<[DataTypeFeature](../../models/shared/DataTypeFeature.md)> | :heavy_minus_sign: | N/A | | -| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use | | -| `integrationId` | *string* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | -| `isBeta` | *bool* | :heavy_minus_sign: | N/A | | -| `isOfflineConnector` | *bool* | :heavy_minus_sign: | N/A | | -| `key` | *string* | :heavy_check_mark: | 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. | gbol | -| `logoUrl` | *string* | :heavy_check_mark: | N/A | | -| `name` | *string* | :heavy_check_mark: | N/A | Xero | -| `sourceId` | *string* | :heavy_minus_sign: | 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`. | 35b92968-9851-4095-ad60-395c95cbcba4 | -| `sourceType` | [SourceType](../../models/shared/SourceType.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dataProvidedBy` | *string* | :heavy_minus_sign: | The name of the data provider. | | +| `datatypeFeatures` | List<[DataTypeFeature](../../models/shared/DataTypeFeature.md)> | :heavy_minus_sign: | N/A | | +| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | | +| `integrationId` | *string* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | +| `isBeta` | *bool* | :heavy_minus_sign: | `True` if the integration is currently in beta release. | | +| `isOfflineConnector` | *bool* | :heavy_minus_sign: | `True` if the integration is to an application installed and run locally on an SMBs computer. | | +| `key` | *string* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | +| `logoUrl` | *string* | :heavy_check_mark: | Static url for integration's logo. | | +| `name` | *string* | :heavy_check_mark: | Name of integration. | Xero | +| `sourceId` | *string* | :heavy_minus_sign: | 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`. | 35b92968-9851-4095-ad60-395c95cbcba4 | +| `sourceType` | [SourceType](../../models/shared/SourceType.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting | \ No newline at end of file diff --git a/platform/docs/models/shared/Integrations.md b/platform/docs/models/shared/Integrations.md index 8f759dc73..2590e0cb6 100755 --- a/platform/docs/models/shared/Integrations.md +++ b/platform/docs/models/shared/Integrations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[Integration](../../models/shared/Integration.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/shared/Profile.md b/platform/docs/models/shared/Profile.md index c06c79ad3..0e52a7b25 100755 --- a/platform/docs/models/shared/Profile.md +++ b/platform/docs/models/shared/Profile.md @@ -5,13 +5,13 @@ Describes your Codat client instance ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `alertAuthHeader` | *string* | :heavy_minus_sign: | N/A | Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2 | -| ~~`apiKey`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB | -| ~~`confirmCompanyName`~~ | *bool* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | -| `iconUrl` | *string* | :heavy_minus_sign: | N/A | https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico | -| `logoUrl` | *string* | :heavy_minus_sign: | N/A | https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png | -| `name` | *string* | :heavy_check_mark: | N/A | Bob's Burgers | -| `redirectUrl` | *string* | :heavy_check_mark: | N/A | https://bobs-burgers.{countrySuffix}/{companyId} | -| `whiteListUrls` | List<*string*> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `alertAuthHeader` | *string* | :heavy_minus_sign: | Alert or webhooks authorization header. | Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2 | +| ~~`apiKey`~~ | *string* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The API key for this Codat instance. | sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB | +| ~~`confirmCompanyName`~~ | *bool* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`True` if the company name has been confirmed. | | +| `iconUrl` | *string* | :heavy_minus_sign: | Static url to your organization's icon. | https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico | +| `logoUrl` | *string* | :heavy_minus_sign: | Static url to your organization's logo. | https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png | +| `name` | *string* | :heavy_check_mark: | The name given to the instance. | Bob's Burgers | +| `redirectUrl` | *string* | :heavy_check_mark: | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. | https://bobs-burgers.{countrySuffix}/{companyId} | +| `whiteListUrls` | List<*string*> | :heavy_minus_sign: | A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PullOperation.md b/platform/docs/models/shared/PullOperation.md index 329f0af43..8ca2f4e00 100755 --- a/platform/docs/models/shared/PullOperation.md +++ b/platform/docs/models/shared/PullOperation.md @@ -8,12 +8,12 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `companyId` | *string* | :heavy_check_mark: | N/A | 22ece347-e5f6-4896-95e0-35a4c7f17023 | -| `connectionId` | *string* | :heavy_check_mark: | N/A | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | -| `dataType` | *string* | :heavy_check_mark: | N/A | | -| `id` | *string* | :heavy_check_mark: | N/A | 943accd0-4247-42d8-865b-363c8629e1da | -| `isCompleted` | *bool* | :heavy_check_mark: | N/A | | -| `isErrored` | *bool* | :heavy_check_mark: | N/A | | -| `progress` | *long* | :heavy_check_mark: | N/A | | +| `companyId` | *string* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | +| `connectionId` | *string* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_check_mark: | Available Data types | invoices | +| `id` | *string* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | +| `isCompleted` | *bool* | :heavy_check_mark: | `True` if the pull operation completed successfully. | | +| `isErrored` | *bool* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | +| `progress` | *long* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `requested` | *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` | [PullOperationStatus](../../models/shared/PullOperationStatus.md) | :heavy_check_mark: | N/A | Complete | \ No newline at end of file +| `status` | [PullOperationStatus](../../models/shared/PullOperationStatus.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | \ No newline at end of file diff --git a/platform/docs/models/shared/PullOperationStatus.md b/platform/docs/models/shared/PullOperationStatus.md index 50ac8e217..240317c20 100755 --- a/platform/docs/models/shared/PullOperationStatus.md +++ b/platform/docs/models/shared/PullOperationStatus.md @@ -1,5 +1,7 @@ # PullOperationStatus +The current status of the pull operation. + ## Values diff --git a/platform/docs/models/shared/PullOperations.md b/platform/docs/models/shared/PullOperations.md index 24f5ffa52..59909ed50 100755 --- a/platform/docs/models/shared/PullOperations.md +++ b/platform/docs/models/shared/PullOperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[PullOperation](../../models/shared/PullOperation.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/shared/PushChangeType.md b/platform/docs/models/shared/PushChangeType.md index 87b354b8a..7585e9c8c 100755 --- a/platform/docs/models/shared/PushChangeType.md +++ b/platform/docs/models/shared/PushChangeType.md @@ -1,5 +1,7 @@ # PushChangeType +Type of change being applied to record in third party platform. + ## Values diff --git a/platform/docs/models/shared/PushFieldValidation.md b/platform/docs/models/shared/PushFieldValidation.md index 03518c94d..d8ab81aa1 100755 --- a/platform/docs/models/shared/PushFieldValidation.md +++ b/platform/docs/models/shared/PushFieldValidation.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `details` | *string* | :heavy_check_mark: | N/A | -| `field` | *string* | :heavy_minus_sign: | N/A | -| `ref` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `details` | *string* | :heavy_check_mark: | Details on the validation issue. | +| `field` | *string* | :heavy_minus_sign: | Field name that resulted in the validation issue. | +| `ref` | *string* | :heavy_minus_sign: | Unique reference identifier for the validation issue. | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperation.md b/platform/docs/models/shared/PushOperation.md index b7b0e1a98..71f2ed741 100755 --- a/platform/docs/models/shared/PushOperation.md +++ b/platform/docs/models/shared/PushOperation.md @@ -10,11 +10,11 @@ | `completedOnUtc` | *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 | | `dataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | -| `errorMessage` | *string* | :heavy_minus_sign: | N/A | | +| `errorMessage` | *string* | :heavy_minus_sign: | A message about the error. | | | `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 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. | | +| `statusCode` | *long* | :heavy_check_mark: | Push status code. | | +| `timeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | +| ~~`timeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Validation](../../models/shared/Validation.md) | :heavy_minus_sign: | 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. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperationChange.md b/platform/docs/models/shared/PushOperationChange.md index e21a45a07..ded991d4b 100755 --- a/platform/docs/models/shared/PushOperationChange.md +++ b/platform/docs/models/shared/PushOperationChange.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `attachmentId` | *string* | :heavy_minus_sign: | N/A | -| `recordRef` | [PushOperationRef](../../models/shared/PushOperationRef.md) | :heavy_minus_sign: | N/A | -| `type` | [PushChangeType](../../models/shared/PushChangeType.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `attachmentId` | *string* | :heavy_minus_sign: | Unique identifier for the attachment created otherwise null. | +| `recordRef` | [PushOperationRef](../../models/shared/PushOperationRef.md) | :heavy_minus_sign: | N/A | +| `type` | [PushChangeType](../../models/shared/PushChangeType.md) | :heavy_minus_sign: | Type of change being applied to record in third party platform. | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperationRef.md b/platform/docs/models/shared/PushOperationRef.md index c56ba798d..d7dce914f 100755 --- a/platform/docs/models/shared/PushOperationRef.md +++ b/platform/docs/models/shared/PushOperationRef.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | Example | | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | | `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_minus_sign: | Available Data types | invoices | -| `id` | *string* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `id` | *string* | :heavy_minus_sign: | Unique identifier for a push operation. | | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOperations.md b/platform/docs/models/shared/PushOperations.md index 5490ccd3c..5683c8b7f 100755 --- a/platform/docs/models/shared/PushOperations.md +++ b/platform/docs/models/shared/PushOperations.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[PushOperation](../../models/shared/PushOperation.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOption.md b/platform/docs/models/shared/PushOption.md index a09050876..950ef3e63 100755 --- a/platform/docs/models/shared/PushOption.md +++ b/platform/docs/models/shared/PushOption.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `displayName` | *string* | :heavy_check_mark: | N/A | +| `description` | *string* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *string* | :heavy_check_mark: | The property's display name. | | `options` | List<[PushOptionChoice](../../models/shared/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | | `properties` | Dictionary | :heavy_minus_sign: | N/A | -| `required` | *bool* | :heavy_check_mark: | N/A | -| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_check_mark: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_check_mark: | The option type. | | `validation` | [PushValidationInfo](../../models/shared/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOptionChoice.md b/platform/docs/models/shared/PushOptionChoice.md index 14954cca2..287a75e7f 100755 --- a/platform/docs/models/shared/PushOptionChoice.md +++ b/platform/docs/models/shared/PushOptionChoice.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `description` | *string* | :heavy_minus_sign: | N/A | -| `displayName` | *string* | :heavy_minus_sign: | N/A | -| `required` | *bool* | :heavy_minus_sign: | N/A | -| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_minus_sign: | N/A | +| `description` | *string* | :heavy_minus_sign: | A description of the property. | +| `displayName` | *string* | :heavy_minus_sign: | The property's display name. | +| `required` | *bool* | :heavy_minus_sign: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_minus_sign: | The option type. | | `value` | *string* | :heavy_minus_sign: | Allowed value for field. | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOptionProperty.md b/platform/docs/models/shared/PushOptionProperty.md index ad08448f4..0062cb4ff 100755 --- a/platform/docs/models/shared/PushOptionProperty.md +++ b/platform/docs/models/shared/PushOptionProperty.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `description` | *string* | :heavy_check_mark: | N/A | -| `displayName` | *string* | :heavy_check_mark: | N/A | +| `description` | *string* | :heavy_check_mark: | A description of the property. | +| `displayName` | *string* | :heavy_check_mark: | The property's display name. | | `options` | List<[PushOptionChoice](../../models/shared/PushOptionChoice.md)> | :heavy_minus_sign: | N/A | | `properties` | Dictionary | :heavy_minus_sign: | N/A | -| `required` | *bool* | :heavy_check_mark: | N/A | -| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_check_mark: | N/A | +| `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | +| `type` | [PushOptionType](../../models/shared/PushOptionType.md) | :heavy_check_mark: | The option type. | | `validation` | [PushValidationInfo](../../models/shared/PushValidationInfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/PushOptionType.md b/platform/docs/models/shared/PushOptionType.md index fc8bd8416..f1bb37088 100755 --- a/platform/docs/models/shared/PushOptionType.md +++ b/platform/docs/models/shared/PushOptionType.md @@ -1,5 +1,7 @@ # PushOptionType +The option type. + ## Values diff --git a/platform/docs/models/shared/SupportedFeature.md b/platform/docs/models/shared/SupportedFeature.md index 17639b66f..6ad57443b 100755 --- a/platform/docs/models/shared/SupportedFeature.md +++ b/platform/docs/models/shared/SupportedFeature.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | -| `featureState` | [FeatureState](../../models/shared/FeatureState.md) | :heavy_check_mark: | N/A | Release | -| `featureType` | [FeatureType](../../models/shared/FeatureType.md) | :heavy_check_mark: | N/A | Get | \ No newline at end of file +| `featureState` | [FeatureState](../../models/shared/FeatureState.md) | :heavy_check_mark: | The current release state of the feature. | Release | +| `featureType` | [FeatureType](../../models/shared/FeatureType.md) | :heavy_check_mark: | The type of feature. | Get | \ No newline at end of file diff --git a/platform/docs/models/shared/SyncSetting.md b/platform/docs/models/shared/SyncSetting.md index 0919dc603..54604b6b2 100755 --- a/platform/docs/models/shared/SyncSetting.md +++ b/platform/docs/models/shared/SyncSetting.md @@ -7,11 +7,11 @@ Describes how often, and how much history, should be fetched for the given data | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dataType` | [SyncSettingDataTypes](../../models/shared/SyncSettingDataTypes.md) | :heavy_check_mark: | Available Data types | invoices | +| `dataType` | [DataType](../../models/shared/DataType.md) | :heavy_check_mark: | Available Data types | invoices | | `fetchOnFirstLink` | *bool* | :heavy_check_mark: | Whether this data type should be queued after a company has authorized a connection. | | -| `isLocked` | *bool* | :heavy_minus_sign: | N/A | | +| `isLocked` | *bool* | :heavy_minus_sign: | `True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked. | | | `monthsToSync` | *long* | :heavy_minus_sign: | Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only. | 24 | | `syncFromUtc` | *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 | -| `syncFromWindow` | *long* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC` | 24 | -| `syncOrder` | *long* | :heavy_check_mark: | N/A | | +| `syncFromWindow` | *long* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC`. | 24 | +| `syncOrder` | *long* | :heavy_check_mark: | The sync in which data types are queued for a sync. | | | `syncSchedule` | *long* | :heavy_check_mark: | Number of hours after which this data type should be refreshed. | 24 | \ No newline at end of file diff --git a/platform/docs/models/shared/SyncSettings.md b/platform/docs/models/shared/SyncSettings.md index 73b824d80..912d61786 100755 --- a/platform/docs/models/shared/SyncSettings.md +++ b/platform/docs/models/shared/SyncSettings.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `clientId` | *string* | :heavy_minus_sign: | N/A | 367f7975-267b-439b-90c6-a6040ee680f3 | -| `overridesDefaults` | *bool* | :heavy_minus_sign: | N/A | | -| `settings` | List<[SyncSetting](../../models/shared/SyncSetting.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `overridesDefaults` | *bool* | :heavy_minus_sign: | Set to `True` if you want to override the default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | +| `settings` | List<[SyncSetting](../../models/shared/SyncSetting.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/ValidationItem.md b/platform/docs/models/shared/ValidationItem.md index dbfd8be3b..6f7fb3235 100755 --- a/platform/docs/models/shared/ValidationItem.md +++ b/platform/docs/models/shared/ValidationItem.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ------------------ | ------------------ | ------------------ | ------------------ | -| `itemId` | *string* | :heavy_minus_sign: | N/A | -| `message` | *string* | :heavy_minus_sign: | N/A | -| `validatorName` | *string* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `itemId` | *string* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *string* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validatorName` | *string* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/platform/docs/models/shared/Webhook.md b/platform/docs/models/shared/Webhook.md index 4ea9d7c1c..e9ef58640 100755 --- a/platform/docs/models/shared/Webhook.md +++ b/platform/docs/models/shared/Webhook.md @@ -5,9 +5,9 @@ Create an event notification to a URL or list of email addresses based on the gi ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | -| `companyId` | *string* | :heavy_minus_sign: | N/A | 39b73b17-cc2e-429e-915d-71654e9dcd1e | -| `id` | *string* | :heavy_minus_sign: | N/A | ff89c50e-a719-4ef5-a182-9917e53927b6 | -| `notifiers` | [WebhookNotifiers](../../models/shared/WebhookNotifiers.md) | :heavy_check_mark: | N/A | | -| `type` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `companyId` | *string* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `id` | *string* | :heavy_minus_sign: | Unique identifier for the configured notification. | ff89c50e-a719-4ef5-a182-9917e53927b6 | +| `notifiers` | [WebhookNotifier](../../models/shared/WebhookNotifier.md) | :heavy_check_mark: | N/A | | +| `type` | *string* | :heavy_check_mark: | The type of webhook. | | \ No newline at end of file diff --git a/platform/docs/models/shared/WebhookNotifier.md b/platform/docs/models/shared/WebhookNotifier.md new file mode 100755 index 000000000..5130fcbb8 --- /dev/null +++ b/platform/docs/models/shared/WebhookNotifier.md @@ -0,0 +1,9 @@ +# WebhookNotifier + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- | +| `emails` | List<*string*> | :heavy_minus_sign: | N/A | | +| `webhook` | *string* | :heavy_minus_sign: | The URI the webhook service will POST events. | https://webhook.client.com | \ No newline at end of file diff --git a/platform/docs/models/shared/WebhookNotifiers.md b/platform/docs/models/shared/WebhookNotifiers.md deleted file mode 100755 index e6a1a967c..000000000 --- a/platform/docs/models/shared/WebhookNotifiers.md +++ /dev/null @@ -1,9 +0,0 @@ -# WebhookNotifiers - - -## Fields - -| Field | Type | Required | Description | Example | -| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | -| `emails` | List<*string*> | :heavy_minus_sign: | N/A | | -| `webhook` | *string* | :heavy_minus_sign: | N/A | https://webhook.client.com | \ No newline at end of file diff --git a/platform/docs/models/shared/Webhooks.md b/platform/docs/models/shared/Webhooks.md index b448525c3..8ec7a30a1 100755 --- a/platform/docs/models/shared/Webhooks.md +++ b/platform/docs/models/shared/Webhooks.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | | `links` | [Links](../../models/shared/Links.md) | :heavy_check_mark: | N/A | -| `pageNumber` | *long* | :heavy_check_mark: | N/A | -| `pageSize` | *long* | :heavy_check_mark: | N/A | +| `pageNumber` | *long* | :heavy_check_mark: | Current page number. | +| `pageSize` | *long* | :heavy_check_mark: | Number of items to return in results array. | | `results` | List<[Webhook](../../models/shared/Webhook.md)> | :heavy_minus_sign: | N/A | -| `totalResults` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| `totalResults` | *long* | :heavy_check_mark: | Total number of items. | \ No newline at end of file diff --git a/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md b/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md index f63a6471a..a6313a3e6 100755 --- a/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md +++ b/platform/docs/models/webhooks/ClientRateLimitReachedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/ClientRateLimitResetResponse.md b/platform/docs/models/webhooks/ClientRateLimitResetResponse.md index c24fe522c..f4571aace 100755 --- a/platform/docs/models/webhooks/ClientRateLimitResetResponse.md +++ b/platform/docs/models/webhooks/ClientRateLimitResetResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/CompanyDataConnectionStatusChangedResponse.md b/platform/docs/models/webhooks/CompanyDataConnectionStatusChangedResponse.md index fc2d9c9b0..f96f6a804 100755 --- a/platform/docs/models/webhooks/CompanyDataConnectionStatusChangedResponse.md +++ b/platform/docs/models/webhooks/CompanyDataConnectionStatusChangedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/DataSyncCompletedResponse.md b/platform/docs/models/webhooks/DataSyncCompletedResponse.md index 0ff2f2051..6c410f34f 100755 --- a/platform/docs/models/webhooks/DataSyncCompletedResponse.md +++ b/platform/docs/models/webhooks/DataSyncCompletedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/DatasetDataChangedResponse.md b/platform/docs/models/webhooks/DatasetDataChangedResponse.md index 452f12694..e20dae235 100755 --- a/platform/docs/models/webhooks/DatasetDataChangedResponse.md +++ b/platform/docs/models/webhooks/DatasetDataChangedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/DatasetStatusHasChangedToAnErrorStateResponse.md b/platform/docs/models/webhooks/DatasetStatusHasChangedToAnErrorStateResponse.md index 324fdd761..805618b51 100755 --- a/platform/docs/models/webhooks/DatasetStatusHasChangedToAnErrorStateResponse.md +++ b/platform/docs/models/webhooks/DatasetStatusHasChangedToAnErrorStateResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/NewCompanySynchronizedResponse.md b/platform/docs/models/webhooks/NewCompanySynchronizedResponse.md index 765d98617..493b976a4 100755 --- a/platform/docs/models/webhooks/NewCompanySynchronizedResponse.md +++ b/platform/docs/models/webhooks/NewCompanySynchronizedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/PushOperationHasTimedOutResponse.md b/platform/docs/models/webhooks/PushOperationHasTimedOutResponse.md index 61bad21ad..5a3a08f55 100755 --- a/platform/docs/models/webhooks/PushOperationHasTimedOutResponse.md +++ b/platform/docs/models/webhooks/PushOperationHasTimedOutResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/models/webhooks/PushOperationStatusHasChangedResponse.md b/platform/docs/models/webhooks/PushOperationStatusHasChangedResponse.md index 942f37b59..257d668f4 100755 --- a/platform/docs/models/webhooks/PushOperationStatusHasChangedResponse.md +++ b/platform/docs/models/webhooks/PushOperationStatusHasChangedResponse.md @@ -5,6 +5,6 @@ | 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 +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/platform/docs/sdks/connections/README.md b/platform/docs/sdks/connections/README.md index 43a63830e..af31d672d 100755 --- a/platform/docs/sdks/connections/README.md +++ b/platform/docs/sdks/connections/README.md @@ -34,7 +34,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.Connections.CreateAsync(new CreateConnectionRequest() { RequestBody = new CreateConnectionRequestBody() { - PlatformKey = "provident", + PlatformKey = "gbol", }, CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", }); @@ -151,7 +151,7 @@ var res = await sdk.Connections.ListAsync(new ListConnectionsRequest() { OrderBy = "-modifiedDate", Page = 1, PageSize = 100, - Query = "distinctio", + Query = "provident", }); // handle response @@ -188,7 +188,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.Connections.UnlinkAsync(new UnlinkConnectionRequest() { UpdateConnectionStatus = new UpdateConnectionStatus() { - Status = CodatPlatform.Models.Shared.DataConnectionStatus.Deauthorized, + Status = CodatPlatform.Models.Shared.DataConnectionStatus.Unlinked, }, CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", @@ -228,7 +228,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.Connections.UpdateAuthorizationAsync(new UpdateConnectionAuthorizationRequest() { RequestBody = new Dictionary() { - { "unde", "nulla" }, + { "quibusdam", "unde" }, }, CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", diff --git a/platform/docs/sdks/integrations/README.md b/platform/docs/sdks/integrations/README.md index 758bc9391..ed4958c7d 100755 --- a/platform/docs/sdks/integrations/README.md +++ b/platform/docs/sdks/integrations/README.md @@ -103,7 +103,7 @@ var res = await sdk.Integrations.ListAsync(new ListIntegrationsRequest() { OrderBy = "-modifiedDate", Page = 1, PageSize = 100, - Query = "corrupti", + Query = "nulla", }); // handle response diff --git a/platform/docs/sdks/pushdata/README.md b/platform/docs/sdks/pushdata/README.md index 1d728e1f9..f607ff097 100755 --- a/platform/docs/sdks/pushdata/README.md +++ b/platform/docs/sdks/pushdata/README.md @@ -76,7 +76,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.PushData.GetOperationAsync(new GetPushOperationRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - PushOperationKey = "d69a674e-0f46-47cc-8796-ed151a05dfc2", + PushOperationKey = "8d69a674-e0f4-467c-8879-6ed151a05dfc", }); // handle response @@ -116,7 +116,7 @@ var res = await sdk.PushData.ListOperationsAsync(new GetCompanyPushHistoryReques OrderBy = "-modifiedDate", Page = 1, PageSize = 100, - Query = "at", + Query = "odit", }); // handle response diff --git a/platform/docs/sdks/refreshdata/README.md b/platform/docs/sdks/refreshdata/README.md index e2fb09686..3fabbc279 100755 --- a/platform/docs/sdks/refreshdata/README.md +++ b/platform/docs/sdks/refreshdata/README.md @@ -73,7 +73,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.RefreshData.ByDataTypeAsync(new RefreshDataTypeRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - ConnectionId = "df7cc78c-a1ba-4928-bc81-6742cb739205", + ConnectionId = "ddf7cc78-ca1b-4a92-8fc8-16742cb73920", DataType = CodatPlatform.Models.Shared.DataType.Invoices, }); @@ -147,7 +147,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.RefreshData.GetPullOperationAsync(new GetPullOperationRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", - DatasetId = "eaed9f0f-e77b-4bc9-a58f-ab8b4b99ab18", + DatasetId = "5929396f-ea75-496e-b10f-aaa2352c5955", }); // handle response @@ -187,7 +187,7 @@ var res = await sdk.RefreshData.ListPullOperationsAsync(new ListPullOperationsRe OrderBy = "-modifiedDate", Page = 1, PageSize = 100, - Query = "natus", + Query = "excepturi", }); // handle response diff --git a/platform/docs/sdks/settings/README.md b/platform/docs/sdks/settings/README.md index 9b35dac2e..8cd0d51e1 100755 --- a/platform/docs/sdks/settings/README.md +++ b/platform/docs/sdks/settings/README.md @@ -135,7 +135,7 @@ var res = await sdk.Settings.GetProfileAsync(); ## GetSyncSettings -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. +Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for your client. This includes how often data types should be queued to be updated, and how much history should be fetched. ### Example Usage @@ -253,17 +253,17 @@ var sdk = new CodatPlatformSDK( ); var res = await sdk.Settings.UpdateSyncSettingsAsync(new UpdateProfileSyncSettingsRequestBody() { - ClientId = "367f7975-267b-439b-90c6-a6040ee680f3", + ClientId = "07aff1a3-a2fa-4946-b739-251aa52c3f5a", OverridesDefaults = false, Settings = new List() { new SyncSetting() { - DataType = CodatPlatform.Models.Shared.SyncSettingDataTypes.Invoices, + DataType = CodatPlatform.Models.Shared.DataType.Invoices, FetchOnFirstLink = false, IsLocked = false, MonthsToSync = 24, SyncFromUtc = "2022-10-23T00:00:00.000Z", SyncFromWindow = 24, - SyncOrder = 612096, + SyncOrder = 13571, SyncSchedule = 24, }, }, diff --git a/platform/docs/sdks/supplementaldata/README.md b/platform/docs/sdks/supplementaldata/README.md index 238364c9e..7ef5d25c8 100755 --- a/platform/docs/sdks/supplementaldata/README.md +++ b/platform/docs/sdks/supplementaldata/README.md @@ -34,19 +34,19 @@ var sdk = new CodatPlatformSDK( var res = await sdk.SupplementalData.ConfigureAsync(new ConfigureSupplementalDataRequest() { SupplementalDataConfiguration = new SupplementalDataConfiguration() { SupplementalDataConfig = new Dictionary() { - { "dolor", new SupplementalDataConfigurationSupplementalDataSourceConfiguration() { - DataSource = "natus", + { "quasi", new SupplementalDataConfigurationSupplementalDataSourceConfiguration() { + DataSource = "error", PullData = new Dictionary() { - { "laboriosam", "hic" }, + { "temporibus", "laborum" }, }, PushData = new Dictionary() { - { "saepe", "fuga" }, + { "quasi", "reiciendis" }, }, } }, }, }, DataType = CodatPlatform.Models.Operations.ConfigureSupplementalDataDataType.Invoices, - PlatformKey = "in", + PlatformKey = "gbol", }); // handle response @@ -85,7 +85,7 @@ var sdk = new CodatPlatformSDK( var res = await sdk.SupplementalData.GetConfigurationAsync(new GetSupplementalDataConfigurationRequest() { DataType = CodatPlatform.Models.Operations.GetSupplementalDataConfigurationDataType.Invoices, - PlatformKey = "corporis", + PlatformKey = "gbol", }); // handle response diff --git a/platform/docs/sdks/webhooks/README.md b/platform/docs/sdks/webhooks/README.md index b68e685c0..884d3aab7 100755 --- a/platform/docs/sdks/webhooks/README.md +++ b/platform/docs/sdks/webhooks/README.md @@ -27,14 +27,14 @@ var sdk = new CodatPlatformSDK( ); var res = await sdk.Webhooks.CreateAsync(new CreateRule() { - CompanyId = "39b73b17-cc2e-429e-915d-71654e9dcd1e", - Notifiers = new CreateRuleNotifiers() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Notifiers = new WebhookNotifier() { Emails = new List() { "info@client.com", }, Webhook = "https://webhook.client.com", }, - Type = "iste", + Type = "voluptatibus", }); // handle response @@ -109,7 +109,7 @@ var res = await sdk.Webhooks.ListAsync(new ListRulesRequest() { OrderBy = "-modifiedDate", Page = 1, PageSize = 100, - Query = "iure", + Query = "vero", }); // handle response diff --git a/platform/files.gen b/platform/files.gen index e03066940..604271721 100755 --- a/platform/files.gen +++ b/platform/files.gen @@ -125,20 +125,19 @@ CodatPlatform/Models/Shared/PushOperationRef.cs CodatPlatform/Models/Shared/PushOperations.cs CodatPlatform/Models/Shared/PullOperationStatus.cs CodatPlatform/Models/Shared/PullOperation.cs +CodatPlatform/Models/Shared/DataStatusDataTypes.cs CodatPlatform/Models/Shared/DataStatus.cs CodatPlatform/Models/Shared/PullOperations.cs CodatPlatform/Models/Shared/ApiKeyDetails.cs CodatPlatform/Models/Shared/CreateApiKey.cs CodatPlatform/Models/Shared/Profile.cs CodatPlatform/Models/Shared/SyncSettings.cs -CodatPlatform/Models/Shared/SyncSettingDataTypes.cs CodatPlatform/Models/Shared/SyncSetting.cs CodatPlatform/Models/Shared/ApiKeys.cs CodatPlatform/Models/Shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.cs CodatPlatform/Models/Shared/SupplementalDataConfiguration.cs -CodatPlatform/Models/Shared/WebhookNotifiers.cs CodatPlatform/Models/Shared/Webhook.cs -CodatPlatform/Models/Shared/CreateRuleNotifiers.cs +CodatPlatform/Models/Shared/WebhookNotifier.cs CodatPlatform/Models/Shared/CreateRule.cs CodatPlatform/Models/Shared/Webhooks.cs CodatPlatform/Models/Shared/Security.cs @@ -169,15 +168,6 @@ CodatPlatform/Models/Webhooks/DatasetStatusHasChangedToAnErrorStateResponse.cs CodatPlatform/Models/Webhooks/NewCompanySynchronizedResponse.cs CodatPlatform/Models/Webhooks/PushOperationHasTimedOutResponse.cs CodatPlatform/Models/Webhooks/PushOperationStatusHasChangedResponse.cs -docs/sdks/codatplatform/README.md -docs/sdks/companies/README.md -docs/sdks/connections/README.md -docs/sdks/integrations/README.md -docs/sdks/pushdata/README.md -docs/sdks/refreshdata/README.md -docs/sdks/settings/README.md -docs/sdks/supplementaldata/README.md -docs/sdks/webhooks/README.md USAGE.md docs/models/operations/CreateCompanyResponse.md docs/models/operations/DeleteCompanyRequest.md @@ -283,20 +273,19 @@ docs/models/shared/PushOperationRef.md docs/models/shared/PushOperations.md docs/models/shared/PullOperationStatus.md docs/models/shared/PullOperation.md +docs/models/shared/DataStatusDataTypes.md docs/models/shared/DataStatus.md docs/models/shared/PullOperations.md docs/models/shared/ApiKeyDetails.md docs/models/shared/CreateApiKey.md docs/models/shared/Profile.md docs/models/shared/SyncSettings.md -docs/models/shared/SyncSettingDataTypes.md docs/models/shared/SyncSetting.md docs/models/shared/ApiKeys.md docs/models/shared/SupplementalDataConfigurationSupplementalDataSourceConfiguration.md docs/models/shared/SupplementalDataConfiguration.md -docs/models/shared/WebhookNotifiers.md docs/models/shared/Webhook.md -docs/models/shared/CreateRuleNotifiers.md +docs/models/shared/WebhookNotifier.md docs/models/shared/CreateRule.md docs/models/shared/Webhooks.md docs/models/shared/Security.md @@ -327,4 +316,13 @@ docs/models/webhooks/DatasetStatusHasChangedToAnErrorStateResponse.md docs/models/webhooks/NewCompanySynchronizedResponse.md docs/models/webhooks/PushOperationHasTimedOutResponse.md docs/models/webhooks/PushOperationStatusHasChangedResponse.md +docs/sdks/codatplatform/README.md +docs/sdks/companies/README.md +docs/sdks/connections/README.md +docs/sdks/integrations/README.md +docs/sdks/pushdata/README.md +docs/sdks/refreshdata/README.md +docs/sdks/settings/README.md +docs/sdks/supplementaldata/README.md +docs/sdks/webhooks/README.md .gitattributes \ No newline at end of file diff --git a/platform/gen.yaml b/platform/gen.yaml index f063dcef1..2d9f7fa04 100644 --- a/platform/gen.yaml +++ b/platform/gen.yaml @@ -1,23 +1,23 @@ configVersion: 1.0.0 management: - docChecksum: 22588f231182e4787ffec29bd112d175 + docChecksum: cd46ae66ff2ab8726e2ee9bb1a99d29e docVersion: 3.0.0 - speakeasyVersion: 1.87.0 - generationVersion: 2.116.0 + speakeasyVersion: 1.91.0 + generationVersion: 2.129.1 generation: sdkClassName: Codat.Platform singleTagPerOp: false telemetryEnabled: true features: csharp: - core: 2.85.8 + core: 2.87.1 deprecations: 2.81.1 examples: 2.81.2 globalSecurity: 2.81.1 globalServerURLs: 2.82.0 nameOverrides: 2.81.1 csharp: - version: 2.0.0 + version: 2.1.0 author: Codat description: Manage the building blocks of Codat, including companies, connections, and more. dotnetVersion: net6.0