zippendo 1.0.2 → 1.0.3

data/zippendo.gemspec

@@ -3,7 +3,7 @@
 =begin
 #Zippendo Public API
 
-#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+#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.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@zippendo.com
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@zippendo.com"]
   s.homepage    = "https://www.zippendo.com"
   s.summary     = "Zippendo Public API Ruby Gem"
-  s.description = "Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_)."
+  s.description = "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."
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
   s.metadata    = {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zippendo
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - OpenAPI-Generator
@@ -49,8 +49,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: Public API documentation for Zippendo. Authenticate using your API token
-  (Bearer token prefixed with zipp_).
+description: '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.'
 email:
 - support@zippendo.com
 executables: []