Shipstation v0.3.5 Shipstation.Client

Shipstation is a piece of software which makes it easy to import, manage and ship your orders. They aim to streamline shipping for online sellers, no matter where they sell their products online.

This hex package is designed to allow you to integrate your ecommerce product with Shipstation’s publicly accessible API.

Summary

Functions

This function decides if there is enough data to build a Basic Authentication header to add into the request. This is useful because it will attempt to make the request without the header if there isn’t enough data. You might want to do this if you are wanting to create a new account through the API

This is the function that calls the API on behalf of the rest of the codebase. It will compile the component pieces of the request and add in authentication information when necessary

Issues a DELETE request to the given url

Issues a DELETE request to the given url, raising an exception in case of failure

Issues a GET request to the given url

Issues a GET request to the given url, raising an exception in case of failure

Issues a HEAD request to the given url

Issues a HEAD request to the given url, raising an exception in case of failure

Issues an OPTIONS request to the given url

Issues a OPTIONS request to the given url, raising an exception in case of failure

Issues a PATCH request to the given url

Issues a PATCH request to the given url, raising an exception in case of failure

Issues a POST request to the given url

Issues a POST request to the given url, raising an exception in case of failure

Issues a PUT request to the given url

Issues a PUT request to the given url, raising an exception in case of failure

Issues an HTTP request with the given method to the given url

Issues an HTTP request with the given method to the given url, raising an exception in case of failure

Starts HTTPoison and its dependencies

Requests the next message to be streamed for a given HTTPoison.AsyncResponse

Types

body()
body() :: binary | {:form, [{atom, any}]} | {:file, binary}
headers()
headers ::
  [{binary, binary}] |
  %{optional(binary) => binary}
response_type()
response_type() :: {atom, map}

Functions

auth()
auth() :: [{:basic_auth, {String.t, String.t}}] | []

This function decides if there is enough data to build a Basic Authentication header to add into the request. This is useful because it will attempt to make the request without the header if there isn’t enough data. You might want to do this if you are wanting to create a new account through the API.

base_uri()
base_uri() :: URI.t
call_api(verb, u_r_i, body, custom_headers \\ [])
call_api(verb :: atom, uri :: URI.t, body :: map | [map], custom_headers :: [map]) :: response_type

This is the function that calls the API on behalf of the rest of the codebase. It will compile the component pieces of the request and add in authentication information when necessary.

default_headers()
default_headers() :: [tuple]
delete(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

delete!(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

get(url, headers \\ [], options \\ [])

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

get!(url, headers \\ [], options \\ [])

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

head(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

head!(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

options(url, headers \\ [], options \\ [])

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

options!(url, headers \\ [], options \\ [])

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

patch(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

patch!(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

post(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

post!(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

process_headers(headers)
process_request_body(body)
process_request_headers(headers)
process_response_body(body)
process_response_chunk(chunk)
process_status_code(status_code)
process_url(url)
put(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

put!(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

request(method, url, body \\ "", headers \\ [], options \\ [])
request(atom, binary, body, headers, Keyword.t) ::
  {:ok, HTTPoison.Response.t | HTTPoison.AsyncResponse.t} |
  {:error, HTTPoison.Error.t}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

  • method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
  • url - target url as a binary string or char list
  • body - request body. See more below
  • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
  • options - Keyword list of options

Body:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file
  • {:stream, enumerable} - lazily send a stream of binaries/charlists Options: *:timeout- timeout to establish a connection, in milliseconds. Default is 8000 *:recv_timeout- timeout used when receiving a connection. Default is 5000 *:stream_to- a PID to stream the response to *:async- if given:once, will only stream one message at a time, requires call tostream_next*:proxy- a proxy to be used for the request; it can be a regular url or a{Host, Port}tuple *:proxy_auth- proxy authentication{User, Password}tuple *:ssl- SSL options supported by thesslerlang module *:follow_redirect- a boolean that causes redirects to be followed *:max_redirect- an integer denoting the maximum number of redirects to follow *:params- an enumerable consisting of two-item tuples that will be appended to the url as query string parameters Timeouts can be an integer or:infinityThis function returns{:ok, response}or{:ok, async_response}if the request is successful,{:error, reason}` otherwise. ## Examples request(:post, “https://my.website.com”, “{\”foo\”: 3}”, [{“Accept”, “application/json”}])
request!(method, url, body \\ "", headers \\ [], options \\ [])
request!(atom, binary, body, headers, Keyword.t) :: HTTPoison.Response.t

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

start()

Starts HTTPoison and its dependencies.

stream_next(async_response)

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.