ship_engine 1.0.0 → 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (734) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +70 -0
  3. data/README.md +312 -312
  4. data/docs/AddFundsToCarrierRequestBody.md +3 -3
  5. data/docs/AddFundsToCarrierResponseBody.md +3 -3
  6. data/docs/AddFundsToInsuranceRequestBody.md +3 -3
  7. data/docs/AddFundsToInsuranceResponseBody.md +3 -3
  8. data/docs/AddToBatchRequestBody.md +3 -3
  9. data/docs/Address.md +3 -3
  10. data/docs/AddressResidentialIndicator.md +3 -3
  11. data/docs/AddressToValidate.md +3 -3
  12. data/docs/AddressValidatingShipment.md +3 -3
  13. data/docs/AddressValidationCode.md +3 -3
  14. data/docs/AddressValidationDetailCode.md +3 -3
  15. data/docs/AddressValidationMessageType.md +3 -3
  16. data/docs/AddressValidationResult.md +3 -3
  17. data/docs/AddressValidationStatus.md +3 -3
  18. data/docs/AddressesApi.md +9 -9
  19. data/docs/AdvancedShipmentOptions.md +3 -3
  20. data/docs/AncillaryServiceEndorsement.md +3 -3
  21. data/docs/Batch.md +3 -3
  22. data/docs/BatchResponseError.md +3 -3
  23. data/docs/BatchStatus.md +3 -3
  24. data/docs/BatchesApi.md +57 -57
  25. data/docs/BatchesSortBy.md +3 -3
  26. data/docs/BillToParty.md +3 -3
  27. data/docs/BulkRate.md +3 -3
  28. data/docs/CalculateRatesRequestBody.md +3 -3
  29. data/docs/CalculateRatesResponseBody.md +3 -3
  30. data/docs/Carrier.md +3 -3
  31. data/docs/CarrierAccountsApi.md +29 -29
  32. data/docs/CarrierAdvancedOption.md +3 -3
  33. data/docs/CarrierName.md +3 -3
  34. data/docs/CarrierNameWithSettings.md +3 -3
  35. data/docs/CarriersApi.md +29 -29
  36. data/docs/CollectOnDelivery.md +3 -3
  37. data/docs/CollectOnDeliveryPaymentType.md +3 -3
  38. data/docs/CompareBulkRatesRequestBody.md +3 -3
  39. data/docs/ConnectAccessWorldwideRequestBody.md +3 -3
  40. data/docs/ConnectAmazonBuyShippingRequestBody.md +3 -3
  41. data/docs/ConnectApcRequestBody.md +3 -3
  42. data/docs/ConnectAsendiaRequestBody.md +3 -3
  43. data/docs/ConnectAustraliaPostRequestBody.md +3 -3
  44. data/docs/ConnectCanadaPostRequestBody.md +3 -3
  45. data/docs/ConnectCarrierRequestBody.md +3 -3
  46. data/docs/ConnectCarrierResponseBody.md +3 -3
  47. data/docs/ConnectDhlEcommerceRequestBody.md +3 -3
  48. data/docs/ConnectDhlExpressAuRequestBody.md +3 -3
  49. data/docs/ConnectDhlExpressCaRequestBody.md +3 -3
  50. data/docs/ConnectDhlExpressRequestBody.md +3 -3
  51. data/docs/ConnectDhlExpressUkRequestBody.md +3 -3
  52. data/docs/ConnectDpdRequestBody.md +3 -3
  53. data/docs/ConnectEndiciaRequestBody.md +3 -3
  54. data/docs/ConnectFedexRequestBody.md +3 -3
  55. data/docs/ConnectFedexUkRequestBody.md +3 -3
  56. data/docs/ConnectFirstmileRequestBody.md +3 -3
  57. data/docs/ConnectGlobegisticsRequestBody.md +3 -3
  58. data/docs/ConnectImexRequestBody.md +3 -3
  59. data/docs/ConnectInsurerRequestBody.md +3 -3
  60. data/docs/ConnectNewgisticsRequestBody.md +3 -3
  61. data/docs/ConnectOntracRequestBody.md +3 -3
  62. data/docs/ConnectPurolatorRequestBody.md +3 -3
  63. data/docs/ConnectRoyalMailRequestBody.md +3 -3
  64. data/docs/ConnectRrDonnelleyRequestBody.md +3 -3
  65. data/docs/ConnectSekoRequestBody.md +3 -3
  66. data/docs/ConnectSendleRequestBody.md +3 -3
  67. data/docs/ConnectStampsRequestBody.md +3 -3
  68. data/docs/ConnectUpsRequestBody.md +3 -3
  69. data/docs/CreateAndValidateShipment.md +3 -3
  70. data/docs/CreateBatchRequestBody.md +3 -3
  71. data/docs/CreateBatchResponseBody.md +3 -3
  72. data/docs/CreateLabelFromRateRequestBody.md +3 -3
  73. data/docs/CreateLabelFromRateResponseBody.md +3 -3
  74. data/docs/CreateLabelFromShipmentRequestBody.md +3 -3
  75. data/docs/CreateLabelFromShipmentResponseBody.md +3 -3
  76. data/docs/CreateLabelRequestBody.md +3 -3
  77. data/docs/CreateLabelResponseBody.md +3 -3
  78. data/docs/CreateManifestByObjectRequestBody.md +3 -3
  79. data/docs/CreateManifestLabelIdsRequestBody.md +3 -3
  80. data/docs/CreateManifestRequestBody.md +3 -3
  81. data/docs/CreateManifestResponseBody.md +3 -3
  82. data/docs/CreatePackageTypeRequestBody.md +3 -3
  83. data/docs/CreatePackageTypeResponseBody.md +3 -3
  84. data/docs/CreateReturnLabelRequestBody.md +3 -3
  85. data/docs/CreateReturnLabelResponseBody.md +3 -3
  86. data/docs/CreateShipmentResponseBodyFields.md +3 -3
  87. data/docs/CreateShipmentsRequestBody.md +3 -3
  88. data/docs/CreateShipmentsResponseBody.md +3 -3
  89. data/docs/CreateTagResponseBody.md +3 -3
  90. data/docs/CreateWarehouseRequestBody.md +3 -3
  91. data/docs/CreateWarehouseResponseBody.md +3 -3
  92. data/docs/CreateWebhookRequestBody.md +3 -3
  93. data/docs/CreateWebhookResponseBody.md +3 -3
  94. data/docs/Currency.md +3 -3
  95. data/docs/CustomsItem.md +3 -3
  96. data/docs/DeliveryConfirmation.md +3 -3
  97. data/docs/DeprecatedManifest.md +3 -3
  98. data/docs/DhlExpressAccountSettings.md +3 -3
  99. data/docs/DhlExpressSettingsResponseBody.md +3 -3
  100. data/docs/DimensionUnit.md +3 -3
  101. data/docs/Dimensions.md +3 -3
  102. data/docs/DownloadsApi.md +5 -5
  103. data/docs/Error.md +3 -3
  104. data/docs/ErrorCode.md +3 -3
  105. data/docs/ErrorResponseBody.md +3 -3
  106. data/docs/ErrorSource.md +3 -3
  107. data/docs/ErrorType.md +3 -3
  108. data/docs/EstimateRatesRequestBody.md +3 -3
  109. data/docs/FedexAccountSettings.md +3 -3
  110. data/docs/FedexAccountSettingsRequestBody.md +3 -3
  111. data/docs/FedexPickupType.md +3 -3
  112. data/docs/FedexSettingsResponseBody.md +3 -3
  113. data/docs/GetBatchByExternalIdResponseBody.md +3 -3
  114. data/docs/GetBatchByIdResponseBody.md +3 -3
  115. data/docs/GetCarrierByIdResponseBody.md +3 -3
  116. data/docs/GetCarrierOptionsResponseBody.md +3 -3
  117. data/docs/GetCarrierSettingsResponseBody.md +3 -3
  118. data/docs/GetCarriersResponseBody.md +3 -3
  119. data/docs/GetInsuranceBalanceResponseBody.md +3 -3
  120. data/docs/GetLabelByExternalShipmentIdResponseBody.md +3 -3
  121. data/docs/GetLabelByIdResponseBody.md +3 -3
  122. data/docs/GetManifestByIdResponseBody.md +3 -3
  123. data/docs/GetPackageTypeByIdResponseBody.md +3 -3
  124. data/docs/GetRateByIdResponseBody.md +3 -3
  125. data/docs/GetShipmentByExternalIdResponseBody.md +3 -3
  126. data/docs/GetShipmentByIdResponseBody.md +3 -3
  127. data/docs/GetTrackingLogFromLabelResponseBody.md +3 -3
  128. data/docs/GetTrackingLogResponseBody.md +3 -3
  129. data/docs/GetWarehouseByIdResponseBody.md +3 -3
  130. data/docs/GetWebhookByIdResponseBody.md +3 -3
  131. data/docs/InsuranceApi.md +19 -19
  132. data/docs/InsuranceProvider.md +3 -3
  133. data/docs/InternationalShipmentOptions.md +3 -3
  134. data/docs/Label.md +3 -3
  135. data/docs/LabelChargeEvent.md +3 -3
  136. data/docs/LabelDownload.md +3 -3
  137. data/docs/LabelDownloadType.md +3 -3
  138. data/docs/LabelFormat.md +3 -3
  139. data/docs/LabelLayout.md +3 -3
  140. data/docs/LabelMessages.md +3 -3
  141. data/docs/LabelStatus.md +3 -3
  142. data/docs/LabelsApi.md +54 -54
  143. data/docs/Link.md +3 -3
  144. data/docs/ListBatchErrorsResponseBody.md +3 -3
  145. data/docs/ListBatchesResponseBody.md +3 -3
  146. data/docs/ListCarrierPackageTypesResponseBody.md +3 -3
  147. data/docs/ListCarrierServicesResponseBody.md +3 -3
  148. data/docs/ListCarriersResponseBody.md +3 -3
  149. data/docs/ListLabelsResponseBody.md +3 -3
  150. data/docs/ListManifestsResponseBody.md +3 -3
  151. data/docs/ListPackageTypesResponseBody.md +3 -3
  152. data/docs/ListShipmentErrorsResponseBody.md +3 -3
  153. data/docs/ListShipmentRatesResponseBody.md +3 -3
  154. data/docs/ListShipmentsResponseBody.md +3 -3
  155. data/docs/ListTagsResponseBody.md +3 -3
  156. data/docs/ListWarehousesResponseBody.md +3 -3
  157. data/docs/Manifest.md +3 -3
  158. data/docs/ManifestDownload.md +3 -3
  159. data/docs/Manifests.md +3 -3
  160. data/docs/ManifestsApi.md +14 -14
  161. data/docs/ModifyBatch.md +3 -3
  162. data/docs/MonetaryValue.md +3 -3
  163. data/docs/NonDelivery.md +3 -3
  164. data/docs/OptionalLink.md +3 -3
  165. data/docs/OrderSourceName.md +3 -3
  166. data/docs/Package.md +3 -3
  167. data/docs/PackageContents.md +3 -3
  168. data/docs/PackageType.md +3 -3
  169. data/docs/PackageTypesApi.md +26 -26
  170. data/docs/PagedListResponseBody.md +3 -3
  171. data/docs/PaginationLink.md +3 -3
  172. data/docs/ParseAddressRequestBody.md +3 -3
  173. data/docs/ParseAddressResponseBody.md +3 -3
  174. data/docs/ParseShipmentRequestBody.md +3 -3
  175. data/docs/ParseShipmentResponseBody.md +3 -3
  176. data/docs/PartialAddress.md +3 -3
  177. data/docs/PartialShipment.md +3 -3
  178. data/docs/PaymentAmount.md +3 -3
  179. data/docs/ProcessBatchRequestBody.md +3 -3
  180. data/docs/PurchaseLabelWithoutShipment.md +3 -3
  181. data/docs/Rate.md +3 -3
  182. data/docs/RateEstimateByCarrierId.md +3 -3
  183. data/docs/RateEstimateByCarrierIds.md +3 -3
  184. data/docs/RateEstimateOptions.md +3 -3
  185. data/docs/RateRequestBody.md +3 -3
  186. data/docs/RateRequestByShipmentIds.md +3 -3
  187. data/docs/RateRequestByShipments.md +3 -3
  188. data/docs/RateRequestOptions.md +3 -3
  189. data/docs/RateRequestRateOptions.md +3 -3
  190. data/docs/RateResponse.md +3 -3
  191. data/docs/RateResponseStatus.md +3 -3
  192. data/docs/RateType.md +3 -3
  193. data/docs/RatesApi.md +20 -20
  194. data/docs/RatesInformation.md +3 -3
  195. data/docs/RecognizedEntity.md +3 -3
  196. data/docs/RemoveFromBatchRequestBody.md +3 -3
  197. data/docs/ResponseMessage.md +3 -3
  198. data/docs/Service.md +3 -3
  199. data/docs/Shipment.md +3 -3
  200. data/docs/ShipmentIdRequest.md +3 -3
  201. data/docs/ShipmentItem.md +3 -3
  202. data/docs/ShipmentRequest.md +3 -3
  203. data/docs/ShipmentResponseError.md +3 -3
  204. data/docs/ShipmentStatus.md +3 -3
  205. data/docs/ShipmentsApi.md +53 -53
  206. data/docs/ShipmentsSortBy.md +3 -3
  207. data/docs/SmartPostHub.md +3 -3
  208. data/docs/SortDir.md +3 -3
  209. data/docs/Tag.md +3 -3
  210. data/docs/TagShipmentResponseBody.md +3 -3
  211. data/docs/TagsApi.md +17 -17
  212. data/docs/TrackEvent.md +3 -3
  213. data/docs/TrackingApi.md +13 -13
  214. data/docs/TrackingInformation.md +3 -3
  215. data/docs/TrackingStatus.md +3 -3
  216. data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
  217. data/docs/UpdateCarrierSettingsRequestBody.md +3 -3
  218. data/docs/UpdateDhlExpressSettingsRequestBody.md +3 -3
  219. data/docs/UpdateFedexSettingsRequestBody.md +3 -3
  220. data/docs/UpdateNewgisticsSettingsRequestBody.md +3 -3
  221. data/docs/UpdatePackageTypeRequestBody.md +3 -3
  222. data/docs/UpdateShipmentFields.md +3 -3
  223. data/docs/UpdateShipmentRequestBody.md +3 -3
  224. data/docs/UpdateShipmentResponseBody.md +3 -3
  225. data/docs/UpdateUpsSettingsRequestBody.md +3 -3
  226. data/docs/UpdateWarehouseRequestBody.md +3 -3
  227. data/docs/UpdateWebhookRequestBody.md +3 -3
  228. data/docs/UpsAccountSettings.md +3 -3
  229. data/docs/UpsInvoice.md +3 -3
  230. data/docs/UpsPickupType.md +3 -3
  231. data/docs/UpsSettingsResponseBody.md +3 -3
  232. data/docs/ValidateAddress.md +3 -3
  233. data/docs/ValidateShipmentFields.md +3 -3
  234. data/docs/ValidationStatus.md +3 -3
  235. data/docs/VoidLabelResponseBody.md +3 -3
  236. data/docs/Warehouse.md +3 -3
  237. data/docs/WarehousesApi.md +26 -26
  238. data/docs/Webhook.md +3 -3
  239. data/docs/WebhookEvent.md +3 -3
  240. data/docs/WebhooksApi.md +26 -26
  241. data/docs/Weight.md +3 -3
  242. data/docs/WeightUnit.md +3 -3
  243. data/lib/ship_engine.rb +278 -0
  244. data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +1 -1
  245. data/lib/{openapi_client → ship_engine}/api/batches_api.rb +28 -28
  246. data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +19 -19
  247. data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +10 -10
  248. data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +1 -1
  249. data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +1 -1
  250. data/lib/{openapi_client → ship_engine}/api/labels_api.rb +28 -28
  251. data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +1 -1
  252. data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +10 -10
  253. data/lib/{openapi_client → ship_engine}/api/rates_api.rb +1 -1
  254. data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +10 -10
  255. data/lib/{openapi_client → ship_engine}/api/tags_api.rb +1 -1
  256. data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +1 -1
  257. data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +10 -10
  258. data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +10 -10
  259. data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
  260. data/lib/{openapi_client → ship_engine}/api_error.rb +1 -1
  261. data/lib/{openapi_client → ship_engine}/configuration.rb +1 -1
  262. data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_request_body.rb +6 -8
  263. data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +6 -8
  264. data/lib/{openapi_client → ship_engine}/models/add_funds_to_insurance_request_body.rb +6 -8
  265. data/lib/{openapi_client → ship_engine}/models/add_funds_to_insurance_response_body.rb +6 -8
  266. data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +6 -8
  267. data/lib/{openapi_client → ship_engine}/models/address.rb +7 -9
  268. data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +1 -1
  269. data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +7 -9
  270. data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +17 -19
  271. data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +1 -1
  272. data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +1 -1
  273. data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +1 -1
  274. data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +6 -8
  275. data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +1 -1
  276. data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +17 -19
  277. data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +1 -1
  278. data/lib/{openapi_client → ship_engine}/models/batch.rb +7 -9
  279. data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +6 -8
  280. data/lib/{openapi_client → ship_engine}/models/batch_status.rb +1 -1
  281. data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +1 -1
  282. data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +1 -1
  283. data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +6 -8
  284. data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +7 -9
  285. data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +17 -19
  286. data/lib/{openapi_client → ship_engine}/models/carrier.rb +7 -9
  287. data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +6 -8
  288. data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +1 -1
  289. data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +1 -1
  290. data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +6 -8
  291. data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +1 -1
  292. data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +7 -9
  293. data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +6 -8
  294. data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +6 -8
  295. data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +6 -8
  296. data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +6 -8
  297. data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +6 -8
  298. data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +6 -8
  299. data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +8 -10
  300. data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +6 -8
  301. data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +8 -10
  302. data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +6 -8
  303. data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +6 -8
  304. data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +6 -8
  305. data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +6 -8
  306. data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +6 -8
  307. data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +6 -8
  308. data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +6 -8
  309. data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +6 -8
  310. data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +6 -8
  311. data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +6 -8
  312. data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +6 -8
  313. data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +6 -8
  314. data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +6 -8
  315. data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +6 -8
  316. data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +6 -8
  317. data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +6 -8
  318. data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +6 -8
  319. data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +6 -8
  320. data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +6 -8
  321. data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +6 -8
  322. data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +6 -8
  323. data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +17 -19
  324. data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +6 -8
  325. data/lib/{openapi_client → ship_engine}/models/create_batch_response_body.rb +6 -8
  326. data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +6 -8
  327. data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_response_body.rb +6 -8
  328. data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +6 -8
  329. data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_response_body.rb +6 -8
  330. data/lib/{openapi_client → ship_engine}/models/create_label_request_body.rb +6 -8
  331. data/lib/{openapi_client → ship_engine}/models/create_label_response_body.rb +6 -8
  332. data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +6 -8
  333. data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +6 -8
  334. data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +7 -9
  335. data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +6 -8
  336. data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +6 -8
  337. data/lib/{openapi_client → ship_engine}/models/create_package_type_response_body.rb +6 -8
  338. data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +9 -11
  339. data/lib/{openapi_client → ship_engine}/models/create_return_label_response_body.rb +6 -8
  340. data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +6 -8
  341. data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +6 -8
  342. data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +6 -8
  343. data/lib/{openapi_client → ship_engine}/models/create_tag_response_body.rb +6 -8
  344. data/lib/{openapi_client → ship_engine}/models/create_warehouse_request_body.rb +6 -8
  345. data/lib/{openapi_client → ship_engine}/models/create_warehouse_response_body.rb +6 -8
  346. data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +6 -8
  347. data/lib/{openapi_client → ship_engine}/models/create_webhook_response_body.rb +6 -8
  348. data/lib/{openapi_client → ship_engine}/models/currency.rb +1 -1
  349. data/lib/{openapi_client → ship_engine}/models/customs_item.rb +7 -9
  350. data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +1 -1
  351. data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +6 -8
  352. data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +6 -8
  353. data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +6 -8
  354. data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +1 -1
  355. data/lib/{openapi_client → ship_engine}/models/dimensions.rb +6 -8
  356. data/lib/{openapi_client → ship_engine}/models/error.rb +7 -9
  357. data/lib/{openapi_client → ship_engine}/models/error_code.rb +1 -1
  358. data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +7 -9
  359. data/lib/{openapi_client → ship_engine}/models/error_source.rb +1 -1
  360. data/lib/{openapi_client → ship_engine}/models/error_type.rb +1 -1
  361. data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +7 -9
  362. data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +6 -8
  363. data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +6 -8
  364. data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +1 -1
  365. data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +6 -8
  366. data/lib/{openapi_client → ship_engine}/models/get_batch_by_external_id_response_body.rb +6 -8
  367. data/lib/{openapi_client → ship_engine}/models/get_batch_by_id_response_body.rb +6 -8
  368. data/lib/{openapi_client → ship_engine}/models/get_carrier_by_id_response_body.rb +6 -8
  369. data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +6 -8
  370. data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +7 -9
  371. data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +7 -9
  372. data/lib/{openapi_client → ship_engine}/models/get_insurance_balance_response_body.rb +6 -8
  373. data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +6 -8
  374. data/lib/{openapi_client → ship_engine}/models/get_label_by_id_response_body.rb +6 -8
  375. data/lib/{openapi_client → ship_engine}/models/get_manifest_by_id_response_body.rb +6 -8
  376. data/lib/{openapi_client → ship_engine}/models/get_package_type_by_id_response_body.rb +6 -8
  377. data/lib/{openapi_client → ship_engine}/models/get_rate_by_id_response_body.rb +6 -8
  378. data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +6 -8
  379. data/lib/{openapi_client → ship_engine}/models/get_shipment_by_id_response_body.rb +6 -8
  380. data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +6 -8
  381. data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +6 -8
  382. data/lib/{openapi_client → ship_engine}/models/get_warehouse_by_id_response_body.rb +6 -8
  383. data/lib/{openapi_client → ship_engine}/models/get_webhook_by_id_response_body.rb +6 -8
  384. data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +1 -1
  385. data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +6 -8
  386. data/lib/{openapi_client → ship_engine}/models/label.rb +30 -32
  387. data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +1 -1
  388. data/lib/{openapi_client → ship_engine}/models/label_download.rb +7 -9
  389. data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +1 -1
  390. data/lib/{openapi_client → ship_engine}/models/label_format.rb +1 -1
  391. data/lib/{openapi_client → ship_engine}/models/label_layout.rb +1 -1
  392. data/lib/{openapi_client → ship_engine}/models/label_messages.rb +10 -12
  393. data/lib/{openapi_client → ship_engine}/models/label_status.rb +1 -1
  394. data/lib/{openapi_client → ship_engine}/models/link.rb +6 -8
  395. data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +6 -8
  396. data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +6 -8
  397. data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +6 -8
  398. data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +6 -8
  399. data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +6 -8
  400. data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +7 -9
  401. data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +6 -8
  402. data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +6 -8
  403. data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +6 -8
  404. data/lib/{openapi_client → ship_engine}/models/list_shipment_rates_response_body.rb +6 -8
  405. data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +6 -8
  406. data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +6 -8
  407. data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +6 -8
  408. data/lib/{openapi_client → ship_engine}/models/manifest.rb +7 -9
  409. data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +6 -8
  410. data/lib/{openapi_client → ship_engine}/models/manifests.rb +6 -8
  411. data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +6 -8
  412. data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +7 -9
  413. data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +1 -1
  414. data/lib/{openapi_client → ship_engine}/models/optional_link.rb +6 -8
  415. data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +1 -1
  416. data/lib/{openapi_client → ship_engine}/models/package.rb +9 -11
  417. data/lib/{openapi_client → ship_engine}/models/package_contents.rb +1 -1
  418. data/lib/{openapi_client → ship_engine}/models/package_type.rb +6 -8
  419. data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +7 -9
  420. data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +10 -12
  421. data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +8 -10
  422. data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +10 -12
  423. data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +8 -10
  424. data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +10 -12
  425. data/lib/{openapi_client → ship_engine}/models/partial_address.rb +14 -16
  426. data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +18 -20
  427. data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +6 -8
  428. data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +6 -8
  429. data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +6 -8
  430. data/lib/{openapi_client → ship_engine}/models/rate.rb +8 -10
  431. data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +6 -8
  432. data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +6 -8
  433. data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +6 -8
  434. data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +6 -8
  435. data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +6 -8
  436. data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +6 -8
  437. data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +6 -8
  438. data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +6 -8
  439. data/lib/{openapi_client → ship_engine}/models/rate_response.rb +6 -8
  440. data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +1 -1
  441. data/lib/{openapi_client → ship_engine}/models/rate_type.rb +1 -1
  442. data/lib/{openapi_client → ship_engine}/models/rates_information.rb +6 -8
  443. data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +9 -11
  444. data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +6 -8
  445. data/lib/{openapi_client → ship_engine}/models/response_message.rb +6 -8
  446. data/lib/{openapi_client → ship_engine}/models/service.rb +6 -8
  447. data/lib/{openapi_client → ship_engine}/models/shipment.rb +7 -9
  448. data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +6 -8
  449. data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +6 -8
  450. data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +6 -8
  451. data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +6 -8
  452. data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +1 -1
  453. data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +1 -1
  454. data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +1 -1
  455. data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +1 -1
  456. data/lib/{openapi_client → ship_engine}/models/tag.rb +7 -9
  457. data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +6 -8
  458. data/lib/{openapi_client → ship_engine}/models/track_event.rb +6 -8
  459. data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +6 -8
  460. data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +1 -1
  461. data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +6 -8
  462. data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +7 -9
  463. data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +6 -8
  464. data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +6 -8
  465. data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +6 -8
  466. data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +6 -8
  467. data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +6 -8
  468. data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +17 -19
  469. data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +6 -8
  470. data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +6 -8
  471. data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +6 -8
  472. data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +6 -8
  473. data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +6 -8
  474. data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +6 -8
  475. data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +1 -1
  476. data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +6 -8
  477. data/lib/{openapi_client → ship_engine}/models/validate_address.rb +1 -1
  478. data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +6 -8
  479. data/lib/{openapi_client → ship_engine}/models/validation_status.rb +1 -1
  480. data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +6 -8
  481. data/lib/{openapi_client → ship_engine}/models/warehouse.rb +6 -8
  482. data/lib/{openapi_client → ship_engine}/models/webhook.rb +6 -8
  483. data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +1 -1
  484. data/lib/{openapi_client → ship_engine}/models/weight.rb +6 -8
  485. data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +1 -1
  486. data/lib/{openapi_client → ship_engine}/version.rb +3 -3
  487. data/ship_engine-1.0.3.gem +0 -0
  488. data/ship_engine-1.0.4.gem +0 -0
  489. data/ship_engine.gemspec +2 -2
  490. data/spec/api/addresses_api_spec.rb +3 -3
  491. data/spec/api/batches_api_spec.rb +3 -3
  492. data/spec/api/carrier_accounts_api_spec.rb +3 -3
  493. data/spec/api/carriers_api_spec.rb +3 -3
  494. data/spec/api/downloads_api_spec.rb +3 -3
  495. data/spec/api/insurance_api_spec.rb +3 -3
  496. data/spec/api/labels_api_spec.rb +3 -3
  497. data/spec/api/manifests_api_spec.rb +3 -3
  498. data/spec/api/package_types_api_spec.rb +3 -3
  499. data/spec/api/rates_api_spec.rb +3 -3
  500. data/spec/api/shipments_api_spec.rb +3 -3
  501. data/spec/api/tags_api_spec.rb +3 -3
  502. data/spec/api/tracking_api_spec.rb +3 -3
  503. data/spec/api/warehouses_api_spec.rb +3 -3
  504. data/spec/api/webhooks_api_spec.rb +3 -3
  505. data/spec/api_client_spec.rb +29 -29
  506. data/spec/configuration_spec.rb +3 -3
  507. data/spec/models/add_funds_to_carrier_request_body_spec.rb +3 -3
  508. data/spec/models/add_funds_to_carrier_response_body_spec.rb +3 -3
  509. data/spec/models/add_funds_to_insurance_request_body_spec.rb +3 -3
  510. data/spec/models/add_funds_to_insurance_response_body_spec.rb +3 -3
  511. data/spec/models/add_to_batch_request_body_spec.rb +3 -3
  512. data/spec/models/address_residential_indicator_spec.rb +3 -3
  513. data/spec/models/address_spec.rb +3 -3
  514. data/spec/models/address_to_validate_spec.rb +3 -3
  515. data/spec/models/address_validating_shipment_spec.rb +3 -3
  516. data/spec/models/address_validation_code_spec.rb +3 -3
  517. data/spec/models/address_validation_detail_code_spec.rb +3 -3
  518. data/spec/models/address_validation_message_type_spec.rb +3 -3
  519. data/spec/models/address_validation_result_spec.rb +3 -3
  520. data/spec/models/address_validation_status_spec.rb +3 -3
  521. data/spec/models/advanced_shipment_options_spec.rb +3 -3
  522. data/spec/models/ancillary_service_endorsement_spec.rb +3 -3
  523. data/spec/models/batch_response_error_spec.rb +3 -3
  524. data/spec/models/batch_spec.rb +3 -3
  525. data/spec/models/batch_status_spec.rb +3 -3
  526. data/spec/models/batches_sort_by_spec.rb +3 -3
  527. data/spec/models/bill_to_party_spec.rb +3 -3
  528. data/spec/models/bulk_rate_spec.rb +3 -3
  529. data/spec/models/calculate_rates_request_body_spec.rb +3 -3
  530. data/spec/models/calculate_rates_response_body_spec.rb +3 -3
  531. data/spec/models/carrier_advanced_option_spec.rb +3 -3
  532. data/spec/models/carrier_name_spec.rb +3 -3
  533. data/spec/models/carrier_name_with_settings_spec.rb +3 -3
  534. data/spec/models/carrier_spec.rb +3 -3
  535. data/spec/models/collect_on_delivery_payment_type_spec.rb +3 -3
  536. data/spec/models/collect_on_delivery_spec.rb +3 -3
  537. data/spec/models/compare_bulk_rates_request_body_spec.rb +3 -3
  538. data/spec/models/connect_access_worldwide_request_body_spec.rb +3 -3
  539. data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +3 -3
  540. data/spec/models/connect_apc_request_body_spec.rb +3 -3
  541. data/spec/models/connect_asendia_request_body_spec.rb +3 -3
  542. data/spec/models/connect_australia_post_request_body_spec.rb +3 -3
  543. data/spec/models/connect_canada_post_request_body_spec.rb +3 -3
  544. data/spec/models/connect_carrier_request_body_spec.rb +3 -3
  545. data/spec/models/connect_carrier_response_body_spec.rb +3 -3
  546. data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +3 -3
  547. data/spec/models/connect_dhl_express_au_request_body_spec.rb +3 -3
  548. data/spec/models/connect_dhl_express_ca_request_body_spec.rb +3 -3
  549. data/spec/models/connect_dhl_express_request_body_spec.rb +3 -3
  550. data/spec/models/connect_dhl_express_uk_request_body_spec.rb +3 -3
  551. data/spec/models/connect_dpd_request_body_spec.rb +3 -3
  552. data/spec/models/connect_endicia_request_body_spec.rb +3 -3
  553. data/spec/models/connect_fedex_request_body_spec.rb +3 -3
  554. data/spec/models/connect_fedex_uk_request_body_spec.rb +3 -3
  555. data/spec/models/connect_firstmile_request_body_spec.rb +3 -3
  556. data/spec/models/connect_globegistics_request_body_spec.rb +3 -3
  557. data/spec/models/connect_imex_request_body_spec.rb +3 -3
  558. data/spec/models/connect_insurer_request_body_spec.rb +3 -3
  559. data/spec/models/connect_newgistics_request_body_spec.rb +3 -3
  560. data/spec/models/connect_ontrac_request_body_spec.rb +3 -3
  561. data/spec/models/connect_purolator_request_body_spec.rb +3 -3
  562. data/spec/models/connect_royal_mail_request_body_spec.rb +3 -3
  563. data/spec/models/connect_rr_donnelley_request_body_spec.rb +3 -3
  564. data/spec/models/connect_seko_request_body_spec.rb +3 -3
  565. data/spec/models/connect_sendle_request_body_spec.rb +3 -3
  566. data/spec/models/connect_stamps_request_body_spec.rb +3 -3
  567. data/spec/models/connect_ups_request_body_spec.rb +3 -3
  568. data/spec/models/create_and_validate_shipment_spec.rb +3 -3
  569. data/spec/models/create_batch_request_body_spec.rb +3 -3
  570. data/spec/models/create_batch_response_body_spec.rb +3 -3
  571. data/spec/models/create_label_from_rate_request_body_spec.rb +3 -3
  572. data/spec/models/create_label_from_rate_response_body_spec.rb +3 -3
  573. data/spec/models/create_label_from_shipment_request_body_spec.rb +3 -3
  574. data/spec/models/create_label_from_shipment_response_body_spec.rb +3 -3
  575. data/spec/models/create_label_request_body_spec.rb +3 -3
  576. data/spec/models/create_label_response_body_spec.rb +3 -3
  577. data/spec/models/create_manifest_by_object_request_body_spec.rb +3 -3
  578. data/spec/models/create_manifest_label_ids_request_body_spec.rb +3 -3
  579. data/spec/models/create_manifest_request_body_spec.rb +3 -3
  580. data/spec/models/create_manifest_response_body_spec.rb +3 -3
  581. data/spec/models/create_package_type_request_body_spec.rb +3 -3
  582. data/spec/models/create_package_type_response_body_spec.rb +3 -3
  583. data/spec/models/create_return_label_request_body_spec.rb +3 -3
  584. data/spec/models/create_return_label_response_body_spec.rb +3 -3
  585. data/spec/models/create_shipment_response_body_fields_spec.rb +3 -3
  586. data/spec/models/create_shipments_request_body_spec.rb +3 -3
  587. data/spec/models/create_shipments_response_body_spec.rb +3 -3
  588. data/spec/models/create_tag_response_body_spec.rb +3 -3
  589. data/spec/models/create_warehouse_request_body_spec.rb +3 -3
  590. data/spec/models/create_warehouse_response_body_spec.rb +3 -3
  591. data/spec/models/create_webhook_request_body_spec.rb +3 -3
  592. data/spec/models/create_webhook_response_body_spec.rb +3 -3
  593. data/spec/models/currency_spec.rb +3 -3
  594. data/spec/models/customs_item_spec.rb +3 -3
  595. data/spec/models/delivery_confirmation_spec.rb +3 -3
  596. data/spec/models/deprecated_manifest_spec.rb +3 -3
  597. data/spec/models/dhl_express_account_settings_spec.rb +3 -3
  598. data/spec/models/dhl_express_settings_response_body_spec.rb +3 -3
  599. data/spec/models/dimension_unit_spec.rb +3 -3
  600. data/spec/models/dimensions_spec.rb +3 -3
  601. data/spec/models/error_code_spec.rb +3 -3
  602. data/spec/models/error_response_body_spec.rb +3 -3
  603. data/spec/models/error_source_spec.rb +3 -3
  604. data/spec/models/error_spec.rb +3 -3
  605. data/spec/models/error_type_spec.rb +3 -3
  606. data/spec/models/estimate_rates_request_body_spec.rb +3 -3
  607. data/spec/models/fedex_account_settings_request_body_spec.rb +3 -3
  608. data/spec/models/fedex_account_settings_spec.rb +3 -3
  609. data/spec/models/fedex_pickup_type_spec.rb +3 -3
  610. data/spec/models/fedex_settings_response_body_spec.rb +3 -3
  611. data/spec/models/get_batch_by_external_id_response_body_spec.rb +3 -3
  612. data/spec/models/get_batch_by_id_response_body_spec.rb +3 -3
  613. data/spec/models/get_carrier_by_id_response_body_spec.rb +3 -3
  614. data/spec/models/get_carrier_options_response_body_spec.rb +3 -3
  615. data/spec/models/get_carrier_settings_response_body_spec.rb +3 -3
  616. data/spec/models/get_carriers_response_body_spec.rb +3 -3
  617. data/spec/models/get_insurance_balance_response_body_spec.rb +3 -3
  618. data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +3 -3
  619. data/spec/models/get_label_by_id_response_body_spec.rb +3 -3
  620. data/spec/models/get_manifest_by_id_response_body_spec.rb +3 -3
  621. data/spec/models/get_package_type_by_id_response_body_spec.rb +3 -3
  622. data/spec/models/get_rate_by_id_response_body_spec.rb +3 -3
  623. data/spec/models/get_shipment_by_external_id_response_body_spec.rb +3 -3
  624. data/spec/models/get_shipment_by_id_response_body_spec.rb +3 -3
  625. data/spec/models/get_tracking_log_from_label_response_body_spec.rb +3 -3
  626. data/spec/models/get_tracking_log_response_body_spec.rb +3 -3
  627. data/spec/models/get_warehouse_by_id_response_body_spec.rb +3 -3
  628. data/spec/models/get_webhook_by_id_response_body_spec.rb +3 -3
  629. data/spec/models/insurance_provider_spec.rb +3 -3
  630. data/spec/models/international_shipment_options_spec.rb +3 -3
  631. data/spec/models/label_charge_event_spec.rb +3 -3
  632. data/spec/models/label_download_spec.rb +3 -3
  633. data/spec/models/label_download_type_spec.rb +3 -3
  634. data/spec/models/label_format_spec.rb +3 -3
  635. data/spec/models/label_layout_spec.rb +3 -3
  636. data/spec/models/label_messages_spec.rb +3 -3
  637. data/spec/models/label_spec.rb +3 -3
  638. data/spec/models/label_status_spec.rb +3 -3
  639. data/spec/models/link_spec.rb +3 -3
  640. data/spec/models/list_batch_errors_response_body_spec.rb +3 -3
  641. data/spec/models/list_batches_response_body_spec.rb +3 -3
  642. data/spec/models/list_carrier_package_types_response_body_spec.rb +3 -3
  643. data/spec/models/list_carrier_services_response_body_spec.rb +3 -3
  644. data/spec/models/list_carriers_response_body_spec.rb +3 -3
  645. data/spec/models/list_labels_response_body_spec.rb +3 -3
  646. data/spec/models/list_manifests_response_body_spec.rb +3 -3
  647. data/spec/models/list_package_types_response_body_spec.rb +3 -3
  648. data/spec/models/list_shipment_errors_response_body_spec.rb +3 -3
  649. data/spec/models/list_shipment_rates_response_body_spec.rb +3 -3
  650. data/spec/models/list_shipments_response_body_spec.rb +3 -3
  651. data/spec/models/list_tags_response_body_spec.rb +3 -3
  652. data/spec/models/list_warehouses_response_body_spec.rb +3 -3
  653. data/spec/models/manifest_download_spec.rb +3 -3
  654. data/spec/models/manifest_spec.rb +3 -3
  655. data/spec/models/manifests_spec.rb +3 -3
  656. data/spec/models/modify_batch_spec.rb +3 -3
  657. data/spec/models/monetary_value_spec.rb +3 -3
  658. data/spec/models/non_delivery_spec.rb +3 -3
  659. data/spec/models/optional_link_spec.rb +3 -3
  660. data/spec/models/order_source_name_spec.rb +3 -3
  661. data/spec/models/package_contents_spec.rb +3 -3
  662. data/spec/models/package_spec.rb +3 -3
  663. data/spec/models/package_type_spec.rb +3 -3
  664. data/spec/models/paged_list_response_body_spec.rb +3 -3
  665. data/spec/models/pagination_link_spec.rb +3 -3
  666. data/spec/models/parse_address_request_body_spec.rb +3 -3
  667. data/spec/models/parse_address_response_body_spec.rb +3 -3
  668. data/spec/models/parse_shipment_request_body_spec.rb +3 -3
  669. data/spec/models/parse_shipment_response_body_spec.rb +3 -3
  670. data/spec/models/partial_address_spec.rb +3 -3
  671. data/spec/models/partial_shipment_spec.rb +3 -3
  672. data/spec/models/payment_amount_spec.rb +3 -3
  673. data/spec/models/process_batch_request_body_spec.rb +3 -3
  674. data/spec/models/purchase_label_without_shipment_spec.rb +3 -3
  675. data/spec/models/rate_estimate_by_carrier_id_spec.rb +3 -3
  676. data/spec/models/rate_estimate_by_carrier_ids_spec.rb +3 -3
  677. data/spec/models/rate_estimate_options_spec.rb +3 -3
  678. data/spec/models/rate_request_body_spec.rb +3 -3
  679. data/spec/models/rate_request_by_shipment_ids_spec.rb +3 -3
  680. data/spec/models/rate_request_by_shipments_spec.rb +3 -3
  681. data/spec/models/rate_request_options_spec.rb +3 -3
  682. data/spec/models/rate_request_rate_options_spec.rb +3 -3
  683. data/spec/models/rate_response_spec.rb +3 -3
  684. data/spec/models/rate_response_status_spec.rb +3 -3
  685. data/spec/models/rate_spec.rb +3 -3
  686. data/spec/models/rate_type_spec.rb +3 -3
  687. data/spec/models/rates_information_spec.rb +3 -3
  688. data/spec/models/recognized_entity_spec.rb +3 -3
  689. data/spec/models/remove_from_batch_request_body_spec.rb +3 -3
  690. data/spec/models/response_message_spec.rb +3 -3
  691. data/spec/models/service_spec.rb +3 -3
  692. data/spec/models/shipment_id_request_spec.rb +3 -3
  693. data/spec/models/shipment_item_spec.rb +3 -3
  694. data/spec/models/shipment_request_spec.rb +3 -3
  695. data/spec/models/shipment_response_error_spec.rb +3 -3
  696. data/spec/models/shipment_spec.rb +3 -3
  697. data/spec/models/shipment_status_spec.rb +3 -3
  698. data/spec/models/shipments_sort_by_spec.rb +3 -3
  699. data/spec/models/smart_post_hub_spec.rb +3 -3
  700. data/spec/models/sort_dir_spec.rb +3 -3
  701. data/spec/models/tag_shipment_response_body_spec.rb +3 -3
  702. data/spec/models/tag_spec.rb +3 -3
  703. data/spec/models/track_event_spec.rb +3 -3
  704. data/spec/models/tracking_information_spec.rb +3 -3
  705. data/spec/models/tracking_status_spec.rb +3 -3
  706. data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +3 -3
  707. data/spec/models/update_carrier_settings_request_body_spec.rb +3 -3
  708. data/spec/models/update_dhl_express_settings_request_body_spec.rb +3 -3
  709. data/spec/models/update_fedex_settings_request_body_spec.rb +3 -3
  710. data/spec/models/update_newgistics_settings_request_body_spec.rb +3 -3
  711. data/spec/models/update_package_type_request_body_spec.rb +3 -3
  712. data/spec/models/update_shipment_fields_spec.rb +3 -3
  713. data/spec/models/update_shipment_request_body_spec.rb +3 -3
  714. data/spec/models/update_shipment_response_body_spec.rb +3 -3
  715. data/spec/models/update_ups_settings_request_body_spec.rb +3 -3
  716. data/spec/models/update_warehouse_request_body_spec.rb +3 -3
  717. data/spec/models/update_webhook_request_body_spec.rb +3 -3
  718. data/spec/models/ups_account_settings_spec.rb +3 -3
  719. data/spec/models/ups_invoice_spec.rb +3 -3
  720. data/spec/models/ups_pickup_type_spec.rb +3 -3
  721. data/spec/models/ups_settings_response_body_spec.rb +3 -3
  722. data/spec/models/validate_address_spec.rb +3 -3
  723. data/spec/models/validate_shipment_fields_spec.rb +3 -3
  724. data/spec/models/validation_status_spec.rb +3 -3
  725. data/spec/models/void_label_response_body_spec.rb +3 -3
  726. data/spec/models/warehouse_spec.rb +3 -3
  727. data/spec/models/webhook_event_spec.rb +3 -3
  728. data/spec/models/webhook_spec.rb +3 -3
  729. data/spec/models/weight_spec.rb +3 -3
  730. data/spec/models/weight_unit_spec.rb +3 -3
  731. data/spec/spec_helper.rb +1 -1
  732. metadata +248 -246
  733. data/lib/openapi_client.rb +0 -278
  734. data/openapi_client-1.0.0.gem +0 -0
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  class AncillaryServiceEndorsement
17
17
  NONE = "none".freeze
18
18
  RETURN_SERVICE_REQUESTED = "return_service_requested".freeze
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,8 +12,8 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
16
- # Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.
15
+ module ShipEngine
16
+ # Batches are an advanced feature of ShipEngine designed for users who need to generate hundreds or thousands of labels at a time.
17
17
  class Batch
18
18
  # label layout
19
19
  attr_accessor :label_layout
@@ -128,14 +128,12 @@ module OpenapiClient
128
128
  # @param [Hash] attributes Model attributes in the form of hash
129
129
  def initialize(attributes = {})
130
130
  if (!attributes.is_a?(Hash))
131
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Batch` initialize method"
131
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::Batch` initialize method"
132
132
  end
133
133
 
134
134
  # check to see if the attribute exists and convert string to symbol for hash key
135
135
  attributes = attributes.each_with_object({}) { |(k, v), h|
136
- if (!self.class.attribute_map.key?(k.to_sym))
137
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Batch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
138
- end
136
+
139
137
  h[k.to_sym] = v
140
138
  }
141
139
 
@@ -513,7 +511,7 @@ module OpenapiClient
513
511
  end
514
512
  end
515
513
  else # model
516
- OpenapiClient.const_get(type).build_from_hash(value)
514
+ ShipEngine.const_get(type).build_from_hash(value)
517
515
  end
518
516
  end
519
517
 
@@ -539,7 +537,7 @@ module OpenapiClient
539
537
  is_nullable = self.class.openapi_nullable.include?(attr)
540
538
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
541
539
  end
542
-
540
+
543
541
  hash[param] = _to_hash(value)
544
542
  end
545
543
  hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  # A batch response error
17
17
  class BatchResponseError
18
18
  # Error message associated with the shipment.
@@ -47,14 +47,12 @@ module OpenapiClient
47
47
  # @param [Hash] attributes Model attributes in the form of hash
48
48
  def initialize(attributes = {})
49
49
  if (!attributes.is_a?(Hash))
50
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::BatchResponseError` initialize method"
50
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::BatchResponseError` initialize method"
51
51
  end
52
52
 
53
53
  # check to see if the attribute exists and convert string to symbol for hash key
54
54
  attributes = attributes.each_with_object({}) { |(k, v), h|
55
- if (!self.class.attribute_map.key?(k.to_sym))
56
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::BatchResponseError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
57
- end
55
+
58
56
  h[k.to_sym] = v
59
57
  }
60
58
 
@@ -180,7 +178,7 @@ module OpenapiClient
180
178
  end
181
179
  end
182
180
  else # model
183
- OpenapiClient.const_get(type).build_from_hash(value)
181
+ ShipEngine.const_get(type).build_from_hash(value)
184
182
  end
185
183
  end
186
184
 
@@ -206,7 +204,7 @@ module OpenapiClient
206
204
  is_nullable = self.class.openapi_nullable.include?(attr)
207
205
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
208
206
  end
209
-
207
+
210
208
  hash[param] = _to_hash(value)
211
209
  end
212
210
  hash
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  class BatchStatus
17
17
  OPEN = "open".freeze
18
18
  QUEUED = "queued".freeze
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  class BatchesSortBy
17
17
  SHIP_DATE = "ship_date".freeze
18
18
  PROCESSED_AT = "processed_at".freeze
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  class BillToParty
17
17
  RECIPIENT = "recipient".freeze
18
18
  THIRD_PARTY = "third_party".freeze
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  # A bulk rate
17
17
  class BulkRate
18
18
  # A string that uniquely identifies the rate request
@@ -60,14 +60,12 @@ module OpenapiClient
60
60
  # @param [Hash] attributes Model attributes in the form of hash
61
61
  def initialize(attributes = {})
62
62
  if (!attributes.is_a?(Hash))
63
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::BulkRate` initialize method"
63
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::BulkRate` initialize method"
64
64
  end
65
65
 
66
66
  # check to see if the attribute exists and convert string to symbol for hash key
67
67
  attributes = attributes.each_with_object({}) { |(k, v), h|
68
- if (!self.class.attribute_map.key?(k.to_sym))
69
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::BulkRate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
70
- end
68
+
71
69
  h[k.to_sym] = v
72
70
  }
73
71
 
@@ -220,7 +218,7 @@ module OpenapiClient
220
218
  end
221
219
  end
222
220
  else # model
223
- OpenapiClient.const_get(type).build_from_hash(value)
221
+ ShipEngine.const_get(type).build_from_hash(value)
224
222
  end
225
223
  end
226
224
 
@@ -246,7 +244,7 @@ module OpenapiClient
246
244
  is_nullable = self.class.openapi_nullable.include?(attr)
247
245
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
248
246
  end
249
-
247
+
250
248
  hash[param] = _to_hash(value)
251
249
  end
252
250
  hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  # A rate shipment request body
17
17
  class CalculateRatesRequestBody < RateRequestOptions
18
18
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -44,14 +44,12 @@ module OpenapiClient
44
44
  # @param [Hash] attributes Model attributes in the form of hash
45
45
  def initialize(attributes = {})
46
46
  if (!attributes.is_a?(Hash))
47
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CalculateRatesRequestBody` initialize method"
47
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::CalculateRatesRequestBody` initialize method"
48
48
  end
49
49
 
50
50
  # check to see if the attribute exists and convert string to symbol for hash key
51
51
  attributes = attributes.each_with_object({}) { |(k, v), h|
52
- if (!self.class.attribute_map.key?(k.to_sym))
53
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::CalculateRatesRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
54
- end
52
+
55
53
  h[k.to_sym] = v
56
54
  }
57
55
 
@@ -71,7 +69,7 @@ module OpenapiClient
71
69
  def valid?
72
70
  _one_of_found = false
73
71
  self.class.openapi_one_of.each do |_class|
74
- _one_of = OpenapiClient.const_get(_class).build_from_hash(self.to_hash)
72
+ _one_of = ShipEngine.const_get(_class).build_from_hash(self.to_hash)
75
73
  if _one_of.valid?
76
74
  if _one_of_found
77
75
  return false
@@ -172,7 +170,7 @@ module OpenapiClient
172
170
  end
173
171
  end
174
172
  else # model
175
- OpenapiClient.const_get(type).build_from_hash(value)
173
+ ShipEngine.const_get(type).build_from_hash(value)
176
174
  end
177
175
  end
178
176
 
@@ -198,7 +196,7 @@ module OpenapiClient
198
196
  is_nullable = self.class.openapi_nullable.include?(attr)
199
197
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
200
198
  end
201
-
199
+
202
200
  hash[param] = _to_hash(value)
203
201
  end
204
202
  hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  # A rate shipment response body
17
17
  class CalculateRatesResponseBody
18
18
  # A string that uniquely identifies the shipment
@@ -21,19 +21,19 @@ module OpenapiClient
21
21
  # The carrier account that is billed for the shipping charges
22
22
  attr_accessor :carrier_id
23
23
 
24
- # The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.
24
+ # The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.
25
25
  attr_accessor :service_code
26
26
 
27
27
  # ID that the Order Source assigned
28
28
  attr_accessor :external_order_id
29
29
 
30
- # Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
30
+ # Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
31
31
  attr_accessor :items
32
32
 
33
- # You can optionally use this field to store your own identifier for this shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.
33
+ # You can optionally use this field to store your own identifier for this shipment. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.
34
34
  attr_accessor :external_shipment_id
35
35
 
36
- # The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.
36
+ # The date that the shipment was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.
37
37
  attr_accessor :ship_date
38
38
 
39
39
  # The date and time that the shipment was created in ShipEngine.
@@ -48,33 +48,33 @@ module OpenapiClient
48
48
  # The recipient's mailing address
49
49
  attr_accessor :ship_to
50
50
 
51
- # The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.
51
+ # The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.
52
52
  attr_accessor :ship_from
53
53
 
54
- # The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.
54
+ # The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from. Either `warehouse_id` or `ship_from` must be specified.
55
55
  attr_accessor :warehouse_id
56
56
 
57
- # The return address for this shipment. Defaults to the `ship_from` address.
57
+ # The return address for this shipment. Defaults to the `ship_from` address.
58
58
  attr_accessor :return_to
59
59
 
60
60
  # The type of delivery confirmation that is required for this shipment.
61
61
  attr_accessor :confirmation
62
62
 
63
- # Customs information. This is usually only needed for international shipments.
63
+ # Customs information. This is usually only needed for international shipments.
64
64
  attr_accessor :customs
65
65
 
66
66
  # Advanced shipment options. These are entirely optional.
67
67
  attr_accessor :advanced_options
68
68
 
69
- # The insurance provider to use for any insured packages in the shipment.
69
+ # The insurance provider to use for any insured packages in the shipment.
70
70
  attr_accessor :insurance_provider
71
71
 
72
- # Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
72
+ # Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
73
73
  attr_accessor :tags
74
74
 
75
75
  attr_accessor :order_source_code
76
76
 
77
- # The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
77
+ # The packages in the shipment. > **Note:** Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
78
78
  attr_accessor :packages
79
79
 
80
80
  # The combined weight of all packages in the shipment
@@ -163,14 +163,12 @@ module OpenapiClient
163
163
  # @param [Hash] attributes Model attributes in the form of hash
164
164
  def initialize(attributes = {})
165
165
  if (!attributes.is_a?(Hash))
166
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CalculateRatesResponseBody` initialize method"
166
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::CalculateRatesResponseBody` initialize method"
167
167
  end
168
168
 
169
169
  # check to see if the attribute exists and convert string to symbol for hash key
170
170
  attributes = attributes.each_with_object({}) { |(k, v), h|
171
- if (!self.class.attribute_map.key?(k.to_sym))
172
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::CalculateRatesResponseBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
173
- end
171
+
174
172
  h[k.to_sym] = v
175
173
  }
176
174
 
@@ -472,7 +470,7 @@ module OpenapiClient
472
470
  end
473
471
  end
474
472
  else # model
475
- OpenapiClient.const_get(type).build_from_hash(value)
473
+ ShipEngine.const_get(type).build_from_hash(value)
476
474
  end
477
475
  end
478
476
 
@@ -498,7 +496,7 @@ module OpenapiClient
498
496
  is_nullable = self.class.openapi_nullable.include?(attr)
499
497
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
500
498
  end
501
-
499
+
502
500
  hash[param] = _to_hash(value)
503
501
  end
504
502
  hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,8 +12,8 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
16
- # A carrier object that represents a provider such as UPS, USPS, DHL, etc that has been tied to the current account.
15
+ module ShipEngine
16
+ # A carrier object that represents a provider such as UPS, USPS, DHL, etc that has been tied to the current account.
17
17
  class Carrier
18
18
  # A string that uniquely identifies the carrier.
19
19
  attr_accessor :carrier_id
@@ -102,14 +102,12 @@ module OpenapiClient
102
102
  # @param [Hash] attributes Model attributes in the form of hash
103
103
  def initialize(attributes = {})
104
104
  if (!attributes.is_a?(Hash))
105
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Carrier` initialize method"
105
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::Carrier` initialize method"
106
106
  end
107
107
 
108
108
  # check to see if the attribute exists and convert string to symbol for hash key
109
109
  attributes = attributes.each_with_object({}) { |(k, v), h|
110
- if (!self.class.attribute_map.key?(k.to_sym))
111
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Carrier`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
112
- end
110
+
113
111
  h[k.to_sym] = v
114
112
  }
115
113
 
@@ -341,7 +339,7 @@ module OpenapiClient
341
339
  end
342
340
  end
343
341
  else # model
344
- OpenapiClient.const_get(type).build_from_hash(value)
342
+ ShipEngine.const_get(type).build_from_hash(value)
345
343
  end
346
344
  end
347
345
 
@@ -367,7 +365,7 @@ module OpenapiClient
367
365
  is_nullable = self.class.openapi_nullable.include?(attr)
368
366
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
369
367
  end
370
-
368
+
371
369
  hash[param] = _to_hash(value)
372
370
  end
373
371
  hash
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #ShipEngine API
3
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.
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
5
 
6
6
  The version of the OpenAPI document: 1.1.202006302006
7
7
  Contact: sales@shipengine.com
@@ -12,7 +12,7 @@ OpenAPI Generator version: 4.3.1
12
12
 
13
13
  require 'date'
14
14
 
15
- module OpenapiClient
15
+ module ShipEngine
16
16
  # Advanced options that are specific to the carrier
17
17
  class CarrierAdvancedOption
18
18
  # Name of advanced option
@@ -52,14 +52,12 @@ module OpenapiClient
52
52
  # @param [Hash] attributes Model attributes in the form of hash
53
53
  def initialize(attributes = {})
54
54
  if (!attributes.is_a?(Hash))
55
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CarrierAdvancedOption` initialize method"
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::CarrierAdvancedOption` initialize method"
56
56
  end
57
57
 
58
58
  # check to see if the attribute exists and convert string to symbol for hash key
59
59
  attributes = attributes.each_with_object({}) { |(k, v), h|
60
- if (!self.class.attribute_map.key?(k.to_sym))
61
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::CarrierAdvancedOption`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
62
- end
60
+
63
61
  h[k.to_sym] = v
64
62
  }
65
63
 
@@ -220,7 +218,7 @@ module OpenapiClient
220
218
  end
221
219
  end
222
220
  else # model
223
- OpenapiClient.const_get(type).build_from_hash(value)
221
+ ShipEngine.const_get(type).build_from_hash(value)
224
222
  end
225
223
  end
226
224
 
@@ -246,7 +244,7 @@ module OpenapiClient
246
244
  is_nullable = self.class.openapi_nullable.include?(attr)
247
245
  next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
248
246
  end
249
-
247
+
250
248
  hash[param] = _to_hash(value)
251
249
  end
252
250
  hash