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.
- 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
|
@@ -2,32 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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
|
+
**errors** | **Array<String>** | An array of errors that occurred while creating shipment. | [optional] [readonly]
|
|
30
|
+
**address_validation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional]
|
|
31
31
|
|
|
32
32
|
## Code Sample
|
|
33
33
|
|
|
@@ -59,3 +59,5 @@ instance = ShipEngine::CreateAndValidateShipment.new(shipment_id: null,
|
|
|
59
59
|
errors: null,
|
|
60
60
|
address_validation: null)
|
|
61
61
|
```
|
|
62
|
+
|
|
63
|
+
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**external_batch_id** | **String** | A string that uniquely identifies the external batch | [optional]
|
|
8
|
+
**batch_notes** | **String** | Add custom messages for a particular batch | [optional]
|
|
9
|
+
**shipment_ids** | **Array<String>** | Array of shipment IDs used in the batch | [optional]
|
|
10
|
+
**rate_ids** | **Array<String>** | Array of rate IDs used in the batch | [optional]
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
@@ -19,3 +19,5 @@ instance = ShipEngine::CreateBatchRequestBody.new(external_batch_id: null,
|
|
|
19
19
|
shipment_ids: null,
|
|
20
20
|
rate_ids: null)
|
|
21
21
|
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -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::CreateBatchResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -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::CreateLabelFromRateRequestBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -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::CreateLabelFromRateResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
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::CreateLabelFromShipmentRequestBody.new(validate_address:
|
|
|
19
19
|
label_format: null,
|
|
20
20
|
label_download_type: null)
|
|
21
21
|
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -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::CreateLabelFromShipmentResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -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::CreateLabelRequestBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -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::CreateLabelResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**carrier_id** | **String** | A string that uniquely identifies the carrier |
|
|
8
|
+
**excluded_label_ids** | **Array<String>** | The list of label ids to exclude from the manifest | [optional]
|
|
9
|
+
**label_ids** | **Array<String>** | The list of label ids to include for the manifest | [optional]
|
|
10
|
+
**warehouse_id** | **String** | A string that uniquely identifies the warehouse |
|
|
11
|
+
**ship_date** | **DateTime** | The ship date that the shipment will be sent out on |
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
@@ -21,3 +21,5 @@ instance = ShipEngine::CreateManifestByObjectRequestBody.new(carrier_id: null,
|
|
|
21
21
|
warehouse_id: null,
|
|
22
22
|
ship_date: 2018-09-23T15:00Z)
|
|
23
23
|
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
| ------------- |
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**label_ids** | **Array<String>** | The list of label ids to include in the manifest |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -13,3 +13,5 @@ require 'ShipEngine'
|
|
|
13
13
|
|
|
14
14
|
instance = ShipEngine::CreateManifestLabelIdsRequestBody.new(label_ids: null)
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**carrier_id** | **String** | A string that uniquely identifies the carrier |
|
|
8
|
+
**excluded_label_ids** | **Array<String>** | The list of label ids to exclude from the manifest | [optional]
|
|
9
|
+
**label_ids** | **Array<String>** | The list of label ids to include in the manifest |
|
|
10
|
+
**warehouse_id** | **String** | A string that uniquely identifies the warehouse |
|
|
11
|
+
**ship_date** | **DateTime** | The ship date that the shipment will be sent out on |
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
@@ -21,3 +21,5 @@ instance = ShipEngine::CreateManifestRequestBody.new(carrier_id: null,
|
|
|
21
21
|
warehouse_id: null,
|
|
22
22
|
ship_date: 2018-09-23T15:00Z)
|
|
23
23
|
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**manifests** | [**Array<Manifest>**](Manifest.md) | | [optional]
|
|
8
|
+
**manifest_id** | **String** | A string that uniquely identifies the manifest |
|
|
9
|
+
**form_id** | **String** | A string that uniquely identifies the form |
|
|
10
|
+
**created_at** | **DateTime** | The date-time that the manifest was created |
|
|
11
|
+
**ship_date** | **DateTime** | The date-time that the manifests shipments will be picked up |
|
|
12
|
+
**shipments** | **Integer** | The number of shipments that are included in this manifest | [readonly]
|
|
13
|
+
**warehouse_id** | **String** | A string that uniquely identifies the warehouse |
|
|
14
|
+
**submission_id** | **String** | A string that uniquely identifies the submission |
|
|
15
|
+
**carrier_id** | **String** | A string that uniquely identifies the carrier |
|
|
16
|
+
**manifest_download** | [**ManifestDownload**](ManifestDownload.md) | |
|
|
17
17
|
|
|
18
18
|
## Code Sample
|
|
19
19
|
|
|
@@ -31,3 +31,5 @@ instance = ShipEngine::CreateManifestResponseBody.new(manifests: null,
|
|
|
31
31
|
carrier_id: null,
|
|
32
32
|
manifest_download: null)
|
|
33
33
|
```
|
|
34
|
+
|
|
35
|
+
|
|
@@ -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::CreatePackageTypeRequestBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -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::CreatePackageTypeResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**charge_event** | [**LabelChargeEvent**](LabelChargeEvent.md) | The label charge event. | [optional]
|
|
8
|
+
**label_layout** | [**LabelLayout**](LabelLayout.md) | The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. | [optional]
|
|
9
|
+
**label_format** | [**LabelFormat**](LabelFormat.md) | The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. | [optional]
|
|
10
|
+
**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) | | [optional]
|
|
11
|
+
**label_image_id** | **String** | The label image resource that was used to create a custom label image. | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
|
@@ -21,3 +21,5 @@ instance = ShipEngine::CreateReturnLabelRequestBody.new(charge_event: null,
|
|
|
21
21
|
label_download_type: null,
|
|
22
22
|
label_image_id: null)
|
|
23
23
|
```
|
|
24
|
+
|
|
25
|
+
|
|
@@ -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::CreateReturnLabelResponseBody.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**errors** | **Array<String>** | An array of errors that occurred while creating shipment. | [optional] [readonly]
|
|
8
|
+
**address_validation** | [**AddressValidationResult**](AddressValidationResult.md) | The address validation | [optional]
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
@@ -15,3 +15,5 @@ require 'ShipEngine'
|
|
|
15
15
|
instance = ShipEngine::CreateShipmentResponseBodyFields.new(errors: null,
|
|
16
16
|
address_validation: null)
|
|
17
17
|
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
| ------------- |
|
|
7
|
-
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**shipments** | [**Array<AddressValidatingShipment>**](AddressValidatingShipment.md) | An array of shipments to be created. |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
@@ -13,3 +13,5 @@ require 'ShipEngine'
|
|
|
13
13
|
|
|
14
14
|
instance = ShipEngine::CreateShipmentsRequestBody.new(shipments: null)
|
|
15
15
|
```
|
|
16
|
+
|
|
17
|
+
|