zippendo 1.0.3 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89004c22feaae9776f3b64cd51551222817536fafaecb179b57b6f99b5f3146c
-  data.tar.gz: befd3088c382beb5f5dbc62963e65a43f57d134365569294c68fc39633dea7d2
+  metadata.gz: a9082f54412379a1ec68798c7f6c703400efd5f6e87e828c7d43f55c877172de
+  data.tar.gz: c1df4fb00fb2e26fe87e963b19136b5031ce6934027b191a33d5224de1b7e35f
 SHA512:
-  metadata.gz: 46012679284ab5cfa81609d735c7c0ceddfc2d05e021b8fa18685d86e9a3d61b6decd6ba5acb58281cc395a76337aa29e19fa298164db555af902d90cb4fe90b
-  data.tar.gz: ea953db497979ae0692dba7028340ebcdae711102c1354ef5f85526ea00d9c9521a121b21663055adf85797dbc2eb35ad660dc2300ff85b0b149dfc5343be9e2
+  metadata.gz: 543e14101135ef460dbb326da2fe41a7251d5cd311b4ecddb199617155f719ee0304001ae6d34c59a1693c7415dd7e3f38ef89d4cec9e786517b19bee224b281
+  data.tar.gz: d5ee65224640d264251382e3c6b991a7ef762f8b5a3baa871b55cdc46a145f7583c1774c182c000b6fab158c569c5d5e7e800df1a649b65d7e077f767f8e98a4

data/README.md

@@ -43,7 +43,7 @@ which one the request acts on.
 ## Brands
 
 A brand is a sub-account inside your organization — one company running several consumer-facing labels
-(Pitaya, Kiwi) keeps each label's orders and shipments separate, with its own company name, address and
+(Acme, Globex) keeps each label's orders and shipments separate, with its own company name, address and
 logo on the documents its shipments produce. Any call can be scoped to one brand by sending the
 `X-Zippendo-Brand` header with the brand's ID or slug.
 
@@ -55,18 +55,18 @@ Zippendo.configure do |config|
   config.access_token = ENV["ZIPPENDO_API_TOKEN"]
 end
 
-Zippendo::ApiClient.default.default_headers["X-Zippendo-Brand"] = "pitaya"  # brand ID or slug
+Zippendo::ApiClient.default.default_headers["X-Zippendo-Brand"] = "acme"  # brand ID or slug
 
 shipments = Zippendo::ShipmentsApi.new
-shipments.list_shipments("org_8f3kd92ld0", limit: 50)   # Pitaya's shipments only
+shipments.list_shipments("org_8f3kd92ld0", limit: 50)   # Acme's shipments only
 ```
 
 To address two brands from one process, give each its own `ApiClient`:
 
 ```ruby
-kiwi = Zippendo::ApiClient.new
-kiwi.default_headers["X-Zippendo-Brand"] = "brnd_8f3kd92ld0"
-Zippendo::OrdersApi.new(kiwi).list_orders("org_8f3kd92ld0")
+globex = Zippendo::ApiClient.new
+globex.default_headers["X-Zippendo-Brand"] = "brnd_8f3kd92ld0"
+Zippendo::OrdersApi.new(globex).list_orders("org_8f3kd92ld0")
 ```
 
 Omit the header and the request covers the whole organization — the behaviour of every existing token.
@@ -76,8 +76,32 @@ 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.
 
-Creating, updating and deleting brands is done in the Zippendo dashboard; brand management is not part of
-this SDK.
+### Managing brands
+
+Brands are managed with `BrandsApi`. Use an organization-wide client for this — you are administering
+brands, not acting inside one:
+
+```ruby
+brands = Zippendo::BrandsApi.new
+
+created = brands.create_org_brand(
+  "org_8f3kd92ld0",
+  Zippendo::CreateOrgBrandRequest.new(name: "Acme", company_name: "Acme ApS")
+)
+
+page = brands.list_org_brands("org_8f3kd92ld0")
+brands.update_org_brand(
+  "org_8f3kd92ld0",
+  created.id,
+  Zippendo::UpdateOrgBrandRequest.new(vat_number: "DK12345678")
+)
+brands.archive_org_brand("org_8f3kd92ld0", created.id)
+```
+
+Retire a brand with `archive_org_brand` — archived brands keep their slug and can be restored with
+`unarchive_org_brand`. Permanent deletion is dashboard-only: it is refused while any order, shipment,
+member or token still references the brand. Brands require a plan that includes them; creating one past
+your plan's limit returns `403`.
 
 ## Listing & pagination
 

data/docs/BatchSplitShipmentRequest.md

@@ -9,7 +9,7 @@
 | **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] |
+| **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersValue>**](CreateShippingRuleRequestAdditionalParametersValue.md) | Carrier-specific parameters for all new shipments. Copied from the original if omitted. | [optional] |
 
 ## Example