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,38 @@
1
+ # Zippendo::CreateShipment201ResponseParcelsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique parcel identifier. | [optional] |
8
+ | **weight** | **Float** | Parcel weight in the given weight unit. | |
9
+ | **weight_unit** | **String** | Unit of measurement for parcel weight. | |
10
+ | **dimensions** | [**CreateShipment201ResponseParcelsInnerDimensions**](CreateShipment201ResponseParcelsInnerDimensions.md) | | |
11
+ | **order_lines** | [**Array<CreateShipment201ResponseParcelsInnerOrderLinesInner>**](CreateShipment201ResponseParcelsInnerOrderLinesInner.md) | Order lines contained in this parcel. | |
12
+ | **tracking_number** | **String** | Carrier tracking number for this parcel. | [optional] |
13
+ | **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
14
+ | **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
15
+ | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
16
+ | **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
17
+ | **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zippendo'
23
+
24
+ instance = Zippendo::CreateShipment201ResponseParcelsInner.new(
25
+ id: prc_5a6b7c8d,
26
+ weight: 2.5,
27
+ weight_unit: kg,
28
+ dimensions: null,
29
+ order_lines: null,
30
+ tracking_number: 00370724710000012345,
31
+ tracking_url: https://tracking.postnord.com/00370724710000012345,
32
+ label_free_code: AB12CD34,
33
+ qr_code_link: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
34
+ qr_code_data_uri: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
35
+ qr_code_url: https://qr.bring.com/label-free/AB12CD34.png
36
+ )
37
+ ```
38
+
@@ -0,0 +1,22 @@
1
+ # Zippendo::CreateShipment201ResponseParcelsInnerDimensions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **length** | **Float** | Parcel length in centimetres. | |
8
+ | **width** | **Float** | Parcel width in centimetres. | |
9
+ | **height** | **Float** | Parcel height in centimetres. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zippendo'
15
+
16
+ instance = Zippendo::CreateShipment201ResponseParcelsInnerDimensions.new(
17
+ length: 30,
18
+ width: 20,
19
+ height: 15
20
+ )
21
+ ```
22
+
@@ -0,0 +1,36 @@
1
+ # Zippendo::CreateShipment201ResponseParcelsInnerOrderLinesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique order line identifier. | [optional] |
8
+ | **sku** | **String** | Stock keeping unit of the product. | |
9
+ | **quantity** | **Integer** | Number of units in this order line. | |
10
+ | **description** | **String** | Human-readable product description. | [optional] |
11
+ | **unit_price** | **Float** | Price per unit in the order line currency. | [optional] |
12
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
13
+ | **vat_percent** | **Float** | VAT percentage applied to the unit price. | [optional] |
14
+ | **location** | **String** | Warehouse picking location. | [optional] |
15
+ | **country_of_origin** | **String** | ISO 3166-1 alpha-2 country of origin. | [optional] |
16
+ | **tarrif_number** | **String** | Customs tariff (HS) code. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'zippendo'
22
+
23
+ instance = Zippendo::CreateShipment201ResponseParcelsInnerOrderLinesInner.new(
24
+ id: ol_9c1d2e3f,
25
+ sku: SKU-1024,
26
+ quantity: 2,
27
+ description: Wool sweater, navy,
28
+ unit_price: 299.95,
29
+ currency: DKK,
30
+ vat_percent: 25,
31
+ location: A-12-3,
32
+ country_of_origin: DK,
33
+ tarrif_number: 61101100
34
+ )
35
+ ```
36
+
@@ -0,0 +1,38 @@
1
+ # Zippendo::CreateShipment201ResponsePartiesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Role of the party in the shipment. | |
8
+ | **name** | **String** | Full name or company name of the party. | |
9
+ | **attention** | **String** | Attention contact at the party. | [optional] |
10
+ | **address1** | **String** | Primary street address line. | |
11
+ | **address2** | **String** | Secondary address line. | [optional] |
12
+ | **postal_code** | **String** | Postal code of the party address. | |
13
+ | **city** | **String** | City of the party address. | |
14
+ | **country_code** | **String** | ISO 3166-1 alpha-2 country code. | |
15
+ | **email** | **String** | Email address of the party. | [optional] |
16
+ | **phone** | **String** | Phone number of the party in E.164 format. | [optional] |
17
+ | **attributes** | [**Array<CreateShipment201ResponsePartiesInnerAttributesInner>**](CreateShipment201ResponsePartiesInnerAttributesInner.md) | Additional carrier-specific attributes for the party. | |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zippendo'
23
+
24
+ instance = Zippendo::CreateShipment201ResponsePartiesInner.new(
25
+ type: receiver,
26
+ name: Anna Jensen,
27
+ attention: Reception,
28
+ address1: Vesterbrogade 12,
29
+ address2: 2. sal,
30
+ postal_code: 1620,
31
+ city: København V,
32
+ country_code: DK,
33
+ email: anna@example.dk,
34
+ phone: +4520123456,
35
+ attributes: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::CreateShipment201ResponsePartiesInnerAttributesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the party attribute. | |
8
+ | **value** | **String** | Value of the party attribute. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::CreateShipment201ResponsePartiesInnerAttributesInner.new(
16
+ name: vatNumber,
17
+ value: DK12345678
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShipment201ResponsePickupDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date** | **String** | Requested pickup date (YYYY-MM-DD). | |
8
+ | **from** | **String** | Requested earliest pickup time (HH:MM:SS). | |
9
+ | **to** | **String** | Requested latest pickup time (HH:MM:SS). | |
10
+ | **instruction** | **String** | Pickup instruction to the carrier. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShipment201ResponsePickupDetails.new(
18
+ date: 2026-06-22,
19
+ from: 08:00:00,
20
+ to: 16:00:00,
21
+ instruction: Ring the bell at the loading dock.
22
+ )
23
+ ```
24
+
@@ -0,0 +1,40 @@
1
+ # Zippendo::CreateShipment201ResponseShippingRule
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique shipping rule identifier. | |
8
+ | **name** | **String** | Display name of the shipping rule. | |
9
+ | **carrier_id** | **String** | Carrier applied by the rule. | |
10
+ | **product_id** | **String** | Carrier product applied by the rule. | |
11
+ | **services** | **Array<String>** | Additional service codes applied by the rule. | |
12
+ | **address_id** | **String** | Sender address applied by the rule. | |
13
+ | **return_shipping_rule_id** | **String** | Shipping rule used for return shipments. | [optional] |
14
+ | **auto_create_return_shipment** | **Boolean** | Whether a return shipment is created automatically. | [optional] |
15
+ | **auto_print_labels** | **Boolean** | Whether labels are printed automatically on send. | [optional] |
16
+ | **auto_print_documents** | **Boolean** | Whether documents are printed automatically on send. | [optional] |
17
+ | **label_printer_id** | **String** | Printer used for labels. | [optional] |
18
+ | **document_printer_id** | **String** | Printer used for documents. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'zippendo'
24
+
25
+ instance = Zippendo::CreateShipment201ResponseShippingRule.new(
26
+ id: rule_3c4d5e6f,
27
+ name: Domestic standard,
28
+ carrier_id: car_pn_001,
29
+ product_id: prod_mypack_home,
30
+ services: ["A7"],
31
+ address_id: addr_7e8f9a0b,
32
+ return_shipping_rule_id: rule_return_01,
33
+ auto_create_return_shipment: false,
34
+ auto_print_labels: true,
35
+ auto_print_documents: false,
36
+ label_printer_id: prn_label_01,
37
+ document_printer_id: prn_doc_01
38
+ )
39
+ ```
40
+
@@ -0,0 +1,28 @@
1
+ # Zippendo::CreateShipment201ResponseTracking
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **url** | **String** | Public carrier tracking URL. | [optional] |
8
+ | **number** | **String** | Carrier tracking number. | [optional] |
9
+ | **label_free_code** | **String** | Label-free drop-off code. | [optional] |
10
+ | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
11
+ | **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
12
+ | **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zippendo'
18
+
19
+ instance = Zippendo::CreateShipment201ResponseTracking.new(
20
+ url: https://tracking.postnord.com/00370724710000012345,
21
+ number: 00370724710000012345,
22
+ label_free_code: AB12CD34,
23
+ qr_code_link: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
24
+ qr_code_data_uri: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
25
+ qr_code_url: https://qr.bring.com/label-free/AB12CD34.png
26
+ )
27
+ ```
28
+
@@ -0,0 +1,42 @@
1
+ # Zippendo::CreateShipmentRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reference** | **String** | Customer-facing shipment reference. | [optional] |
8
+ | **address_id** | **String** | Sender address identifier. | [optional] |
9
+ | **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
10
+ | **parties** | [**Array<CreateShipmentRequestPartiesInner>**](CreateShipmentRequestPartiesInner.md) | Parties involved in the shipment. Optional when orderId is provided. | [optional] |
11
+ | **type** | **String** | Direction of the shipment relative to the organization. | |
12
+ | **carrier_settings** | [**CreateShipmentRequestCarrierSettings**](CreateShipmentRequestCarrierSettings.md) | | |
13
+ | **parcels** | [**Array<CreateShipmentRequestParcelsInner>**](CreateShipmentRequestParcelsInner.md) | Parcels to include. Optional when orderId is provided. | [optional] |
14
+ | **pickup_details** | [**CreateShipmentRequestPickupDetails**](CreateShipmentRequestPickupDetails.md) | | [optional] |
15
+ | **term_of_trade** | **String** | Incoterm governing the shipment. | [optional][default to 'DAP'] |
16
+ | **status** | **String** | Lifecycle status of the shipment. | [optional][default to 'pending'] |
17
+ | **order_id** | **String** | Order to derive parties and parcels from. | [optional] |
18
+ | **label_printer_id** | **String** | Printer to assign for labels. | [optional] |
19
+ | **document_printer_id** | **String** | Printer to assign for documents. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'zippendo'
25
+
26
+ instance = Zippendo::CreateShipmentRequest.new(
27
+ reference: ORDER-1042,
28
+ address_id: addr_7e8f9a0b,
29
+ service_point_id: sp_pn_4521,
30
+ parties: null,
31
+ type: outbound,
32
+ carrier_settings: null,
33
+ parcels: null,
34
+ pickup_details: null,
35
+ term_of_trade: DAP,
36
+ status: pending,
37
+ order_id: ord_5e6f7a8b,
38
+ label_printer_id: prn_label_01,
39
+ document_printer_id: prn_doc_01
40
+ )
41
+ ```
42
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShipmentRequestCarrierSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **carrier_id** | **String** | Identifier of the carrier to use. | |
8
+ | **product_id** | **String** | Identifier of the carrier product/service. | |
9
+ | **services** | **Array<String>** | Additional service codes requested from the carrier. | |
10
+ | **additional_parameters** | [**Hash<String, CreateShippingRuleRequestAdditionalParametersAnyOfValue>**](CreateShippingRuleRequestAdditionalParametersAnyOfValue.md) | Carrier-specific extra parameters as key/value pairs. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShipmentRequestCarrierSettings.new(
18
+ carrier_id: car_pn_001,
19
+ product_id: prod_mypack_home,
20
+ services: ["A7"],
21
+ additional_parameters: {"notificationEmail":"anna@example.dk"}
22
+ )
23
+ ```
24
+
@@ -0,0 +1,38 @@
1
+ # Zippendo::CreateShipmentRequestParcelsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique parcel identifier. | [optional] |
8
+ | **weight** | **Float** | Parcel weight in the given weight unit. | |
9
+ | **weight_unit** | **String** | Unit of measurement for parcel weight. | |
10
+ | **dimensions** | [**CreateShipmentRequestParcelsInnerDimensions**](CreateShipmentRequestParcelsInnerDimensions.md) | | |
11
+ | **order_lines** | [**Array<CreateShipmentRequestParcelsInnerOrderLinesInner>**](CreateShipmentRequestParcelsInnerOrderLinesInner.md) | Order lines contained in this parcel. | |
12
+ | **tracking_number** | **String** | Carrier tracking number for this parcel. | [optional] |
13
+ | **tracking_url** | **String** | Public carrier tracking URL for this parcel. | [optional] |
14
+ | **label_free_code** | **String** | Label-free drop-off code for the parcel. | [optional] |
15
+ | **qr_code_link** | **String** | DEPRECATED — use `qrCodeDataUri` (embeddable data URI) or `qrCodeUrl` (hosted link). Catch-all that carries whichever applies, kept populated for backwards compatibility during the migration and until it is disabled. | [optional] |
16
+ | **qr_code_data_uri** | **String** | Embeddable `data:` URI of the QR code image for label-free drop-off — base64 image bytes you can drop straight into an <img>/email. Null when the carrier returns a hosted link instead (see `qrCodeUrl`). | [optional] |
17
+ | **qr_code_url** | **String** | Carrier-hosted URL of the QR code image for label-free drop-off, returned by carriers (e.g. Bring) that link to the image rather than embedding it. Null when the carrier returns embeddable bytes (see `qrCodeDataUri`). | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zippendo'
23
+
24
+ instance = Zippendo::CreateShipmentRequestParcelsInner.new(
25
+ id: prc_5a6b7c8d,
26
+ weight: 2.5,
27
+ weight_unit: kg,
28
+ dimensions: null,
29
+ order_lines: null,
30
+ tracking_number: 00370724710000012345,
31
+ tracking_url: https://tracking.postnord.com/00370724710000012345,
32
+ label_free_code: AB12CD34,
33
+ qr_code_link: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
34
+ qr_code_data_uri: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==,
35
+ qr_code_url: https://qr.bring.com/label-free/AB12CD34.png
36
+ )
37
+ ```
38
+
@@ -0,0 +1,22 @@
1
+ # Zippendo::CreateShipmentRequestParcelsInnerDimensions
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **length** | **Float** | Parcel length in centimetres. | |
8
+ | **width** | **Float** | Parcel width in centimetres. | |
9
+ | **height** | **Float** | Parcel height in centimetres. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zippendo'
15
+
16
+ instance = Zippendo::CreateShipmentRequestParcelsInnerDimensions.new(
17
+ length: 30,
18
+ width: 20,
19
+ height: 15
20
+ )
21
+ ```
22
+
@@ -0,0 +1,36 @@
1
+ # Zippendo::CreateShipmentRequestParcelsInnerOrderLinesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique order line identifier. | [optional] |
8
+ | **sku** | **String** | Stock keeping unit of the product. | |
9
+ | **quantity** | **Integer** | Number of units in this order line. | |
10
+ | **description** | **String** | Human-readable product description. | [optional] |
11
+ | **unit_price** | **Float** | Price per unit in the order line currency. | [optional] |
12
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
13
+ | **vat_percent** | **Float** | VAT percentage applied to the unit price. | [optional] |
14
+ | **location** | **String** | Warehouse picking location. | [optional] |
15
+ | **country_of_origin** | **String** | ISO 3166-1 alpha-2 country of origin. | [optional] |
16
+ | **tarrif_number** | **String** | Customs tariff (HS) code. | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'zippendo'
22
+
23
+ instance = Zippendo::CreateShipmentRequestParcelsInnerOrderLinesInner.new(
24
+ id: ol_9c1d2e3f,
25
+ sku: SKU-1024,
26
+ quantity: 2,
27
+ description: Wool sweater, navy,
28
+ unit_price: 299.95,
29
+ currency: DKK,
30
+ vat_percent: 25,
31
+ location: A-12-3,
32
+ country_of_origin: DK,
33
+ tarrif_number: 61101100
34
+ )
35
+ ```
36
+
@@ -0,0 +1,38 @@
1
+ # Zippendo::CreateShipmentRequestPartiesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | Role of the party in the shipment. | |
8
+ | **name** | **String** | Full name or company name of the party. | |
9
+ | **attention** | **String** | Attention contact at the party. | [optional] |
10
+ | **address1** | **String** | Primary street address line. | |
11
+ | **address2** | **String** | Secondary address line. | [optional] |
12
+ | **postal_code** | **String** | Postal code of the party address. | |
13
+ | **city** | **String** | City of the party address. | |
14
+ | **country_code** | **String** | ISO 3166-1 alpha-2 country code. | |
15
+ | **email** | **String** | Email address of the party. | [optional] |
16
+ | **phone** | **String** | Phone number of the party in E.164 format. | [optional] |
17
+ | **attributes** | [**Array<CreateShipmentRequestPartiesInnerAttributesInner>**](CreateShipmentRequestPartiesInnerAttributesInner.md) | Additional carrier-specific attributes for the party. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zippendo'
23
+
24
+ instance = Zippendo::CreateShipmentRequestPartiesInner.new(
25
+ type: receiver,
26
+ name: Anna Jensen,
27
+ attention: Reception,
28
+ address1: Vesterbrogade 12,
29
+ address2: 2. sal,
30
+ postal_code: 1620,
31
+ city: København V,
32
+ country_code: DK,
33
+ email: anna@example.dk,
34
+ phone: +4520123456,
35
+ attributes: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::CreateShipmentRequestPartiesInnerAttributesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the party attribute. | |
8
+ | **value** | **String** | Value of the party attribute. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::CreateShipmentRequestPartiesInnerAttributesInner.new(
16
+ name: vatNumber,
17
+ value: DK12345678
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShipmentRequestPickupDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **date** | **String** | Requested pickup date (YYYY-MM-DD). | |
8
+ | **from** | **String** | Requested earliest pickup time (HH:MM:SS). | |
9
+ | **to** | **String** | Requested latest pickup time (HH:MM:SS). | |
10
+ | **instruction** | **String** | Pickup instruction to the carrier. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShipmentRequestPickupDetails.new(
18
+ date: 2026-06-22,
19
+ from: 08:00:00,
20
+ to: 16:00:00,
21
+ instruction: Ring the bell at the loading dock.
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # Zippendo::CreateShippingQuote200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rates** | [**Array<CreateShippingQuote200ResponseRatesInner>**](CreateShippingQuote200ResponseRatesInner.md) | Available shipping rates | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zippendo'
13
+
14
+ instance = Zippendo::CreateShippingQuote200Response.new(
15
+ rates: []
16
+ )
17
+ ```
18
+
@@ -0,0 +1,38 @@
1
+ # Zippendo::CreateShippingQuote200ResponseRatesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **service_name** | **String** | Display name of the shipping option | |
8
+ | **service_code** | **String** | Unique identifier for this shipping option | |
9
+ | **total_price** | **String** | Total shipping price in cents as string | |
10
+ | **currency** | **String** | ISO 4217 currency code | |
11
+ | **description** | **String** | Optional description | [optional] |
12
+ | **min_delivery_date** | **String** | Minimum delivery date (ISO 8601) | [optional] |
13
+ | **max_delivery_date** | **String** | Maximum delivery date (ISO 8601) | [optional] |
14
+ | **carrier_name** | **String** | Carrier display name | [optional] |
15
+ | **carrier_slug** | **String** | Carrier slug identifier | [optional] |
16
+ | **product_id** | **String** | Carrier product ID | [optional] |
17
+ | **shipping_rule_id** | **String** | Shipping rule ID that generated this rate | |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'zippendo'
23
+
24
+ instance = Zippendo::CreateShippingQuote200ResponseRatesInner.new(
25
+ service_name: Standard DK,
26
+ service_code: postnord:PNL13:rule_01HZX9K2QF,
27
+ total_price: 3900,
28
+ currency: DKK,
29
+ description: Standard levering i Danmark,
30
+ min_delivery_date: 2026-06-24,
31
+ max_delivery_date: 2026-06-26,
32
+ carrier_name: PostNord,
33
+ carrier_slug: postnord,
34
+ product_id: PNL13,
35
+ shipping_rule_id: rule_01HZX9K2QF
36
+ )
37
+ ```
38
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::CreateShippingQuote400Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | **String** | Error type | |
8
+ | **message** | **String** | Human-readable error message | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::CreateShippingQuote400Response.new(
16
+ error: Bad Request,
17
+ message: Invalid destination country
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # Zippendo::CreateShippingQuote404Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | **String** | Error type | |
8
+ | **message** | **String** | Human-readable error message | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zippendo'
14
+
15
+ instance = Zippendo::CreateShippingQuote404Response.new(
16
+ error: Not Found,
17
+ message: Organization not found
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateShippingQuoteRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **destination** | [**CreateShippingQuoteRequestDestination**](CreateShippingQuoteRequestDestination.md) | | |
8
+ | **items** | [**Array<CreateShippingQuoteRequestItemsInner>**](CreateShippingQuoteRequestItemsInner.md) | Cart items | |
9
+ | **currency** | **String** | ISO 4217 currency code | |
10
+ | **total_price_cents** | **Float** | Total price in cents after discounts (optional, enables total-based conditions) | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateShippingQuoteRequest.new(
18
+ destination: null,
19
+ items: [{"name":"Uld trøje","quantity":2,"grams":500,"price":29900}],
20
+ currency: DKK,
21
+ total_price_cents: 59800
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # Zippendo::CreateShippingQuoteRequestDestination
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **country** | **String** | ISO 3166-1 alpha-2 country code | |
8
+ | **postal_code** | **String** | Postal/ZIP code | [optional] |
9
+ | **province** | **String** | State/province code | [optional] |
10
+ | **city** | **String** | City name | [optional] |
11
+ | **address1** | **String** | Street address line 1 | [optional] |
12
+ | **address2** | **String** | Street address line 2 | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'zippendo'
18
+
19
+ instance = Zippendo::CreateShippingQuoteRequestDestination.new(
20
+ country: DK,
21
+ postal_code: 1620,
22
+ province: ,
23
+ city: København,
24
+ address1: Vesterbrogade 1,
25
+ address2: 2. sal
26
+ )
27
+ ```
28
+