ship_engine 1.0.2 → 1.0.3

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