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
|
@@ -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
|
# Connect a carrier account
|
|
23
23
|
# Connect a carrier account
|
|
24
24
|
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
|
25
|
-
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
|
25
|
+
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [ConnectCarrierResponseBody]
|
|
28
28
|
def connect_carrier(carrier_name, connect_carrier_request_body, opts = {})
|
|
@@ -33,7 +33,7 @@ module ShipEngine
|
|
|
33
33
|
# Connect a carrier account
|
|
34
34
|
# Connect a carrier account
|
|
35
35
|
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
|
36
|
-
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
|
36
|
+
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(ConnectCarrierResponseBody, Integer, Hash)>] ConnectCarrierResponseBody data, response status code and response headers
|
|
39
39
|
def connect_carrier_with_http_info(carrier_name, connect_carrier_request_body, opts = {})
|
|
@@ -65,10 +65,10 @@ module ShipEngine
|
|
|
65
65
|
form_params = opts[:form_params] || {}
|
|
66
66
|
|
|
67
67
|
# http body (model)
|
|
68
|
-
post_body = opts[:body] || @api_client.object_to_http_body(connect_carrier_request_body)
|
|
68
|
+
post_body = opts[:body] || @api_client.object_to_http_body(connect_carrier_request_body)
|
|
69
69
|
|
|
70
70
|
# return_type
|
|
71
|
-
return_type = opts[:return_type] || 'ConnectCarrierResponseBody'
|
|
71
|
+
return_type = opts[:return_type] || 'ConnectCarrierResponseBody'
|
|
72
72
|
|
|
73
73
|
# auth_names
|
|
74
74
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -146,10 +146,10 @@ module ShipEngine
|
|
|
146
146
|
form_params = opts[:form_params] || {}
|
|
147
147
|
|
|
148
148
|
# http body (model)
|
|
149
|
-
post_body = opts[:body]
|
|
149
|
+
post_body = opts[:body]
|
|
150
150
|
|
|
151
151
|
# return_type
|
|
152
|
-
return_type = opts[:return_type] || 'String'
|
|
152
|
+
return_type = opts[:return_type] || 'String'
|
|
153
153
|
|
|
154
154
|
# auth_names
|
|
155
155
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -227,10 +227,10 @@ module ShipEngine
|
|
|
227
227
|
form_params = opts[:form_params] || {}
|
|
228
228
|
|
|
229
229
|
# http body (model)
|
|
230
|
-
post_body = opts[:body]
|
|
230
|
+
post_body = opts[:body]
|
|
231
231
|
|
|
232
232
|
# return_type
|
|
233
|
-
return_type = opts[:return_type] || 'GetCarrierSettingsResponseBody'
|
|
233
|
+
return_type = opts[:return_type] || 'GetCarrierSettingsResponseBody'
|
|
234
234
|
|
|
235
235
|
# auth_names
|
|
236
236
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -255,7 +255,7 @@ module ShipEngine
|
|
|
255
255
|
# Update carrier settings
|
|
256
256
|
# @param carrier_name [CarrierNameWithSettings] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
|
257
257
|
# @param carrier_id [String] Carrier ID
|
|
258
|
-
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
|
258
|
+
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
|
259
259
|
# @param [Hash] opts the optional parameters
|
|
260
260
|
# @return [String]
|
|
261
261
|
def update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body, opts = {})
|
|
@@ -267,7 +267,7 @@ module ShipEngine
|
|
|
267
267
|
# Update carrier settings
|
|
268
268
|
# @param carrier_name [CarrierNameWithSettings] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
|
269
269
|
# @param carrier_id [String] Carrier ID
|
|
270
|
-
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
|
270
|
+
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
|
271
271
|
# @param [Hash] opts the optional parameters
|
|
272
272
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
273
273
|
def update_carrier_settings_with_http_info(carrier_name, carrier_id, update_carrier_settings_request_body, opts = {})
|
|
@@ -316,10 +316,10 @@ module ShipEngine
|
|
|
316
316
|
form_params = opts[:form_params] || {}
|
|
317
317
|
|
|
318
318
|
# http body (model)
|
|
319
|
-
post_body = opts[:body] || @api_client.object_to_http_body(update_carrier_settings_request_body)
|
|
319
|
+
post_body = opts[:body] || @api_client.object_to_http_body(update_carrier_settings_request_body)
|
|
320
320
|
|
|
321
321
|
# return_type
|
|
322
|
-
return_type = opts[:return_type] || 'String'
|
|
322
|
+
return_type = opts[:return_type] || 'String'
|
|
323
323
|
|
|
324
324
|
# auth_names
|
|
325
325
|
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 Funds To Carrier
|
|
23
23
|
# Add Funds To A Carrier
|
|
24
24
|
# @param carrier_id [String] Carrier ID
|
|
25
|
-
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
|
25
|
+
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @return [AddFundsToCarrierResponseBody]
|
|
28
28
|
def add_funds_to_carrier(carrier_id, add_funds_to_carrier_request_body, opts = {})
|
|
@@ -33,7 +33,7 @@ module ShipEngine
|
|
|
33
33
|
# Add Funds To Carrier
|
|
34
34
|
# Add Funds To A Carrier
|
|
35
35
|
# @param carrier_id [String] Carrier ID
|
|
36
|
-
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
|
36
|
+
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
|
37
37
|
# @param [Hash] opts the optional parameters
|
|
38
38
|
# @return [Array<(AddFundsToCarrierResponseBody, Integer, Hash)>] AddFundsToCarrierResponseBody data, response status code and response headers
|
|
39
39
|
def add_funds_to_carrier_with_http_info(carrier_id, add_funds_to_carrier_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_funds_to_carrier_request_body)
|
|
81
|
+
post_body = opts[:body] || @api_client.object_to_http_body(add_funds_to_carrier_request_body)
|
|
82
82
|
|
|
83
83
|
# return_type
|
|
84
|
-
return_type = opts[:return_type] || 'AddFundsToCarrierResponseBody'
|
|
84
|
+
return_type = opts[:return_type] || 'AddFundsToCarrierResponseBody'
|
|
85
85
|
|
|
86
86
|
# auth_names
|
|
87
87
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -153,10 +153,10 @@ module ShipEngine
|
|
|
153
153
|
form_params = opts[:form_params] || {}
|
|
154
154
|
|
|
155
155
|
# http body (model)
|
|
156
|
-
post_body = opts[:body]
|
|
156
|
+
post_body = opts[:body]
|
|
157
157
|
|
|
158
158
|
# return_type
|
|
159
|
-
return_type = opts[:return_type] || 'GetCarrierByIdResponseBody'
|
|
159
|
+
return_type = opts[:return_type] || 'GetCarrierByIdResponseBody'
|
|
160
160
|
|
|
161
161
|
# auth_names
|
|
162
162
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -228,10 +228,10 @@ module ShipEngine
|
|
|
228
228
|
form_params = opts[:form_params] || {}
|
|
229
229
|
|
|
230
230
|
# http body (model)
|
|
231
|
-
post_body = opts[:body]
|
|
231
|
+
post_body = opts[:body]
|
|
232
232
|
|
|
233
233
|
# return_type
|
|
234
|
-
return_type = opts[:return_type] || 'GetCarrierOptionsResponseBody'
|
|
234
|
+
return_type = opts[:return_type] || 'GetCarrierOptionsResponseBody'
|
|
235
235
|
|
|
236
236
|
# auth_names
|
|
237
237
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -303,10 +303,10 @@ module ShipEngine
|
|
|
303
303
|
form_params = opts[:form_params] || {}
|
|
304
304
|
|
|
305
305
|
# http body (model)
|
|
306
|
-
post_body = opts[:body]
|
|
306
|
+
post_body = opts[:body]
|
|
307
307
|
|
|
308
308
|
# return_type
|
|
309
|
-
return_type = opts[:return_type] || 'ListCarrierPackageTypesResponseBody'
|
|
309
|
+
return_type = opts[:return_type] || 'ListCarrierPackageTypesResponseBody'
|
|
310
310
|
|
|
311
311
|
# auth_names
|
|
312
312
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -378,10 +378,10 @@ module ShipEngine
|
|
|
378
378
|
form_params = opts[:form_params] || {}
|
|
379
379
|
|
|
380
380
|
# http body (model)
|
|
381
|
-
post_body = opts[:body]
|
|
381
|
+
post_body = opts[:body]
|
|
382
382
|
|
|
383
383
|
# return_type
|
|
384
|
-
return_type = opts[:return_type] || 'ListCarrierServicesResponseBody'
|
|
384
|
+
return_type = opts[:return_type] || 'ListCarrierServicesResponseBody'
|
|
385
385
|
|
|
386
386
|
# auth_names
|
|
387
387
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -434,10 +434,10 @@ module ShipEngine
|
|
|
434
434
|
form_params = opts[:form_params] || {}
|
|
435
435
|
|
|
436
436
|
# http body (model)
|
|
437
|
-
post_body = opts[:body]
|
|
437
|
+
post_body = opts[:body]
|
|
438
438
|
|
|
439
439
|
# return_type
|
|
440
|
-
return_type = opts[:return_type] || 'GetCarriersResponseBody'
|
|
440
|
+
return_type = opts[:return_type] || 'GetCarriersResponseBody'
|
|
441
441
|
|
|
442
442
|
# auth_names
|
|
443
443
|
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
|
|
@@ -21,11 +21,11 @@ module ShipEngine
|
|
|
21
21
|
end
|
|
22
22
|
# Download File
|
|
23
23
|
# Get File
|
|
24
|
-
# @param subdir [String]
|
|
25
|
-
# @param filename [String]
|
|
26
|
-
# @param dir [String]
|
|
24
|
+
# @param subdir [String]
|
|
25
|
+
# @param filename [String]
|
|
26
|
+
# @param dir [String]
|
|
27
27
|
# @param [Hash] opts the optional parameters
|
|
28
|
-
# @option opts [String] :download
|
|
28
|
+
# @option opts [String] :download
|
|
29
29
|
# @return [File]
|
|
30
30
|
def download_file(subdir, filename, dir, opts = {})
|
|
31
31
|
data, _status_code, _headers = download_file_with_http_info(subdir, filename, dir, opts)
|
|
@@ -34,11 +34,11 @@ module ShipEngine
|
|
|
34
34
|
|
|
35
35
|
# Download File
|
|
36
36
|
# Get File
|
|
37
|
-
# @param subdir [String]
|
|
38
|
-
# @param filename [String]
|
|
39
|
-
# @param dir [String]
|
|
37
|
+
# @param subdir [String]
|
|
38
|
+
# @param filename [String]
|
|
39
|
+
# @param dir [String]
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
|
-
# @option opts [String] :download
|
|
41
|
+
# @option opts [String] :download
|
|
42
42
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
43
43
|
def download_file_with_http_info(subdir, filename, dir, opts = {})
|
|
44
44
|
if @api_client.config.debugging
|
|
@@ -72,10 +72,10 @@ module ShipEngine
|
|
|
72
72
|
form_params = opts[:form_params] || {}
|
|
73
73
|
|
|
74
74
|
# http body (model)
|
|
75
|
-
post_body = opts[:body]
|
|
75
|
+
post_body = opts[:body]
|
|
76
76
|
|
|
77
77
|
# return_type
|
|
78
|
-
return_type = opts[:return_type] || 'File'
|
|
78
|
+
return_type = opts[:return_type] || 'File'
|
|
79
79
|
|
|
80
80
|
# auth_names
|
|
81
81
|
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
|
|
@@ -20,8 +20,8 @@ module ShipEngine
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add Funds To Insurance
|
|
23
|
-
# You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.
|
|
24
|
-
# @param add_funds_to_insurance_request_body [AddFundsToInsuranceRequestBody]
|
|
23
|
+
# You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.
|
|
24
|
+
# @param add_funds_to_insurance_request_body [AddFundsToInsuranceRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [AddFundsToInsuranceResponseBody]
|
|
27
27
|
def add_funds_to_insurance(add_funds_to_insurance_request_body, opts = {})
|
|
@@ -30,8 +30,8 @@ module ShipEngine
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Add Funds To Insurance
|
|
33
|
-
# You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.
|
|
34
|
-
# @param add_funds_to_insurance_request_body [AddFundsToInsuranceRequestBody]
|
|
33
|
+
# You may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance rather than keeping the account funded.
|
|
34
|
+
# @param add_funds_to_insurance_request_body [AddFundsToInsuranceRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(AddFundsToInsuranceResponseBody, Integer, Hash)>] AddFundsToInsuranceResponseBody data, response status code and response headers
|
|
37
37
|
def add_funds_to_insurance_with_http_info(add_funds_to_insurance_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(add_funds_to_insurance_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(add_funds_to_insurance_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'AddFundsToInsuranceResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'AddFundsToInsuranceResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -85,7 +85,7 @@ module ShipEngine
|
|
|
85
85
|
|
|
86
86
|
# Connect a Shipsurance Account
|
|
87
87
|
# Connect a Shipsurance Account
|
|
88
|
-
# @param connect_insurer_request_body [ConnectInsurerRequestBody]
|
|
88
|
+
# @param connect_insurer_request_body [ConnectInsurerRequestBody]
|
|
89
89
|
# @param [Hash] opts the optional parameters
|
|
90
90
|
# @return [Object]
|
|
91
91
|
def connect_insurer(connect_insurer_request_body, opts = {})
|
|
@@ -95,7 +95,7 @@ module ShipEngine
|
|
|
95
95
|
|
|
96
96
|
# Connect a Shipsurance Account
|
|
97
97
|
# Connect a Shipsurance Account
|
|
98
|
-
# @param connect_insurer_request_body [ConnectInsurerRequestBody]
|
|
98
|
+
# @param connect_insurer_request_body [ConnectInsurerRequestBody]
|
|
99
99
|
# @param [Hash] opts the optional parameters
|
|
100
100
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
|
101
101
|
def connect_insurer_with_http_info(connect_insurer_request_body, 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(connect_insurer_request_body)
|
|
126
|
+
post_body = opts[:body] || @api_client.object_to_http_body(connect_insurer_request_body)
|
|
127
127
|
|
|
128
128
|
# return_type
|
|
129
|
-
return_type = opts[:return_type] || 'Object'
|
|
129
|
+
return_type = opts[:return_type] || 'Object'
|
|
130
130
|
|
|
131
131
|
# auth_names
|
|
132
132
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -179,10 +179,10 @@ module ShipEngine
|
|
|
179
179
|
form_params = opts[:form_params] || {}
|
|
180
180
|
|
|
181
181
|
# http body (model)
|
|
182
|
-
post_body = opts[:body]
|
|
182
|
+
post_body = opts[:body]
|
|
183
183
|
|
|
184
184
|
# return_type
|
|
185
|
-
return_type = opts[:return_type] || 'Object'
|
|
185
|
+
return_type = opts[:return_type] || 'Object'
|
|
186
186
|
|
|
187
187
|
# auth_names
|
|
188
188
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -235,10 +235,10 @@ module ShipEngine
|
|
|
235
235
|
form_params = opts[:form_params] || {}
|
|
236
236
|
|
|
237
237
|
# http body (model)
|
|
238
|
-
post_body = opts[:body]
|
|
238
|
+
post_body = opts[:body]
|
|
239
239
|
|
|
240
240
|
# return_type
|
|
241
|
-
return_type = opts[:return_type] || 'GetInsuranceBalanceResponseBody'
|
|
241
|
+
return_type = opts[:return_type] || 'GetInsuranceBalanceResponseBody'
|
|
242
242
|
|
|
243
243
|
# auth_names
|
|
244
244
|
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
|
|
@@ -21,7 +21,7 @@ module ShipEngine
|
|
|
21
21
|
end
|
|
22
22
|
# Purchase Label
|
|
23
23
|
# Purchase and print a label for shipment
|
|
24
|
-
# @param create_label_request_body [CreateLabelRequestBody]
|
|
24
|
+
# @param create_label_request_body [CreateLabelRequestBody]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [CreateLabelResponseBody]
|
|
27
27
|
def create_label(create_label_request_body, opts = {})
|
|
@@ -31,7 +31,7 @@ module ShipEngine
|
|
|
31
31
|
|
|
32
32
|
# Purchase Label
|
|
33
33
|
# Purchase and print a label for shipment
|
|
34
|
-
# @param create_label_request_body [CreateLabelRequestBody]
|
|
34
|
+
# @param create_label_request_body [CreateLabelRequestBody]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(CreateLabelResponseBody, Integer, Hash)>] CreateLabelResponseBody data, response status code and response headers
|
|
37
37
|
def create_label_with_http_info(create_label_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(create_label_request_body)
|
|
62
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_label_request_body)
|
|
63
63
|
|
|
64
64
|
# return_type
|
|
65
|
-
return_type = opts[:return_type] || 'CreateLabelResponseBody'
|
|
65
|
+
return_type = opts[:return_type] || 'CreateLabelResponseBody'
|
|
66
66
|
|
|
67
67
|
# auth_names
|
|
68
68
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -84,9 +84,9 @@ module ShipEngine
|
|
|
84
84
|
end
|
|
85
85
|
|
|
86
86
|
# Purchase Label with Rate ID
|
|
87
|
-
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
|
87
|
+
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
|
88
88
|
# @param rate_id [String] Rate ID
|
|
89
|
-
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
|
89
|
+
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @return [CreateLabelFromRateResponseBody]
|
|
92
92
|
def create_label_from_rate(rate_id, create_label_from_rate_request_body, opts = {})
|
|
@@ -95,9 +95,9 @@ module ShipEngine
|
|
|
95
95
|
end
|
|
96
96
|
|
|
97
97
|
# Purchase Label with Rate ID
|
|
98
|
-
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
|
98
|
+
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
|
99
99
|
# @param rate_id [String] Rate ID
|
|
100
|
-
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
|
100
|
+
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
|
101
101
|
# @param [Hash] opts the optional parameters
|
|
102
102
|
# @return [Array<(CreateLabelFromRateResponseBody, Integer, Hash)>] CreateLabelFromRateResponseBody data, response status code and response headers
|
|
103
103
|
def create_label_from_rate_with_http_info(rate_id, create_label_from_rate_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_label_from_rate_request_body)
|
|
145
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_label_from_rate_request_body)
|
|
146
146
|
|
|
147
147
|
# return_type
|
|
148
|
-
return_type = opts[:return_type] || 'CreateLabelFromRateResponseBody'
|
|
148
|
+
return_type = opts[:return_type] || 'CreateLabelFromRateResponseBody'
|
|
149
149
|
|
|
150
150
|
# auth_names
|
|
151
151
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -167,9 +167,9 @@ module ShipEngine
|
|
|
167
167
|
end
|
|
168
168
|
|
|
169
169
|
# Purchase Label with Shipment ID
|
|
170
|
-
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
170
|
+
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
171
171
|
# @param shipment_id [String] Shipment ID
|
|
172
|
-
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
|
172
|
+
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
|
173
173
|
# @param [Hash] opts the optional parameters
|
|
174
174
|
# @return [CreateLabelFromShipmentResponseBody]
|
|
175
175
|
def create_label_from_shipment(shipment_id, create_label_from_shipment_request_body, opts = {})
|
|
@@ -178,9 +178,9 @@ module ShipEngine
|
|
|
178
178
|
end
|
|
179
179
|
|
|
180
180
|
# Purchase Label with Shipment ID
|
|
181
|
-
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
181
|
+
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
182
182
|
# @param shipment_id [String] Shipment ID
|
|
183
|
-
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
|
183
|
+
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
|
184
184
|
# @param [Hash] opts the optional parameters
|
|
185
185
|
# @return [Array<(CreateLabelFromShipmentResponseBody, Integer, Hash)>] CreateLabelFromShipmentResponseBody data, response status code and response headers
|
|
186
186
|
def create_label_from_shipment_with_http_info(shipment_id, create_label_from_shipment_request_body, opts = {})
|
|
@@ -225,10 +225,10 @@ module ShipEngine
|
|
|
225
225
|
form_params = opts[:form_params] || {}
|
|
226
226
|
|
|
227
227
|
# http body (model)
|
|
228
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_label_from_shipment_request_body)
|
|
228
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_label_from_shipment_request_body)
|
|
229
229
|
|
|
230
230
|
# return_type
|
|
231
|
-
return_type = opts[:return_type] || 'CreateLabelFromShipmentResponseBody'
|
|
231
|
+
return_type = opts[:return_type] || 'CreateLabelFromShipmentResponseBody'
|
|
232
232
|
|
|
233
233
|
# auth_names
|
|
234
234
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -252,7 +252,7 @@ module ShipEngine
|
|
|
252
252
|
# Create a return label
|
|
253
253
|
# Create a return label
|
|
254
254
|
# @param label_id [String] Label ID
|
|
255
|
-
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
|
255
|
+
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
|
256
256
|
# @param [Hash] opts the optional parameters
|
|
257
257
|
# @return [CreateReturnLabelResponseBody]
|
|
258
258
|
def create_return_label(label_id, create_return_label_request_body, opts = {})
|
|
@@ -263,7 +263,7 @@ module ShipEngine
|
|
|
263
263
|
# Create a return label
|
|
264
264
|
# Create a return label
|
|
265
265
|
# @param label_id [String] Label ID
|
|
266
|
-
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
|
266
|
+
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
|
267
267
|
# @param [Hash] opts the optional parameters
|
|
268
268
|
# @return [Array<(CreateReturnLabelResponseBody, Integer, Hash)>] CreateReturnLabelResponseBody data, response status code and response headers
|
|
269
269
|
def create_return_label_with_http_info(label_id, create_return_label_request_body, opts = {})
|
|
@@ -308,10 +308,10 @@ module ShipEngine
|
|
|
308
308
|
form_params = opts[:form_params] || {}
|
|
309
309
|
|
|
310
310
|
# http body (model)
|
|
311
|
-
post_body = opts[:body] || @api_client.object_to_http_body(create_return_label_request_body)
|
|
311
|
+
post_body = opts[:body] || @api_client.object_to_http_body(create_return_label_request_body)
|
|
312
312
|
|
|
313
313
|
# return_type
|
|
314
|
-
return_type = opts[:return_type] || 'CreateReturnLabelResponseBody'
|
|
314
|
+
return_type = opts[:return_type] || 'CreateReturnLabelResponseBody'
|
|
315
315
|
|
|
316
316
|
# auth_names
|
|
317
317
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -333,10 +333,10 @@ module ShipEngine
|
|
|
333
333
|
end
|
|
334
334
|
|
|
335
335
|
# Get Label By External Shipment ID
|
|
336
|
-
# Find a label by using the external shipment id that was used during label creation
|
|
337
|
-
# @param external_shipment_id [String]
|
|
336
|
+
# Find a label by using the external shipment id that was used during label creation
|
|
337
|
+
# @param external_shipment_id [String]
|
|
338
338
|
# @param [Hash] opts the optional parameters
|
|
339
|
-
# @option opts [LabelDownloadType] :label_download_type
|
|
339
|
+
# @option opts [LabelDownloadType] :label_download_type
|
|
340
340
|
# @return [GetLabelByExternalShipmentIdResponseBody]
|
|
341
341
|
def get_label_by_external_shipment_id(external_shipment_id, opts = {})
|
|
342
342
|
data, _status_code, _headers = get_label_by_external_shipment_id_with_http_info(external_shipment_id, opts)
|
|
@@ -344,10 +344,10 @@ module ShipEngine
|
|
|
344
344
|
end
|
|
345
345
|
|
|
346
346
|
# Get Label By External Shipment ID
|
|
347
|
-
# Find a label by using the external shipment id that was used during label creation
|
|
348
|
-
# @param external_shipment_id [String]
|
|
347
|
+
# Find a label by using the external shipment id that was used during label creation
|
|
348
|
+
# @param external_shipment_id [String]
|
|
349
349
|
# @param [Hash] opts the optional parameters
|
|
350
|
-
# @option opts [LabelDownloadType] :label_download_type
|
|
350
|
+
# @option opts [LabelDownloadType] :label_download_type
|
|
351
351
|
# @return [Array<(GetLabelByExternalShipmentIdResponseBody, Integer, Hash)>] GetLabelByExternalShipmentIdResponseBody data, response status code and response headers
|
|
352
352
|
def get_label_by_external_shipment_id_with_http_info(external_shipment_id, opts = {})
|
|
353
353
|
if @api_client.config.debugging
|
|
@@ -373,10 +373,10 @@ module ShipEngine
|
|
|
373
373
|
form_params = opts[:form_params] || {}
|
|
374
374
|
|
|
375
375
|
# http body (model)
|
|
376
|
-
post_body = opts[:body]
|
|
376
|
+
post_body = opts[:body]
|
|
377
377
|
|
|
378
378
|
# return_type
|
|
379
|
-
return_type = opts[:return_type] || 'GetLabelByExternalShipmentIdResponseBody'
|
|
379
|
+
return_type = opts[:return_type] || 'GetLabelByExternalShipmentIdResponseBody'
|
|
380
380
|
|
|
381
381
|
# auth_names
|
|
382
382
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -401,7 +401,7 @@ module ShipEngine
|
|
|
401
401
|
# Retrieve information for individual labels.
|
|
402
402
|
# @param label_id [String] Label ID
|
|
403
403
|
# @param [Hash] opts the optional parameters
|
|
404
|
-
# @option opts [LabelDownloadType] :label_download_type
|
|
404
|
+
# @option opts [LabelDownloadType] :label_download_type
|
|
405
405
|
# @return [GetLabelByIdResponseBody]
|
|
406
406
|
def get_label_by_id(label_id, opts = {})
|
|
407
407
|
data, _status_code, _headers = get_label_by_id_with_http_info(label_id, opts)
|
|
@@ -412,7 +412,7 @@ module ShipEngine
|
|
|
412
412
|
# Retrieve information for individual labels.
|
|
413
413
|
# @param label_id [String] Label ID
|
|
414
414
|
# @param [Hash] opts the optional parameters
|
|
415
|
-
# @option opts [LabelDownloadType] :label_download_type
|
|
415
|
+
# @option opts [LabelDownloadType] :label_download_type
|
|
416
416
|
# @return [Array<(GetLabelByIdResponseBody, Integer, Hash)>] GetLabelByIdResponseBody data, response status code and response headers
|
|
417
417
|
def get_label_by_id_with_http_info(label_id, opts = {})
|
|
418
418
|
if @api_client.config.debugging
|
|
@@ -451,10 +451,10 @@ module ShipEngine
|
|
|
451
451
|
form_params = opts[:form_params] || {}
|
|
452
452
|
|
|
453
453
|
# http body (model)
|
|
454
|
-
post_body = opts[:body]
|
|
454
|
+
post_body = opts[:body]
|
|
455
455
|
|
|
456
456
|
# return_type
|
|
457
|
-
return_type = opts[:return_type] || 'GetLabelByIdResponseBody'
|
|
457
|
+
return_type = opts[:return_type] || 'GetLabelByIdResponseBody'
|
|
458
458
|
|
|
459
459
|
# auth_names
|
|
460
460
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -526,10 +526,10 @@ module ShipEngine
|
|
|
526
526
|
form_params = opts[:form_params] || {}
|
|
527
527
|
|
|
528
528
|
# http body (model)
|
|
529
|
-
post_body = opts[:body]
|
|
529
|
+
post_body = opts[:body]
|
|
530
530
|
|
|
531
531
|
# return_type
|
|
532
|
-
return_type = opts[:return_type] || 'GetTrackingLogFromLabelResponseBody'
|
|
532
|
+
return_type = opts[:return_type] || 'GetTrackingLogFromLabelResponseBody'
|
|
533
533
|
|
|
534
534
|
# auth_names
|
|
535
535
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -551,7 +551,7 @@ module ShipEngine
|
|
|
551
551
|
end
|
|
552
552
|
|
|
553
553
|
# List labels
|
|
554
|
-
# This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`
|
|
554
|
+
# This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`
|
|
555
555
|
# @param [Hash] opts the optional parameters
|
|
556
556
|
# @option opts [LabelStatus] :label_status Only return labels that are currently in the specified status
|
|
557
557
|
# @option opts [String] :service_code Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
|
|
@@ -574,7 +574,7 @@ module ShipEngine
|
|
|
574
574
|
end
|
|
575
575
|
|
|
576
576
|
# List labels
|
|
577
|
-
# This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`
|
|
577
|
+
# This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`
|
|
578
578
|
# @param [Hash] opts the optional parameters
|
|
579
579
|
# @option opts [LabelStatus] :label_status Only return labels that are currently in the specified status
|
|
580
580
|
# @option opts [String] :service_code Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
|
|
@@ -586,7 +586,7 @@ module ShipEngine
|
|
|
586
586
|
# @option opts [String] :warehouse_id Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)
|
|
587
587
|
# @option opts [DateTime] :created_at_start Only return labels that were created on or after a specific date/time
|
|
588
588
|
# @option opts [DateTime] :created_at_end Only return labels that were created on or before a specific date/time
|
|
589
|
-
# @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.
|
|
589
|
+
# @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.
|
|
590
590
|
# @option opts [Integer] :page_size The number of results to return per response.
|
|
591
591
|
# @option opts [SortDir] :sort_dir Controls the sort order of the query.
|
|
592
592
|
# @option opts [String] :sort_by Controls which field the query is sorted by.
|
|
@@ -710,10 +710,10 @@ module ShipEngine
|
|
|
710
710
|
form_params = opts[:form_params] || {}
|
|
711
711
|
|
|
712
712
|
# http body (model)
|
|
713
|
-
post_body = opts[:body]
|
|
713
|
+
post_body = opts[:body]
|
|
714
714
|
|
|
715
715
|
# return_type
|
|
716
|
-
return_type = opts[:return_type] || 'ListLabelsResponseBody'
|
|
716
|
+
return_type = opts[:return_type] || 'ListLabelsResponseBody'
|
|
717
717
|
|
|
718
718
|
# auth_names
|
|
719
719
|
auth_names = opts[:auth_names] || ['api_key']
|
|
@@ -785,10 +785,10 @@ module ShipEngine
|
|
|
785
785
|
form_params = opts[:form_params] || {}
|
|
786
786
|
|
|
787
787
|
# http body (model)
|
|
788
|
-
post_body = opts[:body]
|
|
788
|
+
post_body = opts[:body]
|
|
789
789
|
|
|
790
790
|
# return_type
|
|
791
|
-
return_type = opts[:return_type] || 'VoidLabelResponseBody'
|
|
791
|
+
return_type = opts[:return_type] || 'VoidLabelResponseBody'
|
|
792
792
|
|
|
793
793
|
# auth_names
|
|
794
794
|
auth_names = opts[:auth_names] || ['api_key']
|