zippendo 1.0.2 → 1.0.3

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 (328) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +39 -0
  3. data/docs/CreateApiToken201Response.md +2 -0
  4. data/docs/CreateApiTokenRequest.md +3 -1
  5. data/docs/ListApiTokens200ResponseDataInner.md +2 -0
  6. data/docs/ListOrders200ResponseDataInner.md +2 -0
  7. data/docs/ListShipments200ResponseDataInner.md +2 -0
  8. data/docs/OrdersApi.md +2 -0
  9. data/docs/ShipmentsApi.md +3 -1
  10. data/lib/zippendo/api/addresses_api.rb +1 -1
  11. data/lib/zippendo/api/billing_api.rb +1 -1
  12. data/lib/zippendo/api/carrier_catalog_api.rb +1 -1
  13. data/lib/zippendo/api/carriers_api.rb +1 -1
  14. data/lib/zippendo/api/orders_api.rb +4 -1
  15. data/lib/zippendo/api/orgs_api.rb +1 -1
  16. data/lib/zippendo/api/quotes_api.rb +1 -1
  17. data/lib/zippendo/api/rules_api.rb +1 -1
  18. data/lib/zippendo/api/shipments_api.rb +4 -1
  19. data/lib/zippendo/api/system_api.rb +1 -1
  20. data/lib/zippendo/api/tokens_api.rb +1 -1
  21. data/lib/zippendo/api/webhooks_api.rb +1 -1
  22. data/lib/zippendo/api_client.rb +1 -1
  23. data/lib/zippendo/api_error.rb +1 -1
  24. data/lib/zippendo/api_model_base.rb +1 -1
  25. data/lib/zippendo/configuration.rb +1 -1
  26. data/lib/zippendo/models/batch_send_shipments200_response.rb +1 -1
  27. data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +3 -3
  28. data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +1 -1
  29. data/lib/zippendo/models/batch_send_shipments_request.rb +1 -1
  30. data/lib/zippendo/models/batch_split_shipment201_response.rb +1 -1
  31. data/lib/zippendo/models/batch_split_shipment_request.rb +1 -1
  32. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +1 -1
  33. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +1 -1
  34. data/lib/zippendo/models/connect_carrier_request.rb +1 -1
  35. data/lib/zippendo/models/create_address_request.rb +1 -1
  36. data/lib/zippendo/models/create_api_token201_response.rb +15 -2
  37. data/lib/zippendo/models/create_api_token_request.rb +16 -5
  38. data/lib/zippendo/models/create_order201_response.rb +1 -1
  39. data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +1 -1
  40. data/lib/zippendo/models/create_order201_response_shipping_address.rb +1 -1
  41. data/lib/zippendo/models/create_order_request.rb +1 -1
  42. data/lib/zippendo/models/create_order_request_order_lines_inner.rb +1 -1
  43. data/lib/zippendo/models/create_order_request_shipping_address.rb +1 -1
  44. data/lib/zippendo/models/create_org_webhook201_response.rb +1 -1
  45. data/lib/zippendo/models/create_org_webhook_request.rb +1 -1
  46. data/lib/zippendo/models/create_shipment201_response.rb +1 -1
  47. data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +1 -1
  48. data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +1 -1
  49. data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +1 -1
  50. data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +1 -1
  51. data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +1 -1
  52. data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +1 -1
  53. data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +1 -1
  54. data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +1 -1
  55. data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +1 -1
  56. data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +1 -1
  57. data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +1 -1
  58. data/lib/zippendo/models/create_shipment201_response_tracking.rb +1 -1
  59. data/lib/zippendo/models/create_shipment_request.rb +1 -1
  60. data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +1 -1
  61. data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +1 -1
  62. data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +1 -1
  63. data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +1 -1
  64. data/lib/zippendo/models/create_shipment_request_parties_inner.rb +1 -1
  65. data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +1 -1
  66. data/lib/zippendo/models/create_shipment_request_pickup_details.rb +1 -1
  67. data/lib/zippendo/models/create_shipping_quote200_response.rb +1 -1
  68. data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +1 -1
  69. data/lib/zippendo/models/create_shipping_quote400_response.rb +1 -1
  70. data/lib/zippendo/models/create_shipping_quote404_response.rb +1 -1
  71. data/lib/zippendo/models/create_shipping_quote_request.rb +1 -1
  72. data/lib/zippendo/models/create_shipping_quote_request_destination.rb +1 -1
  73. data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +1 -1
  74. data/lib/zippendo/models/create_shipping_rule201_response.rb +1 -1
  75. data/lib/zippendo/models/create_shipping_rule_request.rb +1 -1
  76. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +1 -1
  77. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb +1 -1
  78. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb +1 -1
  79. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb +1 -1
  80. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb +1 -1
  81. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +1 -1
  82. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +1 -1
  83. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +1 -1
  84. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +1 -1
  85. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +1 -1
  86. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +1 -1
  87. data/lib/zippendo/models/delete_org_webhook200_response.rb +1 -1
  88. data/lib/zippendo/models/delete_shipping_rule200_response.rb +1 -1
  89. data/lib/zippendo/models/get_billing_usage200_response.rb +1 -1
  90. data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +1 -1
  91. data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +1 -1
  92. data/lib/zippendo/models/get_billing_usage200_response_limits.rb +1 -1
  93. data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +1 -1
  94. data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +1 -1
  95. data/lib/zippendo/models/get_order200_response.rb +1 -1
  96. data/lib/zippendo/models/get_order200_response_shipments_inner.rb +1 -1
  97. data/lib/zippendo/models/get_order200_response_shipping_rule.rb +1 -1
  98. data/lib/zippendo/models/get_org200_response.rb +1 -1
  99. data/lib/zippendo/models/get_org200_response_count.rb +1 -1
  100. data/lib/zippendo/models/get_org_branding200_response.rb +1 -1
  101. data/lib/zippendo/models/health_check200_response.rb +1 -1
  102. data/lib/zippendo/models/list_addresses200_response.rb +1 -1
  103. data/lib/zippendo/models/list_addresses200_response_data_inner.rb +1 -1
  104. data/lib/zippendo/models/list_api_tokens200_response.rb +1 -1
  105. data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +15 -2
  106. data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +1 -1
  107. data/lib/zippendo/models/list_api_tokens401_response.rb +3 -3
  108. data/lib/zippendo/models/list_available_carriers200_response_inner.rb +1 -1
  109. data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +1 -1
  110. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +1 -1
  111. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +1 -1
  112. data/lib/zippendo/models/list_carrier_product_service_points_request.rb +1 -1
  113. data/lib/zippendo/models/list_carrier_products200_response_inner.rb +1 -1
  114. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +1 -1
  115. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +1 -1
  116. data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +1 -1
  117. data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +1 -1
  118. data/lib/zippendo/models/list_carriers200_response.rb +1 -1
  119. data/lib/zippendo/models/list_carriers200_response_data_inner.rb +1 -1
  120. data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +1 -1
  121. data/lib/zippendo/models/list_orders200_response.rb +1 -1
  122. data/lib/zippendo/models/list_orders200_response_data_inner.rb +15 -2
  123. data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +1 -1
  124. data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +1 -1
  125. data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +1 -1
  126. data/lib/zippendo/models/list_org_webhooks200_response.rb +1 -1
  127. data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +1 -1
  128. data/lib/zippendo/models/list_shipments200_response.rb +1 -1
  129. data/lib/zippendo/models/list_shipments200_response_data_inner.rb +15 -2
  130. data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +1 -1
  131. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +1 -1
  132. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb +1 -1
  133. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb +1 -1
  134. data/lib/zippendo/models/list_shipping_rules200_response.rb +1 -1
  135. data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +1 -1
  136. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb +1 -1
  137. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +1 -1
  138. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +1 -1
  139. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +1 -1
  140. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +1 -1
  141. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +1 -1
  142. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +1 -1
  143. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +1 -1
  144. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +1 -1
  145. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +1 -1
  146. data/lib/zippendo/models/revoke_api_token200_response.rb +1 -1
  147. data/lib/zippendo/models/send_shipment422_response.rb +3 -3
  148. data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +1 -1
  149. data/lib/zippendo/models/split_shipment201_response.rb +1 -1
  150. data/lib/zippendo/models/split_shipment_parcel200_response.rb +1 -1
  151. data/lib/zippendo/models/split_shipment_parcel_request.rb +1 -1
  152. data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +1 -1
  153. data/lib/zippendo/models/split_shipment_request.rb +1 -1
  154. data/lib/zippendo/models/test_org_webhook200_response.rb +1 -1
  155. data/lib/zippendo/models/track_shipment200_response.rb +1 -1
  156. data/lib/zippendo/models/track_shipment200_response_events_inner.rb +1 -1
  157. data/lib/zippendo/models/update_address_request.rb +1 -1
  158. data/lib/zippendo/models/update_api_token_request.rb +1 -1
  159. data/lib/zippendo/models/update_carrier_request.rb +1 -1
  160. data/lib/zippendo/models/update_order_request.rb +1 -1
  161. data/lib/zippendo/models/update_org200_response.rb +1 -1
  162. data/lib/zippendo/models/update_org_branding_request.rb +1 -1
  163. data/lib/zippendo/models/update_org_request.rb +1 -1
  164. data/lib/zippendo/models/update_org_webhook_request.rb +1 -1
  165. data/lib/zippendo/models/update_shipment_request.rb +1 -1
  166. data/lib/zippendo/models/update_shipping_rule_request.rb +1 -1
  167. data/lib/zippendo/models/verify_api_token200_response.rb +1 -1
  168. data/lib/zippendo/models/verify_api_token_request.rb +1 -1
  169. data/lib/zippendo/version.rb +2 -2
  170. data/lib/zippendo.rb +1 -1
  171. data/spec/api/addresses_api_spec.rb +1 -1
  172. data/spec/api/billing_api_spec.rb +1 -1
  173. data/spec/api/carrier_catalog_api_spec.rb +1 -1
  174. data/spec/api/carriers_api_spec.rb +1 -1
  175. data/spec/api/orders_api_spec.rb +2 -1
  176. data/spec/api/orgs_api_spec.rb +1 -1
  177. data/spec/api/quotes_api_spec.rb +1 -1
  178. data/spec/api/rules_api_spec.rb +1 -1
  179. data/spec/api/shipments_api_spec.rb +2 -1
  180. data/spec/api/system_api_spec.rb +1 -1
  181. data/spec/api/tokens_api_spec.rb +1 -1
  182. data/spec/api/webhooks_api_spec.rb +1 -1
  183. data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +2 -2
  184. data/spec/models/batch_send_shipments200_response_spec.rb +1 -1
  185. data/spec/models/batch_send_shipments200_response_summary_spec.rb +1 -1
  186. data/spec/models/batch_send_shipments_request_spec.rb +1 -1
  187. data/spec/models/batch_split_shipment201_response_spec.rb +1 -1
  188. data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +1 -1
  189. data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +1 -1
  190. data/spec/models/batch_split_shipment_request_spec.rb +1 -1
  191. data/spec/models/connect_carrier_request_spec.rb +1 -1
  192. data/spec/models/create_address_request_spec.rb +1 -1
  193. data/spec/models/create_api_token201_response_spec.rb +7 -1
  194. data/spec/models/create_api_token_request_spec.rb +7 -1
  195. data/spec/models/create_order201_response_order_lines_inner_spec.rb +1 -1
  196. data/spec/models/create_order201_response_shipping_address_spec.rb +1 -1
  197. data/spec/models/create_order201_response_spec.rb +1 -1
  198. data/spec/models/create_order_request_order_lines_inner_spec.rb +1 -1
  199. data/spec/models/create_order_request_shipping_address_spec.rb +1 -1
  200. data/spec/models/create_order_request_spec.rb +1 -1
  201. data/spec/models/create_org_webhook201_response_spec.rb +1 -1
  202. data/spec/models/create_org_webhook_request_spec.rb +1 -1
  203. data/spec/models/create_shipment201_response_activities_inner_spec.rb +1 -1
  204. data/spec/models/create_shipment201_response_documents_inner_spec.rb +1 -1
  205. data/spec/models/create_shipment201_response_errors_inner_spec.rb +1 -1
  206. data/spec/models/create_shipment201_response_logs_inner_spec.rb +1 -1
  207. data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +1 -1
  208. data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +1 -1
  209. data/spec/models/create_shipment201_response_parcels_inner_spec.rb +1 -1
  210. data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +1 -1
  211. data/spec/models/create_shipment201_response_parties_inner_spec.rb +1 -1
  212. data/spec/models/create_shipment201_response_pickup_details_spec.rb +1 -1
  213. data/spec/models/create_shipment201_response_shipping_rule_spec.rb +1 -1
  214. data/spec/models/create_shipment201_response_spec.rb +1 -1
  215. data/spec/models/create_shipment201_response_tracking_spec.rb +1 -1
  216. data/spec/models/create_shipment_request_carrier_settings_spec.rb +1 -1
  217. data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +1 -1
  218. data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +1 -1
  219. data/spec/models/create_shipment_request_parcels_inner_spec.rb +1 -1
  220. data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +1 -1
  221. data/spec/models/create_shipment_request_parties_inner_spec.rb +1 -1
  222. data/spec/models/create_shipment_request_pickup_details_spec.rb +1 -1
  223. data/spec/models/create_shipment_request_spec.rb +1 -1
  224. data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +1 -1
  225. data/spec/models/create_shipping_quote200_response_spec.rb +1 -1
  226. data/spec/models/create_shipping_quote400_response_spec.rb +1 -1
  227. data/spec/models/create_shipping_quote404_response_spec.rb +1 -1
  228. data/spec/models/create_shipping_quote_request_destination_spec.rb +1 -1
  229. data/spec/models/create_shipping_quote_request_items_inner_spec.rb +1 -1
  230. data/spec/models/create_shipping_quote_request_spec.rb +1 -1
  231. data/spec/models/create_shipping_rule201_response_spec.rb +1 -1
  232. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +1 -1
  233. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +1 -1
  234. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +1 -1
  235. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +1 -1
  236. data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +1 -1
  237. data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +1 -1
  238. data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +1 -1
  239. data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +1 -1
  240. data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +1 -1
  241. data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +1 -1
  242. data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +1 -1
  243. data/spec/models/create_shipping_rule_request_spec.rb +1 -1
  244. data/spec/models/delete_org_webhook200_response_spec.rb +1 -1
  245. data/spec/models/delete_shipping_rule200_response_spec.rb +1 -1
  246. data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +1 -1
  247. data/spec/models/get_billing_usage200_response_current_period_spec.rb +1 -1
  248. data/spec/models/get_billing_usage200_response_limits_spec.rb +1 -1
  249. data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +1 -1
  250. data/spec/models/get_billing_usage200_response_shipments_spec.rb +1 -1
  251. data/spec/models/get_billing_usage200_response_spec.rb +1 -1
  252. data/spec/models/get_order200_response_shipments_inner_spec.rb +1 -1
  253. data/spec/models/get_order200_response_shipping_rule_spec.rb +1 -1
  254. data/spec/models/get_order200_response_spec.rb +1 -1
  255. data/spec/models/get_org200_response_count_spec.rb +1 -1
  256. data/spec/models/get_org200_response_spec.rb +1 -1
  257. data/spec/models/get_org_branding200_response_spec.rb +1 -1
  258. data/spec/models/health_check200_response_spec.rb +1 -1
  259. data/spec/models/list_addresses200_response_data_inner_spec.rb +1 -1
  260. data/spec/models/list_addresses200_response_spec.rb +1 -1
  261. data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +1 -1
  262. data/spec/models/list_api_tokens200_response_data_inner_spec.rb +7 -1
  263. data/spec/models/list_api_tokens200_response_spec.rb +1 -1
  264. data/spec/models/list_api_tokens401_response_spec.rb +2 -2
  265. data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +1 -1
  266. data/spec/models/list_available_carriers200_response_inner_spec.rb +1 -1
  267. data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +1 -1
  268. data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +1 -1
  269. data/spec/models/list_carrier_product_service_points_request_spec.rb +1 -1
  270. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +1 -1
  271. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +1 -1
  272. data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +1 -1
  273. data/spec/models/list_carrier_products200_response_inner_spec.rb +1 -1
  274. data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +1 -1
  275. data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +1 -1
  276. data/spec/models/list_carriers200_response_data_inner_spec.rb +1 -1
  277. data/spec/models/list_carriers200_response_spec.rb +1 -1
  278. data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +1 -1
  279. data/spec/models/list_orders200_response_data_inner_spec.rb +7 -1
  280. data/spec/models/list_orders200_response_spec.rb +1 -1
  281. data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +1 -1
  282. data/spec/models/list_org_webhook_deliveries200_response_spec.rb +1 -1
  283. data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +1 -1
  284. data/spec/models/list_org_webhooks200_response_spec.rb +1 -1
  285. data/spec/models/list_shipments200_response_data_inner_address_spec.rb +1 -1
  286. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +1 -1
  287. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +1 -1
  288. data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +1 -1
  289. data/spec/models/list_shipments200_response_data_inner_spec.rb +7 -1
  290. data/spec/models/list_shipments200_response_spec.rb +1 -1
  291. data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +1 -1
  292. data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +1 -1
  293. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +1 -1
  294. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +1 -1
  295. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +1 -1
  296. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +1 -1
  297. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +1 -1
  298. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +1 -1
  299. data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +1 -1
  300. data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +1 -1
  301. data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +1 -1
  302. data/spec/models/list_shipping_rules200_response_spec.rb +1 -1
  303. data/spec/models/revoke_api_token200_response_spec.rb +1 -1
  304. data/spec/models/send_shipment422_response_errors_inner_spec.rb +1 -1
  305. data/spec/models/send_shipment422_response_spec.rb +2 -2
  306. data/spec/models/split_shipment201_response_spec.rb +1 -1
  307. data/spec/models/split_shipment_parcel200_response_spec.rb +1 -1
  308. data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +1 -1
  309. data/spec/models/split_shipment_parcel_request_spec.rb +1 -1
  310. data/spec/models/split_shipment_request_spec.rb +1 -1
  311. data/spec/models/test_org_webhook200_response_spec.rb +1 -1
  312. data/spec/models/track_shipment200_response_events_inner_spec.rb +1 -1
  313. data/spec/models/track_shipment200_response_spec.rb +1 -1
  314. data/spec/models/update_address_request_spec.rb +1 -1
  315. data/spec/models/update_api_token_request_spec.rb +1 -1
  316. data/spec/models/update_carrier_request_spec.rb +1 -1
  317. data/spec/models/update_order_request_spec.rb +1 -1
  318. data/spec/models/update_org200_response_spec.rb +1 -1
  319. data/spec/models/update_org_branding_request_spec.rb +1 -1
  320. data/spec/models/update_org_request_spec.rb +1 -1
  321. data/spec/models/update_org_webhook_request_spec.rb +1 -1
  322. data/spec/models/update_shipment_request_spec.rb +1 -1
  323. data/spec/models/update_shipping_rule_request_spec.rb +1 -1
  324. data/spec/models/verify_api_token200_response_spec.rb +1 -1
  325. data/spec/models/verify_api_token_request_spec.rb +1 -1
  326. data/spec/spec_helper.rb +1 -1
  327. data/zippendo.gemspec +2 -2
  328. metadata +17 -3
@@ -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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -30,6 +30,9 @@ module Zippendo
30
30
  # Order fulfilment status derived from its shipments.
31
31
  attr_accessor :status
32
32
 
33
+ # Brand this record belongs to, or null when it is organization-wide
34
+ attr_accessor :brand_id
35
+
33
36
  # Order subtotal before shipping and tax.
34
37
  attr_accessor :subtotal_amount
35
38
 
@@ -80,6 +83,7 @@ module Zippendo
80
83
  :'customer_name' => :'customerName',
81
84
  :'customer_email' => :'customerEmail',
82
85
  :'status' => :'status',
86
+ :'brand_id' => :'brandId',
83
87
  :'subtotal_amount' => :'subtotalAmount',
84
88
  :'total_amount' => :'totalAmount',
85
89
  :'currency' => :'currency',
@@ -108,6 +112,7 @@ module Zippendo
108
112
  :'customer_name' => :'String',
109
113
  :'customer_email' => :'String',
110
114
  :'status' => :'String',
115
+ :'brand_id' => :'String',
111
116
  :'subtotal_amount' => :'Float',
112
117
  :'total_amount' => :'Float',
113
118
  :'currency' => :'String',
@@ -123,6 +128,7 @@ module Zippendo
123
128
  Set.new([
124
129
  :'customer_name',
125
130
  :'customer_email',
131
+ :'brand_id',
126
132
  :'subtotal_amount',
127
133
  :'total_amount',
128
134
  :'currency',
@@ -171,6 +177,12 @@ module Zippendo
171
177
  self.status = nil
172
178
  end
173
179
 
180
+ if attributes.key?(:'brand_id')
181
+ self.brand_id = attributes[:'brand_id']
182
+ else
183
+ self.brand_id = nil
184
+ end
185
+
174
186
  if attributes.key?(:'subtotal_amount')
175
187
  self.subtotal_amount = attributes[:'subtotal_amount']
176
188
  end
@@ -358,6 +370,7 @@ module Zippendo
358
370
  customer_name == o.customer_name &&
359
371
  customer_email == o.customer_email &&
360
372
  status == o.status &&
373
+ brand_id == o.brand_id &&
361
374
  subtotal_amount == o.subtotal_amount &&
362
375
  total_amount == o.total_amount &&
363
376
  currency == o.currency &&
@@ -376,7 +389,7 @@ module Zippendo
376
389
  # Calculates hash code according to all attributes.
377
390
  # @return [Integer] Hash code
378
391
  def hash
379
- [id, order_number, customer_name, customer_email, status, subtotal_amount, total_amount, currency, shipment_count, order_channel, created_at, updated_at].hash
392
+ [id, order_number, customer_name, customer_email, status, brand_id, subtotal_amount, total_amount, currency, shipment_count, order_channel, created_at, updated_at].hash
380
393
  end
381
394
 
382
395
  # 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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -29,6 +29,9 @@ module Zippendo
29
29
  # Lifecycle status of the shipment.
30
30
  attr_accessor :status
31
31
 
32
+ # Brand this record belongs to, or null when it is organization-wide
33
+ attr_accessor :brand_id
34
+
32
35
  attr_accessor :address
33
36
 
34
37
  # Timestamp when the shipment was created.
@@ -67,6 +70,7 @@ module Zippendo
67
70
  :'type' => :'type',
68
71
  :'carrier_settings' => :'carrierSettings',
69
72
  :'status' => :'status',
73
+ :'brand_id' => :'brandId',
70
74
  :'address' => :'address',
71
75
  :'created_at' => :'createdAt',
72
76
  :'updated_at' => :'updatedAt'
@@ -91,6 +95,7 @@ module Zippendo
91
95
  :'type' => :'String',
92
96
  :'carrier_settings' => :'ListShipments200ResponseDataInnerCarrierSettings',
93
97
  :'status' => :'String',
98
+ :'brand_id' => :'String',
94
99
  :'address' => :'ListShipments200ResponseDataInnerAddress',
95
100
  :'created_at' => :'String',
96
101
  :'updated_at' => :'String'
@@ -100,6 +105,7 @@ module Zippendo
100
105
  # List of attributes with nullable: true
101
106
  def self.openapi_nullable
102
107
  Set.new([
108
+ :'brand_id',
103
109
  :'address',
104
110
  ])
105
111
  end
@@ -150,6 +156,12 @@ module Zippendo
150
156
  self.status = nil
151
157
  end
152
158
 
159
+ if attributes.key?(:'brand_id')
160
+ self.brand_id = attributes[:'brand_id']
161
+ else
162
+ self.brand_id = nil
163
+ end
164
+
153
165
  if attributes.key?(:'address')
154
166
  self.address = attributes[:'address']
155
167
  end
@@ -301,6 +313,7 @@ module Zippendo
301
313
  type == o.type &&
302
314
  carrier_settings == o.carrier_settings &&
303
315
  status == o.status &&
316
+ brand_id == o.brand_id &&
304
317
  address == o.address &&
305
318
  created_at == o.created_at &&
306
319
  updated_at == o.updated_at
@@ -315,7 +328,7 @@ module Zippendo
315
328
  # Calculates hash code according to all attributes.
316
329
  # @return [Integer] Hash code
317
330
  def hash
318
- [id, reference, type, carrier_settings, status, address, created_at, updated_at].hash
331
+ [id, reference, type, carrier_settings, status, brand_id, address, created_at, updated_at].hash
319
332
  end
320
333
 
321
334
  # 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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
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_).
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.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com
@@ -150,7 +150,7 @@ module Zippendo
150
150
  # @return true if the model is valid
151
151
  def valid?
152
152
  warn '[DEPRECATED] the `valid?` method is obsolete'
153
- code_validator = EnumAttributeValidator.new('String', ["INTERNAL_ERROR", "BAD_REQUEST", "VALIDATION_FAILED", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "PAYLOAD_TOO_LARGE", "IMAGE_DIMENSIONS_EXCEEDED", "NOT_IMPLEMENTED", "AUTH_INVALID_CREDENTIALS", "AUTH_TOKEN_INVALID", "AUTH_TOKEN_EXPIRED", "AUTH_EMAIL_NOT_VERIFIED", "AUTH_EMAIL_EXISTS", "AUTH_OAUTH_FAILED", "AUTH_SIGNUP_NOT_ALLOWED", "AUTH_VERIFICATION_FAILED", "AUTH_RESET_TOKEN_INVALID", "AUTH_MFA_REQUIRED", "AUTH_MFA_INVALID_CODE", "AUTH_MFA_ALREADY_ENABLED", "AUTH_MFA_NOT_ENABLED", "SESSION_REQUIRED", "ORG_NOT_FOUND", "ORG_ACCESS_DENIED", "ORG_DISABLED", "ORG_SLUG_EXISTS", "USER_NOT_FOUND", "USER_EXISTS", "MEMBER_NOT_FOUND", "ROLE_NOT_FOUND", "ROLE_NAME_EXISTS", "ROLE_IN_USE", "MEMBER_EXISTS", "INVITATION_NOT_FOUND", "INVITATION_EXPIRED", "INVITATION_EMAIL_FAILED", "TOKEN_NOT_FOUND", "BILLING_PAYMENT_FAILED", "BILLING_NO_SUBSCRIPTION", "BILLING_TAX_ID_INVALID", "BILLING_PLAN_INVALID", "BILLING_OPERATION_FAILED", "FEATURE_NOT_AVAILABLE", "RESOURCE_LIMIT_REACHED", "PLAN_LIMITS_EXCEEDED", "NO_SUBSCRIPTION", "SUBSCRIPTION_INACTIVE", "BILLING_MANAGED_BY_SHOPIFY", "BILLING_CHECKOUT_REQUIRED", "SHIPMENT_NOT_FOUND", "SHIPMENT_DOCUMENT_NOT_FOUND", "SHIPMENT_ALREADY_SENT", "SHIPMENT_INVALID_STATE", "PARCEL_NOT_FOUND", "PARCEL_INVALID_SPLIT", "PICKUP_NOT_FOUND", "PICKUP_FAILED", "CARRIER_ERROR", "CARRIER_AUTH_FAILED", "CARRIER_NOT_FOUND", "CARRIER_PRODUCT_NOT_FOUND", "CARRIER_CONFIG_INVALID", "CARRIER_PARAMETER_INVALID", "CARRIER_SERVER_UNAVAILABLE", "CARRIER_GLS_WRONG_ADDRESS", "CARRIER_DAO_INVALID_POSTAL_CODE", "CARRIER_POSTNORD_BOOKING_FAILED", "CARRIER_FEDEX_BOOKING_FAILED", "CARRIER_DHL_EXPRESS_BOOKING_FAILED", "CARRIER_UPS_BOOKING_FAILED", "CARRIER_MATKAHUOLTO_BOOKING_FAILED", "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED", "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT", "CARRIER_CUSTOMS_INCOMPLETE", "CARRIER_REQUEST_NOT_FOUND", "CARRIER_REQUEST_LOCKED", "CARRIER_REQUEST_DISPATCH_FAILED", "SHIPPING_RULE_NOT_FOUND", "SHIPPING_RULE_INVALID", "ADDRESS_NOT_FOUND", "ORDER_NOT_FOUND", "ORDER_CHANNEL_NOT_FOUND", "ORDER_CHANNEL_CONFIG_INVALID", "INTEGRATION_NOT_CONFIGURED", "INSTALLATION_NOT_FOUND", "WEBHOOK_SIGNATURE_INVALID", "WEBHOOK_PAYLOAD_INVALID", "SHOPIFY_PENDING_INSTALL_NOT_FOUND", "SHOPIFY_PENDING_INSTALL_EXPIRED", "SHOP_ALREADY_CONNECTED", "SHOP_CLAIMED_BY_ANOTHER_ORG", "WOOCOMMERCE_CONNECT_FAILED", "WOOCOMMERCE_AUTH_STATE_INVALID", "CHECKOUT_TOKEN_INVALID", "ORDER_CHANNEL_TYPE_UNSUPPORTED", "PRINTER_NOT_FOUND", "PRINTER_OFFLINE", "PRINTER_AUTH_TIMEOUT", "PRINTER_JOB_NOT_FOUND", "ORG_INTEGRATION_NOT_FOUND", "ORG_WEBHOOK_NOT_FOUND", "AUTOMATION_NOT_FOUND", "AUTOMATION_INVALID", "ZIPPY_DISABLED", "CONVERSATION_NOT_FOUND", "ADMIN_FORBIDDEN", "JOB_HANDLER_NOT_REGISTERED", "JOB_QUEUE_NOT_CONFIGURED", "JOB_ENQUEUE_FAILED", "JOB_PAYLOAD_INVALID", "EMAIL_SEND_FAILED", "INTEGRATION_DELIVERY_FAILED", "WEBHOOK_DELIVERY_FAILED", "DOCUMENT_GENERATION_FAILED", "AI_UNAVAILABLE", "MIGRATION_PROVIDER_UNKNOWN", "MIGRATION_SOURCE_TOKEN_INVALID", "MIGRATION_SOURCE_UNREACHABLE", "MIGRATION_NOT_FOUND", "MIGRATION_IN_PROGRESS"])
153
+ code_validator = EnumAttributeValidator.new('String', ["INTERNAL_ERROR", "BAD_REQUEST", "VALIDATION_FAILED", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "PAYLOAD_TOO_LARGE", "IMAGE_DIMENSIONS_EXCEEDED", "NOT_IMPLEMENTED", "AUTH_INVALID_CREDENTIALS", "AUTH_TOKEN_INVALID", "AUTH_TOKEN_EXPIRED", "AUTH_EMAIL_NOT_VERIFIED", "AUTH_EMAIL_EXISTS", "AUTH_OAUTH_FAILED", "AUTH_SIGNUP_NOT_ALLOWED", "AUTH_VERIFICATION_FAILED", "AUTH_RESET_TOKEN_INVALID", "AUTH_MFA_REQUIRED", "AUTH_MFA_INVALID_CODE", "AUTH_MFA_ALREADY_ENABLED", "AUTH_MFA_NOT_ENABLED", "SESSION_REQUIRED", "ORG_NOT_FOUND", "ORG_ACCESS_DENIED", "ORG_DISABLED", "ORG_SLUG_EXISTS", "BRAND_NOT_FOUND", "BRAND_ACCESS_DENIED", "BRAND_SLUG_EXISTS", "BRAND_HAS_RECORDS", "USER_NOT_FOUND", "USER_EXISTS", "MEMBER_NOT_FOUND", "MEMBER_SELF_BRAND_RESTRICTION", "ROLE_NOT_FOUND", "ROLE_NAME_EXISTS", "ROLE_IN_USE", "MEMBER_EXISTS", "INVITATION_NOT_FOUND", "INVITATION_EXPIRED", "INVITATION_ALREADY_SENT", "INVITATION_EMAIL_FAILED", "TOKEN_NOT_FOUND", "BILLING_PAYMENT_FAILED", "BILLING_NO_SUBSCRIPTION", "BILLING_TAX_ID_INVALID", "BILLING_PLAN_INVALID", "BILLING_OPERATION_FAILED", "FEATURE_NOT_AVAILABLE", "RESOURCE_LIMIT_REACHED", "PLAN_LIMITS_EXCEEDED", "NO_SUBSCRIPTION", "SUBSCRIPTION_INACTIVE", "BILLING_MANAGED_BY_SHOPIFY", "BILLING_CHECKOUT_REQUIRED", "SHIPMENT_NOT_FOUND", "SHIPMENT_DOCUMENT_NOT_FOUND", "SHIPMENT_ALREADY_SENT", "SHIPMENT_INVALID_STATE", "PARCEL_NOT_FOUND", "PARCEL_INVALID_SPLIT", "PICKUP_NOT_FOUND", "PICKUP_FAILED", "CARRIER_ERROR", "CARRIER_AUTH_FAILED", "CARRIER_NOT_FOUND", "CARRIER_PRODUCT_NOT_FOUND", "CARRIER_CONFIG_INVALID", "CARRIER_PARAMETER_INVALID", "CARRIER_SERVER_UNAVAILABLE", "CARRIER_GLS_WRONG_ADDRESS", "CARRIER_DAO_INVALID_POSTAL_CODE", "CARRIER_POSTNORD_BOOKING_FAILED", "CARRIER_FEDEX_BOOKING_FAILED", "CARRIER_DHL_EXPRESS_BOOKING_FAILED", "CARRIER_UPS_BOOKING_FAILED", "CARRIER_MATKAHUOLTO_BOOKING_FAILED", "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED", "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT", "CARRIER_CUSTOMS_INCOMPLETE", "CARRIER_REQUEST_NOT_FOUND", "CARRIER_REQUEST_LOCKED", "CARRIER_REQUEST_DISPATCH_FAILED", "SHIPPING_RULE_NOT_FOUND", "SHIPPING_RULE_INVALID", "ADDRESS_NOT_FOUND", "ORDER_NOT_FOUND", "ORDER_CHANNEL_NOT_FOUND", "ORDER_CHANNEL_CONFIG_INVALID", "INTEGRATION_NOT_CONFIGURED", "INSTALLATION_NOT_FOUND", "WEBHOOK_SIGNATURE_INVALID", "WEBHOOK_PAYLOAD_INVALID", "SHOPIFY_PENDING_INSTALL_NOT_FOUND", "SHOPIFY_PENDING_INSTALL_EXPIRED", "SHOP_ALREADY_CONNECTED", "SHOP_CLAIMED_BY_ANOTHER_ORG", "WOOCOMMERCE_CONNECT_FAILED", "WOOCOMMERCE_AUTH_STATE_INVALID", "CHECKOUT_TOKEN_INVALID", "ORDER_CHANNEL_TYPE_UNSUPPORTED", "PRINTER_NOT_FOUND", "PRINTER_OFFLINE", "PRINTER_AUTH_TIMEOUT", "PRINTER_JOB_NOT_FOUND", "ORG_INTEGRATION_NOT_FOUND", "ORG_WEBHOOK_NOT_FOUND", "AUTOMATION_NOT_FOUND", "AUTOMATION_INVALID", "ZIPPY_DISABLED", "CONVERSATION_NOT_FOUND", "ADMIN_FORBIDDEN", "JOB_HANDLER_NOT_REGISTERED", "JOB_QUEUE_NOT_CONFIGURED", "JOB_ENQUEUE_FAILED", "JOB_PAYLOAD_INVALID", "EMAIL_SEND_FAILED", "INTEGRATION_DELIVERY_FAILED", "WEBHOOK_DELIVERY_FAILED", "DOCUMENT_GENERATION_FAILED", "AI_UNAVAILABLE", "MIGRATION_PROVIDER_UNKNOWN", "MIGRATION_SOURCE_TOKEN_INVALID", "MIGRATION_SOURCE_UNREACHABLE", "MIGRATION_NOT_FOUND", "MIGRATION_IN_PROGRESS"])
154
154
  return false unless code_validator.valid?(@code)
155
155
  return false if @error.nil?
156
156
  return false if @message.nil?
@@ -161,7 +161,7 @@ module Zippendo
161
161
  # Custom attribute writer method checking allowed values (enum).
162
162
  # @param [Object] code Object to be assigned
163
163
  def code=(code)
164
- validator = EnumAttributeValidator.new('String', ["INTERNAL_ERROR", "BAD_REQUEST", "VALIDATION_FAILED", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "PAYLOAD_TOO_LARGE", "IMAGE_DIMENSIONS_EXCEEDED", "NOT_IMPLEMENTED", "AUTH_INVALID_CREDENTIALS", "AUTH_TOKEN_INVALID", "AUTH_TOKEN_EXPIRED", "AUTH_EMAIL_NOT_VERIFIED", "AUTH_EMAIL_EXISTS", "AUTH_OAUTH_FAILED", "AUTH_SIGNUP_NOT_ALLOWED", "AUTH_VERIFICATION_FAILED", "AUTH_RESET_TOKEN_INVALID", "AUTH_MFA_REQUIRED", "AUTH_MFA_INVALID_CODE", "AUTH_MFA_ALREADY_ENABLED", "AUTH_MFA_NOT_ENABLED", "SESSION_REQUIRED", "ORG_NOT_FOUND", "ORG_ACCESS_DENIED", "ORG_DISABLED", "ORG_SLUG_EXISTS", "USER_NOT_FOUND", "USER_EXISTS", "MEMBER_NOT_FOUND", "ROLE_NOT_FOUND", "ROLE_NAME_EXISTS", "ROLE_IN_USE", "MEMBER_EXISTS", "INVITATION_NOT_FOUND", "INVITATION_EXPIRED", "INVITATION_EMAIL_FAILED", "TOKEN_NOT_FOUND", "BILLING_PAYMENT_FAILED", "BILLING_NO_SUBSCRIPTION", "BILLING_TAX_ID_INVALID", "BILLING_PLAN_INVALID", "BILLING_OPERATION_FAILED", "FEATURE_NOT_AVAILABLE", "RESOURCE_LIMIT_REACHED", "PLAN_LIMITS_EXCEEDED", "NO_SUBSCRIPTION", "SUBSCRIPTION_INACTIVE", "BILLING_MANAGED_BY_SHOPIFY", "BILLING_CHECKOUT_REQUIRED", "SHIPMENT_NOT_FOUND", "SHIPMENT_DOCUMENT_NOT_FOUND", "SHIPMENT_ALREADY_SENT", "SHIPMENT_INVALID_STATE", "PARCEL_NOT_FOUND", "PARCEL_INVALID_SPLIT", "PICKUP_NOT_FOUND", "PICKUP_FAILED", "CARRIER_ERROR", "CARRIER_AUTH_FAILED", "CARRIER_NOT_FOUND", "CARRIER_PRODUCT_NOT_FOUND", "CARRIER_CONFIG_INVALID", "CARRIER_PARAMETER_INVALID", "CARRIER_SERVER_UNAVAILABLE", "CARRIER_GLS_WRONG_ADDRESS", "CARRIER_DAO_INVALID_POSTAL_CODE", "CARRIER_POSTNORD_BOOKING_FAILED", "CARRIER_FEDEX_BOOKING_FAILED", "CARRIER_DHL_EXPRESS_BOOKING_FAILED", "CARRIER_UPS_BOOKING_FAILED", "CARRIER_MATKAHUOLTO_BOOKING_FAILED", "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED", "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT", "CARRIER_CUSTOMS_INCOMPLETE", "CARRIER_REQUEST_NOT_FOUND", "CARRIER_REQUEST_LOCKED", "CARRIER_REQUEST_DISPATCH_FAILED", "SHIPPING_RULE_NOT_FOUND", "SHIPPING_RULE_INVALID", "ADDRESS_NOT_FOUND", "ORDER_NOT_FOUND", "ORDER_CHANNEL_NOT_FOUND", "ORDER_CHANNEL_CONFIG_INVALID", "INTEGRATION_NOT_CONFIGURED", "INSTALLATION_NOT_FOUND", "WEBHOOK_SIGNATURE_INVALID", "WEBHOOK_PAYLOAD_INVALID", "SHOPIFY_PENDING_INSTALL_NOT_FOUND", "SHOPIFY_PENDING_INSTALL_EXPIRED", "SHOP_ALREADY_CONNECTED", "SHOP_CLAIMED_BY_ANOTHER_ORG", "WOOCOMMERCE_CONNECT_FAILED", "WOOCOMMERCE_AUTH_STATE_INVALID", "CHECKOUT_TOKEN_INVALID", "ORDER_CHANNEL_TYPE_UNSUPPORTED", "PRINTER_NOT_FOUND", "PRINTER_OFFLINE", "PRINTER_AUTH_TIMEOUT", "PRINTER_JOB_NOT_FOUND", "ORG_INTEGRATION_NOT_FOUND", "ORG_WEBHOOK_NOT_FOUND", "AUTOMATION_NOT_FOUND", "AUTOMATION_INVALID", "ZIPPY_DISABLED", "CONVERSATION_NOT_FOUND", "ADMIN_FORBIDDEN", "JOB_HANDLER_NOT_REGISTERED", "JOB_QUEUE_NOT_CONFIGURED", "JOB_ENQUEUE_FAILED", "JOB_PAYLOAD_INVALID", "EMAIL_SEND_FAILED", "INTEGRATION_DELIVERY_FAILED", "WEBHOOK_DELIVERY_FAILED", "DOCUMENT_GENERATION_FAILED", "AI_UNAVAILABLE", "MIGRATION_PROVIDER_UNKNOWN", "MIGRATION_SOURCE_TOKEN_INVALID", "MIGRATION_SOURCE_UNREACHABLE", "MIGRATION_NOT_FOUND", "MIGRATION_IN_PROGRESS"])
164
+ validator = EnumAttributeValidator.new('String', ["INTERNAL_ERROR", "BAD_REQUEST", "VALIDATION_FAILED", "UNAUTHORIZED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "RATE_LIMITED", "PAYLOAD_TOO_LARGE", "IMAGE_DIMENSIONS_EXCEEDED", "NOT_IMPLEMENTED", "AUTH_INVALID_CREDENTIALS", "AUTH_TOKEN_INVALID", "AUTH_TOKEN_EXPIRED", "AUTH_EMAIL_NOT_VERIFIED", "AUTH_EMAIL_EXISTS", "AUTH_OAUTH_FAILED", "AUTH_SIGNUP_NOT_ALLOWED", "AUTH_VERIFICATION_FAILED", "AUTH_RESET_TOKEN_INVALID", "AUTH_MFA_REQUIRED", "AUTH_MFA_INVALID_CODE", "AUTH_MFA_ALREADY_ENABLED", "AUTH_MFA_NOT_ENABLED", "SESSION_REQUIRED", "ORG_NOT_FOUND", "ORG_ACCESS_DENIED", "ORG_DISABLED", "ORG_SLUG_EXISTS", "BRAND_NOT_FOUND", "BRAND_ACCESS_DENIED", "BRAND_SLUG_EXISTS", "BRAND_HAS_RECORDS", "USER_NOT_FOUND", "USER_EXISTS", "MEMBER_NOT_FOUND", "MEMBER_SELF_BRAND_RESTRICTION", "ROLE_NOT_FOUND", "ROLE_NAME_EXISTS", "ROLE_IN_USE", "MEMBER_EXISTS", "INVITATION_NOT_FOUND", "INVITATION_EXPIRED", "INVITATION_ALREADY_SENT", "INVITATION_EMAIL_FAILED", "TOKEN_NOT_FOUND", "BILLING_PAYMENT_FAILED", "BILLING_NO_SUBSCRIPTION", "BILLING_TAX_ID_INVALID", "BILLING_PLAN_INVALID", "BILLING_OPERATION_FAILED", "FEATURE_NOT_AVAILABLE", "RESOURCE_LIMIT_REACHED", "PLAN_LIMITS_EXCEEDED", "NO_SUBSCRIPTION", "SUBSCRIPTION_INACTIVE", "BILLING_MANAGED_BY_SHOPIFY", "BILLING_CHECKOUT_REQUIRED", "SHIPMENT_NOT_FOUND", "SHIPMENT_DOCUMENT_NOT_FOUND", "SHIPMENT_ALREADY_SENT", "SHIPMENT_INVALID_STATE", "PARCEL_NOT_FOUND", "PARCEL_INVALID_SPLIT", "PICKUP_NOT_FOUND", "PICKUP_FAILED", "CARRIER_ERROR", "CARRIER_AUTH_FAILED", "CARRIER_NOT_FOUND", "CARRIER_PRODUCT_NOT_FOUND", "CARRIER_CONFIG_INVALID", "CARRIER_PARAMETER_INVALID", "CARRIER_SERVER_UNAVAILABLE", "CARRIER_GLS_WRONG_ADDRESS", "CARRIER_DAO_INVALID_POSTAL_CODE", "CARRIER_POSTNORD_BOOKING_FAILED", "CARRIER_FEDEX_BOOKING_FAILED", "CARRIER_DHL_EXPRESS_BOOKING_FAILED", "CARRIER_UPS_BOOKING_FAILED", "CARRIER_MATKAHUOLTO_BOOKING_FAILED", "CARRIER_TRACKING_WEBHOOK_REGISTRATION_FAILED", "CARRIER_CUSTOMS_UNSUPPORTED_PRODUCT", "CARRIER_CUSTOMS_INCOMPLETE", "CARRIER_REQUEST_NOT_FOUND", "CARRIER_REQUEST_LOCKED", "CARRIER_REQUEST_DISPATCH_FAILED", "SHIPPING_RULE_NOT_FOUND", "SHIPPING_RULE_INVALID", "ADDRESS_NOT_FOUND", "ORDER_NOT_FOUND", "ORDER_CHANNEL_NOT_FOUND", "ORDER_CHANNEL_CONFIG_INVALID", "INTEGRATION_NOT_CONFIGURED", "INSTALLATION_NOT_FOUND", "WEBHOOK_SIGNATURE_INVALID", "WEBHOOK_PAYLOAD_INVALID", "SHOPIFY_PENDING_INSTALL_NOT_FOUND", "SHOPIFY_PENDING_INSTALL_EXPIRED", "SHOP_ALREADY_CONNECTED", "SHOP_CLAIMED_BY_ANOTHER_ORG", "WOOCOMMERCE_CONNECT_FAILED", "WOOCOMMERCE_AUTH_STATE_INVALID", "CHECKOUT_TOKEN_INVALID", "ORDER_CHANNEL_TYPE_UNSUPPORTED", "PRINTER_NOT_FOUND", "PRINTER_OFFLINE", "PRINTER_AUTH_TIMEOUT", "PRINTER_JOB_NOT_FOUND", "ORG_INTEGRATION_NOT_FOUND", "ORG_WEBHOOK_NOT_FOUND", "AUTOMATION_NOT_FOUND", "AUTOMATION_INVALID", "ZIPPY_DISABLED", "CONVERSATION_NOT_FOUND", "ADMIN_FORBIDDEN", "JOB_HANDLER_NOT_REGISTERED", "JOB_QUEUE_NOT_CONFIGURED", "JOB_ENQUEUE_FAILED", "JOB_PAYLOAD_INVALID", "EMAIL_SEND_FAILED", "INTEGRATION_DELIVERY_FAILED", "WEBHOOK_DELIVERY_FAILED", "DOCUMENT_GENERATION_FAILED", "AI_UNAVAILABLE", "MIGRATION_PROVIDER_UNKNOWN", "MIGRATION_SOURCE_TOKEN_INVALID", "MIGRATION_SOURCE_UNREACHABLE", "MIGRATION_NOT_FOUND", "MIGRATION_IN_PROGRESS"])
165
165
  unless validator.valid?(code)
166
166
  fail ArgumentError, "invalid value for \"code\", must be one of #{validator.allowable_values}."
167
167
  end
@@ -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_).
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.
5
5
 
6
6
  The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@zippendo.com