Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuartapp/stuart-client-elixir
Stuart Elixir client
https://github.com/stuartapp/stuart-client-elixir
delivery elixir-library stuart
Last synced: about 1 month ago
JSON representation
Stuart Elixir client
- Host: GitHub
- URL: https://github.com/stuartapp/stuart-client-elixir
- Owner: StuartApp
- Created: 2018-07-30T13:40:03.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-20T09:57:04.000Z (over 1 year ago)
- Last Synced: 2024-10-30T16:56:28.836Z (2 months ago)
- Topics: delivery, elixir-library, stuart
- Language: Elixir
- Homepage:
- Size: 65.4 KB
- Stars: 4
- Watchers: 49
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://app.codeship.com/projects/363007)
# Stuart Elixir Client
For a complete documentation of all endpoints offered by the Stuart API, you can read the [Stuart API documentation](https://api-docs.stuart.com/).
## Install
```elixir
# mix.exs
def deps do
[
{:stuart_client_elixir, "~> 1.3.1"}
]
end
```
## Usage
#### Custom requests
#### Send a GET request to the Stuart API
```elixir
alias StuartClientElixir.{Environment, Credentials}
credentials = %Credentials{client_id: "...", client_secret: "..."}
StuartClientElixir.get(
"/v2/jobs/95896", %{environment: Environment.sandbox(), credentials: credentials})
```
#### Send a POST request to the Stuart API
```elixir
alias StuartClientElixir.{Environment, Credentials}
job = %{
job: %{
transport_type: "bike",
pickups: [
%{
address: "46 Boulevard Barbès, 75018 Paris",
comment: "Wait outside for an employee to come.",
contact: %{
firstname: "Martin",
lastname: "Pont",
phone: "+33698348756",
company: "KFC Paris Barbès"
}
}
],
dropoffs: [
%{
address: "156 rue de Charonne, 75011 Paris",
package_description: "Red packet.",
comment: "code: 3492B. 3e étage droite. Sonner à Durand.",
contact: %{
firstname: "Alex",
lastname: "Durand",
phone: "+33634981209",
company: "Durand associates."
}
}
]
}
}
credentials = %Credentials{client_id: "...", client_secret: "..."}
StuartClientElixir.post("/v2/jobs", Jason.encode!(job), %{environment: Environment.sandbox(), credentials: credentials})
```
#### Send a PATCH request to the Stuart API
```elixir
alias StuartClientElixir.{Environment, Credentials}
job = %{
job: %{
deliveries: [
%{
id: "43035",
client_reference: "new_client_reference",
package_description: "new_package_description",
pickup: %{
comment: "new_comment",
contact: %{
firstname: "new_firstname",
lastname: "new_lastname",
phone: "+33628046091",
email: "[email protected]",
company: "new_company"
}
},
dropoff: %{
comment: "new_comment",
contact: %{
firstname: "new_firstname",
lastname: "new_lastname",
phone: "+33628046095",
email: "[email protected]",
company: "new_company"
}
}
}
]
}
}
credentials = %Credentials{client_id: "...", client_secret: "..."}
StuartClientElixir.patch("/v2/jobs/1234", Jason.encode!(job), %{environment: Environment.sandbox(), credentials: credentials})
```