Spatio.Api.Logos (spatio_sdk v0.0.2)

API calls for all endpoints tagged Logos.

Summary

Functions

get_domain_logo(connection, domain, opts \\ [])

Resolve a domain to its logo URL (CDN-cached 24h).

get_email_logo(connection, email, opts \\ [])

Resolve an email address to its domain logo URL.

get_logos_batch(connection, request_body, opts \\ [])

Batch-resolve a list of domains/emails to logo URLs in one call.

Functions

get_domain_logo(connection, domain, opts \\ [])

@spec get_domain_logo(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Spatio.Model.GetDomainLogo200Response.t()}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Resolve a domain to its logo URL (CDN-cached 24h).

Parameters

connection (Spatio.Connection): Connection to server
domain (String.t):
opts (keyword): Optional parameters

Returns

{:ok, Spatio.Model.GetDomainLogo200Response.t} on success
{:error, Tesla.Env.t} on failure

get_email_logo(connection, email, opts \\ [])

@spec get_email_logo(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Resolve an email address to its domain logo URL.

Parameters

connection (Spatio.Connection): Connection to server
email (String.t):
opts (keyword): Optional parameters

Returns

{:ok, %{}} on success
{:error, Tesla.Env.t} on failure

get_logos_batch(connection, request_body, opts \\ [])

@spec get_logos_batch(Tesla.Env.client(), %{optional(String.t()) => any()}, keyword()) ::
  {:ok, %{optional(String.t()) => any()}}
  | {:ok, Spatio.Model.ApiError.t()}
  | {:error, Tesla.Env.t()}

Batch-resolve a list of domains/emails to logo URLs in one call.

Parameters

connection (Spatio.Connection): Connection to server
request_body (%{optional(String.t) => any()}):
opts (keyword): Optional parameters

Returns

{:ok, %{}} on success
{:error, Tesla.Env.t} on failure