zippendo 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9082f54412379a1ec68798c7f6c703400efd5f6e87e828c7d43f55c877172de
-  data.tar.gz: c1df4fb00fb2e26fe87e963b19136b5031ce6934027b191a33d5224de1b7e35f
+  metadata.gz: bae775bf1a1ae7660b693ca59ba5fc02b8a7d1c4c29b56fde73d294ae0f1cb38
+  data.tar.gz: 8e939ec19a2cd78b0f7136abe4a8de1a13e715e510a78cb22cc8fb2a3264960b
 SHA512:
-  metadata.gz: 543e14101135ef460dbb326da2fe41a7251d5cd311b4ecddb199617155f719ee0304001ae6d34c59a1693c7415dd7e3f38ef89d4cec9e786517b19bee224b281
-  data.tar.gz: d5ee65224640d264251382e3c6b991a7ef762f8b5a3baa871b55cdc46a145f7583c1774c182c000b6fab158c569c5d5e7e800df1a649b65d7e077f767f8e98a4
+  metadata.gz: 1ea90cdc79f094275431f7179c16013682ad5388d29b5ede0b00bd242bae3d40274857fd745308f6deed11be28398f32c0f5f0654d8b4e73f2043c5a2277f2c5
+  data.tar.gz: 2384357611670e6188f32ee9343d82aa65ab7696c623d026548217ddd5520a07f21e47db130304583f9d2835d0f743eeca80f40b2c96b47ea24f4e88939140ae

data/README.md

@@ -76,6 +76,17 @@ A token created with a `brand_id` (see `CreateApiTokenRequest`) is permanently c
 needs no header. Sending `X-Zippendo-Brand` naming a *different* brand on such a token is refused with
 `403 BRAND_ACCESS_DENIED` — the binding is never widened.
 
+List operations also take a `brand_scope` query parameter (`"own"` / `"shared"` / `"both"`) to narrow
+further within whichever brand context already applies: `"own"` returns only that brand's rows and needs
+a brand context (otherwise `400`); `"shared"` returns only the unassigned rows (equivalent to
+`brand_id=none`). Set `X-Zippendo-Brand-Scope` as a default header the same way to cover every call:
+
+```ruby
+Zippendo::ApiClient.default.default_headers["X-Zippendo-Brand-Scope"] = "own"
+```
+
+An explicit `brand_scope` parameter passed to a call still wins over the header.
+
 ### Managing brands
 
 Brands are managed with `BrandsApi`. Use an organization-wide client for this — you are administering

data/docs/AddressesApi.md

@@ -248,7 +248,9 @@ 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)
+  type: 'sender', # String | Filter by address type (sender, pickup, return)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -286,6 +288,8 @@ end
 | **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] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/CarriersApi.md

@@ -395,7 +395,9 @@ api_instance = Zippendo::CarriersApi.new
 org_id = 'org_01HZX9K2QF' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
-  limit: 20 # Integer | Items per page (max 100)
+  limit: 20, # Integer | Items per page (max 100)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -432,6 +434,8 @@ end
 | **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] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/ConnectCarrierRequest.md

@@ -7,6 +7,7 @@
 | **name** | **String** | Carrier display name |  |
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zippendo'
 instance = Zippendo::ConnectCarrierRequest.new(
   name: PostNord,
   carrier_slug: postnord,
-  config: {"customerNumber":"123456"}
+  config: {"customerNumber":"123456"},
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateAddressRequest.md

@@ -16,6 +16,7 @@
 | **email** | **String** | Email address |  |
 | **customs** | **Hash<String, String>** | Customs identifiers (voec, eori, sprn, ioss, fda, duns) | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) | [optional] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -34,7 +35,8 @@ instance = Zippendo::CreateAddressRequest.new(
   state: ,
   email: lager@example.dk,
   customs: {"eori":"DK12345678"},
-  address_types: ["sender"]
+  address_types: ["sender"],
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateOrgWebhook201Response.md

@@ -10,6 +10,7 @@
 | **secret** | **String** | Signing secret used to verify webhook payloads |  |
 | **events** | **Array<String>** | Events the webhook is subscribed to |  |
 | **is_active** | **Boolean** | Whether the webhook is active |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -25,6 +26,7 @@ instance = Zippendo::CreateOrgWebhook201Response.new(
   secret: whsec_8f3a1c2b9d4e5f6a,
   events: ["shipment.created"],
   is_active: true,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-01T09:30:00.000Z,
   updated_at: 2026-06-10T11:15:00.000Z
 )

data/docs/CreateOrgWebhookRequest.md

@@ -8,6 +8,7 @@
 | **url** | **String** | Webhook endpoint URL |  |
 | **events** | **Array<String>** | Events to subscribe to |  |
 | **is_active** | **Boolean** | Whether the webhook is active | [optional][default to true] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = Zippendo::CreateOrgWebhookRequest.new(
   name: Order fulfilment notifier,
   url: https://hooks.example.dk/zippendo,
   events: ["shipment.created","tracking.updated"],
-  is_active: true
+  is_active: true,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/CreateShippingRule201Response.md

@@ -31,6 +31,7 @@
 | **return_shipping_rule_id** | **String** | ID of the return shipping rule |  |
 | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -67,6 +68,7 @@ instance = Zippendo::CreateShippingRule201Response.new(
   return_shipping_rule_id: null,
   auto_create_return_shipment: false,
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/CreateShippingRuleRequest.md

@@ -29,6 +29,7 @@
 | **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] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -60,7 +61,8 @@ instance = Zippendo::CreateShippingRuleRequest.new(
   label_printer_id: null,
   document_printer_id: null,
   return_shipping_rule_id: null,
-  auto_create_return_shipment: false
+  auto_create_return_shipment: false,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/GetBillingUsage200Response.md

@@ -8,6 +8,7 @@
 | **shipments** | [**GetBillingUsage200ResponseShipments**](GetBillingUsage200ResponseShipments.md) |  |  |
 | **limits** | [**GetBillingUsage200ResponseLimits**](GetBillingUsage200ResponseLimits.md) |  |  |
 | **add_ons** | [**Array<GetBillingUsage200ResponseAddOnsInner>**](GetBillingUsage200ResponseAddOnsInner.md) | Active add-ons on the subscription |  |
+| **zippy_messages** | [**GetBillingUsage200ResponseZippyMessages**](GetBillingUsage200ResponseZippyMessages.md) |  | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = Zippendo::GetBillingUsage200Response.new(
   current_period: null,
   shipments: null,
   limits: null,
-  add_ons: []
+  add_ons: [],
+  zippy_messages: null
 )
 ```
 

data/docs/GetBillingUsage200ResponseZippyMessages.md

@@ -0,0 +1,20 @@
+# Zippendo::GetBillingUsage200ResponseZippyMessages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **used** | **Float** | Zippy messages used this period |  |
+| **charges** | **Float** | Zippy message charges so far, in øre |  |
+
+## Example
+
+```ruby
+require 'zippendo'
+
+instance = Zippendo::GetBillingUsage200ResponseZippyMessages.new(
+  used: 42,
+  charges: 4158
+)
+```
+

data/docs/ListAddresses200ResponseDataInner.md

@@ -18,6 +18,7 @@
 | **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -41,6 +42,7 @@ instance = Zippendo::ListAddresses200ResponseDataInner.new(
   customs: {"eori":"DK12345678"},
   address_types: ["sender"],
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/ListCarriers200ResponseDataInner.md

@@ -9,6 +9,7 @@
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 | **logo** | **String** | Carrier logo URL | [optional] |
@@ -27,6 +28,7 @@ instance = Zippendo::ListCarriers200ResponseDataInner.new(
   carrier_slug: postnord,
   config: {"customerNumber":"123456"},
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z,
   logo: https://cdn.zippendo.com/logos/postnord.svg,

data/docs/ListOrgWebhooks200ResponseDataInner.md

@@ -9,6 +9,7 @@
 | **url** | **String** | Webhook endpoint URL |  |
 | **events** | **Array<String>** | Events the webhook is subscribed to |  |
 | **is_active** | **Boolean** | Whether the webhook is active |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -23,6 +24,7 @@ instance = Zippendo::ListOrgWebhooks200ResponseDataInner.new(
   url: https://hooks.example.dk/zippendo,
   events: ["shipment.created"],
   is_active: true,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-01T09:30:00.000Z,
   updated_at: 2026-06-10T11:15:00.000Z
 )

data/docs/ListShipments200ResponseDataInnerAddress.md

@@ -18,6 +18,7 @@
 | **customs** | **Hash<String, String>** | Customs identifiers keyed by type | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -41,6 +42,7 @@ instance = Zippendo::ListShipments200ResponseDataInnerAddress.new(
   customs: {"eori":"DK12345678"},
   address_types: ["sender"],
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/ListShippingRules200ResponseDataInner.md

@@ -31,6 +31,7 @@
 | **return_shipping_rule_id** | **String** | ID of the return shipping rule |  |
 | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 | **carrier** | [**ListShippingRules200ResponseDataInnerCarrier**](ListShippingRules200ResponseDataInnerCarrier.md) |  |  |
@@ -72,6 +73,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInner.new(
   return_shipping_rule_id: null,
   auto_create_return_shipment: false,
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z,
   carrier: null,

data/docs/ListShippingRules200ResponseDataInnerCarrier.md

@@ -9,6 +9,7 @@
 | **carrier_slug** | **String** | Carrier slug identifier |  |
 | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) |  |
 | **org_id** | **String** | Owning organization ID |  |
+| **brand_id** | **String** | Brand this record belongs to, or null when it is organization-wide |  |
 | **created_at** | **String** | Creation timestamp (ISO 8601) |  |
 | **updated_at** | **String** | Last update timestamp (ISO 8601) |  |
 
@@ -23,6 +24,7 @@ instance = Zippendo::ListShippingRules200ResponseDataInnerCarrier.new(
   carrier_slug: postnord,
   config: {"customerNumber":"123456"},
   org_id: org_01HZX9K2QF,
+  brand_id: brnd_8f3kd92ld0,
   created_at: 2026-06-22T09:00:00.000Z,
   updated_at: 2026-06-22T09:00:00.000Z
 )

data/docs/OrdersApi.md

@@ -249,6 +249,7 @@ opts = {
   page: 1, # Integer | Page number (1-based)
   limit: 20, # Integer | Items per page (max 100)
   brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
   status: 'pending', # String | Order fulfilment status derived from its shipments.
   order_channel_id: 'clz9k2f0a0001abcd1234efgh', # String | Filter by order channel ID.
   search: 'Anna' # String | Search by order number or customer name/email.
@@ -289,6 +290,7 @@ end
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
 | **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 | **status** | **String** | Order fulfilment status derived from its shipments. | [optional] |
 | **order_channel_id** | **String** | Filter by order channel ID. | [optional] |
 | **search** | **String** | Search by order number or customer name/email. | [optional] |

data/docs/RulesApi.md

@@ -247,7 +247,9 @@ api_instance = Zippendo::RulesApi.new
 org_id = 'org_01HZX9K2QF' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
-  limit: 20 # Integer | Items per page (max 100)
+  limit: 20, # Integer | Items per page (max 100)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -284,6 +286,8 @@ end
 | **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] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/ShipmentsApi.md

@@ -549,7 +549,8 @@ org_id = 'org_8f3kd92ld0' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
   limit: 20, # Integer | Items per page (max 100)
-  brand_id: 'brnd_8f3kd92ld0' # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -587,6 +588,7 @@ end
 | **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
 | **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
 | **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/docs/UpdateAddressRequest.md

@@ -16,6 +16,7 @@
 | **email** | **String** | Email address | [optional] |
 | **customs** | **Hash<String, String>** | Customs identifiers | [optional] |
 | **address_types** | **Array<String>** | Address types (sender, pickup, return) | [optional] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -34,7 +35,8 @@ instance = Zippendo::UpdateAddressRequest.new(
   state: Hovedstaden,
   email: lager@example.dk,
   customs: {"eori":"DK12345678"},
-  address_types: ["sender"]
+  address_types: ["sender"],
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/UpdateCarrierRequest.md

@@ -7,6 +7,7 @@
 | **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] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zippendo'
 instance = Zippendo::UpdateCarrierRequest.new(
   name: GLS,
   carrier_slug: gls,
-  config: {"customerNumber":"123456"}
+  config: {"customerNumber":"123456"},
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/UpdateOrgWebhookRequest.md

@@ -8,6 +8,7 @@
 | **url** | **String** | Webhook endpoint URL | [optional] |
 | **events** | **Array<String>** | Events to subscribe to | [optional] |
 | **is_active** | **Boolean** | Whether the webhook is active | [optional] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -18,7 +19,8 @@ instance = Zippendo::UpdateOrgWebhookRequest.new(
   name: Order fulfilment notifier,
   url: https://hooks.example.dk/zippendo,
   events: ["shipment.created"],
-  is_active: true
+  is_active: true,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/UpdateShippingRuleRequest.md

@@ -29,6 +29,7 @@
 | **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] |
+| **brand_id** | **String** | Brand this record is assigned to; null (or omitted outside a brand session) keeps it organization-wide | [optional] |
 
 ## Example
 
@@ -60,7 +61,8 @@ instance = Zippendo::UpdateShippingRuleRequest.new(
   label_printer_id: null,
   document_printer_id: null,
   return_shipping_rule_id: null,
-  auto_create_return_shipment: false
+  auto_create_return_shipment: false,
+  brand_id: brnd_8f3kd92ld0
 )
 ```
 

data/docs/WebhooksApi.md

@@ -326,7 +326,9 @@ api_instance = Zippendo::WebhooksApi.new
 org_id = 'org_8f3kd92ld0' # String | Organization ID
 opts = {
   page: 1, # Integer | Page number (1-based)
-  limit: 20 # Integer | Items per page (max 100)
+  limit: 20, # Integer | Items per page (max 100)
+  brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+  brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
 }
 
 begin
@@ -363,6 +365,8 @@ end
 | **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] |
+| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
+| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
 
 ### Return type
 

data/lib/zippendo/api/addresses_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Zippendo Public API
 
-#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@zippendo.com
@@ -238,6 +238,8 @@ module Zippendo
     # @option opts [Integer] :page Page number (1-based) (default to 1)
     # @option opts [Integer] :limit Items per page (max 100) (default to 20)
     # @option opts [String] :type Filter by address type (sender, pickup, return)
+    # @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+    # @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
     # @return [ListAddresses200Response]
     def list_addresses(org_id, opts = {})
       data, _status_code, _headers = list_addresses_with_http_info(org_id, opts)
@@ -251,6 +253,8 @@ module Zippendo
     # @option opts [Integer] :page Page number (1-based) (default to 1)
     # @option opts [Integer] :limit Items per page (max 100) (default to 20)
     # @option opts [String] :type Filter by address type (sender, pickup, return)
+    # @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
+    # @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
     # @return [Array<(ListAddresses200Response, Integer, Hash)>] ListAddresses200Response data, response status code and response headers
     def list_addresses_with_http_info(org_id, opts = {})
       if @api_client.config.debugging
@@ -280,6 +284,10 @@ module Zippendo
       if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
         fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
       end
+      allowable_values = ["own", "shared", "both"]
+      if @api_client.config.client_side_validation && opts[:'brand_scope'] && !allowable_values.include?(opts[:'brand_scope'])
+        fail ArgumentError, "invalid value for \"brand_scope\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/orgs/{orgId}/addresses'.sub('{orgId}', CGI.escape(org_id.to_s))
 
@@ -288,6 +296,8 @@ module Zippendo
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
+      query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/zippendo/api/billing_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Zippendo Public API
 
-#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@zippendo.com

data/lib/zippendo/api/brands_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Zippendo Public API
 
-#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@zippendo.com

data/lib/zippendo/api/carrier_catalog_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Zippendo Public API
 
-#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand's team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand's id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan's limit returns `403`.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@zippendo.com