Module: index

Signadot Node SDK.
The index module provides access to constructors for all the classes which comprise the public API.

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: 

var @SignadotSignadotSdk = require('index'); // See note below*.
var xxxSvc = new @SignadotSignadotSdk.XxxApi(); // Allocate the API class we're going to use.
var yyyModel = new @SignadotSignadotSdk.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...
*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

A non-AMD browser application (discouraged) might do something like this: 

var xxxSvc = new @SignadotSignadotSdk.XxxApi(); // Allocate the API class we're going to use.
var yyy = new @SignadotSignadotSdk.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...

Source:

Members

(static) ApiClient

The ApiClient constructor.
Properties:
Type Description
module:ApiClient
Source:

(static) ApierrsResponse

The ApierrsResponse model constructor.
Properties:
Type Description
module:model/ApierrsResponse
Source:

(static) Branch

The Branch model constructor.
Properties:
Type Description
module:model/Branch
Source:

(static) Cluster

The Cluster model constructor.
Properties:
Type Description
module:model/Cluster
Source:

(static) ClusterApi

The ClusterApi service constructor.
Properties:
Type Description
module:api/ClusterApi
Source:

(static) ConnectClusterRequest

The ConnectClusterRequest model constructor.
Properties:
Type Description
module:model/ConnectClusterRequest
Source:

(static) ConnectClusterResponse

The ConnectClusterResponse model constructor.
Properties:
Type Description
module:model/ConnectClusterResponse
Source:

(static) CreateClusterTokenResponse

The CreateClusterTokenResponse model constructor.
Properties:
Type Description
module:model/CreateClusterTokenResponse
Source:

(static) CreatePreviewEndpointRequest

The CreatePreviewEndpointRequest model constructor.
Properties:
Type Description
module:model/CreatePreviewEndpointRequest
Source:

(static) CreateSandboxRequest

The CreateSandboxRequest model constructor.
Properties:
Type Description
module:model/CreateSandboxRequest
Source:

(static) CreateSandboxResponse

The CreateSandboxResponse model constructor.
Properties:
Type Description
module:model/CreateSandboxResponse
Source:

(static) CustomPatch

The CustomPatch model constructor.
Properties:
Type Description
module:model/CustomPatch
Source:

(static) EnvOp

The EnvOp model constructor.
Properties:
Type Description
module:model/EnvOp
Source:

(static) EnvValueFrom

The EnvValueFrom model constructor.
Properties:
Type Description
module:model/EnvValueFrom
Source:

(static) EnvValueFromFork

The EnvValueFromFork model constructor.
Properties:
Type Description
module:model/EnvValueFromFork
Source:

(static) EnvValueFromResource

The EnvValueFromResource model constructor.
Properties:
Type Description
module:model/EnvValueFromResource
Source:

(static) ForkEndpoint

The ForkEndpoint model constructor.
Properties:
Type Description
module:model/ForkEndpoint
Source:

(static) ForkOf

The ForkOf model constructor.
Properties:
Type Description
module:model/ForkOf
Source:

(static) GetClustersResponse

The GetClustersResponse model constructor.
Properties:
Type Description
module:model/GetClustersResponse
Source:

(static) GetSandboxByIdResponse

The GetSandboxByIdResponse model constructor.
Properties:
Type Description
module:model/GetSandboxByIdResponse
Source:

(static) GetSandboxesResponse

The GetSandboxesResponse model constructor.
Properties:
Type Description
module:model/GetSandboxesResponse
Source:

(static) HandlerEmptyResponse

The HandlerEmptyResponse model constructor.
Properties:
Type Description
module:model/HandlerEmptyResponse
Source:

(static) Image

The Image model constructor.
Properties:
Type Description
module:model/Image
Source:

(static) PreviewEndpoint

The PreviewEndpoint model constructor.
Properties:
Type Description
module:model/PreviewEndpoint
Source:

(static) SandboxCustomizations

The SandboxCustomizations model constructor.
Properties:
Type Description
module:model/SandboxCustomizations
Source:

(static) SandboxDetails

The SandboxDetails model constructor.
Properties:
Type Description
module:model/SandboxDetails
Source:

(static) SandboxEndpoint

The SandboxEndpoint model constructor.
Properties:
Type Description
module:model/SandboxEndpoint
Source:

(static) SandboxesApi

The SandboxesApi service constructor.
Properties:
Type Description
module:api/SandboxesApi
Source:

(static) SandboxFork

The SandboxFork model constructor.
Properties:
Type Description
module:model/SandboxFork
Source:

(static) SandboxInfo

The SandboxInfo model constructor.
Properties:
Type Description
module:model/SandboxInfo
Source:

(static) SandboxReadyResponse

The SandboxReadyResponse model constructor.
Properties:
Type Description
module:model/SandboxReadyResponse
Source:

(static) SandboxResource

The SandboxResource model constructor.
Properties:
Type Description
module:model/SandboxResource
Source:

(static) SandboxStatus

The SandboxStatus model constructor.
Properties:
Type Description
module:model/SandboxStatus
Source:

(static) SandboxStatusResponse

The SandboxStatusResponse model constructor.
Properties:
Type Description
module:model/SandboxStatusResponse
Source:

(static) UpsertPRWorkspacesRequest

The UpsertPRWorkspacesRequest model constructor.
Properties:
Type Description
module:model/UpsertPRWorkspacesRequest
Source:

(static) UpsertWorkspaceResponse

The UpsertWorkspaceResponse model constructor.
Properties:
Type Description
module:model/UpsertWorkspaceResponse
Source:

(static) V1ImageReplacement

The V1ImageReplacement model constructor.
Properties:
Type Description
module:model/V1ImageReplacement
Source: