openapi_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (732) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +431 -0
  4. data/Rakefile +10 -0
  5. data/docs/AddFundsToCarrierRequestBody.md +16 -0
  6. data/docs/AddFundsToCarrierResponseBody.md +17 -0
  7. data/docs/AddFundsToInsuranceRequestBody.md +16 -0
  8. data/docs/AddFundsToInsuranceResponseBody.md +16 -0
  9. data/docs/AddToBatchRequestBody.md +16 -0
  10. data/docs/Address.md +16 -0
  11. data/docs/AddressResidentialIndicator.md +16 -0
  12. data/docs/AddressToValidate.md +16 -0
  13. data/docs/AddressValidatingShipment.md +61 -0
  14. data/docs/AddressValidationCode.md +16 -0
  15. data/docs/AddressValidationDetailCode.md +16 -0
  16. data/docs/AddressValidationMessageType.md +16 -0
  17. data/docs/AddressValidationResult.md +23 -0
  18. data/docs/AddressValidationStatus.md +16 -0
  19. data/docs/AddressesApi.md +118 -0
  20. data/docs/AdvancedShipmentOptions.md +47 -0
  21. data/docs/AncillaryServiceEndorsement.md +16 -0
  22. data/docs/Batch.md +51 -0
  23. data/docs/BatchResponseError.md +19 -0
  24. data/docs/BatchStatus.md +16 -0
  25. data/docs/BatchesApi.md +580 -0
  26. data/docs/BatchesSortBy.md +16 -0
  27. data/docs/BillToParty.md +16 -0
  28. data/docs/BulkRate.md +25 -0
  29. data/docs/CalculateRatesRequestBody.md +16 -0
  30. data/docs/CalculateRatesResponseBody.md +61 -0
  31. data/docs/Carrier.md +41 -0
  32. data/docs/CarrierAccountsApi.md +238 -0
  33. data/docs/CarrierAdvancedOption.md +21 -0
  34. data/docs/CarrierName.md +16 -0
  35. data/docs/CarrierNameWithSettings.md +16 -0
  36. data/docs/CarriersApi.md +336 -0
  37. data/docs/CollectOnDelivery.md +19 -0
  38. data/docs/CollectOnDeliveryPaymentType.md +16 -0
  39. data/docs/CompareBulkRatesRequestBody.md +16 -0
  40. data/docs/ConnectAccessWorldwideRequestBody.md +21 -0
  41. data/docs/ConnectAmazonBuyShippingRequestBody.md +23 -0
  42. data/docs/ConnectApcRequestBody.md +21 -0
  43. data/docs/ConnectAsendiaRequestBody.md +23 -0
  44. data/docs/ConnectAustraliaPostRequestBody.md +23 -0
  45. data/docs/ConnectCanadaPostRequestBody.md +25 -0
  46. data/docs/ConnectCarrierRequestBody.md +113 -0
  47. data/docs/ConnectCarrierResponseBody.md +17 -0
  48. data/docs/ConnectDhlEcommerceRequestBody.md +39 -0
  49. data/docs/ConnectDhlExpressAuRequestBody.md +19 -0
  50. data/docs/ConnectDhlExpressCaRequestBody.md +19 -0
  51. data/docs/ConnectDhlExpressRequestBody.md +19 -0
  52. data/docs/ConnectDhlExpressUkRequestBody.md +23 -0
  53. data/docs/ConnectDpdRequestBody.md +21 -0
  54. data/docs/ConnectEndiciaRequestBody.md +21 -0
  55. data/docs/ConnectFedexRequestBody.md +45 -0
  56. data/docs/ConnectFedexUkRequestBody.md +45 -0
  57. data/docs/ConnectFirstmileRequestBody.md +23 -0
  58. data/docs/ConnectGlobegisticsRequestBody.md +21 -0
  59. data/docs/ConnectImexRequestBody.md +21 -0
  60. data/docs/ConnectInsurerRequestBody.md +19 -0
  61. data/docs/ConnectNewgisticsRequestBody.md +23 -0
  62. data/docs/ConnectOntracRequestBody.md +21 -0
  63. data/docs/ConnectPurolatorRequestBody.md +21 -0
  64. data/docs/ConnectRoyalMailRequestBody.md +39 -0
  65. data/docs/ConnectRrDonnelleyRequestBody.md +21 -0
  66. data/docs/ConnectSekoRequestBody.md +19 -0
  67. data/docs/ConnectSendleRequestBody.md +21 -0
  68. data/docs/ConnectStampsRequestBody.md +21 -0
  69. data/docs/ConnectUpsRequestBody.md +51 -0
  70. data/docs/CreateAndValidateShipment.md +63 -0
  71. data/docs/CreateBatchRequestBody.md +23 -0
  72. data/docs/CreateBatchResponseBody.md +16 -0
  73. data/docs/CreateLabelFromRateRequestBody.md +16 -0
  74. data/docs/CreateLabelFromRateResponseBody.md +16 -0
  75. data/docs/CreateLabelFromShipmentRequestBody.md +23 -0
  76. data/docs/CreateLabelFromShipmentResponseBody.md +16 -0
  77. data/docs/CreateLabelRequestBody.md +16 -0
  78. data/docs/CreateLabelResponseBody.md +16 -0
  79. data/docs/CreateManifestByObjectRequestBody.md +25 -0
  80. data/docs/CreateManifestLabelIdsRequestBody.md +17 -0
  81. data/docs/CreateManifestRequestBody.md +25 -0
  82. data/docs/CreateManifestResponseBody.md +35 -0
  83. data/docs/CreatePackageTypeRequestBody.md +16 -0
  84. data/docs/CreatePackageTypeResponseBody.md +16 -0
  85. data/docs/CreateReturnLabelRequestBody.md +25 -0
  86. data/docs/CreateReturnLabelResponseBody.md +16 -0
  87. data/docs/CreateShipmentResponseBodyFields.md +19 -0
  88. data/docs/CreateShipmentsRequestBody.md +17 -0
  89. data/docs/CreateShipmentsResponseBody.md +19 -0
  90. data/docs/CreateTagResponseBody.md +16 -0
  91. data/docs/CreateWarehouseRequestBody.md +16 -0
  92. data/docs/CreateWarehouseResponseBody.md +16 -0
  93. data/docs/CreateWebhookRequestBody.md +19 -0
  94. data/docs/CreateWebhookResponseBody.md +16 -0
  95. data/docs/Currency.md +16 -0
  96. data/docs/CustomsItem.md +33 -0
  97. data/docs/DeliveryConfirmation.md +16 -0
  98. data/docs/DeprecatedManifest.md +33 -0
  99. data/docs/DhlExpressAccountSettings.md +21 -0
  100. data/docs/DhlExpressSettingsResponseBody.md +16 -0
  101. data/docs/DimensionUnit.md +16 -0
  102. data/docs/Dimensions.md +23 -0
  103. data/docs/DownloadsApi.md +71 -0
  104. data/docs/Error.md +23 -0
  105. data/docs/ErrorCode.md +16 -0
  106. data/docs/ErrorResponseBody.md +19 -0
  107. data/docs/ErrorSource.md +16 -0
  108. data/docs/ErrorType.md +16 -0
  109. data/docs/EstimateRatesRequestBody.md +16 -0
  110. data/docs/FedexAccountSettings.md +25 -0
  111. data/docs/FedexAccountSettingsRequestBody.md +16 -0
  112. data/docs/FedexPickupType.md +16 -0
  113. data/docs/FedexSettingsResponseBody.md +16 -0
  114. data/docs/GetBatchByExternalIdResponseBody.md +16 -0
  115. data/docs/GetBatchByIdResponseBody.md +16 -0
  116. data/docs/GetCarrierByIdResponseBody.md +16 -0
  117. data/docs/GetCarrierOptionsResponseBody.md +17 -0
  118. data/docs/GetCarrierSettingsResponseBody.md +45 -0
  119. data/docs/GetCarriersResponseBody.md +21 -0
  120. data/docs/GetInsuranceBalanceResponseBody.md +16 -0
  121. data/docs/GetLabelByExternalShipmentIdResponseBody.md +16 -0
  122. data/docs/GetLabelByIdResponseBody.md +16 -0
  123. data/docs/GetManifestByIdResponseBody.md +16 -0
  124. data/docs/GetPackageTypeByIdResponseBody.md +16 -0
  125. data/docs/GetRateByIdResponseBody.md +16 -0
  126. data/docs/GetShipmentByExternalIdResponseBody.md +16 -0
  127. data/docs/GetShipmentByIdResponseBody.md +16 -0
  128. data/docs/GetTrackingLogFromLabelResponseBody.md +16 -0
  129. data/docs/GetTrackingLogResponseBody.md +16 -0
  130. data/docs/GetWarehouseByIdResponseBody.md +16 -0
  131. data/docs/GetWebhookByIdResponseBody.md +16 -0
  132. data/docs/InsuranceApi.md +220 -0
  133. data/docs/InsuranceProvider.md +16 -0
  134. data/docs/InternationalShipmentOptions.md +21 -0
  135. data/docs/Label.md +81 -0
  136. data/docs/LabelChargeEvent.md +16 -0
  137. data/docs/LabelDownload.md +23 -0
  138. data/docs/LabelDownloadType.md +16 -0
  139. data/docs/LabelFormat.md +16 -0
  140. data/docs/LabelLayout.md +16 -0
  141. data/docs/LabelMessages.md +21 -0
  142. data/docs/LabelStatus.md +16 -0
  143. data/docs/LabelsApi.md +545 -0
  144. data/docs/Link.md +16 -0
  145. data/docs/ListBatchErrorsResponseBody.md +19 -0
  146. data/docs/ListBatchesResponseBody.md +25 -0
  147. data/docs/ListCarrierPackageTypesResponseBody.md +17 -0
  148. data/docs/ListCarrierServicesResponseBody.md +17 -0
  149. data/docs/ListCarriersResponseBody.md +17 -0
  150. data/docs/ListLabelsResponseBody.md +17 -0
  151. data/docs/ListManifestsResponseBody.md +25 -0
  152. data/docs/ListPackageTypesResponseBody.md +17 -0
  153. data/docs/ListShipmentErrorsResponseBody.md +19 -0
  154. data/docs/ListShipmentRatesResponseBody.md +16 -0
  155. data/docs/ListShipmentsResponseBody.md +25 -0
  156. data/docs/ListTagsResponseBody.md +17 -0
  157. data/docs/ListWarehousesResponseBody.md +17 -0
  158. data/docs/Manifest.md +33 -0
  159. data/docs/ManifestDownload.md +17 -0
  160. data/docs/Manifests.md +17 -0
  161. data/docs/ManifestsApi.md +191 -0
  162. data/docs/ModifyBatch.md +19 -0
  163. data/docs/MonetaryValue.md +19 -0
  164. data/docs/NonDelivery.md +16 -0
  165. data/docs/OptionalLink.md +19 -0
  166. data/docs/OrderSourceName.md +16 -0
  167. data/docs/Package.md +29 -0
  168. data/docs/PackageContents.md +16 -0
  169. data/docs/PackageType.md +25 -0
  170. data/docs/PackageTypesApi.md +281 -0
  171. data/docs/PagedListResponseBody.md +23 -0
  172. data/docs/PaginationLink.md +23 -0
  173. data/docs/ParseAddressRequestBody.md +19 -0
  174. data/docs/ParseAddressResponseBody.md +21 -0
  175. data/docs/ParseShipmentRequestBody.md +20 -0
  176. data/docs/ParseShipmentResponseBody.md +21 -0
  177. data/docs/PartialAddress.md +37 -0
  178. data/docs/PartialShipment.md +59 -0
  179. data/docs/PaymentAmount.md +19 -0
  180. data/docs/ProcessBatchRequestBody.md +21 -0
  181. data/docs/PurchaseLabelWithoutShipment.md +23 -0
  182. data/docs/Rate.md +65 -0
  183. data/docs/RateEstimateByCarrierId.md +17 -0
  184. data/docs/RateEstimateByCarrierIds.md +17 -0
  185. data/docs/RateEstimateOptions.md +41 -0
  186. data/docs/RateRequestBody.md +25 -0
  187. data/docs/RateRequestByShipmentIds.md +17 -0
  188. data/docs/RateRequestByShipments.md +17 -0
  189. data/docs/RateRequestOptions.md +17 -0
  190. data/docs/RateRequestRateOptions.md +17 -0
  191. data/docs/RateResponse.md +17 -0
  192. data/docs/RateResponseStatus.md +16 -0
  193. data/docs/RateType.md +16 -0
  194. data/docs/RatesApi.md +228 -0
  195. data/docs/RatesInformation.md +29 -0
  196. data/docs/RecognizedEntity.md +27 -0
  197. data/docs/RemoveFromBatchRequestBody.md +16 -0
  198. data/docs/ResponseMessage.md +23 -0
  199. data/docs/Service.md +29 -0
  200. data/docs/Shipment.md +16 -0
  201. data/docs/ShipmentIdRequest.md +17 -0
  202. data/docs/ShipmentItem.md +33 -0
  203. data/docs/ShipmentRequest.md +17 -0
  204. data/docs/ShipmentResponseError.md +21 -0
  205. data/docs/ShipmentStatus.md +16 -0
  206. data/docs/ShipmentsApi.md +653 -0
  207. data/docs/ShipmentsSortBy.md +16 -0
  208. data/docs/SmartPostHub.md +16 -0
  209. data/docs/SortDir.md +16 -0
  210. data/docs/Tag.md +17 -0
  211. data/docs/TagShipmentResponseBody.md +19 -0
  212. data/docs/TagsApi.md +226 -0
  213. data/docs/TrackEvent.md +39 -0
  214. data/docs/TrackingApi.md +185 -0
  215. data/docs/TrackingInformation.md +35 -0
  216. data/docs/TrackingStatus.md +16 -0
  217. data/docs/UpdateAmazonBuyShippingRequestBody.md +17 -0
  218. data/docs/UpdateCarrierSettingsRequestBody.md +51 -0
  219. data/docs/UpdateDhlExpressSettingsRequestBody.md +16 -0
  220. data/docs/UpdateFedexSettingsRequestBody.md +16 -0
  221. data/docs/UpdateNewgisticsSettingsRequestBody.md +19 -0
  222. data/docs/UpdatePackageTypeRequestBody.md +16 -0
  223. data/docs/UpdateShipmentFields.md +17 -0
  224. data/docs/UpdateShipmentRequestBody.md +61 -0
  225. data/docs/UpdateShipmentResponseBody.md +16 -0
  226. data/docs/UpdateUpsSettingsRequestBody.md +16 -0
  227. data/docs/UpdateWarehouseRequestBody.md +16 -0
  228. data/docs/UpdateWebhookRequestBody.md +17 -0
  229. data/docs/UpsAccountSettings.md +39 -0
  230. data/docs/UpsInvoice.md +23 -0
  231. data/docs/UpsPickupType.md +16 -0
  232. data/docs/UpsSettingsResponseBody.md +16 -0
  233. data/docs/ValidateAddress.md +16 -0
  234. data/docs/ValidateShipmentFields.md +17 -0
  235. data/docs/ValidationStatus.md +16 -0
  236. data/docs/VoidLabelResponseBody.md +19 -0
  237. data/docs/Warehouse.md +25 -0
  238. data/docs/WarehousesApi.md +281 -0
  239. data/docs/Webhook.md +21 -0
  240. data/docs/WebhookEvent.md +16 -0
  241. data/docs/WebhooksApi.md +281 -0
  242. data/docs/Weight.md +19 -0
  243. data/docs/WeightUnit.md +16 -0
  244. data/git_push.sh +58 -0
  245. data/lib/openapi_client.rb +278 -0
  246. data/lib/openapi_client/api/addresses_api.rb +150 -0
  247. data/lib/openapi_client/api/batches_api.rb +790 -0
  248. data/lib/openapi_client/api/carrier_accounts_api.rb +343 -0
  249. data/lib/openapi_client/api/carriers_api.rb +461 -0
  250. data/lib/openapi_client/api/downloads_api.rb +99 -0
  251. data/lib/openapi_client/api/insurance_api.rb +262 -0
  252. data/lib/openapi_client/api/labels_api.rb +812 -0
  253. data/lib/openapi_client/api/manifests_api.rb +278 -0
  254. data/lib/openapi_client/api/package_types_api.rb +375 -0
  255. data/lib/openapi_client/api/rates_api.rb +289 -0
  256. data/lib/openapi_client/api/shipments_api.rb +899 -0
  257. data/lib/openapi_client/api/tags_api.rb +286 -0
  258. data/lib/openapi_client/api/tracking_api.rb +232 -0
  259. data/lib/openapi_client/api/warehouses_api.rb +375 -0
  260. data/lib/openapi_client/api/webhooks_api.rb +375 -0
  261. data/lib/openapi_client/api_client.rb +388 -0
  262. data/lib/openapi_client/api_error.rb +57 -0
  263. data/lib/openapi_client/configuration.rb +248 -0
  264. data/lib/openapi_client/models/add_funds_to_carrier_request_body.rb +209 -0
  265. data/lib/openapi_client/models/add_funds_to_carrier_response_body.rb +213 -0
  266. data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +209 -0
  267. data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +209 -0
  268. data/lib/openapi_client/models/add_to_batch_request_body.rb +209 -0
  269. data/lib/openapi_client/models/address.rb +209 -0
  270. data/lib/openapi_client/models/address_residential_indicator.rb +37 -0
  271. data/lib/openapi_client/models/address_to_validate.rb +209 -0
  272. data/lib/openapi_client/models/address_validating_shipment.rb +484 -0
  273. data/lib/openapi_client/models/address_validation_code.rb +47 -0
  274. data/lib/openapi_client/models/address_validation_detail_code.rb +92 -0
  275. data/lib/openapi_client/models/address_validation_message_type.rb +37 -0
  276. data/lib/openapi_client/models/address_validation_result.rb +259 -0
  277. data/lib/openapi_client/models/address_validation_status.rb +38 -0
  278. data/lib/openapi_client/models/advanced_shipment_options.rb +434 -0
  279. data/lib/openapi_client/models/ancillary_service_endorsement.rb +40 -0
  280. data/lib/openapi_client/models/batch.rb +566 -0
  281. data/lib/openapi_client/models/batch_response_error.rb +233 -0
  282. data/lib/openapi_client/models/batch_status.rb +42 -0
  283. data/lib/openapi_client/models/batches_sort_by.rb +36 -0
  284. data/lib/openapi_client/models/bill_to_party.rb +36 -0
  285. data/lib/openapi_client/models/bulk_rate.rb +273 -0
  286. data/lib/openapi_client/models/calculate_rates_request_body.rb +225 -0
  287. data/lib/openapi_client/models/calculate_rates_response_body.rb +525 -0
  288. data/lib/openapi_client/models/carrier.rb +394 -0
  289. data/lib/openapi_client/models/carrier_advanced_option.rb +273 -0
  290. data/lib/openapi_client/models/carrier_name.rb +61 -0
  291. data/lib/openapi_client/models/carrier_name_with_settings.rb +38 -0
  292. data/lib/openapi_client/models/collect_on_delivery.rb +216 -0
  293. data/lib/openapi_client/models/collect_on_delivery_payment_type.rb +38 -0
  294. data/lib/openapi_client/models/compare_bulk_rates_request_body.rb +225 -0
  295. data/lib/openapi_client/models/connect_access_worldwide_request_body.rb +300 -0
  296. data/lib/openapi_client/models/connect_amazon_buy_shipping_request_body.rb +312 -0
  297. data/lib/openapi_client/models/connect_apc_request_body.rb +300 -0
  298. data/lib/openapi_client/models/connect_asendia_request_body.rb +334 -0
  299. data/lib/openapi_client/models/connect_australia_post_request_body.rb +334 -0
  300. data/lib/openapi_client/models/connect_canada_post_request_body.rb +368 -0
  301. data/lib/openapi_client/models/connect_carrier_request_body.rb +1661 -0
  302. data/lib/openapi_client/models/connect_carrier_response_body.rb +213 -0
  303. data/lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb +536 -0
  304. data/lib/openapi_client/models/connect_dhl_express_au_request_body.rb +266 -0
  305. data/lib/openapi_client/models/connect_dhl_express_ca_request_body.rb +266 -0
  306. data/lib/openapi_client/models/connect_dhl_express_request_body.rb +266 -0
  307. data/lib/openapi_client/models/connect_dhl_express_uk_request_body.rb +315 -0
  308. data/lib/openapi_client/models/connect_dpd_request_body.rb +300 -0
  309. data/lib/openapi_client/models/connect_endicia_request_body.rb +300 -0
  310. data/lib/openapi_client/models/connect_fedex_request_body.rb +643 -0
  311. data/lib/openapi_client/models/connect_fedex_uk_request_body.rb +643 -0
  312. data/lib/openapi_client/models/connect_firstmile_request_body.rb +306 -0
  313. data/lib/openapi_client/models/connect_globegistics_request_body.rb +300 -0
  314. data/lib/openapi_client/models/connect_imex_request_body.rb +300 -0
  315. data/lib/openapi_client/models/connect_insurer_request_body.rb +245 -0
  316. data/lib/openapi_client/models/connect_newgistics_request_body.rb +316 -0
  317. data/lib/openapi_client/models/connect_ontrac_request_body.rb +300 -0
  318. data/lib/openapi_client/models/connect_purolator_request_body.rb +300 -0
  319. data/lib/openapi_client/models/connect_royal_mail_request_body.rb +513 -0
  320. data/lib/openapi_client/models/connect_rr_donnelley_request_body.rb +300 -0
  321. data/lib/openapi_client/models/connect_seko_request_body.rb +266 -0
  322. data/lib/openapi_client/models/connect_sendle_request_body.rb +281 -0
  323. data/lib/openapi_client/models/connect_stamps_request_body.rb +300 -0
  324. data/lib/openapi_client/models/connect_ups_request_body.rb +730 -0
  325. data/lib/openapi_client/models/create_and_validate_shipment.rb +472 -0
  326. data/lib/openapi_client/models/create_batch_request_body.rb +257 -0
  327. data/lib/openapi_client/models/create_batch_response_body.rb +209 -0
  328. data/lib/openapi_client/models/create_label_from_rate_request_body.rb +209 -0
  329. data/lib/openapi_client/models/create_label_from_rate_response_body.rb +209 -0
  330. data/lib/openapi_client/models/create_label_from_shipment_request_body.rb +234 -0
  331. data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +209 -0
  332. data/lib/openapi_client/models/create_label_request_body.rb +209 -0
  333. data/lib/openapi_client/models/create_label_response_body.rb +209 -0
  334. data/lib/openapi_client/models/create_manifest_by_object_request_body.rb +267 -0
  335. data/lib/openapi_client/models/create_manifest_label_ids_request_body.rb +215 -0
  336. data/lib/openapi_client/models/create_manifest_request_body.rb +295 -0
  337. data/lib/openapi_client/models/create_manifest_response_body.rb +389 -0
  338. data/lib/openapi_client/models/create_package_type_request_body.rb +209 -0
  339. data/lib/openapi_client/models/create_package_type_response_body.rb +209 -0
  340. data/lib/openapi_client/models/create_return_label_request_body.rb +248 -0
  341. data/lib/openapi_client/models/create_return_label_response_body.rb +209 -0
  342. data/lib/openapi_client/models/create_shipment_response_body_fields.rb +219 -0
  343. data/lib/openapi_client/models/create_shipments_request_body.rb +215 -0
  344. data/lib/openapi_client/models/create_shipments_response_body.rb +232 -0
  345. data/lib/openapi_client/models/create_tag_response_body.rb +209 -0
  346. data/lib/openapi_client/models/create_warehouse_request_body.rb +209 -0
  347. data/lib/openapi_client/models/create_warehouse_response_body.rb +209 -0
  348. data/lib/openapi_client/models/create_webhook_request_body.rb +227 -0
  349. data/lib/openapi_client/models/create_webhook_response_body.rb +209 -0
  350. data/lib/openapi_client/models/currency.rb +40 -0
  351. data/lib/openapi_client/models/customs_item.rb +334 -0
  352. data/lib/openapi_client/models/delivery_confirmation.rb +40 -0
  353. data/lib/openapi_client/models/deprecated_manifest.rb +317 -0
  354. data/lib/openapi_client/models/dhl_express_account_settings.rb +243 -0
  355. data/lib/openapi_client/models/dhl_express_settings_response_body.rb +209 -0
  356. data/lib/openapi_client/models/dimension_unit.rb +36 -0
  357. data/lib/openapi_client/models/dimensions.rb +320 -0
  358. data/lib/openapi_client/models/error.rb +274 -0
  359. data/lib/openapi_client/models/error_code.rb +71 -0
  360. data/lib/openapi_client/models/error_response_body.rb +230 -0
  361. data/lib/openapi_client/models/error_source.rb +37 -0
  362. data/lib/openapi_client/models/error_type.rb +40 -0
  363. data/lib/openapi_client/models/estimate_rates_request_body.rb +225 -0
  364. data/lib/openapi_client/models/fedex_account_settings.rb +259 -0
  365. data/lib/openapi_client/models/fedex_account_settings_request_body.rb +209 -0
  366. data/lib/openapi_client/models/fedex_pickup_type.rb +40 -0
  367. data/lib/openapi_client/models/fedex_settings_response_body.rb +209 -0
  368. data/lib/openapi_client/models/get_batch_by_external_id_response_body.rb +209 -0
  369. data/lib/openapi_client/models/get_batch_by_id_response_body.rb +209 -0
  370. data/lib/openapi_client/models/get_carrier_by_id_response_body.rb +209 -0
  371. data/lib/openapi_client/models/get_carrier_options_response_body.rb +210 -0
  372. data/lib/openapi_client/models/get_carrier_settings_response_body.rb +413 -0
  373. data/lib/openapi_client/models/get_carriers_response_body.rb +254 -0
  374. data/lib/openapi_client/models/get_insurance_balance_response_body.rb +209 -0
  375. data/lib/openapi_client/models/get_label_by_external_shipment_id_response_body.rb +209 -0
  376. data/lib/openapi_client/models/get_label_by_id_response_body.rb +209 -0
  377. data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +209 -0
  378. data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +209 -0
  379. data/lib/openapi_client/models/get_rate_by_id_response_body.rb +209 -0
  380. data/lib/openapi_client/models/get_shipment_by_external_id_response_body.rb +209 -0
  381. data/lib/openapi_client/models/get_shipment_by_id_response_body.rb +209 -0
  382. data/lib/openapi_client/models/get_tracking_log_from_label_response_body.rb +209 -0
  383. data/lib/openapi_client/models/get_tracking_log_response_body.rb +209 -0
  384. data/lib/openapi_client/models/get_warehouse_by_id_response_body.rb +209 -0
  385. data/lib/openapi_client/models/get_webhook_by_id_response_body.rb +209 -0
  386. data/lib/openapi_client/models/insurance_provider.rb +38 -0
  387. data/lib/openapi_client/models/international_shipment_options.rb +240 -0
  388. data/lib/openapi_client/models/label.rb +548 -0
  389. data/lib/openapi_client/models/label_charge_event.rb +37 -0
  390. data/lib/openapi_client/models/label_download.rb +238 -0
  391. data/lib/openapi_client/models/label_download_type.rb +36 -0
  392. data/lib/openapi_client/models/label_format.rb +37 -0
  393. data/lib/openapi_client/models/label_layout.rb +36 -0
  394. data/lib/openapi_client/models/label_messages.rb +237 -0
  395. data/lib/openapi_client/models/label_status.rb +38 -0
  396. data/lib/openapi_client/models/link.rb +209 -0
  397. data/lib/openapi_client/models/list_batch_errors_response_body.rb +229 -0
  398. data/lib/openapi_client/models/list_batches_response_body.rb +331 -0
  399. data/lib/openapi_client/models/list_carrier_package_types_response_body.rb +210 -0
  400. data/lib/openapi_client/models/list_carrier_services_response_body.rb +210 -0
  401. data/lib/openapi_client/models/list_carriers_response_body.rb +215 -0
  402. data/lib/openapi_client/models/list_labels_response_body.rb +226 -0
  403. data/lib/openapi_client/models/list_manifests_response_body.rb +332 -0
  404. data/lib/openapi_client/models/list_package_types_response_body.rb +210 -0
  405. data/lib/openapi_client/models/list_shipment_errors_response_body.rb +229 -0
  406. data/lib/openapi_client/models/list_shipment_rates_response_body.rb +209 -0
  407. data/lib/openapi_client/models/list_shipments_response_body.rb +329 -0
  408. data/lib/openapi_client/models/list_tags_response_body.rb +210 -0
  409. data/lib/openapi_client/models/list_warehouses_response_body.rb +215 -0
  410. data/lib/openapi_client/models/manifest.rb +317 -0
  411. data/lib/openapi_client/models/manifest_download.rb +208 -0
  412. data/lib/openapi_client/models/manifests.rb +209 -0
  413. data/lib/openapi_client/models/modify_batch.rb +222 -0
  414. data/lib/openapi_client/models/monetary_value.rb +246 -0
  415. data/lib/openapi_client/models/non_delivery.rb +36 -0
  416. data/lib/openapi_client/models/optional_link.rb +233 -0
  417. data/lib/openapi_client/models/order_source_name.rb +54 -0
  418. data/lib/openapi_client/models/package.rb +287 -0
  419. data/lib/openapi_client/models/package_contents.rb +39 -0
  420. data/lib/openapi_client/models/package_type.rb +276 -0
  421. data/lib/openapi_client/models/paged_list_response_body.rb +314 -0
  422. data/lib/openapi_client/models/pagination_link.rb +258 -0
  423. data/lib/openapi_client/models/parse_address_request_body.rb +242 -0
  424. data/lib/openapi_client/models/parse_address_response_body.rb +273 -0
  425. data/lib/openapi_client/models/parse_shipment_request_body.rb +242 -0
  426. data/lib/openapi_client/models/parse_shipment_response_body.rb +273 -0
  427. data/lib/openapi_client/models/partial_address.rb +432 -0
  428. data/lib/openapi_client/models/partial_shipment.rb +442 -0
  429. data/lib/openapi_client/models/payment_amount.rb +230 -0
  430. data/lib/openapi_client/models/process_batch_request_body.rb +228 -0
  431. data/lib/openapi_client/models/purchase_label_without_shipment.rb +234 -0
  432. data/lib/openapi_client/models/rate.rb +696 -0
  433. data/lib/openapi_client/models/rate_estimate_by_carrier_id.rb +207 -0
  434. data/lib/openapi_client/models/rate_estimate_by_carrier_ids.rb +209 -0
  435. data/lib/openapi_client/models/rate_estimate_options.rb +381 -0
  436. data/lib/openapi_client/models/rate_request_body.rb +256 -0
  437. data/lib/openapi_client/models/rate_request_by_shipment_ids.rb +214 -0
  438. data/lib/openapi_client/models/rate_request_by_shipments.rb +214 -0
  439. data/lib/openapi_client/models/rate_request_options.rb +207 -0
  440. data/lib/openapi_client/models/rate_request_rate_options.rb +207 -0
  441. data/lib/openapi_client/models/rate_response.rb +207 -0
  442. data/lib/openapi_client/models/rate_response_status.rb +38 -0
  443. data/lib/openapi_client/models/rate_type.rb +36 -0
  444. data/lib/openapi_client/models/rates_information.rb +272 -0
  445. data/lib/openapi_client/models/recognized_entity.rb +389 -0
  446. data/lib/openapi_client/models/remove_from_batch_request_body.rb +209 -0
  447. data/lib/openapi_client/models/response_message.rb +251 -0
  448. data/lib/openapi_client/models/service.rb +297 -0
  449. data/lib/openapi_client/models/shipment.rb +209 -0
  450. data/lib/openapi_client/models/shipment_id_request.rb +207 -0
  451. data/lib/openapi_client/models/shipment_item.rb +347 -0
  452. data/lib/openapi_client/models/shipment_request.rb +207 -0
  453. data/lib/openapi_client/models/shipment_response_error.rb +257 -0
  454. data/lib/openapi_client/models/shipment_status.rb +38 -0
  455. data/lib/openapi_client/models/shipments_sort_by.rb +36 -0
  456. data/lib/openapi_client/models/smart_post_hub.rb +68 -0
  457. data/lib/openapi_client/models/sort_dir.rb +36 -0
  458. data/lib/openapi_client/models/tag.rb +232 -0
  459. data/lib/openapi_client/models/tag_shipment_response_body.rb +228 -0
  460. data/lib/openapi_client/models/track_event.rb +502 -0
  461. data/lib/openapi_client/models/tracking_information.rb +371 -0
  462. data/lib/openapi_client/models/tracking_status.rb +38 -0
  463. data/lib/openapi_client/models/update_amazon_buy_shipping_request_body.rb +223 -0
  464. data/lib/openapi_client/models/update_carrier_settings_request_body.rb +458 -0
  465. data/lib/openapi_client/models/update_dhl_express_settings_request_body.rb +209 -0
  466. data/lib/openapi_client/models/update_fedex_settings_request_body.rb +209 -0
  467. data/lib/openapi_client/models/update_newgistics_settings_request_body.rb +216 -0
  468. data/lib/openapi_client/models/update_package_type_request_body.rb +209 -0
  469. data/lib/openapi_client/models/update_shipment_fields.rb +206 -0
  470. data/lib/openapi_client/models/update_shipment_request_body.rb +469 -0
  471. data/lib/openapi_client/models/update_shipment_response_body.rb +209 -0
  472. data/lib/openapi_client/models/update_ups_settings_request_body.rb +209 -0
  473. data/lib/openapi_client/models/update_warehouse_request_body.rb +209 -0
  474. data/lib/openapi_client/models/update_webhook_request_body.rb +208 -0
  475. data/lib/openapi_client/models/ups_account_settings.rb +361 -0
  476. data/lib/openapi_client/models/ups_invoice.rb +267 -0
  477. data/lib/openapi_client/models/ups_pickup_type.rb +37 -0
  478. data/lib/openapi_client/models/ups_settings_response_body.rb +209 -0
  479. data/lib/openapi_client/models/validate_address.rb +37 -0
  480. data/lib/openapi_client/models/validate_shipment_fields.rb +206 -0
  481. data/lib/openapi_client/models/validation_status.rb +38 -0
  482. data/lib/openapi_client/models/void_label_response_body.rb +246 -0
  483. data/lib/openapi_client/models/warehouse.rb +263 -0
  484. data/lib/openapi_client/models/webhook.rb +227 -0
  485. data/lib/openapi_client/models/webhook_event.rb +41 -0
  486. data/lib/openapi_client/models/weight.rb +246 -0
  487. data/lib/openapi_client/models/weight_unit.rb +38 -0
  488. data/lib/openapi_client/version.rb +15 -0
  489. data/openapi_client.gemspec +39 -0
  490. data/spec/api/addresses_api_spec.rb +59 -0
  491. data/spec/api/batches_api_spec.rb +164 -0
  492. data/spec/api/carrier_accounts_api_spec.rb +88 -0
  493. data/spec/api/carriers_api_spec.rb +107 -0
  494. data/spec/api/downloads_api_spec.rb +50 -0
  495. data/spec/api/insurance_api_spec.rb +81 -0
  496. data/spec/api/labels_api_spec.rb +161 -0
  497. data/spec/api/manifests_api_spec.rb +79 -0
  498. data/spec/api/package_types_api_spec.rb +95 -0
  499. data/spec/api/rates_api_spec.rb +83 -0
  500. data/spec/api/shipments_api_spec.rb +184 -0
  501. data/spec/api/tags_api_spec.rb +83 -0
  502. data/spec/api/tracking_api_spec.rb +74 -0
  503. data/spec/api/warehouses_api_spec.rb +95 -0
  504. data/spec/api/webhooks_api_spec.rb +95 -0
  505. data/spec/api_client_spec.rb +226 -0
  506. data/spec/configuration_spec.rb +42 -0
  507. data/spec/models/add_funds_to_carrier_request_body_spec.rb +35 -0
  508. data/spec/models/add_funds_to_carrier_response_body_spec.rb +41 -0
  509. data/spec/models/add_funds_to_insurance_request_body_spec.rb +35 -0
  510. data/spec/models/add_funds_to_insurance_response_body_spec.rb +35 -0
  511. data/spec/models/add_to_batch_request_body_spec.rb +35 -0
  512. data/spec/models/address_residential_indicator_spec.rb +35 -0
  513. data/spec/models/address_spec.rb +35 -0
  514. data/spec/models/address_to_validate_spec.rb +35 -0
  515. data/spec/models/address_validating_shipment_spec.rb +173 -0
  516. data/spec/models/address_validation_code_spec.rb +35 -0
  517. data/spec/models/address_validation_detail_code_spec.rb +35 -0
  518. data/spec/models/address_validation_message_type_spec.rb +35 -0
  519. data/spec/models/address_validation_result_spec.rb +59 -0
  520. data/spec/models/address_validation_status_spec.rb +35 -0
  521. data/spec/models/advanced_shipment_options_spec.rb +131 -0
  522. data/spec/models/ancillary_service_endorsement_spec.rb +35 -0
  523. data/spec/models/batch_response_error_spec.rb +47 -0
  524. data/spec/models/batch_spec.rb +143 -0
  525. data/spec/models/batch_status_spec.rb +35 -0
  526. data/spec/models/batches_sort_by_spec.rb +35 -0
  527. data/spec/models/bill_to_party_spec.rb +35 -0
  528. data/spec/models/bulk_rate_spec.rb +65 -0
  529. data/spec/models/calculate_rates_request_body_spec.rb +35 -0
  530. data/spec/models/calculate_rates_response_body_spec.rb +173 -0
  531. data/spec/models/carrier_advanced_option_spec.rb +53 -0
  532. data/spec/models/carrier_name_spec.rb +35 -0
  533. data/spec/models/carrier_name_with_settings_spec.rb +35 -0
  534. data/spec/models/carrier_spec.rb +113 -0
  535. data/spec/models/collect_on_delivery_payment_type_spec.rb +35 -0
  536. data/spec/models/collect_on_delivery_spec.rb +47 -0
  537. data/spec/models/compare_bulk_rates_request_body_spec.rb +35 -0
  538. data/spec/models/connect_access_worldwide_request_body_spec.rb +53 -0
  539. data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +59 -0
  540. data/spec/models/connect_apc_request_body_spec.rb +53 -0
  541. data/spec/models/connect_asendia_request_body_spec.rb +59 -0
  542. data/spec/models/connect_australia_post_request_body_spec.rb +59 -0
  543. data/spec/models/connect_canada_post_request_body_spec.rb +65 -0
  544. data/spec/models/connect_carrier_request_body_spec.rb +329 -0
  545. data/spec/models/connect_carrier_response_body_spec.rb +41 -0
  546. data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +107 -0
  547. data/spec/models/connect_dhl_express_au_request_body_spec.rb +47 -0
  548. data/spec/models/connect_dhl_express_ca_request_body_spec.rb +47 -0
  549. data/spec/models/connect_dhl_express_request_body_spec.rb +47 -0
  550. data/spec/models/connect_dhl_express_uk_request_body_spec.rb +59 -0
  551. data/spec/models/connect_dpd_request_body_spec.rb +53 -0
  552. data/spec/models/connect_endicia_request_body_spec.rb +53 -0
  553. data/spec/models/connect_fedex_request_body_spec.rb +125 -0
  554. data/spec/models/connect_fedex_uk_request_body_spec.rb +125 -0
  555. data/spec/models/connect_firstmile_request_body_spec.rb +59 -0
  556. data/spec/models/connect_globegistics_request_body_spec.rb +53 -0
  557. data/spec/models/connect_imex_request_body_spec.rb +53 -0
  558. data/spec/models/connect_insurer_request_body_spec.rb +47 -0
  559. data/spec/models/connect_newgistics_request_body_spec.rb +59 -0
  560. data/spec/models/connect_ontrac_request_body_spec.rb +53 -0
  561. data/spec/models/connect_purolator_request_body_spec.rb +53 -0
  562. data/spec/models/connect_royal_mail_request_body_spec.rb +107 -0
  563. data/spec/models/connect_rr_donnelley_request_body_spec.rb +53 -0
  564. data/spec/models/connect_seko_request_body_spec.rb +47 -0
  565. data/spec/models/connect_sendle_request_body_spec.rb +53 -0
  566. data/spec/models/connect_stamps_request_body_spec.rb +53 -0
  567. data/spec/models/connect_ups_request_body_spec.rb +143 -0
  568. data/spec/models/create_and_validate_shipment_spec.rb +179 -0
  569. data/spec/models/create_batch_request_body_spec.rb +59 -0
  570. data/spec/models/create_batch_response_body_spec.rb +35 -0
  571. data/spec/models/create_label_from_rate_request_body_spec.rb +35 -0
  572. data/spec/models/create_label_from_rate_response_body_spec.rb +35 -0
  573. data/spec/models/create_label_from_shipment_request_body_spec.rb +59 -0
  574. data/spec/models/create_label_from_shipment_response_body_spec.rb +35 -0
  575. data/spec/models/create_label_request_body_spec.rb +35 -0
  576. data/spec/models/create_label_response_body_spec.rb +35 -0
  577. data/spec/models/create_manifest_by_object_request_body_spec.rb +65 -0
  578. data/spec/models/create_manifest_label_ids_request_body_spec.rb +41 -0
  579. data/spec/models/create_manifest_request_body_spec.rb +65 -0
  580. data/spec/models/create_manifest_response_body_spec.rb +95 -0
  581. data/spec/models/create_package_type_request_body_spec.rb +35 -0
  582. data/spec/models/create_package_type_response_body_spec.rb +35 -0
  583. data/spec/models/create_return_label_request_body_spec.rb +65 -0
  584. data/spec/models/create_return_label_response_body_spec.rb +35 -0
  585. data/spec/models/create_shipment_response_body_fields_spec.rb +47 -0
  586. data/spec/models/create_shipments_request_body_spec.rb +41 -0
  587. data/spec/models/create_shipments_response_body_spec.rb +47 -0
  588. data/spec/models/create_tag_response_body_spec.rb +35 -0
  589. data/spec/models/create_warehouse_request_body_spec.rb +35 -0
  590. data/spec/models/create_warehouse_response_body_spec.rb +35 -0
  591. data/spec/models/create_webhook_request_body_spec.rb +47 -0
  592. data/spec/models/create_webhook_response_body_spec.rb +35 -0
  593. data/spec/models/currency_spec.rb +35 -0
  594. data/spec/models/customs_item_spec.rb +89 -0
  595. data/spec/models/delivery_confirmation_spec.rb +35 -0
  596. data/spec/models/deprecated_manifest_spec.rb +89 -0
  597. data/spec/models/dhl_express_account_settings_spec.rb +53 -0
  598. data/spec/models/dhl_express_settings_response_body_spec.rb +35 -0
  599. data/spec/models/dimension_unit_spec.rb +35 -0
  600. data/spec/models/dimensions_spec.rb +59 -0
  601. data/spec/models/error_code_spec.rb +35 -0
  602. data/spec/models/error_response_body_spec.rb +47 -0
  603. data/spec/models/error_source_spec.rb +35 -0
  604. data/spec/models/error_spec.rb +59 -0
  605. data/spec/models/error_type_spec.rb +35 -0
  606. data/spec/models/estimate_rates_request_body_spec.rb +35 -0
  607. data/spec/models/fedex_account_settings_request_body_spec.rb +35 -0
  608. data/spec/models/fedex_account_settings_spec.rb +65 -0
  609. data/spec/models/fedex_pickup_type_spec.rb +35 -0
  610. data/spec/models/fedex_settings_response_body_spec.rb +35 -0
  611. data/spec/models/get_batch_by_external_id_response_body_spec.rb +35 -0
  612. data/spec/models/get_batch_by_id_response_body_spec.rb +35 -0
  613. data/spec/models/get_carrier_by_id_response_body_spec.rb +35 -0
  614. data/spec/models/get_carrier_options_response_body_spec.rb +41 -0
  615. data/spec/models/get_carrier_settings_response_body_spec.rb +125 -0
  616. data/spec/models/get_carriers_response_body_spec.rb +53 -0
  617. data/spec/models/get_insurance_balance_response_body_spec.rb +35 -0
  618. data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +35 -0
  619. data/spec/models/get_label_by_id_response_body_spec.rb +35 -0
  620. data/spec/models/get_manifest_by_id_response_body_spec.rb +35 -0
  621. data/spec/models/get_package_type_by_id_response_body_spec.rb +35 -0
  622. data/spec/models/get_rate_by_id_response_body_spec.rb +35 -0
  623. data/spec/models/get_shipment_by_external_id_response_body_spec.rb +35 -0
  624. data/spec/models/get_shipment_by_id_response_body_spec.rb +35 -0
  625. data/spec/models/get_tracking_log_from_label_response_body_spec.rb +35 -0
  626. data/spec/models/get_tracking_log_response_body_spec.rb +35 -0
  627. data/spec/models/get_warehouse_by_id_response_body_spec.rb +35 -0
  628. data/spec/models/get_webhook_by_id_response_body_spec.rb +35 -0
  629. data/spec/models/insurance_provider_spec.rb +35 -0
  630. data/spec/models/international_shipment_options_spec.rb +53 -0
  631. data/spec/models/label_charge_event_spec.rb +35 -0
  632. data/spec/models/label_download_spec.rb +59 -0
  633. data/spec/models/label_download_type_spec.rb +35 -0
  634. data/spec/models/label_format_spec.rb +35 -0
  635. data/spec/models/label_layout_spec.rb +35 -0
  636. data/spec/models/label_messages_spec.rb +53 -0
  637. data/spec/models/label_spec.rb +233 -0
  638. data/spec/models/label_status_spec.rb +35 -0
  639. data/spec/models/link_spec.rb +35 -0
  640. data/spec/models/list_batch_errors_response_body_spec.rb +47 -0
  641. data/spec/models/list_batches_response_body_spec.rb +65 -0
  642. data/spec/models/list_carrier_package_types_response_body_spec.rb +41 -0
  643. data/spec/models/list_carrier_services_response_body_spec.rb +41 -0
  644. data/spec/models/list_carriers_response_body_spec.rb +41 -0
  645. data/spec/models/list_labels_response_body_spec.rb +41 -0
  646. data/spec/models/list_manifests_response_body_spec.rb +65 -0
  647. data/spec/models/list_package_types_response_body_spec.rb +41 -0
  648. data/spec/models/list_shipment_errors_response_body_spec.rb +47 -0
  649. data/spec/models/list_shipment_rates_response_body_spec.rb +35 -0
  650. data/spec/models/list_shipments_response_body_spec.rb +65 -0
  651. data/spec/models/list_tags_response_body_spec.rb +41 -0
  652. data/spec/models/list_warehouses_response_body_spec.rb +41 -0
  653. data/spec/models/manifest_download_spec.rb +41 -0
  654. data/spec/models/manifest_spec.rb +89 -0
  655. data/spec/models/manifests_spec.rb +41 -0
  656. data/spec/models/modify_batch_spec.rb +47 -0
  657. data/spec/models/monetary_value_spec.rb +47 -0
  658. data/spec/models/non_delivery_spec.rb +35 -0
  659. data/spec/models/optional_link_spec.rb +47 -0
  660. data/spec/models/order_source_name_spec.rb +35 -0
  661. data/spec/models/package_contents_spec.rb +35 -0
  662. data/spec/models/package_spec.rb +77 -0
  663. data/spec/models/package_type_spec.rb +65 -0
  664. data/spec/models/paged_list_response_body_spec.rb +59 -0
  665. data/spec/models/pagination_link_spec.rb +59 -0
  666. data/spec/models/parse_address_request_body_spec.rb +47 -0
  667. data/spec/models/parse_address_response_body_spec.rb +53 -0
  668. data/spec/models/parse_shipment_request_body_spec.rb +47 -0
  669. data/spec/models/parse_shipment_response_body_spec.rb +53 -0
  670. data/spec/models/partial_address_spec.rb +101 -0
  671. data/spec/models/partial_shipment_spec.rb +167 -0
  672. data/spec/models/payment_amount_spec.rb +47 -0
  673. data/spec/models/process_batch_request_body_spec.rb +53 -0
  674. data/spec/models/purchase_label_without_shipment_spec.rb +59 -0
  675. data/spec/models/rate_estimate_by_carrier_id_spec.rb +41 -0
  676. data/spec/models/rate_estimate_by_carrier_ids_spec.rb +41 -0
  677. data/spec/models/rate_estimate_options_spec.rb +113 -0
  678. data/spec/models/rate_request_body_spec.rb +65 -0
  679. data/spec/models/rate_request_by_shipment_ids_spec.rb +41 -0
  680. data/spec/models/rate_request_by_shipments_spec.rb +41 -0
  681. data/spec/models/rate_request_options_spec.rb +41 -0
  682. data/spec/models/rate_request_rate_options_spec.rb +41 -0
  683. data/spec/models/rate_response_spec.rb +41 -0
  684. data/spec/models/rate_response_status_spec.rb +35 -0
  685. data/spec/models/rate_spec.rb +185 -0
  686. data/spec/models/rate_type_spec.rb +35 -0
  687. data/spec/models/rates_information_spec.rb +77 -0
  688. data/spec/models/recognized_entity_spec.rb +71 -0
  689. data/spec/models/remove_from_batch_request_body_spec.rb +35 -0
  690. data/spec/models/response_message_spec.rb +59 -0
  691. data/spec/models/service_spec.rb +77 -0
  692. data/spec/models/shipment_id_request_spec.rb +41 -0
  693. data/spec/models/shipment_item_spec.rb +89 -0
  694. data/spec/models/shipment_request_spec.rb +41 -0
  695. data/spec/models/shipment_response_error_spec.rb +53 -0
  696. data/spec/models/shipment_spec.rb +35 -0
  697. data/spec/models/shipment_status_spec.rb +35 -0
  698. data/spec/models/shipments_sort_by_spec.rb +35 -0
  699. data/spec/models/smart_post_hub_spec.rb +35 -0
  700. data/spec/models/sort_dir_spec.rb +35 -0
  701. data/spec/models/tag_shipment_response_body_spec.rb +47 -0
  702. data/spec/models/tag_spec.rb +41 -0
  703. data/spec/models/track_event_spec.rb +107 -0
  704. data/spec/models/tracking_information_spec.rb +95 -0
  705. data/spec/models/tracking_status_spec.rb +35 -0
  706. data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +41 -0
  707. data/spec/models/update_carrier_settings_request_body_spec.rb +143 -0
  708. data/spec/models/update_dhl_express_settings_request_body_spec.rb +35 -0
  709. data/spec/models/update_fedex_settings_request_body_spec.rb +35 -0
  710. data/spec/models/update_newgistics_settings_request_body_spec.rb +47 -0
  711. data/spec/models/update_package_type_request_body_spec.rb +35 -0
  712. data/spec/models/update_shipment_fields_spec.rb +41 -0
  713. data/spec/models/update_shipment_request_body_spec.rb +173 -0
  714. data/spec/models/update_shipment_response_body_spec.rb +35 -0
  715. data/spec/models/update_ups_settings_request_body_spec.rb +35 -0
  716. data/spec/models/update_warehouse_request_body_spec.rb +35 -0
  717. data/spec/models/update_webhook_request_body_spec.rb +41 -0
  718. data/spec/models/ups_account_settings_spec.rb +107 -0
  719. data/spec/models/ups_invoice_spec.rb +59 -0
  720. data/spec/models/ups_pickup_type_spec.rb +35 -0
  721. data/spec/models/ups_settings_response_body_spec.rb +35 -0
  722. data/spec/models/validate_address_spec.rb +35 -0
  723. data/spec/models/validate_shipment_fields_spec.rb +41 -0
  724. data/spec/models/validation_status_spec.rb +35 -0
  725. data/spec/models/void_label_response_body_spec.rb +47 -0
  726. data/spec/models/warehouse_spec.rb +65 -0
  727. data/spec/models/webhook_event_spec.rb +35 -0
  728. data/spec/models/webhook_spec.rb +53 -0
  729. data/spec/models/weight_spec.rb +47 -0
  730. data/spec/models/weight_unit_spec.rb +35 -0
  731. data/spec/spec_helper.rb +111 -0
  732. metadata +1109 -0
@@ -0,0 +1,278 @@
1
+ =begin
2
+ #ShipEngine API
3
+
4
+ #ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
5
+
6
+ The version of the OpenAPI document: 1.1.202006302006
7
+ Contact: sales@shipengine.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module OpenapiClient
16
+ class ManifestsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create Manifest
23
+ # Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
24
+ # @param create_manifest_request_body [CreateManifestRequestBody]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [CreateManifestResponseBody]
27
+ def create_manifest(create_manifest_request_body, opts = {})
28
+ data, _status_code, _headers = create_manifest_with_http_info(create_manifest_request_body, opts)
29
+ data
30
+ end
31
+
32
+ # Create Manifest
33
+ # Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for.
34
+ # @param create_manifest_request_body [CreateManifestRequestBody]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(CreateManifestResponseBody, Integer, Hash)>] CreateManifestResponseBody data, response status code and response headers
37
+ def create_manifest_with_http_info(create_manifest_request_body, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ManifestsApi.create_manifest ...'
40
+ end
41
+ # verify the required parameter 'create_manifest_request_body' is set
42
+ if @api_client.config.client_side_validation && create_manifest_request_body.nil?
43
+ fail ArgumentError, "Missing the required parameter 'create_manifest_request_body' when calling ManifestsApi.create_manifest"
44
+ end
45
+ # resource path
46
+ local_var_path = '/v1/manifests'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body] || @api_client.object_to_http_body(create_manifest_request_body)
63
+
64
+ # return_type
65
+ return_type = opts[:return_type] || 'CreateManifestResponseBody'
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['api_key']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: ManifestsApi#create_manifest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Get Manifest By Id
87
+ # Get Manifest By Id
88
+ # @param manifest_id [String] The Manifest Id
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [GetManifestByIdResponseBody]
91
+ def get_manifest_by_id(manifest_id, opts = {})
92
+ data, _status_code, _headers = get_manifest_by_id_with_http_info(manifest_id, opts)
93
+ data
94
+ end
95
+
96
+ # Get Manifest By Id
97
+ # Get Manifest By Id
98
+ # @param manifest_id [String] The Manifest Id
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(GetManifestByIdResponseBody, Integer, Hash)>] GetManifestByIdResponseBody data, response status code and response headers
101
+ def get_manifest_by_id_with_http_info(manifest_id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: ManifestsApi.get_manifest_by_id ...'
104
+ end
105
+ # verify the required parameter 'manifest_id' is set
106
+ if @api_client.config.client_side_validation && manifest_id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'manifest_id' when calling ManifestsApi.get_manifest_by_id"
108
+ end
109
+ if @api_client.config.client_side_validation && manifest_id.to_s.length > 25
110
+ fail ArgumentError, 'invalid value for "manifest_id" when calling ManifestsApi.get_manifest_by_id, the character length must be smaller than or equal to 25.'
111
+ end
112
+
113
+ if @api_client.config.client_side_validation && manifest_id.to_s.length < 1
114
+ fail ArgumentError, 'invalid value for "manifest_id" when calling ManifestsApi.get_manifest_by_id, the character length must be great than or equal to 1.'
115
+ end
116
+
117
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
118
+ if @api_client.config.client_side_validation && manifest_id !~ pattern
119
+ fail ArgumentError, "invalid value for 'manifest_id' when calling ManifestsApi.get_manifest_by_id, must conform to the pattern #{pattern}."
120
+ end
121
+
122
+ # resource path
123
+ local_var_path = '/v1/manifests/{manifest_id}'.sub('{' + 'manifest_id' + '}', CGI.escape(manifest_id.to_s))
124
+
125
+ # query parameters
126
+ query_params = opts[:query_params] || {}
127
+
128
+ # header parameters
129
+ header_params = opts[:header_params] || {}
130
+ # HTTP header 'Accept' (if needed)
131
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
132
+
133
+ # form parameters
134
+ form_params = opts[:form_params] || {}
135
+
136
+ # http body (model)
137
+ post_body = opts[:body]
138
+
139
+ # return_type
140
+ return_type = opts[:return_type] || 'GetManifestByIdResponseBody'
141
+
142
+ # auth_names
143
+ auth_names = opts[:auth_names] || ['api_key']
144
+
145
+ new_options = opts.merge(
146
+ :header_params => header_params,
147
+ :query_params => query_params,
148
+ :form_params => form_params,
149
+ :body => post_body,
150
+ :auth_names => auth_names,
151
+ :return_type => return_type
152
+ )
153
+
154
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: ManifestsApi#get_manifest_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+
161
+ # List Manifests
162
+ # Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
163
+ # @param [Hash] opts the optional parameters
164
+ # @option opts [String] :warehouse_id Warehouse ID
165
+ # @option opts [DateTime] :ship_date_start ship date start range
166
+ # @option opts [DateTime] :ship_date_end ship date end range
167
+ # @option opts [DateTime] :created_at_start Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
168
+ # @option opts [DateTime] :created_at_end Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
169
+ # @option opts [String] :carrier_id Carrier ID
170
+ # @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that&#39;s greater than the number of pages of results, an empty page is returned. (default to 1)
171
+ # @option opts [Integer] :page_size The number of results to return per response. (default to 25)
172
+ # @option opts [Array<String>] :label_ids
173
+ # @return [ListManifestsResponseBody]
174
+ def list_manifests(opts = {})
175
+ data, _status_code, _headers = list_manifests_with_http_info(opts)
176
+ data
177
+ end
178
+
179
+ # List Manifests
180
+ # Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
181
+ # @param [Hash] opts the optional parameters
182
+ # @option opts [String] :warehouse_id Warehouse ID
183
+ # @option opts [DateTime] :ship_date_start ship date start range
184
+ # @option opts [DateTime] :ship_date_end ship date end range
185
+ # @option opts [DateTime] :created_at_start Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
186
+ # @option opts [DateTime] :created_at_end Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
187
+ # @option opts [String] :carrier_id Carrier ID
188
+ # @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that&#39;s greater than the number of pages of results, an empty page is returned.
189
+ # @option opts [Integer] :page_size The number of results to return per response.
190
+ # @option opts [Array<String>] :label_ids
191
+ # @return [Array<(ListManifestsResponseBody, Integer, Hash)>] ListManifestsResponseBody data, response status code and response headers
192
+ def list_manifests_with_http_info(opts = {})
193
+ if @api_client.config.debugging
194
+ @api_client.config.logger.debug 'Calling API: ManifestsApi.list_manifests ...'
195
+ end
196
+ if @api_client.config.client_side_validation && !opts[:'warehouse_id'].nil? && opts[:'warehouse_id'].to_s.length > 25
197
+ fail ArgumentError, 'invalid value for "opts[:"warehouse_id"]" when calling ManifestsApi.list_manifests, the character length must be smaller than or equal to 25.'
198
+ end
199
+
200
+ if @api_client.config.client_side_validation && !opts[:'warehouse_id'].nil? && opts[:'warehouse_id'].to_s.length < 1
201
+ fail ArgumentError, 'invalid value for "opts[:"warehouse_id"]" when calling ManifestsApi.list_manifests, the character length must be great than or equal to 1.'
202
+ end
203
+
204
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
205
+ if @api_client.config.client_side_validation && !opts[:'warehouse_id'].nil? && opts[:'warehouse_id'] !~ pattern
206
+ fail ArgumentError, "invalid value for 'opts[:\"warehouse_id\"]' when calling ManifestsApi.list_manifests, must conform to the pattern #{pattern}."
207
+ end
208
+
209
+ if @api_client.config.client_side_validation && !opts[:'carrier_id'].nil? && opts[:'carrier_id'].to_s.length > 25
210
+ fail ArgumentError, 'invalid value for "opts[:"carrier_id"]" when calling ManifestsApi.list_manifests, the character length must be smaller than or equal to 25.'
211
+ end
212
+
213
+ if @api_client.config.client_side_validation && !opts[:'carrier_id'].nil? && opts[:'carrier_id'].to_s.length < 1
214
+ fail ArgumentError, 'invalid value for "opts[:"carrier_id"]" when calling ManifestsApi.list_manifests, the character length must be great than or equal to 1.'
215
+ end
216
+
217
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
218
+ if @api_client.config.client_side_validation && !opts[:'carrier_id'].nil? && opts[:'carrier_id'] !~ pattern
219
+ fail ArgumentError, "invalid value for 'opts[:\"carrier_id\"]' when calling ManifestsApi.list_manifests, must conform to the pattern #{pattern}."
220
+ end
221
+
222
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
223
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ManifestsApi.list_manifests, must be greater than or equal to 1.'
224
+ end
225
+
226
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
227
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ManifestsApi.list_manifests, must be greater than or equal to 1.'
228
+ end
229
+
230
+ # resource path
231
+ local_var_path = '/v1/manifests'
232
+
233
+ # query parameters
234
+ query_params = opts[:query_params] || {}
235
+ query_params[:'warehouse_id'] = opts[:'warehouse_id'] if !opts[:'warehouse_id'].nil?
236
+ query_params[:'ship_date_start'] = opts[:'ship_date_start'] if !opts[:'ship_date_start'].nil?
237
+ query_params[:'ship_date_end'] = opts[:'ship_date_end'] if !opts[:'ship_date_end'].nil?
238
+ query_params[:'created_at_start'] = opts[:'created_at_start'] if !opts[:'created_at_start'].nil?
239
+ query_params[:'created_at_end'] = opts[:'created_at_end'] if !opts[:'created_at_end'].nil?
240
+ query_params[:'carrier_id'] = opts[:'carrier_id'] if !opts[:'carrier_id'].nil?
241
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
242
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
243
+ query_params[:'label_ids'] = @api_client.build_collection_param(opts[:'label_ids'], :multi) if !opts[:'label_ids'].nil?
244
+
245
+ # header parameters
246
+ header_params = opts[:header_params] || {}
247
+ # HTTP header 'Accept' (if needed)
248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
249
+
250
+ # form parameters
251
+ form_params = opts[:form_params] || {}
252
+
253
+ # http body (model)
254
+ post_body = opts[:body]
255
+
256
+ # return_type
257
+ return_type = opts[:return_type] || 'ListManifestsResponseBody'
258
+
259
+ # auth_names
260
+ auth_names = opts[:auth_names] || ['api_key']
261
+
262
+ new_options = opts.merge(
263
+ :header_params => header_params,
264
+ :query_params => query_params,
265
+ :form_params => form_params,
266
+ :body => post_body,
267
+ :auth_names => auth_names,
268
+ :return_type => return_type
269
+ )
270
+
271
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
272
+ if @api_client.config.debugging
273
+ @api_client.config.logger.debug "API called: ManifestsApi#list_manifests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
274
+ end
275
+ return data, status_code, headers
276
+ end
277
+ end
278
+ end
@@ -0,0 +1,375 @@
1
+ =begin
2
+ #ShipEngine API
3
+
4
+ #ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
5
+
6
+ The version of the OpenAPI document: 1.1.202006302006
7
+ Contact: sales@shipengine.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module OpenapiClient
16
+ class PackageTypesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create Custom Package Type
23
+ # Create a custom package type to better assist in getting accurate rate estimates
24
+ # @param create_package_type_request_body [CreatePackageTypeRequestBody]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [CreatePackageTypeResponseBody]
27
+ def create_package_type(create_package_type_request_body, opts = {})
28
+ data, _status_code, _headers = create_package_type_with_http_info(create_package_type_request_body, opts)
29
+ data
30
+ end
31
+
32
+ # Create Custom Package Type
33
+ # Create a custom package type to better assist in getting accurate rate estimates
34
+ # @param create_package_type_request_body [CreatePackageTypeRequestBody]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(CreatePackageTypeResponseBody, Integer, Hash)>] CreatePackageTypeResponseBody data, response status code and response headers
37
+ def create_package_type_with_http_info(create_package_type_request_body, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: PackageTypesApi.create_package_type ...'
40
+ end
41
+ # verify the required parameter 'create_package_type_request_body' is set
42
+ if @api_client.config.client_side_validation && create_package_type_request_body.nil?
43
+ fail ArgumentError, "Missing the required parameter 'create_package_type_request_body' when calling PackageTypesApi.create_package_type"
44
+ end
45
+ # resource path
46
+ local_var_path = '/v1/packages'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body] || @api_client.object_to_http_body(create_package_type_request_body)
63
+
64
+ # return_type
65
+ return_type = opts[:return_type] || 'CreatePackageTypeResponseBody'
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['api_key']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: PackageTypesApi#create_package_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Delete A Custom Package By ID
87
+ # Delete a custom package using the ID
88
+ # @param package_id [String] Package ID
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [String]
91
+ def delete_package_type(package_id, opts = {})
92
+ data, _status_code, _headers = delete_package_type_with_http_info(package_id, opts)
93
+ data
94
+ end
95
+
96
+ # Delete A Custom Package By ID
97
+ # Delete a custom package using the ID
98
+ # @param package_id [String] Package ID
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
101
+ def delete_package_type_with_http_info(package_id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: PackageTypesApi.delete_package_type ...'
104
+ end
105
+ # verify the required parameter 'package_id' is set
106
+ if @api_client.config.client_side_validation && package_id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'package_id' when calling PackageTypesApi.delete_package_type"
108
+ end
109
+ if @api_client.config.client_side_validation && package_id.to_s.length > 25
110
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.delete_package_type, the character length must be smaller than or equal to 25.'
111
+ end
112
+
113
+ if @api_client.config.client_side_validation && package_id.to_s.length < 1
114
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.delete_package_type, the character length must be great than or equal to 1.'
115
+ end
116
+
117
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
118
+ if @api_client.config.client_side_validation && package_id !~ pattern
119
+ fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.delete_package_type, must conform to the pattern #{pattern}."
120
+ end
121
+
122
+ # resource path
123
+ local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_id.to_s))
124
+
125
+ # query parameters
126
+ query_params = opts[:query_params] || {}
127
+
128
+ # header parameters
129
+ header_params = opts[:header_params] || {}
130
+ # HTTP header 'Accept' (if needed)
131
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])
132
+
133
+ # form parameters
134
+ form_params = opts[:form_params] || {}
135
+
136
+ # http body (model)
137
+ post_body = opts[:body]
138
+
139
+ # return_type
140
+ return_type = opts[:return_type] || 'String'
141
+
142
+ # auth_names
143
+ auth_names = opts[:auth_names] || ['api_key']
144
+
145
+ new_options = opts.merge(
146
+ :header_params => header_params,
147
+ :query_params => query_params,
148
+ :form_params => form_params,
149
+ :body => post_body,
150
+ :auth_names => auth_names,
151
+ :return_type => return_type
152
+ )
153
+
154
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: PackageTypesApi#delete_package_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+
161
+ # Get Custom Package Type By ID
162
+ # Get Custom Package Type by ID
163
+ # @param package_id [String] Package ID
164
+ # @param [Hash] opts the optional parameters
165
+ # @return [GetPackageTypeByIdResponseBody]
166
+ def get_package_type_by_id(package_id, opts = {})
167
+ data, _status_code, _headers = get_package_type_by_id_with_http_info(package_id, opts)
168
+ data
169
+ end
170
+
171
+ # Get Custom Package Type By ID
172
+ # Get Custom Package Type by ID
173
+ # @param package_id [String] Package ID
174
+ # @param [Hash] opts the optional parameters
175
+ # @return [Array<(GetPackageTypeByIdResponseBody, Integer, Hash)>] GetPackageTypeByIdResponseBody data, response status code and response headers
176
+ def get_package_type_by_id_with_http_info(package_id, opts = {})
177
+ if @api_client.config.debugging
178
+ @api_client.config.logger.debug 'Calling API: PackageTypesApi.get_package_type_by_id ...'
179
+ end
180
+ # verify the required parameter 'package_id' is set
181
+ if @api_client.config.client_side_validation && package_id.nil?
182
+ fail ArgumentError, "Missing the required parameter 'package_id' when calling PackageTypesApi.get_package_type_by_id"
183
+ end
184
+ if @api_client.config.client_side_validation && package_id.to_s.length > 25
185
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.get_package_type_by_id, the character length must be smaller than or equal to 25.'
186
+ end
187
+
188
+ if @api_client.config.client_side_validation && package_id.to_s.length < 1
189
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.get_package_type_by_id, the character length must be great than or equal to 1.'
190
+ end
191
+
192
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
193
+ if @api_client.config.client_side_validation && package_id !~ pattern
194
+ fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.get_package_type_by_id, must conform to the pattern #{pattern}."
195
+ end
196
+
197
+ # resource path
198
+ local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_id.to_s))
199
+
200
+ # query parameters
201
+ query_params = opts[:query_params] || {}
202
+
203
+ # header parameters
204
+ header_params = opts[:header_params] || {}
205
+ # HTTP header 'Accept' (if needed)
206
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
207
+
208
+ # form parameters
209
+ form_params = opts[:form_params] || {}
210
+
211
+ # http body (model)
212
+ post_body = opts[:body]
213
+
214
+ # return_type
215
+ return_type = opts[:return_type] || 'GetPackageTypeByIdResponseBody'
216
+
217
+ # auth_names
218
+ auth_names = opts[:auth_names] || ['api_key']
219
+
220
+ new_options = opts.merge(
221
+ :header_params => header_params,
222
+ :query_params => query_params,
223
+ :form_params => form_params,
224
+ :body => post_body,
225
+ :auth_names => auth_names,
226
+ :return_type => return_type
227
+ )
228
+
229
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
230
+ if @api_client.config.debugging
231
+ @api_client.config.logger.debug "API called: PackageTypesApi#get_package_type_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
232
+ end
233
+ return data, status_code, headers
234
+ end
235
+
236
+ # List Custom Package Types
237
+ # List the custom package types associated with the account
238
+ # @param [Hash] opts the optional parameters
239
+ # @return [ListPackageTypesResponseBody]
240
+ def list_package_types(opts = {})
241
+ data, _status_code, _headers = list_package_types_with_http_info(opts)
242
+ data
243
+ end
244
+
245
+ # List Custom Package Types
246
+ # List the custom package types associated with the account
247
+ # @param [Hash] opts the optional parameters
248
+ # @return [Array<(ListPackageTypesResponseBody, Integer, Hash)>] ListPackageTypesResponseBody data, response status code and response headers
249
+ def list_package_types_with_http_info(opts = {})
250
+ if @api_client.config.debugging
251
+ @api_client.config.logger.debug 'Calling API: PackageTypesApi.list_package_types ...'
252
+ end
253
+ # resource path
254
+ local_var_path = '/v1/packages'
255
+
256
+ # query parameters
257
+ query_params = opts[:query_params] || {}
258
+
259
+ # header parameters
260
+ header_params = opts[:header_params] || {}
261
+ # HTTP header 'Accept' (if needed)
262
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
263
+
264
+ # form parameters
265
+ form_params = opts[:form_params] || {}
266
+
267
+ # http body (model)
268
+ post_body = opts[:body]
269
+
270
+ # return_type
271
+ return_type = opts[:return_type] || 'ListPackageTypesResponseBody'
272
+
273
+ # auth_names
274
+ auth_names = opts[:auth_names] || ['api_key']
275
+
276
+ new_options = opts.merge(
277
+ :header_params => header_params,
278
+ :query_params => query_params,
279
+ :form_params => form_params,
280
+ :body => post_body,
281
+ :auth_names => auth_names,
282
+ :return_type => return_type
283
+ )
284
+
285
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
286
+ if @api_client.config.debugging
287
+ @api_client.config.logger.debug "API called: PackageTypesApi#list_package_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
288
+ end
289
+ return data, status_code, headers
290
+ end
291
+
292
+ # Update Custom Package Type By ID
293
+ # Update the custom package type object by ID
294
+ # @param package_id [String] Package ID
295
+ # @param update_package_type_request_body [UpdatePackageTypeRequestBody]
296
+ # @param [Hash] opts the optional parameters
297
+ # @return [String]
298
+ def update_package_type(package_id, update_package_type_request_body, opts = {})
299
+ data, _status_code, _headers = update_package_type_with_http_info(package_id, update_package_type_request_body, opts)
300
+ data
301
+ end
302
+
303
+ # Update Custom Package Type By ID
304
+ # Update the custom package type object by ID
305
+ # @param package_id [String] Package ID
306
+ # @param update_package_type_request_body [UpdatePackageTypeRequestBody]
307
+ # @param [Hash] opts the optional parameters
308
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
309
+ def update_package_type_with_http_info(package_id, update_package_type_request_body, opts = {})
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug 'Calling API: PackageTypesApi.update_package_type ...'
312
+ end
313
+ # verify the required parameter 'package_id' is set
314
+ if @api_client.config.client_side_validation && package_id.nil?
315
+ fail ArgumentError, "Missing the required parameter 'package_id' when calling PackageTypesApi.update_package_type"
316
+ end
317
+ if @api_client.config.client_side_validation && package_id.to_s.length > 25
318
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.update_package_type, the character length must be smaller than or equal to 25.'
319
+ end
320
+
321
+ if @api_client.config.client_side_validation && package_id.to_s.length < 1
322
+ fail ArgumentError, 'invalid value for "package_id" when calling PackageTypesApi.update_package_type, the character length must be great than or equal to 1.'
323
+ end
324
+
325
+ pattern = Regexp.new(/^se(-[a-z0-9]+)+$/)
326
+ if @api_client.config.client_side_validation && package_id !~ pattern
327
+ fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.update_package_type, must conform to the pattern #{pattern}."
328
+ end
329
+
330
+ # verify the required parameter 'update_package_type_request_body' is set
331
+ if @api_client.config.client_side_validation && update_package_type_request_body.nil?
332
+ fail ArgumentError, "Missing the required parameter 'update_package_type_request_body' when calling PackageTypesApi.update_package_type"
333
+ end
334
+ # resource path
335
+ local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_id.to_s))
336
+
337
+ # query parameters
338
+ query_params = opts[:query_params] || {}
339
+
340
+ # header parameters
341
+ header_params = opts[:header_params] || {}
342
+ # HTTP header 'Accept' (if needed)
343
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json'])
344
+ # HTTP header 'Content-Type'
345
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
346
+
347
+ # form parameters
348
+ form_params = opts[:form_params] || {}
349
+
350
+ # http body (model)
351
+ post_body = opts[:body] || @api_client.object_to_http_body(update_package_type_request_body)
352
+
353
+ # return_type
354
+ return_type = opts[:return_type] || 'String'
355
+
356
+ # auth_names
357
+ auth_names = opts[:auth_names] || ['api_key']
358
+
359
+ new_options = opts.merge(
360
+ :header_params => header_params,
361
+ :query_params => query_params,
362
+ :form_params => form_params,
363
+ :body => post_body,
364
+ :auth_names => auth_names,
365
+ :return_type => return_type
366
+ )
367
+
368
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
369
+ if @api_client.config.debugging
370
+ @api_client.config.logger.debug "API called: PackageTypesApi#update_package_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
371
+ end
372
+ return data, status_code, headers
373
+ end
374
+ end
375
+ end