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,22 @@
1
+ # Zippendo::ConnectCarrierRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Carrier display name | |
8
+ | **carrier_slug** | **String** | Carrier slug identifier | |
9
+ | **config** | [**Hash<String, ListCarriers200ResponseDataInnerConfigValue>**](ListCarriers200ResponseDataInnerConfigValue.md) | Carrier configuration (required and optional fields) | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zippendo'
15
+
16
+ instance = Zippendo::ConnectCarrierRequest.new(
17
+ name: PostNord,
18
+ carrier_slug: postnord,
19
+ config: {"customerNumber":"123456"}
20
+ )
21
+ ```
22
+
@@ -0,0 +1,40 @@
1
+ # Zippendo::CreateAddressRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the address | |
8
+ | **att_contact** | **String** | Attention contact person | |
9
+ | **address1** | **String** | Address line 1 | |
10
+ | **address2** | **String** | Address line 2 | [optional] |
11
+ | **zipcode** | **String** | Postal/ZIP code | |
12
+ | **city** | **String** | City | |
13
+ | **phone** | **String** | Phone number | |
14
+ | **country_code** | **String** | Country code (ISO 2 or 3 letter) | |
15
+ | **state** | **String** | State/Province | [optional] |
16
+ | **email** | **String** | Email address | |
17
+ | **customs** | **Hash<String, String>** | Customs identifiers (voec, eori, sprn, ioss, fda, duns) | [optional] |
18
+ | **address_types** | **Array<String>** | Address types (sender, pickup, return) | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'zippendo'
24
+
25
+ instance = Zippendo::CreateAddressRequest.new(
26
+ name: Hovedlager,
27
+ att_contact: Mette Hansen,
28
+ address1: Vesterbrogade 1,
29
+ address2: 2. sal,
30
+ zipcode: 1620,
31
+ city: København,
32
+ phone: +4533123456,
33
+ country_code: DK,
34
+ state: ,
35
+ email: lager@example.dk,
36
+ customs: {"eori":"DK12345678"},
37
+ address_types: ["sender"]
38
+ )
39
+ ```
40
+
@@ -0,0 +1,32 @@
1
+ # Zippendo::CreateApiToken201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique API token identifier | |
8
+ | **name** | **String** | Token name for identification | |
9
+ | **token_prefix** | **String** | First 12 chars of the token for identification | |
10
+ | **scopes** | **Array<String>** | Permission scopes granted by the token | |
11
+ | **last_used_at** | **String** | Timestamp the token was last used (ISO 8601), null if never used | |
12
+ | **expires_at** | **String** | Expiry timestamp (ISO 8601), null if it never expires | |
13
+ | **created_at** | **String** | Creation timestamp (ISO 8601) | |
14
+ | **token** | **String** | Full API token (only shown once) | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zippendo'
20
+
21
+ instance = Zippendo::CreateApiToken201Response.new(
22
+ id: tok_6e2fa83ij9,
23
+ name: Warehouse integration,
24
+ token_prefix: zipp_live_8f,
25
+ scopes: ["read:shipments","write:shipments"],
26
+ last_used_at: 2026-06-22T14:30:00.000Z,
27
+ expires_at: 2026-09-20T14:30:00.000Z,
28
+ created_at: 2026-06-22T14:30:00.000Z,
29
+ token: zipp_live_8f3kd92ld0a7b6c5d4e3f2a1
30
+ )
31
+ ```
32
+
@@ -0,0 +1,22 @@
1
+ # Zippendo::CreateApiTokenRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Token name for identification | |
8
+ | **scopes** | **Array<String>** | Permission scopes for the token | |
9
+ | **expires_in_days** | **Integer** | Token expiry in days (optional, max 365) | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zippendo'
15
+
16
+ instance = Zippendo::CreateApiTokenRequest.new(
17
+ name: Warehouse integration,
18
+ scopes: ["read:shipments","write:shipments"],
19
+ expires_in_days: 90
20
+ )
21
+ ```
22
+
@@ -0,0 +1,52 @@
1
+ # Zippendo::CreateOrder201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique order ID. | |
8
+ | **order_number** | **String** | Human-readable order number. | |
9
+ | **external_id** | **String** | Identifier of the order in the source platform. | [optional] |
10
+ | **customer_name** | **String** | Customer full name. | [optional] |
11
+ | **customer_email** | **String** | Customer email address. | [optional] |
12
+ | **shipping_address** | [**CreateOrder201ResponseShippingAddress**](CreateOrder201ResponseShippingAddress.md) | | [optional] |
13
+ | **order_lines** | [**Array<CreateOrder201ResponseOrderLinesInner>**](CreateOrder201ResponseOrderLinesInner.md) | Line items in the order. | |
14
+ | **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
15
+ | **total_amount** | **Float** | Order grand total. | [optional] |
16
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
17
+ | **status** | **String** | Order fulfilment status derived from its shipments. | |
18
+ | **shipping_rule_id** | **String** | ID of the applied shipping rule. | [optional] |
19
+ | **notes** | **String** | Free-form internal notes. | [optional] |
20
+ | **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |
21
+ | **order_channel_id** | **String** | ID of the order channel this order belongs to. | |
22
+ | **org_id** | **String** | Owning organization ID. | |
23
+ | **created_at** | **String** | Creation timestamp (ISO 8601). | |
24
+ | **updated_at** | **String** | Last update timestamp (ISO 8601). | |
25
+
26
+ ## Example
27
+
28
+ ```ruby
29
+ require 'zippendo'
30
+
31
+ instance = Zippendo::CreateOrder201Response.new(
32
+ id: clz9k2f0a0003abcd9012mnop,
33
+ order_number: #1042,
34
+ external_id: 5012345678901,
35
+ customer_name: Anna Jensen,
36
+ customer_email: anna@example.dk,
37
+ shipping_address: null,
38
+ order_lines: null,
39
+ subtotal_amount: 998,
40
+ total_amount: 1047,
41
+ currency: DKK,
42
+ status: processing,
43
+ shipping_rule_id: clz9k2f0a0002abcd5678ijkl,
44
+ notes: Leave at front desk,
45
+ external_data: null,
46
+ order_channel_id: clz9k2f0a0001abcd1234efgh,
47
+ org_id: clz9k2f0a0000abcd0000zzzz,
48
+ created_at: 2026-06-22T14:30:00.000Z,
49
+ updated_at: 2026-06-22T14:30:00.000Z
50
+ )
51
+ ```
52
+
@@ -0,0 +1,54 @@
1
+ # Zippendo::CreateOrder201ResponseOrderLinesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sku** | **String** | Stock keeping unit identifier. | [optional] |
8
+ | **name** | **String** | Product name. | |
9
+ | **quantity** | **Integer** | Quantity ordered. | |
10
+ | **unit_price** | **Float** | Price per unit. | [optional] |
11
+ | **total_price** | **Float** | Total price for the line. | [optional] |
12
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
13
+ | **weight** | **Float** | Item weight in the given unit. | [optional] |
14
+ | **weight_unit** | **String** | Unit of the weight value. | [optional] |
15
+ | **variant_id** | **String** | Platform variant identifier. | [optional] |
16
+ | **product_id** | **String** | Platform product identifier. | [optional] |
17
+ | **image_url** | **String** | Product image URL. | [optional] |
18
+ | **hs_code** | **String** | Harmonized System customs code (6-13 digits). | [optional] |
19
+ | **country_of_origin** | **String** | ISO 3166-1 alpha-2 country of origin. | [optional] |
20
+ | **province_of_origin** | **String** | ISO 3166-2 province of origin. | [optional] |
21
+ | **barcode** | **String** | Item barcode (EAN/UPC). | [optional] |
22
+ | **requires_shipping** | **Boolean** | Whether the item requires shipping. | [optional] |
23
+ | **taxable** | **Boolean** | Whether the item is taxable. | [optional] |
24
+ | **gift_card** | **Boolean** | Whether the item is a gift card. | [optional] |
25
+ | **vendor** | **String** | Vendor or brand name. | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'zippendo'
31
+
32
+ instance = Zippendo::CreateOrder201ResponseOrderLinesInner.new(
33
+ sku: SKU-1042-BLK,
34
+ name: Wool Sweater,
35
+ quantity: 2,
36
+ unit_price: 499,
37
+ total_price: 998,
38
+ currency: DKK,
39
+ weight: 0.5,
40
+ weight_unit: kg,
41
+ variant_id: 44218900291,
42
+ product_id: 8123456789,
43
+ image_url: https://cdn.example.dk/products/sweater.jpg,
44
+ hs_code: 611020,
45
+ country_of_origin: DK,
46
+ province_of_origin: DK-84,
47
+ barcode: 5712345678901,
48
+ requires_shipping: true,
49
+ taxable: true,
50
+ gift_card: false,
51
+ vendor: Norse Knits
52
+ )
53
+ ```
54
+
@@ -0,0 +1,42 @@
1
+ # Zippendo::CreateOrder201ResponseShippingAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Recipient full name. | |
8
+ | **attention** | **String** | Attention / care-of line. | [optional] |
9
+ | **company** | **String** | Company name. | [optional] |
10
+ | **address1** | **String** | Street address line 1. | |
11
+ | **address2** | **String** | Street address line 2. | [optional] |
12
+ | **city** | **String** | City name. | |
13
+ | **province** | **String** | Province or region name. | [optional] |
14
+ | **province_code** | **String** | Province or region code. | [optional] |
15
+ | **postal_code** | **String** | Postal code. | |
16
+ | **country** | **String** | Country name. | [optional] |
17
+ | **country_code** | **String** | ISO 3166-1 alpha-2 country code. | |
18
+ | **phone** | **String** | Recipient phone number. | [optional] |
19
+ | **email** | **String** | Recipient email address. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'zippendo'
25
+
26
+ instance = Zippendo::CreateOrder201ResponseShippingAddress.new(
27
+ name: Anna Jensen,
28
+ attention: c/o Reception,
29
+ company: Jensen Design ApS,
30
+ address1: Nørregade 12,
31
+ address2: 2. sal,
32
+ city: København,
33
+ province: Hovedstaden,
34
+ province_code: DK-84,
35
+ postal_code: 1165,
36
+ country: Denmark,
37
+ country_code: DK,
38
+ phone: +45 12 34 56 78,
39
+ email: anna@example.dk
40
+ )
41
+ ```
42
+
@@ -0,0 +1,40 @@
1
+ # Zippendo::CreateOrderRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **order_number** | **String** | Human-readable order number. | |
8
+ | **external_id** | **String** | Identifier of the order in the source platform. | [optional] |
9
+ | **order_channel_id** | **String** | ID of the order channel this order belongs to. | |
10
+ | **customer_name** | **String** | Customer full name. | [optional] |
11
+ | **customer_email** | **String** | Customer email address. | [optional] |
12
+ | **shipping_address** | [**CreateOrderRequestShippingAddress**](CreateOrderRequestShippingAddress.md) | | [optional] |
13
+ | **order_lines** | [**Array<CreateOrderRequestOrderLinesInner>**](CreateOrderRequestOrderLinesInner.md) | Line items in the order. | |
14
+ | **subtotal_amount** | **Float** | Order subtotal before shipping and tax. | [optional] |
15
+ | **total_amount** | **Float** | Order grand total. | [optional] |
16
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
17
+ | **notes** | **String** | Free-form internal notes. | [optional] |
18
+ | **external_data** | **Hash<String, Object>** | Raw platform-specific payload for reference. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'zippendo'
24
+
25
+ instance = Zippendo::CreateOrderRequest.new(
26
+ order_number: #1042,
27
+ external_id: 5012345678901,
28
+ order_channel_id: clz9k2f0a0001abcd1234efgh,
29
+ customer_name: Anna Jensen,
30
+ customer_email: anna@example.dk,
31
+ shipping_address: null,
32
+ order_lines: null,
33
+ subtotal_amount: 998,
34
+ total_amount: 1047,
35
+ currency: DKK,
36
+ notes: Leave at front desk,
37
+ external_data: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,54 @@
1
+ # Zippendo::CreateOrderRequestOrderLinesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sku** | **String** | Stock keeping unit identifier. | [optional] |
8
+ | **name** | **String** | Product name. | |
9
+ | **quantity** | **Integer** | Quantity ordered. | |
10
+ | **unit_price** | **Float** | Price per unit. | [optional] |
11
+ | **total_price** | **Float** | Total price for the line. | [optional] |
12
+ | **currency** | **String** | ISO 4217 currency code. | [optional] |
13
+ | **weight** | **Float** | Item weight in the given unit. | [optional] |
14
+ | **weight_unit** | **String** | Unit of the weight value. | [optional] |
15
+ | **variant_id** | **String** | Platform variant identifier. | [optional] |
16
+ | **product_id** | **String** | Platform product identifier. | [optional] |
17
+ | **image_url** | **String** | Product image URL. | [optional] |
18
+ | **hs_code** | **String** | Harmonized System customs code (6-13 digits). | [optional] |
19
+ | **country_of_origin** | **String** | ISO 3166-1 alpha-2 country of origin. | [optional] |
20
+ | **province_of_origin** | **String** | ISO 3166-2 province of origin. | [optional] |
21
+ | **barcode** | **String** | Item barcode (EAN/UPC). | [optional] |
22
+ | **requires_shipping** | **Boolean** | Whether the item requires shipping. | [optional] |
23
+ | **taxable** | **Boolean** | Whether the item is taxable. | [optional] |
24
+ | **gift_card** | **Boolean** | Whether the item is a gift card. | [optional] |
25
+ | **vendor** | **String** | Vendor or brand name. | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'zippendo'
31
+
32
+ instance = Zippendo::CreateOrderRequestOrderLinesInner.new(
33
+ sku: SKU-1042-BLK,
34
+ name: Wool Sweater,
35
+ quantity: 2,
36
+ unit_price: 499,
37
+ total_price: 998,
38
+ currency: DKK,
39
+ weight: 0.5,
40
+ weight_unit: kg,
41
+ variant_id: 44218900291,
42
+ product_id: 8123456789,
43
+ image_url: https://cdn.example.dk/products/sweater.jpg,
44
+ hs_code: 611020,
45
+ country_of_origin: DK,
46
+ province_of_origin: DK-84,
47
+ barcode: 5712345678901,
48
+ requires_shipping: true,
49
+ taxable: true,
50
+ gift_card: false,
51
+ vendor: Norse Knits
52
+ )
53
+ ```
54
+
@@ -0,0 +1,42 @@
1
+ # Zippendo::CreateOrderRequestShippingAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Recipient full name. | |
8
+ | **attention** | **String** | Attention / care-of line. | [optional] |
9
+ | **company** | **String** | Company name. | [optional] |
10
+ | **address1** | **String** | Street address line 1. | |
11
+ | **address2** | **String** | Street address line 2. | [optional] |
12
+ | **city** | **String** | City name. | |
13
+ | **province** | **String** | Province or region name. | [optional] |
14
+ | **province_code** | **String** | Province or region code. | [optional] |
15
+ | **postal_code** | **String** | Postal code. | |
16
+ | **country** | **String** | Country name. | [optional] |
17
+ | **country_code** | **String** | ISO 3166-1 alpha-2 country code. | |
18
+ | **phone** | **String** | Recipient phone number. | [optional] |
19
+ | **email** | **String** | Recipient email address. | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'zippendo'
25
+
26
+ instance = Zippendo::CreateOrderRequestShippingAddress.new(
27
+ name: Anna Jensen,
28
+ attention: c/o Reception,
29
+ company: Jensen Design ApS,
30
+ address1: Nørregade 12,
31
+ address2: 2. sal,
32
+ city: København,
33
+ province: Hovedstaden,
34
+ province_code: DK-84,
35
+ postal_code: 1165,
36
+ country: Denmark,
37
+ country_code: DK,
38
+ phone: +45 12 34 56 78,
39
+ email: anna@example.dk
40
+ )
41
+ ```
42
+
@@ -0,0 +1,32 @@
1
+ # Zippendo::CreateOrgWebhook201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Webhook ID | |
8
+ | **name** | **String** | Human-readable webhook name | |
9
+ | **url** | **String** | Webhook endpoint URL | |
10
+ | **secret** | **String** | Signing secret used to verify webhook payloads | |
11
+ | **events** | **Array<String>** | Events the webhook is subscribed to | |
12
+ | **is_active** | **Boolean** | Whether the webhook is active | |
13
+ | **created_at** | **String** | Creation timestamp (ISO 8601) | |
14
+ | **updated_at** | **String** | Last update timestamp (ISO 8601) | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zippendo'
20
+
21
+ instance = Zippendo::CreateOrgWebhook201Response.new(
22
+ id: wh_clx1a2b3c4,
23
+ name: Order fulfilment notifier,
24
+ url: https://hooks.example.dk/zippendo,
25
+ secret: whsec_8f3a1c2b9d4e5f6a,
26
+ events: ["shipment.created"],
27
+ is_active: true,
28
+ created_at: 2026-06-01T09:30:00.000Z,
29
+ updated_at: 2026-06-10T11:15:00.000Z
30
+ )
31
+ ```
32
+
@@ -0,0 +1,24 @@
1
+ # Zippendo::CreateOrgWebhookRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Human-readable webhook name | |
8
+ | **url** | **String** | Webhook endpoint URL | |
9
+ | **events** | **Array<String>** | Events to subscribe to | |
10
+ | **is_active** | **Boolean** | Whether the webhook is active | [optional][default to true] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zippendo'
16
+
17
+ instance = Zippendo::CreateOrgWebhookRequest.new(
18
+ name: Order fulfilment notifier,
19
+ url: https://hooks.example.dk/zippendo,
20
+ events: ["shipment.created","tracking.updated"],
21
+ is_active: true
22
+ )
23
+ ```
24
+
@@ -0,0 +1,64 @@
1
+ # Zippendo::CreateShipment201Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique shipment identifier. | |
8
+ | **reference** | **String** | Customer-facing shipment reference. | |
9
+ | **address_id** | **String** | Sender address identifier. | [optional] |
10
+ | **service_point_id** | **String** | Selected carrier service point identifier. | [optional] |
11
+ | **parties** | [**Array<CreateShipment201ResponsePartiesInner>**](CreateShipment201ResponsePartiesInner.md) | Parties involved in the shipment (sender, receiver, etc.). | |
12
+ | **type** | **String** | Direction of the shipment relative to the organization. | |
13
+ | **carrier_settings** | [**ListShipments200ResponseDataInnerCarrierSettings**](ListShipments200ResponseDataInnerCarrierSettings.md) | | |
14
+ | **parcels** | [**Array<CreateShipment201ResponseParcelsInner>**](CreateShipment201ResponseParcelsInner.md) | Parcels included in the shipment. | |
15
+ | **pickup_details** | [**CreateShipment201ResponsePickupDetails**](CreateShipment201ResponsePickupDetails.md) | | [optional] |
16
+ | **term_of_trade** | **String** | Incoterm governing the shipment. | [default to 'DAP'] |
17
+ | **documents** | [**Array<CreateShipment201ResponseDocumentsInner>**](CreateShipment201ResponseDocumentsInner.md) | Documents generated for the shipment (labels, invoices). | [optional] |
18
+ | **errors** | [**Array<CreateShipment201ResponseErrorsInner>**](CreateShipment201ResponseErrorsInner.md) | Carrier errors recorded for the shipment. | |
19
+ | **tracking** | [**CreateShipment201ResponseTracking**](CreateShipment201ResponseTracking.md) | | [optional] |
20
+ | **status** | **String** | Lifecycle status of the shipment. | |
21
+ | **org_id** | **String** | Owning organization identifier. | |
22
+ | **order_id** | **String** | Associated order identifier. | [optional] |
23
+ | **shipping_rule_id** | **String** | Applied shipping rule identifier. | [optional] |
24
+ | **shipping_rule** | [**CreateShipment201ResponseShippingRule**](CreateShipment201ResponseShippingRule.md) | | [optional] |
25
+ | **label_printer_id** | **String** | Printer assigned for labels on this shipment. | [optional] |
26
+ | **document_printer_id** | **String** | Printer assigned for documents on this shipment. | [optional] |
27
+ | **logs** | [**Array<CreateShipment201ResponseLogsInner>**](CreateShipment201ResponseLogsInner.md) | Request/response logs captured during carrier interactions. | |
28
+ | **activities** | [**Array<CreateShipment201ResponseActivitiesInner>**](CreateShipment201ResponseActivitiesInner.md) | Chronological activity history of the shipment. | |
29
+ | **created_at** | **String** | Timestamp when the shipment was created. | |
30
+ | **updated_at** | **String** | Timestamp when the shipment was last updated. | |
31
+
32
+ ## Example
33
+
34
+ ```ruby
35
+ require 'zippendo'
36
+
37
+ instance = Zippendo::CreateShipment201Response.new(
38
+ id: shp_4d9e7a2f,
39
+ reference: ORDER-1042,
40
+ address_id: addr_7e8f9a0b,
41
+ service_point_id: sp_pn_4521,
42
+ parties: null,
43
+ type: outbound,
44
+ carrier_settings: null,
45
+ parcels: null,
46
+ pickup_details: null,
47
+ term_of_trade: DAP,
48
+ documents: null,
49
+ errors: null,
50
+ tracking: null,
51
+ status: pending,
52
+ org_id: org_1a2b3c4d,
53
+ order_id: ord_5e6f7a8b,
54
+ shipping_rule_id: rule_3c4d5e6f,
55
+ shipping_rule: null,
56
+ label_printer_id: prn_label_01,
57
+ document_printer_id: prn_doc_01,
58
+ logs: null,
59
+ activities: null,
60
+ created_at: 2026-06-22T14:30:00.000Z,
61
+ updated_at: 2026-06-22T14:30:00.000Z
62
+ )
63
+ ```
64
+
@@ -0,0 +1,26 @@
1
+ # Zippendo::CreateShipment201ResponseActivitiesInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique activity identifier. | |
8
+ | **action** | **String** | Type of activity performed on the shipment. | |
9
+ | **description** | **String** | Human-readable description of the activity. | |
10
+ | **metadata** | **Object** | Additional structured data about the activity. | [optional] |
11
+ | **created_at** | **String** | Timestamp when the activity occurred. | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zippendo'
17
+
18
+ instance = Zippendo::CreateShipment201ResponseActivitiesInner.new(
19
+ id: act_1d2e3f4a,
20
+ action: created,
21
+ description: Shipment created,
22
+ metadata: null,
23
+ created_at: 2026-06-22T14:30:00.000Z
24
+ )
25
+ ```
26
+
@@ -0,0 +1,32 @@
1
+ # Zippendo::CreateShipment201ResponseDocumentsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique document identifier. | |
8
+ | **shipment_id** | **String** | Identifier of the shipment this document belongs to. | |
9
+ | **document_type** | **String** | Type of shipment document. | |
10
+ | **format** | **String** | File format of the document content. | |
11
+ | **content** | **String** | Base64-encoded document/label content. | |
12
+ | **size** | **String** | Physical print size of the document. | [default to 'A4'] |
13
+ | **created_at** | **String** | Timestamp when the document was created. | |
14
+ | **updated_at** | **String** | Timestamp when the document was last updated. | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zippendo'
20
+
21
+ instance = Zippendo::CreateShipment201ResponseDocumentsInner.new(
22
+ id: doc_8f3a2b1c,
23
+ shipment_id: shp_4d9e7a2f,
24
+ document_type: label,
25
+ format: pdf,
26
+ content: JVBERi0xLjQKJeLjz9MKMS...,
27
+ size: 100X150,
28
+ created_at: 2026-06-22T14:30:00.000Z,
29
+ updated_at: 2026-06-22T14:30:00.000Z
30
+ )
31
+ ```
32
+
@@ -0,0 +1,26 @@
1
+ # Zippendo::CreateShipment201ResponseErrorsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique error identifier. | |
8
+ | **carrier** | **String** | Carrier that produced the error. | |
9
+ | **code** | **String** | Carrier-specific error code. | [optional] |
10
+ | **message** | **String** | Human-readable error message. | |
11
+ | **created_at** | **String** | Timestamp when the error occurred. | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zippendo'
17
+
18
+ instance = Zippendo::CreateShipment201ResponseErrorsInner.new(
19
+ id: err_2b3c4d5e,
20
+ carrier: PostNord,
21
+ code: INVALID_POSTAL_CODE,
22
+ message: Receiver postal code is invalid for the selected product.,
23
+ created_at: 2026-06-22T14:30:00.000Z
24
+ )
25
+ ```
26
+
@@ -0,0 +1,32 @@
1
+ # Zippendo::CreateShipment201ResponseLogsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique log entry identifier. | |
8
+ | **direction** | **String** | Direction of the logged request. | |
9
+ | **request** | **Object** | Captured request payload. | |
10
+ | **response** | **Object** | Captured response payload. | [optional] |
11
+ | **status_code** | **Float** | HTTP status code of the response. | [optional] |
12
+ | **error** | **String** | Error message if the request failed. | [optional] |
13
+ | **duration** | **Float** | Request duration in milliseconds. | [optional] |
14
+ | **created_at** | **String** | Timestamp when the log entry was created. | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'zippendo'
20
+
21
+ instance = Zippendo::CreateShipment201ResponseLogsInner.new(
22
+ id: log_6f7a8b9c,
23
+ direction: outbound,
24
+ request: null,
25
+ response: null,
26
+ status_code: 200,
27
+ error: Connection timed out,
28
+ duration: 342,
29
+ created_at: 2026-06-22T14:30:00.000Z
30
+ )
31
+ ```
32
+