ship_engine 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/README.md +326 -321
- data/docs/AddFundsToCarrierRequestBody.md +4 -3
- data/docs/AddFundsToCarrierResponseBody.md +5 -3
- data/docs/AddFundsToInsuranceRequestBody.md +4 -3
- data/docs/AddFundsToInsuranceResponseBody.md +4 -3
- data/docs/AddToBatchRequestBody.md +4 -3
- data/docs/Address.md +4 -3
- data/docs/AddressResidentialIndicator.md +4 -3
- data/docs/AddressToValidate.md +4 -3
- data/docs/AddressValidatingShipment.md +27 -25
- data/docs/AddressValidationCode.md +4 -3
- data/docs/AddressValidationDetailCode.md +4 -3
- data/docs/AddressValidationMessageType.md +4 -3
- data/docs/AddressValidationResult.md +8 -6
- data/docs/AddressValidationStatus.md +4 -3
- data/docs/AddressesApi.md +22 -16
- data/docs/AdvancedShipmentOptions.md +20 -18
- data/docs/AncillaryServiceEndorsement.md +4 -3
- data/docs/Batch.md +22 -20
- data/docs/BatchResponseError.md +6 -4
- data/docs/BatchStatus.md +4 -3
- data/docs/BatchesApi.md +94 -72
- data/docs/BatchesSortBy.md +4 -3
- data/docs/BillToParty.md +4 -3
- data/docs/BulkRate.md +9 -7
- data/docs/CalculateRatesRequestBody.md +4 -3
- data/docs/CalculateRatesResponseBody.md +27 -25
- data/docs/Carrier.md +17 -15
- data/docs/CarrierAccountsApi.md +39 -29
- data/docs/CarrierAdvancedOption.md +7 -5
- data/docs/CarrierName.md +4 -3
- data/docs/CarrierNameWithSettings.md +4 -3
- data/docs/CarriersApi.md +44 -31
- data/docs/CollectOnDelivery.md +6 -4
- data/docs/CollectOnDeliveryPaymentType.md +4 -3
- data/docs/CompareBulkRatesRequestBody.md +4 -3
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -5
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -6
- data/docs/ConnectApcRequestBody.md +7 -5
- data/docs/ConnectAsendiaRequestBody.md +8 -6
- data/docs/ConnectAustraliaPostRequestBody.md +8 -6
- data/docs/ConnectCanadaPostRequestBody.md +9 -7
- data/docs/ConnectCarrierRequestBody.md +53 -51
- data/docs/ConnectCarrierResponseBody.md +5 -3
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -14
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -4
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -4
- data/docs/ConnectDhlExpressRequestBody.md +6 -4
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -6
- data/docs/ConnectDpdRequestBody.md +7 -5
- data/docs/ConnectEndiciaRequestBody.md +7 -5
- data/docs/ConnectFedexRequestBody.md +19 -17
- data/docs/ConnectFedexUkRequestBody.md +19 -17
- data/docs/ConnectFirstmileRequestBody.md +8 -6
- data/docs/ConnectGlobegisticsRequestBody.md +7 -5
- data/docs/ConnectImexRequestBody.md +7 -5
- data/docs/ConnectInsurerRequestBody.md +6 -4
- data/docs/ConnectNewgisticsRequestBody.md +8 -6
- data/docs/ConnectOntracRequestBody.md +7 -5
- data/docs/ConnectPurolatorRequestBody.md +7 -5
- data/docs/ConnectRoyalMailRequestBody.md +16 -14
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -5
- data/docs/ConnectSekoRequestBody.md +6 -4
- data/docs/ConnectSendleRequestBody.md +7 -5
- data/docs/ConnectStampsRequestBody.md +7 -5
- data/docs/ConnectUpsRequestBody.md +22 -20
- data/docs/CreateAndValidateShipment.md +28 -26
- data/docs/CreateBatchRequestBody.md +8 -6
- data/docs/CreateBatchResponseBody.md +4 -3
- data/docs/CreateLabelFromRateRequestBody.md +4 -3
- data/docs/CreateLabelFromRateResponseBody.md +4 -3
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -6
- data/docs/CreateLabelFromShipmentResponseBody.md +4 -3
- data/docs/CreateLabelRequestBody.md +4 -3
- data/docs/CreateLabelResponseBody.md +4 -3
- data/docs/CreateManifestByObjectRequestBody.md +9 -7
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -3
- data/docs/CreateManifestRequestBody.md +9 -7
- data/docs/CreateManifestResponseBody.md +14 -12
- data/docs/CreatePackageTypeRequestBody.md +4 -3
- data/docs/CreatePackageTypeResponseBody.md +4 -3
- data/docs/CreateReturnLabelRequestBody.md +9 -7
- data/docs/CreateReturnLabelResponseBody.md +4 -3
- data/docs/CreateShipmentResponseBodyFields.md +6 -4
- data/docs/CreateShipmentsRequestBody.md +5 -3
- data/docs/CreateShipmentsResponseBody.md +6 -4
- data/docs/CreateTagResponseBody.md +4 -3
- data/docs/CreateWarehouseRequestBody.md +4 -3
- data/docs/CreateWarehouseResponseBody.md +4 -3
- data/docs/CreateWebhookRequestBody.md +6 -4
- data/docs/CreateWebhookResponseBody.md +4 -3
- data/docs/Currency.md +4 -3
- data/docs/CustomsItem.md +13 -11
- data/docs/DeliveryConfirmation.md +4 -3
- data/docs/DeprecatedManifest.md +13 -11
- data/docs/DhlExpressAccountSettings.md +7 -5
- data/docs/DhlExpressSettingsResponseBody.md +4 -3
- data/docs/DimensionUnit.md +4 -3
- data/docs/Dimensions.md +8 -6
- data/docs/DownloadsApi.md +18 -14
- data/docs/Error.md +8 -6
- data/docs/ErrorCode.md +4 -3
- data/docs/ErrorResponseBody.md +6 -4
- data/docs/ErrorSource.md +4 -3
- data/docs/ErrorType.md +4 -3
- data/docs/EstimateRatesRequestBody.md +4 -3
- data/docs/FedexAccountSettings.md +9 -7
- data/docs/FedexAccountSettingsRequestBody.md +4 -3
- data/docs/FedexPickupType.md +4 -3
- data/docs/FedexSettingsResponseBody.md +4 -3
- data/docs/GetBatchByExternalIdResponseBody.md +4 -3
- data/docs/GetBatchByIdResponseBody.md +4 -3
- data/docs/GetCarrierByIdResponseBody.md +4 -3
- data/docs/GetCarrierOptionsResponseBody.md +5 -3
- data/docs/GetCarrierSettingsResponseBody.md +19 -17
- data/docs/GetCarriersResponseBody.md +7 -5
- data/docs/GetInsuranceBalanceResponseBody.md +4 -3
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +4 -3
- data/docs/GetLabelByIdResponseBody.md +4 -3
- data/docs/GetManifestByIdResponseBody.md +4 -3
- data/docs/GetPackageTypeByIdResponseBody.md +4 -3
- data/docs/GetRateByIdResponseBody.md +4 -3
- data/docs/GetShipmentByExternalIdResponseBody.md +4 -3
- data/docs/GetShipmentByIdResponseBody.md +4 -3
- data/docs/GetTrackingLogFromLabelResponseBody.md +4 -3
- data/docs/GetTrackingLogResponseBody.md +4 -3
- data/docs/GetWarehouseByIdResponseBody.md +4 -3
- data/docs/GetWebhookByIdResponseBody.md +4 -3
- data/docs/InsuranceApi.md +27 -19
- data/docs/InsuranceProvider.md +4 -3
- data/docs/InternationalShipmentOptions.md +7 -5
- data/docs/Label.md +37 -35
- data/docs/LabelChargeEvent.md +4 -3
- data/docs/LabelDownload.md +8 -6
- data/docs/LabelDownloadType.md +4 -3
- data/docs/LabelFormat.md +4 -3
- data/docs/LabelLayout.md +4 -3
- data/docs/LabelMessages.md +7 -5
- data/docs/LabelStatus.md +4 -3
- data/docs/LabelsApi.md +97 -77
- data/docs/Link.md +4 -3
- data/docs/ListBatchErrorsResponseBody.md +6 -4
- data/docs/ListBatchesResponseBody.md +9 -7
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -3
- data/docs/ListCarrierServicesResponseBody.md +5 -3
- data/docs/ListCarriersResponseBody.md +5 -3
- data/docs/ListLabelsResponseBody.md +5 -3
- data/docs/ListManifestsResponseBody.md +9 -7
- data/docs/ListPackageTypesResponseBody.md +5 -3
- data/docs/ListShipmentErrorsResponseBody.md +6 -4
- data/docs/ListShipmentRatesResponseBody.md +4 -3
- data/docs/ListShipmentsResponseBody.md +9 -7
- data/docs/ListTagsResponseBody.md +5 -3
- data/docs/ListWarehousesResponseBody.md +5 -3
- data/docs/Manifest.md +13 -11
- data/docs/ManifestDownload.md +5 -3
- data/docs/Manifests.md +5 -3
- data/docs/ManifestsApi.md +37 -29
- data/docs/ModifyBatch.md +6 -4
- data/docs/MonetaryValue.md +6 -4
- data/docs/NonDelivery.md +4 -3
- data/docs/OptionalLink.md +6 -4
- data/docs/OrderSourceName.md +4 -3
- data/docs/Package.md +11 -9
- data/docs/PackageContents.md +4 -3
- data/docs/PackageType.md +9 -7
- data/docs/PackageTypesApi.md +38 -27
- data/docs/PagedListResponseBody.md +8 -6
- data/docs/PaginationLink.md +8 -6
- data/docs/ParseAddressRequestBody.md +6 -4
- data/docs/ParseAddressResponseBody.md +7 -5
- data/docs/ParseShipmentRequestBody.md +6 -4
- data/docs/ParseShipmentResponseBody.md +7 -5
- data/docs/PartialAddress.md +15 -13
- data/docs/PartialShipment.md +26 -24
- data/docs/PaymentAmount.md +6 -4
- data/docs/ProcessBatchRequestBody.md +7 -5
- data/docs/PurchaseLabelWithoutShipment.md +8 -6
- data/docs/Rate.md +29 -27
- data/docs/RateEstimateByCarrierId.md +5 -3
- data/docs/RateEstimateByCarrierIds.md +5 -3
- data/docs/RateEstimateOptions.md +17 -15
- data/docs/RateRequestBody.md +9 -7
- data/docs/RateRequestByShipmentIds.md +5 -3
- data/docs/RateRequestByShipments.md +5 -3
- data/docs/RateRequestOptions.md +5 -3
- data/docs/RateRequestRateOptions.md +5 -3
- data/docs/RateResponse.md +5 -3
- data/docs/RateResponseStatus.md +4 -3
- data/docs/RateType.md +4 -3
- data/docs/RatesApi.md +36 -26
- data/docs/RatesInformation.md +11 -9
- data/docs/RecognizedEntity.md +10 -8
- data/docs/RemoveFromBatchRequestBody.md +4 -3
- data/docs/ResponseMessage.md +8 -6
- data/docs/Service.md +11 -9
- data/docs/Shipment.md +4 -3
- data/docs/ShipmentIdRequest.md +5 -3
- data/docs/ShipmentItem.md +13 -11
- data/docs/ShipmentRequest.md +5 -3
- data/docs/ShipmentResponseError.md +7 -5
- data/docs/ShipmentStatus.md +4 -3
- data/docs/ShipmentsApi.md +112 -88
- data/docs/ShipmentsSortBy.md +4 -3
- data/docs/SmartPostHub.md +4 -3
- data/docs/SortDir.md +4 -3
- data/docs/Tag.md +5 -3
- data/docs/TagShipmentResponseBody.md +6 -4
- data/docs/TagsApi.md +33 -24
- data/docs/TrackEvent.md +16 -14
- data/docs/TrackingApi.md +29 -21
- data/docs/TrackingInformation.md +14 -12
- data/docs/TrackingStatus.md +4 -3
- data/docs/UpdateAmazonBuyShippingRequestBody.md +5 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -20
- data/docs/UpdateDhlExpressSettingsRequestBody.md +4 -3
- data/docs/UpdateFedexSettingsRequestBody.md +4 -3
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -4
- data/docs/UpdatePackageTypeRequestBody.md +4 -3
- data/docs/UpdateShipmentFields.md +5 -3
- data/docs/UpdateShipmentRequestBody.md +27 -25
- data/docs/UpdateShipmentResponseBody.md +4 -3
- data/docs/UpdateUpsSettingsRequestBody.md +4 -3
- data/docs/UpdateWarehouseRequestBody.md +4 -3
- data/docs/UpdateWebhookRequestBody.md +5 -3
- data/docs/UpsAccountSettings.md +16 -14
- data/docs/UpsInvoice.md +8 -6
- data/docs/UpsPickupType.md +4 -3
- data/docs/UpsSettingsResponseBody.md +4 -3
- data/docs/ValidateAddress.md +4 -3
- data/docs/ValidateShipmentFields.md +5 -3
- data/docs/ValidationStatus.md +4 -3
- data/docs/VoidLabelResponseBody.md +6 -4
- data/docs/Warehouse.md +9 -7
- data/docs/WarehousesApi.md +39 -28
- data/docs/Webhook.md +7 -5
- data/docs/WebhookEvent.md +4 -3
- data/docs/WebhooksApi.md +38 -27
- data/docs/Weight.md +6 -4
- data/docs/WeightUnit.md +4 -3
- data/lib/ship_engine.rb +25 -25
- data/lib/ship_engine/api/addresses_api.rb +13 -13
- data/lib/ship_engine/api/batches_api.rb +41 -41
- data/lib/ship_engine/api/carrier_accounts_api.rb +13 -13
- data/lib/ship_engine/api/carriers_api.rb +15 -15
- data/lib/ship_engine/api/downloads_api.rb +11 -11
- data/lib/ship_engine/api/insurance_api.rb +15 -15
- data/lib/ship_engine/api/labels_api.rb +42 -42
- data/lib/ship_engine/api/manifests_api.rb +14 -14
- data/lib/ship_engine/api/package_types_api.rb +15 -15
- data/lib/ship_engine/api/rates_api.rb +17 -17
- data/lib/ship_engine/api/shipments_api.rb +49 -49
- data/lib/ship_engine/api/tags_api.rb +17 -17
- data/lib/ship_engine/api/tracking_api.rb +9 -9
- data/lib/ship_engine/api/warehouses_api.rb +17 -17
- data/lib/ship_engine/api/webhooks_api.rb +15 -15
- data/lib/ship_engine/api_client.rb +1 -1
- data/lib/ship_engine/api_error.rb +1 -1
- data/lib/ship_engine/configuration.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +2 -2
- data/lib/ship_engine/models/add_to_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/address.rb +3 -3
- data/lib/ship_engine/models/address_residential_indicator.rb +1 -1
- data/lib/ship_engine/models/address_to_validate.rb +3 -3
- data/lib/ship_engine/models/address_validating_shipment.rb +13 -13
- data/lib/ship_engine/models/address_validation_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_detail_code.rb +1 -1
- data/lib/ship_engine/models/address_validation_message_type.rb +1 -1
- data/lib/ship_engine/models/address_validation_result.rb +2 -2
- data/lib/ship_engine/models/address_validation_status.rb +1 -1
- data/lib/ship_engine/models/advanced_shipment_options.rb +13 -13
- data/lib/ship_engine/models/ancillary_service_endorsement.rb +1 -1
- data/lib/ship_engine/models/batch.rb +3 -3
- data/lib/ship_engine/models/batch_response_error.rb +2 -2
- data/lib/ship_engine/models/batch_status.rb +1 -1
- data/lib/ship_engine/models/batches_sort_by.rb +1 -1
- data/lib/ship_engine/models/bill_to_party.rb +1 -1
- data/lib/ship_engine/models/bulk_rate.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_response_body.rb +13 -13
- data/lib/ship_engine/models/carrier.rb +3 -3
- data/lib/ship_engine/models/carrier_advanced_option.rb +2 -2
- data/lib/ship_engine/models/carrier_name.rb +1 -1
- data/lib/ship_engine/models/carrier_name_with_settings.rb +1 -1
- data/lib/ship_engine/models/collect_on_delivery.rb +2 -2
- data/lib/ship_engine/models/collect_on_delivery_payment_type.rb +1 -1
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_apc_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_asendia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_carrier_request_body.rb +3 -3
- data/lib/ship_engine/models/connect_carrier_response_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +4 -4
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_dpd_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_endicia_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_imex_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_insurer_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_purolator_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_seko_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_sendle_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_stamps_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_ups_request_body.rb +2 -2
- data/lib/ship_engine/models/create_and_validate_shipment.rb +13 -13
- data/lib/ship_engine/models/create_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/create_batch_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/create_label_request_body.rb +2 -2
- data/lib/ship_engine/models/create_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_response_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/create_package_type_response_body.rb +2 -2
- data/lib/ship_engine/models/create_return_label_request_body.rb +5 -5
- data/lib/ship_engine/models/create_return_label_response_body.rb +2 -2
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +2 -2
- data/lib/ship_engine/models/create_shipments_request_body.rb +2 -2
- data/lib/ship_engine/models/create_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/create_tag_response_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/create_warehouse_response_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/create_webhook_response_body.rb +2 -2
- data/lib/ship_engine/models/currency.rb +1 -1
- data/lib/ship_engine/models/customs_item.rb +3 -3
- data/lib/ship_engine/models/delivery_confirmation.rb +1 -1
- data/lib/ship_engine/models/deprecated_manifest.rb +2 -2
- data/lib/ship_engine/models/dhl_express_account_settings.rb +2 -2
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/dimension_unit.rb +1 -1
- data/lib/ship_engine/models/dimensions.rb +2 -2
- data/lib/ship_engine/models/error.rb +3 -3
- data/lib/ship_engine/models/error_code.rb +1 -1
- data/lib/ship_engine/models/error_response_body.rb +3 -3
- data/lib/ship_engine/models/error_source.rb +1 -1
- data/lib/ship_engine/models/error_type.rb +1 -1
- data/lib/ship_engine/models/estimate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_pickup_type.rb +1 -1
- data/lib/ship_engine/models/fedex_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carriers_response_body.rb +3 -3
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +2 -2
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +2 -2
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +2 -2
- data/lib/ship_engine/models/insurance_provider.rb +1 -1
- data/lib/ship_engine/models/international_shipment_options.rb +2 -2
- data/lib/ship_engine/models/label.rb +26 -26
- data/lib/ship_engine/models/label_charge_event.rb +1 -1
- data/lib/ship_engine/models/label_download.rb +3 -3
- data/lib/ship_engine/models/label_download_type.rb +1 -1
- data/lib/ship_engine/models/label_format.rb +1 -1
- data/lib/ship_engine/models/label_layout.rb +1 -1
- data/lib/ship_engine/models/label_messages.rb +6 -6
- data/lib/ship_engine/models/label_status.rb +1 -1
- data/lib/ship_engine/models/link.rb +2 -2
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_batches_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +2 -2
- data/lib/ship_engine/models/list_carriers_response_body.rb +2 -2
- data/lib/ship_engine/models/list_labels_response_body.rb +3 -3
- data/lib/ship_engine/models/list_manifests_response_body.rb +2 -2
- data/lib/ship_engine/models/list_package_types_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +2 -2
- data/lib/ship_engine/models/list_shipments_response_body.rb +2 -2
- data/lib/ship_engine/models/list_tags_response_body.rb +2 -2
- data/lib/ship_engine/models/list_warehouses_response_body.rb +2 -2
- data/lib/ship_engine/models/manifest.rb +3 -3
- data/lib/ship_engine/models/manifest_download.rb +2 -2
- data/lib/ship_engine/models/manifests.rb +2 -2
- data/lib/ship_engine/models/modify_batch.rb +2 -2
- data/lib/ship_engine/models/monetary_value.rb +3 -3
- data/lib/ship_engine/models/non_delivery.rb +1 -1
- data/lib/ship_engine/models/optional_link.rb +2 -2
- data/lib/ship_engine/models/order_source_name.rb +1 -1
- data/lib/ship_engine/models/package.rb +5 -5
- data/lib/ship_engine/models/package_contents.rb +1 -1
- data/lib/ship_engine/models/package_type.rb +2 -2
- data/lib/ship_engine/models/paged_list_response_body.rb +3 -3
- data/lib/ship_engine/models/pagination_link.rb +6 -6
- data/lib/ship_engine/models/parse_address_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_address_response_body.rb +6 -6
- data/lib/ship_engine/models/parse_shipment_request_body.rb +4 -4
- data/lib/ship_engine/models/parse_shipment_response_body.rb +6 -6
- data/lib/ship_engine/models/partial_address.rb +10 -10
- data/lib/ship_engine/models/partial_shipment.rb +14 -14
- data/lib/ship_engine/models/payment_amount.rb +2 -2
- data/lib/ship_engine/models/process_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +2 -2
- data/lib/ship_engine/models/rate.rb +4 -4
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +2 -2
- data/lib/ship_engine/models/rate_estimate_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_body.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +2 -2
- data/lib/ship_engine/models/rate_request_by_shipments.rb +2 -2
- data/lib/ship_engine/models/rate_request_options.rb +2 -2
- data/lib/ship_engine/models/rate_request_rate_options.rb +2 -2
- data/lib/ship_engine/models/rate_response.rb +2 -2
- data/lib/ship_engine/models/rate_response_status.rb +1 -1
- data/lib/ship_engine/models/rate_type.rb +1 -1
- data/lib/ship_engine/models/rates_information.rb +2 -2
- data/lib/ship_engine/models/recognized_entity.rb +5 -5
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +2 -2
- data/lib/ship_engine/models/response_message.rb +2 -2
- data/lib/ship_engine/models/service.rb +2 -2
- data/lib/ship_engine/models/shipment.rb +3 -3
- data/lib/ship_engine/models/shipment_id_request.rb +2 -2
- data/lib/ship_engine/models/shipment_item.rb +2 -2
- data/lib/ship_engine/models/shipment_request.rb +2 -2
- data/lib/ship_engine/models/shipment_response_error.rb +2 -2
- data/lib/ship_engine/models/shipment_status.rb +1 -1
- data/lib/ship_engine/models/shipments_sort_by.rb +1 -1
- data/lib/ship_engine/models/smart_post_hub.rb +1 -1
- data/lib/ship_engine/models/sort_dir.rb +1 -1
- data/lib/ship_engine/models/tag.rb +3 -3
- data/lib/ship_engine/models/tag_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/track_event.rb +2 -2
- data/lib/ship_engine/models/tracking_information.rb +2 -2
- data/lib/ship_engine/models/tracking_status.rb +1 -1
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +2 -2
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_package_type_request_body.rb +2 -2
- data/lib/ship_engine/models/update_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/update_shipment_request_body.rb +13 -13
- data/lib/ship_engine/models/update_shipment_response_body.rb +2 -2
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_warehouse_request_body.rb +2 -2
- data/lib/ship_engine/models/update_webhook_request_body.rb +2 -2
- data/lib/ship_engine/models/ups_account_settings.rb +2 -2
- data/lib/ship_engine/models/ups_invoice.rb +2 -2
- data/lib/ship_engine/models/ups_pickup_type.rb +1 -1
- data/lib/ship_engine/models/ups_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/validate_address.rb +1 -1
- data/lib/ship_engine/models/validate_shipment_fields.rb +2 -2
- data/lib/ship_engine/models/validation_status.rb +1 -1
- data/lib/ship_engine/models/void_label_response_body.rb +2 -2
- data/lib/ship_engine/models/warehouse.rb +2 -2
- data/lib/ship_engine/models/webhook.rb +2 -2
- data/lib/ship_engine/models/webhook_event.rb +1 -1
- data/lib/ship_engine/models/weight.rb +2 -2
- data/lib/ship_engine/models/weight_unit.rb +1 -1
- data/lib/ship_engine/version.rb +2 -2
- data/ship_engine.gemspec +1 -1
- data/spec/api/addresses_api_spec.rb +5 -5
- data/spec/api/batches_api_spec.rb +12 -12
- data/spec/api/carrier_accounts_api_spec.rb +3 -3
- data/spec/api/carriers_api_spec.rb +2 -2
- data/spec/api/downloads_api_spec.rb +5 -5
- data/spec/api/insurance_api_spec.rb +4 -4
- data/spec/api/labels_api_spec.rb +13 -13
- data/spec/api/manifests_api_spec.rb +5 -5
- data/spec/api/package_types_api_spec.rb +3 -3
- data/spec/api/rates_api_spec.rb +5 -5
- data/spec/api/shipments_api_spec.rb +15 -15
- data/spec/api/tags_api_spec.rb +5 -5
- data/spec/api/tracking_api_spec.rb +2 -2
- data/spec/api/warehouses_api_spec.rb +4 -4
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +1 -1
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +1 -1
- data/spec/models/add_to_batch_request_body_spec.rb +1 -1
- data/spec/models/address_residential_indicator_spec.rb +1 -1
- data/spec/models/address_spec.rb +1 -1
- data/spec/models/address_to_validate_spec.rb +1 -1
- data/spec/models/address_validating_shipment_spec.rb +1 -1
- data/spec/models/address_validation_code_spec.rb +1 -1
- data/spec/models/address_validation_detail_code_spec.rb +1 -1
- data/spec/models/address_validation_message_type_spec.rb +1 -1
- data/spec/models/address_validation_result_spec.rb +1 -1
- data/spec/models/address_validation_status_spec.rb +1 -1
- data/spec/models/advanced_shipment_options_spec.rb +1 -1
- data/spec/models/ancillary_service_endorsement_spec.rb +1 -1
- data/spec/models/batch_response_error_spec.rb +1 -1
- data/spec/models/batch_spec.rb +1 -1
- data/spec/models/batch_status_spec.rb +1 -1
- data/spec/models/batches_sort_by_spec.rb +1 -1
- data/spec/models/bill_to_party_spec.rb +1 -1
- data/spec/models/bulk_rate_spec.rb +1 -1
- data/spec/models/calculate_rates_request_body_spec.rb +1 -1
- data/spec/models/calculate_rates_response_body_spec.rb +1 -1
- data/spec/models/carrier_advanced_option_spec.rb +1 -1
- data/spec/models/carrier_name_spec.rb +1 -1
- data/spec/models/carrier_name_with_settings_spec.rb +1 -1
- data/spec/models/carrier_spec.rb +1 -1
- data/spec/models/collect_on_delivery_payment_type_spec.rb +1 -1
- data/spec/models/collect_on_delivery_spec.rb +1 -1
- data/spec/models/compare_bulk_rates_request_body_spec.rb +1 -1
- data/spec/models/connect_access_worldwide_request_body_spec.rb +1 -1
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/connect_apc_request_body_spec.rb +1 -1
- data/spec/models/connect_asendia_request_body_spec.rb +1 -1
- data/spec/models/connect_australia_post_request_body_spec.rb +1 -1
- data/spec/models/connect_canada_post_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_request_body_spec.rb +1 -1
- data/spec/models/connect_carrier_response_body_spec.rb +1 -1
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_request_body_spec.rb +1 -1
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_dpd_request_body_spec.rb +1 -1
- data/spec/models/connect_endicia_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_request_body_spec.rb +1 -1
- data/spec/models/connect_fedex_uk_request_body_spec.rb +1 -1
- data/spec/models/connect_firstmile_request_body_spec.rb +1 -1
- data/spec/models/connect_globegistics_request_body_spec.rb +1 -1
- data/spec/models/connect_imex_request_body_spec.rb +1 -1
- data/spec/models/connect_insurer_request_body_spec.rb +1 -1
- data/spec/models/connect_newgistics_request_body_spec.rb +1 -1
- data/spec/models/connect_ontrac_request_body_spec.rb +1 -1
- data/spec/models/connect_purolator_request_body_spec.rb +1 -1
- data/spec/models/connect_royal_mail_request_body_spec.rb +1 -1
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +1 -1
- data/spec/models/connect_seko_request_body_spec.rb +1 -1
- data/spec/models/connect_sendle_request_body_spec.rb +1 -1
- data/spec/models/connect_stamps_request_body_spec.rb +1 -1
- data/spec/models/connect_ups_request_body_spec.rb +1 -1
- data/spec/models/create_and_validate_shipment_spec.rb +1 -1
- data/spec/models/create_batch_request_body_spec.rb +1 -1
- data/spec/models/create_batch_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_rate_response_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_request_body_spec.rb +1 -1
- data/spec/models/create_label_from_shipment_response_body_spec.rb +1 -1
- data/spec/models/create_label_request_body_spec.rb +1 -1
- data/spec/models/create_label_response_body_spec.rb +1 -1
- data/spec/models/create_manifest_by_object_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_request_body_spec.rb +1 -1
- data/spec/models/create_manifest_response_body_spec.rb +1 -1
- data/spec/models/create_package_type_request_body_spec.rb +1 -1
- data/spec/models/create_package_type_response_body_spec.rb +1 -1
- data/spec/models/create_return_label_request_body_spec.rb +1 -1
- data/spec/models/create_return_label_response_body_spec.rb +1 -1
- data/spec/models/create_shipment_response_body_fields_spec.rb +1 -1
- data/spec/models/create_shipments_request_body_spec.rb +1 -1
- data/spec/models/create_shipments_response_body_spec.rb +1 -1
- data/spec/models/create_tag_response_body_spec.rb +1 -1
- data/spec/models/create_warehouse_request_body_spec.rb +1 -1
- data/spec/models/create_warehouse_response_body_spec.rb +1 -1
- data/spec/models/create_webhook_request_body_spec.rb +1 -1
- data/spec/models/create_webhook_response_body_spec.rb +1 -1
- data/spec/models/currency_spec.rb +1 -1
- data/spec/models/customs_item_spec.rb +1 -1
- data/spec/models/delivery_confirmation_spec.rb +1 -1
- data/spec/models/deprecated_manifest_spec.rb +1 -1
- data/spec/models/dhl_express_account_settings_spec.rb +1 -1
- data/spec/models/dhl_express_settings_response_body_spec.rb +1 -1
- data/spec/models/dimension_unit_spec.rb +1 -1
- data/spec/models/dimensions_spec.rb +1 -1
- data/spec/models/error_code_spec.rb +1 -1
- data/spec/models/error_response_body_spec.rb +1 -1
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/error_type_spec.rb +1 -1
- data/spec/models/estimate_rates_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_request_body_spec.rb +1 -1
- data/spec/models/fedex_account_settings_spec.rb +1 -1
- data/spec/models/fedex_pickup_type_spec.rb +1 -1
- data/spec/models/fedex_settings_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_batch_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_options_response_body_spec.rb +1 -1
- data/spec/models/get_carrier_settings_response_body_spec.rb +1 -1
- data/spec/models/get_carriers_response_body_spec.rb +1 -1
- data/spec/models/get_insurance_balance_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +1 -1
- data/spec/models/get_label_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_manifest_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_package_type_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_rate_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +1 -1
- data/spec/models/get_shipment_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +1 -1
- data/spec/models/get_tracking_log_response_body_spec.rb +1 -1
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +1 -1
- data/spec/models/get_webhook_by_id_response_body_spec.rb +1 -1
- data/spec/models/insurance_provider_spec.rb +1 -1
- data/spec/models/international_shipment_options_spec.rb +1 -1
- data/spec/models/label_charge_event_spec.rb +1 -1
- data/spec/models/label_download_spec.rb +1 -1
- data/spec/models/label_download_type_spec.rb +1 -1
- data/spec/models/label_format_spec.rb +1 -1
- data/spec/models/label_layout_spec.rb +1 -1
- data/spec/models/label_messages_spec.rb +1 -1
- data/spec/models/label_spec.rb +1 -1
- data/spec/models/label_status_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/list_batch_errors_response_body_spec.rb +1 -1
- data/spec/models/list_batches_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_carrier_services_response_body_spec.rb +1 -1
- data/spec/models/list_carriers_response_body_spec.rb +1 -1
- data/spec/models/list_labels_response_body_spec.rb +1 -1
- data/spec/models/list_manifests_response_body_spec.rb +1 -1
- data/spec/models/list_package_types_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_errors_response_body_spec.rb +1 -1
- data/spec/models/list_shipment_rates_response_body_spec.rb +1 -1
- data/spec/models/list_shipments_response_body_spec.rb +1 -1
- data/spec/models/list_tags_response_body_spec.rb +1 -1
- data/spec/models/list_warehouses_response_body_spec.rb +1 -1
- data/spec/models/manifest_download_spec.rb +1 -1
- data/spec/models/manifest_spec.rb +1 -1
- data/spec/models/manifests_spec.rb +1 -1
- data/spec/models/modify_batch_spec.rb +1 -1
- data/spec/models/monetary_value_spec.rb +1 -1
- data/spec/models/non_delivery_spec.rb +1 -1
- data/spec/models/optional_link_spec.rb +1 -1
- data/spec/models/order_source_name_spec.rb +1 -1
- data/spec/models/package_contents_spec.rb +1 -1
- data/spec/models/package_spec.rb +1 -1
- data/spec/models/package_type_spec.rb +1 -1
- data/spec/models/paged_list_response_body_spec.rb +1 -1
- data/spec/models/pagination_link_spec.rb +1 -1
- data/spec/models/parse_address_request_body_spec.rb +1 -1
- data/spec/models/parse_address_response_body_spec.rb +1 -1
- data/spec/models/parse_shipment_request_body_spec.rb +1 -1
- data/spec/models/parse_shipment_response_body_spec.rb +1 -1
- data/spec/models/partial_address_spec.rb +1 -1
- data/spec/models/partial_shipment_spec.rb +1 -1
- data/spec/models/payment_amount_spec.rb +1 -1
- data/spec/models/process_batch_request_body_spec.rb +1 -1
- data/spec/models/purchase_label_without_shipment_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +1 -1
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +1 -1
- data/spec/models/rate_estimate_options_spec.rb +1 -1
- data/spec/models/rate_request_body_spec.rb +1 -1
- data/spec/models/rate_request_by_shipment_ids_spec.rb +1 -1
- data/spec/models/rate_request_by_shipments_spec.rb +1 -1
- data/spec/models/rate_request_options_spec.rb +1 -1
- data/spec/models/rate_request_rate_options_spec.rb +1 -1
- data/spec/models/rate_response_spec.rb +1 -1
- data/spec/models/rate_response_status_spec.rb +1 -1
- data/spec/models/rate_spec.rb +1 -1
- data/spec/models/rate_type_spec.rb +1 -1
- data/spec/models/rates_information_spec.rb +1 -1
- data/spec/models/recognized_entity_spec.rb +1 -1
- data/spec/models/remove_from_batch_request_body_spec.rb +1 -1
- data/spec/models/response_message_spec.rb +1 -1
- data/spec/models/service_spec.rb +1 -1
- data/spec/models/shipment_id_request_spec.rb +1 -1
- data/spec/models/shipment_item_spec.rb +1 -1
- data/spec/models/shipment_request_spec.rb +1 -1
- data/spec/models/shipment_response_error_spec.rb +1 -1
- data/spec/models/shipment_spec.rb +1 -1
- data/spec/models/shipment_status_spec.rb +1 -1
- data/spec/models/shipments_sort_by_spec.rb +1 -1
- data/spec/models/smart_post_hub_spec.rb +1 -1
- data/spec/models/sort_dir_spec.rb +1 -1
- data/spec/models/tag_shipment_response_body_spec.rb +1 -1
- data/spec/models/tag_spec.rb +1 -1
- data/spec/models/track_event_spec.rb +1 -1
- data/spec/models/tracking_information_spec.rb +1 -1
- data/spec/models/tracking_status_spec.rb +1 -1
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +1 -1
- data/spec/models/update_carrier_settings_request_body_spec.rb +1 -1
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +1 -1
- data/spec/models/update_fedex_settings_request_body_spec.rb +1 -1
- data/spec/models/update_newgistics_settings_request_body_spec.rb +1 -1
- data/spec/models/update_package_type_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_fields_spec.rb +1 -1
- data/spec/models/update_shipment_request_body_spec.rb +1 -1
- data/spec/models/update_shipment_response_body_spec.rb +1 -1
- data/spec/models/update_ups_settings_request_body_spec.rb +1 -1
- data/spec/models/update_warehouse_request_body_spec.rb +1 -1
- data/spec/models/update_webhook_request_body_spec.rb +1 -1
- data/spec/models/ups_account_settings_spec.rb +1 -1
- data/spec/models/ups_invoice_spec.rb +1 -1
- data/spec/models/ups_pickup_type_spec.rb +1 -1
- data/spec/models/ups_settings_response_body_spec.rb +1 -1
- data/spec/models/validate_address_spec.rb +1 -1
- data/spec/models/validate_shipment_fields_spec.rb +1 -1
- data/spec/models/validation_status_spec.rb +1 -1
- data/spec/models/void_label_response_body_spec.rb +1 -1
- data/spec/models/warehouse_spec.rb +1 -1
- data/spec/models/webhook_event_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/weight_spec.rb +1 -1
- data/spec/models/weight_unit_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine-1.0.1.gem +0 -0
data/docs/RateResponseStatus.md
CHANGED
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::RateResponseStatus.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/RateType.md
CHANGED
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::RateType.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/RatesApi.md
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.shipengine.com*
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**calculate_rates**](RatesApi.md#calculate_rates) | **POST** /v1/rates | Get Shipping Rates
|
|
8
|
+
[**compare_bulk_rates**](RatesApi.md#compare_bulk_rates) | **POST** /v1/rates/bulk | Get Bulk Rates
|
|
9
|
+
[**estimate_rates**](RatesApi.md#estimate_rates) | **POST** /v1/rates/estimate | Estimate Rates
|
|
10
|
+
[**get_rate_by_id**](RatesApi.md#get_rate_by_id) | **GET** /v1/rates/{rate_id} | Get Rate By ID
|
|
11
|
+
|
|
12
|
+
|
|
11
13
|
|
|
12
14
|
## calculate_rates
|
|
13
15
|
|
|
@@ -15,13 +17,13 @@ All URIs are relative to *https://api.shipengine.com*
|
|
|
15
17
|
|
|
16
18
|
Get Shipping Rates
|
|
17
19
|
|
|
18
|
-
It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
20
|
+
It's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most companies don't solely ship things using a single shipping option; so we provide functionality to show you all your options!
|
|
19
21
|
|
|
20
22
|
### Example
|
|
21
23
|
|
|
22
24
|
```ruby
|
|
23
25
|
# load the gem
|
|
24
|
-
require '
|
|
26
|
+
require 'ship_engine'
|
|
25
27
|
# setup authorization
|
|
26
28
|
ShipEngine.configure do |config|
|
|
27
29
|
# Configure API key authorization: api_key
|
|
@@ -31,7 +33,7 @@ ShipEngine.configure do |config|
|
|
|
31
33
|
end
|
|
32
34
|
|
|
33
35
|
api_instance = ShipEngine::RatesApi.new
|
|
34
|
-
calculate_rates_request_body = ShipEngine::CalculateRatesRequestBody.new # CalculateRatesRequestBody |
|
|
36
|
+
calculate_rates_request_body = ShipEngine::CalculateRatesRequestBody.new # CalculateRatesRequestBody |
|
|
35
37
|
|
|
36
38
|
begin
|
|
37
39
|
#Get Shipping Rates
|
|
@@ -44,9 +46,10 @@ end
|
|
|
44
46
|
|
|
45
47
|
### Parameters
|
|
46
48
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
|
49
|
+
|
|
50
|
+
Name | Type | Description | Notes
|
|
51
|
+
------------- | ------------- | ------------- | -------------
|
|
52
|
+
**calculate_rates_request_body** | [**CalculateRatesRequestBody**](CalculateRatesRequestBody.md)| |
|
|
50
53
|
|
|
51
54
|
### Return type
|
|
52
55
|
|
|
@@ -61,6 +64,7 @@ end
|
|
|
61
64
|
- **Content-Type**: application/json
|
|
62
65
|
- **Accept**: application/json
|
|
63
66
|
|
|
67
|
+
|
|
64
68
|
## compare_bulk_rates
|
|
65
69
|
|
|
66
70
|
> Array<BulkRate> compare_bulk_rates(compare_bulk_rates_request_body)
|
|
@@ -73,7 +77,7 @@ Get Bulk Shipment Rates
|
|
|
73
77
|
|
|
74
78
|
```ruby
|
|
75
79
|
# load the gem
|
|
76
|
-
require '
|
|
80
|
+
require 'ship_engine'
|
|
77
81
|
# setup authorization
|
|
78
82
|
ShipEngine.configure do |config|
|
|
79
83
|
# Configure API key authorization: api_key
|
|
@@ -83,7 +87,7 @@ ShipEngine.configure do |config|
|
|
|
83
87
|
end
|
|
84
88
|
|
|
85
89
|
api_instance = ShipEngine::RatesApi.new
|
|
86
|
-
compare_bulk_rates_request_body = ShipEngine::CompareBulkRatesRequestBody.new # CompareBulkRatesRequestBody |
|
|
90
|
+
compare_bulk_rates_request_body = ShipEngine::CompareBulkRatesRequestBody.new # CompareBulkRatesRequestBody |
|
|
87
91
|
|
|
88
92
|
begin
|
|
89
93
|
#Get Bulk Rates
|
|
@@ -96,9 +100,10 @@ end
|
|
|
96
100
|
|
|
97
101
|
### Parameters
|
|
98
102
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
|
103
|
+
|
|
104
|
+
Name | Type | Description | Notes
|
|
105
|
+
------------- | ------------- | ------------- | -------------
|
|
106
|
+
**compare_bulk_rates_request_body** | [**CompareBulkRatesRequestBody**](CompareBulkRatesRequestBody.md)| |
|
|
102
107
|
|
|
103
108
|
### Return type
|
|
104
109
|
|
|
@@ -113,6 +118,7 @@ end
|
|
|
113
118
|
- **Content-Type**: application/json
|
|
114
119
|
- **Accept**: application/json
|
|
115
120
|
|
|
121
|
+
|
|
116
122
|
## estimate_rates
|
|
117
123
|
|
|
118
124
|
> Array<Rate> estimate_rates(estimate_rates_request_body)
|
|
@@ -125,7 +131,7 @@ Get Rate Estimates
|
|
|
125
131
|
|
|
126
132
|
```ruby
|
|
127
133
|
# load the gem
|
|
128
|
-
require '
|
|
134
|
+
require 'ship_engine'
|
|
129
135
|
# setup authorization
|
|
130
136
|
ShipEngine.configure do |config|
|
|
131
137
|
# Configure API key authorization: api_key
|
|
@@ -135,7 +141,7 @@ ShipEngine.configure do |config|
|
|
|
135
141
|
end
|
|
136
142
|
|
|
137
143
|
api_instance = ShipEngine::RatesApi.new
|
|
138
|
-
estimate_rates_request_body = ShipEngine::EstimateRatesRequestBody.new # EstimateRatesRequestBody |
|
|
144
|
+
estimate_rates_request_body = ShipEngine::EstimateRatesRequestBody.new # EstimateRatesRequestBody |
|
|
139
145
|
|
|
140
146
|
begin
|
|
141
147
|
#Estimate Rates
|
|
@@ -148,9 +154,10 @@ end
|
|
|
148
154
|
|
|
149
155
|
### Parameters
|
|
150
156
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
|
157
|
+
|
|
158
|
+
Name | Type | Description | Notes
|
|
159
|
+
------------- | ------------- | ------------- | -------------
|
|
160
|
+
**estimate_rates_request_body** | [**EstimateRatesRequestBody**](EstimateRatesRequestBody.md)| |
|
|
154
161
|
|
|
155
162
|
### Return type
|
|
156
163
|
|
|
@@ -165,6 +172,7 @@ end
|
|
|
165
172
|
- **Content-Type**: application/json
|
|
166
173
|
- **Accept**: application/json
|
|
167
174
|
|
|
175
|
+
|
|
168
176
|
## get_rate_by_id
|
|
169
177
|
|
|
170
178
|
> GetRateByIdResponseBody get_rate_by_id(rate_id)
|
|
@@ -177,7 +185,7 @@ Retrieve a previously queried rate by its ID
|
|
|
177
185
|
|
|
178
186
|
```ruby
|
|
179
187
|
# load the gem
|
|
180
|
-
require '
|
|
188
|
+
require 'ship_engine'
|
|
181
189
|
# setup authorization
|
|
182
190
|
ShipEngine.configure do |config|
|
|
183
191
|
# Configure API key authorization: api_key
|
|
@@ -200,9 +208,10 @@ end
|
|
|
200
208
|
|
|
201
209
|
### Parameters
|
|
202
210
|
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
|
211
|
+
|
|
212
|
+
Name | Type | Description | Notes
|
|
213
|
+
------------- | ------------- | ------------- | -------------
|
|
214
|
+
**rate_id** | **String**| Rate ID |
|
|
206
215
|
|
|
207
216
|
### Return type
|
|
208
217
|
|
|
@@ -216,3 +225,4 @@ end
|
|
|
216
225
|
|
|
217
226
|
- **Content-Type**: Not defined
|
|
218
227
|
- **Accept**: application/json
|
|
228
|
+
|
data/docs/RatesInformation.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**rates** | [**Array<Rate>**](Rate.md) | An array of shipment rates | [optional] [readonly]
|
|
8
|
+
**invalid_rates** | [**Array<Rate>**](Rate.md) | An array of invalid shipment rates | [optional] [readonly]
|
|
9
|
+
**rate_request_id** | **String** | A string that uniquely identifies the rate request | [optional] [readonly]
|
|
10
|
+
**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly]
|
|
11
|
+
**created_at** | **String** | When the rate was created | [optional]
|
|
12
|
+
**status** | [**RateResponseStatus**](RateResponseStatus.md) | | [optional] [readonly]
|
|
13
|
+
**errors** | [**Array<Error>**](Error.md) | | [optional]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
@@ -25,3 +25,5 @@ instance = ShipEngine::RatesInformation.new(rates: null,
|
|
|
25
25
|
status: null,
|
|
26
26
|
errors: null)
|
|
27
27
|
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/RecognizedEntity.md
CHANGED
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**type** | **String** | The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) |
|
|
8
|
+
**score** | **Float** | A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity |
|
|
9
|
+
**text** | **String** | The substring from the original text that was recognized as this entity |
|
|
10
|
+
**start_index** | **Integer** | The index of the first character of this entity within the original text |
|
|
11
|
+
**end_index** | **Integer** | The index of the last character of this entity within the original text |
|
|
12
|
+
**result** | **Hash<String, Object>** | The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. | [optional]
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
@@ -23,3 +23,5 @@ instance = ShipEngine::RecognizedEntity.new(type: null,
|
|
|
23
23
|
end_index: null,
|
|
24
24
|
result: null)
|
|
25
25
|
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::RemoveFromBatchRequestBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/ResponseMessage.md
CHANGED
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**code** | [**AddressValidationCode**](AddressValidationCode.md) | | [optional] [readonly]
|
|
8
|
+
**message** | **String** | Message explaining the address validation error | [optional] [readonly]
|
|
9
|
+
**type** | [**AddressValidationMessageType**](AddressValidationMessageType.md) | | [optional] [readonly]
|
|
10
|
+
**detail_code** | [**AddressValidationDetailCode**](AddressValidationDetailCode.md) | | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -19,3 +19,5 @@ instance = ShipEngine::ResponseMessage.new(code: null,
|
|
|
19
19
|
type: null,
|
|
20
20
|
detail_code: null)
|
|
21
21
|
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/Service.md
CHANGED
|
@@ -2,15 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**carrier_id** | **String** | A string that uniquely identifies the carrier | [optional] [readonly]
|
|
8
|
+
**carrier_code** | **String** | | [optional]
|
|
9
|
+
**service_code** | **String** | service code | [optional] [readonly]
|
|
10
|
+
**name** | **String** | User friendly service name | [optional] [readonly]
|
|
11
|
+
**domestic** | **Boolean** | Supports domestic shipping | [optional] [readonly]
|
|
12
|
+
**international** | **Boolean** | Supports international shipping. | [optional] [readonly]
|
|
13
|
+
**is_multi_package_supported** | **Boolean** | Carrier supports multiple packages per shipment | [optional] [readonly]
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
@@ -25,3 +25,5 @@ instance = ShipEngine::Service.new(carrier_id: null,
|
|
|
25
25
|
international: null,
|
|
26
26
|
is_multi_package_supported: null)
|
|
27
27
|
```
|
|
28
|
+
|
|
29
|
+
|
data/docs/Shipment.md
CHANGED
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
8
7
|
|
|
9
8
|
## Code Sample
|
|
10
9
|
|
|
@@ -13,3 +12,5 @@ require 'ShipEngine'
|
|
|
13
12
|
|
|
14
13
|
instance = ShipEngine::Shipment.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/docs/ShipmentIdRequest.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional]
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -13,3 +13,5 @@ require 'ShipEngine'
|
|
|
13
13
|
|
|
14
14
|
instance = ShipEngine::ShipmentIdRequest.new(shipment_id: null)
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
|
data/docs/ShipmentItem.md
CHANGED
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | item name | [optional]
|
|
8
|
+
**sales_order_id** | **String** | sales order id | [optional]
|
|
9
|
+
**sales_order_item_id** | **String** | sales order item id | [optional]
|
|
10
|
+
**quantity** | **Integer** | The quantity of this item included in the shipment | [optional]
|
|
11
|
+
**sku** | **String** | Item Stock Keeping Unit | [optional]
|
|
12
|
+
**external_order_id** | **String** | external order id | [optional]
|
|
13
|
+
**external_order_item_id** | **String** | external order item id | [optional]
|
|
14
|
+
**asin** | **String** | Amazon Standard Identification Number | [optional]
|
|
15
|
+
**order_source_code** | [**OrderSourceName**](OrderSourceName.md) | | [optional]
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
@@ -29,3 +29,5 @@ instance = ShipEngine::ShipmentItem.new(name: null,
|
|
|
29
29
|
asin: B00005N5PF,
|
|
30
30
|
order_source_code: null)
|
|
31
31
|
```
|
|
32
|
+
|
|
33
|
+
|
data/docs/ShipmentRequest.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**shipment** | [**AddressValidatingShipment**](AddressValidatingShipment.md) | The shipment object | [optional]
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -13,3 +13,5 @@ require 'ShipEngine'
|
|
|
13
13
|
|
|
14
14
|
instance = ShipEngine::ShipmentRequest.new(shipment: null)
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**error** | **String** | Shipment error message | [readonly]
|
|
8
|
+
**shipment_id** | **String** | A string that uniquely identifies the shipment. | [readonly]
|
|
9
|
+
**external_shipment_id** | **String** | A string that uniquely identifies the external shipment. | [optional] [readonly]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -17,3 +17,5 @@ instance = ShipEngine::ShipmentResponseError.new(error: null,
|
|
|
17
17
|
shipment_id: null,
|
|
18
18
|
external_shipment_id: null)
|
|
19
19
|
```
|
|
20
|
+
|
|
21
|
+
|