zippendo 1.0.3 → 1.1.2

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 (351) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -8
  3. data/docs/BatchSplitShipmentRequest.md +1 -1
  4. data/docs/BrandsApi.md +733 -0
  5. data/docs/CheckBrandSlug200Response.md +20 -0
  6. data/docs/CreateOrgBrandRequest.md +42 -0
  7. data/docs/CreateShipment201ResponseParcelsInner.md +2 -2
  8. data/docs/CreateShipment201ResponseTracking.md +2 -2
  9. data/docs/CreateShipmentRequestCarrierSettings.md +1 -1
  10. data/docs/CreateShipmentRequestParcelsInner.md +2 -2
  11. data/docs/CreateShippingRule201Response.md +2 -2
  12. data/docs/CreateShippingRuleRequest.md +2 -2
  13. data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValue.md → CreateShippingRuleRequestAdditionalParametersValue.md} +3 -3
  14. data/docs/{CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md → CreateShippingRuleRequestAdditionalParametersValueAnyOf.md} +3 -3
  15. data/docs/ListOrgBrands200Response.md +18 -0
  16. data/docs/ListOrgBrands200ResponseDataInner.md +54 -0
  17. data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +1 -1
  18. data/docs/ListShippingRules200ResponseDataInner.md +2 -2
  19. data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md → ListShippingRules200ResponseDataInnerAdditionalParametersValue.md} +3 -3
  20. data/docs/{ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOf.md} +3 -3
  21. data/docs/{ListShippingRules200ResponseDataInnerAdditionalParametersInner.md → ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner.md} +2 -7
  22. data/docs/ShipmentsApi.md +1 -1
  23. data/docs/SplitShipmentRequest.md +1 -1
  24. data/docs/UpdateOrgBrandRequest.md +42 -0
  25. data/docs/UpdateShippingRuleRequest.md +2 -2
  26. data/lib/zippendo/api/addresses_api.rb +1 -1
  27. data/lib/zippendo/api/billing_api.rb +1 -1
  28. data/lib/zippendo/api/brands_api.rb +750 -0
  29. data/lib/zippendo/api/carrier_catalog_api.rb +1 -1
  30. data/lib/zippendo/api/carriers_api.rb +1 -1
  31. data/lib/zippendo/api/orders_api.rb +1 -1
  32. data/lib/zippendo/api/orgs_api.rb +1 -1
  33. data/lib/zippendo/api/quotes_api.rb +1 -1
  34. data/lib/zippendo/api/rules_api.rb +1 -1
  35. data/lib/zippendo/api/shipments_api.rb +1 -1
  36. data/lib/zippendo/api/system_api.rb +1 -1
  37. data/lib/zippendo/api/tokens_api.rb +1 -1
  38. data/lib/zippendo/api/webhooks_api.rb +1 -1
  39. data/lib/zippendo/api_client.rb +1 -1
  40. data/lib/zippendo/api_error.rb +1 -1
  41. data/lib/zippendo/api_model_base.rb +1 -1
  42. data/lib/zippendo/configuration.rb +1 -1
  43. data/lib/zippendo/models/batch_send_shipments200_response.rb +1 -1
  44. data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +1 -1
  45. data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +1 -1
  46. data/lib/zippendo/models/batch_send_shipments_request.rb +1 -1
  47. data/lib/zippendo/models/batch_split_shipment201_response.rb +1 -1
  48. data/lib/zippendo/models/batch_split_shipment_request.rb +3 -3
  49. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +1 -1
  50. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +1 -1
  51. data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_inner.rb → check_brand_slug200_response.rb} +37 -46
  52. data/lib/zippendo/models/connect_carrier_request.rb +1 -1
  53. data/lib/zippendo/models/create_address_request.rb +1 -1
  54. data/lib/zippendo/models/create_api_token201_response.rb +1 -1
  55. data/lib/zippendo/models/create_api_token_request.rb +1 -1
  56. data/lib/zippendo/models/create_order201_response.rb +1 -1
  57. data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +1 -1
  58. data/lib/zippendo/models/create_order201_response_shipping_address.rb +1 -1
  59. data/lib/zippendo/models/create_order_request.rb +1 -1
  60. data/lib/zippendo/models/create_order_request_order_lines_inner.rb +1 -1
  61. data/lib/zippendo/models/create_order_request_shipping_address.rb +1 -1
  62. data/lib/zippendo/models/create_org_brand_request.rb +502 -0
  63. data/lib/zippendo/models/create_org_webhook201_response.rb +1 -1
  64. data/lib/zippendo/models/create_org_webhook_request.rb +1 -1
  65. data/lib/zippendo/models/create_shipment201_response.rb +1 -1
  66. data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +1 -1
  67. data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +1 -1
  68. data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +1 -1
  69. data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +1 -1
  70. data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +3 -3
  71. data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +1 -1
  72. data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +1 -1
  73. data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +1 -1
  74. data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +1 -1
  75. data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +1 -1
  76. data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +1 -1
  77. data/lib/zippendo/models/create_shipment201_response_tracking.rb +3 -3
  78. data/lib/zippendo/models/create_shipment_request.rb +1 -1
  79. data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +2 -2
  80. data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +3 -3
  81. data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +1 -1
  82. data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +1 -1
  83. data/lib/zippendo/models/create_shipment_request_parties_inner.rb +1 -1
  84. data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +1 -1
  85. data/lib/zippendo/models/create_shipment_request_pickup_details.rb +1 -1
  86. data/lib/zippendo/models/create_shipping_quote200_response.rb +1 -1
  87. data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +1 -1
  88. data/lib/zippendo/models/create_shipping_quote400_response.rb +1 -1
  89. data/lib/zippendo/models/create_shipping_quote404_response.rb +1 -1
  90. data/lib/zippendo/models/create_shipping_quote_request.rb +1 -1
  91. data/lib/zippendo/models/create_shipping_quote_request_destination.rb +1 -1
  92. data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +1 -1
  93. data/lib/zippendo/models/create_shipping_rule201_response.rb +4 -4
  94. data/lib/zippendo/models/create_shipping_rule_request.rb +6 -3
  95. data/lib/zippendo/models/{list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb → create_shipping_rule_request_additional_parameters_value.rb} +3 -3
  96. data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb → create_shipping_rule_request_additional_parameters_value_any_of.rb} +5 -5
  97. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +1 -1
  98. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +1 -1
  99. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +1 -1
  100. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +1 -1
  101. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +1 -1
  102. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +1 -1
  103. data/lib/zippendo/models/delete_org_webhook200_response.rb +1 -1
  104. data/lib/zippendo/models/delete_shipping_rule200_response.rb +1 -1
  105. data/lib/zippendo/models/get_billing_usage200_response.rb +1 -1
  106. data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +1 -1
  107. data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +1 -1
  108. data/lib/zippendo/models/get_billing_usage200_response_limits.rb +1 -1
  109. data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +1 -1
  110. data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +1 -1
  111. data/lib/zippendo/models/get_order200_response.rb +1 -1
  112. data/lib/zippendo/models/get_order200_response_shipments_inner.rb +1 -1
  113. data/lib/zippendo/models/get_order200_response_shipping_rule.rb +1 -1
  114. data/lib/zippendo/models/get_org200_response.rb +1 -1
  115. data/lib/zippendo/models/get_org200_response_count.rb +1 -1
  116. data/lib/zippendo/models/get_org_branding200_response.rb +1 -1
  117. data/lib/zippendo/models/health_check200_response.rb +1 -1
  118. data/lib/zippendo/models/list_addresses200_response.rb +1 -1
  119. data/lib/zippendo/models/list_addresses200_response_data_inner.rb +1 -1
  120. data/lib/zippendo/models/list_api_tokens200_response.rb +1 -1
  121. data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +1 -1
  122. data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +1 -1
  123. data/lib/zippendo/models/list_api_tokens401_response.rb +1 -1
  124. data/lib/zippendo/models/list_available_carriers200_response_inner.rb +1 -1
  125. data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +1 -1
  126. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +1 -1
  127. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +1 -1
  128. data/lib/zippendo/models/list_carrier_product_service_points_request.rb +1 -1
  129. data/lib/zippendo/models/list_carrier_products200_response_inner.rb +1 -1
  130. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +1 -1
  131. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +1 -1
  132. data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +1 -1
  133. data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +1 -1
  134. data/lib/zippendo/models/list_carriers200_response.rb +1 -1
  135. data/lib/zippendo/models/list_carriers200_response_data_inner.rb +1 -1
  136. data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +1 -1
  137. data/lib/zippendo/models/list_orders200_response.rb +1 -1
  138. data/lib/zippendo/models/list_orders200_response_data_inner.rb +1 -1
  139. data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +1 -1
  140. data/lib/zippendo/models/{list_shipping_rules200_response_data_inner_additional_parameters_inner.rb → list_org_brands200_response.rb} +22 -57
  141. data/lib/zippendo/models/list_org_brands200_response_data_inner.rb +613 -0
  142. data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +1 -1
  143. data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +1 -1
  144. data/lib/zippendo/models/list_org_webhooks200_response.rb +1 -1
  145. data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +1 -1
  146. data/lib/zippendo/models/list_shipments200_response.rb +1 -1
  147. data/lib/zippendo/models/list_shipments200_response_data_inner.rb +1 -1
  148. data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +1 -1
  149. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +2 -2
  150. data/lib/zippendo/models/list_shipping_rules200_response.rb +1 -1
  151. data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +4 -4
  152. data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value.rb → list_shipping_rules200_response_data_inner_additional_parameters_value.rb} +3 -3
  153. data/lib/zippendo/models/{list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb → list_shipping_rules200_response_data_inner_additional_parameters_value_any_of.rb} +5 -5
  154. data/lib/zippendo/models/{create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb → list_shipping_rules200_response_data_inner_additional_parameters_value_any_of_coordinates_inner.rb} +2 -2
  155. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +1 -1
  156. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +1 -1
  157. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +1 -1
  158. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +1 -1
  159. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +1 -1
  160. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +1 -1
  161. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +1 -1
  162. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +1 -1
  163. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +1 -1
  164. data/lib/zippendo/models/revoke_api_token200_response.rb +1 -1
  165. data/lib/zippendo/models/send_shipment422_response.rb +1 -1
  166. data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +1 -1
  167. data/lib/zippendo/models/split_shipment201_response.rb +1 -1
  168. data/lib/zippendo/models/split_shipment_parcel200_response.rb +1 -1
  169. data/lib/zippendo/models/split_shipment_parcel_request.rb +1 -1
  170. data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +1 -1
  171. data/lib/zippendo/models/split_shipment_request.rb +3 -3
  172. data/lib/zippendo/models/test_org_webhook200_response.rb +1 -1
  173. data/lib/zippendo/models/track_shipment200_response.rb +1 -1
  174. data/lib/zippendo/models/track_shipment200_response_events_inner.rb +1 -1
  175. data/lib/zippendo/models/update_address_request.rb +1 -1
  176. data/lib/zippendo/models/update_api_token_request.rb +1 -1
  177. data/lib/zippendo/models/update_carrier_request.rb +1 -1
  178. data/lib/zippendo/models/update_order_request.rb +1 -1
  179. data/lib/zippendo/models/update_org200_response.rb +1 -1
  180. data/lib/zippendo/models/update_org_brand_request.rb +495 -0
  181. data/lib/zippendo/models/update_org_branding_request.rb +1 -1
  182. data/lib/zippendo/models/update_org_request.rb +1 -1
  183. data/lib/zippendo/models/update_org_webhook_request.rb +1 -1
  184. data/lib/zippendo/models/update_shipment_request.rb +1 -1
  185. data/lib/zippendo/models/update_shipping_rule_request.rb +6 -3
  186. data/lib/zippendo/models/verify_api_token200_response.rb +1 -1
  187. data/lib/zippendo/models/verify_api_token_request.rb +1 -1
  188. data/lib/zippendo/version.rb +2 -2
  189. data/lib/zippendo.rb +12 -9
  190. data/spec/spec_helper.rb +1 -1
  191. data/zippendo.gemspec +2 -2
  192. metadata +29 -328
  193. data/docs/CreateShippingRuleRequestAdditionalParameters.md +0 -15
  194. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +0 -20
  195. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +0 -15
  196. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +0 -104
  197. data/spec/api/addresses_api_spec.rb +0 -103
  198. data/spec/api/billing_api_spec.rb +0 -47
  199. data/spec/api/carrier_catalog_api_spec.rb +0 -47
  200. data/spec/api/carriers_api_spec.rb +0 -130
  201. data/spec/api/orders_api_spec.rb +0 -106
  202. data/spec/api/orgs_api_spec.rb +0 -122
  203. data/spec/api/quotes_api_spec.rb +0 -48
  204. data/spec/api/rules_api_spec.rb +0 -102
  205. data/spec/api/shipments_api_spec.rb +0 -213
  206. data/spec/api/system_api_spec.rb +0 -46
  207. data/spec/api/tokens_api_spec.rb +0 -114
  208. data/spec/api/webhooks_api_spec.rb +0 -130
  209. data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +0 -68
  210. data/spec/models/batch_send_shipments200_response_spec.rb +0 -42
  211. data/spec/models/batch_send_shipments200_response_summary_spec.rb +0 -48
  212. data/spec/models/batch_send_shipments_request_spec.rb +0 -36
  213. data/spec/models/batch_split_shipment201_response_spec.rb +0 -42
  214. data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +0 -42
  215. data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +0 -42
  216. data/spec/models/batch_split_shipment_request_spec.rb +0 -66
  217. data/spec/models/connect_carrier_request_spec.rb +0 -48
  218. data/spec/models/create_address_request_spec.rb +0 -106
  219. data/spec/models/create_api_token201_response_spec.rb +0 -84
  220. data/spec/models/create_api_token_request_spec.rb +0 -58
  221. data/spec/models/create_order201_response_order_lines_inner_spec.rb +0 -148
  222. data/spec/models/create_order201_response_shipping_address_spec.rb +0 -108
  223. data/spec/models/create_order201_response_spec.rb +0 -142
  224. data/spec/models/create_order_request_order_lines_inner_spec.rb +0 -148
  225. data/spec/models/create_order_request_shipping_address_spec.rb +0 -108
  226. data/spec/models/create_order_request_spec.rb +0 -102
  227. data/spec/models/create_org_webhook201_response_spec.rb +0 -78
  228. data/spec/models/create_org_webhook_request_spec.rb +0 -58
  229. data/spec/models/create_shipment201_response_activities_inner_spec.rb +0 -64
  230. data/spec/models/create_shipment201_response_documents_inner_spec.rb +0 -90
  231. data/spec/models/create_shipment201_response_errors_inner_spec.rb +0 -60
  232. data/spec/models/create_shipment201_response_logs_inner_spec.rb +0 -82
  233. data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +0 -48
  234. data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +0 -90
  235. data/spec/models/create_shipment201_response_parcels_inner_spec.rb +0 -100
  236. data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +0 -42
  237. data/spec/models/create_shipment201_response_parties_inner_spec.rb +0 -100
  238. data/spec/models/create_shipment201_response_pickup_details_spec.rb +0 -54
  239. data/spec/models/create_shipment201_response_shipping_rule_spec.rb +0 -102
  240. data/spec/models/create_shipment201_response_spec.rb +0 -182
  241. data/spec/models/create_shipment201_response_tracking_spec.rb +0 -66
  242. data/spec/models/create_shipment_request_carrier_settings_spec.rb +0 -54
  243. data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +0 -48
  244. data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +0 -90
  245. data/spec/models/create_shipment_request_parcels_inner_spec.rb +0 -100
  246. data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +0 -42
  247. data/spec/models/create_shipment_request_parties_inner_spec.rb +0 -100
  248. data/spec/models/create_shipment_request_pickup_details_spec.rb +0 -54
  249. data/spec/models/create_shipment_request_spec.rb +0 -116
  250. data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +0 -96
  251. data/spec/models/create_shipping_quote200_response_spec.rb +0 -36
  252. data/spec/models/create_shipping_quote400_response_spec.rb +0 -42
  253. data/spec/models/create_shipping_quote404_response_spec.rb +0 -42
  254. data/spec/models/create_shipping_quote_request_destination_spec.rb +0 -66
  255. data/spec/models/create_shipping_quote_request_items_inner_spec.rb +0 -72
  256. data/spec/models/create_shipping_quote_request_spec.rb +0 -54
  257. data/spec/models/create_shipping_rule201_response_spec.rb +0 -208
  258. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +0 -42
  259. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +0 -21
  260. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +0 -54
  261. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +0 -21
  262. data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +0 -21
  263. data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +0 -78
  264. data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +0 -74
  265. data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +0 -68
  266. data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +0 -52
  267. data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +0 -64
  268. data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +0 -32
  269. data/spec/models/create_shipping_rule_request_spec.rb +0 -184
  270. data/spec/models/delete_org_webhook200_response_spec.rb +0 -36
  271. data/spec/models/delete_shipping_rule200_response_spec.rb +0 -36
  272. data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +0 -58
  273. data/spec/models/get_billing_usage200_response_current_period_spec.rb +0 -42
  274. data/spec/models/get_billing_usage200_response_limits_spec.rb +0 -72
  275. data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +0 -42
  276. data/spec/models/get_billing_usage200_response_shipments_spec.rb +0 -54
  277. data/spec/models/get_billing_usage200_response_spec.rb +0 -54
  278. data/spec/models/get_order200_response_shipments_inner_spec.rb +0 -98
  279. data/spec/models/get_order200_response_shipping_rule_spec.rb +0 -102
  280. data/spec/models/get_order200_response_spec.rb +0 -160
  281. data/spec/models/get_org200_response_count_spec.rb +0 -36
  282. data/spec/models/get_org200_response_spec.rb +0 -132
  283. data/spec/models/get_org_branding200_response_spec.rb +0 -48
  284. data/spec/models/health_check200_response_spec.rb +0 -48
  285. data/spec/models/list_addresses200_response_data_inner_spec.rb +0 -130
  286. data/spec/models/list_addresses200_response_spec.rb +0 -60
  287. data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +0 -48
  288. data/spec/models/list_api_tokens200_response_data_inner_spec.rb +0 -84
  289. data/spec/models/list_api_tokens200_response_spec.rb +0 -60
  290. data/spec/models/list_api_tokens401_response_spec.rb +0 -52
  291. data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +0 -70
  292. data/spec/models/list_available_carriers200_response_inner_spec.rb +0 -96
  293. data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +0 -66
  294. data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +0 -78
  295. data/spec/models/list_carrier_product_service_points_request_spec.rb +0 -66
  296. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +0 -48
  297. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +0 -76
  298. data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +0 -42
  299. data/spec/models/list_carrier_products200_response_inner_spec.rb +0 -100
  300. data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +0 -52
  301. data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +0 -21
  302. data/spec/models/list_carriers200_response_data_inner_spec.rb +0 -96
  303. data/spec/models/list_carriers200_response_spec.rb +0 -60
  304. data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +0 -52
  305. data/spec/models/list_orders200_response_data_inner_spec.rb +0 -112
  306. data/spec/models/list_orders200_response_spec.rb +0 -60
  307. data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +0 -96
  308. data/spec/models/list_org_webhook_deliveries200_response_spec.rb +0 -60
  309. data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +0 -72
  310. data/spec/models/list_org_webhooks200_response_spec.rb +0 -60
  311. data/spec/models/list_shipments200_response_data_inner_address_spec.rb +0 -130
  312. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +0 -54
  313. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +0 -21
  314. data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +0 -54
  315. data/spec/models/list_shipments200_response_data_inner_spec.rb +0 -92
  316. data/spec/models/list_shipments200_response_spec.rb +0 -60
  317. data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +0 -42
  318. data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +0 -72
  319. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +0 -78
  320. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +0 -74
  321. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +0 -68
  322. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +0 -52
  323. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +0 -64
  324. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +0 -32
  325. data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +0 -42
  326. data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +0 -42
  327. data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +0 -238
  328. data/spec/models/list_shipping_rules200_response_spec.rb +0 -60
  329. data/spec/models/revoke_api_token200_response_spec.rb +0 -36
  330. data/spec/models/send_shipment422_response_errors_inner_spec.rb +0 -42
  331. data/spec/models/send_shipment422_response_spec.rb +0 -58
  332. data/spec/models/split_shipment201_response_spec.rb +0 -42
  333. data/spec/models/split_shipment_parcel200_response_spec.rb +0 -36
  334. data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +0 -42
  335. data/spec/models/split_shipment_parcel_request_spec.rb +0 -36
  336. data/spec/models/split_shipment_request_spec.rb +0 -72
  337. data/spec/models/test_org_webhook200_response_spec.rb +0 -36
  338. data/spec/models/track_shipment200_response_events_inner_spec.rb +0 -70
  339. data/spec/models/track_shipment200_response_spec.rb +0 -64
  340. data/spec/models/update_address_request_spec.rb +0 -106
  341. data/spec/models/update_api_token_request_spec.rb +0 -36
  342. data/spec/models/update_carrier_request_spec.rb +0 -48
  343. data/spec/models/update_order_request_spec.rb +0 -100
  344. data/spec/models/update_org200_response_spec.rb +0 -126
  345. data/spec/models/update_org_branding_request_spec.rb +0 -42
  346. data/spec/models/update_org_request_spec.rb +0 -118
  347. data/spec/models/update_org_webhook_request_spec.rb +0 -58
  348. data/spec/models/update_shipment_request_spec.rb +0 -122
  349. data/spec/models/update_shipping_rule_request_spec.rb +0 -184
  350. data/spec/models/verify_api_token200_response_spec.rb +0 -66
  351. data/spec/models/verify_api_token_request_spec.rb +0 -36
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -30,7 +30,7 @@ module Zippendo
30
30
  # Service codes for all new shipments. Copied from the original if omitted.
31
31
  attr_accessor :services
32
32
 
33
- # Carrier-specific parameters for all new shipments.
33
+ # Carrier-specific parameters for all new shipments. Copied from the original if omitted.
34
34
  attr_accessor :additional_parameters
35
35
 
36
36
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -63,7 +63,7 @@ module Zippendo
63
63
  :'carrier_id' => :'String',
64
64
  :'product_id' => :'String',
65
65
  :'services' => :'Array<String>',
66
- :'additional_parameters' => :'Hash<String, Object>'
66
+ :'additional_parameters' => :'Hash<String, CreateShippingRuleRequestAdditionalParametersValue>'
67
67
  }
68
68
  end
69
69
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -14,18 +14,18 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Zippendo
17
- class CreateShippingRuleRequestAdditionalParametersAnyOfInner < ApiModelBase
18
- # Carrier parameter key
19
- attr_accessor :name
17
+ class CheckBrandSlug200Response < ApiModelBase
18
+ # The slug that was checked
19
+ attr_accessor :slug
20
20
 
21
- # Parameter value (stringified)
22
- attr_accessor :val
21
+ # Whether the slug is free within this organization
22
+ attr_accessor :available
23
23
 
24
24
  # Attribute mapping from ruby-style variable name to JSON key.
25
25
  def self.attribute_map
26
26
  {
27
- :'name' => :'name',
28
- :'val' => :'val'
27
+ :'slug' => :'slug',
28
+ :'available' => :'available'
29
29
  }
30
30
  end
31
31
 
@@ -42,8 +42,8 @@ module Zippendo
42
42
  # Attribute type mapping.
43
43
  def self.openapi_types
44
44
  {
45
- :'name' => :'String',
46
- :'val' => :'String'
45
+ :'slug' => :'String',
46
+ :'available' => :'Boolean'
47
47
  }
48
48
  end
49
49
 
@@ -57,28 +57,28 @@ module Zippendo
57
57
  # @param [Hash] attributes Model attributes in the form of hash
58
58
  def initialize(attributes = {})
59
59
  if (!attributes.is_a?(Hash))
60
- fail ArgumentError, "The input argument (attributes) must be a hash in `Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfInner` initialize method"
60
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zippendo::CheckBrandSlug200Response` initialize method"
61
61
  end
62
62
 
63
63
  # check to see if the attribute exists and convert string to symbol for hash key
64
64
  acceptable_attribute_map = self.class.acceptable_attribute_map
65
65
  attributes = attributes.each_with_object({}) { |(k, v), h|
66
66
  if (!acceptable_attribute_map.key?(k.to_sym))
67
- fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
67
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::CheckBrandSlug200Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
68
68
  end
69
69
  h[k.to_sym] = v
70
70
  }
71
71
 
72
- if attributes.key?(:'name')
73
- self.name = attributes[:'name']
72
+ if attributes.key?(:'slug')
73
+ self.slug = attributes[:'slug']
74
74
  else
75
- self.name = nil
75
+ self.slug = nil
76
76
  end
77
77
 
78
- if attributes.key?(:'val')
79
- self.val = attributes[:'val']
78
+ if attributes.key?(:'available')
79
+ self.available = attributes[:'available']
80
80
  else
81
- self.val = nil
81
+ self.available = nil
82
82
  end
83
83
  end
84
84
 
@@ -87,16 +87,12 @@ module Zippendo
87
87
  def list_invalid_properties
88
88
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
89
89
  invalid_properties = Array.new
90
- if @name.nil?
91
- invalid_properties.push('invalid value for "name", name cannot be nil.')
90
+ if @slug.nil?
91
+ invalid_properties.push('invalid value for "slug", slug cannot be nil.')
92
92
  end
93
93
 
94
- if @name.to_s.length < 1
95
- invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
96
- end
97
-
98
- if @val.nil?
99
- invalid_properties.push('invalid value for "val", val cannot be nil.')
94
+ if @available.nil?
95
+ invalid_properties.push('invalid value for "available", available cannot be nil.')
100
96
  end
101
97
 
102
98
  invalid_properties
@@ -106,34 +102,29 @@ module Zippendo
106
102
  # @return true if the model is valid
107
103
  def valid?
108
104
  warn '[DEPRECATED] the `valid?` method is obsolete'
109
- return false if @name.nil?
110
- return false if @name.to_s.length < 1
111
- return false if @val.nil?
105
+ return false if @slug.nil?
106
+ return false if @available.nil?
112
107
  true
113
108
  end
114
109
 
115
110
  # Custom attribute writer method with validation
116
- # @param [Object] name Value to be assigned
117
- def name=(name)
118
- if name.nil?
119
- fail ArgumentError, 'name cannot be nil'
120
- end
121
-
122
- if name.to_s.length < 1
123
- fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
111
+ # @param [Object] slug Value to be assigned
112
+ def slug=(slug)
113
+ if slug.nil?
114
+ fail ArgumentError, 'slug cannot be nil'
124
115
  end
125
116
 
126
- @name = name
117
+ @slug = slug
127
118
  end
128
119
 
129
120
  # Custom attribute writer method with validation
130
- # @param [Object] val Value to be assigned
131
- def val=(val)
132
- if val.nil?
133
- fail ArgumentError, 'val cannot be nil'
121
+ # @param [Object] available Value to be assigned
122
+ def available=(available)
123
+ if available.nil?
124
+ fail ArgumentError, 'available cannot be nil'
134
125
  end
135
126
 
136
- @val = val
127
+ @available = available
137
128
  end
138
129
 
139
130
  # Checks equality by comparing each attribute.
@@ -141,8 +132,8 @@ module Zippendo
141
132
  def ==(o)
142
133
  return true if self.equal?(o)
143
134
  self.class == o.class &&
144
- name == o.name &&
145
- val == o.val
135
+ slug == o.slug &&
136
+ available == o.available
146
137
  end
147
138
 
148
139
  # @see the `==` method
@@ -154,7 +145,7 @@ module Zippendo
154
145
  # Calculates hash code according to all attributes.
155
146
  # @return [Integer] Hash code
156
147
  def hash
157
- [name, val].hash
148
+ [slug, available].hash
158
149
  end
159
150
 
160
151
  # Builds the object from hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Zippendo Public API
3
3
 
4
- #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.
4
+ #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`.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com