ship_engine 1.0.0 → 1.0.1

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