CorvoNfse.Resources.Certificates (Corvo NFS-e v0.1.1)

Copy Markdown View Source

A1 (.p12) certificate management for a company.

CorvoNfse.Resources.Certificates.upload(client, company_id, {:file, "cert.p12"}, "secret")

Summary

Types

list_option()
upload_option()

Functions

list(client, company_id, opts \\ [])

Lists a company's certificates (GET /v1/companies/:companyId/certificates).

remove(client, company_id, cert_id)

Deletes a certificate; 204 yields {:ok, nil}.

upload(client, company_id, source, password, opts \\ [])

Uploads a certificate as multipart/form-data (POST /v1/companies/:companyId/certificates).

Types

list_option()

@type list_option() :: {:limit, pos_integer()} | {:cursor, String.t()}

upload_option()

@type upload_option() :: {:file_name, String.t()}

Functions

list(client, company_id, opts \\ [])

@spec list(CorvoNfse.Client.t(), String.t(), [list_option()]) ::
  {:ok, CorvoNfse.Types.Common.page()} | {:error, CorvoNfse.Error.t()}

Lists a company's certificates (GET /v1/companies/:companyId/certificates).

remove(client, company_id, cert_id)

@spec remove(CorvoNfse.Client.t(), String.t(), String.t()) ::
  {:ok, nil} | {:error, CorvoNfse.Error.t()}

Deletes a certificate; 204 yields {:ok, nil}.

upload(client, company_id, source, password, opts \\ [])

@spec upload(
  CorvoNfse.Client.t(),
  String.t(),
  CorvoNfse.Types.Certificate.upload_source(),
  String.t(),
  [upload_option()]
) :: {:ok, map()} | {:error, CorvoNfse.Error.t()}

Uploads a certificate as multipart/form-data (POST /v1/companies/:companyId/certificates).

The source is {:file, path} (read from disk) or {:binary, bytes}; for the latter pass file_name: (defaults to certificate.p12).