2023-07-12 11:28:07 +03:00
<!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.29.4" >
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.HTTPClient.Interface — Plausible v0.0.1< / title >
< link rel = "stylesheet" href = "dist/html-elixir-HHVY3JYD.css" / >
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
< script src = "dist/handlebars.templates-XWGFFSCD.js" > < / script >
2023-07-24 17:28:39 +03:00
< script src = "dist/sidebar_items-CDCE2E48.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
< script async src = "dist/html-JDI3AVDD.js" > < / script >
< / head >
< body data-type = "modules" class = "page-behaviour" >
< script >
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) & &
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
< / script >
< div class = "main" >
< button class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" >
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
< section class = "sidebar" >
< form class = "sidebar-search" action = "search.html" >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-label = "Cancel Search" >
< i class = "ri-close-line ri-lg" aria-hidden = "true" title = "Cancel search" > < / i >
< / button >
< label class = "search-label" >
< p class = "sr-only" > Search< / p >
< input name = "q" type = "text" class = "search-input" placeholder = "Search..." aria-label = "Input your search terms" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< / form >
< div class = "autocomplete" >
< div class = "autocomplete-results" >
< / div >
< / div >
< div class = "sidebar-header" >
< a href = "readme.html" >
< img src = "assets/logo.png" alt = "Plausible" class = "sidebar-projectImage" >
< / a >
< div class = "sidebar-projectDetails" >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
Plausible
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
< / 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 >
< li > < a id = "tasks-list-link" href = "#full-list" > < span translate = "no" > Mix< / span > Tasks< / a > < / li >
< / ul >
< / div >
< div class = "gradient" > < / div >
< ul id = "full-list" > < / ul >
< / section >
< section class = "content" >
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
< h1 >
< button class = "icon-action display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L13" title = "View Source" class = "icon-action" rel = "help" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< span translate = "no" > Plausible.HTTPClient.Interface< / span > < small > behaviour< / small >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "summary" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#summary" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< 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:finch_request_opts/0" translate = "no" > finch_request_opts()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:headers/0" translate = "no" > headers()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:params/0" translate = "no" > params()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:response/0" translate = "no" > response()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:url/0" translate = "no" > url()< / a >
< / div >
< / div >
< / div >
< div class = "summary-callbacks summary" >
< h2 >
< a href = "#callbacks" > Callbacks< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#c:get/1" translate = "no" > get(url)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#c:get/2" translate = "no" > get(url, headers)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#c:post/3" translate = "no" > post(url, headers, params)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#c:post/4" translate = "no" > post(url, headers, params, finch_request_opts)< / a >
< / div >
< / div >
< / div >
< / section >
< section id = "types" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#types" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this section< / span >
< / a >
Types
< / h1 >
< div class = "types-list" >
< section class = "detail" id = "t:finch_request_opts/0" >
< div class = "detail-header" >
< a href = "#t:finch_request_opts/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > finch_request_opts()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L14" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > finch_request_opts() :: < a href = "https://hexdocs.pm/elixir/Keyword.html#t:t/0" > Keyword.t< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "t:headers/0" >
< div class = "detail-header" >
< a href = "#t:headers/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > headers()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L16" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > headers() :: < a href = "https://hexdocs.pm/finch/0.14.0/Finch.Request.html#t:headers/0" > Finch.Request.headers< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "t:params/0" >
< div class = "detail-header" >
< a href = "#t:params/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > params()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L17" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > params() :: < a href = "https://hexdocs.pm/finch/0.14.0/Finch.Request.html#t:body/0" > Finch.Request.body< / a > () | < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > map< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "t:response/0" >
< div class = "detail-header" >
< a href = "#t:response/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > response()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L18" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > response() ::
{:ok, < a href = "https://hexdocs.pm/finch/0.14.0/Finch.Response.html#t:t/0" > Finch.Response.t< / a > ()}
| {:error,
< a href = "https://hexdocs.pm/mint/1.5.1/Mint.Types.html#t:error/0" > Mint.Types.error< / a > () | < a href = "https://hexdocs.pm/finch/0.14.0/Finch.Error.html#t:t/0" > Finch.Error.t< / a > () | < a href = "Plausible.HTTPClient.Non200Error.html#t:t/0" > Plausible.HTTPClient.Non200Error.t< / a > ()}< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "t:url/0" >
< div class = "detail-header" >
< a href = "#t:url/0" class = "detail-link" title = "Link to this type" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this type< / span >
< / a >
< h1 class = "signature" translate = "no" > url()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L15" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @type< / span > url() :: < a href = "https://hexdocs.pm/finch/0.14.0/Finch.Request.html#t:url/0" > Finch.Request.url< / a > ()< / pre >
< / div >
< / section >
< / section >
< / div >
< / section >
< section id = "callbacks" class = "details-list" >
< h1 class = "section-heading" >
< a class = "hover-link" href = "#callbacks" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this section< / span >
< / a >
Callbacks
< / h1 >
< div class = "callbacks-list" >
< section class = "detail" id = "c:get/1" >
< div class = "detail-header" >
< a href = "#c:get/1" class = "detail-link" title = "Link to this callback" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this callback< / span >
< / a >
< h1 class = "signature" translate = "no" > get(url)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L23" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @callback< / span > get(< a href = "#t:url/0" > url< / a > ()) :: < a href = "#t:response/0" > response< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "c:get/2" >
< div class = "detail-header" >
< a href = "#c:get/2" class = "detail-link" title = "Link to this callback" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this callback< / span >
< / a >
< h1 class = "signature" translate = "no" > get(url, headers)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L22" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @callback< / span > get(< a href = "#t:url/0" > url< / a > (), < a href = "#t:headers/0" > headers< / a > ()) :: < a href = "#t:response/0" > response< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "c:post/3" >
< div class = "detail-header" >
< a href = "#c:post/3" class = "detail-link" title = "Link to this callback" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this callback< / span >
< / a >
< h1 class = "signature" translate = "no" > post(url, headers, params)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L24" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @callback< / span > post(< a href = "#t:url/0" > url< / a > (), < a href = "#t:headers/0" > headers< / a > (), < a href = "#t:params/0" > params< / a > ()) :: < a href = "#t:response/0" > response< / a > ()< / pre >
< / div >
< / section >
< / section >
< section class = "detail" id = "c:post/4" >
< div class = "detail-header" >
< a href = "#c:post/4" class = "detail-link" title = "Link to this callback" >
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this callback< / span >
< / a >
< h1 class = "signature" translate = "no" > post(url, headers, params, finch_request_opts)< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/http_client.ex#L25" class = "icon-action" rel = "help" title = "View Source" >
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< div class = "specs" >
< pre translate = "no" > < span class = "attribute" > @callback< / span > post(< a href = "#t:url/0" > url< / a > (), < a href = "#t:headers/0" > headers< / a > (), < a href = "#t:params/0" > params< / a > (), < a href = "#t:finch_request_opts/0" > finch_request_opts< / a > ()) :: < a href = "#t:response/0" > response< / a > ()< / pre >
< / div >
< / section >
< / section >
< / div >
< / section >
< footer class = "footer" >
< p >
< span class = "line" >
< button class = "a-main footer-button display-quick-switch" title = "Search HexDocs packages" >
Search HexDocs
< / button >
< a href = "Plausible.epub" title = "ePub version" >
Download ePub version
< / a >
< / span >
< / p >
< p class = "built-using" >
Built using
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.29.4) for the
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
< / section >
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
