Excontentstack.Management.Environments (Excontentstack v0.5.0)

Operations on publishing environments.

Summary

Functions

Creates a new publishing environment.

Deletes a publishing environment by UID.

Retrieves a single environment by UID.

Lists all publishing environments in a stack.

Updates an existing publishing environment.

Functions

create(client, data, opts \\ [])

Creates a new publishing environment.

The data map must include at minimum :name and :urls.

Examples

Environments.create(client, %{
  name: "staging",
  urls: [%{locale: "en-us", url: "https://staging.example.com"}]
})

delete(client, environment_uid, opts \\ [])

Deletes a publishing environment by UID.

get(client, environment_uid, opts \\ [])

Retrieves a single environment by UID.

list(client, opts \\ [])

Lists all publishing environments in a stack.

update(client, environment_uid, data, opts \\ [])

Updates an existing publishing environment.