EndPointBlank.Management.Applications (end_point_blank_elixir v0.12.0)

/api/v1/applications: your applications (API services), or, through EndPointBlank.Management.for_managed_client/2, a managed client's.

An application is %{"id", "name", "public", "organization_group_id", "synced_at", "inserted_at", "updated_at"}. Its deployments are EndPointBlank.Management.ApplicationEnvironments.

Summary

Functions

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

Creates an application. attrs: name and environment_base_urls (required: a map of environment id to base URL, at least one entry; the application is placed in each), public, organization_group_id. Options: idempotency_key:.

delete(client, id)

Deletes an application: %{"id", "deleted" => true}. Refused with "has_dependents" while grants or credentials depend on it.

get(client, id)

One application.

list(client, opts \\ [])

One page of applications. Options: limit:, after:.

stream(client, opts \\ [])

Every application, a page at a time. Raises EndPointBlank.Management.Error.

update(client, id, attrs)

Updates an application. attrs: name, public.

Functions

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

@spec create(EndPointBlank.Management.t(), map() | keyword(), keyword()) ::
  EndPointBlank.Management.result(map())

Creates an application. attrs: name and environment_base_urls (required: a map of environment id to base URL, at least one entry; the application is placed in each), public, organization_group_id. Options: idempotency_key:.

Applications.create(mgmt, %{
  name: "orders",
  environment_base_urls: %{environment_id => "https://orders.example.com"}
})

delete(client, id)

@spec delete(EndPointBlank.Management.t(), String.t()) ::
  EndPointBlank.Management.result(map())

Deletes an application: %{"id", "deleted" => true}. Refused with "has_dependents" while grants or credentials depend on it.

get(client, id)

@spec get(EndPointBlank.Management.t(), String.t()) ::
  EndPointBlank.Management.result(map())

One application.

list(client, opts \\ [])

@spec list(
  EndPointBlank.Management.t(),
  keyword()
) :: EndPointBlank.Management.result(EndPointBlank.Management.Page.t())

One page of applications. Options: limit:, after:.

stream(client, opts \\ [])

@spec stream(
  EndPointBlank.Management.t(),
  keyword()
) :: Enumerable.t()

Every application, a page at a time. Raises EndPointBlank.Management.Error.

update(client, id, attrs)

@spec update(EndPointBlank.Management.t(), String.t(), map() | keyword()) ::
  EndPointBlank.Management.result(map())

Updates an application. attrs: name, public.