Skip to content

README.md

Latest commit

 

History

History
294 lines (196 loc) · 16 KB

README.md

File metadata and controls

294 lines (196 loc) · 16 KB

PublishingTokens

Overview

Available Operations

  • Create - Create a publishing token for a workspace
  • Delete - Delete a specific publishing token
  • Get - Get a specific publishing token
  • List - Get publishing tokens for a workspace
  • ResolveMetadata - Get metadata about the token
  • ResolveTarget - Get a specific publishing token target
  • Update - Updates the validitity period of a publishing token

Create

Creates a publishing token for the current workspace

Example Usage

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

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

CreatePublishingTokenRequestBody? req = null;

var res = await sdk.PublishingTokens.CreateAsync(req);

// handle response

Parameters

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

Response

CreatePublishingTokenResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

Delete

Delete a particular publishing token.

Example Usage

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

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

DeletePublishingTokenRequest req = new DeletePublishingTokenRequest() {
    TokenID = "<id>",
};

var res = await sdk.PublishingTokens.DeleteAsync(req);

// handle response

Parameters

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

Response

DeletePublishingTokenResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

Get

Get information about a particular publishing token.

Example Usage

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

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

GetPublishingTokenByIDRequest req = new GetPublishingTokenByIDRequest() {
    TokenID = "<id>",
};

var res = await sdk.PublishingTokens.GetAsync(req);

// handle response

Parameters

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

Response

GetPublishingTokenByIDResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

List

Returns a publishing token for the current workspace

Example Usage

using SpeakeasySDK;
using SpeakeasySDK.Models.Shared;

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

var res = await sdk.PublishingTokens.ListAsync();

// handle response

Response

GetPublishingTokenResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

ResolveMetadata

Get information about a particular publishing token.

Example Usage

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

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

GetPublishingTokenPublicMetadataRequest req = new GetPublishingTokenPublicMetadataRequest() {
    TokenID = "<id>",
};

var res = await sdk.PublishingTokens.ResolveMetadataAsync(req);

// handle response

Parameters

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

Response

GetPublishingTokenPublicMetadataResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

ResolveTarget

Get information about a particular publishing token target.

Example Usage

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

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

GetPublishingTokenTargetByIDRequest req = new GetPublishingTokenTargetByIDRequest() {
    TokenID = "<id>",
};

var res = await sdk.PublishingTokens.ResolveTargetAsync(req);

// handle response

Parameters

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

Response

GetPublishingTokenTargetByIDResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*

Update

Updates the validity period of a particular publishing token.

Example Usage

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

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

UpdatePublishingTokenExpirationRequest req = new UpdatePublishingTokenExpirationRequest() {
    TokenID = "<id>",
};

var res = await sdk.PublishingTokens.UpdateAsync(req);

// handle response

Parameters

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

Response

UpdatePublishingTokenExpirationResponse

Errors

Error Type Status Code Content Type
SpeakeasySDK.Models.Errors.Error 4XX application/json
SpeakeasySDK.Models.Errors.SDKException 5XX */*