zippendo 1.0.0

data/docs/SplitShipment201Response.md

@@ -0,0 +1,20 @@
+# Zippendo::SplitShipment201Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_shipment** | [**CreateShipment201Response**](CreateShipment201Response.md) |  |  |
+| **new_shipment** | [**CreateShipment201Response**](CreateShipment201Response.md) |  |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::SplitShipment201Response.new(
+  original_shipment: null,
+  new_shipment: null
+)
+```
+

data/docs/SplitShipmentParcel200Response.md

@@ -0,0 +1,18 @@
+# Zippendo::SplitShipmentParcel200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **shipment** | [**CreateShipment201Response**](CreateShipment201Response.md) |  |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::SplitShipmentParcel200Response.new(
+  shipment: null
+)
+```
+

data/docs/SplitShipmentParcelRequest.md

@@ -0,0 +1,18 @@
+# Zippendo::SplitShipmentParcelRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parcels** | [**Array<SplitShipmentParcelRequestParcelsInner>**](SplitShipmentParcelRequestParcelsInner.md) | Target parcel layout to redistribute order lines into. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::SplitShipmentParcelRequest.new(
+  parcels: null
+)
+```
+

data/docs/SplitShipmentParcelRequestParcelsInner.md

@@ -0,0 +1,20 @@
+# Zippendo::SplitShipmentParcelRequestParcelsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Existing parcel ID to update. Omit to create a new parcel. | [optional] |
+| **order_lines** | [**Array<BatchSplitShipmentRequestShipmentsInnerOrderLinesInner>**](BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md) | Order lines and quantities to place in this parcel. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::SplitShipmentParcelRequestParcelsInner.new(
+  id: prc_5a6b7c8d,
+  order_lines: null
+)
+```
+

data/docs/SplitShipmentRequest.md

@@ -0,0 +1,30 @@
+# Zippendo::SplitShipmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parcel_id** | **String** | Parcel whose order lines are split into a new shipment. |  |
+| **order_line_ids** | **Array<String>** | Order line IDs to move. If omitted, all order lines in the parcel are moved. | [optional] |
+| **carrier_id** | **String** | Carrier for the new shipment. Copied from the original if omitted. | [optional] |
+| **product_id** | **String** | Carrier product for the new shipment. Copied from the original if omitted. | [optional] |
+| **services** | **Array<String>** | Service codes for the new shipment. Copied from the original if omitted. | [optional] |
+| **additional_parameters** | **Hash<String, Object>** | Carrier-specific parameters for the new shipment. | [optional] |
+| **reference** | **String** | Reference for the new shipment. Defaults to the original reference with a suffix. | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::SplitShipmentRequest.new(
+  parcel_id: prc_5a6b7c8d,
+  order_line_ids: ["ol_9c1d2e3f"],
+  carrier_id: car_pn_001,
+  product_id: prod_mypack_home,
+  services: ["A7"],
+  additional_parameters: {"notificationEmail":"anna@example.dk"},
+  reference: ORDER-1042-split
+)
+```
+

data/docs/SystemApi.md

@@ -0,0 +1,74 @@
+# Zippendo::SystemApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**health_check**](SystemApi.md#health_check) | **GET** /health | Health check |
+
+
+## health_check
+
+> <HealthCheck200Response> health_check
+
+Health check
+
+Return the service health status, current timestamp, and version.
+
+### 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::SystemApi.new
+
+begin
+  # Health check
+  result = api_instance.health_check
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling SystemApi->health_check: #{e}"
+end
+```
+
+#### Using the health_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthCheck200Response>, Integer, Hash)> health_check_with_http_info
+
+```ruby
+begin
+  # Health check
+  data, status_code, headers = api_instance.health_check_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthCheck200Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling SystemApi->health_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthCheck200Response**](HealthCheck200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TestOrgWebhook200Response.md

@@ -0,0 +1,18 @@
+# Zippendo::TestOrgWebhook200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Result message |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::TestOrgWebhook200Response.new(
+  message: Test event sent
+)
+```
+

data/docs/TokensApi.md

@@ -0,0 +1,443 @@
+# Zippendo::TokensApi
+
+All URIs are relative to *https://api.zippendo.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_api_token**](TokensApi.md#create_api_token) | **POST** /orgs/{orgId}/api-tokens | Create API keys |
+| [**get_api_token**](TokensApi.md#get_api_token) | **GET** /orgs/{orgId}/api-tokens/{tokenId} | Get API keys |
+| [**list_api_tokens**](TokensApi.md#list_api_tokens) | **GET** /orgs/{orgId}/api-tokens | List API keys |
+| [**revoke_api_token**](TokensApi.md#revoke_api_token) | **DELETE** /orgs/{orgId}/api-tokens/{tokenId} | Revoke API keys |
+| [**update_api_token**](TokensApi.md#update_api_token) | **PATCH** /orgs/{orgId}/api-tokens/{tokenId} | Update API keys |
+| [**verify_api_token**](TokensApi.md#verify_api_token) | **POST** /api-tokens/verify | Verify API keys |
+
+
+## create_api_token
+
+> <CreateApiToken201Response> create_api_token(org_id, create_api_token_request)
+
+Create API keys
+
+Creates a new API token for the specified organization. The full token is only shown once.
+
+### 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::TokensApi.new
+org_id = 'org_4d8af01qw2' # String | Organization ID
+create_api_token_request = Zippendo::CreateApiTokenRequest.new({name: 'Warehouse integration', scopes: ["read: shipments", "write: shipments"]}) # CreateApiTokenRequest | 
+
+begin
+  # Create API keys
+  result = api_instance.create_api_token(org_id, create_api_token_request)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->create_api_token: #{e}"
+end
+```
+
+#### Using the create_api_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateApiToken201Response>, Integer, Hash)> create_api_token_with_http_info(org_id, create_api_token_request)
+
+```ruby
+begin
+  # Create API keys
+  data, status_code, headers = api_instance.create_api_token_with_http_info(org_id, create_api_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateApiToken201Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->create_api_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **create_api_token_request** | [**CreateApiTokenRequest**](CreateApiTokenRequest.md) |  |  |
+
+### Return type
+
+[**CreateApiToken201Response**](CreateApiToken201Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_api_token
+
+> <ListApiTokens200ResponseDataInner> get_api_token(org_id, token_id)
+
+Get API keys
+
+Returns metadata for a specific API token. The token secret is never returned.
+
+### 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::TokensApi.new
+org_id = 'org_4d8af01qw2' # String | Organization ID
+token_id = 'tok_6e2fa83ij9' # String | API Token ID
+
+begin
+  # Get API keys
+  result = api_instance.get_api_token(org_id, token_id)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->get_api_token: #{e}"
+end
+```
+
+#### Using the get_api_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListApiTokens200ResponseDataInner>, Integer, Hash)> get_api_token_with_http_info(org_id, token_id)
+
+```ruby
+begin
+  # Get API keys
+  data, status_code, headers = api_instance.get_api_token_with_http_info(org_id, token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListApiTokens200ResponseDataInner>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->get_api_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **token_id** | **String** | API Token ID |  |
+
+### Return type
+
+[**ListApiTokens200ResponseDataInner**](ListApiTokens200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_api_tokens
+
+> <ListApiTokens200Response> list_api_tokens(org_id, opts)
+
+List API keys
+
+Returns a paginated list of API tokens belonging to the specified 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::TokensApi.new
+org_id = 'org_4d8af01qw2' # String | Organization ID
+opts = {
+  page: 1, # Integer | Page number (1-based)
+  limit: 20 # Integer | Items per page (max 100)
+}
+
+begin
+  # List API keys
+  result = api_instance.list_api_tokens(org_id, opts)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->list_api_tokens: #{e}"
+end
+```
+
+#### Using the list_api_tokens_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListApiTokens200Response>, Integer, Hash)> list_api_tokens_with_http_info(org_id, opts)
+
+```ruby
+begin
+  # List API keys
+  data, status_code, headers = api_instance.list_api_tokens_with_http_info(org_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListApiTokens200Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->list_api_tokens_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] |
+
+### Return type
+
+[**ListApiTokens200Response**](ListApiTokens200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revoke_api_token
+
+> <RevokeApiToken200Response> revoke_api_token(org_id, token_id)
+
+Revoke API keys
+
+Revokes and deletes an API token.
+
+### 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::TokensApi.new
+org_id = 'org_4d8af01qw2' # String | Organization ID
+token_id = 'tok_6e2fa83ij9' # String | API Token ID
+
+begin
+  # Revoke API keys
+  result = api_instance.revoke_api_token(org_id, token_id)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->revoke_api_token: #{e}"
+end
+```
+
+#### Using the revoke_api_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RevokeApiToken200Response>, Integer, Hash)> revoke_api_token_with_http_info(org_id, token_id)
+
+```ruby
+begin
+  # Revoke API keys
+  data, status_code, headers = api_instance.revoke_api_token_with_http_info(org_id, token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RevokeApiToken200Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->revoke_api_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **token_id** | **String** | API Token ID |  |
+
+### Return type
+
+[**RevokeApiToken200Response**](RevokeApiToken200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_api_token
+
+> <ListApiTokens200ResponseDataInner> update_api_token(org_id, token_id, update_api_token_request)
+
+Update API keys
+
+Updates the name of an API token.
+
+### 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::TokensApi.new
+org_id = 'org_4d8af01qw2' # String | Organization ID
+token_id = 'tok_6e2fa83ij9' # String | API Token ID
+update_api_token_request = Zippendo::UpdateApiTokenRequest.new({name: 'Warehouse integration'}) # UpdateApiTokenRequest | 
+
+begin
+  # Update API keys
+  result = api_instance.update_api_token(org_id, token_id, update_api_token_request)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->update_api_token: #{e}"
+end
+```
+
+#### Using the update_api_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListApiTokens200ResponseDataInner>, Integer, Hash)> update_api_token_with_http_info(org_id, token_id, update_api_token_request)
+
+```ruby
+begin
+  # Update API keys
+  data, status_code, headers = api_instance.update_api_token_with_http_info(org_id, token_id, update_api_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListApiTokens200ResponseDataInner>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->update_api_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **org_id** | **String** | Organization ID |  |
+| **token_id** | **String** | API Token ID |  |
+| **update_api_token_request** | [**UpdateApiTokenRequest**](UpdateApiTokenRequest.md) |  |  |
+
+### Return type
+
+[**ListApiTokens200ResponseDataInner**](ListApiTokens200ResponseDataInner.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_api_token
+
+> <VerifyApiToken200Response> verify_api_token(verify_api_token_request)
+
+Verify API keys
+
+Verifies whether an API token is valid and returns its metadata.
+
+### 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::TokensApi.new
+verify_api_token_request = Zippendo::VerifyApiTokenRequest.new({token: 'zipp_live_8f3kd92ld0a7b6c5d4e3f2a1'}) # VerifyApiTokenRequest | 
+
+begin
+  # Verify API keys
+  result = api_instance.verify_api_token(verify_api_token_request)
+  p result
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->verify_api_token: #{e}"
+end
+```
+
+#### Using the verify_api_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyApiToken200Response>, Integer, Hash)> verify_api_token_with_http_info(verify_api_token_request)
+
+```ruby
+begin
+  # Verify API keys
+  data, status_code, headers = api_instance.verify_api_token_with_http_info(verify_api_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyApiToken200Response>
+rescue Zippendo::ApiError => e
+  puts "Error when calling TokensApi->verify_api_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_api_token_request** | [**VerifyApiTokenRequest**](VerifyApiTokenRequest.md) |  |  |
+
+### Return type
+
+[**VerifyApiToken200Response**](VerifyApiToken200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TrackShipment200Response.md

@@ -0,0 +1,26 @@
+# Zippendo::TrackShipment200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tracking_number** | **String** | Carrier tracking number. |  |
+| **tracking_url** | **String** | Public carrier tracking URL. |  |
+| **current_status** | **String** | Latest normalized tracking status. |  |
+| **estimated_delivery** | **String** | Estimated delivery timestamp. | [optional] |
+| **events** | [**Array<TrackShipment200ResponseEventsInner>**](TrackShipment200ResponseEventsInner.md) | Tracking events ordered from newest to oldest. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::TrackShipment200Response.new(
+  tracking_number: 00370724710000012345,
+  tracking_url: https://tracking.postnord.com/00370724710000012345,
+  current_status: delivered,
+  estimated_delivery: 2026-06-23T12:00:00.000Z,
+  events: null
+)
+```
+

data/docs/TrackShipment200ResponseEventsInner.md

@@ -0,0 +1,28 @@
+# Zippendo::TrackShipment200ResponseEventsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique tracking event identifier. |  |
+| **status** | **String** | Normalized tracking status for the event. |  |
+| **carrier_status** | **String** | Raw status string reported by the carrier. |  |
+| **description** | **String** | Human-readable description of the event. |  |
+| **location** | **String** | Location where the event was registered. |  |
+| **occurred_at** | **String** | Timestamp when the event occurred. |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::TrackShipment200ResponseEventsInner.new(
+  id: trk_7a8b9c0d,
+  status: in_transit,
+  carrier_status: INFORMED,
+  description: The shipment is on its way.,
+  location: København,
+  occurred_at: 2026-06-22T14:30:00.000Z
+)
+```
+