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/InsuranceProvider.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::InsuranceProvider
|
|
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::InsuranceProvider.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::InternationalShipmentOptions
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**contents**
|
|
8
|
-
**non_delivery**
|
|
9
|
-
**customs_items** | [**Array<CustomsItem>**](CustomsItem.md) | Customs declarations for each item in the shipment.
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------- |
|
|
7
|
+
| **contents** | [**PackageContents**](PackageContents.md) | The type of contents in this shipment. This may impact import duties or customs treatment. |
|
|
8
|
+
| **non_delivery** | [**NonDelivery**](NonDelivery.md) | Indicates what to do if a package is unable to be delivered. |
|
|
9
|
+
| **customs_items** | [**Array<CustomsItem>**](CustomsItem.md) | Customs declarations for each item in the shipment. | [optional] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'OpenapiClient'
|
|
15
15
|
|
|
16
|
-
instance =
|
|
16
|
+
instance = ShipEngine::InternationalShipmentOptions.new(contents: null,
|
|
17
17
|
non_delivery: null,
|
|
18
18
|
customs_items: null)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/Label.md
CHANGED
|
@@ -1,49 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::Label
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**label_id** | **String** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly]
|
|
8
|
-
**status** | [**LabelStatus**](LabelStatus.md) | | [optional] [readonly]
|
|
9
|
-
**shipment_id** | **String** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly]
|
|
10
|
-
**shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional]
|
|
11
|
-
**ship_date** | **DateTime** | The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly]
|
|
12
|
-
**created_at** | **DateTime** | The date and time that the label was created in ShipEngine. | [optional] [readonly]
|
|
13
|
-
**shipment_cost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly]
|
|
14
|
-
**insurance_cost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly]
|
|
15
|
-
**tracking_number** | **String** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly]
|
|
16
|
-
**is_return_label** | **Boolean** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional]
|
|
17
|
-
**rma_number** | **String** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional]
|
|
18
|
-
**is_international** | **Boolean** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly]
|
|
19
|
-
**batch_id** | **String** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly]
|
|
20
|
-
**carrier_id** | **String** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly]
|
|
21
|
-
**charge_event** | [**LabelChargeEvent**](LabelChargeEvent.md) | The label charge event. | [optional]
|
|
22
|
-
**outbound_label_id** | **String** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional]
|
|
23
|
-
**service_code** | **String** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly]
|
|
7
|
+
**label_id** | **String** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. | [optional] [readonly]
|
|
8
|
+
**status** | [**LabelStatus**](LabelStatus.md) | | [optional] [readonly]
|
|
9
|
+
**shipment_id** | **String** | The shipment that this label is for. ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) | [optional] [readonly]
|
|
10
|
+
**shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional]
|
|
11
|
+
**ship_date** | **DateTime** | The date that the package was (or will be) shippped. ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. | [optional] [readonly]
|
|
12
|
+
**created_at** | **DateTime** | The date and time that the label was created in ShipEngine. | [optional] [readonly]
|
|
13
|
+
**shipment_cost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges. This amount **does not** include insurance costs. | [optional] [readonly]
|
|
14
|
+
**insurance_cost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package. Add this to the `shipment_cost` field to get the total cost. | [optional] [readonly]
|
|
15
|
+
**tracking_number** | **String** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly]
|
|
16
|
+
**is_return_label** | **Boolean** | Indicates whether this is a return label. You may also want to set the `rma_number` so you know what is being returned. | [optional]
|
|
17
|
+
**rma_number** | **String** | An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value. | [optional]
|
|
18
|
+
**is_international** | **Boolean** | Indicates whether this is an international shipment. That is, the originating country and destination country are different. | [optional] [readonly]
|
|
19
|
+
**batch_id** | **String** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. | [optional] [readonly]
|
|
20
|
+
**carrier_id** | **String** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label | [optional] [readonly]
|
|
21
|
+
**charge_event** | [**LabelChargeEvent**](LabelChargeEvent.md) | The label charge event. | [optional]
|
|
22
|
+
**outbound_label_id** | **String** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. | [optional]
|
|
23
|
+
**service_code** | **String** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. | [optional] [readonly]
|
|
24
24
|
**test_label** | **Boolean** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false]
|
|
25
|
-
**package_code** | **String** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly]
|
|
26
|
-
**validate_address** | [**ValidateAddress**](ValidateAddress.md) | | [optional]
|
|
27
|
-
**voided** | **Boolean** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly]
|
|
28
|
-
**voided_at** | **DateTime** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly]
|
|
29
|
-
**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) | | [optional]
|
|
30
|
-
**label_format** | [**LabelFormat**](LabelFormat.md) | The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. | [optional]
|
|
31
|
-
**label_layout** | [**LabelLayout**](LabelLayout.md) | The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. | [optional]
|
|
32
|
-
**trackable** | **Boolean** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly]
|
|
33
|
-
**label_image_id** | **String** | The label image resource that was used to create a custom label image. | [optional]
|
|
34
|
-
**carrier_code** | **String** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly]
|
|
35
|
-
**tracking_status** | [**TrackingStatus**](TrackingStatus.md) | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly]
|
|
36
|
-
**label_download** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly]
|
|
37
|
-
**form_download** | [**Link**](Link.md) | The link to downlaod the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly]
|
|
38
|
-
**insurance_claim** | [**Link**](Link.md) | The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission. | [optional] [readonly]
|
|
39
|
-
**packages** | [**Array<Package>**](Package.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly]
|
|
25
|
+
**package_code** | **String** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc. The code `package` indicates a custom or unknown package type. | [optional] [readonly]
|
|
26
|
+
**validate_address** | [**ValidateAddress**](ValidateAddress.md) | | [optional]
|
|
27
|
+
**voided** | **Boolean** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) | [optional] [readonly]
|
|
28
|
+
**voided_at** | **DateTime** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided | [optional] [readonly]
|
|
29
|
+
**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) | | [optional]
|
|
30
|
+
**label_format** | [**LabelFormat**](LabelFormat.md) | The file format that you want the label to be in. We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. | [optional]
|
|
31
|
+
**label_layout** | [**LabelLayout**](LabelLayout.md) | The layout (size) that you want the label to be in. The `label_format` determines which sizes are allowed. `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. | [optional]
|
|
32
|
+
**trackable** | **Boolean** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. | [optional] [readonly]
|
|
33
|
+
**label_image_id** | **String** | The label image resource that was used to create a custom label image. | [optional]
|
|
34
|
+
**carrier_code** | **String** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. | [optional] [readonly]
|
|
35
|
+
**tracking_status** | [**TrackingStatus**](TrackingStatus.md) | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly]
|
|
36
|
+
**label_download** | [**LabelDownload**](LabelDownload.md) | | [optional] [readonly]
|
|
37
|
+
**form_download** | [**Link**](Link.md) | The link to downlaod the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. | [optional] [readonly]
|
|
38
|
+
**insurance_claim** | [**Link**](Link.md) | The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission. | [optional] [readonly]
|
|
39
|
+
**packages** | [**Array<Package>**](Package.md) | The label's package(s). > **Note:** Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. | [optional] [readonly]
|
|
40
40
|
|
|
41
41
|
## Code Sample
|
|
42
42
|
|
|
43
43
|
```ruby
|
|
44
44
|
require 'OpenapiClient'
|
|
45
45
|
|
|
46
|
-
instance =
|
|
46
|
+
instance = ShipEngine::Label.new(label_id: null,
|
|
47
47
|
status: null,
|
|
48
48
|
shipment_id: null,
|
|
49
49
|
shipment: null,
|
data/docs/LabelChargeEvent.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelChargeEvent
|
|
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::LabelChargeEvent.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/LabelDownload.md
CHANGED
|
@@ -1,23 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelDownload
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**href** | **String** | The URL of the linked resource, if any | [optional]
|
|
8
|
-
**pdf**
|
|
9
|
-
**png**
|
|
10
|
-
**zpl**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------- | ---------- | -------------------------------------- | ---------- |
|
|
7
|
+
| **href** | **String** | The URL of the linked resource, if any | [optional] |
|
|
8
|
+
| **pdf** | **String** | The URL for the pdf generated label | [optional] |
|
|
9
|
+
| **png** | **String** | The URL for the png generated label | [optional] |
|
|
10
|
+
| **zpl** | **String** | The URL for the zpl generated label | [optional] |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
|
13
13
|
|
|
14
14
|
```ruby
|
|
15
15
|
require 'OpenapiClient'
|
|
16
16
|
|
|
17
|
-
instance =
|
|
17
|
+
instance = ShipEngine::LabelDownload.new(href: null,
|
|
18
18
|
pdf: null,
|
|
19
19
|
png: null,
|
|
20
20
|
zpl: null)
|
|
21
21
|
```
|
|
22
|
-
|
|
23
|
-
|
data/docs/LabelDownloadType.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelDownloadType
|
|
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::LabelDownloadType.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/LabelFormat.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelFormat
|
|
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::LabelFormat.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/LabelLayout.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelLayout
|
|
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::LabelLayout.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/LabelMessages.md
CHANGED
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelMessages
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**reference1** | **String** | The first line of the custom label message.
|
|
8
|
-
**reference2** | **String** | The second line of the custom label message.
|
|
9
|
-
**reference3** | **String** | The third line of the custom label message.
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| -------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
|
|
7
|
+
| **reference1** | **String** | The first line of the custom label message. Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc. | [default to 'null'] |
|
|
8
|
+
| **reference2** | **String** | The second line of the custom label message. Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc. | [default to 'null'] |
|
|
9
|
+
| **reference3** | **String** | The third line of the custom label message. Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc. | [default to 'null'] |
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'OpenapiClient'
|
|
15
15
|
|
|
16
|
-
instance =
|
|
16
|
+
instance = ShipEngine::LabelMessages.new(reference1: null,
|
|
17
17
|
reference2: null,
|
|
18
18
|
reference3: null)
|
|
19
19
|
```
|
|
20
|
-
|
|
21
|
-
|
data/docs/LabelStatus.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelStatus
|
|
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::LabelStatus.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/LabelsApi.md
CHANGED
|
@@ -1,20 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::LabelsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.shipengine.com*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**create_label**](LabelsApi.md#create_label)
|
|
8
|
-
[**create_label_from_rate**](LabelsApi.md#create_label_from_rate)
|
|
9
|
-
[**create_label_from_shipment**](LabelsApi.md#create_label_from_shipment)
|
|
10
|
-
[**create_return_label**](LabelsApi.md#create_return_label)
|
|
11
|
-
[**get_label_by_external_shipment_id**](LabelsApi.md#get_label_by_external_shipment_id) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID
|
|
12
|
-
[**get_label_by_id**](LabelsApi.md#get_label_by_id)
|
|
13
|
-
[**get_tracking_log_from_label**](LabelsApi.md#get_tracking_log_from_label)
|
|
14
|
-
[**list_labels**](LabelsApi.md#list_labels)
|
|
15
|
-
[**void_label**](LabelsApi.md#void_label)
|
|
16
|
-
|
|
17
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| --------------------------------------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------- |
|
|
7
|
+
| [**create_label**](LabelsApi.md#create_label) | **POST** /v1/labels | Purchase Label |
|
|
8
|
+
| [**create_label_from_rate**](LabelsApi.md#create_label_from_rate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID |
|
|
9
|
+
| [**create_label_from_shipment**](LabelsApi.md#create_label_from_shipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID |
|
|
10
|
+
| [**create_return_label**](LabelsApi.md#create_return_label) | **POST** /v1/labels/{label_id}/return | Create a return label |
|
|
11
|
+
| [**get_label_by_external_shipment_id**](LabelsApi.md#get_label_by_external_shipment_id) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID |
|
|
12
|
+
| [**get_label_by_id**](LabelsApi.md#get_label_by_id) | **GET** /v1/labels/{label_id} | Get Label By ID |
|
|
13
|
+
| [**get_tracking_log_from_label**](LabelsApi.md#get_tracking_log_from_label) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information |
|
|
14
|
+
| [**list_labels**](LabelsApi.md#list_labels) | **GET** /v1/labels | List labels |
|
|
15
|
+
| [**void_label**](LabelsApi.md#void_label) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID |
|
|
18
16
|
|
|
19
17
|
## create_label
|
|
20
18
|
|
|
@@ -37,24 +35,23 @@ OpenapiClient.configure do |config|
|
|
|
37
35
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
38
36
|
end
|
|
39
37
|
|
|
40
|
-
api_instance =
|
|
41
|
-
create_label_request_body =
|
|
38
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
39
|
+
create_label_request_body = ShipEngine::CreateLabelRequestBody.new # CreateLabelRequestBody |
|
|
42
40
|
|
|
43
41
|
begin
|
|
44
42
|
#Purchase Label
|
|
45
43
|
result = api_instance.create_label(create_label_request_body)
|
|
46
44
|
p result
|
|
47
|
-
rescue
|
|
45
|
+
rescue ShipEngine::ApiError => e
|
|
48
46
|
puts "Exception when calling LabelsApi->create_label: #{e}"
|
|
49
47
|
end
|
|
50
48
|
```
|
|
51
49
|
|
|
52
50
|
### Parameters
|
|
53
51
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
**create_label_request_body** | [**CreateLabelRequestBody**](CreateLabelRequestBody.md)| |
|
|
52
|
+
| Name | Type | Description | Notes |
|
|
53
|
+
| ----------------------------- | ------------------------------------------------------- | ----------- | ----- |
|
|
54
|
+
| **create_label_request_body** | [**CreateLabelRequestBody**](CreateLabelRequestBody.md) | |
|
|
58
55
|
|
|
59
56
|
### Return type
|
|
60
57
|
|
|
@@ -69,14 +66,13 @@ Name | Type | Description | Notes
|
|
|
69
66
|
- **Content-Type**: application/json
|
|
70
67
|
- **Accept**: application/json
|
|
71
68
|
|
|
72
|
-
|
|
73
69
|
## create_label_from_rate
|
|
74
70
|
|
|
75
71
|
> CreateLabelFromRateResponseBody create_label_from_rate(rate_id, create_label_from_rate_request_body)
|
|
76
72
|
|
|
77
73
|
Purchase Label with Rate ID
|
|
78
74
|
|
|
79
|
-
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.
|
|
75
|
+
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.
|
|
80
76
|
|
|
81
77
|
### Example
|
|
82
78
|
|
|
@@ -91,26 +87,25 @@ OpenapiClient.configure do |config|
|
|
|
91
87
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
92
88
|
end
|
|
93
89
|
|
|
94
|
-
api_instance =
|
|
90
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
95
91
|
rate_id = 'rate_id_example' # String | Rate ID
|
|
96
|
-
create_label_from_rate_request_body =
|
|
92
|
+
create_label_from_rate_request_body = ShipEngine::CreateLabelFromRateRequestBody.new # CreateLabelFromRateRequestBody |
|
|
97
93
|
|
|
98
94
|
begin
|
|
99
95
|
#Purchase Label with Rate ID
|
|
100
96
|
result = api_instance.create_label_from_rate(rate_id, create_label_from_rate_request_body)
|
|
101
97
|
p result
|
|
102
|
-
rescue
|
|
98
|
+
rescue ShipEngine::ApiError => e
|
|
103
99
|
puts "Exception when calling LabelsApi->create_label_from_rate: #{e}"
|
|
104
100
|
end
|
|
105
101
|
```
|
|
106
102
|
|
|
107
103
|
### Parameters
|
|
108
104
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
**
|
|
113
|
-
**create_label_from_rate_request_body** | [**CreateLabelFromRateRequestBody**](CreateLabelFromRateRequestBody.md)| |
|
|
105
|
+
| Name | Type | Description | Notes |
|
|
106
|
+
| --------------------------------------- | ----------------------------------------------------------------------- | ----------- | ----- |
|
|
107
|
+
| **rate_id** | **String** | Rate ID |
|
|
108
|
+
| **create_label_from_rate_request_body** | [**CreateLabelFromRateRequestBody**](CreateLabelFromRateRequestBody.md) | |
|
|
114
109
|
|
|
115
110
|
### Return type
|
|
116
111
|
|
|
@@ -125,14 +120,13 @@ Name | Type | Description | Notes
|
|
|
125
120
|
- **Content-Type**: application/json
|
|
126
121
|
- **Accept**: application/json
|
|
127
122
|
|
|
128
|
-
|
|
129
123
|
## create_label_from_shipment
|
|
130
124
|
|
|
131
125
|
> CreateLabelFromShipmentResponseBody create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
|
|
132
126
|
|
|
133
127
|
Purchase Label with Shipment ID
|
|
134
128
|
|
|
135
|
-
Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
129
|
+
Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
|
136
130
|
|
|
137
131
|
### Example
|
|
138
132
|
|
|
@@ -147,26 +141,25 @@ OpenapiClient.configure do |config|
|
|
|
147
141
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
148
142
|
end
|
|
149
143
|
|
|
150
|
-
api_instance =
|
|
144
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
151
145
|
shipment_id = 'shipment_id_example' # String | Shipment ID
|
|
152
|
-
create_label_from_shipment_request_body =
|
|
146
|
+
create_label_from_shipment_request_body = ShipEngine::CreateLabelFromShipmentRequestBody.new # CreateLabelFromShipmentRequestBody |
|
|
153
147
|
|
|
154
148
|
begin
|
|
155
149
|
#Purchase Label with Shipment ID
|
|
156
150
|
result = api_instance.create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
|
|
157
151
|
p result
|
|
158
|
-
rescue
|
|
152
|
+
rescue ShipEngine::ApiError => e
|
|
159
153
|
puts "Exception when calling LabelsApi->create_label_from_shipment: #{e}"
|
|
160
154
|
end
|
|
161
155
|
```
|
|
162
156
|
|
|
163
157
|
### Parameters
|
|
164
158
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
**
|
|
169
|
-
**create_label_from_shipment_request_body** | [**CreateLabelFromShipmentRequestBody**](CreateLabelFromShipmentRequestBody.md)| |
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
| ------------------------------------------- | ------------------------------------------------------------------------------- | ----------- | ----- |
|
|
161
|
+
| **shipment_id** | **String** | Shipment ID |
|
|
162
|
+
| **create_label_from_shipment_request_body** | [**CreateLabelFromShipmentRequestBody**](CreateLabelFromShipmentRequestBody.md) | |
|
|
170
163
|
|
|
171
164
|
### Return type
|
|
172
165
|
|
|
@@ -181,7 +174,6 @@ Name | Type | Description | Notes
|
|
|
181
174
|
- **Content-Type**: application/json
|
|
182
175
|
- **Accept**: application/json
|
|
183
176
|
|
|
184
|
-
|
|
185
177
|
## create_return_label
|
|
186
178
|
|
|
187
179
|
> CreateReturnLabelResponseBody create_return_label(label_id, create_return_label_request_body)
|
|
@@ -203,26 +195,25 @@ OpenapiClient.configure do |config|
|
|
|
203
195
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
204
196
|
end
|
|
205
197
|
|
|
206
|
-
api_instance =
|
|
198
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
207
199
|
label_id = 'label_id_example' # String | Label ID
|
|
208
|
-
create_return_label_request_body =
|
|
200
|
+
create_return_label_request_body = ShipEngine::CreateReturnLabelRequestBody.new # CreateReturnLabelRequestBody |
|
|
209
201
|
|
|
210
202
|
begin
|
|
211
203
|
#Create a return label
|
|
212
204
|
result = api_instance.create_return_label(label_id, create_return_label_request_body)
|
|
213
205
|
p result
|
|
214
|
-
rescue
|
|
206
|
+
rescue ShipEngine::ApiError => e
|
|
215
207
|
puts "Exception when calling LabelsApi->create_return_label: #{e}"
|
|
216
208
|
end
|
|
217
209
|
```
|
|
218
210
|
|
|
219
211
|
### Parameters
|
|
220
212
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
**
|
|
225
|
-
**create_return_label_request_body** | [**CreateReturnLabelRequestBody**](CreateReturnLabelRequestBody.md)| |
|
|
213
|
+
| Name | Type | Description | Notes |
|
|
214
|
+
| ------------------------------------ | ------------------------------------------------------------------- | ----------- | ----- |
|
|
215
|
+
| **label_id** | **String** | Label ID |
|
|
216
|
+
| **create_return_label_request_body** | [**CreateReturnLabelRequestBody**](CreateReturnLabelRequestBody.md) | |
|
|
226
217
|
|
|
227
218
|
### Return type
|
|
228
219
|
|
|
@@ -237,14 +228,13 @@ Name | Type | Description | Notes
|
|
|
237
228
|
- **Content-Type**: application/json
|
|
238
229
|
- **Accept**: application/json
|
|
239
230
|
|
|
240
|
-
|
|
241
231
|
## get_label_by_external_shipment_id
|
|
242
232
|
|
|
243
233
|
> GetLabelByExternalShipmentIdResponseBody get_label_by_external_shipment_id(external_shipment_id, opts)
|
|
244
234
|
|
|
245
235
|
Get Label By External Shipment ID
|
|
246
236
|
|
|
247
|
-
Find a label by using the external shipment id that was used during label creation
|
|
237
|
+
Find a label by using the external shipment id that was used during label creation
|
|
248
238
|
|
|
249
239
|
### Example
|
|
250
240
|
|
|
@@ -259,28 +249,27 @@ OpenapiClient.configure do |config|
|
|
|
259
249
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
260
250
|
end
|
|
261
251
|
|
|
262
|
-
api_instance =
|
|
263
|
-
external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String |
|
|
252
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
253
|
+
external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String |
|
|
264
254
|
opts = {
|
|
265
|
-
label_download_type:
|
|
255
|
+
label_download_type: ShipEngine::LabelDownloadType.new # LabelDownloadType |
|
|
266
256
|
}
|
|
267
257
|
|
|
268
258
|
begin
|
|
269
259
|
#Get Label By External Shipment ID
|
|
270
260
|
result = api_instance.get_label_by_external_shipment_id(external_shipment_id, opts)
|
|
271
261
|
p result
|
|
272
|
-
rescue
|
|
262
|
+
rescue ShipEngine::ApiError => e
|
|
273
263
|
puts "Exception when calling LabelsApi->get_label_by_external_shipment_id: #{e}"
|
|
274
264
|
end
|
|
275
265
|
```
|
|
276
266
|
|
|
277
267
|
### Parameters
|
|
278
268
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
**
|
|
283
|
-
**label_download_type** | [**LabelDownloadType**](.md)| | [optional]
|
|
269
|
+
| Name | Type | Description | Notes |
|
|
270
|
+
| ------------------------ | ---------------------------- | ----------- | ---------- |
|
|
271
|
+
| **external_shipment_id** | **String** | |
|
|
272
|
+
| **label_download_type** | [**LabelDownloadType**](.md) | | [optional] |
|
|
284
273
|
|
|
285
274
|
### Return type
|
|
286
275
|
|
|
@@ -295,7 +284,6 @@ Name | Type | Description | Notes
|
|
|
295
284
|
- **Content-Type**: Not defined
|
|
296
285
|
- **Accept**: application/json
|
|
297
286
|
|
|
298
|
-
|
|
299
287
|
## get_label_by_id
|
|
300
288
|
|
|
301
289
|
> GetLabelByIdResponseBody get_label_by_id(label_id, opts)
|
|
@@ -317,28 +305,27 @@ OpenapiClient.configure do |config|
|
|
|
317
305
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
318
306
|
end
|
|
319
307
|
|
|
320
|
-
api_instance =
|
|
308
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
321
309
|
label_id = 'label_id_example' # String | Label ID
|
|
322
310
|
opts = {
|
|
323
|
-
label_download_type:
|
|
311
|
+
label_download_type: ShipEngine::LabelDownloadType.new # LabelDownloadType |
|
|
324
312
|
}
|
|
325
313
|
|
|
326
314
|
begin
|
|
327
315
|
#Get Label By ID
|
|
328
316
|
result = api_instance.get_label_by_id(label_id, opts)
|
|
329
317
|
p result
|
|
330
|
-
rescue
|
|
318
|
+
rescue ShipEngine::ApiError => e
|
|
331
319
|
puts "Exception when calling LabelsApi->get_label_by_id: #{e}"
|
|
332
320
|
end
|
|
333
321
|
```
|
|
334
322
|
|
|
335
323
|
### Parameters
|
|
336
324
|
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
**
|
|
341
|
-
**label_download_type** | [**LabelDownloadType**](.md)| | [optional]
|
|
325
|
+
| Name | Type | Description | Notes |
|
|
326
|
+
| ----------------------- | ---------------------------- | ----------- | ---------- |
|
|
327
|
+
| **label_id** | **String** | Label ID |
|
|
328
|
+
| **label_download_type** | [**LabelDownloadType**](.md) | | [optional] |
|
|
342
329
|
|
|
343
330
|
### Return type
|
|
344
331
|
|
|
@@ -353,7 +340,6 @@ Name | Type | Description | Notes
|
|
|
353
340
|
- **Content-Type**: Not defined
|
|
354
341
|
- **Accept**: application/json
|
|
355
342
|
|
|
356
|
-
|
|
357
343
|
## get_tracking_log_from_label
|
|
358
344
|
|
|
359
345
|
> GetTrackingLogFromLabelResponseBody get_tracking_log_from_label(label_id)
|
|
@@ -375,24 +361,23 @@ OpenapiClient.configure do |config|
|
|
|
375
361
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
376
362
|
end
|
|
377
363
|
|
|
378
|
-
api_instance =
|
|
364
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
379
365
|
label_id = 'label_id_example' # String | Label ID
|
|
380
366
|
|
|
381
367
|
begin
|
|
382
368
|
#Get Label Tracking Information
|
|
383
369
|
result = api_instance.get_tracking_log_from_label(label_id)
|
|
384
370
|
p result
|
|
385
|
-
rescue
|
|
371
|
+
rescue ShipEngine::ApiError => e
|
|
386
372
|
puts "Exception when calling LabelsApi->get_tracking_log_from_label: #{e}"
|
|
387
373
|
end
|
|
388
374
|
```
|
|
389
375
|
|
|
390
376
|
### Parameters
|
|
391
377
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
**label_id** | **String**| Label ID |
|
|
378
|
+
| Name | Type | Description | Notes |
|
|
379
|
+
| ------------ | ---------- | ----------- | ----- |
|
|
380
|
+
| **label_id** | **String** | Label ID |
|
|
396
381
|
|
|
397
382
|
### Return type
|
|
398
383
|
|
|
@@ -407,14 +392,13 @@ Name | Type | Description | Notes
|
|
|
407
392
|
- **Content-Type**: Not defined
|
|
408
393
|
- **Accept**: application/json
|
|
409
394
|
|
|
410
|
-
|
|
411
395
|
## list_labels
|
|
412
396
|
|
|
413
397
|
> ListLabelsResponseBody list_labels(opts)
|
|
414
398
|
|
|
415
399
|
List labels
|
|
416
400
|
|
|
417
|
-
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.
|
|
401
|
+
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`
|
|
418
402
|
|
|
419
403
|
### Example
|
|
420
404
|
|
|
@@ -429,9 +413,9 @@ OpenapiClient.configure do |config|
|
|
|
429
413
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
430
414
|
end
|
|
431
415
|
|
|
432
|
-
api_instance =
|
|
416
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
433
417
|
opts = {
|
|
434
|
-
label_status:
|
|
418
|
+
label_status: ShipEngine::LabelStatus.new, # LabelStatus | Only return labels that are currently in the specified status
|
|
435
419
|
service_code: 'usps_first_class_mail', # String | Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
|
|
436
420
|
carrier_id: 'carrier_id_example', # String | Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)
|
|
437
421
|
tracking_number: '9.405511899223197E+21', # String | Only return labels with a specific tracking number
|
|
@@ -441,9 +425,9 @@ opts = {
|
|
|
441
425
|
warehouse_id: 'warehouse_id_example', # String | Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)
|
|
442
426
|
created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Only return labels that were created on or after a specific date/time
|
|
443
427
|
created_at_end: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Only return labels that were created on or before a specific date/time
|
|
444
|
-
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.
|
|
428
|
+
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.
|
|
445
429
|
page_size: 25, # Integer | The number of results to return per response.
|
|
446
|
-
sort_dir:
|
|
430
|
+
sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
|
|
447
431
|
sort_by: 'created_at' # String | Controls which field the query is sorted by.
|
|
448
432
|
}
|
|
449
433
|
|
|
@@ -451,30 +435,29 @@ begin
|
|
|
451
435
|
#List labels
|
|
452
436
|
result = api_instance.list_labels(opts)
|
|
453
437
|
p result
|
|
454
|
-
rescue
|
|
438
|
+
rescue ShipEngine::ApiError => e
|
|
455
439
|
puts "Exception when calling LabelsApi->list_labels: #{e}"
|
|
456
440
|
end
|
|
457
441
|
```
|
|
458
442
|
|
|
459
443
|
### Parameters
|
|
460
444
|
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
**
|
|
465
|
-
**
|
|
466
|
-
**
|
|
467
|
-
**
|
|
468
|
-
**
|
|
469
|
-
**
|
|
470
|
-
**
|
|
471
|
-
**
|
|
472
|
-
**
|
|
473
|
-
**
|
|
474
|
-
**
|
|
475
|
-
**
|
|
476
|
-
**
|
|
477
|
-
**sort_by** | **String**| Controls which field the query is sorted by. | [optional] [default to 'created_at']
|
|
445
|
+
| Name | Type | Description | Notes |
|
|
446
|
+
| -------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
|
447
|
+
| **label_status** | [**LabelStatus**](.md) | Only return labels that are currently in the specified status | [optional] |
|
|
448
|
+
| **service_code** | **String** | Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) | [optional] |
|
|
449
|
+
| **carrier_id** | **String** | Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) | [optional] |
|
|
450
|
+
| **tracking_number** | **String** | Only return labels with a specific tracking number | [optional] |
|
|
451
|
+
| **batch_id** | **String** | Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/) | [optional] |
|
|
452
|
+
| **rate_id** | **String** | Rate ID | [optional] |
|
|
453
|
+
| **shipment_id** | **String** | Shipment ID | [optional] |
|
|
454
|
+
| **warehouse_id** | **String** | Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) | [optional] |
|
|
455
|
+
| **created_at_start** | **DateTime** | Only return labels that were created on or after a specific date/time | [optional] |
|
|
456
|
+
| **created_at_end** | **DateTime** | Only return labels that were created on or before a specific date/time | [optional] |
|
|
457
|
+
| **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] |
|
|
458
|
+
| **page_size** | **Integer** | The number of results to return per response. | [optional] [default to 25] |
|
|
459
|
+
| **sort_dir** | [**SortDir**](.md) | Controls the sort order of the query. | [optional] |
|
|
460
|
+
| **sort_by** | **String** | Controls which field the query is sorted by. | [optional] [default to 'created_at'] |
|
|
478
461
|
|
|
479
462
|
### Return type
|
|
480
463
|
|
|
@@ -489,7 +472,6 @@ Name | Type | Description | Notes
|
|
|
489
472
|
- **Content-Type**: Not defined
|
|
490
473
|
- **Accept**: application/json
|
|
491
474
|
|
|
492
|
-
|
|
493
475
|
## void_label
|
|
494
476
|
|
|
495
477
|
> VoidLabelResponseBody void_label(label_id)
|
|
@@ -511,24 +493,23 @@ OpenapiClient.configure do |config|
|
|
|
511
493
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
512
494
|
end
|
|
513
495
|
|
|
514
|
-
api_instance =
|
|
496
|
+
api_instance = ShipEngine::LabelsApi.new
|
|
515
497
|
label_id = 'label_id_example' # String | Label ID
|
|
516
498
|
|
|
517
499
|
begin
|
|
518
500
|
#Void a Label By ID
|
|
519
501
|
result = api_instance.void_label(label_id)
|
|
520
502
|
p result
|
|
521
|
-
rescue
|
|
503
|
+
rescue ShipEngine::ApiError => e
|
|
522
504
|
puts "Exception when calling LabelsApi->void_label: #{e}"
|
|
523
505
|
end
|
|
524
506
|
```
|
|
525
507
|
|
|
526
508
|
### Parameters
|
|
527
509
|
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
**label_id** | **String**| Label ID |
|
|
510
|
+
| Name | Type | Description | Notes |
|
|
511
|
+
| ------------ | ---------- | ----------- | ----- |
|
|
512
|
+
| **label_id** | **String** | Label ID |
|
|
532
513
|
|
|
533
514
|
### Return type
|
|
534
515
|
|
|
@@ -542,4 +523,3 @@ Name | Type | Description | Notes
|
|
|
542
523
|
|
|
543
524
|
- **Content-Type**: Not defined
|
|
544
525
|
- **Accept**: application/json
|
|
545
|
-
|