Skip to content

Latest commit

 

History

History
141 lines (88 loc) · 4.7 KB

File metadata and controls

141 lines (88 loc) · 4.7 KB

Organizations

(Organizations)

Overview

Available Operations

CreateFreeTrial

Creates a free trial for an organization

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Organizations.CreateFreeTrialAsync();

// handle response

Response

CreateFreeTrialResponse

Errors

Error Object Status Code Content Type
SpeakeasySDK.Models.Errors.SDKException 4xx-5xx /

GetOrganization

Get information about a particular organization.

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Operations;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

GetOrganizationRequest req = new GetOrganizationRequest() {
    OrganizationID = "<value>",
};

var res = await sdk.Organizations.GetOrganizationAsync(req);

// handle response

Parameters

Parameter Type Required Description
request GetOrganizationRequest ✔️ The request object to use for the request.

Response

GetOrganizationResponse

Errors

Error Object Status Code Content Type
SpeakeasySDK.Models.Errors.SDKException 4xx-5xx /

GetOrganizationUsage

Returns a billing usage summary by target languages for a particular organization

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Organizations.GetOrganizationUsageAsync();

// handle response

Response

GetOrganizationUsageResponse

Errors

Error Object Status Code Content Type
SpeakeasySDK.Models.Errors.SDKException 4xx-5xx /

GetOrganizations

Returns a list of organizations a user has access too

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

var sdk = new SDK(security: new Security() {
    APIKey = "<YOUR_API_KEY_HERE>",
});

var res = await sdk.Organizations.GetOrganizationsAsync();

// handle response

Response

GetOrganizationsResponse

Errors

Error Object Status Code Content Type
SpeakeasySDK.Models.Errors.SDKException 4xx-5xx /