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/WeightUnit.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::WeightUnit.new()
|
|
15
14
|
```
|
|
15
|
+
|
|
16
|
+
|
data/lib/ship_engine.rb
CHANGED
|
@@ -17,11 +17,14 @@ require 'ship_engine/version'
|
|
|
17
17
|
require 'ship_engine/configuration'
|
|
18
18
|
|
|
19
19
|
# Models
|
|
20
|
+
require 'ship_engine/models/monetary_value'
|
|
20
21
|
require 'ship_engine/models/add_funds_to_carrier_request_body'
|
|
21
22
|
require 'ship_engine/models/add_funds_to_carrier_response_body'
|
|
22
23
|
require 'ship_engine/models/add_funds_to_insurance_request_body'
|
|
23
24
|
require 'ship_engine/models/add_funds_to_insurance_response_body'
|
|
25
|
+
require 'ship_engine/models/modify_batch'
|
|
24
26
|
require 'ship_engine/models/add_to_batch_request_body'
|
|
27
|
+
require 'ship_engine/models/partial_address'
|
|
25
28
|
require 'ship_engine/models/address'
|
|
26
29
|
require 'ship_engine/models/address_residential_indicator'
|
|
27
30
|
require 'ship_engine/models/address_to_validate'
|
|
@@ -39,6 +42,10 @@ require 'ship_engine/models/batch_status'
|
|
|
39
42
|
require 'ship_engine/models/batches_sort_by'
|
|
40
43
|
require 'ship_engine/models/bill_to_party'
|
|
41
44
|
require 'ship_engine/models/bulk_rate'
|
|
45
|
+
require 'ship_engine/models/rate_request_options'
|
|
46
|
+
require 'ship_engine/models/rate_request_rate_options'
|
|
47
|
+
require 'ship_engine/models/label'
|
|
48
|
+
require 'ship_engine/models/package_type'
|
|
42
49
|
require 'ship_engine/models/calculate_rates_request_body'
|
|
43
50
|
require 'ship_engine/models/calculate_rates_response_body'
|
|
44
51
|
require 'ship_engine/models/carrier'
|
|
@@ -81,6 +88,7 @@ require 'ship_engine/models/connect_ups_request_body'
|
|
|
81
88
|
require 'ship_engine/models/create_and_validate_shipment'
|
|
82
89
|
require 'ship_engine/models/create_batch_request_body'
|
|
83
90
|
require 'ship_engine/models/create_batch_response_body'
|
|
91
|
+
require 'ship_engine/models/purchase_label_without_shipment'
|
|
84
92
|
require 'ship_engine/models/create_label_from_rate_request_body'
|
|
85
93
|
require 'ship_engine/models/create_label_from_rate_response_body'
|
|
86
94
|
require 'ship_engine/models/create_label_from_shipment_request_body'
|
|
@@ -98,9 +106,12 @@ require 'ship_engine/models/create_return_label_response_body'
|
|
|
98
106
|
require 'ship_engine/models/create_shipment_response_body_fields'
|
|
99
107
|
require 'ship_engine/models/create_shipments_request_body'
|
|
100
108
|
require 'ship_engine/models/create_shipments_response_body'
|
|
109
|
+
require 'ship_engine/models/tag'
|
|
101
110
|
require 'ship_engine/models/create_tag_response_body'
|
|
111
|
+
require 'ship_engine/models/warehouse'
|
|
102
112
|
require 'ship_engine/models/create_warehouse_request_body'
|
|
103
113
|
require 'ship_engine/models/create_warehouse_response_body'
|
|
114
|
+
require 'ship_engine/models/webhook'
|
|
104
115
|
require 'ship_engine/models/create_webhook_request_body'
|
|
105
116
|
require 'ship_engine/models/create_webhook_response_body'
|
|
106
117
|
require 'ship_engine/models/currency'
|
|
@@ -116,6 +127,7 @@ require 'ship_engine/models/error_code'
|
|
|
116
127
|
require 'ship_engine/models/error_response_body'
|
|
117
128
|
require 'ship_engine/models/error_source'
|
|
118
129
|
require 'ship_engine/models/error_type'
|
|
130
|
+
require 'ship_engine/models/rate_estimate_options'
|
|
119
131
|
require 'ship_engine/models/estimate_rates_request_body'
|
|
120
132
|
require 'ship_engine/models/fedex_account_settings'
|
|
121
133
|
require 'ship_engine/models/fedex_account_settings_request_body'
|
|
@@ -130,18 +142,23 @@ require 'ship_engine/models/get_carriers_response_body'
|
|
|
130
142
|
require 'ship_engine/models/get_insurance_balance_response_body'
|
|
131
143
|
require 'ship_engine/models/get_label_by_external_shipment_id_response_body'
|
|
132
144
|
require 'ship_engine/models/get_label_by_id_response_body'
|
|
145
|
+
require 'ship_engine/models/manifest'
|
|
133
146
|
require 'ship_engine/models/get_manifest_by_id_response_body'
|
|
134
147
|
require 'ship_engine/models/get_package_type_by_id_response_body'
|
|
148
|
+
require 'ship_engine/models/rate'
|
|
135
149
|
require 'ship_engine/models/get_rate_by_id_response_body'
|
|
150
|
+
require 'ship_engine/models/partial_shipment'
|
|
151
|
+
require 'ship_engine/models/shipment'
|
|
136
152
|
require 'ship_engine/models/get_shipment_by_external_id_response_body'
|
|
137
153
|
require 'ship_engine/models/get_shipment_by_id_response_body'
|
|
154
|
+
require 'ship_engine/models/tracking_information'
|
|
155
|
+
require 'ship_engine/models/tracking_status'
|
|
138
156
|
require 'ship_engine/models/get_tracking_log_from_label_response_body'
|
|
139
157
|
require 'ship_engine/models/get_tracking_log_response_body'
|
|
140
158
|
require 'ship_engine/models/get_warehouse_by_id_response_body'
|
|
141
159
|
require 'ship_engine/models/get_webhook_by_id_response_body'
|
|
142
160
|
require 'ship_engine/models/insurance_provider'
|
|
143
161
|
require 'ship_engine/models/international_shipment_options'
|
|
144
|
-
require 'ship_engine/models/label'
|
|
145
162
|
require 'ship_engine/models/label_charge_event'
|
|
146
163
|
require 'ship_engine/models/label_download'
|
|
147
164
|
require 'ship_engine/models/label_download_type'
|
|
@@ -149,60 +166,48 @@ require 'ship_engine/models/label_format'
|
|
|
149
166
|
require 'ship_engine/models/label_layout'
|
|
150
167
|
require 'ship_engine/models/label_messages'
|
|
151
168
|
require 'ship_engine/models/label_status'
|
|
169
|
+
require 'ship_engine/models/optional_link'
|
|
152
170
|
require 'ship_engine/models/link'
|
|
153
171
|
require 'ship_engine/models/list_batch_errors_response_body'
|
|
154
172
|
require 'ship_engine/models/list_batches_response_body'
|
|
155
173
|
require 'ship_engine/models/list_carrier_package_types_response_body'
|
|
156
174
|
require 'ship_engine/models/list_carrier_services_response_body'
|
|
157
175
|
require 'ship_engine/models/list_carriers_response_body'
|
|
176
|
+
require 'ship_engine/models/paged_list_response_body'
|
|
177
|
+
require 'ship_engine/models/pagination_link'
|
|
158
178
|
require 'ship_engine/models/list_labels_response_body'
|
|
159
179
|
require 'ship_engine/models/list_manifests_response_body'
|
|
160
180
|
require 'ship_engine/models/list_package_types_response_body'
|
|
181
|
+
require 'ship_engine/models/rates_information'
|
|
161
182
|
require 'ship_engine/models/list_shipment_errors_response_body'
|
|
162
183
|
require 'ship_engine/models/list_shipment_rates_response_body'
|
|
163
184
|
require 'ship_engine/models/list_shipments_response_body'
|
|
164
185
|
require 'ship_engine/models/list_tags_response_body'
|
|
165
186
|
require 'ship_engine/models/list_warehouses_response_body'
|
|
166
|
-
require 'ship_engine/models/manifest'
|
|
167
187
|
require 'ship_engine/models/manifest_download'
|
|
168
188
|
require 'ship_engine/models/manifests'
|
|
169
|
-
require 'ship_engine/models/modify_batch'
|
|
170
|
-
require 'ship_engine/models/monetary_value'
|
|
171
189
|
require 'ship_engine/models/non_delivery'
|
|
172
|
-
require 'ship_engine/models/optional_link'
|
|
173
190
|
require 'ship_engine/models/order_source_name'
|
|
174
191
|
require 'ship_engine/models/package'
|
|
175
192
|
require 'ship_engine/models/package_contents'
|
|
176
|
-
require 'ship_engine/models/package_type'
|
|
177
|
-
require 'ship_engine/models/paged_list_response_body'
|
|
178
|
-
require 'ship_engine/models/pagination_link'
|
|
179
193
|
require 'ship_engine/models/parse_address_request_body'
|
|
180
194
|
require 'ship_engine/models/parse_address_response_body'
|
|
181
195
|
require 'ship_engine/models/parse_shipment_request_body'
|
|
182
196
|
require 'ship_engine/models/parse_shipment_response_body'
|
|
183
|
-
require 'ship_engine/models/partial_address'
|
|
184
|
-
require 'ship_engine/models/partial_shipment'
|
|
185
197
|
require 'ship_engine/models/payment_amount'
|
|
186
198
|
require 'ship_engine/models/process_batch_request_body'
|
|
187
|
-
require 'ship_engine/models/purchase_label_without_shipment'
|
|
188
|
-
require 'ship_engine/models/rate'
|
|
189
199
|
require 'ship_engine/models/rate_estimate_by_carrier_id'
|
|
190
200
|
require 'ship_engine/models/rate_estimate_by_carrier_ids'
|
|
191
|
-
require 'ship_engine/models/rate_estimate_options'
|
|
192
201
|
require 'ship_engine/models/rate_request_body'
|
|
193
202
|
require 'ship_engine/models/rate_request_by_shipment_ids'
|
|
194
203
|
require 'ship_engine/models/rate_request_by_shipments'
|
|
195
|
-
require 'ship_engine/models/rate_request_options'
|
|
196
|
-
require 'ship_engine/models/rate_request_rate_options'
|
|
197
204
|
require 'ship_engine/models/rate_response'
|
|
198
205
|
require 'ship_engine/models/rate_response_status'
|
|
199
206
|
require 'ship_engine/models/rate_type'
|
|
200
|
-
require 'ship_engine/models/rates_information'
|
|
201
207
|
require 'ship_engine/models/recognized_entity'
|
|
202
208
|
require 'ship_engine/models/remove_from_batch_request_body'
|
|
203
209
|
require 'ship_engine/models/response_message'
|
|
204
210
|
require 'ship_engine/models/service'
|
|
205
|
-
require 'ship_engine/models/shipment'
|
|
206
211
|
require 'ship_engine/models/shipment_id_request'
|
|
207
212
|
require 'ship_engine/models/shipment_item'
|
|
208
213
|
require 'ship_engine/models/shipment_request'
|
|
@@ -211,11 +216,8 @@ require 'ship_engine/models/shipment_status'
|
|
|
211
216
|
require 'ship_engine/models/shipments_sort_by'
|
|
212
217
|
require 'ship_engine/models/smart_post_hub'
|
|
213
218
|
require 'ship_engine/models/sort_dir'
|
|
214
|
-
require 'ship_engine/models/tag'
|
|
215
219
|
require 'ship_engine/models/tag_shipment_response_body'
|
|
216
220
|
require 'ship_engine/models/track_event'
|
|
217
|
-
require 'ship_engine/models/tracking_information'
|
|
218
|
-
require 'ship_engine/models/tracking_status'
|
|
219
221
|
require 'ship_engine/models/update_amazon_buy_shipping_request_body'
|
|
220
222
|
require 'ship_engine/models/update_carrier_settings_request_body'
|
|
221
223
|
require 'ship_engine/models/update_dhl_express_settings_request_body'
|
|
@@ -225,19 +227,17 @@ require 'ship_engine/models/update_package_type_request_body'
|
|
|
225
227
|
require 'ship_engine/models/update_shipment_fields'
|
|
226
228
|
require 'ship_engine/models/update_shipment_request_body'
|
|
227
229
|
require 'ship_engine/models/update_shipment_response_body'
|
|
228
|
-
require 'ship_engine/models/update_ups_settings_request_body'
|
|
229
|
-
require 'ship_engine/models/update_warehouse_request_body'
|
|
230
|
-
require 'ship_engine/models/update_webhook_request_body'
|
|
231
230
|
require 'ship_engine/models/ups_account_settings'
|
|
232
231
|
require 'ship_engine/models/ups_invoice'
|
|
233
232
|
require 'ship_engine/models/ups_pickup_type'
|
|
234
233
|
require 'ship_engine/models/ups_settings_response_body'
|
|
234
|
+
require 'ship_engine/models/update_ups_settings_request_body'
|
|
235
|
+
require 'ship_engine/models/update_warehouse_request_body'
|
|
236
|
+
require 'ship_engine/models/update_webhook_request_body'
|
|
235
237
|
require 'ship_engine/models/validate_address'
|
|
236
238
|
require 'ship_engine/models/validate_shipment_fields'
|
|
237
239
|
require 'ship_engine/models/validation_status'
|
|
238
240
|
require 'ship_engine/models/void_label_response_body'
|
|
239
|
-
require 'ship_engine/models/warehouse'
|
|
240
|
-
require 'ship_engine/models/webhook'
|
|
241
241
|
require 'ship_engine/models/webhook_event'
|
|
242
242
|
require 'ship_engine/models/weight'
|
|
243
243
|
require 'ship_engine/models/weight_unit'
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -20,8 +20,8 @@ module ShipEngine
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Parse an address
|
|
23
|
-
# The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
24
|
-
# @param parse_address_request_body [ParseAddressRequestBody] The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
23
|
+
# The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
24
|
+
# @param parse_address_request_body [ParseAddressRequestBody] The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [ParseAddressResponseBody]
|
|
27
27
|
def parse_address(parse_address_request_body, opts = {})
|
|
@@ -30,8 +30,8 @@ module ShipEngine
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Parse an address
|
|
33
|
-
# The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
34
|
-
# @param parse_address_request_body [ParseAddressRequestBody] The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
33
|
+
# The address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
34
|
+
# @param parse_address_request_body [ParseAddressRequestBody] The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(ParseAddressResponseBody, Integer, Hash)>] ParseAddressResponseBody data, response status code and response headers
|
|
37
37
|
def parse_address_with_http_info(parse_address_request_body, opts = {})
|
|
@@ -59,10 +59,10 @@ module ShipEngine
|
|
|
59
59
|
form_params = opts[:form_params] || {}
|
|
60
60
|
|
|
61
61
|
# http body (model)
|
|
62
|
-
post_body = opts[:body] || @api_client.object_to_http_body(parse_address_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(parse_address_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'ParseAddressResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'ParseAddressResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -84,8 +84,8 @@ module ShipEngine
|
|
|
84
84
|
end
|
|
85
85
|
|
|
86
86
|
# Validate An Address
|
|
87
|
-
# Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.
|
|
88
|
-
# @param address_to_validate [Array<AddressToValidate>]
|
|
87
|
+
# Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.
|
|
88
|
+
# @param address_to_validate [Array<AddressToValidate>]
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
90
|
# @return [Array<AddressValidationResult>]
|
|
91
91
|
def validate_address(address_to_validate, opts = {})
|
|
@@ -94,8 +94,8 @@ module ShipEngine
|
|
|
94
94
|
end
|
|
95
95
|
|
|
96
96
|
# Validate An Address
|
|
97
|
-
# Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.
|
|
98
|
-
# @param address_to_validate [Array<AddressToValidate>]
|
|
97
|
+
# Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.
|
|
98
|
+
# @param address_to_validate [Array<AddressToValidate>]
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
100
|
# @return [Array<(Array<AddressValidationResult>, Integer, Hash)>] Array<AddressValidationResult> data, response status code and response headers
|
|
101
101
|
def validate_address_with_http_info(address_to_validate, opts = {})
|
|
@@ -123,10 +123,10 @@ module ShipEngine
|
|
|
123
123
|
form_params = opts[:form_params] || {}
|
|
124
124
|
|
|
125
125
|
# http body (model)
|
|
126
|
-
post_body = opts[:body] || @api_client.object_to_http_body(address_to_validate)
|
|
126
|
+
post_body = opts[:body] || @api_client.object_to_http_body(address_to_validate)
|
|
127
127
|
|
|
128
128
|
# return_type
|
|
129
|
-
return_type = opts[:return_type] || 'Array<AddressValidationResult>'
|
|
129
|
+
return_type = opts[:return_type] || 'Array<AddressValidationResult>'
|
|
130
130
|
|
|
131
131
|
# auth_names
|
|
132
132
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#ShipEngine API
|
|
3
3
|
|
|
4
|
-
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
4
|
+
#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices. Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service. ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips. Here are some step-by-step **tutorials** to get you started: - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/) - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/) - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/) - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/) ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/). ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is. ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info. ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.1.202006302006
|
|
7
7
|
Contact: sales@shipengine.com
|
|
@@ -22,7 +22,7 @@ module ShipEngine
|
|
|
22
22
|
# Add to a Batch
|
|
23
23
|
# Add a Shipment or Rate to a Batch
|
|
24
24
|
# @param batch_id [String] Batch ID
|
|
25
|
-
# @param add_to_batch_request_body [AddToBatchRequestBody]
|
|
25
|
+
# @param add_to_batch_request_body [AddToBatchRequestBody]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [String]
|
|
28
28
|
def add_to_batch(batch_id, add_to_batch_request_body, opts = {})
|
|
@@ -33,7 +33,7 @@ module ShipEngine
|
|
|
33
33
|
# Add to a Batch
|
|
34
34
|
# Add a Shipment or Rate to a Batch
|
|
35
35
|
# @param batch_id [String] Batch ID
|
|
36
|
-
# @param add_to_batch_request_body [AddToBatchRequestBody]
|
|
36
|
+
# @param add_to_batch_request_body [AddToBatchRequestBody]
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
39
39
|
def add_to_batch_with_http_info(batch_id, add_to_batch_request_body, opts = {})
|
|
@@ -78,10 +78,10 @@ module ShipEngine
|
|
|
78
78
|
form_params = opts[:form_params] || {}
|
|
79
79
|
|
|
80
80
|
# http body (model)
|
|
81
|
-
post_body = opts[:body] || @api_client.object_to_http_body(add_to_batch_request_body)
|
|
81
|
+
post_body = opts[:body] || @api_client.object_to_http_body(add_to_batch_request_body)
|
|
82
82
|
|
|
83
83
|
# return_type
|
|
84
|
-
return_type = opts[:return_type] || 'String'
|
|
84
|
+
return_type = opts[:return_type] || 'String'
|
|
85
85
|
|
|
86
86
|
# auth_names
|
|
87
87
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -104,7 +104,7 @@ module ShipEngine
|
|
|
104
104
|
|
|
105
105
|
# Create A Batch
|
|
106
106
|
# Create a Batch
|
|
107
|
-
# @param create_batch_request_body [CreateBatchRequestBody]
|
|
107
|
+
# @param create_batch_request_body [CreateBatchRequestBody]
|
|
108
108
|
# @param [Hash] opts the optional parameters
|
|
109
109
|
# @return [CreateBatchResponseBody]
|
|
110
110
|
def create_batch(create_batch_request_body, opts = {})
|
|
@@ -114,7 +114,7 @@ module ShipEngine
|
|
|
114
114
|
|
|
115
115
|
# Create A Batch
|
|
116
116
|
# Create a Batch
|
|
117
|
-
# @param create_batch_request_body [CreateBatchRequestBody]
|
|
117
|
+
# @param create_batch_request_body [CreateBatchRequestBody]
|
|
118
118
|
# @param [Hash] opts the optional parameters
|
|
119
119
|
# @return [Array<(CreateBatchResponseBody, Integer, Hash)>] CreateBatchResponseBody data, response status code and response headers
|
|
120
120
|
def create_batch_with_http_info(create_batch_request_body, opts = {})
|
|
@@ -142,10 +142,10 @@ module ShipEngine
|
|
|
142
142
|
form_params = opts[:form_params] || {}
|
|
143
143
|
|
|
144
144
|
# http body (model)
|
|
145
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_batch_request_body)
|
|
145
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_batch_request_body)
|
|
146
146
|
|
|
147
147
|
# return_type
|
|
148
|
-
return_type = opts[:return_type] || 'CreateBatchResponseBody'
|
|
148
|
+
return_type = opts[:return_type] || 'CreateBatchResponseBody'
|
|
149
149
|
|
|
150
150
|
# auth_names
|
|
151
151
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -217,10 +217,10 @@ module ShipEngine
|
|
|
217
217
|
form_params = opts[:form_params] || {}
|
|
218
218
|
|
|
219
219
|
# http body (model)
|
|
220
|
-
post_body = opts[:body]
|
|
220
|
+
post_body = opts[:body]
|
|
221
221
|
|
|
222
222
|
# return_type
|
|
223
|
-
return_type = opts[:return_type] || 'String'
|
|
223
|
+
return_type = opts[:return_type] || 'String'
|
|
224
224
|
|
|
225
225
|
# auth_names
|
|
226
226
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -243,7 +243,7 @@ module ShipEngine
|
|
|
243
243
|
|
|
244
244
|
# Get Batch By External ID
|
|
245
245
|
# Get Batch By External ID
|
|
246
|
-
# @param external_batch_id [String]
|
|
246
|
+
# @param external_batch_id [String]
|
|
247
247
|
# @param [Hash] opts the optional parameters
|
|
248
248
|
# @return [GetBatchByExternalIdResponseBody]
|
|
249
249
|
def get_batch_by_external_id(external_batch_id, opts = {})
|
|
@@ -253,7 +253,7 @@ module ShipEngine
|
|
|
253
253
|
|
|
254
254
|
# Get Batch By External ID
|
|
255
255
|
# Get Batch By External ID
|
|
256
|
-
# @param external_batch_id [String]
|
|
256
|
+
# @param external_batch_id [String]
|
|
257
257
|
# @param [Hash] opts the optional parameters
|
|
258
258
|
# @return [Array<(GetBatchByExternalIdResponseBody, Integer, Hash)>] GetBatchByExternalIdResponseBody data, response status code and response headers
|
|
259
259
|
def get_batch_by_external_id_with_http_info(external_batch_id, opts = {})
|
|
@@ -279,10 +279,10 @@ module ShipEngine
|
|
|
279
279
|
form_params = opts[:form_params] || {}
|
|
280
280
|
|
|
281
281
|
# http body (model)
|
|
282
|
-
post_body = opts[:body]
|
|
282
|
+
post_body = opts[:body]
|
|
283
283
|
|
|
284
284
|
# return_type
|
|
285
|
-
return_type = opts[:return_type] || 'GetBatchByExternalIdResponseBody'
|
|
285
|
+
return_type = opts[:return_type] || 'GetBatchByExternalIdResponseBody'
|
|
286
286
|
|
|
287
287
|
# auth_names
|
|
288
288
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -354,10 +354,10 @@ module ShipEngine
|
|
|
354
354
|
form_params = opts[:form_params] || {}
|
|
355
355
|
|
|
356
356
|
# http body (model)
|
|
357
|
-
post_body = opts[:body]
|
|
357
|
+
post_body = opts[:body]
|
|
358
358
|
|
|
359
359
|
# return_type
|
|
360
|
-
return_type = opts[:return_type] || 'GetBatchByIdResponseBody'
|
|
360
|
+
return_type = opts[:return_type] || 'GetBatchByIdResponseBody'
|
|
361
361
|
|
|
362
362
|
# auth_names
|
|
363
363
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -379,11 +379,11 @@ module ShipEngine
|
|
|
379
379
|
end
|
|
380
380
|
|
|
381
381
|
# Get Batch Errors
|
|
382
|
-
# Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
382
|
+
# Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
383
383
|
# @param batch_id [String] Batch ID
|
|
384
384
|
# @param [Hash] opts the optional parameters
|
|
385
385
|
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. (default to 1)
|
|
386
|
-
# @option opts [Integer] :pagesize
|
|
386
|
+
# @option opts [Integer] :pagesize
|
|
387
387
|
# @return [ListBatchErrorsResponseBody]
|
|
388
388
|
def list_batch_errors(batch_id, opts = {})
|
|
389
389
|
data, _status_code, _headers = list_batch_errors_with_http_info(batch_id, opts)
|
|
@@ -391,11 +391,11 @@ module ShipEngine
|
|
|
391
391
|
end
|
|
392
392
|
|
|
393
393
|
# Get Batch Errors
|
|
394
|
-
# Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
394
|
+
# Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
395
395
|
# @param batch_id [String] Batch ID
|
|
396
396
|
# @param [Hash] opts the optional parameters
|
|
397
|
-
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
398
|
-
# @option opts [Integer] :pagesize
|
|
397
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
398
|
+
# @option opts [Integer] :pagesize
|
|
399
399
|
# @return [Array<(ListBatchErrorsResponseBody, Integer, Hash)>] ListBatchErrorsResponseBody data, response status code and response headers
|
|
400
400
|
def list_batch_errors_with_http_info(batch_id, opts = {})
|
|
401
401
|
if @api_client.config.debugging
|
|
@@ -443,10 +443,10 @@ module ShipEngine
|
|
|
443
443
|
form_params = opts[:form_params] || {}
|
|
444
444
|
|
|
445
445
|
# http body (model)
|
|
446
|
-
post_body = opts[:body]
|
|
446
|
+
post_body = opts[:body]
|
|
447
447
|
|
|
448
448
|
# return_type
|
|
449
|
-
return_type = opts[:return_type] || 'ListBatchErrorsResponseBody'
|
|
449
|
+
return_type = opts[:return_type] || 'ListBatchErrorsResponseBody'
|
|
450
450
|
|
|
451
451
|
# auth_names
|
|
452
452
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -470,11 +470,11 @@ module ShipEngine
|
|
|
470
470
|
# List Batches
|
|
471
471
|
# List Batches associated with your Shipengine account
|
|
472
472
|
# @param [Hash] opts the optional parameters
|
|
473
|
-
# @option opts [BatchStatus] :status
|
|
473
|
+
# @option opts [BatchStatus] :status
|
|
474
474
|
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. (default to 1)
|
|
475
475
|
# @option opts [Integer] :page_size The number of results to return per response. (default to 25)
|
|
476
476
|
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
|
477
|
-
# @option opts [BatchesSortBy] :sort_by
|
|
477
|
+
# @option opts [BatchesSortBy] :sort_by
|
|
478
478
|
# @return [ListBatchesResponseBody]
|
|
479
479
|
def list_batches(opts = {})
|
|
480
480
|
data, _status_code, _headers = list_batches_with_http_info(opts)
|
|
@@ -484,11 +484,11 @@ module ShipEngine
|
|
|
484
484
|
# List Batches
|
|
485
485
|
# List Batches associated with your Shipengine account
|
|
486
486
|
# @param [Hash] opts the optional parameters
|
|
487
|
-
# @option opts [BatchStatus] :status
|
|
488
|
-
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
487
|
+
# @option opts [BatchStatus] :status
|
|
488
|
+
# @option opts [Integer] :page Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
489
489
|
# @option opts [Integer] :page_size The number of results to return per response.
|
|
490
490
|
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
|
491
|
-
# @option opts [BatchesSortBy] :sort_by
|
|
491
|
+
# @option opts [BatchesSortBy] :sort_by
|
|
492
492
|
# @return [Array<(ListBatchesResponseBody, Integer, Hash)>] ListBatchesResponseBody data, response status code and response headers
|
|
493
493
|
def list_batches_with_http_info(opts = {})
|
|
494
494
|
if @api_client.config.debugging
|
|
@@ -522,10 +522,10 @@ module ShipEngine
|
|
|
522
522
|
form_params = opts[:form_params] || {}
|
|
523
523
|
|
|
524
524
|
# http body (model)
|
|
525
|
-
post_body = opts[:body]
|
|
525
|
+
post_body = opts[:body]
|
|
526
526
|
|
|
527
527
|
# return_type
|
|
528
|
-
return_type = opts[:return_type] || 'ListBatchesResponseBody'
|
|
528
|
+
return_type = opts[:return_type] || 'ListBatchesResponseBody'
|
|
529
529
|
|
|
530
530
|
# auth_names
|
|
531
531
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -549,7 +549,7 @@ module ShipEngine
|
|
|
549
549
|
# Process Batch ID Labels
|
|
550
550
|
# Process Batch ID Labels
|
|
551
551
|
# @param batch_id [String] Batch ID
|
|
552
|
-
# @param process_batch_request_body [ProcessBatchRequestBody]
|
|
552
|
+
# @param process_batch_request_body [ProcessBatchRequestBody]
|
|
553
553
|
# @param [Hash] opts the optional parameters
|
|
554
554
|
# @return [String]
|
|
555
555
|
def process_batch(batch_id, process_batch_request_body, opts = {})
|
|
@@ -560,7 +560,7 @@ module ShipEngine
|
|
|
560
560
|
# Process Batch ID Labels
|
|
561
561
|
# Process Batch ID Labels
|
|
562
562
|
# @param batch_id [String] Batch ID
|
|
563
|
-
# @param process_batch_request_body [ProcessBatchRequestBody]
|
|
563
|
+
# @param process_batch_request_body [ProcessBatchRequestBody]
|
|
564
564
|
# @param [Hash] opts the optional parameters
|
|
565
565
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
566
566
|
def process_batch_with_http_info(batch_id, process_batch_request_body, opts = {})
|
|
@@ -605,10 +605,10 @@ module ShipEngine
|
|
|
605
605
|
form_params = opts[:form_params] || {}
|
|
606
606
|
|
|
607
607
|
# http body (model)
|
|
608
|
-
post_body = opts[:body] || @api_client.object_to_http_body(process_batch_request_body)
|
|
608
|
+
post_body = opts[:body] || @api_client.object_to_http_body(process_batch_request_body)
|
|
609
609
|
|
|
610
610
|
# return_type
|
|
611
|
-
return_type = opts[:return_type] || 'String'
|
|
611
|
+
return_type = opts[:return_type] || 'String'
|
|
612
612
|
|
|
613
613
|
# auth_names
|
|
614
614
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -632,7 +632,7 @@ module ShipEngine
|
|
|
632
632
|
# Remove From Batch
|
|
633
633
|
# Remove a shipment or rate from a batch
|
|
634
634
|
# @param batch_id [String] Batch ID
|
|
635
|
-
# @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
|
|
635
|
+
# @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
|
|
636
636
|
# @param [Hash] opts the optional parameters
|
|
637
637
|
# @return [String]
|
|
638
638
|
def remove_from_batch(batch_id, remove_from_batch_request_body, opts = {})
|
|
@@ -643,7 +643,7 @@ module ShipEngine
|
|
|
643
643
|
# Remove From Batch
|
|
644
644
|
# Remove a shipment or rate from a batch
|
|
645
645
|
# @param batch_id [String] Batch ID
|
|
646
|
-
# @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
|
|
646
|
+
# @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
|
|
647
647
|
# @param [Hash] opts the optional parameters
|
|
648
648
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
649
649
|
def remove_from_batch_with_http_info(batch_id, remove_from_batch_request_body, opts = {})
|
|
@@ -688,10 +688,10 @@ module ShipEngine
|
|
|
688
688
|
form_params = opts[:form_params] || {}
|
|
689
689
|
|
|
690
690
|
# http body (model)
|
|
691
|
-
post_body = opts[:body] || @api_client.object_to_http_body(remove_from_batch_request_body)
|
|
691
|
+
post_body = opts[:body] || @api_client.object_to_http_body(remove_from_batch_request_body)
|
|
692
692
|
|
|
693
693
|
# return_type
|
|
694
|
-
return_type = opts[:return_type] || 'String'
|
|
694
|
+
return_type = opts[:return_type] || 'String'
|
|
695
695
|
|
|
696
696
|
# auth_names
|
|
697
697
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -763,10 +763,10 @@ module ShipEngine
|
|
|
763
763
|
form_params = opts[:form_params] || {}
|
|
764
764
|
|
|
765
765
|
# http body (model)
|
|
766
|
-
post_body = opts[:body]
|
|
766
|
+
post_body = opts[:body]
|
|
767
767
|
|
|
768
768
|
# return_type
|
|
769
|
-
return_type = opts[:return_type] || 'String'
|
|
769
|
+
return_type = opts[:return_type] || 'String'
|
|
770
770
|
|
|
771
771
|
# auth_names
|
|
772
772
|
auth_names = opts[:auth_names] || ['api_key']
|