zippendo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e489bdaf0549f71942041b5cb9badb6b1c090a021f9d29389733e105d45c9bd
+  data.tar.gz: 0a4a5ee8853d98349c66dd7aaffc023d764c90ed608eb89147cd2674e673dc53
+SHA512:
+  metadata.gz: 8b27f107ce90daf43afafd301f7f0242ec05b20782a5e648433f32727b755dee6087ec2ad8643ea124bd8a19c5a1e5c7d40cb309d9044b7192958713b9ca74bc
+  data.tar.gz: d961b22c62a5ecd73e73c6eb0e2b1340f351f595cd57c73e1f4c716af3eac6ff8732aae02de5c117860313f97a58a18cc962be326613394779753fc526d15474

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zippendo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Zippendo Ruby SDK
+
+Official Ruby client for the [Zippendo](https://zippendo.com) shipping & logistics API. Requires
+Ruby 2.7+.
+
+## Install
+
+```sh
+gem install zippendo
+```
+
+## Authentication
+
+Create an API token in your Zippendo dashboard (**Settings → API tokens**) — a Bearer token prefixed
+with `zipp_`. Configure it once:
+
+```ruby
+require "zippendo"
+
+Zippendo.configure do |config|
+  config.access_token = ENV["ZIPPENDO_API_TOKEN"]
+end
+```
+
+The base URL defaults to `https://api.zippendo.com`.
+
+## Resources & clients
+
+The API is split into resource clients — `ShipmentsApi`, `OrdersApi`, `CarriersApi`, `AddressesApi`,
+`RulesApi`, `WebhooksApi`, `TokensApi`, and more:
+
+```ruby
+shipments = Zippendo::ShipmentsApi.new
+orders = Zippendo::OrdersApi.new
+```
+
+## The `org_id` parameter
+
+Every call takes an `org_id` (your organization ID, found in the dashboard). It is explicit on each
+call by design: one API token can be granted access to multiple organizations, and `org_id` selects
+which one the request acts on.
+
+## Listing & pagination
+
+List endpoints accept `:page` (1-based) and `:limit`, and return a page with `data` plus `total`,
+`page`, `limit`, and `total_pages`:
+
+```ruby
+result = shipments.list_shipments("org_8f3kd92ld0", page: 1, limit: 50)
+puts result.data                       # Array<Shipment>
+puts "#{result.total} / #{result.total_pages}"
+```
+
+## Creating resources
+
+```ruby
+order = orders.create_order("org_8f3kd92ld0", Zippendo::CreateOrderRequest.new(
+  order_number: "1001",
+  order_channel_id: "chan_7d2k1",
+  order_lines: [Zippendo::CreateOrderRequestOrderLinesInner.new(name: "T-shirt", quantity: 2)]
+))
+puts order.id
+```
+
+See [`./docs`](./docs) for the full request/response shape of every operation.
+
+## Error handling
+
+Non-2xx responses raise `Zippendo::ApiError`. The body is Zippendo's canonical
+`{ code, error, message }` — branch on the machine-readable `code`:
+
+```ruby
+begin
+  shipments.get_shipment("org_8f3kd92ld0", "shp_missing")
+rescue Zippendo::ApiError => e
+  puts e.code            # HTTP status
+  puts e.response_body   # JSON, e.g. {"code":"SHIPMENT_NOT_FOUND", ...}
+end
+```
+
+## Configuration
+
+Point the client at a different environment by overriding the host:
+
+```ruby
+Zippendo.configure do |config|
+  config.access_token = ENV["ZIPPENDO_API_TOKEN"]
+  config.host = "staging.api.zippendo.com"
+end
+```
+
+## Reference
+
+Full per-endpoint and per-model documentation is in [`./docs`](./docs). Hosted reference:
+<https://www.zippendo.com/docs/api-reference/overview>.
+
+## License
+
+[MIT](./LICENSE.md)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddressesApi.md

@@ -0,0 +1,375 @@
+# Zippendo::AddressesApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_address**](AddressesApi.md#create_address) | **POST** /orgs/{orgId}/addresses | Create address |
+| [**delete_address**](AddressesApi.md#delete_address) | **DELETE** /orgs/{orgId}/addresses/{addressId} | Delete address |
+| [**get_address**](AddressesApi.md#get_address) | **GET** /orgs/{orgId}/addresses/{addressId} | Get address |
+| [**list_addresses**](AddressesApi.md#list_addresses) | **GET** /orgs/{orgId}/addresses | List addresses |
+| [**update_address**](AddressesApi.md#update_address) | **PUT** /orgs/{orgId}/addresses/{addressId} | Update address |
+
+
+## create_address
+
+> <ListAddresses200ResponseDataInner> create_address(org_id, create_address_request)
+
+Create address
+
+Creates a new sender, pickup or return address for the organization.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zippendo'
+# setup authorization
+Zippendo.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zippendo::AddressesApi.new
+org_id = 'org_01HZX9K2QF' # String | Organization ID
+create_address_request = Zippendo::CreateAddressRequest.new({name: 'Hovedlager', att_contact: 'Mette Hansen', address1: 'Vesterbrogade 1', zipcode: '1620', city: 'København', phone: '+4533123456', country_code: 'DK', email: 'lager@example.dk'}) # CreateAddressRequest | 
+
+begin
+  # Create address
+  result = api_instance.create_address(org_id, create_address_request)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->create_address: #{e}"
+end
+```
+
+#### Using the create_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAddresses200ResponseDataInner>, Integer, Hash)> create_address_with_http_info(org_id, create_address_request)
+
+```ruby
+begin
+  # Create address
+  data, status_code, headers = api_instance.create_address_with_http_info(org_id, create_address_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAddresses200ResponseDataInner>
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->create_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **create_address_request** | [**CreateAddressRequest**](CreateAddressRequest.md) |  |  |
+
+### Return type
+
+[**ListAddresses200ResponseDataInner**](ListAddresses200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_address
+
+> String delete_address(org_id, address_id)
+
+Delete address
+
+Deletes an address belonging to the organization.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zippendo'
+# setup authorization
+Zippendo.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zippendo::AddressesApi.new
+org_id = 'org_01HZX9K2QF' # String | Organization ID
+address_id = 'addr_01HZX9K2QF' # String | Address ID
+
+begin
+  # Delete address
+  result = api_instance.delete_address(org_id, address_id)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->delete_address: #{e}"
+end
+```
+
+#### Using the delete_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> delete_address_with_http_info(org_id, address_id)
+
+```ruby
+begin
+  # Delete address
+  data, status_code, headers = api_instance.delete_address_with_http_info(org_id, address_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->delete_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **address_id** | **String** | Address ID |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_address
+
+> <ListAddresses200ResponseDataInner> get_address(org_id, address_id)
+
+Get address
+
+Returns a single address belonging to the organization, identified by its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zippendo'
+# setup authorization
+Zippendo.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zippendo::AddressesApi.new
+org_id = 'org_01HZX9K2QF' # String | Organization ID
+address_id = 'addr_01HZX9K2QF' # String | Address ID
+
+begin
+  # Get address
+  result = api_instance.get_address(org_id, address_id)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->get_address: #{e}"
+end
+```
+
+#### Using the get_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAddresses200ResponseDataInner>, Integer, Hash)> get_address_with_http_info(org_id, address_id)
+
+```ruby
+begin
+  # Get address
+  data, status_code, headers = api_instance.get_address_with_http_info(org_id, address_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAddresses200ResponseDataInner>
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->get_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **address_id** | **String** | Address ID |  |
+
+### Return type
+
+[**ListAddresses200ResponseDataInner**](ListAddresses200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_addresses
+
+> <ListAddresses200Response> list_addresses(org_id, opts)
+
+List addresses
+
+Returns a paginated list of addresses for the organization, optionally filtered by type.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zippendo'
+# setup authorization
+Zippendo.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zippendo::AddressesApi.new
+org_id = 'org_01HZX9K2QF' # String | Organization ID
+opts = {
+  page: 1, # Integer | Page number (1-based)
+  limit: 20, # Integer | Items per page (max 100)
+  type: 'sender' # String | Filter by address type (sender, pickup, return)
+}
+
+begin
+  # List addresses
+  result = api_instance.list_addresses(org_id, opts)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->list_addresses: #{e}"
+end
+```
+
+#### Using the list_addresses_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAddresses200Response>, Integer, Hash)> list_addresses_with_http_info(org_id, opts)
+
+```ruby
+begin
+  # List addresses
+  data, status_code, headers = api_instance.list_addresses_with_http_info(org_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAddresses200Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->list_addresses_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
+| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
+| **type** | **String** | Filter by address type (sender, pickup, return) | [optional] |
+
+### Return type
+
+[**ListAddresses200Response**](ListAddresses200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_address
+
+> <ListAddresses200ResponseDataInner> update_address(org_id, address_id, update_address_request)
+
+Update address
+
+Updates an existing address belonging to the organization.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zippendo'
+# setup authorization
+Zippendo.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zippendo::AddressesApi.new
+org_id = 'org_01HZX9K2QF' # String | Organization ID
+address_id = 'addr_01HZX9K2QF' # String | Address ID
+update_address_request = Zippendo::UpdateAddressRequest.new # UpdateAddressRequest | 
+
+begin
+  # Update address
+  result = api_instance.update_address(org_id, address_id, update_address_request)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->update_address: #{e}"
+end
+```
+
+#### Using the update_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAddresses200ResponseDataInner>, Integer, Hash)> update_address_with_http_info(org_id, address_id, update_address_request)
+
+```ruby
+begin
+  # Update address
+  data, status_code, headers = api_instance.update_address_with_http_info(org_id, address_id, update_address_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAddresses200ResponseDataInner>
+rescue Zippendo::ApiError => e
+  puts "Error when calling AddressesApi->update_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **address_id** | **String** | Address ID |  |
+| **update_address_request** | [**UpdateAddressRequest**](UpdateAddressRequest.md) |  |  |
+
+### Return type
+
+[**ListAddresses200ResponseDataInner**](ListAddresses200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/BatchSendShipments200Response.md

@@ -0,0 +1,20 @@
+# Zippendo::BatchSendShipments200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array<BatchSendShipments200ResponseResultsInner>**](BatchSendShipments200ResponseResultsInner.md) | Per-shipment outcome (one entry per unique requested shipment id). |  |
+| **summary** | [**BatchSendShipments200ResponseSummary**](BatchSendShipments200ResponseSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSendShipments200Response.new(
+  results: null,
+  summary: null
+)
+```
+

data/docs/BatchSendShipments200ResponseResultsInner.md

@@ -0,0 +1,26 @@
+# Zippendo::BatchSendShipments200ResponseResultsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **shipment_id** | **String** | The shipment this result refers to. |  |
+| **status** | **String** | Whether this shipment was successfully booked with its carrier. |  |
+| **code** | **String** | Canonical machine-readable error code, present when `status` is `failed`. | [optional] |
+| **message** | **String** | Human-readable failure detail, present when `status` is `failed`. | [optional] |
+| **errors** | [**Array<SendShipment422ResponseErrorsInner>**](SendShipment422ResponseErrorsInner.md) | Carrier-specific errors, present when the carrier rejected the booking. | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSendShipments200ResponseResultsInner.new(
+  shipment_id: shp_01H8XABC123,
+  status: sent,
+  code: CARRIER_ERROR,
+  message: Shipment must be in pending or error status to be sent,
+  errors: null
+)
+```
+

data/docs/BatchSendShipments200ResponseSummary.md

@@ -0,0 +1,22 @@
+# Zippendo::BatchSendShipments200ResponseSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Number of unique shipments processed. |  |
+| **sent** | **Integer** | How many were successfully booked. |  |
+| **failed** | **Integer** | How many failed. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSendShipments200ResponseSummary.new(
+  total: 3,
+  sent: 2,
+  failed: 1
+)
+```
+

data/docs/BatchSendShipmentsRequest.md

@@ -0,0 +1,18 @@
+# Zippendo::BatchSendShipmentsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **shipment_ids** | **Array<String>** | IDs of the shipments to book. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSendShipmentsRequest.new(
+  shipment_ids: ["shp_01H8XABC123","shp_01H8XDEF456"]
+)
+```
+

data/docs/BatchSplitShipment201Response.md

@@ -0,0 +1,20 @@
+# Zippendo::BatchSplitShipment201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_shipment** | [**CreateShipment201Response**](CreateShipment201Response.md) |  |  |
+| **new_shipments** | [**Array<CreateShipment201Response>**](CreateShipment201Response.md) | Newly created shipments resulting from the split. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSplitShipment201Response.new(
+  original_shipment: null,
+  new_shipments: null
+)
+```
+

data/docs/BatchSplitShipmentRequest.md

@@ -0,0 +1,28 @@
+# Zippendo::BatchSplitShipmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parcel_id** | **String** | Parcel whose order lines are split across new shipments. |  |
+| **shipments** | [**Array<BatchSplitShipmentRequestShipmentsInner>**](BatchSplitShipmentRequestShipmentsInner.md) | New shipments to create from the split parcel. |  |
+| **carrier_id** | **String** | Carrier for all new shipments. Copied from the original if omitted. | [optional] |
+| **product_id** | **String** | Carrier product for all new shipments. Copied from the original if omitted. | [optional] |
+| **services** | **Array<String>** | Service codes for all new shipments. Copied from the original if omitted. | [optional] |
+| **additional_parameters** | **Hash<String, Object>** | Carrier-specific parameters for all new shipments. | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSplitShipmentRequest.new(
+  parcel_id: prc_5a6b7c8d,
+  shipments: null,
+  carrier_id: car_pn_001,
+  product_id: prod_mypack_home,
+  services: ["A7"],
+  additional_parameters: {"notificationEmail":"anna@example.dk"}
+)
+```
+

data/docs/BatchSplitShipmentRequestShipmentsInner.md

@@ -0,0 +1,20 @@
+# Zippendo::BatchSplitShipmentRequestShipmentsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference** | **String** | Reference for this new shipment. Defaults to original reference with a suffix. | [optional] |
+| **order_lines** | [**Array<BatchSplitShipmentRequestShipmentsInnerOrderLinesInner>**](BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md) | Order lines and quantities to move into this new shipment. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::BatchSplitShipmentRequestShipmentsInner.new(
+  reference: ORDER-1042-split-1,
+  order_lines: null
+)
+```
+