ExOAPI.Client (ex_oapi v0.1.0) View Source
The client module used to provide an api for generating requests programatically inside the generated SDK functions.
Link to this section Summary
Functions
Sets the :base_url
to be used as the API endpoint.
Adds an header to the client.
Adds middleware to the client that will be passed on to the Tesla request.
Adds options to be passed to the tesla adapter.
Adds a query param to the client.
Sets the adapter options that will be passed on to the Tesla request.
Link to this section Types
Specs
Specs
t() :: %ExOAPI.Client{ adapter: {any(), Keyword.t()}, base_url: nil | String.t(), body: any(), errors: [any()], headers: [{String.t(), String.t()}], method: nil | ExOAPI.EctoTypes.HTTPMethods.t(), middleware: middleware(), module: module() | nil, opts: Keyword.t(), outgoing_format: String.t(), path: nil | String.t(), query: Keyword.t(), replacements: [{String.t(), String.t()}], response_handler: function() | mfa() }
Link to this section Functions
Specs
Sets the :base_url
to be used as the API endpoint.
Specs
Specs
Adds an header to the client.
Specs
add_middleware(t(), [middleware()] | middleware() | module()) :: t()
Adds middleware to the client that will be passed on to the Tesla request.
Specs
Adds options to be passed to the tesla adapter.
Specs
Adds a query param to the client.
Specs
Sets the adapter options that will be passed on to the Tesla request.