View Source Docspring.Connection (docspring v0.0.4)

@type option() ::
  {:method, Tesla.Env.method()}
  | {:url, Tesla.Env.url()}
  | {:query, Tesla.Env.query()}
  | {:headers, Tesla.Env.headers()}
  | {:body, Tesla.Env.body()}
  | {:opts, Tesla.Env.opts()}

Link to this section Functions

delete(url)

@spec delete(Tesla.Env.url()) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

ExampleApi.delete("/users")

delete(client, url)

@spec delete(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()

@spec delete(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.delete("/users")
ExampleApi.delete("/users", query: [page: 1])

delete(client, url, options)

@spec delete(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a DELETE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.delete("/users", query: [page: 1])

get(url)

@spec get(Tesla.Env.url()) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

ExampleApi.get("/users")

get(client, url)

@spec get(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()

@spec get(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.get("/users")
ExampleApi.get("/users", query: [page: 1])

get(client, url, options)

@spec get(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a GET request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.get("/users", query: [page: 1])

head(url)

@spec head(Tesla.Env.url()) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

ExampleApi.head("/users")

head(client, url)

@spec head(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()

@spec head(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.head("/users")
ExampleApi.head("/users", query: [page: 1])

head(client, url, options)

@spec head(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a HEAD request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.head("/users", query: [page: 1])

new()

@spec new() :: Tesla.Env.client()

Configure an authless client connection

Returns

Tesla.Env.client

new(username, password)

@spec new(String.t(), String.t()) :: Tesla.Env.client()

Configure a client connection using Basic authentication.

parameters
Parameters

username (String): Username used for authentication
password (String): Password used for authentication

Returns

Tesla.Env.client

options(url)

@spec options(Tesla.Env.url()) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

ExampleApi.options("/users")

options(client, url)

@spec options(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()

@spec options(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.options("/users")
ExampleApi.options("/users", query: [page: 1])

options(client, url, options)

@spec options(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a OPTIONS request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.options("/users", query: [page: 1])

patch(url, body)

@spec patch(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

ExampleApi.patch("/users", %{name: "Jon"})

patch(client, url, body)

@spec patch(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

@spec patch(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.patch("/users", %{name: "Jon"})
ExampleApi.patch("/users", %{name: "Jon"}, query: [scope: "admin"])

patch(client, url, body, options)

@spec patch(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a PATCH request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.patch("/users", %{name: "Jon"}, query: [scope: "admin"])

post(url, body)

@spec post(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

ExampleApi.post("/users", %{name: "Jon"})

post(client, url, body)

@spec post(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

@spec post(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.post("/users", %{name: "Jon"})
ExampleApi.post("/users", %{name: "Jon"}, query: [scope: "admin"])

post(client, url, body, options)

@spec post(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a POST request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.post("/users", %{name: "Jon"}, query: [scope: "admin"])

put(url, body)

@spec put(Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

ExampleApi.put("/users", %{name: "Jon"})

put(client, url, body)

@spec put(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body()) :: Tesla.Env.t()

@spec put(Tesla.Env.url(), Tesla.Env.body(), [option()]) :: Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.put("/users", %{name: "Jon"})
ExampleApi.put("/users", %{name: "Jon"}, query: [scope: "admin"])

put(client, url, body, options)

@spec put(Tesla.Env.client(), Tesla.Env.url(), Tesla.Env.body(), [option()]) ::
  Tesla.Env.t()

Perform a PUT request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.put("/users", %{name: "Jon"}, query: [scope: "admin"])

request(options)

@spec request([option()]) :: Tesla.Env.t()

Perform a request. See request/2 for available options.

request(client, options)

@spec request(Tesla.Env.client(), [option()]) :: Tesla.Env.t()

Perform a request using client function

Options:

:method - the request method, one of [:head, :get, :delete, :trace, :options, :post, :put, :patch]
:url - either full url e.g. "http://example.com/some/path" or just "/some/path" if using Tesla.Middleware.BaseUrl
:query - a keyword list of query params, e.g. [page: 1, per_page: 100]
:headers - a keyworld list of headers, e.g. [{"content-type", "text/plain"}]
:body - depends on used middleware:
- by default it can be a binary
- if using e.g. JSON encoding middleware it can be a nested map
- if adapter supports it it can be a Stream with any of the above
:opts - custom, per-request middleware or adapter options

Examples:

ExampleApi.request(method: :get, url: "/users/path")

You can also use shortcut methods like:

ExampleApi.get("/users/1")

myclient |> ExampleApi.post("/users", %{name: "Jon"})

trace(url)

@spec trace(Tesla.Env.url()) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

ExampleApi.trace("/users")

trace(client, url)

@spec trace(Tesla.Env.client(), Tesla.Env.url()) :: Tesla.Env.t()

@spec trace(Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.trace("/users")
ExampleApi.trace("/users", query: [page: 1])

trace(client, url, options)

@spec trace(Tesla.Env.client(), Tesla.Env.url(), [option()]) :: Tesla.Env.t()

Perform a TRACE request. See request/1 or request/2 for options definition.

Example

myclient |> ExampleApi.trace("/users", query: [page: 1])

Settings View Source Docspring.Connection (docspring v0.0.4)

Link to this section Summary

Types

Functions

Link to this section Types

option()

Link to this section Functions

delete(url)

delete(client, url)

delete(client, url, options)

get(url)

get(client, url)

get(client, url, options)

head(url)

head(client, url)

head(client, url, options)

new()

Returns

new(username, password)

parameters Parameters

Returns

options(url)

options(client, url)

options(client, url, options)

patch(url, body)

patch(client, url, body)

patch(client, url, body, options)

post(url, body)

post(client, url, body)

post(client, url, body, options)

put(url, body)

put(client, url, body)

put(client, url, body, options)

request(options)

request(client, options)

trace(url)

trace(client, url)

trace(client, url, options)

View Source Docspring.Connection (docspring v0.0.4)

parameters
Parameters