Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc 3.0.0, Speakeay CLI 1.87.0 (#85)
Browse files Browse the repository at this point in the history
Co-authored-by: speakeasybot <[email protected]>
  • Loading branch information
github-actions[bot] and speakeasybot authored Sep 18, 2023
1 parent 663f6d0 commit 31bf1e3
Show file tree
Hide file tree
Showing 194 changed files with 2,257 additions and 2,139 deletions.
3 changes: 2 additions & 1 deletion platform/CodatPlatform/CodatPlatform.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
<PropertyGroup>
<IsPackable>true</IsPackable>
<PackageId>Codat.Platform</PackageId>
<Version>0.5.0</Version>
<Version>1.1.0</Version>
<Authors>Codat</Authors>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
<PackageReadmeFile>README.md</PackageReadmeFile>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

<ItemGroup>
Expand Down
86 changes: 47 additions & 39 deletions platform/CodatPlatform/CodatPlatformSDK.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,35 +17,67 @@ namespace CodatPlatform
using System.Threading.Tasks;
using System;

/// <summary>
/// Platform API: Platform API
///
/// <remarks>
/// An API for the common components of all of Codat&apos;s products.<br/>
/// <br/>
/// These end points cover creating and managing your companies, data connections, and integrations.<br/>
/// <br/>
/// <a href="https://docs.codat.io/core-concepts/companies">Read about the building blocks of Codat...</a><br/>
/// <br/>
/// <a href="https://github.com/codatio/oas">See our OpenAPI spec</a>
/// </remarks>
/// </summary>
public interface ICodatPlatformSDK
{

/// <summary>
/// Create and manage your Codat companies.
/// </summary>
public ICompaniesSDK Companies { get; }

/// <summary>
/// Manage your companies&amp;apos; data connections.
/// </summary>
public IConnectionsSDK Connections { get; }

/// <summary>
/// View and manage your available integrations in Codat.
/// </summary>
public IIntegrationsSDK Integrations { get; }

/// <summary>
/// View push options and get push statuses.
/// </summary>
public IPushDataSDK PushData { get; }

/// <summary>
/// Asynchronously retrieve data from an integration to refresh data in Codat.
/// </summary>
public IRefreshDataSDK RefreshData { get; }

/// <summary>
/// Manage your Codat instance.
/// </summary>
public ISettingsSDK Settings { get; }

/// <summary>
/// View and configure supplemental data for supported data types.
/// </summary>
public ISupplementalDataSDK SupplementalData { get; }

/// <summary>
/// Manage webhooks, rules, and events.
/// </summary>
public IWebhooksSDK Webhooks { get; }
}

public class SDKConfig

Check warning on line 77 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'SDKConfig'
{
}

/// <summary>
/// Platform API: Platform API
///
/// <remarks>
/// An API for the common components of all of Codat's products.
///
/// These end points cover creating and managing your companies, data connections, and integrations.
///
/// [Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies)
///
/// [See our OpenAPI spec](https://github.com/codatio/oas)
/// </remarks>
/// </summary>
public class CodatPlatformSDK: ICodatPlatformSDK

Check warning on line 81 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK'
{
public SDKConfig Config { get; private set; }

Check warning on line 83 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.Config'
Expand All @@ -55,43 +87,19 @@ public class CodatPlatformSDK: ICodatPlatformSDK
};

private const string _language = "csharp";
private const string _sdkVersion = "0.5.0";
private const string _sdkGenVersion = "2.113.0";
private const string _sdkVersion = "1.1.0";
private const string _sdkGenVersion = "2.116.0";
private const string _openapiDocVersion = "3.0.0";
private string _serverUrl = "";
private ISpeakeasyHttpClient _defaultClient;
private ISpeakeasyHttpClient _securityClient;
/// <summary>
/// Create and manage your Codat companies.
/// </summary>
public ICompaniesSDK Companies { get; private set; }

Check warning on line 96 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.Companies'
/// <summary>
/// Manage your companies' data connections.
/// </summary>
public IConnectionsSDK Connections { get; private set; }

Check warning on line 97 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.Connections'
/// <summary>
/// View and manage your available integrations in Codat.
/// </summary>
public IIntegrationsSDK Integrations { get; private set; }

Check warning on line 98 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.Integrations'
/// <summary>
/// View push options and get push statuses.
/// </summary>
public IPushDataSDK PushData { get; private set; }

Check warning on line 99 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.PushData'
/// <summary>
/// Asynchronously retrieve data from an integration to refresh data in Codat.
/// </summary>
public IRefreshDataSDK RefreshData { get; private set; }

Check warning on line 100 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.RefreshData'
/// <summary>
/// Manage your Codat instance.
/// </summary>
public ISettingsSDK Settings { get; private set; }

Check warning on line 101 in platform/CodatPlatform/CodatPlatformSDK.cs

View workflow job for this annotation

GitHub Actions / publish / Publish C# SDK

Missing XML comment for publicly visible type or member 'CodatPlatformSDK.Settings'
/// <summary>
/// View and configure supplemental data for supported data types.
/// </summary>
public ISupplementalDataSDK SupplementalData { get; private set; }
/// <summary>
/// Manage webhooks, rules, and events.
/// </summary>
public IWebhooksSDK Webhooks { get; private set; }

public CodatPlatformSDK(Security? security = null, string? serverUrl = null, ISpeakeasyHttpClient? client = null)
Expand Down
95 changes: 50 additions & 45 deletions platform/CodatPlatform/Companies.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,69 @@ namespace CodatPlatform
using System.Threading.Tasks;
using System;

/// <summary>
/// Create and manage your Codat companies.
/// </summary>
public interface ICompaniesSDK
{

/// <summary>
/// Create company
///
/// <remarks>
/// Creates a new company that can be used to assign connections to. <br/>
/// <br/>
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.<br/>
/// <br/>
///
/// </remarks>
/// </summary>
Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request = null);

/// <summary>
/// Delete a company
///
/// <remarks>
/// <br/>
/// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
/// </remarks>
/// </summary>
Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? request = null);

/// <summary>
/// Get company
///
/// <remarks>
/// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
/// </remarks>
/// </summary>
Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null);

/// <summary>
/// List companies
///
/// <remarks>
/// Returns a list of your companies. The company schema contains a list of <a href="https://docs.codat.io/codat-api#/schemas/Connection">connections</a> related to the company.
/// </remarks>
/// </summary>
Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request = null);

/// <summary>
/// Update company
///
/// <remarks>
/// Updates both the name and description of the company.
/// </remarks>
/// </summary>
Task<UpdateCompanyResponse> UpdateAsync(UpdateCompanyRequest? request = null);
}

/// <summary>
/// Create and manage your Codat companies.
/// </summary>
public class CompaniesSDK: ICompaniesSDK
{
public SDKConfig Config { get; private set; }
private const string _language = "csharp";
private const string _sdkVersion = "0.5.0";
private const string _sdkGenVersion = "2.113.0";
private const string _sdkVersion = "1.1.0";
private const string _sdkGenVersion = "2.116.0";
private const string _openapiDocVersion = "3.0.0";
private string _serverUrl = "";
private ISpeakeasyHttpClient _defaultClient;
Expand All @@ -51,17 +96,6 @@ public CompaniesSDK(ISpeakeasyHttpClient defaultClient, ISpeakeasyHttpClient sec
}


/// <summary>
/// Create company
///
/// <remarks>
/// Creates a new company that can be used to assign connections to.
///
/// If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
///
///
/// </remarks>
/// </summary>
public async Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request = null)
{
string baseUrl = _serverUrl;
Expand Down Expand Up @@ -115,14 +149,6 @@ public async Task<CreateCompanyResponse> CreateAsync(CompanyRequestBody? request
}


/// <summary>
/// Delete a company
///
/// <remarks>
///
/// Permanently deletes a company, its connections and any cached data. This operation is irreversible. If the company ID does not exist an error is returned.
/// </remarks>
/// </summary>
public async Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? request = null)
{
string baseUrl = _serverUrl;
Expand Down Expand Up @@ -167,13 +193,6 @@ public async Task<DeleteCompanyResponse> DeleteAsync(DeleteCompanyRequest? reque
}


/// <summary>
/// Get company
///
/// <remarks>
/// Returns the company for a valid identifier. If the identifier is for a deleted company, a not found response is returned.
/// </remarks>
/// </summary>
public async Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null)
{
string baseUrl = _serverUrl;
Expand Down Expand Up @@ -222,13 +241,6 @@ public async Task<GetCompanyResponse> GetAsync(GetCompanyRequest? request = null
}


/// <summary>
/// List companies
///
/// <remarks>
/// Returns a list of your companies. The company schema contains a list of [connections](https://docs.codat.io/codat-api#/schemas/Connection) related to the company.
/// </remarks>
/// </summary>
public async Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request = null)
{
string baseUrl = _serverUrl;
Expand Down Expand Up @@ -277,13 +289,6 @@ public async Task<ListCompaniesResponse> ListAsync(ListCompaniesRequest? request
}


/// <summary>
/// Update company
///
/// <remarks>
/// Updates both the name and description of the company.
/// </remarks>
/// </summary>
public async Task<UpdateCompanyResponse> UpdateAsync(UpdateCompanyRequest? request = null)
{
string baseUrl = _serverUrl;
Expand Down
Loading

0 comments on commit 31bf1e3

Please sign in to comment.