Current section
Files
Jump to
Current section
Files
docs/JayaCurrencyConverter.ExchangeRatesClient.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.26.0">
<meta name="project" content="Currency Converter v0.1.0">
<title>JayaCurrencyConverter.ExchangeRatesClient — Currency Converter v0.1.0</title>
<link rel="stylesheet" href="dist/elixir-b5076885a795c65e636c.css" />
<script src="dist/sidebar_items-b06e806963.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/app-a404e1e870b77c874f9e.js"></script>
</head>
<body data-type="modules">
<script>
try {
if (localStorage.getItem('night-mode') === 'true') {
document.body.classList.add('night-mode');
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle">
<span class="icon-menu" title="Collapse/expand sidebar"></span>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<span class="icon-search" aria-hidden="true" title="Submit search"></span>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<span class="icon-cross" aria-hidden="true" title="Cancel search"></span>
</button>
<label class="search-label">
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Currency Converter
</a>
<strong class="sidebar-projectVersion" translate="no">
v0.1.0
</strong>
</div>
<a href="readme.html">
<img src="assets/logo.png" alt="Currency Converter" class="sidebar-projectImage">
</a>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<span translate="no">JayaCurrencyConverter.ExchangeRatesClient</span>
<small class="app-vsn" translate="no">(Currency Converter v0.1.0)</small>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L1" title="View Source" class="view-source" rel="help">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</h1>
<section id="moduledoc">
<p>This is the ExchangeRatesClient module that makes the request for the Exchanges Rates API.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:option/0" translate="no">option()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete/3" translate="no">delete(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a DELETE request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#delete!/3" translate="no">delete!(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a DELETE request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get/3" translate="no">get(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a GET request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get!/3" translate="no">get!(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a GET request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_all_rates/1" translate="no">get_all_rates(base \\ "EUR")</a>
</div>
<div class="summary-synopsis"><p>The function <code class="inline">get_all_rates</code> receives a string with the currency.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#head/3" translate="no">head(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a HEAD request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#head!/3" translate="no">head!(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a HEAD request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#options/3" translate="no">options(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a OPTIONS request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#options!/3" translate="no">options!(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a OPTIONS request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#patch/4" translate="no">patch(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a PATCH request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#patch!/4" translate="no">patch!(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a PATCH request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#post/4" translate="no">post(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a POST request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#post!/4" translate="no">post!(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a POST request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#put/4" translate="no">put(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a PUT request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#put!/4" translate="no">put!(client, url, body, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a PUT request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#request/2" translate="no">request(client \\ %Tesla.Client{}, options)</a>
</div>
<div class="summary-synopsis"><p>Perform a request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#request!/2" translate="no">request!(client \\ %Tesla.Client{}, options)</a>
</div>
<div class="summary-synopsis"><p>Perform request and raise in case of error.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trace/3" translate="no">trace(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a TRACE request.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trace!/3" translate="no">trace!(client, url, opts)</a>
</div>
<div class="summary-synopsis"><p>Perform a TRACE request.</p></div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Types
</h1>
<div class="types-list">
<section class="detail" id="t:option/0">
<div class="detail-header">
<a href="#t:option/0" class="detail-link" title="Link to this type">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">option()</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">option() ::
{:method, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:method/0">Tesla.Env.method</a>()}
| {:url, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>()}
| {:query, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:query/0">Tesla.Env.query</a>()}
| {:headers, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:headers/0">Tesla.Env.headers</a>()}
| {:body, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>()}
| {:opts, <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:opts/0">Tesla.Env.opts</a>()}</pre>
</div>
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this section</span>
</a>
Functions
</h1>
<div class="functions-list">
<section class="detail" id="delete/3">
<div class="detail-header">
<a href="#delete/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">delete(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">delete(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a DELETE request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">delete</span><span class="p" data-group-id="6786248921-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="6786248921-1">)</span><span class="w">
</span><span class="n">delete</span><span class="p" data-group-id="6786248921-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6786248921-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6786248921-3">]</span><span class="p" data-group-id="6786248921-2">)</span><span class="w">
</span><span class="n">delete</span><span class="p" data-group-id="6786248921-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="6786248921-4">)</span><span class="w">
</span><span class="n">delete</span><span class="p" data-group-id="6786248921-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6786248921-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6786248921-6">]</span><span class="p" data-group-id="6786248921-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="delete!/3">
<div class="detail-header">
<a href="#delete!/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">delete!(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">delete!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a DELETE request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">delete!</span><span class="p" data-group-id="3309653114-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="3309653114-1">)</span><span class="w">
</span><span class="n">delete!</span><span class="p" data-group-id="3309653114-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3309653114-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3309653114-3">]</span><span class="p" data-group-id="3309653114-2">)</span><span class="w">
</span><span class="n">delete!</span><span class="p" data-group-id="3309653114-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="3309653114-4">)</span><span class="w">
</span><span class="n">delete!</span><span class="p" data-group-id="3309653114-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="3309653114-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="3309653114-6">]</span><span class="p" data-group-id="3309653114-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="get/3">
<div class="detail-header">
<a href="#get/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">get(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a GET request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">get</span><span class="p" data-group-id="2902437748-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="2902437748-1">)</span><span class="w">
</span><span class="n">get</span><span class="p" data-group-id="2902437748-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2902437748-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2902437748-3">]</span><span class="p" data-group-id="2902437748-2">)</span><span class="w">
</span><span class="n">get</span><span class="p" data-group-id="2902437748-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="2902437748-4">)</span><span class="w">
</span><span class="n">get</span><span class="p" data-group-id="2902437748-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2902437748-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2902437748-6">]</span><span class="p" data-group-id="2902437748-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="get!/3">
<div class="detail-header">
<a href="#get!/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get!(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">get!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a GET request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">get!</span><span class="p" data-group-id="8546061776-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="8546061776-1">)</span><span class="w">
</span><span class="n">get!</span><span class="p" data-group-id="8546061776-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8546061776-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="8546061776-3">]</span><span class="p" data-group-id="8546061776-2">)</span><span class="w">
</span><span class="n">get!</span><span class="p" data-group-id="8546061776-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="8546061776-4">)</span><span class="w">
</span><span class="n">get!</span><span class="p" data-group-id="8546061776-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="8546061776-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="8546061776-6">]</span><span class="p" data-group-id="8546061776-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="get_all_rates/1">
<span id="get_all_rates/0"></span>
<div class="detail-header">
<a href="#get_all_rates/1" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_all_rates(base \\ "EUR")</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L28" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>The function <code class="inline">get_all_rates</code> receives a string with the currency.</p><p> Returns <code class="inline">map</code> in success or <code class="inline">error</code> if some thing was wrong.</p><h2 id="get_all_rates/1-examples" class="section-heading">
<a href="#get_all_rates/1-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Examples
</h2>
<pre><code class="makeup elixir"><span class="gp unselectable">iex> </span><span class="nc">ExchangeRatesClient</span><span class="o">.</span><span class="n">get_all_rates</span><span class="w"> </span><span class="s">"EUR"</span><span class="w">
</span><span class="p" data-group-id="5023170757-1">%{</span><span class="s">"BRL"</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mf">6.418483</span><span class="p">,</span><span class="w"> </span><span class="s">"EUR"</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s">"JPY"</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mf">129.340028</span><span class="p">,</span><span class="w"> </span><span class="s">"USD"</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="mf">1.131029</span><span class="p" data-group-id="5023170757-1">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">ExchangeRatesClient</span><span class="o">.</span><span class="n">get_all_rates</span><span class="w"> </span><span class="s">"FOM"</span><span class="w">
</span><span class="p" data-group-id="5023170757-2">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="s">"invalid_base_currency"</span><span class="p" data-group-id="5023170757-2">}</span></code></pre>
</section>
</section>
<section class="detail" id="head/3">
<div class="detail-header">
<a href="#head/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">head(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">head(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a HEAD request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">head</span><span class="p" data-group-id="0646776517-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="0646776517-1">)</span><span class="w">
</span><span class="n">head</span><span class="p" data-group-id="0646776517-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0646776517-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0646776517-3">]</span><span class="p" data-group-id="0646776517-2">)</span><span class="w">
</span><span class="n">head</span><span class="p" data-group-id="0646776517-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="0646776517-4">)</span><span class="w">
</span><span class="n">head</span><span class="p" data-group-id="0646776517-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0646776517-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0646776517-6">]</span><span class="p" data-group-id="0646776517-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="head!/3">
<div class="detail-header">
<a href="#head!/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">head!(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">head!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a HEAD request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">head!</span><span class="p" data-group-id="5062833712-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="5062833712-1">)</span><span class="w">
</span><span class="n">head!</span><span class="p" data-group-id="5062833712-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5062833712-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5062833712-3">]</span><span class="p" data-group-id="5062833712-2">)</span><span class="w">
</span><span class="n">head!</span><span class="p" data-group-id="5062833712-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="5062833712-4">)</span><span class="w">
</span><span class="n">head!</span><span class="p" data-group-id="5062833712-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5062833712-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5062833712-6">]</span><span class="p" data-group-id="5062833712-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="options/3">
<div class="detail-header">
<a href="#options/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">options(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">options(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a OPTIONS request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">options</span><span class="p" data-group-id="5522436350-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="5522436350-1">)</span><span class="w">
</span><span class="n">options</span><span class="p" data-group-id="5522436350-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5522436350-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5522436350-3">]</span><span class="p" data-group-id="5522436350-2">)</span><span class="w">
</span><span class="n">options</span><span class="p" data-group-id="5522436350-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="5522436350-4">)</span><span class="w">
</span><span class="n">options</span><span class="p" data-group-id="5522436350-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5522436350-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5522436350-6">]</span><span class="p" data-group-id="5522436350-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="options!/3">
<div class="detail-header">
<a href="#options!/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">options!(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">options!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a OPTIONS request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">options!</span><span class="p" data-group-id="2211622477-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="2211622477-1">)</span><span class="w">
</span><span class="n">options!</span><span class="p" data-group-id="2211622477-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2211622477-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2211622477-3">]</span><span class="p" data-group-id="2211622477-2">)</span><span class="w">
</span><span class="n">options!</span><span class="p" data-group-id="2211622477-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="2211622477-4">)</span><span class="w">
</span><span class="n">options!</span><span class="p" data-group-id="2211622477-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2211622477-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2211622477-6">]</span><span class="p" data-group-id="2211622477-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="patch/4">
<div class="detail-header">
<a href="#patch/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">patch(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">patch(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a PATCH request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">patch</span><span class="p" data-group-id="9101753502-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9101753502-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9101753502-2">}</span><span class="p" data-group-id="9101753502-1">)</span><span class="w">
</span><span class="n">patch</span><span class="p" data-group-id="9101753502-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9101753502-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9101753502-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9101753502-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9101753502-5">]</span><span class="p" data-group-id="9101753502-3">)</span><span class="w">
</span><span class="n">patch</span><span class="p" data-group-id="9101753502-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9101753502-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9101753502-7">}</span><span class="p" data-group-id="9101753502-6">)</span><span class="w">
</span><span class="n">patch</span><span class="p" data-group-id="9101753502-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9101753502-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9101753502-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9101753502-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9101753502-10">]</span><span class="p" data-group-id="9101753502-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="patch!/4">
<div class="detail-header">
<a href="#patch!/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">patch!(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">patch!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a PATCH request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">patch!</span><span class="p" data-group-id="0142301927-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0142301927-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0142301927-2">}</span><span class="p" data-group-id="0142301927-1">)</span><span class="w">
</span><span class="n">patch!</span><span class="p" data-group-id="0142301927-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0142301927-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0142301927-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0142301927-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0142301927-5">]</span><span class="p" data-group-id="0142301927-3">)</span><span class="w">
</span><span class="n">patch!</span><span class="p" data-group-id="0142301927-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0142301927-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0142301927-7">}</span><span class="p" data-group-id="0142301927-6">)</span><span class="w">
</span><span class="n">patch!</span><span class="p" data-group-id="0142301927-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="0142301927-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="0142301927-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0142301927-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="0142301927-10">]</span><span class="p" data-group-id="0142301927-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="post/4">
<div class="detail-header">
<a href="#post/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">post(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">post(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a POST request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">post</span><span class="p" data-group-id="7015552680-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7015552680-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="7015552680-2">}</span><span class="p" data-group-id="7015552680-1">)</span><span class="w">
</span><span class="n">post</span><span class="p" data-group-id="7015552680-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7015552680-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="7015552680-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="7015552680-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="7015552680-5">]</span><span class="p" data-group-id="7015552680-3">)</span><span class="w">
</span><span class="n">post</span><span class="p" data-group-id="7015552680-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7015552680-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="7015552680-7">}</span><span class="p" data-group-id="7015552680-6">)</span><span class="w">
</span><span class="n">post</span><span class="p" data-group-id="7015552680-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="7015552680-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="7015552680-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="7015552680-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="7015552680-10">]</span><span class="p" data-group-id="7015552680-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="post!/4">
<div class="detail-header">
<a href="#post!/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">post!(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">post!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a POST request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">post!</span><span class="p" data-group-id="9817113745-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9817113745-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9817113745-2">}</span><span class="p" data-group-id="9817113745-1">)</span><span class="w">
</span><span class="n">post!</span><span class="p" data-group-id="9817113745-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9817113745-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9817113745-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9817113745-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9817113745-5">]</span><span class="p" data-group-id="9817113745-3">)</span><span class="w">
</span><span class="n">post!</span><span class="p" data-group-id="9817113745-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9817113745-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9817113745-7">}</span><span class="p" data-group-id="9817113745-6">)</span><span class="w">
</span><span class="n">post!</span><span class="p" data-group-id="9817113745-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="9817113745-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="9817113745-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="9817113745-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="9817113745-10">]</span><span class="p" data-group-id="9817113745-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="put/4">
<div class="detail-header">
<a href="#put/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">put(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">put(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a PUT request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">put</span><span class="p" data-group-id="6924743844-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6924743844-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6924743844-2">}</span><span class="p" data-group-id="6924743844-1">)</span><span class="w">
</span><span class="n">put</span><span class="p" data-group-id="6924743844-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6924743844-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6924743844-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6924743844-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6924743844-5">]</span><span class="p" data-group-id="6924743844-3">)</span><span class="w">
</span><span class="n">put</span><span class="p" data-group-id="6924743844-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6924743844-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6924743844-7">}</span><span class="p" data-group-id="6924743844-6">)</span><span class="w">
</span><span class="n">put</span><span class="p" data-group-id="6924743844-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="6924743844-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="6924743844-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6924743844-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="6924743844-10">]</span><span class="p" data-group-id="6924743844-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="put!/4">
<div class="detail-header">
<a href="#put!/4" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">put!(client, url, body, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">put!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:body/0">Tesla.Env.body</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a PUT request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">put!</span><span class="p" data-group-id="1870661689-1">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1870661689-2">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1870661689-2">}</span><span class="p" data-group-id="1870661689-1">)</span><span class="w">
</span><span class="n">put!</span><span class="p" data-group-id="1870661689-3">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1870661689-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1870661689-4">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1870661689-5">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1870661689-5">]</span><span class="p" data-group-id="1870661689-3">)</span><span class="w">
</span><span class="n">put!</span><span class="p" data-group-id="1870661689-6">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1870661689-7">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1870661689-7">}</span><span class="p" data-group-id="1870661689-6">)</span><span class="w">
</span><span class="n">put!</span><span class="p" data-group-id="1870661689-8">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="1870661689-9">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="1870661689-9">}</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="1870661689-10">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="1870661689-10">]</span><span class="p" data-group-id="1870661689-8">)</span></code></pre>
</section>
</section>
<section class="detail" id="request/2">
<span id="request/1"></span>
<div class="detail-header">
<a href="#request/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">request(client \\ %Tesla.Client{}, options)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">request(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a request.</p><h2 id="request/2-options" class="section-heading">
<a href="#request/2-options" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Options
</h2>
<ul><li><code class="inline">:method</code> - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]</li><li><code class="inline">:url</code> - either full url e.g. "<a href="http://example.com/some/path%22">http://example.com/some/path"</a> or just "/some/path" if using <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Middleware.BaseUrl.html"><code class="inline">Tesla.Middleware.BaseUrl</code></a></li><li><code class="inline">:query</code> - a keyword list of query params, e.g. <code class="inline">[page: 1, per_page: 100]</code></li><li><code class="inline">:headers</code> - a keyworld list of headers, e.g. <code class="inline">[{"content-type", "text/plain"}]</code></li><li><code class="inline">:body</code> - depends on used middleware:<ul><li>by default it can be a binary</li><li>if using e.g. JSON encoding middleware it can be a nested map</li><li>if adapter supports it it can be a Stream with any of the above</li></ul></li><li><code class="inline">:opts</code> - custom, per-request middleware or adapter options</li></ul><h2 id="request/2-examples" class="section-heading">
<a href="#request/2-examples" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Examples
</h2>
<pre><code class="makeup elixir"><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">request</span><span class="p" data-group-id="5373765030-1">(</span><span class="ss">method</span><span class="p">:</span><span class="w"> </span><span class="ss">:get</span><span class="p">,</span><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s">"/users/path"</span><span class="p" data-group-id="5373765030-1">)</span><span class="w">
</span><span class="c1"># use shortcut methods</span><span class="w">
</span><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">get</span><span class="p" data-group-id="5373765030-2">(</span><span class="s">"/users/1"</span><span class="p" data-group-id="5373765030-2">)</span><span class="w">
</span><span class="nc">ExampleApi</span><span class="o">.</span><span class="n">post</span><span class="p" data-group-id="5373765030-3">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="5373765030-4">%{</span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="s">"Jon"</span><span class="p" data-group-id="5373765030-4">}</span><span class="p" data-group-id="5373765030-3">)</span></code></pre>
</section>
</section>
<section class="detail" id="request!/2">
<span id="request!/1"></span>
<div class="detail-header">
<a href="#request!/2" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">request!(client \\ %Tesla.Client{}, options)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">request!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform request and raise in case of error.</p><p>This is similar to <a href="#request/2"><code class="inline">request/2</code></a> behaviour from Tesla 0.x</p><p>See <a href="#request/2"><code class="inline">request/2</code></a> for list of available options.</p>
</section>
</section>
<section class="detail" id="trace/3">
<div class="detail-header">
<a href="#trace/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">trace(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">trace(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) :: <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:result/0">Tesla.Env.result</a>()</pre>
</div>
<p>Perform a TRACE request.</p><p>See <a href="#request/1"><code class="inline">request/1</code></a> or <a href="#request/2"><code class="inline">request/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">trace</span><span class="p" data-group-id="2633493528-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="2633493528-1">)</span><span class="w">
</span><span class="n">trace</span><span class="p" data-group-id="2633493528-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2633493528-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2633493528-3">]</span><span class="p" data-group-id="2633493528-2">)</span><span class="w">
</span><span class="n">trace</span><span class="p" data-group-id="2633493528-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="2633493528-4">)</span><span class="w">
</span><span class="n">trace</span><span class="p" data-group-id="2633493528-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="2633493528-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="2633493528-6">]</span><span class="p" data-group-id="2633493528-5">)</span></code></pre>
</section>
</section>
<section class="detail" id="trace!/3">
<div class="detail-header">
<a href="#trace!/3" class="detail-link" title="Link to this function">
<span class="icon-link" aria-hidden="true"></span>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">trace!(client, url, opts)</h1>
<a href="https://github.com/franknfjr/jaya_currency_converter/blob/v0.1.0/lib/jaya_currency_converter/clients/exchange_rates_client.ex#L6" class="view-source" rel="help" title="View Source">
<span class="icon-code" aria-hidden="true"></span>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<h2>Specs</h2>
<div class="specs">
<pre translate="no">trace!(<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:client/0">Tesla.Env.client</a>(), <a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:url/0">Tesla.Env.url</a>(), [<a href="#t:option/0">option</a>()]) ::
<a href="https://hexdocs.pm/tesla/1.3.3/Tesla.Env.html#t:t/0">Tesla.Env.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
</div>
<p>Perform a TRACE request.</p><p>See <a href="#request!/1"><code class="inline">request!/1</code></a> or <a href="#request!/2"><code class="inline">request!/2</code></a> for options definition.</p><pre><code class="makeup elixir"><span class="n">trace!</span><span class="p" data-group-id="5151985889-1">(</span><span class="s">"/users"</span><span class="p" data-group-id="5151985889-1">)</span><span class="w">
</span><span class="n">trace!</span><span class="p" data-group-id="5151985889-2">(</span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5151985889-3">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5151985889-3">]</span><span class="p" data-group-id="5151985889-2">)</span><span class="w">
</span><span class="n">trace!</span><span class="p" data-group-id="5151985889-4">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p" data-group-id="5151985889-4">)</span><span class="w">
</span><span class="n">trace!</span><span class="p" data-group-id="5151985889-5">(</span><span class="n">client</span><span class="p">,</span><span class="w"> </span><span class="s">"/users"</span><span class="p">,</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5151985889-6">[</span><span class="ss">scope</span><span class="p">:</span><span class="w"> </span><span class="s">"admin"</span><span class="p" data-group-id="5151985889-6">]</span><span class="p" data-group-id="5151985889-5">)</span></code></pre>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
Find it on Hex:
<a href="https://hex.pm/packages/jaya_currency_converter/0.1.0" class="line footer-hex-package">Package</a>
<a href="https://preview.hex.pm/preview/jaya_currency_converter/0.1.0" class="line">Preview</a>
<a href="https://preview.hex.pm/preview/jaya_currency_converter/0.1.0/show/lib/jaya_currency_converter/clients/exchange_rates_client.ex">(current file)</a>
</p>
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.26.0) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>.
</span>
<span class="line">
Designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" rel="noopener" title="@dignifiedquire" translate="no">Friedel Ziegelmayer</a>.
</span>
</p>
<p>
<a href="api-reference.html" title="API reference" class="line footer-button">API Reference</a>
<button class="line footer-button display-shortcuts-help">
Display keyboard shortcuts
</button>
<button class="line footer-button display-quick-switch">
Go to a HexDocs package
</button>
<button class="line footer-button display-settings">
Settings
</button>
</p>
</footer>
</div>
</div>
</section>
</div>
</body>
</html>