@zippendo/sdk 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (828) hide show
  1. package/README.md +31 -7
  2. package/dist/apis/AddressesApi.d.ts +1 -1
  3. package/dist/apis/AddressesApi.js +1 -1
  4. package/dist/apis/BillingApi.d.ts +1 -1
  5. package/dist/apis/BillingApi.js +1 -1
  6. package/dist/apis/BrandsApi.d.ts +204 -0
  7. package/dist/apis/BrandsApi.js +584 -0
  8. package/dist/apis/CarrierCatalogApi.d.ts +1 -1
  9. package/dist/apis/CarrierCatalogApi.js +1 -1
  10. package/dist/apis/CarriersApi.d.ts +1 -1
  11. package/dist/apis/CarriersApi.js +1 -1
  12. package/dist/apis/OrdersApi.d.ts +1 -1
  13. package/dist/apis/OrdersApi.js +1 -1
  14. package/dist/apis/OrgsApi.d.ts +1 -1
  15. package/dist/apis/OrgsApi.js +1 -1
  16. package/dist/apis/QuotesApi.d.ts +1 -1
  17. package/dist/apis/QuotesApi.js +1 -1
  18. package/dist/apis/RulesApi.d.ts +1 -1
  19. package/dist/apis/RulesApi.js +1 -1
  20. package/dist/apis/ShipmentsApi.d.ts +1 -1
  21. package/dist/apis/ShipmentsApi.js +1 -1
  22. package/dist/apis/SystemApi.d.ts +1 -1
  23. package/dist/apis/SystemApi.js +1 -1
  24. package/dist/apis/TokensApi.d.ts +1 -1
  25. package/dist/apis/TokensApi.js +1 -1
  26. package/dist/apis/WebhooksApi.d.ts +1 -1
  27. package/dist/apis/WebhooksApi.js +1 -1
  28. package/dist/apis/index.d.ts +1 -0
  29. package/dist/apis/index.js +1 -0
  30. package/dist/esm/apis/AddressesApi.d.ts +1 -1
  31. package/dist/esm/apis/AddressesApi.js +1 -1
  32. package/dist/esm/apis/BillingApi.d.ts +1 -1
  33. package/dist/esm/apis/BillingApi.js +1 -1
  34. package/dist/esm/apis/BrandsApi.d.ts +204 -0
  35. package/dist/esm/apis/BrandsApi.js +580 -0
  36. package/dist/esm/apis/CarrierCatalogApi.d.ts +1 -1
  37. package/dist/esm/apis/CarrierCatalogApi.js +1 -1
  38. package/dist/esm/apis/CarriersApi.d.ts +1 -1
  39. package/dist/esm/apis/CarriersApi.js +1 -1
  40. package/dist/esm/apis/OrdersApi.d.ts +1 -1
  41. package/dist/esm/apis/OrdersApi.js +1 -1
  42. package/dist/esm/apis/OrgsApi.d.ts +1 -1
  43. package/dist/esm/apis/OrgsApi.js +1 -1
  44. package/dist/esm/apis/QuotesApi.d.ts +1 -1
  45. package/dist/esm/apis/QuotesApi.js +1 -1
  46. package/dist/esm/apis/RulesApi.d.ts +1 -1
  47. package/dist/esm/apis/RulesApi.js +1 -1
  48. package/dist/esm/apis/ShipmentsApi.d.ts +1 -1
  49. package/dist/esm/apis/ShipmentsApi.js +1 -1
  50. package/dist/esm/apis/SystemApi.d.ts +1 -1
  51. package/dist/esm/apis/SystemApi.js +1 -1
  52. package/dist/esm/apis/TokensApi.d.ts +1 -1
  53. package/dist/esm/apis/TokensApi.js +1 -1
  54. package/dist/esm/apis/WebhooksApi.d.ts +1 -1
  55. package/dist/esm/apis/WebhooksApi.js +1 -1
  56. package/dist/esm/apis/index.d.ts +1 -0
  57. package/dist/esm/apis/index.js +1 -0
  58. package/dist/esm/models/BatchSendShipments200Response.d.ts +1 -1
  59. package/dist/esm/models/BatchSendShipments200Response.js +1 -1
  60. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -1
  61. package/dist/esm/models/BatchSendShipments200ResponseResultsInner.js +1 -1
  62. package/dist/esm/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  63. package/dist/esm/models/BatchSendShipments200ResponseSummary.js +1 -1
  64. package/dist/esm/models/BatchSendShipmentsRequest.d.ts +1 -1
  65. package/dist/esm/models/BatchSendShipmentsRequest.js +1 -1
  66. package/dist/esm/models/BatchSplitShipment201Response.d.ts +1 -1
  67. package/dist/esm/models/BatchSplitShipment201Response.js +1 -1
  68. package/dist/esm/models/BatchSplitShipmentRequest.d.ts +1 -1
  69. package/dist/esm/models/BatchSplitShipmentRequest.js +1 -1
  70. package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
  71. package/dist/esm/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
  72. package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
  73. package/dist/esm/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
  74. package/dist/esm/models/CheckBrandSlug200Response.d.ts +38 -0
  75. package/dist/esm/models/CheckBrandSlug200Response.js +47 -0
  76. package/dist/esm/models/ConnectCarrierRequest.d.ts +1 -1
  77. package/dist/esm/models/ConnectCarrierRequest.js +1 -1
  78. package/dist/esm/models/CreateAddressRequest.d.ts +1 -1
  79. package/dist/esm/models/CreateAddressRequest.js +1 -1
  80. package/dist/esm/models/CreateApiToken201Response.d.ts +1 -1
  81. package/dist/esm/models/CreateApiToken201Response.js +1 -1
  82. package/dist/esm/models/CreateApiTokenRequest.d.ts +1 -1
  83. package/dist/esm/models/CreateApiTokenRequest.js +1 -1
  84. package/dist/esm/models/CreateOrder201Response.d.ts +1 -1
  85. package/dist/esm/models/CreateOrder201Response.js +1 -1
  86. package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
  87. package/dist/esm/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
  88. package/dist/esm/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
  89. package/dist/esm/models/CreateOrder201ResponseShippingAddress.js +1 -1
  90. package/dist/esm/models/CreateOrderRequest.d.ts +1 -1
  91. package/dist/esm/models/CreateOrderRequest.js +1 -1
  92. package/dist/esm/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
  93. package/dist/esm/models/CreateOrderRequestOrderLinesInner.js +1 -1
  94. package/dist/esm/models/CreateOrderRequestShippingAddress.d.ts +1 -1
  95. package/dist/esm/models/CreateOrderRequestShippingAddress.js +1 -1
  96. package/dist/esm/models/CreateOrgBrandRequest.d.ts +106 -0
  97. package/dist/esm/models/CreateOrgBrandRequest.js +67 -0
  98. package/dist/esm/models/CreateOrgWebhook201Response.d.ts +1 -1
  99. package/dist/esm/models/CreateOrgWebhook201Response.js +1 -1
  100. package/dist/esm/models/CreateOrgWebhookRequest.d.ts +1 -1
  101. package/dist/esm/models/CreateOrgWebhookRequest.js +1 -1
  102. package/dist/esm/models/CreateShipment201Response.d.ts +1 -1
  103. package/dist/esm/models/CreateShipment201Response.js +1 -1
  104. package/dist/esm/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
  105. package/dist/esm/models/CreateShipment201ResponseActivitiesInner.js +1 -1
  106. package/dist/esm/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
  107. package/dist/esm/models/CreateShipment201ResponseDocumentsInner.js +1 -1
  108. package/dist/esm/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
  109. package/dist/esm/models/CreateShipment201ResponseErrorsInner.js +1 -1
  110. package/dist/esm/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
  111. package/dist/esm/models/CreateShipment201ResponseLogsInner.js +1 -1
  112. package/dist/esm/models/CreateShipment201ResponseParcelsInner.d.ts +1 -1
  113. package/dist/esm/models/CreateShipment201ResponseParcelsInner.js +1 -1
  114. package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
  115. package/dist/esm/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
  116. package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
  117. package/dist/esm/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
  118. package/dist/esm/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
  119. package/dist/esm/models/CreateShipment201ResponsePartiesInner.js +1 -1
  120. package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
  121. package/dist/esm/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
  122. package/dist/esm/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
  123. package/dist/esm/models/CreateShipment201ResponsePickupDetails.js +1 -1
  124. package/dist/esm/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
  125. package/dist/esm/models/CreateShipment201ResponseShippingRule.js +1 -1
  126. package/dist/esm/models/CreateShipment201ResponseTracking.d.ts +1 -1
  127. package/dist/esm/models/CreateShipment201ResponseTracking.js +1 -1
  128. package/dist/esm/models/CreateShipmentRequest.d.ts +1 -1
  129. package/dist/esm/models/CreateShipmentRequest.js +1 -1
  130. package/dist/esm/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
  131. package/dist/esm/models/CreateShipmentRequestCarrierSettings.js +1 -1
  132. package/dist/esm/models/CreateShipmentRequestParcelsInner.d.ts +1 -1
  133. package/dist/esm/models/CreateShipmentRequestParcelsInner.js +1 -1
  134. package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
  135. package/dist/esm/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
  136. package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
  137. package/dist/esm/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
  138. package/dist/esm/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
  139. package/dist/esm/models/CreateShipmentRequestPartiesInner.js +1 -1
  140. package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
  141. package/dist/esm/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
  142. package/dist/esm/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
  143. package/dist/esm/models/CreateShipmentRequestPickupDetails.js +1 -1
  144. package/dist/esm/models/CreateShippingQuote200Response.d.ts +1 -1
  145. package/dist/esm/models/CreateShippingQuote200Response.js +1 -1
  146. package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
  147. package/dist/esm/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
  148. package/dist/esm/models/CreateShippingQuote400Response.d.ts +1 -1
  149. package/dist/esm/models/CreateShippingQuote400Response.js +1 -1
  150. package/dist/esm/models/CreateShippingQuote404Response.d.ts +1 -1
  151. package/dist/esm/models/CreateShippingQuote404Response.js +1 -1
  152. package/dist/esm/models/CreateShippingQuoteRequest.d.ts +1 -1
  153. package/dist/esm/models/CreateShippingQuoteRequest.js +1 -1
  154. package/dist/esm/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
  155. package/dist/esm/models/CreateShippingQuoteRequestDestination.js +1 -1
  156. package/dist/esm/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
  157. package/dist/esm/models/CreateShippingQuoteRequestItemsInner.js +1 -1
  158. package/dist/esm/models/CreateShippingRule201Response.d.ts +1 -1
  159. package/dist/esm/models/CreateShippingRule201Response.js +1 -1
  160. package/dist/esm/models/CreateShippingRuleRequest.d.ts +1 -1
  161. package/dist/esm/models/CreateShippingRuleRequest.js +1 -1
  162. package/dist/esm/models/CreateShippingRuleRequestAdditionalParameters.d.ts +1 -1
  163. package/dist/esm/models/CreateShippingRuleRequestAdditionalParameters.js +1 -1
  164. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.d.ts +1 -1
  165. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.js +1 -1
  166. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.d.ts +1 -1
  167. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.js +1 -1
  168. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.d.ts +1 -1
  169. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.js +1 -1
  170. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.d.ts +1 -1
  171. package/dist/esm/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.js +1 -1
  172. package/dist/esm/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
  173. package/dist/esm/models/CreateShippingRuleRequestConditionsInner.js +1 -1
  174. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
  175. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
  176. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
  177. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
  178. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
  179. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
  180. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
  181. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
  182. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
  183. package/dist/esm/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
  184. package/dist/esm/models/DeleteOrgWebhook200Response.d.ts +1 -1
  185. package/dist/esm/models/DeleteOrgWebhook200Response.js +1 -1
  186. package/dist/esm/models/DeleteShippingRule200Response.d.ts +1 -1
  187. package/dist/esm/models/DeleteShippingRule200Response.js +1 -1
  188. package/dist/esm/models/GetBillingUsage200Response.d.ts +1 -1
  189. package/dist/esm/models/GetBillingUsage200Response.js +1 -1
  190. package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.d.ts +1 -1
  191. package/dist/esm/models/GetBillingUsage200ResponseAddOnsInner.js +1 -1
  192. package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
  193. package/dist/esm/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
  194. package/dist/esm/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
  195. package/dist/esm/models/GetBillingUsage200ResponseLimits.js +1 -1
  196. package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
  197. package/dist/esm/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
  198. package/dist/esm/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
  199. package/dist/esm/models/GetBillingUsage200ResponseShipments.js +1 -1
  200. package/dist/esm/models/GetOrder200Response.d.ts +1 -1
  201. package/dist/esm/models/GetOrder200Response.js +1 -1
  202. package/dist/esm/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
  203. package/dist/esm/models/GetOrder200ResponseShipmentsInner.js +1 -1
  204. package/dist/esm/models/GetOrder200ResponseShippingRule.d.ts +1 -1
  205. package/dist/esm/models/GetOrder200ResponseShippingRule.js +1 -1
  206. package/dist/esm/models/GetOrg200Response.d.ts +1 -1
  207. package/dist/esm/models/GetOrg200Response.js +1 -1
  208. package/dist/esm/models/GetOrg200ResponseCount.d.ts +1 -1
  209. package/dist/esm/models/GetOrg200ResponseCount.js +1 -1
  210. package/dist/esm/models/GetOrgBranding200Response.d.ts +1 -1
  211. package/dist/esm/models/GetOrgBranding200Response.js +1 -1
  212. package/dist/esm/models/HealthCheck200Response.d.ts +1 -1
  213. package/dist/esm/models/HealthCheck200Response.js +1 -1
  214. package/dist/esm/models/ListAddresses200Response.d.ts +1 -1
  215. package/dist/esm/models/ListAddresses200Response.js +1 -1
  216. package/dist/esm/models/ListAddresses200ResponseDataInner.d.ts +1 -1
  217. package/dist/esm/models/ListAddresses200ResponseDataInner.js +1 -1
  218. package/dist/esm/models/ListApiTokens200Response.d.ts +1 -1
  219. package/dist/esm/models/ListApiTokens200Response.js +1 -1
  220. package/dist/esm/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
  221. package/dist/esm/models/ListApiTokens200ResponseDataInner.js +1 -1
  222. package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
  223. package/dist/esm/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
  224. package/dist/esm/models/ListApiTokens401Response.d.ts +1 -1
  225. package/dist/esm/models/ListApiTokens401Response.js +1 -1
  226. package/dist/esm/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
  227. package/dist/esm/models/ListAvailableCarriers200ResponseInner.js +1 -1
  228. package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
  229. package/dist/esm/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
  230. package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
  231. package/dist/esm/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
  232. package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
  233. package/dist/esm/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
  234. package/dist/esm/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
  235. package/dist/esm/models/ListCarrierProductServicePointsRequest.js +1 -1
  236. package/dist/esm/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
  237. package/dist/esm/models/ListCarrierProducts200ResponseInner.js +1 -1
  238. package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
  239. package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
  240. package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
  241. package/dist/esm/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
  242. package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
  243. package/dist/esm/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
  244. package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
  245. package/dist/esm/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
  246. package/dist/esm/models/ListCarriers200Response.d.ts +1 -1
  247. package/dist/esm/models/ListCarriers200Response.js +1 -1
  248. package/dist/esm/models/ListCarriers200ResponseDataInner.d.ts +1 -1
  249. package/dist/esm/models/ListCarriers200ResponseDataInner.js +1 -1
  250. package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
  251. package/dist/esm/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
  252. package/dist/esm/models/ListOrders200Response.d.ts +1 -1
  253. package/dist/esm/models/ListOrders200Response.js +1 -1
  254. package/dist/esm/models/ListOrders200ResponseDataInner.d.ts +1 -1
  255. package/dist/esm/models/ListOrders200ResponseDataInner.js +1 -1
  256. package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
  257. package/dist/esm/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
  258. package/dist/esm/models/ListOrgBrands200Response.d.ts +33 -0
  259. package/dist/esm/models/ListOrgBrands200Response.js +44 -0
  260. package/dist/esm/models/ListOrgBrands200ResponseDataInner.d.ts +142 -0
  261. package/dist/esm/models/ListOrgBrands200ResponseDataInner.js +95 -0
  262. package/dist/esm/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
  263. package/dist/esm/models/ListOrgWebhookDeliveries200Response.js +1 -1
  264. package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
  265. package/dist/esm/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
  266. package/dist/esm/models/ListOrgWebhooks200Response.d.ts +1 -1
  267. package/dist/esm/models/ListOrgWebhooks200Response.js +1 -1
  268. package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.d.ts +1 -1
  269. package/dist/esm/models/ListOrgWebhooks200ResponseDataInner.js +1 -1
  270. package/dist/esm/models/ListShipments200Response.d.ts +1 -1
  271. package/dist/esm/models/ListShipments200Response.js +1 -1
  272. package/dist/esm/models/ListShipments200ResponseDataInner.d.ts +1 -1
  273. package/dist/esm/models/ListShipments200ResponseDataInner.js +1 -1
  274. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.d.ts +1 -1
  275. package/dist/esm/models/ListShipments200ResponseDataInnerAddress.js +1 -1
  276. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +1 -1
  277. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettings.js +1 -1
  278. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.d.ts +1 -1
  279. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.js +1 -1
  280. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.d.ts +1 -1
  281. package/dist/esm/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.js +1 -1
  282. package/dist/esm/models/ListShippingRules200Response.d.ts +1 -1
  283. package/dist/esm/models/ListShippingRules200Response.js +1 -1
  284. package/dist/esm/models/ListShippingRules200ResponseDataInner.d.ts +1 -1
  285. package/dist/esm/models/ListShippingRules200ResponseDataInner.js +1 -1
  286. package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.d.ts +1 -1
  287. package/dist/esm/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.js +1 -1
  288. package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +1 -1
  289. package/dist/esm/models/ListShippingRules200ResponseDataInnerCarrier.js +1 -1
  290. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
  291. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
  292. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
  293. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
  294. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
  295. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
  296. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
  297. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
  298. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
  299. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
  300. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
  301. package/dist/esm/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
  302. package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
  303. package/dist/esm/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
  304. package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
  305. package/dist/esm/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
  306. package/dist/esm/models/RevokeApiToken200Response.d.ts +1 -1
  307. package/dist/esm/models/RevokeApiToken200Response.js +1 -1
  308. package/dist/esm/models/SendShipment422Response.d.ts +1 -1
  309. package/dist/esm/models/SendShipment422Response.js +1 -1
  310. package/dist/esm/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
  311. package/dist/esm/models/SendShipment422ResponseErrorsInner.js +1 -1
  312. package/dist/esm/models/SplitShipment201Response.d.ts +1 -1
  313. package/dist/esm/models/SplitShipment201Response.js +1 -1
  314. package/dist/esm/models/SplitShipmentParcel200Response.d.ts +1 -1
  315. package/dist/esm/models/SplitShipmentParcel200Response.js +1 -1
  316. package/dist/esm/models/SplitShipmentParcelRequest.d.ts +1 -1
  317. package/dist/esm/models/SplitShipmentParcelRequest.js +1 -1
  318. package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
  319. package/dist/esm/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
  320. package/dist/esm/models/SplitShipmentRequest.d.ts +1 -1
  321. package/dist/esm/models/SplitShipmentRequest.js +1 -1
  322. package/dist/esm/models/TestOrgWebhook200Response.d.ts +1 -1
  323. package/dist/esm/models/TestOrgWebhook200Response.js +1 -1
  324. package/dist/esm/models/TrackShipment200Response.d.ts +1 -1
  325. package/dist/esm/models/TrackShipment200Response.js +1 -1
  326. package/dist/esm/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
  327. package/dist/esm/models/TrackShipment200ResponseEventsInner.js +1 -1
  328. package/dist/esm/models/UpdateAddressRequest.d.ts +1 -1
  329. package/dist/esm/models/UpdateAddressRequest.js +1 -1
  330. package/dist/esm/models/UpdateApiTokenRequest.d.ts +1 -1
  331. package/dist/esm/models/UpdateApiTokenRequest.js +1 -1
  332. package/dist/esm/models/UpdateCarrierRequest.d.ts +1 -1
  333. package/dist/esm/models/UpdateCarrierRequest.js +1 -1
  334. package/dist/esm/models/UpdateOrderRequest.d.ts +1 -1
  335. package/dist/esm/models/UpdateOrderRequest.js +1 -1
  336. package/dist/esm/models/UpdateOrg200Response.d.ts +1 -1
  337. package/dist/esm/models/UpdateOrg200Response.js +1 -1
  338. package/dist/esm/models/UpdateOrgBrandRequest.d.ts +106 -0
  339. package/dist/esm/models/UpdateOrgBrandRequest.js +65 -0
  340. package/dist/esm/models/UpdateOrgBrandingRequest.d.ts +1 -1
  341. package/dist/esm/models/UpdateOrgBrandingRequest.js +1 -1
  342. package/dist/esm/models/UpdateOrgRequest.d.ts +1 -1
  343. package/dist/esm/models/UpdateOrgRequest.js +1 -1
  344. package/dist/esm/models/UpdateOrgWebhookRequest.d.ts +1 -1
  345. package/dist/esm/models/UpdateOrgWebhookRequest.js +1 -1
  346. package/dist/esm/models/UpdateShipmentRequest.d.ts +1 -1
  347. package/dist/esm/models/UpdateShipmentRequest.js +1 -1
  348. package/dist/esm/models/UpdateShippingRuleRequest.d.ts +1 -1
  349. package/dist/esm/models/UpdateShippingRuleRequest.js +1 -1
  350. package/dist/esm/models/VerifyApiToken200Response.d.ts +1 -1
  351. package/dist/esm/models/VerifyApiToken200Response.js +1 -1
  352. package/dist/esm/models/VerifyApiTokenRequest.d.ts +1 -1
  353. package/dist/esm/models/VerifyApiTokenRequest.js +1 -1
  354. package/dist/esm/models/index.d.ts +5 -0
  355. package/dist/esm/models/index.js +5 -0
  356. package/dist/esm/runtime.d.ts +1 -1
  357. package/dist/esm/runtime.js +1 -1
  358. package/dist/models/BatchSendShipments200Response.d.ts +1 -1
  359. package/dist/models/BatchSendShipments200Response.js +1 -1
  360. package/dist/models/BatchSendShipments200ResponseResultsInner.d.ts +1 -1
  361. package/dist/models/BatchSendShipments200ResponseResultsInner.js +1 -1
  362. package/dist/models/BatchSendShipments200ResponseSummary.d.ts +1 -1
  363. package/dist/models/BatchSendShipments200ResponseSummary.js +1 -1
  364. package/dist/models/BatchSendShipmentsRequest.d.ts +1 -1
  365. package/dist/models/BatchSendShipmentsRequest.js +1 -1
  366. package/dist/models/BatchSplitShipment201Response.d.ts +1 -1
  367. package/dist/models/BatchSplitShipment201Response.js +1 -1
  368. package/dist/models/BatchSplitShipmentRequest.d.ts +1 -1
  369. package/dist/models/BatchSplitShipmentRequest.js +1 -1
  370. package/dist/models/BatchSplitShipmentRequestShipmentsInner.d.ts +1 -1
  371. package/dist/models/BatchSplitShipmentRequestShipmentsInner.js +1 -1
  372. package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.d.ts +1 -1
  373. package/dist/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.js +1 -1
  374. package/dist/models/CheckBrandSlug200Response.d.ts +38 -0
  375. package/dist/models/CheckBrandSlug200Response.js +54 -0
  376. package/dist/models/ConnectCarrierRequest.d.ts +1 -1
  377. package/dist/models/ConnectCarrierRequest.js +1 -1
  378. package/dist/models/CreateAddressRequest.d.ts +1 -1
  379. package/dist/models/CreateAddressRequest.js +1 -1
  380. package/dist/models/CreateApiToken201Response.d.ts +1 -1
  381. package/dist/models/CreateApiToken201Response.js +1 -1
  382. package/dist/models/CreateApiTokenRequest.d.ts +1 -1
  383. package/dist/models/CreateApiTokenRequest.js +1 -1
  384. package/dist/models/CreateOrder201Response.d.ts +1 -1
  385. package/dist/models/CreateOrder201Response.js +1 -1
  386. package/dist/models/CreateOrder201ResponseOrderLinesInner.d.ts +1 -1
  387. package/dist/models/CreateOrder201ResponseOrderLinesInner.js +1 -1
  388. package/dist/models/CreateOrder201ResponseShippingAddress.d.ts +1 -1
  389. package/dist/models/CreateOrder201ResponseShippingAddress.js +1 -1
  390. package/dist/models/CreateOrderRequest.d.ts +1 -1
  391. package/dist/models/CreateOrderRequest.js +1 -1
  392. package/dist/models/CreateOrderRequestOrderLinesInner.d.ts +1 -1
  393. package/dist/models/CreateOrderRequestOrderLinesInner.js +1 -1
  394. package/dist/models/CreateOrderRequestShippingAddress.d.ts +1 -1
  395. package/dist/models/CreateOrderRequestShippingAddress.js +1 -1
  396. package/dist/models/CreateOrgBrandRequest.d.ts +106 -0
  397. package/dist/models/CreateOrgBrandRequest.js +74 -0
  398. package/dist/models/CreateOrgWebhook201Response.d.ts +1 -1
  399. package/dist/models/CreateOrgWebhook201Response.js +1 -1
  400. package/dist/models/CreateOrgWebhookRequest.d.ts +1 -1
  401. package/dist/models/CreateOrgWebhookRequest.js +1 -1
  402. package/dist/models/CreateShipment201Response.d.ts +1 -1
  403. package/dist/models/CreateShipment201Response.js +1 -1
  404. package/dist/models/CreateShipment201ResponseActivitiesInner.d.ts +1 -1
  405. package/dist/models/CreateShipment201ResponseActivitiesInner.js +1 -1
  406. package/dist/models/CreateShipment201ResponseDocumentsInner.d.ts +1 -1
  407. package/dist/models/CreateShipment201ResponseDocumentsInner.js +1 -1
  408. package/dist/models/CreateShipment201ResponseErrorsInner.d.ts +1 -1
  409. package/dist/models/CreateShipment201ResponseErrorsInner.js +1 -1
  410. package/dist/models/CreateShipment201ResponseLogsInner.d.ts +1 -1
  411. package/dist/models/CreateShipment201ResponseLogsInner.js +1 -1
  412. package/dist/models/CreateShipment201ResponseParcelsInner.d.ts +1 -1
  413. package/dist/models/CreateShipment201ResponseParcelsInner.js +1 -1
  414. package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.d.ts +1 -1
  415. package/dist/models/CreateShipment201ResponseParcelsInnerDimensions.js +1 -1
  416. package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.d.ts +1 -1
  417. package/dist/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.js +1 -1
  418. package/dist/models/CreateShipment201ResponsePartiesInner.d.ts +1 -1
  419. package/dist/models/CreateShipment201ResponsePartiesInner.js +1 -1
  420. package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.d.ts +1 -1
  421. package/dist/models/CreateShipment201ResponsePartiesInnerAttributesInner.js +1 -1
  422. package/dist/models/CreateShipment201ResponsePickupDetails.d.ts +1 -1
  423. package/dist/models/CreateShipment201ResponsePickupDetails.js +1 -1
  424. package/dist/models/CreateShipment201ResponseShippingRule.d.ts +1 -1
  425. package/dist/models/CreateShipment201ResponseShippingRule.js +1 -1
  426. package/dist/models/CreateShipment201ResponseTracking.d.ts +1 -1
  427. package/dist/models/CreateShipment201ResponseTracking.js +1 -1
  428. package/dist/models/CreateShipmentRequest.d.ts +1 -1
  429. package/dist/models/CreateShipmentRequest.js +1 -1
  430. package/dist/models/CreateShipmentRequestCarrierSettings.d.ts +1 -1
  431. package/dist/models/CreateShipmentRequestCarrierSettings.js +1 -1
  432. package/dist/models/CreateShipmentRequestParcelsInner.d.ts +1 -1
  433. package/dist/models/CreateShipmentRequestParcelsInner.js +1 -1
  434. package/dist/models/CreateShipmentRequestParcelsInnerDimensions.d.ts +1 -1
  435. package/dist/models/CreateShipmentRequestParcelsInnerDimensions.js +1 -1
  436. package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.d.ts +1 -1
  437. package/dist/models/CreateShipmentRequestParcelsInnerOrderLinesInner.js +1 -1
  438. package/dist/models/CreateShipmentRequestPartiesInner.d.ts +1 -1
  439. package/dist/models/CreateShipmentRequestPartiesInner.js +1 -1
  440. package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.d.ts +1 -1
  441. package/dist/models/CreateShipmentRequestPartiesInnerAttributesInner.js +1 -1
  442. package/dist/models/CreateShipmentRequestPickupDetails.d.ts +1 -1
  443. package/dist/models/CreateShipmentRequestPickupDetails.js +1 -1
  444. package/dist/models/CreateShippingQuote200Response.d.ts +1 -1
  445. package/dist/models/CreateShippingQuote200Response.js +1 -1
  446. package/dist/models/CreateShippingQuote200ResponseRatesInner.d.ts +1 -1
  447. package/dist/models/CreateShippingQuote200ResponseRatesInner.js +1 -1
  448. package/dist/models/CreateShippingQuote400Response.d.ts +1 -1
  449. package/dist/models/CreateShippingQuote400Response.js +1 -1
  450. package/dist/models/CreateShippingQuote404Response.d.ts +1 -1
  451. package/dist/models/CreateShippingQuote404Response.js +1 -1
  452. package/dist/models/CreateShippingQuoteRequest.d.ts +1 -1
  453. package/dist/models/CreateShippingQuoteRequest.js +1 -1
  454. package/dist/models/CreateShippingQuoteRequestDestination.d.ts +1 -1
  455. package/dist/models/CreateShippingQuoteRequestDestination.js +1 -1
  456. package/dist/models/CreateShippingQuoteRequestItemsInner.d.ts +1 -1
  457. package/dist/models/CreateShippingQuoteRequestItemsInner.js +1 -1
  458. package/dist/models/CreateShippingRule201Response.d.ts +1 -1
  459. package/dist/models/CreateShippingRule201Response.js +1 -1
  460. package/dist/models/CreateShippingRuleRequest.d.ts +1 -1
  461. package/dist/models/CreateShippingRuleRequest.js +1 -1
  462. package/dist/models/CreateShippingRuleRequestAdditionalParameters.d.ts +1 -1
  463. package/dist/models/CreateShippingRuleRequestAdditionalParameters.js +1 -1
  464. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.d.ts +1 -1
  465. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.js +1 -1
  466. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.d.ts +1 -1
  467. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.js +1 -1
  468. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.d.ts +1 -1
  469. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.js +1 -1
  470. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.d.ts +1 -1
  471. package/dist/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.js +1 -1
  472. package/dist/models/CreateShippingRuleRequestConditionsInner.d.ts +1 -1
  473. package/dist/models/CreateShippingRuleRequestConditionsInner.js +1 -1
  474. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.d.ts +1 -1
  475. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf.js +1 -1
  476. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.d.ts +1 -1
  477. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf1.js +1 -1
  478. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.d.ts +1 -1
  479. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf2.js +1 -1
  480. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.d.ts +1 -1
  481. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf3.js +1 -1
  482. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.d.ts +1 -1
  483. package/dist/models/CreateShippingRuleRequestConditionsInnerOneOf4.js +1 -1
  484. package/dist/models/DeleteOrgWebhook200Response.d.ts +1 -1
  485. package/dist/models/DeleteOrgWebhook200Response.js +1 -1
  486. package/dist/models/DeleteShippingRule200Response.d.ts +1 -1
  487. package/dist/models/DeleteShippingRule200Response.js +1 -1
  488. package/dist/models/GetBillingUsage200Response.d.ts +1 -1
  489. package/dist/models/GetBillingUsage200Response.js +1 -1
  490. package/dist/models/GetBillingUsage200ResponseAddOnsInner.d.ts +1 -1
  491. package/dist/models/GetBillingUsage200ResponseAddOnsInner.js +1 -1
  492. package/dist/models/GetBillingUsage200ResponseCurrentPeriod.d.ts +1 -1
  493. package/dist/models/GetBillingUsage200ResponseCurrentPeriod.js +1 -1
  494. package/dist/models/GetBillingUsage200ResponseLimits.d.ts +1 -1
  495. package/dist/models/GetBillingUsage200ResponseLimits.js +1 -1
  496. package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.d.ts +1 -1
  497. package/dist/models/GetBillingUsage200ResponseLimitsTeamMembers.js +1 -1
  498. package/dist/models/GetBillingUsage200ResponseShipments.d.ts +1 -1
  499. package/dist/models/GetBillingUsage200ResponseShipments.js +1 -1
  500. package/dist/models/GetOrder200Response.d.ts +1 -1
  501. package/dist/models/GetOrder200Response.js +1 -1
  502. package/dist/models/GetOrder200ResponseShipmentsInner.d.ts +1 -1
  503. package/dist/models/GetOrder200ResponseShipmentsInner.js +1 -1
  504. package/dist/models/GetOrder200ResponseShippingRule.d.ts +1 -1
  505. package/dist/models/GetOrder200ResponseShippingRule.js +1 -1
  506. package/dist/models/GetOrg200Response.d.ts +1 -1
  507. package/dist/models/GetOrg200Response.js +1 -1
  508. package/dist/models/GetOrg200ResponseCount.d.ts +1 -1
  509. package/dist/models/GetOrg200ResponseCount.js +1 -1
  510. package/dist/models/GetOrgBranding200Response.d.ts +1 -1
  511. package/dist/models/GetOrgBranding200Response.js +1 -1
  512. package/dist/models/HealthCheck200Response.d.ts +1 -1
  513. package/dist/models/HealthCheck200Response.js +1 -1
  514. package/dist/models/ListAddresses200Response.d.ts +1 -1
  515. package/dist/models/ListAddresses200Response.js +1 -1
  516. package/dist/models/ListAddresses200ResponseDataInner.d.ts +1 -1
  517. package/dist/models/ListAddresses200ResponseDataInner.js +1 -1
  518. package/dist/models/ListApiTokens200Response.d.ts +1 -1
  519. package/dist/models/ListApiTokens200Response.js +1 -1
  520. package/dist/models/ListApiTokens200ResponseDataInner.d.ts +1 -1
  521. package/dist/models/ListApiTokens200ResponseDataInner.js +1 -1
  522. package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.d.ts +1 -1
  523. package/dist/models/ListApiTokens200ResponseDataInnerCreatedBy.js +1 -1
  524. package/dist/models/ListApiTokens401Response.d.ts +1 -1
  525. package/dist/models/ListApiTokens401Response.js +1 -1
  526. package/dist/models/ListAvailableCarriers200ResponseInner.d.ts +1 -1
  527. package/dist/models/ListAvailableCarriers200ResponseInner.js +1 -1
  528. package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.d.ts +1 -1
  529. package/dist/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.js +1 -1
  530. package/dist/models/ListCarrierProductServicePoints200ResponseInner.d.ts +1 -1
  531. package/dist/models/ListCarrierProductServicePoints200ResponseInner.js +1 -1
  532. package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.d.ts +1 -1
  533. package/dist/models/ListCarrierProductServicePoints200ResponseInnerAddress.js +1 -1
  534. package/dist/models/ListCarrierProductServicePointsRequest.d.ts +1 -1
  535. package/dist/models/ListCarrierProductServicePointsRequest.js +1 -1
  536. package/dist/models/ListCarrierProducts200ResponseInner.d.ts +1 -1
  537. package/dist/models/ListCarrierProducts200ResponseInner.js +1 -1
  538. package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.d.ts +1 -1
  539. package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.js +1 -1
  540. package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.d.ts +1 -1
  541. package/dist/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.js +1 -1
  542. package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.d.ts +1 -1
  543. package/dist/models/ListCarrierProducts200ResponseInnerServicesInner.js +1 -1
  544. package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.d.ts +1 -1
  545. package/dist/models/ListCarrierProducts200ResponseInnerWeightLimits.js +1 -1
  546. package/dist/models/ListCarriers200Response.d.ts +1 -1
  547. package/dist/models/ListCarriers200Response.js +1 -1
  548. package/dist/models/ListCarriers200ResponseDataInner.d.ts +1 -1
  549. package/dist/models/ListCarriers200ResponseDataInner.js +1 -1
  550. package/dist/models/ListCarriers200ResponseDataInnerConfigValue.d.ts +1 -1
  551. package/dist/models/ListCarriers200ResponseDataInnerConfigValue.js +1 -1
  552. package/dist/models/ListOrders200Response.d.ts +1 -1
  553. package/dist/models/ListOrders200Response.js +1 -1
  554. package/dist/models/ListOrders200ResponseDataInner.d.ts +1 -1
  555. package/dist/models/ListOrders200ResponseDataInner.js +1 -1
  556. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.d.ts +1 -1
  557. package/dist/models/ListOrders200ResponseDataInnerOrderChannel.js +1 -1
  558. package/dist/models/ListOrgBrands200Response.d.ts +33 -0
  559. package/dist/models/ListOrgBrands200Response.js +51 -0
  560. package/dist/models/ListOrgBrands200ResponseDataInner.d.ts +142 -0
  561. package/dist/models/ListOrgBrands200ResponseDataInner.js +102 -0
  562. package/dist/models/ListOrgWebhookDeliveries200Response.d.ts +1 -1
  563. package/dist/models/ListOrgWebhookDeliveries200Response.js +1 -1
  564. package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.d.ts +1 -1
  565. package/dist/models/ListOrgWebhookDeliveries200ResponseDataInner.js +1 -1
  566. package/dist/models/ListOrgWebhooks200Response.d.ts +1 -1
  567. package/dist/models/ListOrgWebhooks200Response.js +1 -1
  568. package/dist/models/ListOrgWebhooks200ResponseDataInner.d.ts +1 -1
  569. package/dist/models/ListOrgWebhooks200ResponseDataInner.js +1 -1
  570. package/dist/models/ListShipments200Response.d.ts +1 -1
  571. package/dist/models/ListShipments200Response.js +1 -1
  572. package/dist/models/ListShipments200ResponseDataInner.d.ts +1 -1
  573. package/dist/models/ListShipments200ResponseDataInner.js +1 -1
  574. package/dist/models/ListShipments200ResponseDataInnerAddress.d.ts +1 -1
  575. package/dist/models/ListShipments200ResponseDataInnerAddress.js +1 -1
  576. package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.d.ts +1 -1
  577. package/dist/models/ListShipments200ResponseDataInnerCarrierSettings.js +1 -1
  578. package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.d.ts +1 -1
  579. package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.js +1 -1
  580. package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.d.ts +1 -1
  581. package/dist/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.js +1 -1
  582. package/dist/models/ListShippingRules200Response.d.ts +1 -1
  583. package/dist/models/ListShippingRules200Response.js +1 -1
  584. package/dist/models/ListShippingRules200ResponseDataInner.d.ts +1 -1
  585. package/dist/models/ListShippingRules200ResponseDataInner.js +1 -1
  586. package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.d.ts +1 -1
  587. package/dist/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.js +1 -1
  588. package/dist/models/ListShippingRules200ResponseDataInnerCarrier.d.ts +1 -1
  589. package/dist/models/ListShippingRules200ResponseDataInnerCarrier.js +1 -1
  590. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.d.ts +1 -1
  591. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInner.js +1 -1
  592. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.d.ts +1 -1
  593. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.js +1 -1
  594. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.d.ts +1 -1
  595. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.js +1 -1
  596. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.d.ts +1 -1
  597. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.js +1 -1
  598. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.d.ts +1 -1
  599. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.js +1 -1
  600. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.d.ts +1 -1
  601. package/dist/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.js +1 -1
  602. package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.d.ts +1 -1
  603. package/dist/models/ListShippingRules200ResponseDataInnerLabelPrinter.js +1 -1
  604. package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.d.ts +1 -1
  605. package/dist/models/ListShippingRules200ResponseDataInnerReturnShippingRule.js +1 -1
  606. package/dist/models/RevokeApiToken200Response.d.ts +1 -1
  607. package/dist/models/RevokeApiToken200Response.js +1 -1
  608. package/dist/models/SendShipment422Response.d.ts +1 -1
  609. package/dist/models/SendShipment422Response.js +1 -1
  610. package/dist/models/SendShipment422ResponseErrorsInner.d.ts +1 -1
  611. package/dist/models/SendShipment422ResponseErrorsInner.js +1 -1
  612. package/dist/models/SplitShipment201Response.d.ts +1 -1
  613. package/dist/models/SplitShipment201Response.js +1 -1
  614. package/dist/models/SplitShipmentParcel200Response.d.ts +1 -1
  615. package/dist/models/SplitShipmentParcel200Response.js +1 -1
  616. package/dist/models/SplitShipmentParcelRequest.d.ts +1 -1
  617. package/dist/models/SplitShipmentParcelRequest.js +1 -1
  618. package/dist/models/SplitShipmentParcelRequestParcelsInner.d.ts +1 -1
  619. package/dist/models/SplitShipmentParcelRequestParcelsInner.js +1 -1
  620. package/dist/models/SplitShipmentRequest.d.ts +1 -1
  621. package/dist/models/SplitShipmentRequest.js +1 -1
  622. package/dist/models/TestOrgWebhook200Response.d.ts +1 -1
  623. package/dist/models/TestOrgWebhook200Response.js +1 -1
  624. package/dist/models/TrackShipment200Response.d.ts +1 -1
  625. package/dist/models/TrackShipment200Response.js +1 -1
  626. package/dist/models/TrackShipment200ResponseEventsInner.d.ts +1 -1
  627. package/dist/models/TrackShipment200ResponseEventsInner.js +1 -1
  628. package/dist/models/UpdateAddressRequest.d.ts +1 -1
  629. package/dist/models/UpdateAddressRequest.js +1 -1
  630. package/dist/models/UpdateApiTokenRequest.d.ts +1 -1
  631. package/dist/models/UpdateApiTokenRequest.js +1 -1
  632. package/dist/models/UpdateCarrierRequest.d.ts +1 -1
  633. package/dist/models/UpdateCarrierRequest.js +1 -1
  634. package/dist/models/UpdateOrderRequest.d.ts +1 -1
  635. package/dist/models/UpdateOrderRequest.js +1 -1
  636. package/dist/models/UpdateOrg200Response.d.ts +1 -1
  637. package/dist/models/UpdateOrg200Response.js +1 -1
  638. package/dist/models/UpdateOrgBrandRequest.d.ts +106 -0
  639. package/dist/models/UpdateOrgBrandRequest.js +72 -0
  640. package/dist/models/UpdateOrgBrandingRequest.d.ts +1 -1
  641. package/dist/models/UpdateOrgBrandingRequest.js +1 -1
  642. package/dist/models/UpdateOrgRequest.d.ts +1 -1
  643. package/dist/models/UpdateOrgRequest.js +1 -1
  644. package/dist/models/UpdateOrgWebhookRequest.d.ts +1 -1
  645. package/dist/models/UpdateOrgWebhookRequest.js +1 -1
  646. package/dist/models/UpdateShipmentRequest.d.ts +1 -1
  647. package/dist/models/UpdateShipmentRequest.js +1 -1
  648. package/dist/models/UpdateShippingRuleRequest.d.ts +1 -1
  649. package/dist/models/UpdateShippingRuleRequest.js +1 -1
  650. package/dist/models/VerifyApiToken200Response.d.ts +1 -1
  651. package/dist/models/VerifyApiToken200Response.js +1 -1
  652. package/dist/models/VerifyApiTokenRequest.d.ts +1 -1
  653. package/dist/models/VerifyApiTokenRequest.js +1 -1
  654. package/dist/models/index.d.ts +5 -0
  655. package/dist/models/index.js +5 -0
  656. package/dist/runtime.d.ts +1 -1
  657. package/dist/runtime.js +1 -1
  658. package/docs/BrandsApi.md +795 -0
  659. package/docs/CheckBrandSlug200Response.md +36 -0
  660. package/docs/CreateOrgBrandRequest.md +58 -0
  661. package/docs/ListOrgBrands200Response.md +34 -0
  662. package/docs/ListOrgBrands200ResponseDataInner.md +70 -0
  663. package/docs/UpdateOrgBrandRequest.md +58 -0
  664. package/package.json +1 -1
  665. package/src/apis/AddressesApi.ts +1 -1
  666. package/src/apis/BillingApi.ts +1 -1
  667. package/src/apis/BrandsApi.ts +770 -0
  668. package/src/apis/CarrierCatalogApi.ts +1 -1
  669. package/src/apis/CarriersApi.ts +1 -1
  670. package/src/apis/OrdersApi.ts +1 -1
  671. package/src/apis/OrgsApi.ts +1 -1
  672. package/src/apis/QuotesApi.ts +1 -1
  673. package/src/apis/RulesApi.ts +1 -1
  674. package/src/apis/ShipmentsApi.ts +1 -1
  675. package/src/apis/SystemApi.ts +1 -1
  676. package/src/apis/TokensApi.ts +1 -1
  677. package/src/apis/WebhooksApi.ts +1 -1
  678. package/src/apis/index.ts +1 -0
  679. package/src/models/BatchSendShipments200Response.ts +1 -1
  680. package/src/models/BatchSendShipments200ResponseResultsInner.ts +1 -1
  681. package/src/models/BatchSendShipments200ResponseSummary.ts +1 -1
  682. package/src/models/BatchSendShipmentsRequest.ts +1 -1
  683. package/src/models/BatchSplitShipment201Response.ts +1 -1
  684. package/src/models/BatchSplitShipmentRequest.ts +1 -1
  685. package/src/models/BatchSplitShipmentRequestShipmentsInner.ts +1 -1
  686. package/src/models/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.ts +1 -1
  687. package/src/models/CheckBrandSlug200Response.ts +75 -0
  688. package/src/models/ConnectCarrierRequest.ts +1 -1
  689. package/src/models/CreateAddressRequest.ts +1 -1
  690. package/src/models/CreateApiToken201Response.ts +1 -1
  691. package/src/models/CreateApiTokenRequest.ts +1 -1
  692. package/src/models/CreateOrder201Response.ts +1 -1
  693. package/src/models/CreateOrder201ResponseOrderLinesInner.ts +1 -1
  694. package/src/models/CreateOrder201ResponseShippingAddress.ts +1 -1
  695. package/src/models/CreateOrderRequest.ts +1 -1
  696. package/src/models/CreateOrderRequestOrderLinesInner.ts +1 -1
  697. package/src/models/CreateOrderRequestShippingAddress.ts +1 -1
  698. package/src/models/CreateOrgBrandRequest.ts +162 -0
  699. package/src/models/CreateOrgWebhook201Response.ts +1 -1
  700. package/src/models/CreateOrgWebhookRequest.ts +1 -1
  701. package/src/models/CreateShipment201Response.ts +1 -1
  702. package/src/models/CreateShipment201ResponseActivitiesInner.ts +1 -1
  703. package/src/models/CreateShipment201ResponseDocumentsInner.ts +1 -1
  704. package/src/models/CreateShipment201ResponseErrorsInner.ts +1 -1
  705. package/src/models/CreateShipment201ResponseLogsInner.ts +1 -1
  706. package/src/models/CreateShipment201ResponseParcelsInner.ts +1 -1
  707. package/src/models/CreateShipment201ResponseParcelsInnerDimensions.ts +1 -1
  708. package/src/models/CreateShipment201ResponseParcelsInnerOrderLinesInner.ts +1 -1
  709. package/src/models/CreateShipment201ResponsePartiesInner.ts +1 -1
  710. package/src/models/CreateShipment201ResponsePartiesInnerAttributesInner.ts +1 -1
  711. package/src/models/CreateShipment201ResponsePickupDetails.ts +1 -1
  712. package/src/models/CreateShipment201ResponseShippingRule.ts +1 -1
  713. package/src/models/CreateShipment201ResponseTracking.ts +1 -1
  714. package/src/models/CreateShipmentRequest.ts +1 -1
  715. package/src/models/CreateShipmentRequestCarrierSettings.ts +1 -1
  716. package/src/models/CreateShipmentRequestParcelsInner.ts +1 -1
  717. package/src/models/CreateShipmentRequestParcelsInnerDimensions.ts +1 -1
  718. package/src/models/CreateShipmentRequestParcelsInnerOrderLinesInner.ts +1 -1
  719. package/src/models/CreateShipmentRequestPartiesInner.ts +1 -1
  720. package/src/models/CreateShipmentRequestPartiesInnerAttributesInner.ts +1 -1
  721. package/src/models/CreateShipmentRequestPickupDetails.ts +1 -1
  722. package/src/models/CreateShippingQuote200Response.ts +1 -1
  723. package/src/models/CreateShippingQuote200ResponseRatesInner.ts +1 -1
  724. package/src/models/CreateShippingQuote400Response.ts +1 -1
  725. package/src/models/CreateShippingQuote404Response.ts +1 -1
  726. package/src/models/CreateShippingQuoteRequest.ts +1 -1
  727. package/src/models/CreateShippingQuoteRequestDestination.ts +1 -1
  728. package/src/models/CreateShippingQuoteRequestItemsInner.ts +1 -1
  729. package/src/models/CreateShippingRule201Response.ts +1 -1
  730. package/src/models/CreateShippingRuleRequest.ts +1 -1
  731. package/src/models/CreateShippingRuleRequestAdditionalParameters.ts +1 -1
  732. package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfInner.ts +1 -1
  733. package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValue.ts +1 -1
  734. package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.ts +1 -1
  735. package/src/models/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.ts +1 -1
  736. package/src/models/CreateShippingRuleRequestConditionsInner.ts +1 -1
  737. package/src/models/CreateShippingRuleRequestConditionsInnerOneOf.ts +1 -1
  738. package/src/models/CreateShippingRuleRequestConditionsInnerOneOf1.ts +1 -1
  739. package/src/models/CreateShippingRuleRequestConditionsInnerOneOf2.ts +1 -1
  740. package/src/models/CreateShippingRuleRequestConditionsInnerOneOf3.ts +1 -1
  741. package/src/models/CreateShippingRuleRequestConditionsInnerOneOf4.ts +1 -1
  742. package/src/models/DeleteOrgWebhook200Response.ts +1 -1
  743. package/src/models/DeleteShippingRule200Response.ts +1 -1
  744. package/src/models/GetBillingUsage200Response.ts +1 -1
  745. package/src/models/GetBillingUsage200ResponseAddOnsInner.ts +1 -1
  746. package/src/models/GetBillingUsage200ResponseCurrentPeriod.ts +1 -1
  747. package/src/models/GetBillingUsage200ResponseLimits.ts +1 -1
  748. package/src/models/GetBillingUsage200ResponseLimitsTeamMembers.ts +1 -1
  749. package/src/models/GetBillingUsage200ResponseShipments.ts +1 -1
  750. package/src/models/GetOrder200Response.ts +1 -1
  751. package/src/models/GetOrder200ResponseShipmentsInner.ts +1 -1
  752. package/src/models/GetOrder200ResponseShippingRule.ts +1 -1
  753. package/src/models/GetOrg200Response.ts +1 -1
  754. package/src/models/GetOrg200ResponseCount.ts +1 -1
  755. package/src/models/GetOrgBranding200Response.ts +1 -1
  756. package/src/models/HealthCheck200Response.ts +1 -1
  757. package/src/models/ListAddresses200Response.ts +1 -1
  758. package/src/models/ListAddresses200ResponseDataInner.ts +1 -1
  759. package/src/models/ListApiTokens200Response.ts +1 -1
  760. package/src/models/ListApiTokens200ResponseDataInner.ts +1 -1
  761. package/src/models/ListApiTokens200ResponseDataInnerCreatedBy.ts +1 -1
  762. package/src/models/ListApiTokens401Response.ts +1 -1
  763. package/src/models/ListAvailableCarriers200ResponseInner.ts +1 -1
  764. package/src/models/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.ts +1 -1
  765. package/src/models/ListCarrierProductServicePoints200ResponseInner.ts +1 -1
  766. package/src/models/ListCarrierProductServicePoints200ResponseInnerAddress.ts +1 -1
  767. package/src/models/ListCarrierProductServicePointsRequest.ts +1 -1
  768. package/src/models/ListCarrierProducts200ResponseInner.ts +1 -1
  769. package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInner.ts +1 -1
  770. package/src/models/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.ts +1 -1
  771. package/src/models/ListCarrierProducts200ResponseInnerServicesInner.ts +1 -1
  772. package/src/models/ListCarrierProducts200ResponseInnerWeightLimits.ts +1 -1
  773. package/src/models/ListCarriers200Response.ts +1 -1
  774. package/src/models/ListCarriers200ResponseDataInner.ts +1 -1
  775. package/src/models/ListCarriers200ResponseDataInnerConfigValue.ts +1 -1
  776. package/src/models/ListOrders200Response.ts +1 -1
  777. package/src/models/ListOrders200ResponseDataInner.ts +1 -1
  778. package/src/models/ListOrders200ResponseDataInnerOrderChannel.ts +1 -1
  779. package/src/models/ListOrgBrands200Response.ts +74 -0
  780. package/src/models/ListOrgBrands200ResponseDataInner.ts +218 -0
  781. package/src/models/ListOrgWebhookDeliveries200Response.ts +1 -1
  782. package/src/models/ListOrgWebhookDeliveries200ResponseDataInner.ts +1 -1
  783. package/src/models/ListOrgWebhooks200Response.ts +1 -1
  784. package/src/models/ListOrgWebhooks200ResponseDataInner.ts +1 -1
  785. package/src/models/ListShipments200Response.ts +1 -1
  786. package/src/models/ListShipments200ResponseDataInner.ts +1 -1
  787. package/src/models/ListShipments200ResponseDataInnerAddress.ts +1 -1
  788. package/src/models/ListShipments200ResponseDataInnerCarrierSettings.ts +1 -1
  789. package/src/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.ts +1 -1
  790. package/src/models/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.ts +1 -1
  791. package/src/models/ListShippingRules200Response.ts +1 -1
  792. package/src/models/ListShippingRules200ResponseDataInner.ts +1 -1
  793. package/src/models/ListShippingRules200ResponseDataInnerAdditionalParametersInner.ts +1 -1
  794. package/src/models/ListShippingRules200ResponseDataInnerCarrier.ts +1 -1
  795. package/src/models/ListShippingRules200ResponseDataInnerConditionsInner.ts +1 -1
  796. package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.ts +1 -1
  797. package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.ts +1 -1
  798. package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.ts +1 -1
  799. package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.ts +1 -1
  800. package/src/models/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.ts +1 -1
  801. package/src/models/ListShippingRules200ResponseDataInnerLabelPrinter.ts +1 -1
  802. package/src/models/ListShippingRules200ResponseDataInnerReturnShippingRule.ts +1 -1
  803. package/src/models/RevokeApiToken200Response.ts +1 -1
  804. package/src/models/SendShipment422Response.ts +1 -1
  805. package/src/models/SendShipment422ResponseErrorsInner.ts +1 -1
  806. package/src/models/SplitShipment201Response.ts +1 -1
  807. package/src/models/SplitShipmentParcel200Response.ts +1 -1
  808. package/src/models/SplitShipmentParcelRequest.ts +1 -1
  809. package/src/models/SplitShipmentParcelRequestParcelsInner.ts +1 -1
  810. package/src/models/SplitShipmentRequest.ts +1 -1
  811. package/src/models/TestOrgWebhook200Response.ts +1 -1
  812. package/src/models/TrackShipment200Response.ts +1 -1
  813. package/src/models/TrackShipment200ResponseEventsInner.ts +1 -1
  814. package/src/models/UpdateAddressRequest.ts +1 -1
  815. package/src/models/UpdateApiTokenRequest.ts +1 -1
  816. package/src/models/UpdateCarrierRequest.ts +1 -1
  817. package/src/models/UpdateOrderRequest.ts +1 -1
  818. package/src/models/UpdateOrg200Response.ts +1 -1
  819. package/src/models/UpdateOrgBrandRequest.ts +161 -0
  820. package/src/models/UpdateOrgBrandingRequest.ts +1 -1
  821. package/src/models/UpdateOrgRequest.ts +1 -1
  822. package/src/models/UpdateOrgWebhookRequest.ts +1 -1
  823. package/src/models/UpdateShipmentRequest.ts +1 -1
  824. package/src/models/UpdateShippingRuleRequest.ts +1 -1
  825. package/src/models/VerifyApiToken200Response.ts +1 -1
  826. package/src/models/VerifyApiTokenRequest.ts +1 -1
  827. package/src/models/index.ts +5 -0
  828. package/src/runtime.ts +1 -1
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * 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`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfCheckBrandSlug200Response = instanceOfCheckBrandSlug200Response;
17
+ exports.CheckBrandSlug200ResponseFromJSON = CheckBrandSlug200ResponseFromJSON;
18
+ exports.CheckBrandSlug200ResponseFromJSONTyped = CheckBrandSlug200ResponseFromJSONTyped;
19
+ exports.CheckBrandSlug200ResponseToJSON = CheckBrandSlug200ResponseToJSON;
20
+ exports.CheckBrandSlug200ResponseToJSONTyped = CheckBrandSlug200ResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the CheckBrandSlug200Response interface.
23
+ */
24
+ function instanceOfCheckBrandSlug200Response(value) {
25
+ if (!('slug' in value) || value['slug'] === undefined)
26
+ return false;
27
+ if (!('available' in value) || value['available'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function CheckBrandSlug200ResponseFromJSON(json) {
32
+ return CheckBrandSlug200ResponseFromJSONTyped(json, false);
33
+ }
34
+ function CheckBrandSlug200ResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'slug': json['slug'],
40
+ 'available': json['available'],
41
+ };
42
+ }
43
+ function CheckBrandSlug200ResponseToJSON(json) {
44
+ return CheckBrandSlug200ResponseToJSONTyped(json, false);
45
+ }
46
+ function CheckBrandSlug200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'slug': value['slug'],
52
+ 'available': value['available'],
53
+ };
54
+ }
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -0,0 +1,106 @@
1
+ /**
2
+ * Zippendo Public API
3
+ * 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`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@zippendo.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreateOrgBrandRequest
16
+ */
17
+ export interface CreateOrgBrandRequest {
18
+ /**
19
+ * Legal entity name printed on this brand's documents
20
+ * @type {string}
21
+ * @memberof CreateOrgBrandRequest
22
+ */
23
+ companyName?: string | null;
24
+ /**
25
+ * VAT/tax ID for this brand's shipments and documents
26
+ * @type {string}
27
+ * @memberof CreateOrgBrandRequest
28
+ */
29
+ vatNumber?: string | null;
30
+ /**
31
+ * Customs identifiers keyed by type
32
+ * @type {{ [key: string]: string; }}
33
+ * @memberof CreateOrgBrandRequest
34
+ */
35
+ customs?: {
36
+ [key: string]: string;
37
+ } | null;
38
+ /**
39
+ * Street address line 1
40
+ * @type {string}
41
+ * @memberof CreateOrgBrandRequest
42
+ */
43
+ addressLine1?: string | null;
44
+ /**
45
+ * Street address line 2
46
+ * @type {string}
47
+ * @memberof CreateOrgBrandRequest
48
+ */
49
+ addressLine2?: string | null;
50
+ /**
51
+ * City
52
+ * @type {string}
53
+ * @memberof CreateOrgBrandRequest
54
+ */
55
+ city?: string | null;
56
+ /**
57
+ * Postal code
58
+ * @type {string}
59
+ * @memberof CreateOrgBrandRequest
60
+ */
61
+ postalCode?: string | null;
62
+ /**
63
+ * Country (ISO 3166-1 alpha-2)
64
+ * @type {string}
65
+ * @memberof CreateOrgBrandRequest
66
+ */
67
+ country?: string | null;
68
+ /**
69
+ * Primary brand colour — document title and table headers
70
+ * @type {string}
71
+ * @memberof CreateOrgBrandRequest
72
+ */
73
+ primaryColor?: string | null;
74
+ /**
75
+ * Secondary brand colour — subtitle, section headings, totals accent
76
+ * @type {string}
77
+ * @memberof CreateOrgBrandRequest
78
+ */
79
+ secondaryColor?: string | null;
80
+ /**
81
+ * Brand display name
82
+ * @type {string}
83
+ * @memberof CreateOrgBrandRequest
84
+ */
85
+ name: string;
86
+ /**
87
+ * URL-safe identifier, unique within the org. Derived from the name when omitted.
88
+ * @type {string}
89
+ * @memberof CreateOrgBrandRequest
90
+ */
91
+ slug?: string;
92
+ /**
93
+ * Whether this brand ships under the organization's fiscal identity. True (the default) declares the organization's VAT number and customs identifiers and ignores the brand's own. False makes the brand's own values the sole source — nothing falls back to the organization, so an identifier the brand has not set is not declared at all.
94
+ * @type {boolean}
95
+ * @memberof CreateOrgBrandRequest
96
+ */
97
+ useOrgCustoms?: boolean;
98
+ }
99
+ /**
100
+ * Check if a given object implements the CreateOrgBrandRequest interface.
101
+ */
102
+ export declare function instanceOfCreateOrgBrandRequest(value: object): value is CreateOrgBrandRequest;
103
+ export declare function CreateOrgBrandRequestFromJSON(json: any): CreateOrgBrandRequest;
104
+ export declare function CreateOrgBrandRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrgBrandRequest;
105
+ export declare function CreateOrgBrandRequestToJSON(json: any): CreateOrgBrandRequest;
106
+ export declare function CreateOrgBrandRequestToJSONTyped(value?: CreateOrgBrandRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Zippendo Public API
6
+ * 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`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@zippendo.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfCreateOrgBrandRequest = instanceOfCreateOrgBrandRequest;
17
+ exports.CreateOrgBrandRequestFromJSON = CreateOrgBrandRequestFromJSON;
18
+ exports.CreateOrgBrandRequestFromJSONTyped = CreateOrgBrandRequestFromJSONTyped;
19
+ exports.CreateOrgBrandRequestToJSON = CreateOrgBrandRequestToJSON;
20
+ exports.CreateOrgBrandRequestToJSONTyped = CreateOrgBrandRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the CreateOrgBrandRequest interface.
23
+ */
24
+ function instanceOfCreateOrgBrandRequest(value) {
25
+ if (!('name' in value) || value['name'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function CreateOrgBrandRequestFromJSON(json) {
30
+ return CreateOrgBrandRequestFromJSONTyped(json, false);
31
+ }
32
+ function CreateOrgBrandRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'companyName': json['companyName'] === undefined ? undefined : json['companyName'] === null ? null : json['companyName'],
38
+ 'vatNumber': json['vatNumber'] === undefined ? undefined : json['vatNumber'] === null ? null : json['vatNumber'],
39
+ 'customs': json['customs'] === undefined ? undefined : json['customs'] === null ? null : json['customs'],
40
+ 'addressLine1': json['addressLine1'] === undefined ? undefined : json['addressLine1'] === null ? null : json['addressLine1'],
41
+ 'addressLine2': json['addressLine2'] === undefined ? undefined : json['addressLine2'] === null ? null : json['addressLine2'],
42
+ 'city': json['city'] === undefined ? undefined : json['city'] === null ? null : json['city'],
43
+ 'postalCode': json['postalCode'] === undefined ? undefined : json['postalCode'] === null ? null : json['postalCode'],
44
+ 'country': json['country'] === undefined ? undefined : json['country'] === null ? null : json['country'],
45
+ 'primaryColor': json['primaryColor'] === undefined ? undefined : json['primaryColor'] === null ? null : json['primaryColor'],
46
+ 'secondaryColor': json['secondaryColor'] === undefined ? undefined : json['secondaryColor'] === null ? null : json['secondaryColor'],
47
+ 'name': json['name'],
48
+ 'slug': json['slug'] == null ? undefined : json['slug'],
49
+ 'useOrgCustoms': json['useOrgCustoms'] == null ? undefined : json['useOrgCustoms'],
50
+ };
51
+ }
52
+ function CreateOrgBrandRequestToJSON(json) {
53
+ return CreateOrgBrandRequestToJSONTyped(json, false);
54
+ }
55
+ function CreateOrgBrandRequestToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ 'companyName': value['companyName'],
61
+ 'vatNumber': value['vatNumber'],
62
+ 'customs': value['customs'],
63
+ 'addressLine1': value['addressLine1'],
64
+ 'addressLine2': value['addressLine2'],
65
+ 'city': value['city'],
66
+ 'postalCode': value['postalCode'],
67
+ 'country': value['country'],
68
+ 'primaryColor': value['primaryColor'],
69
+ 'secondaryColor': value['secondaryColor'],
70
+ 'name': value['name'],
71
+ 'slug': value['slug'],
72
+ 'useOrgCustoms': value['useOrgCustoms'],
73
+ };
74
+ }
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Zippendo Public API
3
- * 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.
3
+ * 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`.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  * Contact: support@zippendo.com
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Zippendo Public API
6
- * 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.
6
+ * 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`.
7
7
  *
8
8
  * The version of the OpenAPI document: 1.0.0
9
9
  * Contact: support@zippendo.com