ship_engine 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +315 -320
- data/docs/AddFundsToCarrierRequestBody.md +5 -6
- data/docs/AddFundsToCarrierResponseBody.md +5 -7
- data/docs/AddFundsToInsuranceRequestBody.md +5 -6
- data/docs/AddFundsToInsuranceResponseBody.md +5 -6
- data/docs/AddToBatchRequestBody.md +5 -6
- data/docs/Address.md +5 -6
- data/docs/AddressResidentialIndicator.md +5 -6
- data/docs/AddressToValidate.md +5 -6
- data/docs/AddressValidatingShipment.md +27 -29
- data/docs/AddressValidationCode.md +5 -6
- data/docs/AddressValidationDetailCode.md +5 -6
- data/docs/AddressValidationMessageType.md +5 -6
- data/docs/AddressValidationResult.md +8 -10
- data/docs/AddressValidationStatus.md +5 -6
- data/docs/AddressesApi.md +19 -25
- data/docs/AdvancedShipmentOptions.md +20 -22
- data/docs/AncillaryServiceEndorsement.md +5 -6
- data/docs/Batch.md +22 -24
- data/docs/BatchResponseError.md +6 -8
- data/docs/BatchStatus.md +5 -6
- data/docs/BatchesApi.md +84 -106
- data/docs/BatchesSortBy.md +5 -6
- data/docs/BillToParty.md +5 -6
- data/docs/BulkRate.md +9 -11
- data/docs/CalculateRatesRequestBody.md +5 -6
- data/docs/CalculateRatesResponseBody.md +27 -29
- data/docs/Carrier.md +17 -19
- data/docs/CarrierAccountsApi.md +38 -48
- data/docs/CarrierAdvancedOption.md +7 -9
- data/docs/CarrierName.md +5 -6
- data/docs/CarrierNameWithSettings.md +5 -6
- data/docs/CarriersApi.md +38 -51
- data/docs/CollectOnDelivery.md +6 -8
- data/docs/CollectOnDeliveryPaymentType.md +5 -6
- data/docs/CompareBulkRatesRequestBody.md +5 -6
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -9
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -10
- data/docs/ConnectApcRequestBody.md +7 -9
- data/docs/ConnectAsendiaRequestBody.md +8 -10
- data/docs/ConnectAustraliaPostRequestBody.md +8 -10
- data/docs/ConnectCanadaPostRequestBody.md +9 -11
- data/docs/ConnectCarrierRequestBody.md +53 -55
- data/docs/ConnectCarrierResponseBody.md +5 -7
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -18
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -8
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -8
- data/docs/ConnectDhlExpressRequestBody.md +6 -8
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -10
- data/docs/ConnectDpdRequestBody.md +7 -9
- data/docs/ConnectEndiciaRequestBody.md +7 -9
- data/docs/ConnectFedexRequestBody.md +19 -21
- data/docs/ConnectFedexUkRequestBody.md +19 -21
- data/docs/ConnectFirstmileRequestBody.md +8 -10
- data/docs/ConnectGlobegisticsRequestBody.md +7 -9
- data/docs/ConnectImexRequestBody.md +7 -9
- data/docs/ConnectInsurerRequestBody.md +6 -8
- data/docs/ConnectNewgisticsRequestBody.md +8 -10
- data/docs/ConnectOntracRequestBody.md +7 -9
- data/docs/ConnectPurolatorRequestBody.md +7 -9
- data/docs/ConnectRoyalMailRequestBody.md +16 -18
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -9
- data/docs/ConnectSekoRequestBody.md +6 -8
- data/docs/ConnectSendleRequestBody.md +7 -9
- data/docs/ConnectStampsRequestBody.md +7 -9
- data/docs/ConnectUpsRequestBody.md +22 -24
- data/docs/CreateAndValidateShipment.md +28 -30
- data/docs/CreateBatchRequestBody.md +8 -10
- data/docs/CreateBatchResponseBody.md +5 -6
- data/docs/CreateLabelFromRateRequestBody.md +5 -6
- data/docs/CreateLabelFromRateResponseBody.md +5 -6
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -10
- data/docs/CreateLabelFromShipmentResponseBody.md +5 -6
- data/docs/CreateLabelRequestBody.md +5 -6
- data/docs/CreateLabelResponseBody.md +5 -6
- data/docs/CreateManifestByObjectRequestBody.md +9 -11
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -7
- data/docs/CreateManifestRequestBody.md +9 -11
- data/docs/CreateManifestResponseBody.md +14 -16
- data/docs/CreatePackageTypeRequestBody.md +5 -6
- data/docs/CreatePackageTypeResponseBody.md +5 -6
- data/docs/CreateReturnLabelRequestBody.md +9 -11
- data/docs/CreateReturnLabelResponseBody.md +5 -6
- data/docs/CreateShipmentResponseBodyFields.md +6 -8
- data/docs/CreateShipmentsRequestBody.md +5 -7
- data/docs/CreateShipmentsResponseBody.md +6 -8
- data/docs/CreateTagResponseBody.md +5 -6
- data/docs/CreateWarehouseRequestBody.md +5 -6
- data/docs/CreateWarehouseResponseBody.md +5 -6
- data/docs/CreateWebhookRequestBody.md +4 -4
- data/docs/CreateWebhookResponseBody.md +5 -6
- data/docs/Currency.md +5 -6
- data/docs/CustomsItem.md +13 -15
- data/docs/DeliveryConfirmation.md +5 -6
- data/docs/DeprecatedManifest.md +13 -15
- data/docs/DhlExpressAccountSettings.md +7 -9
- data/docs/DhlExpressSettingsResponseBody.md +5 -6
- data/docs/DimensionUnit.md +5 -6
- data/docs/Dimensions.md +8 -10
- data/docs/DownloadsApi.md +16 -20
- data/docs/Error.md +8 -10
- data/docs/ErrorCode.md +5 -6
- data/docs/ErrorResponseBody.md +6 -8
- data/docs/ErrorSource.md +5 -6
- data/docs/ErrorType.md +5 -6
- data/docs/EstimateRatesRequestBody.md +5 -6
- data/docs/FedexAccountSettings.md +9 -11
- data/docs/FedexAccountSettingsRequestBody.md +5 -6
- data/docs/FedexPickupType.md +5 -6
- data/docs/FedexSettingsResponseBody.md +5 -6
- data/docs/GetBatchByExternalIdResponseBody.md +5 -6
- data/docs/GetBatchByIdResponseBody.md +5 -6
- data/docs/GetCarrierByIdResponseBody.md +5 -6
- data/docs/GetCarrierOptionsResponseBody.md +5 -7
- data/docs/GetCarrierSettingsResponseBody.md +19 -21
- data/docs/GetCarriersResponseBody.md +7 -9
- data/docs/GetInsuranceBalanceResponseBody.md +5 -6
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +5 -6
- data/docs/GetLabelByIdResponseBody.md +5 -6
- data/docs/GetManifestByIdResponseBody.md +5 -6
- data/docs/GetPackageTypeByIdResponseBody.md +5 -6
- data/docs/GetRateByIdResponseBody.md +5 -6
- data/docs/GetShipmentByExternalIdResponseBody.md +5 -6
- data/docs/GetShipmentByIdResponseBody.md +5 -6
- data/docs/GetTrackingLogFromLabelResponseBody.md +5 -6
- data/docs/GetTrackingLogResponseBody.md +5 -6
- data/docs/GetWarehouseByIdResponseBody.md +5 -6
- data/docs/GetWebhookByIdResponseBody.md +5 -6
- data/docs/InsuranceApi.md +24 -32
- data/docs/InsuranceProvider.md +5 -6
- data/docs/InternationalShipmentOptions.md +7 -9
- data/docs/Label.md +34 -34
- data/docs/LabelChargeEvent.md +5 -6
- data/docs/LabelDownload.md +8 -10
- data/docs/LabelDownloadType.md +5 -6
- data/docs/LabelFormat.md +5 -6
- data/docs/LabelLayout.md +5 -6
- data/docs/LabelMessages.md +7 -9
- data/docs/LabelStatus.md +5 -6
- data/docs/LabelsApi.md +89 -109
- data/docs/Link.md +5 -6
- data/docs/ListBatchErrorsResponseBody.md +6 -8
- data/docs/ListBatchesResponseBody.md +9 -11
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -7
- data/docs/ListCarrierServicesResponseBody.md +5 -7
- data/docs/ListCarriersResponseBody.md +5 -7
- data/docs/ListLabelsResponseBody.md +5 -7
- data/docs/ListManifestsResponseBody.md +9 -11
- data/docs/ListPackageTypesResponseBody.md +5 -7
- data/docs/ListShipmentErrorsResponseBody.md +6 -8
- data/docs/ListShipmentRatesResponseBody.md +5 -6
- data/docs/ListShipmentsResponseBody.md +9 -11
- data/docs/ListTagsResponseBody.md +5 -7
- data/docs/ListWarehousesResponseBody.md +5 -7
- data/docs/Manifest.md +13 -15
- data/docs/ManifestDownload.md +5 -7
- data/docs/Manifests.md +5 -7
- data/docs/ManifestsApi.md +33 -41
- data/docs/ModifyBatch.md +6 -8
- data/docs/MonetaryValue.md +6 -8
- data/docs/NonDelivery.md +5 -6
- data/docs/OptionalLink.md +6 -8
- data/docs/OrderSourceName.md +5 -6
- data/docs/Package.md +11 -13
- data/docs/PackageContents.md +5 -6
- data/docs/PackageType.md +9 -11
- data/docs/PackageTypesApi.md +33 -44
- data/docs/PagedListResponseBody.md +8 -10
- data/docs/PaginationLink.md +8 -10
- data/docs/ParseAddressRequestBody.md +6 -8
- data/docs/ParseAddressResponseBody.md +7 -9
- data/docs/ParseShipmentRequestBody.md +6 -8
- data/docs/ParseShipmentResponseBody.md +7 -9
- data/docs/PartialAddress.md +15 -17
- data/docs/PartialShipment.md +26 -28
- data/docs/PaymentAmount.md +6 -8
- data/docs/ProcessBatchRequestBody.md +7 -9
- data/docs/PurchaseLabelWithoutShipment.md +8 -10
- data/docs/Rate.md +29 -31
- data/docs/RateEstimateByCarrierId.md +5 -7
- data/docs/RateEstimateByCarrierIds.md +3 -3
- data/docs/RateEstimateOptions.md +17 -19
- data/docs/RateRequestBody.md +9 -11
- data/docs/RateRequestByShipmentIds.md +5 -7
- data/docs/RateRequestByShipments.md +5 -7
- data/docs/RateRequestOptions.md +5 -7
- data/docs/RateRequestRateOptions.md +5 -7
- data/docs/RateResponse.md +5 -7
- data/docs/RateResponseStatus.md +5 -6
- data/docs/RateType.md +5 -6
- data/docs/RatesApi.md +31 -41
- data/docs/RatesInformation.md +11 -13
- data/docs/RecognizedEntity.md +10 -12
- data/docs/RemoveFromBatchRequestBody.md +5 -6
- data/docs/ResponseMessage.md +8 -10
- data/docs/Service.md +11 -13
- data/docs/Shipment.md +5 -6
- data/docs/ShipmentIdRequest.md +5 -7
- data/docs/ShipmentItem.md +13 -15
- data/docs/ShipmentRequest.md +5 -7
- data/docs/ShipmentResponseError.md +7 -9
- data/docs/ShipmentStatus.md +5 -6
- data/docs/ShipmentsApi.md +101 -125
- data/docs/ShipmentsSortBy.md +5 -6
- data/docs/SmartPostHub.md +5 -6
- data/docs/SortDir.md +5 -6
- data/docs/Tag.md +5 -7
- data/docs/TagShipmentResponseBody.md +6 -8
- data/docs/TagsApi.md +29 -38
- data/docs/TrackEvent.md +16 -18
- data/docs/TrackingApi.md +25 -33
- data/docs/TrackingInformation.md +14 -16
- data/docs/TrackingStatus.md +5 -6
- data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -24
- data/docs/UpdateDhlExpressSettingsRequestBody.md +5 -6
- data/docs/UpdateFedexSettingsRequestBody.md +5 -6
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -8
- data/docs/UpdatePackageTypeRequestBody.md +5 -6
- data/docs/UpdateShipmentFields.md +5 -7
- data/docs/UpdateShipmentRequestBody.md +27 -29
- data/docs/UpdateShipmentResponseBody.md +5 -6
- data/docs/UpdateUpsSettingsRequestBody.md +5 -6
- data/docs/UpdateWarehouseRequestBody.md +5 -6
- data/docs/UpdateWebhookRequestBody.md +5 -7
- data/docs/UpsAccountSettings.md +16 -18
- data/docs/UpsInvoice.md +8 -10
- data/docs/UpsPickupType.md +5 -6
- data/docs/UpsSettingsResponseBody.md +5 -6
- data/docs/ValidateAddress.md +5 -6
- data/docs/ValidateShipmentFields.md +5 -7
- data/docs/ValidationStatus.md +5 -6
- data/docs/VoidLabelResponseBody.md +6 -8
- data/docs/Warehouse.md +9 -11
- data/docs/WarehousesApi.md +34 -45
- data/docs/Webhook.md +7 -9
- data/docs/WebhookEvent.md +5 -6
- data/docs/WebhooksApi.md +33 -44
- data/docs/Weight.md +6 -8
- data/docs/WeightUnit.md +5 -6
- data/lib/ship_engine.rb +278 -0
- data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/batches_api.rb +42 -42
- data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +12 -12
- data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/labels_api.rb +43 -43
- data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +15 -15
- data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/rates_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +50 -50
- data/lib/{openapi_client → ship_engine}/api/tags_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
- data/lib/{openapi_client → ship_engine}/api_error.rb +2 -2
- data/lib/{openapi_client → ship_engine}/configuration.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_response_body.rb → ship_engine/models/add_funds_to_insurance_request_body.rb} +8 -8
- data/lib/{openapi_client/models/add_funds_to_carrier_request_body.rb → ship_engine/models/add_funds_to_insurance_response_body.rb} +7 -7
- data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batch.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/batch_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/carrier.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +5 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_warehouse_by_id_response_body.rb → ship_engine/models/create_label_from_rate_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_batch_by_external_id_response_body.rb → ship_engine/models/create_label_from_shipment_response_body.rb} +8 -8
- data/lib/ship_engine/models/create_label_request_body.rb +209 -0
- data/lib/ship_engine/models/create_label_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_carrier_by_id_response_body.rb → ship_engine/models/create_package_type_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +8 -8
- data/lib/{openapi_client/models/get_webhook_by_id_response_body.rb → ship_engine/models/create_return_label_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +5 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +209 -0
- data/lib/{openapi_client/models/create_batch_response_body.rb → ship_engine/models/create_warehouse_request_body.rb} +8 -8
- data/lib/{openapi_client/models/get_batch_by_id_response_body.rb → ship_engine/models/create_warehouse_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +5 -5
- data/lib/{openapi_client/models/create_label_request_body.rb → ship_engine/models/create_webhook_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/currency.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/customs_item.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/dimensions.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/error.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_source.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_return_label_response_body.rb → ship_engine/models/get_batch_by_external_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_tag_response_body.rb → ship_engine/models/get_batch_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_label_response_body.rb → ship_engine/models/get_carrier_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +6 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +209 -0
- data/lib/{openapi_client/models/get_label_by_id_response_body.rb → ship_engine/models/get_manifest_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_shipment_by_id_response_body.rb → ship_engine/models/get_package_type_by_id_response_body.rb} +8 -8
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_webhook_response_body.rb → ship_engine/models/get_warehouse_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_rate_by_id_response_body.rb → ship_engine/models/get_webhook_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/label.rb +29 -29
- data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_download.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_format.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_layout.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_messages.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/label_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_request_body.rb → ship_engine/models/list_shipment_rates_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifest.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifests.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/optional_link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/package_contents.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package_type.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/partial_address.rb +13 -13
- data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +17 -17
- data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rate_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rates_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/response_message.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/service.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/tag.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/track_event.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validate_address.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/warehouse.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/weight.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/version.rb +3 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine.gemspec +2 -2
- data/spec/api/addresses_api_spec.rb +8 -8
- data/spec/api/batches_api_spec.rb +15 -15
- data/spec/api/carrier_accounts_api_spec.rb +6 -6
- data/spec/api/carriers_api_spec.rb +5 -5
- data/spec/api/downloads_api_spec.rb +8 -8
- data/spec/api/insurance_api_spec.rb +7 -7
- data/spec/api/labels_api_spec.rb +16 -16
- data/spec/api/manifests_api_spec.rb +8 -8
- data/spec/api/package_types_api_spec.rb +6 -6
- data/spec/api/rates_api_spec.rb +8 -8
- data/spec/api/shipments_api_spec.rb +18 -18
- data/spec/api/tags_api_spec.rb +8 -8
- data/spec/api/tracking_api_spec.rb +5 -5
- data/spec/api/warehouses_api_spec.rb +7 -7
- data/spec/api/webhooks_api_spec.rb +6 -6
- data/spec/api_client_spec.rb +24 -24
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +4 -4
- data/spec/models/add_to_batch_request_body_spec.rb +4 -4
- data/spec/models/address_residential_indicator_spec.rb +4 -4
- data/spec/models/address_spec.rb +4 -4
- data/spec/models/address_to_validate_spec.rb +4 -4
- data/spec/models/address_validating_shipment_spec.rb +4 -4
- data/spec/models/address_validation_code_spec.rb +4 -4
- data/spec/models/address_validation_detail_code_spec.rb +4 -4
- data/spec/models/address_validation_message_type_spec.rb +4 -4
- data/spec/models/address_validation_result_spec.rb +4 -4
- data/spec/models/address_validation_status_spec.rb +4 -4
- data/spec/models/advanced_shipment_options_spec.rb +4 -4
- data/spec/models/ancillary_service_endorsement_spec.rb +4 -4
- data/spec/models/batch_response_error_spec.rb +4 -4
- data/spec/models/batch_spec.rb +4 -4
- data/spec/models/batch_status_spec.rb +4 -4
- data/spec/models/batches_sort_by_spec.rb +4 -4
- data/spec/models/bill_to_party_spec.rb +4 -4
- data/spec/models/bulk_rate_spec.rb +4 -4
- data/spec/models/calculate_rates_request_body_spec.rb +4 -4
- data/spec/models/calculate_rates_response_body_spec.rb +4 -4
- data/spec/models/carrier_advanced_option_spec.rb +4 -4
- data/spec/models/carrier_name_spec.rb +4 -4
- data/spec/models/carrier_name_with_settings_spec.rb +4 -4
- data/spec/models/carrier_spec.rb +4 -4
- data/spec/models/collect_on_delivery_payment_type_spec.rb +4 -4
- data/spec/models/collect_on_delivery_spec.rb +4 -4
- data/spec/models/compare_bulk_rates_request_body_spec.rb +4 -4
- data/spec/models/connect_access_worldwide_request_body_spec.rb +4 -4
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/connect_apc_request_body_spec.rb +4 -4
- data/spec/models/connect_asendia_request_body_spec.rb +4 -4
- data/spec/models/connect_australia_post_request_body_spec.rb +4 -4
- data/spec/models/connect_canada_post_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_response_body_spec.rb +4 -4
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_dpd_request_body_spec.rb +4 -4
- data/spec/models/connect_endicia_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_firstmile_request_body_spec.rb +4 -4
- data/spec/models/connect_globegistics_request_body_spec.rb +4 -4
- data/spec/models/connect_imex_request_body_spec.rb +4 -4
- data/spec/models/connect_insurer_request_body_spec.rb +4 -4
- data/spec/models/connect_newgistics_request_body_spec.rb +4 -4
- data/spec/models/connect_ontrac_request_body_spec.rb +4 -4
- data/spec/models/connect_purolator_request_body_spec.rb +4 -4
- data/spec/models/connect_royal_mail_request_body_spec.rb +4 -4
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +4 -4
- data/spec/models/connect_seko_request_body_spec.rb +4 -4
- data/spec/models/connect_sendle_request_body_spec.rb +4 -4
- data/spec/models/connect_stamps_request_body_spec.rb +4 -4
- data/spec/models/connect_ups_request_body_spec.rb +4 -4
- data/spec/models/create_and_validate_shipment_spec.rb +4 -4
- data/spec/models/create_batch_request_body_spec.rb +4 -4
- data/spec/models/create_batch_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_response_body_spec.rb +4 -4
- data/spec/models/create_label_request_body_spec.rb +4 -4
- data/spec/models/create_label_response_body_spec.rb +4 -4
- data/spec/models/create_manifest_by_object_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_response_body_spec.rb +4 -4
- data/spec/models/create_package_type_request_body_spec.rb +4 -4
- data/spec/models/create_package_type_response_body_spec.rb +4 -4
- data/spec/models/create_return_label_request_body_spec.rb +4 -4
- data/spec/models/create_return_label_response_body_spec.rb +4 -4
- data/spec/models/create_shipment_response_body_fields_spec.rb +4 -4
- data/spec/models/create_shipments_request_body_spec.rb +4 -4
- data/spec/models/create_shipments_response_body_spec.rb +4 -4
- data/spec/models/create_tag_response_body_spec.rb +4 -4
- data/spec/models/create_warehouse_request_body_spec.rb +4 -4
- data/spec/models/create_warehouse_response_body_spec.rb +4 -4
- data/spec/models/create_webhook_request_body_spec.rb +4 -4
- data/spec/models/create_webhook_response_body_spec.rb +4 -4
- data/spec/models/currency_spec.rb +4 -4
- data/spec/models/customs_item_spec.rb +4 -4
- data/spec/models/delivery_confirmation_spec.rb +4 -4
- data/spec/models/deprecated_manifest_spec.rb +4 -4
- data/spec/models/dhl_express_account_settings_spec.rb +4 -4
- data/spec/models/dhl_express_settings_response_body_spec.rb +4 -4
- data/spec/models/dimension_unit_spec.rb +4 -4
- data/spec/models/dimensions_spec.rb +4 -4
- data/spec/models/error_code_spec.rb +4 -4
- data/spec/models/error_response_body_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/error_spec.rb +4 -4
- data/spec/models/error_type_spec.rb +4 -4
- data/spec/models/estimate_rates_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_spec.rb +4 -4
- data/spec/models/fedex_pickup_type_spec.rb +4 -4
- data/spec/models/fedex_settings_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_options_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_settings_response_body_spec.rb +4 -4
- data/spec/models/get_carriers_response_body_spec.rb +4 -4
- data/spec/models/get_insurance_balance_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_manifest_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_package_type_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_rate_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_response_body_spec.rb +4 -4
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_webhook_by_id_response_body_spec.rb +4 -4
- data/spec/models/insurance_provider_spec.rb +4 -4
- data/spec/models/international_shipment_options_spec.rb +4 -4
- data/spec/models/label_charge_event_spec.rb +4 -4
- data/spec/models/label_download_spec.rb +4 -4
- data/spec/models/label_download_type_spec.rb +4 -4
- data/spec/models/label_format_spec.rb +4 -4
- data/spec/models/label_layout_spec.rb +4 -4
- data/spec/models/label_messages_spec.rb +4 -4
- data/spec/models/label_spec.rb +4 -4
- data/spec/models/label_status_spec.rb +4 -4
- data/spec/models/link_spec.rb +4 -4
- data/spec/models/list_batch_errors_response_body_spec.rb +4 -4
- data/spec/models/list_batches_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_services_response_body_spec.rb +4 -4
- data/spec/models/list_carriers_response_body_spec.rb +4 -4
- data/spec/models/list_labels_response_body_spec.rb +4 -4
- data/spec/models/list_manifests_response_body_spec.rb +4 -4
- data/spec/models/list_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_errors_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_rates_response_body_spec.rb +4 -4
- data/spec/models/list_shipments_response_body_spec.rb +4 -4
- data/spec/models/list_tags_response_body_spec.rb +4 -4
- data/spec/models/list_warehouses_response_body_spec.rb +4 -4
- data/spec/models/manifest_download_spec.rb +4 -4
- data/spec/models/manifest_spec.rb +4 -4
- data/spec/models/manifests_spec.rb +4 -4
- data/spec/models/modify_batch_spec.rb +4 -4
- data/spec/models/monetary_value_spec.rb +4 -4
- data/spec/models/non_delivery_spec.rb +4 -4
- data/spec/models/optional_link_spec.rb +4 -4
- data/spec/models/order_source_name_spec.rb +4 -4
- data/spec/models/package_contents_spec.rb +4 -4
- data/spec/models/package_spec.rb +4 -4
- data/spec/models/package_type_spec.rb +4 -4
- data/spec/models/paged_list_response_body_spec.rb +4 -4
- data/spec/models/pagination_link_spec.rb +4 -4
- data/spec/models/parse_address_request_body_spec.rb +4 -4
- data/spec/models/parse_address_response_body_spec.rb +4 -4
- data/spec/models/parse_shipment_request_body_spec.rb +4 -4
- data/spec/models/parse_shipment_response_body_spec.rb +4 -4
- data/spec/models/partial_address_spec.rb +4 -4
- data/spec/models/partial_shipment_spec.rb +4 -4
- data/spec/models/payment_amount_spec.rb +4 -4
- data/spec/models/process_batch_request_body_spec.rb +4 -4
- data/spec/models/purchase_label_without_shipment_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +4 -4
- data/spec/models/rate_estimate_options_spec.rb +4 -4
- data/spec/models/rate_request_body_spec.rb +4 -4
- data/spec/models/rate_request_by_shipment_ids_spec.rb +4 -4
- data/spec/models/rate_request_by_shipments_spec.rb +4 -4
- data/spec/models/rate_request_options_spec.rb +4 -4
- data/spec/models/rate_request_rate_options_spec.rb +4 -4
- data/spec/models/rate_response_spec.rb +4 -4
- data/spec/models/rate_response_status_spec.rb +4 -4
- data/spec/models/rate_spec.rb +4 -4
- data/spec/models/rate_type_spec.rb +4 -4
- data/spec/models/rates_information_spec.rb +4 -4
- data/spec/models/recognized_entity_spec.rb +4 -4
- data/spec/models/remove_from_batch_request_body_spec.rb +4 -4
- data/spec/models/response_message_spec.rb +4 -4
- data/spec/models/service_spec.rb +4 -4
- data/spec/models/shipment_id_request_spec.rb +4 -4
- data/spec/models/shipment_item_spec.rb +4 -4
- data/spec/models/shipment_request_spec.rb +4 -4
- data/spec/models/shipment_response_error_spec.rb +4 -4
- data/spec/models/shipment_spec.rb +4 -4
- data/spec/models/shipment_status_spec.rb +4 -4
- data/spec/models/shipments_sort_by_spec.rb +4 -4
- data/spec/models/smart_post_hub_spec.rb +4 -4
- data/spec/models/sort_dir_spec.rb +4 -4
- data/spec/models/tag_shipment_response_body_spec.rb +4 -4
- data/spec/models/tag_spec.rb +4 -4
- data/spec/models/track_event_spec.rb +4 -4
- data/spec/models/tracking_information_spec.rb +4 -4
- data/spec/models/tracking_status_spec.rb +4 -4
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/update_carrier_settings_request_body_spec.rb +4 -4
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +4 -4
- data/spec/models/update_fedex_settings_request_body_spec.rb +4 -4
- data/spec/models/update_newgistics_settings_request_body_spec.rb +4 -4
- data/spec/models/update_package_type_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_fields_spec.rb +4 -4
- data/spec/models/update_shipment_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_response_body_spec.rb +4 -4
- data/spec/models/update_ups_settings_request_body_spec.rb +4 -4
- data/spec/models/update_warehouse_request_body_spec.rb +4 -4
- data/spec/models/update_webhook_request_body_spec.rb +4 -4
- data/spec/models/ups_account_settings_spec.rb +4 -4
- data/spec/models/ups_invoice_spec.rb +4 -4
- data/spec/models/ups_pickup_type_spec.rb +4 -4
- data/spec/models/ups_settings_response_body_spec.rb +4 -4
- data/spec/models/validate_address_spec.rb +4 -4
- data/spec/models/validate_shipment_fields_spec.rb +4 -4
- data/spec/models/validation_status_spec.rb +4 -4
- data/spec/models/void_label_response_body_spec.rb +4 -4
- data/spec/models/warehouse_spec.rb +4 -4
- data/spec/models/webhook_event_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/models/weight_spec.rb +4 -4
- data/spec/models/weight_unit_spec.rb +4 -4
- metadata +246 -246
- data/lib/openapi_client.rb +0 -278
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +0 -209
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +0 -209
- data/lib/openapi_client/models/create_package_type_response_body.rb +0 -209
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +0 -209
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +0 -209
- data/openapi_client-1.0.0.gem +0 -0
data/docs/RatesInformation.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::RatesInformation
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**rates**
|
|
8
|
-
**invalid_rates**
|
|
9
|
-
**rate_request_id** | **String**
|
|
10
|
-
**shipment_id**
|
|
11
|
-
**created_at**
|
|
12
|
-
**status**
|
|
13
|
-
**errors**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ------------------- | ----------------------------------------------- | -------------------------------------------------- | --------------------- |
|
|
7
|
+
| **rates** | [**Array<Rate>**](Rate.md) | An array of shipment rates | [optional] [readonly] |
|
|
8
|
+
| **invalid_rates** | [**Array<Rate>**](Rate.md) | An array of invalid shipment rates | [optional] [readonly] |
|
|
9
|
+
| **rate_request_id** | **String** | A string that uniquely identifies the rate request | [optional] [readonly] |
|
|
10
|
+
| **shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly] |
|
|
11
|
+
| **created_at** | **String** | When the rate was created | [optional] |
|
|
12
|
+
| **status** | [**RateResponseStatus**](RateResponseStatus.md) | | [optional] [readonly] |
|
|
13
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'OpenapiClient'
|
|
19
19
|
|
|
20
|
-
instance =
|
|
20
|
+
instance = ShipEngine::RatesInformation.new(rates: null,
|
|
21
21
|
invalid_rates: null,
|
|
22
22
|
rate_request_id: null,
|
|
23
23
|
shipment_id: null,
|
|
@@ -25,5 +25,3 @@ instance = OpenapiClient::RatesInformation.new(rates: null,
|
|
|
25
25
|
status: null,
|
|
26
26
|
errors: null)
|
|
27
27
|
```
|
|
28
|
-
|
|
29
|
-
|
data/docs/RecognizedEntity.md
CHANGED
|
@@ -1,27 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::RecognizedEntity
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**type**
|
|
8
|
-
**score**
|
|
9
|
-
**text**
|
|
10
|
-
**start_index** | **Integer**
|
|
11
|
-
**end_index**
|
|
12
|
-
**result**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
7
|
+
| **type** | **String** | The Entity type (e.g. \"weight\", \"person\", \"address_line1\", etc.) |
|
|
8
|
+
| **score** | **Float** | A confidence score between zero and one that indicates how certain the API is that it correctly recognized this entity |
|
|
9
|
+
| **text** | **String** | The substring from the original text that was recognized as this entity |
|
|
10
|
+
| **start_index** | **Integer** | The index of the first character of this entity within the original text |
|
|
11
|
+
| **end_index** | **Integer** | The index of the last character of this entity within the original text |
|
|
12
|
+
| **result** | **Hash<String, Object>** | The normalized value of the entity. Most entity results have a `value` field, which is the normalized value of the entity. For example, if the substring \"john doe\" was recognized as a \"person\" entity, then the value might be normalized to have proper capitalization (e.g. \"John Doe\"). Or if the substring \"ft worth\" was recognized as a \"city\" entity, then the value might be normalized to \"Fort Worth\". Some entities have other information in addition to, or instead of a `value`. For example, a \"dimensions\" entity will have separate fields for `length`, `width`, `height`, and `unit`. | [optional] |
|
|
13
13
|
|
|
14
14
|
## Code Sample
|
|
15
15
|
|
|
16
16
|
```ruby
|
|
17
17
|
require 'OpenapiClient'
|
|
18
18
|
|
|
19
|
-
instance =
|
|
19
|
+
instance = ShipEngine::RecognizedEntity.new(type: null,
|
|
20
20
|
score: null,
|
|
21
21
|
text: null,
|
|
22
22
|
start_index: null,
|
|
23
23
|
end_index: null,
|
|
24
24
|
result: null)
|
|
25
25
|
```
|
|
26
|
-
|
|
27
|
-
|
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::RemoveFromBatchRequestBody
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
7
8
|
|
|
8
9
|
## Code Sample
|
|
9
10
|
|
|
10
11
|
```ruby
|
|
11
12
|
require 'OpenapiClient'
|
|
12
13
|
|
|
13
|
-
instance =
|
|
14
|
+
instance = ShipEngine::RemoveFromBatchRequestBody.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/ResponseMessage.md
CHANGED
|
@@ -1,23 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ResponseMessage
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**code**
|
|
8
|
-
**message**
|
|
9
|
-
**type**
|
|
10
|
-
**detail_code** | [**AddressValidationDetailCode**](AddressValidationDetailCode.md)
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ------------------------------------------------------------------- | ----------------------------------------------- | --------------------- |
|
|
7
|
+
| **code** | [**AddressValidationCode**](AddressValidationCode.md) | | [optional] [readonly] |
|
|
8
|
+
| **message** | **String** | Message explaining the address validation error | [optional] [readonly] |
|
|
9
|
+
| **type** | [**AddressValidationMessageType**](AddressValidationMessageType.md) | | [optional] [readonly] |
|
|
10
|
+
| **detail_code** | [**AddressValidationDetailCode**](AddressValidationDetailCode.md) | | [optional] |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'OpenapiClient'
|
|
16
16
|
|
|
17
|
-
instance =
|
|
17
|
+
instance = ShipEngine::ResponseMessage.new(code: null,
|
|
18
18
|
message: Invalid Postal Code,
|
|
19
19
|
type: null,
|
|
20
20
|
detail_code: null)
|
|
21
21
|
```
|
|
22
|
-
|
|
23
|
-
|
data/docs/Service.md
CHANGED
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::Service
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**carrier_id**
|
|
8
|
-
**carrier_code**
|
|
9
|
-
**service_code**
|
|
10
|
-
**name**
|
|
11
|
-
**domestic**
|
|
12
|
-
**international**
|
|
13
|
-
**is_multi_package_supported** | **Boolean** | Carrier supports multiple packages per shipment | [optional] [readonly]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ------------------------------ | ----------- | ----------------------------------------------- | --------------------- |
|
|
7
|
+
| **carrier_id** | **String** | A string that uniquely identifies the carrier | [optional] [readonly] |
|
|
8
|
+
| **carrier_code** | **String** | | [optional] |
|
|
9
|
+
| **service_code** | **String** | service code | [optional] [readonly] |
|
|
10
|
+
| **name** | **String** | User friendly service name | [optional] [readonly] |
|
|
11
|
+
| **domestic** | **Boolean** | Supports domestic shipping | [optional] [readonly] |
|
|
12
|
+
| **international** | **Boolean** | Supports international shipping. | [optional] [readonly] |
|
|
13
|
+
| **is_multi_package_supported** | **Boolean** | Carrier supports multiple packages per shipment | [optional] [readonly] |
|
|
14
14
|
|
|
15
15
|
## Code Sample
|
|
16
16
|
|
|
17
17
|
```ruby
|
|
18
18
|
require 'OpenapiClient'
|
|
19
19
|
|
|
20
|
-
instance =
|
|
20
|
+
instance = ShipEngine::Service.new(carrier_id: null,
|
|
21
21
|
carrier_code: null,
|
|
22
22
|
service_code: usps_media_mail,
|
|
23
23
|
name: USPS First Class Mail,
|
|
@@ -25,5 +25,3 @@ instance = OpenapiClient::Service.new(carrier_id: null,
|
|
|
25
25
|
international: null,
|
|
26
26
|
is_multi_package_supported: null)
|
|
27
27
|
```
|
|
28
|
-
|
|
29
|
-
|
data/docs/Shipment.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::Shipment
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
7
8
|
|
|
8
9
|
## Code Sample
|
|
9
10
|
|
|
10
11
|
```ruby
|
|
11
12
|
require 'OpenapiClient'
|
|
12
13
|
|
|
13
|
-
instance =
|
|
14
|
+
instance = ShipEngine::Shipment.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/ShipmentIdRequest.md
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentIdRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ---------- | ---------------------------------------------- | ---------- |
|
|
7
|
+
| **shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'OpenapiClient'
|
|
13
13
|
|
|
14
|
-
instance =
|
|
14
|
+
instance = ShipEngine::ShipmentIdRequest.new(shipment_id: null)
|
|
15
15
|
```
|
|
16
|
-
|
|
17
|
-
|
data/docs/ShipmentItem.md
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentItem
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**name**
|
|
8
|
-
**sales_order_id**
|
|
9
|
-
**sales_order_item_id**
|
|
10
|
-
**quantity**
|
|
11
|
-
**sku**
|
|
12
|
-
**external_order_id**
|
|
13
|
-
**external_order_item_id** | **String**
|
|
14
|
-
**asin**
|
|
15
|
-
**order_source_code**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------------------- | ----------------------------------------- | -------------------------------------------------- | ---------- |
|
|
7
|
+
| **name** | **String** | item name | [optional] |
|
|
8
|
+
| **sales_order_id** | **String** | sales order id | [optional] |
|
|
9
|
+
| **sales_order_item_id** | **String** | sales order item id | [optional] |
|
|
10
|
+
| **quantity** | **Integer** | The quantity of this item included in the shipment | [optional] |
|
|
11
|
+
| **sku** | **String** | Item Stock Keeping Unit | [optional] |
|
|
12
|
+
| **external_order_id** | **String** | external order id | [optional] |
|
|
13
|
+
| **external_order_item_id** | **String** | external order item id | [optional] |
|
|
14
|
+
| **asin** | **String** | Amazon Standard Identification Number | [optional] |
|
|
15
|
+
| **order_source_code** | [**OrderSourceName**](OrderSourceName.md) | | [optional] |
|
|
16
16
|
|
|
17
17
|
## Code Sample
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
20
|
require 'OpenapiClient'
|
|
21
21
|
|
|
22
|
-
instance =
|
|
22
|
+
instance = ShipEngine::ShipmentItem.new(name: null,
|
|
23
23
|
sales_order_id: null,
|
|
24
24
|
sales_order_item_id: null,
|
|
25
25
|
quantity: null,
|
|
@@ -29,5 +29,3 @@ instance = OpenapiClient::ShipmentItem.new(name: null,
|
|
|
29
29
|
asin: B00005N5PF,
|
|
30
30
|
order_source_code: null)
|
|
31
31
|
```
|
|
32
|
-
|
|
33
|
-
|
data/docs/ShipmentRequest.md
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
------------ |
|
|
7
|
-
**shipment** | [**AddressValidatingShipment**](AddressValidatingShipment.md) | The shipment object | [optional]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ------------ | ------------------------------------------------------------- | ------------------- | ---------- |
|
|
7
|
+
| **shipment** | [**AddressValidatingShipment**](AddressValidatingShipment.md) | The shipment object | [optional] |
|
|
8
8
|
|
|
9
9
|
## Code Sample
|
|
10
10
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'OpenapiClient'
|
|
13
13
|
|
|
14
|
-
instance =
|
|
14
|
+
instance = ShipEngine::ShipmentRequest.new(shipment: null)
|
|
15
15
|
```
|
|
16
|
-
|
|
17
|
-
|
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentResponseError
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**error**
|
|
8
|
-
**shipment_id**
|
|
9
|
-
**external_shipment_id** | **String** | A string that uniquely identifies the external shipment. | [optional] [readonly]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ------------------------ | ---------- | -------------------------------------------------------- | --------------------- |
|
|
7
|
+
| **error** | **String** | Shipment error message | [readonly] |
|
|
8
|
+
| **shipment_id** | **String** | A string that uniquely identifies the shipment. | [readonly] |
|
|
9
|
+
| **external_shipment_id** | **String** | A string that uniquely identifies the external shipment. | [optional] [readonly] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'OpenapiClient'
|
|
15
15
|
|
|
16
|
-
instance =
|
|
16
|
+
instance = ShipEngine::ShipmentResponseError.new(error: null,
|
|
17
17
|
shipment_id: null,
|
|
18
18
|
external_shipment_id: null)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/ShipmentStatus.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentStatus
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
7
8
|
|
|
8
9
|
## Code Sample
|
|
9
10
|
|
|
10
11
|
```ruby
|
|
11
12
|
require 'OpenapiClient'
|
|
12
13
|
|
|
13
|
-
instance =
|
|
14
|
+
instance = ShipEngine::ShipmentStatus.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/ShipmentsApi.md
CHANGED
|
@@ -1,22 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::ShipmentsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.shipengine.com*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**cancel_shipments**](ShipmentsApi.md#cancel_shipments)
|
|
8
|
-
[**create_shipments**](ShipmentsApi.md#create_shipments)
|
|
9
|
-
[**get_shipment_by_external_id**](ShipmentsApi.md#get_shipment_by_external_id) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID
|
|
10
|
-
[**get_shipment_by_id**](ShipmentsApi.md#get_shipment_by_id)
|
|
11
|
-
[**list_shipment_errors**](ShipmentsApi.md#list_shipment_errors)
|
|
12
|
-
[**list_shipment_rates**](ShipmentsApi.md#list_shipment_rates)
|
|
13
|
-
[**list_shipments**](ShipmentsApi.md#list_shipments)
|
|
14
|
-
[**parse_shipment**](ShipmentsApi.md#parse_shipment)
|
|
15
|
-
[**tag_shipment**](ShipmentsApi.md#tag_shipment)
|
|
16
|
-
[**untag_shipment**](ShipmentsApi.md#untag_shipment)
|
|
17
|
-
[**update_shipment**](ShipmentsApi.md#update_shipment)
|
|
18
|
-
|
|
19
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | --------------------------- |
|
|
7
|
+
| [**cancel_shipments**](ShipmentsApi.md#cancel_shipments) | **PUT** /v1/shipments/{shipment_id}/cancel | Cancel a Shipment |
|
|
8
|
+
| [**create_shipments**](ShipmentsApi.md#create_shipments) | **POST** /v1/shipments | Create Shipments |
|
|
9
|
+
| [**get_shipment_by_external_id**](ShipmentsApi.md#get_shipment_by_external_id) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID |
|
|
10
|
+
| [**get_shipment_by_id**](ShipmentsApi.md#get_shipment_by_id) | **GET** /v1/shipments/{shipment_id} | Get Shipment By ID |
|
|
11
|
+
| [**list_shipment_errors**](ShipmentsApi.md#list_shipment_errors) | **GET** /v1/shipments/{shipment_id}/errors | Get Shipment Errors |
|
|
12
|
+
| [**list_shipment_rates**](ShipmentsApi.md#list_shipment_rates) | **GET** /v1/shipments/{shipment_id}/rates | Get Shipment Rates |
|
|
13
|
+
| [**list_shipments**](ShipmentsApi.md#list_shipments) | **GET** /v1/shipments | List Shipments |
|
|
14
|
+
| [**parse_shipment**](ShipmentsApi.md#parse_shipment) | **PUT** /v1/shipments/recognize | Parse shipping info |
|
|
15
|
+
| [**tag_shipment**](ShipmentsApi.md#tag_shipment) | **POST** /v1/shipments/{shipment_id}/tags/{tag_name} | Add Tag to Shipment |
|
|
16
|
+
| [**untag_shipment**](ShipmentsApi.md#untag_shipment) | **DELETE** /v1/shipments/{shipment_id}/tags/{tag_name} | Remove Tag from Shipment |
|
|
17
|
+
| [**update_shipment**](ShipmentsApi.md#update_shipment) | **PUT** /v1/shipments/{shipment_id} | Update Shipment By ID |
|
|
20
18
|
|
|
21
19
|
## cancel_shipments
|
|
22
20
|
|
|
@@ -24,7 +22,7 @@ Method | HTTP request | Description
|
|
|
24
22
|
|
|
25
23
|
Cancel a Shipment
|
|
26
24
|
|
|
27
|
-
Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
25
|
+
Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process
|
|
28
26
|
|
|
29
27
|
### Example
|
|
30
28
|
|
|
@@ -39,24 +37,23 @@ OpenapiClient.configure do |config|
|
|
|
39
37
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
40
38
|
end
|
|
41
39
|
|
|
42
|
-
api_instance =
|
|
40
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
43
41
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
44
42
|
|
|
45
43
|
begin
|
|
46
44
|
#Cancel a Shipment
|
|
47
45
|
result = api_instance.cancel_shipments(shipment_id)
|
|
48
46
|
p result
|
|
49
|
-
rescue
|
|
47
|
+
rescue ShipEngine::ApiError => e
|
|
50
48
|
puts "Exception when calling ShipmentsApi->cancel_shipments: #{e}"
|
|
51
49
|
end
|
|
52
50
|
```
|
|
53
51
|
|
|
54
52
|
### Parameters
|
|
55
53
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
**shipment_id** | **String**| Shipment ID |
|
|
54
|
+
| Name | Type | Description | Notes |
|
|
55
|
+
| --------------- | ---------- | ----------- | ----- |
|
|
56
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
60
57
|
|
|
61
58
|
### Return type
|
|
62
59
|
|
|
@@ -71,7 +68,6 @@ Name | Type | Description | Notes
|
|
|
71
68
|
- **Content-Type**: Not defined
|
|
72
69
|
- **Accept**: text/plain, application/json
|
|
73
70
|
|
|
74
|
-
|
|
75
71
|
## create_shipments
|
|
76
72
|
|
|
77
73
|
> CreateShipmentsResponseBody create_shipments(create_shipments_request_body)
|
|
@@ -93,24 +89,23 @@ OpenapiClient.configure do |config|
|
|
|
93
89
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
94
90
|
end
|
|
95
91
|
|
|
96
|
-
api_instance =
|
|
97
|
-
create_shipments_request_body =
|
|
92
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
93
|
+
create_shipments_request_body = ShipEngine::CreateShipmentsRequestBody.new # CreateShipmentsRequestBody |
|
|
98
94
|
|
|
99
95
|
begin
|
|
100
96
|
#Create Shipments
|
|
101
97
|
result = api_instance.create_shipments(create_shipments_request_body)
|
|
102
98
|
p result
|
|
103
|
-
rescue
|
|
99
|
+
rescue ShipEngine::ApiError => e
|
|
104
100
|
puts "Exception when calling ShipmentsApi->create_shipments: #{e}"
|
|
105
101
|
end
|
|
106
102
|
```
|
|
107
103
|
|
|
108
104
|
### Parameters
|
|
109
105
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
**create_shipments_request_body** | [**CreateShipmentsRequestBody**](CreateShipmentsRequestBody.md)| |
|
|
106
|
+
| Name | Type | Description | Notes |
|
|
107
|
+
| --------------------------------- | --------------------------------------------------------------- | ----------- | ----- |
|
|
108
|
+
| **create_shipments_request_body** | [**CreateShipmentsRequestBody**](CreateShipmentsRequestBody.md) | |
|
|
114
109
|
|
|
115
110
|
### Return type
|
|
116
111
|
|
|
@@ -125,7 +120,6 @@ Name | Type | Description | Notes
|
|
|
125
120
|
- **Content-Type**: application/json
|
|
126
121
|
- **Accept**: application/json
|
|
127
122
|
|
|
128
|
-
|
|
129
123
|
## get_shipment_by_external_id
|
|
130
124
|
|
|
131
125
|
> GetShipmentByExternalIdResponseBody get_shipment_by_external_id(external_shipment_id)
|
|
@@ -147,24 +141,23 @@ OpenapiClient.configure do |config|
|
|
|
147
141
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
148
142
|
end
|
|
149
143
|
|
|
150
|
-
api_instance =
|
|
151
|
-
external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String |
|
|
144
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
145
|
+
external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String |
|
|
152
146
|
|
|
153
147
|
begin
|
|
154
148
|
#Get Shipment By External ID
|
|
155
149
|
result = api_instance.get_shipment_by_external_id(external_shipment_id)
|
|
156
150
|
p result
|
|
157
|
-
rescue
|
|
151
|
+
rescue ShipEngine::ApiError => e
|
|
158
152
|
puts "Exception when calling ShipmentsApi->get_shipment_by_external_id: #{e}"
|
|
159
153
|
end
|
|
160
154
|
```
|
|
161
155
|
|
|
162
156
|
### Parameters
|
|
163
157
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
**external_shipment_id** | **String**| |
|
|
158
|
+
| Name | Type | Description | Notes |
|
|
159
|
+
| ------------------------ | ---------- | ----------- | ----- |
|
|
160
|
+
| **external_shipment_id** | **String** | |
|
|
168
161
|
|
|
169
162
|
### Return type
|
|
170
163
|
|
|
@@ -179,7 +172,6 @@ Name | Type | Description | Notes
|
|
|
179
172
|
- **Content-Type**: Not defined
|
|
180
173
|
- **Accept**: application/json
|
|
181
174
|
|
|
182
|
-
|
|
183
175
|
## get_shipment_by_id
|
|
184
176
|
|
|
185
177
|
> GetShipmentByIdResponseBody get_shipment_by_id(shipment_id)
|
|
@@ -201,24 +193,23 @@ OpenapiClient.configure do |config|
|
|
|
201
193
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
202
194
|
end
|
|
203
195
|
|
|
204
|
-
api_instance =
|
|
196
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
205
197
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
206
198
|
|
|
207
199
|
begin
|
|
208
200
|
#Get Shipment By ID
|
|
209
201
|
result = api_instance.get_shipment_by_id(shipment_id)
|
|
210
202
|
p result
|
|
211
|
-
rescue
|
|
203
|
+
rescue ShipEngine::ApiError => e
|
|
212
204
|
puts "Exception when calling ShipmentsApi->get_shipment_by_id: #{e}"
|
|
213
205
|
end
|
|
214
206
|
```
|
|
215
207
|
|
|
216
208
|
### Parameters
|
|
217
209
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
**shipment_id** | **String**| Shipment ID |
|
|
210
|
+
| Name | Type | Description | Notes |
|
|
211
|
+
| --------------- | ---------- | ----------- | ----- |
|
|
212
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
222
213
|
|
|
223
214
|
### Return type
|
|
224
215
|
|
|
@@ -233,14 +224,13 @@ Name | Type | Description | Notes
|
|
|
233
224
|
- **Content-Type**: Not defined
|
|
234
225
|
- **Accept**: application/json
|
|
235
226
|
|
|
236
|
-
|
|
237
227
|
## list_shipment_errors
|
|
238
228
|
|
|
239
229
|
> ListShipmentErrorsResponseBody list_shipment_errors(shipment_id, opts)
|
|
240
230
|
|
|
241
231
|
Get Shipment Errors
|
|
242
232
|
|
|
243
|
-
If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
233
|
+
If there are no errors associated with this shipment then the API will return a 404 Not Found response to indicate that no errors are associated with the request
|
|
244
234
|
|
|
245
235
|
### Example
|
|
246
236
|
|
|
@@ -255,30 +245,29 @@ OpenapiClient.configure do |config|
|
|
|
255
245
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
256
246
|
end
|
|
257
247
|
|
|
258
|
-
api_instance =
|
|
248
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
259
249
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
260
250
|
opts = {
|
|
261
|
-
page: 1, # Integer | 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.
|
|
262
|
-
pagesize: 56 # Integer |
|
|
251
|
+
page: 1, # Integer | 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.
|
|
252
|
+
pagesize: 56 # Integer |
|
|
263
253
|
}
|
|
264
254
|
|
|
265
255
|
begin
|
|
266
256
|
#Get Shipment Errors
|
|
267
257
|
result = api_instance.list_shipment_errors(shipment_id, opts)
|
|
268
258
|
p result
|
|
269
|
-
rescue
|
|
259
|
+
rescue ShipEngine::ApiError => e
|
|
270
260
|
puts "Exception when calling ShipmentsApi->list_shipment_errors: #{e}"
|
|
271
261
|
end
|
|
272
262
|
```
|
|
273
263
|
|
|
274
264
|
### Parameters
|
|
275
265
|
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
**
|
|
280
|
-
**
|
|
281
|
-
**pagesize** | **Integer**| | [optional]
|
|
266
|
+
| Name | Type | Description | Notes |
|
|
267
|
+
| --------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
|
|
268
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
269
|
+
| **page** | **Integer** | 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. | [optional] [default to 1] |
|
|
270
|
+
| **pagesize** | **Integer** | | [optional] |
|
|
282
271
|
|
|
283
272
|
### Return type
|
|
284
273
|
|
|
@@ -293,7 +282,6 @@ Name | Type | Description | Notes
|
|
|
293
282
|
- **Content-Type**: Not defined
|
|
294
283
|
- **Accept**: application/json
|
|
295
284
|
|
|
296
|
-
|
|
297
285
|
## list_shipment_rates
|
|
298
286
|
|
|
299
287
|
> ListShipmentRatesResponseBody list_shipment_rates(shipment_id, opts)
|
|
@@ -315,7 +303,7 @@ OpenapiClient.configure do |config|
|
|
|
315
303
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
316
304
|
end
|
|
317
305
|
|
|
318
|
-
api_instance =
|
|
306
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
319
307
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
320
308
|
opts = {
|
|
321
309
|
created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z') # DateTime | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
|
|
@@ -325,18 +313,17 @@ begin
|
|
|
325
313
|
#Get Shipment Rates
|
|
326
314
|
result = api_instance.list_shipment_rates(shipment_id, opts)
|
|
327
315
|
p result
|
|
328
|
-
rescue
|
|
316
|
+
rescue ShipEngine::ApiError => e
|
|
329
317
|
puts "Exception when calling ShipmentsApi->list_shipment_rates: #{e}"
|
|
330
318
|
end
|
|
331
319
|
```
|
|
332
320
|
|
|
333
321
|
### Parameters
|
|
334
322
|
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
**
|
|
339
|
-
**created_at_start** | **DateTime**| Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional]
|
|
323
|
+
| Name | Type | Description | Notes |
|
|
324
|
+
| -------------------- | ------------ | -------------------------------------------------------------------------------------------------------------- | ---------- |
|
|
325
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
326
|
+
| **created_at_start** | **DateTime** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] |
|
|
340
327
|
|
|
341
328
|
### Return type
|
|
342
329
|
|
|
@@ -351,7 +338,6 @@ Name | Type | Description | Notes
|
|
|
351
338
|
- **Content-Type**: Not defined
|
|
352
339
|
- **Accept**: application/json
|
|
353
340
|
|
|
354
|
-
|
|
355
341
|
## list_shipments
|
|
356
342
|
|
|
357
343
|
> ListShipmentsResponseBody list_shipments(opts)
|
|
@@ -373,48 +359,47 @@ OpenapiClient.configure do |config|
|
|
|
373
359
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
374
360
|
end
|
|
375
361
|
|
|
376
|
-
api_instance =
|
|
362
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
377
363
|
opts = {
|
|
378
|
-
shipment_status:
|
|
364
|
+
shipment_status: ShipEngine::ShipmentStatus.new, # ShipmentStatus |
|
|
379
365
|
batch_id: 'batch_id_example', # String | Batch ID
|
|
380
366
|
tag: 'Letters_to_santa', # String | Search for shipments based on the custom tag added to the shipment object
|
|
381
367
|
created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
|
|
382
368
|
created_at_end: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
|
|
383
369
|
modified_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
|
|
384
370
|
modified_at_end: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
|
|
385
|
-
page: 1, # Integer | 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.
|
|
371
|
+
page: 1, # Integer | 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.
|
|
386
372
|
page_size: 25, # Integer | The number of results to return per response.
|
|
387
373
|
sales_order_id: 'sales_order_id_example', # String | Sales Order ID
|
|
388
|
-
sort_dir:
|
|
389
|
-
sort_by:
|
|
374
|
+
sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
|
|
375
|
+
sort_by: ShipEngine::ShipmentsSortBy.new # ShipmentsSortBy |
|
|
390
376
|
}
|
|
391
377
|
|
|
392
378
|
begin
|
|
393
379
|
#List Shipments
|
|
394
380
|
result = api_instance.list_shipments(opts)
|
|
395
381
|
p result
|
|
396
|
-
rescue
|
|
382
|
+
rescue ShipEngine::ApiError => e
|
|
397
383
|
puts "Exception when calling ShipmentsApi->list_shipments: #{e}"
|
|
398
384
|
end
|
|
399
385
|
```
|
|
400
386
|
|
|
401
387
|
### Parameters
|
|
402
388
|
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
**
|
|
407
|
-
**
|
|
408
|
-
**
|
|
409
|
-
**
|
|
410
|
-
**
|
|
411
|
-
**
|
|
412
|
-
**
|
|
413
|
-
**
|
|
414
|
-
**
|
|
415
|
-
**
|
|
416
|
-
**
|
|
417
|
-
**sort_by** | [**ShipmentsSortBy**](.md)| | [optional]
|
|
389
|
+
| Name | Type | Description | Notes |
|
|
390
|
+
| --------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
391
|
+
| **shipment_status** | [**ShipmentStatus**](.md) | | [optional] |
|
|
392
|
+
| **batch_id** | **String** | Batch ID | [optional] |
|
|
393
|
+
| **tag** | **String** | Search for shipments based on the custom tag added to the shipment object | [optional] |
|
|
394
|
+
| **created_at_start** | **DateTime** | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] |
|
|
395
|
+
| **created_at_end** | **DateTime** | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) | [optional] |
|
|
396
|
+
| **modified_at_start** | **DateTime** | Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time) | [optional] |
|
|
397
|
+
| **modified_at_end** | **DateTime** | Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time) | [optional] |
|
|
398
|
+
| **page** | **Integer** | 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. | [optional] [default to 1] |
|
|
399
|
+
| **page_size** | **Integer** | The number of results to return per response. | [optional] [default to 25] |
|
|
400
|
+
| **sales_order_id** | **String** | Sales Order ID | [optional] |
|
|
401
|
+
| **sort_dir** | [**SortDir**](.md) | Controls the sort order of the query. | [optional] |
|
|
402
|
+
| **sort_by** | [**ShipmentsSortBy**](.md) | | [optional] |
|
|
418
403
|
|
|
419
404
|
### Return type
|
|
420
405
|
|
|
@@ -429,14 +414,13 @@ Name | Type | Description | Notes
|
|
|
429
414
|
- **Content-Type**: Not defined
|
|
430
415
|
- **Accept**: application/json
|
|
431
416
|
|
|
432
|
-
|
|
433
417
|
## parse_shipment
|
|
434
418
|
|
|
435
419
|
> ParseShipmentResponseBody parse_shipment(parse_shipment_request_body)
|
|
436
420
|
|
|
437
421
|
Parse shipping info
|
|
438
422
|
|
|
439
|
-
The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more.
|
|
423
|
+
The shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and dimensions, insurance and delivery requirements, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's shipment-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed shipment data is returned in the same structure that's used for other ShipEngine APIs, so you can easily use the parsed data to create a shipping label. > **Note:** Shipment recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.
|
|
440
424
|
|
|
441
425
|
### Example
|
|
442
426
|
|
|
@@ -451,24 +435,23 @@ OpenapiClient.configure do |config|
|
|
|
451
435
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
452
436
|
end
|
|
453
437
|
|
|
454
|
-
api_instance =
|
|
455
|
-
parse_shipment_request_body = {"text":"I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.\n"} # ParseShipmentRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
438
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
439
|
+
parse_shipment_request_body = {"text":"I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.\n"} # ParseShipmentRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use.
|
|
456
440
|
|
|
457
441
|
begin
|
|
458
442
|
#Parse shipping info
|
|
459
443
|
result = api_instance.parse_shipment(parse_shipment_request_body)
|
|
460
444
|
p result
|
|
461
|
-
rescue
|
|
445
|
+
rescue ShipEngine::ApiError => e
|
|
462
446
|
puts "Exception when calling ShipmentsApi->parse_shipment: #{e}"
|
|
463
447
|
end
|
|
464
448
|
```
|
|
465
449
|
|
|
466
450
|
### Parameters
|
|
467
451
|
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
**parse_shipment_request_body** | [**ParseShipmentRequestBody**](ParseShipmentRequestBody.md)| The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. |
|
|
452
|
+
| Name | Type | Description | Notes |
|
|
453
|
+
| ------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
|
454
|
+
| **parse_shipment_request_body** | [**ParseShipmentRequestBody**](ParseShipmentRequestBody.md) | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. |
|
|
472
455
|
|
|
473
456
|
### Return type
|
|
474
457
|
|
|
@@ -483,7 +466,6 @@ Name | Type | Description | Notes
|
|
|
483
466
|
- **Content-Type**: application/json
|
|
484
467
|
- **Accept**: application/json
|
|
485
468
|
|
|
486
|
-
|
|
487
469
|
## tag_shipment
|
|
488
470
|
|
|
489
471
|
> TagShipmentResponseBody tag_shipment(shipment_id, tag_name)
|
|
@@ -505,26 +487,25 @@ OpenapiClient.configure do |config|
|
|
|
505
487
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
506
488
|
end
|
|
507
489
|
|
|
508
|
-
api_instance =
|
|
490
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
509
491
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
510
|
-
tag_name = 'tag_name_example' # String |
|
|
492
|
+
tag_name = 'tag_name_example' # String |
|
|
511
493
|
|
|
512
494
|
begin
|
|
513
495
|
#Add Tag to Shipment
|
|
514
496
|
result = api_instance.tag_shipment(shipment_id, tag_name)
|
|
515
497
|
p result
|
|
516
|
-
rescue
|
|
498
|
+
rescue ShipEngine::ApiError => e
|
|
517
499
|
puts "Exception when calling ShipmentsApi->tag_shipment: #{e}"
|
|
518
500
|
end
|
|
519
501
|
```
|
|
520
502
|
|
|
521
503
|
### Parameters
|
|
522
504
|
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
**
|
|
527
|
-
**tag_name** | **String**| |
|
|
505
|
+
| Name | Type | Description | Notes |
|
|
506
|
+
| --------------- | ---------- | ----------- | ----- |
|
|
507
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
508
|
+
| **tag_name** | **String** | |
|
|
528
509
|
|
|
529
510
|
### Return type
|
|
530
511
|
|
|
@@ -539,7 +520,6 @@ Name | Type | Description | Notes
|
|
|
539
520
|
- **Content-Type**: Not defined
|
|
540
521
|
- **Accept**: application/json
|
|
541
522
|
|
|
542
|
-
|
|
543
523
|
## untag_shipment
|
|
544
524
|
|
|
545
525
|
> String untag_shipment(shipment_id, tag_name)
|
|
@@ -561,26 +541,25 @@ OpenapiClient.configure do |config|
|
|
|
561
541
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
562
542
|
end
|
|
563
543
|
|
|
564
|
-
api_instance =
|
|
544
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
565
545
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
566
|
-
tag_name = 'tag_name_example' # String |
|
|
546
|
+
tag_name = 'tag_name_example' # String |
|
|
567
547
|
|
|
568
548
|
begin
|
|
569
549
|
#Remove Tag from Shipment
|
|
570
550
|
result = api_instance.untag_shipment(shipment_id, tag_name)
|
|
571
551
|
p result
|
|
572
|
-
rescue
|
|
552
|
+
rescue ShipEngine::ApiError => e
|
|
573
553
|
puts "Exception when calling ShipmentsApi->untag_shipment: #{e}"
|
|
574
554
|
end
|
|
575
555
|
```
|
|
576
556
|
|
|
577
557
|
### Parameters
|
|
578
558
|
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
**
|
|
583
|
-
**tag_name** | **String**| |
|
|
559
|
+
| Name | Type | Description | Notes |
|
|
560
|
+
| --------------- | ---------- | ----------- | ----- |
|
|
561
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
562
|
+
| **tag_name** | **String** | |
|
|
584
563
|
|
|
585
564
|
### Return type
|
|
586
565
|
|
|
@@ -595,7 +574,6 @@ Name | Type | Description | Notes
|
|
|
595
574
|
- **Content-Type**: Not defined
|
|
596
575
|
- **Accept**: text/plain, application/json
|
|
597
576
|
|
|
598
|
-
|
|
599
577
|
## update_shipment
|
|
600
578
|
|
|
601
579
|
> UpdateShipmentResponseBody update_shipment(shipment_id, update_shipment_request_body)
|
|
@@ -617,26 +595,25 @@ OpenapiClient.configure do |config|
|
|
|
617
595
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
618
596
|
end
|
|
619
597
|
|
|
620
|
-
api_instance =
|
|
598
|
+
api_instance = ShipEngine::ShipmentsApi.new
|
|
621
599
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
622
|
-
update_shipment_request_body =
|
|
600
|
+
update_shipment_request_body = ShipEngine::UpdateShipmentRequestBody.new # UpdateShipmentRequestBody |
|
|
623
601
|
|
|
624
602
|
begin
|
|
625
603
|
#Update Shipment By ID
|
|
626
604
|
result = api_instance.update_shipment(shipment_id, update_shipment_request_body)
|
|
627
605
|
p result
|
|
628
|
-
rescue
|
|
606
|
+
rescue ShipEngine::ApiError => e
|
|
629
607
|
puts "Exception when calling ShipmentsApi->update_shipment: #{e}"
|
|
630
608
|
end
|
|
631
609
|
```
|
|
632
610
|
|
|
633
611
|
### Parameters
|
|
634
612
|
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
**
|
|
639
|
-
**update_shipment_request_body** | [**UpdateShipmentRequestBody**](UpdateShipmentRequestBody.md)| |
|
|
613
|
+
| Name | Type | Description | Notes |
|
|
614
|
+
| -------------------------------- | ------------------------------------------------------------- | ----------- | ----- |
|
|
615
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
616
|
+
| **update_shipment_request_body** | [**UpdateShipmentRequestBody**](UpdateShipmentRequestBody.md) | |
|
|
640
617
|
|
|
641
618
|
### Return type
|
|
642
619
|
|
|
@@ -650,4 +627,3 @@ Name | Type | Description | Notes
|
|
|
650
627
|
|
|
651
628
|
- **Content-Type**: application/json
|
|
652
629
|
- **Accept**: application/json
|
|
653
|
-
|