zippendo 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (480) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE.md +21 -0
  4. data/README.md +99 -0
  5. data/Rakefile +10 -0
  6. data/docs/AddressesApi.md +375 -0
  7. data/docs/BatchSendShipments200Response.md +20 -0
  8. data/docs/BatchSendShipments200ResponseResultsInner.md +26 -0
  9. data/docs/BatchSendShipments200ResponseSummary.md +22 -0
  10. data/docs/BatchSendShipmentsRequest.md +18 -0
  11. data/docs/BatchSplitShipment201Response.md +20 -0
  12. data/docs/BatchSplitShipmentRequest.md +28 -0
  13. data/docs/BatchSplitShipmentRequestShipmentsInner.md +20 -0
  14. data/docs/BatchSplitShipmentRequestShipmentsInnerOrderLinesInner.md +20 -0
  15. data/docs/BillingApi.md +77 -0
  16. data/docs/CarrierCatalogApi.md +77 -0
  17. data/docs/CarriersApi.md +521 -0
  18. data/docs/ConnectCarrierRequest.md +22 -0
  19. data/docs/CreateAddressRequest.md +40 -0
  20. data/docs/CreateApiToken201Response.md +32 -0
  21. data/docs/CreateApiTokenRequest.md +22 -0
  22. data/docs/CreateOrder201Response.md +52 -0
  23. data/docs/CreateOrder201ResponseOrderLinesInner.md +54 -0
  24. data/docs/CreateOrder201ResponseShippingAddress.md +42 -0
  25. data/docs/CreateOrderRequest.md +40 -0
  26. data/docs/CreateOrderRequestOrderLinesInner.md +54 -0
  27. data/docs/CreateOrderRequestShippingAddress.md +42 -0
  28. data/docs/CreateOrgWebhook201Response.md +32 -0
  29. data/docs/CreateOrgWebhookRequest.md +24 -0
  30. data/docs/CreateShipment201Response.md +64 -0
  31. data/docs/CreateShipment201ResponseActivitiesInner.md +26 -0
  32. data/docs/CreateShipment201ResponseDocumentsInner.md +32 -0
  33. data/docs/CreateShipment201ResponseErrorsInner.md +26 -0
  34. data/docs/CreateShipment201ResponseLogsInner.md +32 -0
  35. data/docs/CreateShipment201ResponseParcelsInner.md +38 -0
  36. data/docs/CreateShipment201ResponseParcelsInnerDimensions.md +22 -0
  37. data/docs/CreateShipment201ResponseParcelsInnerOrderLinesInner.md +36 -0
  38. data/docs/CreateShipment201ResponsePartiesInner.md +38 -0
  39. data/docs/CreateShipment201ResponsePartiesInnerAttributesInner.md +20 -0
  40. data/docs/CreateShipment201ResponsePickupDetails.md +24 -0
  41. data/docs/CreateShipment201ResponseShippingRule.md +40 -0
  42. data/docs/CreateShipment201ResponseTracking.md +28 -0
  43. data/docs/CreateShipmentRequest.md +42 -0
  44. data/docs/CreateShipmentRequestCarrierSettings.md +24 -0
  45. data/docs/CreateShipmentRequestParcelsInner.md +38 -0
  46. data/docs/CreateShipmentRequestParcelsInnerDimensions.md +22 -0
  47. data/docs/CreateShipmentRequestParcelsInnerOrderLinesInner.md +36 -0
  48. data/docs/CreateShipmentRequestPartiesInner.md +38 -0
  49. data/docs/CreateShipmentRequestPartiesInnerAttributesInner.md +20 -0
  50. data/docs/CreateShipmentRequestPickupDetails.md +24 -0
  51. data/docs/CreateShippingQuote200Response.md +18 -0
  52. data/docs/CreateShippingQuote200ResponseRatesInner.md +38 -0
  53. data/docs/CreateShippingQuote400Response.md +20 -0
  54. data/docs/CreateShippingQuote404Response.md +20 -0
  55. data/docs/CreateShippingQuoteRequest.md +24 -0
  56. data/docs/CreateShippingQuoteRequestDestination.md +28 -0
  57. data/docs/CreateShippingQuoteRequestItemsInner.md +30 -0
  58. data/docs/CreateShippingRule201Response.md +74 -0
  59. data/docs/CreateShippingRuleRequest.md +66 -0
  60. data/docs/CreateShippingRuleRequestAdditionalParameters.md +15 -0
  61. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfInner.md +20 -0
  62. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValue.md +24 -0
  63. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.md +24 -0
  64. data/docs/CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md +15 -0
  65. data/docs/CreateShippingRuleRequestConditionsInner.md +55 -0
  66. data/docs/CreateShippingRuleRequestConditionsInnerOneOf.md +26 -0
  67. data/docs/CreateShippingRuleRequestConditionsInnerOneOf1.md +28 -0
  68. data/docs/CreateShippingRuleRequestConditionsInnerOneOf2.md +28 -0
  69. data/docs/CreateShippingRuleRequestConditionsInnerOneOf3.md +26 -0
  70. data/docs/CreateShippingRuleRequestConditionsInnerOneOf4.md +22 -0
  71. data/docs/DeleteOrgWebhook200Response.md +18 -0
  72. data/docs/DeleteShippingRule200Response.md +18 -0
  73. data/docs/GetBillingUsage200Response.md +24 -0
  74. data/docs/GetBillingUsage200ResponseAddOnsInner.md +24 -0
  75. data/docs/GetBillingUsage200ResponseCurrentPeriod.md +20 -0
  76. data/docs/GetBillingUsage200ResponseLimits.md +30 -0
  77. data/docs/GetBillingUsage200ResponseLimitsTeamMembers.md +20 -0
  78. data/docs/GetBillingUsage200ResponseShipments.md +24 -0
  79. data/docs/GetOrder200Response.md +58 -0
  80. data/docs/GetOrder200ResponseShipmentsInner.md +36 -0
  81. data/docs/GetOrder200ResponseShippingRule.md +40 -0
  82. data/docs/GetOrg200Response.md +50 -0
  83. data/docs/GetOrg200ResponseCount.md +18 -0
  84. data/docs/GetOrgBranding200Response.md +22 -0
  85. data/docs/HealthCheck200Response.md +22 -0
  86. data/docs/ListAddresses200Response.md +26 -0
  87. data/docs/ListAddresses200ResponseDataInner.md +48 -0
  88. data/docs/ListApiTokens200Response.md +26 -0
  89. data/docs/ListApiTokens200ResponseDataInner.md +32 -0
  90. data/docs/ListApiTokens200ResponseDataInnerCreatedBy.md +22 -0
  91. data/docs/ListApiTokens401Response.md +22 -0
  92. data/docs/ListAvailableCarriers200ResponseInner.md +38 -0
  93. data/docs/ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md +28 -0
  94. data/docs/ListCarrierProductServicePoints200ResponseInner.md +32 -0
  95. data/docs/ListCarrierProductServicePoints200ResponseInnerAddress.md +28 -0
  96. data/docs/ListCarrierProductServicePointsRequest.md +28 -0
  97. data/docs/ListCarrierProducts200ResponseInner.md +38 -0
  98. data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInner.md +30 -0
  99. data/docs/ListCarrierProducts200ResponseInnerAdditionalParametersInnerOptionsInner.md +22 -0
  100. data/docs/ListCarrierProducts200ResponseInnerServicesInner.md +20 -0
  101. data/docs/ListCarrierProducts200ResponseInnerWeightLimits.md +22 -0
  102. data/docs/ListCarriers200Response.md +26 -0
  103. data/docs/ListCarriers200ResponseDataInner.md +38 -0
  104. data/docs/ListCarriers200ResponseDataInnerConfigValue.md +15 -0
  105. data/docs/ListOrders200Response.md +26 -0
  106. data/docs/ListOrders200ResponseDataInner.md +40 -0
  107. data/docs/ListOrders200ResponseDataInnerOrderChannel.md +22 -0
  108. data/docs/ListOrgWebhookDeliveries200Response.md +26 -0
  109. data/docs/ListOrgWebhookDeliveries200ResponseDataInner.md +38 -0
  110. data/docs/ListOrgWebhooks200Response.md +26 -0
  111. data/docs/ListOrgWebhooks200ResponseDataInner.md +30 -0
  112. data/docs/ListShipments200Response.md +26 -0
  113. data/docs/ListShipments200ResponseDataInner.md +32 -0
  114. data/docs/ListShipments200ResponseDataInnerAddress.md +48 -0
  115. data/docs/ListShipments200ResponseDataInnerCarrierSettings.md +24 -0
  116. data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValue.md +24 -0
  117. data/docs/ListShipments200ResponseDataInnerCarrierSettingsAdditionalParametersValueAnyOf.md +24 -0
  118. data/docs/ListShippingRules200Response.md +26 -0
  119. data/docs/ListShippingRules200ResponseDataInner.md +84 -0
  120. data/docs/ListShippingRules200ResponseDataInnerAdditionalParametersInner.md +20 -0
  121. data/docs/ListShippingRules200ResponseDataInnerCarrier.md +30 -0
  122. data/docs/ListShippingRules200ResponseDataInnerConditionsInner.md +55 -0
  123. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf.md +26 -0
  124. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf1.md +28 -0
  125. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf2.md +28 -0
  126. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf3.md +26 -0
  127. data/docs/ListShippingRules200ResponseDataInnerConditionsInnerOneOf4.md +22 -0
  128. data/docs/ListShippingRules200ResponseDataInnerLabelPrinter.md +20 -0
  129. data/docs/ListShippingRules200ResponseDataInnerReturnShippingRule.md +20 -0
  130. data/docs/OrdersApi.md +379 -0
  131. data/docs/OrgsApi.md +503 -0
  132. data/docs/QuotesApi.md +79 -0
  133. data/docs/RevokeApiToken200Response.md +18 -0
  134. data/docs/RulesApi.md +373 -0
  135. data/docs/SendShipment422Response.md +24 -0
  136. data/docs/SendShipment422ResponseErrorsInner.md +20 -0
  137. data/docs/ShipmentsApi.md +962 -0
  138. data/docs/SplitShipment201Response.md +20 -0
  139. data/docs/SplitShipmentParcel200Response.md +18 -0
  140. data/docs/SplitShipmentParcelRequest.md +18 -0
  141. data/docs/SplitShipmentParcelRequestParcelsInner.md +20 -0
  142. data/docs/SplitShipmentRequest.md +30 -0
  143. data/docs/SystemApi.md +74 -0
  144. data/docs/TestOrgWebhook200Response.md +18 -0
  145. data/docs/TokensApi.md +443 -0
  146. data/docs/TrackShipment200Response.md +26 -0
  147. data/docs/TrackShipment200ResponseEventsInner.md +28 -0
  148. data/docs/UpdateAddressRequest.md +40 -0
  149. data/docs/UpdateApiTokenRequest.md +18 -0
  150. data/docs/UpdateCarrierRequest.md +22 -0
  151. data/docs/UpdateOrderRequest.md +38 -0
  152. data/docs/UpdateOrg200Response.md +48 -0
  153. data/docs/UpdateOrgBrandingRequest.md +20 -0
  154. data/docs/UpdateOrgRequest.md +44 -0
  155. data/docs/UpdateOrgWebhookRequest.md +24 -0
  156. data/docs/UpdateShipmentRequest.md +44 -0
  157. data/docs/UpdateShippingRuleRequest.md +66 -0
  158. data/docs/VerifyApiToken200Response.md +28 -0
  159. data/docs/VerifyApiTokenRequest.md +18 -0
  160. data/docs/WebhooksApi.md +523 -0
  161. data/git_push.sh +57 -0
  162. data/lib/zippendo/api/addresses_api.rb +406 -0
  163. data/lib/zippendo/api/billing_api.rb +85 -0
  164. data/lib/zippendo/api/carrier_catalog_api.rb +85 -0
  165. data/lib/zippendo/api/carriers_api.rb +554 -0
  166. data/lib/zippendo/api/orders_api.rb +412 -0
  167. data/lib/zippendo/api/orgs_api.rb +497 -0
  168. data/lib/zippendo/api/quotes_api.rb +96 -0
  169. data/lib/zippendo/api/rules_api.rb +399 -0
  170. data/lib/zippendo/api/shipments_api.rb +1003 -0
  171. data/lib/zippendo/api/system_api.rb +79 -0
  172. data/lib/zippendo/api/tokens_api.rb +467 -0
  173. data/lib/zippendo/api/webhooks_api.rb +559 -0
  174. data/lib/zippendo/api_client.rb +397 -0
  175. data/lib/zippendo/api_error.rb +58 -0
  176. data/lib/zippendo/api_model_base.rb +88 -0
  177. data/lib/zippendo/configuration.rb +309 -0
  178. data/lib/zippendo/models/batch_send_shipments200_response.rb +193 -0
  179. data/lib/zippendo/models/batch_send_shipments200_response_results_inner.rb +260 -0
  180. data/lib/zippendo/models/batch_send_shipments200_response_summary.rb +274 -0
  181. data/lib/zippendo/models/batch_send_shipments_request.rb +185 -0
  182. data/lib/zippendo/models/batch_split_shipment201_response.rb +193 -0
  183. data/lib/zippendo/models/batch_split_shipment_request.rb +247 -0
  184. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner.rb +186 -0
  185. data/lib/zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner.rb +210 -0
  186. data/lib/zippendo/models/connect_carrier_request.rb +239 -0
  187. data/lib/zippendo/models/create_address_request.rb +508 -0
  188. data/lib/zippendo/models/create_api_token201_response.rb +328 -0
  189. data/lib/zippendo/models/create_api_token_request.rb +267 -0
  190. data/lib/zippendo/models/create_order201_response.rb +491 -0
  191. data/lib/zippendo/models/create_order201_response_order_lines_inner.rb +533 -0
  192. data/lib/zippendo/models/create_order201_response_shipping_address.rb +433 -0
  193. data/lib/zippendo/models/create_order_request.rb +410 -0
  194. data/lib/zippendo/models/create_order_request_order_lines_inner.rb +533 -0
  195. data/lib/zippendo/models/create_order_request_shipping_address.rb +433 -0
  196. data/lib/zippendo/models/create_org_webhook201_response.rb +356 -0
  197. data/lib/zippendo/models/create_org_webhook_request.rb +268 -0
  198. data/lib/zippendo/models/create_shipment201_response.rb +659 -0
  199. data/lib/zippendo/models/create_shipment201_response_activities_inner.rb +281 -0
  200. data/lib/zippendo/models/create_shipment201_response_documents_inner.rb +382 -0
  201. data/lib/zippendo/models/create_shipment201_response_errors_inner.rb +257 -0
  202. data/lib/zippendo/models/create_shipment201_response_logs_inner.rb +300 -0
  203. data/lib/zippendo/models/create_shipment201_response_parcels_inner.rb +356 -0
  204. data/lib/zippendo/models/create_shipment201_response_parcels_inner_dimensions.rb +246 -0
  205. data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb +402 -0
  206. data/lib/zippendo/models/create_shipment201_response_parties_inner.rb +468 -0
  207. data/lib/zippendo/models/create_shipment201_response_parties_inner_attributes_inner.rb +210 -0
  208. data/lib/zippendo/models/create_shipment201_response_pickup_details.rb +229 -0
  209. data/lib/zippendo/models/create_shipment201_response_shipping_rule.rb +365 -0
  210. data/lib/zippendo/models/create_shipment201_response_tracking.rb +204 -0
  211. data/lib/zippendo/models/create_shipment_request.rb +407 -0
  212. data/lib/zippendo/models/create_shipment_request_carrier_settings.rb +250 -0
  213. data/lib/zippendo/models/create_shipment_request_parcels_inner.rb +356 -0
  214. data/lib/zippendo/models/create_shipment_request_parcels_inner_dimensions.rb +246 -0
  215. data/lib/zippendo/models/create_shipment_request_parcels_inner_order_lines_inner.rb +402 -0
  216. data/lib/zippendo/models/create_shipment_request_parties_inner.rb +451 -0
  217. data/lib/zippendo/models/create_shipment_request_parties_inner_attributes_inner.rb +210 -0
  218. data/lib/zippendo/models/create_shipment_request_pickup_details.rb +229 -0
  219. data/lib/zippendo/models/create_shipping_quote200_response.rb +167 -0
  220. data/lib/zippendo/models/create_shipping_quote200_response_rates_inner.rb +333 -0
  221. data/lib/zippendo/models/create_shipping_quote400_response.rb +192 -0
  222. data/lib/zippendo/models/create_shipping_quote404_response.rb +192 -0
  223. data/lib/zippendo/models/create_shipping_quote_request.rb +276 -0
  224. data/lib/zippendo/models/create_shipping_quote_request_destination.rb +233 -0
  225. data/lib/zippendo/models/create_shipping_quote_request_items_inner.rb +315 -0
  226. data/lib/zippendo/models/create_shipping_rule201_response.rb +910 -0
  227. data/lib/zippendo/models/create_shipping_rule_request.rb +640 -0
  228. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters.rb +104 -0
  229. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner.rb +201 -0
  230. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value.rb +105 -0
  231. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of.rb +259 -0
  232. data/lib/zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner.rb +102 -0
  233. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner.rb +107 -0
  234. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of.rb +342 -0
  235. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of1.rb +359 -0
  236. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of2.rb +366 -0
  237. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of3.rb +344 -0
  238. data/lib/zippendo/models/create_shipping_rule_request_conditions_inner_one_of4.rb +270 -0
  239. data/lib/zippendo/models/delete_org_webhook200_response.rb +165 -0
  240. data/lib/zippendo/models/delete_shipping_rule200_response.rb +165 -0
  241. data/lib/zippendo/models/get_billing_usage200_response.rb +245 -0
  242. data/lib/zippendo/models/get_billing_usage200_response_add_ons_inner.rb +270 -0
  243. data/lib/zippendo/models/get_billing_usage200_response_current_period.rb +192 -0
  244. data/lib/zippendo/models/get_billing_usage200_response_limits.rb +320 -0
  245. data/lib/zippendo/models/get_billing_usage200_response_limits_team_members.rb +192 -0
  246. data/lib/zippendo/models/get_billing_usage200_response_shipments.rb +246 -0
  247. data/lib/zippendo/models/get_order200_response.rb +555 -0
  248. data/lib/zippendo/models/get_order200_response_shipments_inner.rb +385 -0
  249. data/lib/zippendo/models/get_order200_response_shipping_rule.rb +365 -0
  250. data/lib/zippendo/models/get_org200_response.rb +440 -0
  251. data/lib/zippendo/models/get_org200_response_count.rb +165 -0
  252. data/lib/zippendo/models/get_org_branding200_response.rb +177 -0
  253. data/lib/zippendo/models/health_check200_response.rb +219 -0
  254. data/lib/zippendo/models/list_addresses200_response.rb +275 -0
  255. data/lib/zippendo/models/list_addresses200_response_data_inner.rb +553 -0
  256. data/lib/zippendo/models/list_api_tokens200_response.rb +275 -0
  257. data/lib/zippendo/models/list_api_tokens200_response_data_inner.rb +327 -0
  258. data/lib/zippendo/models/list_api_tokens200_response_data_inner_created_by.rb +205 -0
  259. data/lib/zippendo/models/list_api_tokens401_response.rb +236 -0
  260. data/lib/zippendo/models/list_available_carriers200_response_inner.rb +286 -0
  261. data/lib/zippendo/models/list_available_carriers200_response_inner_required_fields_inner.rb +292 -0
  262. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner.rb +287 -0
  263. data/lib/zippendo/models/list_carrier_product_service_points200_response_inner_address.rb +314 -0
  264. data/lib/zippendo/models/list_carrier_product_service_points_request.rb +313 -0
  265. data/lib/zippendo/models/list_carrier_products200_response_inner.rb +398 -0
  266. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner.rb +321 -0
  267. data/lib/zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner.rb +219 -0
  268. data/lib/zippendo/models/list_carrier_products200_response_inner_services_inner.rb +192 -0
  269. data/lib/zippendo/models/list_carrier_products200_response_inner_weight_limits.rb +244 -0
  270. data/lib/zippendo/models/list_carriers200_response.rb +275 -0
  271. data/lib/zippendo/models/list_carriers200_response_data_inner.rb +369 -0
  272. data/lib/zippendo/models/list_carriers200_response_data_inner_config_value.rb +104 -0
  273. data/lib/zippendo/models/list_orders200_response.rb +275 -0
  274. data/lib/zippendo/models/list_orders200_response_data_inner.rb +423 -0
  275. data/lib/zippendo/models/list_orders200_response_data_inner_order_channel.rb +244 -0
  276. data/lib/zippendo/models/list_org_webhook_deliveries200_response.rb +275 -0
  277. data/lib/zippendo/models/list_org_webhook_deliveries200_response_data_inner.rb +365 -0
  278. data/lib/zippendo/models/list_org_webhooks200_response.rb +275 -0
  279. data/lib/zippendo/models/list_org_webhooks200_response_data_inner.rb +329 -0
  280. data/lib/zippendo/models/list_shipments200_response.rb +275 -0
  281. data/lib/zippendo/models/list_shipments200_response_data_inner.rb +362 -0
  282. data/lib/zippendo/models/list_shipments200_response_data_inner_address.rb +553 -0
  283. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings.rb +250 -0
  284. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value.rb +105 -0
  285. data/lib/zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of.rb +259 -0
  286. data/lib/zippendo/models/list_shipping_rules200_response.rb +275 -0
  287. data/lib/zippendo/models/list_shipping_rules200_response_data_inner.rb +992 -0
  288. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner.rb +201 -0
  289. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_carrier.rb +329 -0
  290. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner.rb +107 -0
  291. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of.rb +342 -0
  292. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1.rb +364 -0
  293. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2.rb +371 -0
  294. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3.rb +344 -0
  295. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4.rb +270 -0
  296. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_label_printer.rb +192 -0
  297. data/lib/zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule.rb +192 -0
  298. data/lib/zippendo/models/revoke_api_token200_response.rb +165 -0
  299. data/lib/zippendo/models/send_shipment422_response.rb +265 -0
  300. data/lib/zippendo/models/send_shipment422_response_errors_inner.rb +175 -0
  301. data/lib/zippendo/models/split_shipment201_response.rb +190 -0
  302. data/lib/zippendo/models/split_shipment_parcel200_response.rb +164 -0
  303. data/lib/zippendo/models/split_shipment_parcel_request.rb +176 -0
  304. data/lib/zippendo/models/split_shipment_parcel_request_parcels_inner.rb +186 -0
  305. data/lib/zippendo/models/split_shipment_request.rb +231 -0
  306. data/lib/zippendo/models/test_org_webhook200_response.rb +165 -0
  307. data/lib/zippendo/models/track_shipment200_response.rb +251 -0
  308. data/lib/zippendo/models/track_shipment200_response_events_inner.rb +296 -0
  309. data/lib/zippendo/models/update_address_request.rb +471 -0
  310. data/lib/zippendo/models/update_api_token_request.rb +183 -0
  311. data/lib/zippendo/models/update_carrier_request.rb +208 -0
  312. data/lib/zippendo/models/update_order_request.rb +400 -0
  313. data/lib/zippendo/models/update_org200_response.rb +414 -0
  314. data/lib/zippendo/models/update_org_branding_request.rb +194 -0
  315. data/lib/zippendo/models/update_org_request.rb +389 -0
  316. data/lib/zippendo/models/update_org_webhook_request.rb +235 -0
  317. data/lib/zippendo/models/update_shipment_request.rb +394 -0
  318. data/lib/zippendo/models/update_shipping_rule_request.rb +531 -0
  319. data/lib/zippendo/models/verify_api_token200_response.rb +218 -0
  320. data/lib/zippendo/models/verify_api_token_request.rb +165 -0
  321. data/lib/zippendo/version.rb +15 -0
  322. data/lib/zippendo.rb +195 -0
  323. data/spec/api/addresses_api_spec.rb +103 -0
  324. data/spec/api/billing_api_spec.rb +47 -0
  325. data/spec/api/carrier_catalog_api_spec.rb +47 -0
  326. data/spec/api/carriers_api_spec.rb +130 -0
  327. data/spec/api/orders_api_spec.rb +105 -0
  328. data/spec/api/orgs_api_spec.rb +122 -0
  329. data/spec/api/quotes_api_spec.rb +48 -0
  330. data/spec/api/rules_api_spec.rb +102 -0
  331. data/spec/api/shipments_api_spec.rb +212 -0
  332. data/spec/api/system_api_spec.rb +46 -0
  333. data/spec/api/tokens_api_spec.rb +114 -0
  334. data/spec/api/webhooks_api_spec.rb +130 -0
  335. data/spec/models/batch_send_shipments200_response_results_inner_spec.rb +68 -0
  336. data/spec/models/batch_send_shipments200_response_spec.rb +42 -0
  337. data/spec/models/batch_send_shipments200_response_summary_spec.rb +48 -0
  338. data/spec/models/batch_send_shipments_request_spec.rb +36 -0
  339. data/spec/models/batch_split_shipment201_response_spec.rb +42 -0
  340. data/spec/models/batch_split_shipment_request_shipments_inner_order_lines_inner_spec.rb +42 -0
  341. data/spec/models/batch_split_shipment_request_shipments_inner_spec.rb +42 -0
  342. data/spec/models/batch_split_shipment_request_spec.rb +66 -0
  343. data/spec/models/connect_carrier_request_spec.rb +48 -0
  344. data/spec/models/create_address_request_spec.rb +106 -0
  345. data/spec/models/create_api_token201_response_spec.rb +78 -0
  346. data/spec/models/create_api_token_request_spec.rb +52 -0
  347. data/spec/models/create_order201_response_order_lines_inner_spec.rb +148 -0
  348. data/spec/models/create_order201_response_shipping_address_spec.rb +108 -0
  349. data/spec/models/create_order201_response_spec.rb +142 -0
  350. data/spec/models/create_order_request_order_lines_inner_spec.rb +148 -0
  351. data/spec/models/create_order_request_shipping_address_spec.rb +108 -0
  352. data/spec/models/create_order_request_spec.rb +102 -0
  353. data/spec/models/create_org_webhook201_response_spec.rb +78 -0
  354. data/spec/models/create_org_webhook_request_spec.rb +58 -0
  355. data/spec/models/create_shipment201_response_activities_inner_spec.rb +64 -0
  356. data/spec/models/create_shipment201_response_documents_inner_spec.rb +90 -0
  357. data/spec/models/create_shipment201_response_errors_inner_spec.rb +60 -0
  358. data/spec/models/create_shipment201_response_logs_inner_spec.rb +82 -0
  359. data/spec/models/create_shipment201_response_parcels_inner_dimensions_spec.rb +48 -0
  360. data/spec/models/create_shipment201_response_parcels_inner_order_lines_inner_spec.rb +90 -0
  361. data/spec/models/create_shipment201_response_parcels_inner_spec.rb +100 -0
  362. data/spec/models/create_shipment201_response_parties_inner_attributes_inner_spec.rb +42 -0
  363. data/spec/models/create_shipment201_response_parties_inner_spec.rb +100 -0
  364. data/spec/models/create_shipment201_response_pickup_details_spec.rb +54 -0
  365. data/spec/models/create_shipment201_response_shipping_rule_spec.rb +102 -0
  366. data/spec/models/create_shipment201_response_spec.rb +182 -0
  367. data/spec/models/create_shipment201_response_tracking_spec.rb +66 -0
  368. data/spec/models/create_shipment_request_carrier_settings_spec.rb +54 -0
  369. data/spec/models/create_shipment_request_parcels_inner_dimensions_spec.rb +48 -0
  370. data/spec/models/create_shipment_request_parcels_inner_order_lines_inner_spec.rb +90 -0
  371. data/spec/models/create_shipment_request_parcels_inner_spec.rb +100 -0
  372. data/spec/models/create_shipment_request_parties_inner_attributes_inner_spec.rb +42 -0
  373. data/spec/models/create_shipment_request_parties_inner_spec.rb +100 -0
  374. data/spec/models/create_shipment_request_pickup_details_spec.rb +54 -0
  375. data/spec/models/create_shipment_request_spec.rb +116 -0
  376. data/spec/models/create_shipping_quote200_response_rates_inner_spec.rb +96 -0
  377. data/spec/models/create_shipping_quote200_response_spec.rb +36 -0
  378. data/spec/models/create_shipping_quote400_response_spec.rb +42 -0
  379. data/spec/models/create_shipping_quote404_response_spec.rb +42 -0
  380. data/spec/models/create_shipping_quote_request_destination_spec.rb +66 -0
  381. data/spec/models/create_shipping_quote_request_items_inner_spec.rb +72 -0
  382. data/spec/models/create_shipping_quote_request_spec.rb +54 -0
  383. data/spec/models/create_shipping_rule201_response_spec.rb +208 -0
  384. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_inner_spec.rb +42 -0
  385. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner_spec.rb +21 -0
  386. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_spec.rb +54 -0
  387. data/spec/models/create_shipping_rule_request_additional_parameters_any_of_value_spec.rb +21 -0
  388. data/spec/models/create_shipping_rule_request_additional_parameters_spec.rb +21 -0
  389. data/spec/models/create_shipping_rule_request_conditions_inner_one_of1_spec.rb +78 -0
  390. data/spec/models/create_shipping_rule_request_conditions_inner_one_of2_spec.rb +74 -0
  391. data/spec/models/create_shipping_rule_request_conditions_inner_one_of3_spec.rb +68 -0
  392. data/spec/models/create_shipping_rule_request_conditions_inner_one_of4_spec.rb +52 -0
  393. data/spec/models/create_shipping_rule_request_conditions_inner_one_of_spec.rb +64 -0
  394. data/spec/models/create_shipping_rule_request_conditions_inner_spec.rb +32 -0
  395. data/spec/models/create_shipping_rule_request_spec.rb +184 -0
  396. data/spec/models/delete_org_webhook200_response_spec.rb +36 -0
  397. data/spec/models/delete_shipping_rule200_response_spec.rb +36 -0
  398. data/spec/models/get_billing_usage200_response_add_ons_inner_spec.rb +58 -0
  399. data/spec/models/get_billing_usage200_response_current_period_spec.rb +42 -0
  400. data/spec/models/get_billing_usage200_response_limits_spec.rb +72 -0
  401. data/spec/models/get_billing_usage200_response_limits_team_members_spec.rb +42 -0
  402. data/spec/models/get_billing_usage200_response_shipments_spec.rb +54 -0
  403. data/spec/models/get_billing_usage200_response_spec.rb +54 -0
  404. data/spec/models/get_order200_response_shipments_inner_spec.rb +98 -0
  405. data/spec/models/get_order200_response_shipping_rule_spec.rb +102 -0
  406. data/spec/models/get_order200_response_spec.rb +160 -0
  407. data/spec/models/get_org200_response_count_spec.rb +36 -0
  408. data/spec/models/get_org200_response_spec.rb +132 -0
  409. data/spec/models/get_org_branding200_response_spec.rb +48 -0
  410. data/spec/models/health_check200_response_spec.rb +48 -0
  411. data/spec/models/list_addresses200_response_data_inner_spec.rb +130 -0
  412. data/spec/models/list_addresses200_response_spec.rb +60 -0
  413. data/spec/models/list_api_tokens200_response_data_inner_created_by_spec.rb +48 -0
  414. data/spec/models/list_api_tokens200_response_data_inner_spec.rb +78 -0
  415. data/spec/models/list_api_tokens200_response_spec.rb +60 -0
  416. data/spec/models/list_api_tokens401_response_spec.rb +52 -0
  417. data/spec/models/list_available_carriers200_response_inner_required_fields_inner_spec.rb +70 -0
  418. data/spec/models/list_available_carriers200_response_inner_spec.rb +96 -0
  419. data/spec/models/list_carrier_product_service_points200_response_inner_address_spec.rb +66 -0
  420. data/spec/models/list_carrier_product_service_points200_response_inner_spec.rb +78 -0
  421. data/spec/models/list_carrier_product_service_points_request_spec.rb +66 -0
  422. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner_spec.rb +48 -0
  423. data/spec/models/list_carrier_products200_response_inner_additional_parameters_inner_spec.rb +76 -0
  424. data/spec/models/list_carrier_products200_response_inner_services_inner_spec.rb +42 -0
  425. data/spec/models/list_carrier_products200_response_inner_spec.rb +100 -0
  426. data/spec/models/list_carrier_products200_response_inner_weight_limits_spec.rb +52 -0
  427. data/spec/models/list_carriers200_response_data_inner_config_value_spec.rb +21 -0
  428. data/spec/models/list_carriers200_response_data_inner_spec.rb +96 -0
  429. data/spec/models/list_carriers200_response_spec.rb +60 -0
  430. data/spec/models/list_orders200_response_data_inner_order_channel_spec.rb +52 -0
  431. data/spec/models/list_orders200_response_data_inner_spec.rb +106 -0
  432. data/spec/models/list_orders200_response_spec.rb +60 -0
  433. data/spec/models/list_org_webhook_deliveries200_response_data_inner_spec.rb +96 -0
  434. data/spec/models/list_org_webhook_deliveries200_response_spec.rb +60 -0
  435. data/spec/models/list_org_webhooks200_response_data_inner_spec.rb +72 -0
  436. data/spec/models/list_org_webhooks200_response_spec.rb +60 -0
  437. data/spec/models/list_shipments200_response_data_inner_address_spec.rb +130 -0
  438. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of_spec.rb +54 -0
  439. data/spec/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_spec.rb +21 -0
  440. data/spec/models/list_shipments200_response_data_inner_carrier_settings_spec.rb +54 -0
  441. data/spec/models/list_shipments200_response_data_inner_spec.rb +86 -0
  442. data/spec/models/list_shipments200_response_spec.rb +60 -0
  443. data/spec/models/list_shipping_rules200_response_data_inner_additional_parameters_inner_spec.rb +42 -0
  444. data/spec/models/list_shipping_rules200_response_data_inner_carrier_spec.rb +72 -0
  445. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1_spec.rb +78 -0
  446. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2_spec.rb +74 -0
  447. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3_spec.rb +68 -0
  448. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4_spec.rb +52 -0
  449. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of_spec.rb +64 -0
  450. data/spec/models/list_shipping_rules200_response_data_inner_conditions_inner_spec.rb +32 -0
  451. data/spec/models/list_shipping_rules200_response_data_inner_label_printer_spec.rb +42 -0
  452. data/spec/models/list_shipping_rules200_response_data_inner_return_shipping_rule_spec.rb +42 -0
  453. data/spec/models/list_shipping_rules200_response_data_inner_spec.rb +238 -0
  454. data/spec/models/list_shipping_rules200_response_spec.rb +60 -0
  455. data/spec/models/revoke_api_token200_response_spec.rb +36 -0
  456. data/spec/models/send_shipment422_response_errors_inner_spec.rb +42 -0
  457. data/spec/models/send_shipment422_response_spec.rb +58 -0
  458. data/spec/models/split_shipment201_response_spec.rb +42 -0
  459. data/spec/models/split_shipment_parcel200_response_spec.rb +36 -0
  460. data/spec/models/split_shipment_parcel_request_parcels_inner_spec.rb +42 -0
  461. data/spec/models/split_shipment_parcel_request_spec.rb +36 -0
  462. data/spec/models/split_shipment_request_spec.rb +72 -0
  463. data/spec/models/test_org_webhook200_response_spec.rb +36 -0
  464. data/spec/models/track_shipment200_response_events_inner_spec.rb +70 -0
  465. data/spec/models/track_shipment200_response_spec.rb +64 -0
  466. data/spec/models/update_address_request_spec.rb +106 -0
  467. data/spec/models/update_api_token_request_spec.rb +36 -0
  468. data/spec/models/update_carrier_request_spec.rb +48 -0
  469. data/spec/models/update_order_request_spec.rb +100 -0
  470. data/spec/models/update_org200_response_spec.rb +126 -0
  471. data/spec/models/update_org_branding_request_spec.rb +42 -0
  472. data/spec/models/update_org_request_spec.rb +118 -0
  473. data/spec/models/update_org_webhook_request_spec.rb +58 -0
  474. data/spec/models/update_shipment_request_spec.rb +122 -0
  475. data/spec/models/update_shipping_rule_request_spec.rb +184 -0
  476. data/spec/models/verify_api_token200_response_spec.rb +66 -0
  477. data/spec/models/verify_api_token_request_spec.rb +36 -0
  478. data/spec/spec_helper.rb +111 -0
  479. data/zippendo.gemspec +39 -0
  480. metadata +715 -0
@@ -0,0 +1,30 @@
1
+ # Zippendo::CreateShippingQuoteRequestItemsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Item name | |
8
+ | **sku** | **String** | SKU identifier | [optional] |
9
+ | **quantity** | **Integer** | Quantity | |
10
+ | **grams** | **Float** | Weight in grams | |
11
+ | **price** | **Float** | Price in cents | |
12
+ | **product_id** | **String** | Product ID | [optional] |
13
+ | **variant_id** | **String** | Variant ID | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zippendo'
19
+
20
+ instance = Zippendo::CreateShippingQuoteRequestItemsInner.new(
21
+ name: Uld trøje,
22
+ sku: SKU-1001,
23
+ quantity: 2,
24
+ grams: 500,
25
+ price: 29900,
26
+ product_id: prod_01HZX9K2QF,
27
+ variant_id: var_01HZX9K2QF
28
+ )
29
+ ```
30
+
@@ -0,0 +1,74 @@
1
+ # Zippendo::CreateShippingRule201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique shipping rule identifier | |
8
+ | **name** | **String** | Shipping rule name | |
9
+ | **description** | **String** | Optional description | |
10
+ | **direction** | **String** | Whether this rule is for outbound or inbound (return) shipments | [default to 'outbound'] |
11
+ | **carrier_id** | **String** | Carrier ID | |
12
+ | **product_id** | **String** | Product ID from carrier | |
13
+ | **services** | **Array<String>** | List of selected services | |
14
+ | **additional_parameters** | [**Array<ListShippingRules200ResponseDataInnerAdditionalParametersInner>**](ListShippingRules200ResponseDataInnerAdditionalParametersInner.md) | Carrier-specific extra parameters. DEPRECATED array form `[{ name, val }]` where `name` is the carrier parameter `key` (from the product's `additionalParameters[].key`, e.g. `returnFunctionality`) and `val` is the stringified value. This will change to a `{ key: value }` object in a future version — writes already accept either shape. | |
15
+ | **address_id** | **String** | Sender address ID | |
16
+ | **receiving_countries** | **Array<String>** | List of supported country codes | |
17
+ | **email_notification** | **Boolean** | Send email notification to recipient | [default to false] |
18
+ | **phone_notification** | **Boolean** | Send SMS notification to recipient | [default to false] |
19
+ | **min_weight** | **Float** | Minimum required weight in kg. Orders below this are excluded from the rule. | |
20
+ | **max_weight** | **Float** | Maximum allowed weight in kg. Orders exceeding this are excluded from the rule. | |
21
+ | **min_order_value** | **Float** | Minimum required order value in currency units. Orders below this are excluded from the rule. | |
22
+ | **max_order_value** | **Float** | Maximum allowed order value in currency units. Orders exceeding this are excluded from the rule. | |
23
+ | **conditions** | [**Array<ListShippingRules200ResponseDataInnerConditionsInner>**](ListShippingRules200ResponseDataInnerConditionsInner.md) | Rule conditions (weight/price/quantity) | |
24
+ | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [default to false] |
25
+ | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [default to false] |
26
+ | **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [default to false] |
27
+ | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [default to false] |
28
+ | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [default to false] |
29
+ | **label_printer_id** | **String** | ID of the label printer | |
30
+ | **document_printer_id** | **String** | ID of the document printer | |
31
+ | **return_shipping_rule_id** | **String** | ID of the return shipping rule | |
32
+ | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [default to false] |
33
+ | **org_id** | **String** | Owning organization ID | |
34
+ | **created_at** | **String** | Creation timestamp (ISO 8601) | |
35
+ | **updated_at** | **String** | Last update timestamp (ISO 8601) | |
36
+
37
+ ## Example
38
+
39
+ ```ruby
40
+ require 'zippendo'
41
+
42
+ instance = Zippendo::CreateShippingRule201Response.new(
43
+ id: rule_01HZX9K2QF,
44
+ name: Standard DK,
45
+ description: Standard levering i Danmark,
46
+ direction: outbound,
47
+ carrier_id: carr_01HZX9K2QF,
48
+ product_id: PNL13,
49
+ services: ["EMAIL_NOTIFICATION"],
50
+ additional_parameters: [{"name":"returnFunctionality","val":"LABELLESS"}],
51
+ address_id: addr_01HZX9K2QF,
52
+ receiving_countries: ["DK","SE"],
53
+ email_notification: true,
54
+ phone_notification: false,
55
+ min_weight: 0,
56
+ max_weight: 20,
57
+ min_order_value: 0,
58
+ max_order_value: 5000,
59
+ conditions: [{"type":"flatRate","shippingPrice":39,"currency":"DKK"}],
60
+ generate_proforma_invoice: false,
61
+ generate_commercial_invoice: false,
62
+ generate_packing_list: false,
63
+ auto_print_labels: false,
64
+ auto_print_documents: false,
65
+ label_printer_id: null,
66
+ document_printer_id: null,
67
+ return_shipping_rule_id: null,
68
+ auto_create_return_shipment: false,
69
+ org_id: org_01HZX9K2QF,
70
+ created_at: 2026-06-22T09:00:00.000Z,
71
+ updated_at: 2026-06-22T09:00:00.000Z
72
+ )
73
+ ```
74
+
@@ -0,0 +1,66 @@
1
+ # Zippendo::CreateShippingRuleRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Shipping rule name | |
8
+ | **description** | **String** | Optional description | [optional] |
9
+ | **direction** | **String** | Whether this rule is for outbound or inbound (return) shipments | [optional][default to 'outbound'] |
10
+ | **carrier_id** | **String** | Carrier ID | |
11
+ | **product_id** | **String** | Product ID from carrier | |
12
+ | **services** | **Array<String>** | List of selected services | |
13
+ | **additional_parameters** | [**CreateShippingRuleRequestAdditionalParameters**](CreateShippingRuleRequestAdditionalParameters.md) | | [optional] |
14
+ | **address_id** | **String** | Sender address ID | |
15
+ | **receiving_countries** | **Array<String>** | List of supported country codes | |
16
+ | **email_notification** | **Boolean** | Send email notification to recipient | [optional][default to false] |
17
+ | **phone_notification** | **Boolean** | Send SMS notification to recipient | [optional][default to false] |
18
+ | **min_weight** | **Float** | Minimum required weight in kg | [optional] |
19
+ | **max_weight** | **Float** | Maximum allowed weight in kg | [optional] |
20
+ | **min_order_value** | **Float** | Minimum required order value in currency units | [optional] |
21
+ | **max_order_value** | **Float** | Maximum allowed order value in currency units | [optional] |
22
+ | **conditions** | [**Array<CreateShippingRuleRequestConditionsInner>**](CreateShippingRuleRequestConditionsInner.md) | Rule conditions (weight/price/quantity) | |
23
+ | **generate_proforma_invoice** | **Boolean** | Generate proforma invoice for shipments | [optional][default to false] |
24
+ | **generate_commercial_invoice** | **Boolean** | Generate commercial invoice for international shipments | [optional][default to false] |
25
+ | **generate_packing_list** | **Boolean** | Generate packing slip with package and item details | [optional][default to false] |
26
+ | **auto_print_labels** | **Boolean** | Automatically print labels when shipment is sent | [optional][default to false] |
27
+ | **auto_print_documents** | **Boolean** | Automatically print documents when shipment is sent | [optional][default to false] |
28
+ | **label_printer_id** | **String** | ID of the label printer | [optional] |
29
+ | **document_printer_id** | **String** | ID of the document printer | [optional] |
30
+ | **return_shipping_rule_id** | **String** | ID of the return shipping rule | [optional] |
31
+ | **auto_create_return_shipment** | **Boolean** | Automatically create and send a return shipment on dispatch | [optional][default to false] |
32
+
33
+ ## Example
34
+
35
+ ```ruby
36
+ require 'zippendo'
37
+
38
+ instance = Zippendo::CreateShippingRuleRequest.new(
39
+ name: Standard DK,
40
+ description: Standard levering i Danmark,
41
+ direction: outbound,
42
+ carrier_id: carr_01HZX9K2QF,
43
+ product_id: PNL13,
44
+ services: ["EMAIL_NOTIFICATION"],
45
+ additional_parameters: null,
46
+ address_id: addr_01HZX9K2QF,
47
+ receiving_countries: ["DK","SE"],
48
+ email_notification: true,
49
+ phone_notification: false,
50
+ min_weight: 0,
51
+ max_weight: 20,
52
+ min_order_value: 0,
53
+ max_order_value: 5000,
54
+ conditions: [{"type":"flatRate","shippingPrice":39,"currency":"DKK"}],
55
+ generate_proforma_invoice: false,
56
+ generate_commercial_invoice: false,
57
+ generate_packing_list: false,
58
+ auto_print_labels: false,
59
+ auto_print_documents: false,
60
+ label_printer_id: null,
61
+ document_printer_id: null,
62
+ return_shipping_rule_id: null,
63
+ auto_create_return_shipment: false
64
+ )
65
+ ```
66
+
@@ -0,0 +1,15 @@
1
+ # Zippendo::CreateShippingRuleRequestAdditionalParameters
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'zippendo'
12
+
13
+ instance = Zippendo::CreateShippingRuleRequestAdditionalParameters.new()
14
+ ```
15
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Carrier parameter key | |
8
+ | **val** | **String** | Parameter value (stringified) | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfInner.new(
16
+ name: returnFunctionality,
17
+ val: LABELLESS
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValue
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the selected service point. | |
8
+ | **name** | **String** | Display name of the service point. | |
9
+ | **address** | **String** | Formatted address of the service point. | |
10
+ | **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValue.new(
18
+ id: sp_pn_4521,
19
+ name: Føtex Nørrebro,
20
+ address: Nørrebrogade 20, 2200 København N,
21
+ coordinates: [55.6987, 12.5501]
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Identifier of the selected service point. | |
8
+ | **name** | **String** | Display name of the service point. | |
9
+ | **address** | **String** | Formatted address of the service point. | |
10
+ | **coordinates** | [**Array<CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner>**](CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.md) | Latitude/longitude of the service point. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOf.new(
18
+ id: sp_pn_4521,
19
+ name: Føtex Nørrebro,
20
+ address: Nørrebrogade 20, 2200 København N,
21
+ coordinates: [55.6987,12.5501]
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'zippendo'
12
+
13
+ instance = Zippendo::CreateShippingRuleRequestAdditionalParametersAnyOfValueAnyOfCoordinatesInner.new()
14
+ ```
15
+
@@ -0,0 +1,55 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInner
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'zippendo'
13
+
14
+ Zippendo::CreateShippingRuleRequestConditionsInner.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'CreateShippingRuleRequestConditionsInnerOneOf',
18
+ # :'CreateShippingRuleRequestConditionsInnerOneOf1',
19
+ # :'CreateShippingRuleRequestConditionsInnerOneOf2',
20
+ # :'CreateShippingRuleRequestConditionsInnerOneOf3',
21
+ # :'CreateShippingRuleRequestConditionsInnerOneOf4'
22
+ # ]
23
+ ```
24
+
25
+ ### build
26
+
27
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
28
+
29
+ #### Example
30
+
31
+ ```ruby
32
+ require 'zippendo'
33
+
34
+ Zippendo::CreateShippingRuleRequestConditionsInner.build(data)
35
+ # => #<CreateShippingRuleRequestConditionsInnerOneOf:0x00007fdd4aab02a0>
36
+
37
+ Zippendo::CreateShippingRuleRequestConditionsInner.build(data_that_doesnt_match)
38
+ # => nil
39
+ ```
40
+
41
+ #### Parameters
42
+
43
+ | Name | Type | Description |
44
+ | ---- | ---- | ----------- |
45
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
46
+
47
+ #### Return type
48
+
49
+ - `CreateShippingRuleRequestConditionsInnerOneOf`
50
+ - `CreateShippingRuleRequestConditionsInnerOneOf1`
51
+ - `CreateShippingRuleRequestConditionsInnerOneOf2`
52
+ - `CreateShippingRuleRequestConditionsInnerOneOf3`
53
+ - `CreateShippingRuleRequestConditionsInnerOneOf4`
54
+ - `nil` (if no type matches)
55
+
@@ -0,0 +1,26 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInnerOneOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Condition type discriminator | |
8
+ | **min** | **Float** | Minimum weight in kg (inclusive) | |
9
+ | **max** | **Float** | Maximum weight in kg (inclusive) | |
10
+ | **shipping_price** | **Float** | Shipping price when condition matches | |
11
+ | **currency** | **String** | ISO 4217 currency code | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zippendo'
17
+
18
+ instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf.new(
19
+ type: weight,
20
+ min: 0,
21
+ max: 5,
22
+ shipping_price: 39,
23
+ currency: DKK
24
+ )
25
+ ```
26
+
@@ -0,0 +1,28 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInnerOneOf1
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Condition type discriminator | |
8
+ | **price_type** | **String** | Whether to compare against subtotal (before discounts) or total (after discounts) | [optional][default to &#39;total&#39;] |
9
+ | **operator** | **String** | Comparison operator | |
10
+ | **value** | **Float** | Price value to compare against | |
11
+ | **shipping_price** | **Float** | Shipping price when condition matches | |
12
+ | **currency** | **String** | ISO 4217 currency code | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zippendo'
18
+
19
+ instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf1.new(
20
+ type: price,
21
+ price_type: total,
22
+ operator: gte,
23
+ value: 500,
24
+ shipping_price: 0,
25
+ currency: DKK
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInnerOneOf2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Condition type discriminator | |
8
+ | **price_type** | **String** | Whether to compare against subtotal (before discounts) or total (after discounts) | [optional][default to &#39;total&#39;] |
9
+ | **min** | **Float** | Minimum cart value (inclusive) | |
10
+ | **max** | **Float** | Maximum cart value (inclusive) | |
11
+ | **shipping_price** | **Float** | Shipping price when condition matches | |
12
+ | **currency** | **String** | ISO 4217 currency code | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zippendo'
18
+
19
+ instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf2.new(
20
+ type: priceRange,
21
+ price_type: total,
22
+ min: 0,
23
+ max: 499,
24
+ shipping_price: 49,
25
+ currency: DKK
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInnerOneOf3
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Condition type discriminator | |
8
+ | **operator** | **String** | Comparison operator | |
9
+ | **value** | **Integer** | Quantity value to compare against | |
10
+ | **shipping_price** | **Float** | Shipping price when condition matches | |
11
+ | **currency** | **String** | ISO 4217 currency code | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zippendo'
17
+
18
+ instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf3.new(
19
+ type: quantity,
20
+ operator: gte,
21
+ value: 3,
22
+ shipping_price: 0,
23
+ currency: DKK
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # Zippendo::CreateShippingRuleRequestConditionsInnerOneOf4
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Condition type discriminator | |
8
+ | **shipping_price** | **Float** | Flat shipping price | |
9
+ | **currency** | **String** | ISO 4217 currency code | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zippendo'
15
+
16
+ instance = Zippendo::CreateShippingRuleRequestConditionsInnerOneOf4.new(
17
+ type: flatRate,
18
+ shipping_price: 39,
19
+ currency: DKK
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # Zippendo::DeleteOrgWebhook200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Result message | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zippendo'
13
+
14
+ instance = Zippendo::DeleteOrgWebhook200Response.new(
15
+ message: Webhook deleted successfully
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # Zippendo::DeleteShippingRule200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **success** | **Boolean** | Whether the rule was deleted | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zippendo'
13
+
14
+ instance = Zippendo::DeleteShippingRule200Response.new(
15
+ success: true
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::GetBillingUsage200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **current_period** | [**GetBillingUsage200ResponseCurrentPeriod**](GetBillingUsage200ResponseCurrentPeriod.md) | | |
8
+ | **shipments** | [**GetBillingUsage200ResponseShipments**](GetBillingUsage200ResponseShipments.md) | | |
9
+ | **limits** | [**GetBillingUsage200ResponseLimits**](GetBillingUsage200ResponseLimits.md) | | |
10
+ | **add_ons** | [**Array&lt;GetBillingUsage200ResponseAddOnsInner&gt;**](GetBillingUsage200ResponseAddOnsInner.md) | Active add-ons on the subscription | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::GetBillingUsage200Response.new(
18
+ current_period: null,
19
+ shipments: null,
20
+ limits: null,
21
+ add_ons: []
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::GetBillingUsage200ResponseAddOnsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Type of billing add-on | |
8
+ | **quantity** | **Float** | Number of add-on units purchased | |
9
+ | **unit_price** | **Float** | Price per unit per month, in øre | |
10
+ | **total_price** | **Float** | Total price per month, in øre | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::GetBillingUsage200ResponseAddOnsInner.new(
18
+ type: extra_carrier,
19
+ quantity: 2,
20
+ unit_price: 9900,
21
+ total_price: 19800
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::GetBillingUsage200ResponseCurrentPeriod
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **start** | **String** | Start of the current usage period (ISO 8601) | |
8
+ | **_end** | **String** | End of the current usage period (ISO 8601) | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::GetBillingUsage200ResponseCurrentPeriod.new(
16
+ start: 2026-06-01T00:00:00.000Z,
17
+ _end: 2026-07-01T00:00:00.000Z
18
+ )
19
+ ```
20
+
@@ -0,0 +1,30 @@
1
+ # Zippendo::GetBillingUsage200ResponseLimits
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **team_members** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
8
+ | **carriers** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
9
+ | **order_channels** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
10
+ | **shipping_rules** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
11
+ | **addresses** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
12
+ | **api_tokens** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
13
+ | **automations** | [**GetBillingUsage200ResponseLimitsTeamMembers**](GetBillingUsage200ResponseLimitsTeamMembers.md) | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zippendo'
19
+
20
+ instance = Zippendo::GetBillingUsage200ResponseLimits.new(
21
+ team_members: null,
22
+ carriers: null,
23
+ order_channels: null,
24
+ shipping_rules: null,
25
+ addresses: null,
26
+ api_tokens: null,
27
+ automations: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::GetBillingUsage200ResponseLimitsTeamMembers
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **used** | **Float** | Amount of the resource currently used | |
8
+ | **limit** | **Float** | Maximum allowed (-1 for unlimited) | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::GetBillingUsage200ResponseLimitsTeamMembers.new(
16
+ used: 3,
17
+ limit: 5
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::GetBillingUsage200ResponseShipments
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **used** | **Float** | Shipments created this period | |
8
+ | **included** | **Float** | Shipments included in the plan | |
9
+ | **overage** | **Float** | Shipments above the included allowance | |
10
+ | **overage_charges** | **Float** | Overage charges so far, in øre | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::GetBillingUsage200ResponseShipments.new(
18
+ used: 1240,
19
+ included: 1000,
20
+ overage: 240,
21
+ overage_charges: 36000
22
+ )
23
+ ```
24
+