Packages

iyzico

1.3.0
1.6.5 1.6.4 1.6.3 1.6.2 1.6.1-rc1 1.6.0 1.5.6 1.5.5 1.5.4 1.5.3 1.5.2 1.5.1 1.5.0 1.4.1 1.4.0 1.3.1 1.3.0 1.2.1 1.2.0 1.1.1 1.1.0 1.0.1 1.0.0 0.1.0

A minimal iyzico Client for Elixir.

HexDocs

Current section

Files

Jump to
Readme
24 Versions
2 Dependencies
Dependants
Files
Activity
iyzico lib model metadata.ex
Raw

lib/model/metadata.ex 

defmodule Iyzico.Metadata do

  @moduledoc """

  A module containing request metadata related utilities.

  """



  @enforce_keys ~w(system_time succeed? locale)a



  defstruct [

    :system_time,

    :succeed?,

    :phase,

    :locale,

    :auth_code

  ]



  @typedoc """

  Provides metadata of a response from server.



  ## Fields:



  - `:system_time`: System epoch in milliseconds.

  - `:succeed?`: Boolean value indicating success of operation.

  - `:phase`: `:auth` if request was authorized successfully, else `nil`.

  - `:locale`: Locale of the response.

  - `:auth_code`: Authentication related string returned in response.

  """

  @type t :: %__MODULE__{

    system_time: integer,

    succeed?: boolean,

    phase: atom,

    locale: binary,

    auth_code: binary

  }

end