ExAcme.Order (ExAcme v0.1.0)
View SourceRepresents an ACME Order object.
Provides functionalities to fetch, finalize, and parse order details from the ACME server.
Attributes
url
- The URL of the order.status
- The current status of the order.expires
- Expiration datetime of the order.identifiers
- List of domain identifiers associated with the order.profile
- The profile associated with the order.not_before
- Start datetime of the order's validity.not_after
- End datetime of the order's validity.error
- Any error associated with the order.authorizations
- List of authorization URLs.finalize_url
- URL to finalize the order.certificate_url
- URL to retrieve the issued certificate.
Summary
Functions
Fetches an order from the ACME server.
Finalizes an order by submitting a Certificate Signing Request (CSR).
Types
@type t() :: %ExAcme.Order{ authorizations: [String.t()], certificate_url: String.t() | nil, error: map() | nil, expires: DateTime.t() | nil, finalize_url: String.t(), identifiers: [map()], not_after: DateTime.t() | nil, not_before: DateTime.t() | nil, profile: String.t(), status: String.t(), url: String.t() }
ACME Order object
Functions
@spec fetch(String.t(), ExAcme.AccountKey.t(), ExAcme.client()) :: {:ok, t()} | {:error, term()}
Fetches an order from the ACME server.
Parameters
url
- The order URL.account_key
- The account key for authentication.client
- The ExAcme client agent.
Returns
{:ok, order}
on success.{:error, reason}
on failure.
@spec finalize(String.t(), X509.CSR.t(), ExAcme.AccountKey.t(), ExAcme.client()) :: {:ok, t()} | {:error, term()}
Finalizes an order by submitting a Certificate Signing Request (CSR).
Parameters
finalize_url
- The finalize URL from the order.csr
- The Certificate Signing Request.account_key
- The account key for authentication.client
- The ExAcme client agent.
Returns
{:ok, order}
on success.{:error, reason}
on failure.