zippendo 1.0.0

data/docs/UpdateAddressRequest.md

@@ -0,0 +1,40 @@
+# Zippendo::UpdateAddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the address | [optional] |
+| **att_contact** | **String** | Attention contact person | [optional] |
+| **address1** | **String** | Address line 1 | [optional] |
+| **address2** | **String** | Address line 2 | [optional] |
+| **zipcode** | **String** | Postal/ZIP code | [optional] |
+| **city** | **String** | City | [optional] |
+| **phone** | **String** | Phone number | [optional] |
+| **country_code** | **String** | ISO country code | [optional] |
+| **state** | **String** | State/Province | [optional] |
+| **email** | **String** | Email address | [optional] |
+| **customs** | **Hash<String, String>** | Customs identifiers | [optional] |
+| **address_types** | **Array<String>** | Address types (sender, pickup, return) | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateAddressRequest.new(
+  name: Hovedlager,
+  att_contact: Mette Hansen,
+  address1: Vesterbrogade 1,
+  address2: 2. sal,
+  zipcode: 1620,
+  city: København,
+  phone: +4533123456,
+  country_code: DK,
+  state: Hovedstaden,
+  email: lager@example.dk,
+  customs: {"eori":"DK12345678"},
+  address_types: ["sender"]
+)
+```
+

data/docs/UpdateApiTokenRequest.md

@@ -0,0 +1,18 @@
+# Zippendo::UpdateApiTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | New token name |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateApiTokenRequest.new(
+  name: Warehouse integration
+)
+```
+

data/docs/UpdateCarrierRequest.md

@@ -0,0 +1,22 @@
+# Zippendo::UpdateCarrierRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Carrier display name | [optional] |
+| **carrier_slug** | **String** | Carrier slug identifier | [optional] |
+| **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateCarrierRequest.new(
+  name: GLS,
+  carrier_slug: gls,
+  config: {"customerNumber":"123456"}
+)
+```
+

data/docs/UpdateOrderRequest.md

@@ -0,0 +1,38 @@
+# Zippendo::UpdateOrderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_number** | **String** | Human-readable order number. | [optional] |
+| **customer_name** | **String** | Customer full name. | [optional] |
+| **customer_email** | **String** | Customer email address. | [optional] |
+| **shipping_address** | [**CreateOrderRequestShippingAddress**](CreateOrderRequestShippingAddress.md) |  | [optional] |
+| **order_lines** | [**Array<CreateOrderRequestOrderLinesInner>**](CreateOrderRequestOrderLinesInner.md) | Line items in the order. | [optional] |
+| **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
+| **total_amount** | **Float** | Order grand total. | [optional] |
+| **currency** | **String** | ISO 4217 currency code. | [optional] |
+| **notes** | **String** | Free-form internal notes. | [optional] |
+| **status** | **String** | Order fulfilment status derived from its shipments. | [optional] |
+| **shipping_rule_id** | **String** | ID of the shipping rule to apply. | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateOrderRequest.new(
+  order_number: #1042,
+  customer_name: Anna Jensen,
+  customer_email: anna@example.dk,
+  shipping_address: null,
+  order_lines: null,
+  subtotal_amount: 998,
+  total_amount: 1047,
+  currency: DKK,
+  notes: Leave at front desk,
+  status: processing,
+  shipping_rule_id: clz9k2f0a0002abcd5678ijkl
+)
+```
+

data/docs/UpdateOrg200Response.md

@@ -0,0 +1,48 @@
+# Zippendo::UpdateOrg200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique organization identifier |  |
+| **name** | **String** | Organization name |  |
+| **slug** | **String** | Organization URL slug (unique identifier) |  |
+| **description** | **String** | Organization description |  |
+| **currency** | **String** | Billing currency (ISO 4217 code) | [default to 'DKK'] |
+| **vat_number** | **String** | Company VAT/tax ID for invoices | [optional] |
+| **billing_email** | **String** | Billing email for invoices | [optional] |
+| **company_name** | **String** | Legal company name | [optional] |
+| **address_line1** | **String** | Address line 1 | [optional] |
+| **address_line2** | **String** | Address line 2 | [optional] |
+| **city** | **String** | City | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **country** | **String** | Country (ISO 3166-1 alpha-2 code) | [optional] |
+| **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
+| **created_at** | **String** | Creation timestamp (ISO 8601) |  |
+| **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateOrg200Response.new(
+  id: org_4d8af01qw2,
+  name: Nordic Logistics ApS,
+  slug: nordic-logistics,
+  description: Parcel and freight logistics across the Nordics,
+  currency: DKK,
+  vat_number: DK12345678,
+  billing_email: billing@nordic-logistics.dk,
+  company_name: Nordic Logistics ApS,
+  address_line1: Havnegade 12,
+  address_line2: 3. sal,
+  city: København,
+  postal_code: 1058,
+  country: DK,
+  customs: {"eori":"DK12345678"},
+  created_at: 2026-06-22T14:30:00.000Z,
+  updated_at: 2026-06-22T14:30:00.000Z
+)
+```
+

data/docs/UpdateOrgBrandingRequest.md

@@ -0,0 +1,20 @@
+# Zippendo::UpdateOrgBrandingRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_color** | **String** | Primary brand color (hex) — tints the document title and table headers | [optional] |
+| **secondary_color** | **String** | Secondary brand color (hex) — tints the subtitle, section headings, and totals accent | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateOrgBrandingRequest.new(
+  primary_color: #1D4ED8,
+  secondary_color: #F59E0B
+)
+```
+

data/docs/UpdateOrgRequest.md

@@ -0,0 +1,44 @@
+# Zippendo::UpdateOrgRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Organization name | [optional] |
+| **slug** | **String** | Organization slug | [optional] |
+| **description** | **String** | Organization description | [optional] |
+| **currency** | **String** | Billing currency (ISO 4217 code) | [optional] |
+| **vat_number** | **String** | Company VAT/tax ID for invoices | [optional] |
+| **overage_enabled** | **Boolean** | Allow shipments beyond plan limit (overage charges apply) | [optional] |
+| **billing_email** | **String** | Billing email for invoices | [optional] |
+| **company_name** | **String** | Legal company name | [optional] |
+| **address_line1** | **String** | Address line 1 | [optional] |
+| **address_line2** | **String** | Address line 2 | [optional] |
+| **city** | **String** | City | [optional] |
+| **postal_code** | **String** | Postal code | [optional] |
+| **country** | **String** | Country (ISO 3166-1 alpha-2 code) | [optional] |
+| **customs** | **Hash<String, String>** | Organization-wide customs identifiers (EORI, IOSS, VOEC, etc.); null clears all | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateOrgRequest.new(
+  name: Nordic Logistics ApS,
+  slug: nordic-logistics,
+  description: Parcel and freight logistics across the Nordics,
+  currency: DKK,
+  vat_number: DK12345678,
+  overage_enabled: false,
+  billing_email: billing@nordic-logistics.dk,
+  company_name: Nordic Logistics ApS,
+  address_line1: Havnegade 12,
+  address_line2: 3. sal,
+  city: København,
+  postal_code: 1058,
+  country: DK,
+  customs: null
+)
+```
+

data/docs/UpdateOrgWebhookRequest.md

@@ -0,0 +1,24 @@
+# Zippendo::UpdateOrgWebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Human-readable webhook name | [optional] |
+| **url** | **String** | Webhook endpoint URL | [optional] |
+| **events** | **Array<String>** | Events to subscribe to | [optional] |
+| **is_active** | **Boolean** | Whether the webhook is active | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateOrgWebhookRequest.new(
+  name: Order fulfilment notifier,
+  url: https://hooks.example.dk/zippendo,
+  events: ["shipment.created"],
+  is_active: true
+)
+```
+

data/docs/UpdateShipmentRequest.md

@@ -0,0 +1,44 @@
+# Zippendo::UpdateShipmentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference** | **String** | Customer-facing shipment reference. | [optional] |
+| **address_id** | **String** | Sender address identifier. | [optional] |
+| **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
+| **parties** | [**Array<CreateShipmentRequestPartiesInner>**](CreateShipmentRequestPartiesInner.md) | Parties involved in the shipment. Optional when orderId is provided. | [optional] |
+| **type** | **String** | Direction of the shipment relative to the organization. | [optional] |
+| **carrier_settings** | [**CreateShipmentRequestCarrierSettings**](CreateShipmentRequestCarrierSettings.md) |  | [optional] |
+| **parcels** | [**Array<CreateShipmentRequestParcelsInner>**](CreateShipmentRequestParcelsInner.md) | Parcels to include. Optional when orderId is provided. | [optional] |
+| **pickup_details** | [**CreateShipmentRequestPickupDetails**](CreateShipmentRequestPickupDetails.md) |  | [optional] |
+| **term_of_trade** | **String** | Incoterm governing the shipment. | [optional][default to 'DAP'] |
+| **status** | **String** | Lifecycle status of the shipment. | [optional][default to 'pending'] |
+| **order_id** | **String** | Order to derive parties and parcels from. | [optional] |
+| **label_printer_id** | **String** | Printer to assign for labels. | [optional] |
+| **document_printer_id** | **String** | Printer to assign for documents. | [optional] |
+| **shipping_rule_id** | **String** | Shipping rule to apply to the shipment. Pass null to clear. | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateShipmentRequest.new(
+  reference: ORDER-1042,
+  address_id: addr_7e8f9a0b,
+  service_point_id: sp_pn_4521,
+  parties: null,
+  type: outbound,
+  carrier_settings: null,
+  parcels: null,
+  pickup_details: null,
+  term_of_trade: DAP,
+  status: pending,
+  order_id: ord_5e6f7a8b,
+  label_printer_id: prn_label_01,
+  document_printer_id: prn_doc_01,
+  shipping_rule_id: rule_3c4d5e6f
+)
+```
+

data/docs/UpdateShippingRuleRequest.md

@@ -0,0 +1,66 @@
+# Zippendo::UpdateShippingRuleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Shipping rule name | [optional] |
+| **description** | **String** | Optional description | [optional] |
+| **direction** | **String** | Whether this rule is for outbound or inbound (return) shipments | [optional][default to 'outbound'] |
+| **carrier_id** | **String** | Carrier ID | [optional] |
+| **product_id** | **String** | Product ID from carrier | [optional] |
+| **services** | **Array<String>** | List of selected services | [optional] |
+| **additional_parameters** | [**CreateShippingRuleRequestAdditionalParameters**](CreateShippingRuleRequestAdditionalParameters.md) |  | [optional] |
+| **address_id** | **String** | Sender address ID | [optional] |
+| **receiving_countries** | **Array<String>** | List of supported country codes | [optional] |
+| **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
+| **phone_notification** | **Boolean** | Send SMS notification to recipient | [optional][default to false] |
+| **min_weight** | **Float** | Minimum required weight in kg | [optional] |
+| **max_weight** | **Float** | Maximum allowed weight in kg | [optional] |
+| **min_order_value** | **Float** | Minimum required order value in currency units | [optional] |
+| **max_order_value** | **Float** | Maximum allowed order value in currency units | [optional] |
+| **conditions** | [**Array<CreateShippingRuleRequestConditionsInner>**](CreateShippingRuleRequestConditionsInner.md) | Rule conditions (weight/price/quantity) | [optional] |
+| **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [optional][default to false] |
+| **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [optional][default to false] |
+| **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [optional][default to false] |
+| **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [optional][default to false] |
+| **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [optional][default to false] |
+| **label_printer_id** | **String** | ID of the label printer | [optional] |
+| **document_printer_id** | **String** | ID of the document printer | [optional] |
+| **return_shipping_rule_id** | **String** | ID of the return shipping rule | [optional] |
+| **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::UpdateShippingRuleRequest.new(
+  name: Standard DK,
+  description: Standard levering i Danmark,
+  direction: outbound,
+  carrier_id: carr_01HZX9K2QF,
+  product_id: PNL13,
+  services: ["EMAIL_NOTIFICATION"],
+  additional_parameters: null,
+  address_id: addr_01HZX9K2QF,
+  receiving_countries: ["DK","SE"],
+  email_notification: true,
+  phone_notification: false,
+  min_weight: 0,
+  max_weight: 20,
+  min_order_value: 0,
+  max_order_value: 5000,
+  conditions: [{"type":"flatRate","shippingPrice":39,"currency":"DKK"}],
+  generate_proforma_invoice: false,
+  generate_commercial_invoice: false,
+  generate_packing_list: false,
+  auto_print_labels: false,
+  auto_print_documents: false,
+  label_printer_id: null,
+  document_printer_id: null,
+  return_shipping_rule_id: null,
+  auto_create_return_shipment: false
+)
+```
+

data/docs/VerifyApiToken200Response.md

@@ -0,0 +1,28 @@
+# Zippendo::VerifyApiToken200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | Whether the token is valid |  |
+| **token_id** | **String** | Token identifier | [optional] |
+| **user_id** | **String** | User identifier the token belongs to | [optional] |
+| **org_id** | **String** | Organization identifier the token belongs to | [optional] |
+| **scopes** | **Array<String>** | Permission scopes granted by the token | [optional] |
+| **expires_at** | **String** | Expiry timestamp (ISO 8601), null if it never expires | [optional] |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::VerifyApiToken200Response.new(
+  valid: true,
+  token_id: tok_6e2fa83ij9,
+  user_id: usr_9f3kd92ld0,
+  org_id: org_4d8af01qw2,
+  scopes: ["read:shipments"],
+  expires_at: 2026-09-20T14:30:00.000Z
+)
+```
+

data/docs/VerifyApiTokenRequest.md

@@ -0,0 +1,18 @@
+# Zippendo::VerifyApiTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The API token to verify |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::VerifyApiTokenRequest.new(
+  token: zipp_live_8f3kd92ld0a7b6c5d4e3f2a1
+)
+```
+