Class Altitude

An SDK for the Altitude platform.

Export

Hierarchy

Altitude

Index

Constructors

Properties

apiClient authClient axios

Methods

deleteEnvironment deploy getAllSites getBranches getDeployment getEnvironment getEnvironments getMe

Constructors

constructor

new Altitude(__namedParameters: Configuration): Altitude
Parameters
- __namedParameters: Configuration
Returns Altitude
- Defined in altitude-sdk.ts:27

Properties

`Private` apiClient

apiClient: _AltitudeApiClient

`Private` authClient

authClient: AuthClient

`Protected` axios

axios: AxiosInstance = globalAxios

Methods

deleteEnvironment

deleteEnvironment(siteId: string, environmentName: string): Promise<void>
Returns
A void promise
Parameters
- siteId: string
  
  The id of the site that the environment belongs to.
- environmentName: string
  
  The name of the environment to delete. Delete Environment
Returns Promise<void>
- Defined in altitude-sdk.ts:136

deploy

deploy(body: DeploySiteBody, siteId: string): Promise<SiteDeployment>
Throws
Will throw an error is branch name is not specified.

Returns
A Promise of details of the created deployment job.
Parameters
- body: DeploySiteBody
  
  Request body containing branch name and optional git ref.
- siteId: string
  
  The id of the site to deploy.
Returns Promise<SiteDeployment>
- Defined in altitude-sdk.ts:46

getAllSites

getAllSites(): Promise<Sites>
Get all sites within an organisation.

Throws
Throws error if a field is missing.

Returns
A Promise of an object containing an array of sites.

Returns Promise<Sites>
- Defined in altitude-sdk.ts:59

getBranches

getBranches(siteId: string): Promise<Branches>
Get all branches associated with a site.

Throws

Returns
A Promise of branch names for a given site, including the default branch.
Parameters
- siteId: string
  
  The id of the site which the the branches are associated with.
Returns Promise<Branches>
- Defined in altitude-sdk.ts:70

getDeployment

getDeployment(siteId: string, deploymentId: string): Promise<SiteDeployment>
Get details of a deployment.

Throws

Returns
A Promise of a site deployment.
Parameters
- siteId: string
  
  The id of the site the deployment is for.
- deploymentId: string
  
  The id of the deployment.
Returns Promise<SiteDeployment>
- Defined in altitude-sdk.ts:110

getEnvironment

getEnvironment(siteId: string, envName: string): Promise<CliEnvironmentEntity>
Get environment by name.

Throws

Returns
A promise of an environment with the given name from the given site.
Parameters
- siteId: string
  
  The id of the site which the environment is associated with.
- envName: string
  
  The name of the environment being searched for.
Returns Promise<CliEnvironmentEntity>
- Defined in altitude-sdk.ts:95

getEnvironments

getEnvironments(siteId: string): Promise<{
id: string;
name: string;
}[]>
Get all environment names associated with a site.

Throws

Returns
A promise of environment names for a given site.
Parameters
- siteId: string
  
  The id of the site which the environments are associated with.
Returns Promise<{
id: string;
name: string;
}[]>
- Defined in altitude-sdk.ts:81

getMe

getMe(): Promise<Client>
Returns
A Promise of details of the client.

Returns Promise<Client>
- Defined in altitude-sdk.ts:123

Generated using TypeDoc