ship_engine 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AddFundsToCarrierRequestBody.md +1 -1
- data/docs/AddFundsToCarrierResponseBody.md +1 -1
- data/docs/AddFundsToInsuranceRequestBody.md +1 -1
- data/docs/AddFundsToInsuranceResponseBody.md +1 -1
- data/docs/AddToBatchRequestBody.md +1 -1
- data/docs/Address.md +1 -1
- data/docs/AddressResidentialIndicator.md +1 -1
- data/docs/AddressToValidate.md +1 -1
- data/docs/AddressValidatingShipment.md +1 -1
- data/docs/AddressValidationCode.md +1 -1
- data/docs/AddressValidationDetailCode.md +1 -1
- data/docs/AddressValidationMessageType.md +1 -1
- data/docs/AddressValidationResult.md +1 -1
- data/docs/AddressValidationStatus.md +1 -1
- data/docs/AddressesApi.md +2 -2
- data/docs/AdvancedShipmentOptions.md +1 -1
- data/docs/AncillaryServiceEndorsement.md +1 -1
- data/docs/Batch.md +1 -1
- data/docs/BatchResponseError.md +1 -1
- data/docs/BatchStatus.md +1 -1
- data/docs/BatchesApi.md +10 -10
- data/docs/BatchesSortBy.md +1 -1
- data/docs/BillToParty.md +1 -1
- data/docs/BulkRate.md +1 -1
- data/docs/CalculateRatesRequestBody.md +1 -1
- data/docs/CalculateRatesResponseBody.md +1 -1
- data/docs/Carrier.md +1 -1
- data/docs/CarrierAccountsApi.md +4 -4
- data/docs/CarrierAdvancedOption.md +1 -1
- data/docs/CarrierName.md +1 -1
- data/docs/CarrierNameWithSettings.md +1 -1
- data/docs/CarriersApi.md +6 -6
- data/docs/CollectOnDelivery.md +1 -1
- data/docs/CollectOnDeliveryPaymentType.md +1 -1
- data/docs/CompareBulkRatesRequestBody.md +1 -1
- data/docs/ConnectAccessWorldwideRequestBody.md +1 -1
- data/docs/ConnectAmazonBuyShippingRequestBody.md +1 -1
- data/docs/ConnectApcRequestBody.md +1 -1
- data/docs/ConnectAsendiaRequestBody.md +1 -1
- data/docs/ConnectAustraliaPostRequestBody.md +1 -1
- data/docs/ConnectCanadaPostRequestBody.md +1 -1
- data/docs/ConnectCarrierRequestBody.md +1 -1
- data/docs/ConnectCarrierResponseBody.md +1 -1
- data/docs/ConnectDhlEcommerceRequestBody.md +1 -1
- data/docs/ConnectDhlExpressAuRequestBody.md +1 -1
- data/docs/ConnectDhlExpressCaRequestBody.md +1 -1
- data/docs/ConnectDhlExpressRequestBody.md +1 -1
- data/docs/ConnectDhlExpressUkRequestBody.md +1 -1
- data/docs/ConnectDpdRequestBody.md +1 -1
- data/docs/ConnectEndiciaRequestBody.md +1 -1
- data/docs/ConnectFedexRequestBody.md +1 -1
- data/docs/ConnectFedexUkRequestBody.md +1 -1
- data/docs/ConnectFirstmileRequestBody.md +1 -1
- data/docs/ConnectGlobegisticsRequestBody.md +1 -1
- data/docs/ConnectImexRequestBody.md +1 -1
- data/docs/ConnectInsurerRequestBody.md +1 -1
- data/docs/ConnectNewgisticsRequestBody.md +1 -1
- data/docs/ConnectOntracRequestBody.md +1 -1
- data/docs/ConnectPurolatorRequestBody.md +1 -1
- data/docs/ConnectRoyalMailRequestBody.md +1 -1
- data/docs/ConnectRrDonnelleyRequestBody.md +1 -1
- data/docs/ConnectSekoRequestBody.md +1 -1
- data/docs/ConnectSendleRequestBody.md +1 -1
- data/docs/ConnectStampsRequestBody.md +1 -1
- data/docs/ConnectUpsRequestBody.md +1 -1
- data/docs/CreateAndValidateShipment.md +1 -1
- data/docs/CreateBatchRequestBody.md +1 -1
- data/docs/CreateBatchResponseBody.md +1 -1
- data/docs/CreateLabelFromRateRequestBody.md +1 -1
- data/docs/CreateLabelFromRateResponseBody.md +1 -1
- data/docs/CreateLabelFromShipmentRequestBody.md +1 -1
- data/docs/CreateLabelFromShipmentResponseBody.md +1 -1
- data/docs/CreateLabelRequestBody.md +1 -1
- data/docs/CreateLabelResponseBody.md +1 -1
- data/docs/CreateManifestByObjectRequestBody.md +1 -1
- data/docs/CreateManifestLabelIdsRequestBody.md +1 -1
- data/docs/CreateManifestRequestBody.md +1 -1
- data/docs/CreateManifestResponseBody.md +1 -1
- data/docs/CreatePackageTypeRequestBody.md +1 -1
- data/docs/CreatePackageTypeResponseBody.md +1 -1
- data/docs/CreateReturnLabelRequestBody.md +1 -1
- data/docs/CreateReturnLabelResponseBody.md +1 -1
- data/docs/CreateShipmentResponseBodyFields.md +1 -1
- data/docs/CreateShipmentsRequestBody.md +1 -1
- data/docs/CreateShipmentsResponseBody.md +1 -1
- data/docs/CreateTagResponseBody.md +1 -1
- data/docs/CreateWarehouseRequestBody.md +1 -1
- data/docs/CreateWarehouseResponseBody.md +1 -1
- data/docs/CreateWebhookRequestBody.md +5 -7
- data/docs/CreateWebhookResponseBody.md +1 -1
- data/docs/Currency.md +1 -1
- data/docs/CustomsItem.md +1 -1
- data/docs/DeliveryConfirmation.md +1 -1
- data/docs/DeprecatedManifest.md +1 -1
- data/docs/DhlExpressAccountSettings.md +1 -1
- data/docs/DhlExpressSettingsResponseBody.md +1 -1
- data/docs/DimensionUnit.md +1 -1
- data/docs/Dimensions.md +1 -1
- data/docs/DownloadsApi.md +1 -1
- data/docs/Error.md +1 -1
- data/docs/ErrorCode.md +1 -1
- data/docs/ErrorResponseBody.md +1 -1
- data/docs/ErrorSource.md +1 -1
- data/docs/ErrorType.md +1 -1
- data/docs/EstimateRatesRequestBody.md +1 -1
- data/docs/FedexAccountSettings.md +1 -1
- data/docs/FedexAccountSettingsRequestBody.md +1 -1
- data/docs/FedexPickupType.md +1 -1
- data/docs/FedexSettingsResponseBody.md +1 -1
- data/docs/GetBatchByExternalIdResponseBody.md +1 -1
- data/docs/GetBatchByIdResponseBody.md +1 -1
- data/docs/GetCarrierByIdResponseBody.md +1 -1
- data/docs/GetCarrierOptionsResponseBody.md +1 -1
- data/docs/GetCarrierSettingsResponseBody.md +1 -1
- data/docs/GetCarriersResponseBody.md +1 -1
- data/docs/GetInsuranceBalanceResponseBody.md +1 -1
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +1 -1
- data/docs/GetLabelByIdResponseBody.md +1 -1
- data/docs/GetManifestByIdResponseBody.md +1 -1
- data/docs/GetPackageTypeByIdResponseBody.md +1 -1
- data/docs/GetRateByIdResponseBody.md +1 -1
- data/docs/GetShipmentByExternalIdResponseBody.md +1 -1
- data/docs/GetShipmentByIdResponseBody.md +1 -1
- data/docs/GetTrackingLogFromLabelResponseBody.md +1 -1
- data/docs/GetTrackingLogResponseBody.md +1 -1
- data/docs/GetWarehouseByIdResponseBody.md +1 -1
- data/docs/GetWebhookByIdResponseBody.md +1 -1
- data/docs/InsuranceApi.md +4 -4
- data/docs/InsuranceProvider.md +1 -1
- data/docs/InternationalShipmentOptions.md +1 -1
- data/docs/Label.md +36 -38
- data/docs/LabelChargeEvent.md +1 -1
- data/docs/LabelDownload.md +1 -1
- data/docs/LabelDownloadType.md +1 -1
- data/docs/LabelFormat.md +1 -1
- data/docs/LabelLayout.md +1 -1
- data/docs/LabelMessages.md +1 -1
- data/docs/LabelStatus.md +1 -1
- data/docs/LabelsApi.md +9 -9
- data/docs/Link.md +1 -1
- data/docs/ListBatchErrorsResponseBody.md +1 -1
- data/docs/ListBatchesResponseBody.md +1 -1
- data/docs/ListCarrierPackageTypesResponseBody.md +1 -1
- data/docs/ListCarrierServicesResponseBody.md +1 -1
- data/docs/ListCarriersResponseBody.md +1 -1
- data/docs/ListLabelsResponseBody.md +1 -1
- data/docs/ListManifestsResponseBody.md +1 -1
- data/docs/ListPackageTypesResponseBody.md +1 -1
- data/docs/ListShipmentErrorsResponseBody.md +1 -1
- data/docs/ListShipmentRatesResponseBody.md +1 -1
- data/docs/ListShipmentsResponseBody.md +1 -1
- data/docs/ListTagsResponseBody.md +1 -1
- data/docs/ListWarehousesResponseBody.md +1 -1
- data/docs/Manifest.md +1 -1
- data/docs/ManifestDownload.md +1 -1
- data/docs/Manifests.md +1 -1
- data/docs/ManifestsApi.md +3 -3
- data/docs/ModifyBatch.md +1 -1
- data/docs/MonetaryValue.md +1 -1
- data/docs/NonDelivery.md +1 -1
- data/docs/OptionalLink.md +1 -1
- data/docs/OrderSourceName.md +1 -1
- data/docs/Package.md +1 -1
- data/docs/PackageContents.md +1 -1
- data/docs/PackageType.md +1 -1
- data/docs/PackageTypesApi.md +5 -5
- data/docs/PagedListResponseBody.md +1 -1
- data/docs/PaginationLink.md +1 -1
- data/docs/ParseAddressRequestBody.md +1 -1
- data/docs/ParseAddressResponseBody.md +1 -1
- data/docs/ParseShipmentRequestBody.md +1 -1
- data/docs/ParseShipmentResponseBody.md +1 -1
- data/docs/PartialAddress.md +1 -1
- data/docs/PartialShipment.md +1 -1
- data/docs/PaymentAmount.md +1 -1
- data/docs/ProcessBatchRequestBody.md +1 -1
- data/docs/PurchaseLabelWithoutShipment.md +1 -1
- data/docs/Rate.md +1 -1
- data/docs/RateEstimateByCarrierId.md +1 -1
- data/docs/RateEstimateByCarrierIds.md +4 -6
- data/docs/RateEstimateOptions.md +1 -1
- data/docs/RateRequestBody.md +1 -1
- data/docs/RateRequestByShipmentIds.md +1 -1
- data/docs/RateRequestByShipments.md +1 -1
- data/docs/RateRequestOptions.md +1 -1
- data/docs/RateRequestRateOptions.md +1 -1
- data/docs/RateResponse.md +1 -1
- data/docs/RateResponseStatus.md +1 -1
- data/docs/RateType.md +1 -1
- data/docs/RatesApi.md +4 -4
- data/docs/RatesInformation.md +1 -1
- data/docs/RecognizedEntity.md +1 -1
- data/docs/RemoveFromBatchRequestBody.md +1 -1
- data/docs/ResponseMessage.md +1 -1
- data/docs/Service.md +1 -1
- data/docs/Shipment.md +1 -1
- data/docs/ShipmentIdRequest.md +1 -1
- data/docs/ShipmentItem.md +1 -1
- data/docs/ShipmentRequest.md +1 -1
- data/docs/ShipmentResponseError.md +1 -1
- data/docs/ShipmentStatus.md +1 -1
- data/docs/ShipmentsApi.md +11 -11
- data/docs/ShipmentsSortBy.md +1 -1
- data/docs/SmartPostHub.md +1 -1
- data/docs/SortDir.md +1 -1
- data/docs/Tag.md +1 -1
- data/docs/TagShipmentResponseBody.md +1 -1
- data/docs/TagsApi.md +4 -4
- data/docs/TrackEvent.md +1 -1
- data/docs/TrackingApi.md +3 -3
- data/docs/TrackingInformation.md +1 -1
- data/docs/TrackingStatus.md +1 -1
- data/docs/UpdateAmazonBuyShippingRequestBody.md +4 -6
- data/docs/UpdateCarrierSettingsRequestBody.md +1 -1
- data/docs/UpdateDhlExpressSettingsRequestBody.md +1 -1
- data/docs/UpdateFedexSettingsRequestBody.md +1 -1
- data/docs/UpdateNewgisticsSettingsRequestBody.md +1 -1
- data/docs/UpdatePackageTypeRequestBody.md +1 -1
- data/docs/UpdateShipmentFields.md +1 -1
- data/docs/UpdateShipmentRequestBody.md +1 -1
- data/docs/UpdateShipmentResponseBody.md +1 -1
- data/docs/UpdateUpsSettingsRequestBody.md +1 -1
- data/docs/UpdateWarehouseRequestBody.md +1 -1
- data/docs/UpdateWebhookRequestBody.md +1 -1
- data/docs/UpsAccountSettings.md +1 -1
- data/docs/UpsInvoice.md +1 -1
- data/docs/UpsPickupType.md +1 -1
- data/docs/UpsSettingsResponseBody.md +1 -1
- data/docs/ValidateAddress.md +1 -1
- data/docs/ValidateShipmentFields.md +1 -1
- data/docs/ValidationStatus.md +1 -1
- data/docs/VoidLabelResponseBody.md +1 -1
- data/docs/Warehouse.md +1 -1
- data/docs/WarehousesApi.md +5 -5
- data/docs/Webhook.md +1 -1
- data/docs/WebhookEvent.md +1 -1
- data/docs/WebhooksApi.md +5 -5
- data/docs/Weight.md +1 -1
- data/docs/WeightUnit.md +1 -1
- data/lib/ship_engine/api_client.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +1 -1
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +1 -1
- data/lib/ship_engine/models/add_to_batch_request_body.rb +1 -1
- data/lib/ship_engine/models/address.rb +1 -1
- data/lib/ship_engine/models/address_to_validate.rb +1 -1
- data/lib/ship_engine/models/address_validating_shipment.rb +1 -1
- data/lib/ship_engine/models/address_validation_result.rb +1 -1
- data/lib/ship_engine/models/advanced_shipment_options.rb +1 -1
- data/lib/ship_engine/models/batch.rb +1 -1
- data/lib/ship_engine/models/batch_response_error.rb +1 -1
- data/lib/ship_engine/models/bulk_rate.rb +1 -1
- data/lib/ship_engine/models/calculate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/calculate_rates_response_body.rb +1 -1
- data/lib/ship_engine/models/carrier.rb +1 -1
- data/lib/ship_engine/models/carrier_advanced_option.rb +1 -1
- data/lib/ship_engine/models/collect_on_delivery.rb +1 -1
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_apc_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_asendia_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_carrier_request_body.rb +2 -2
- data/lib/ship_engine/models/connect_carrier_response_body.rb +1 -1
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_dpd_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_endicia_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_fedex_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_imex_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_insurer_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_purolator_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_seko_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_sendle_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_stamps_request_body.rb +1 -1
- data/lib/ship_engine/models/connect_ups_request_body.rb +1 -1
- data/lib/ship_engine/models/create_and_validate_shipment.rb +1 -1
- data/lib/ship_engine/models/create_batch_request_body.rb +1 -1
- data/lib/ship_engine/models/create_batch_response_body.rb +1 -1
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +1 -1
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +1 -1
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +1 -1
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +1 -1
- data/lib/ship_engine/models/create_label_request_body.rb +1 -1
- data/lib/ship_engine/models/create_label_response_body.rb +1 -1
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +1 -1
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +1 -1
- data/lib/ship_engine/models/create_manifest_request_body.rb +2 -2
- data/lib/ship_engine/models/create_manifest_response_body.rb +1 -1
- data/lib/ship_engine/models/create_package_type_request_body.rb +1 -1
- data/lib/ship_engine/models/create_package_type_response_body.rb +1 -1
- data/lib/ship_engine/models/create_return_label_request_body.rb +1 -1
- data/lib/ship_engine/models/create_return_label_response_body.rb +1 -1
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +1 -1
- data/lib/ship_engine/models/create_shipments_request_body.rb +1 -1
- data/lib/ship_engine/models/create_shipments_response_body.rb +1 -1
- data/lib/ship_engine/models/create_tag_response_body.rb +1 -1
- data/lib/ship_engine/models/create_warehouse_request_body.rb +1 -1
- data/lib/ship_engine/models/create_warehouse_response_body.rb +1 -1
- data/lib/ship_engine/models/create_webhook_request_body.rb +1 -1
- data/lib/ship_engine/models/create_webhook_response_body.rb +1 -1
- data/lib/ship_engine/models/customs_item.rb +1 -1
- data/lib/ship_engine/models/deprecated_manifest.rb +1 -1
- data/lib/ship_engine/models/dhl_express_account_settings.rb +1 -1
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +1 -1
- data/lib/ship_engine/models/dimensions.rb +1 -1
- data/lib/ship_engine/models/error.rb +1 -1
- data/lib/ship_engine/models/error_response_body.rb +1 -1
- data/lib/ship_engine/models/estimate_rates_request_body.rb +2 -2
- data/lib/ship_engine/models/fedex_account_settings.rb +1 -1
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +1 -1
- data/lib/ship_engine/models/fedex_settings_response_body.rb +1 -1
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +1 -1
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +2 -2
- data/lib/ship_engine/models/get_carriers_response_body.rb +1 -1
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +1 -1
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +1 -1
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +1 -1
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +1 -1
- data/lib/ship_engine/models/international_shipment_options.rb +1 -1
- data/lib/ship_engine/models/label.rb +1 -1
- data/lib/ship_engine/models/label_download.rb +1 -1
- data/lib/ship_engine/models/label_messages.rb +1 -1
- data/lib/ship_engine/models/link.rb +1 -1
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +1 -1
- data/lib/ship_engine/models/list_batches_response_body.rb +1 -1
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +1 -1
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +1 -1
- data/lib/ship_engine/models/list_carriers_response_body.rb +1 -1
- data/lib/ship_engine/models/list_labels_response_body.rb +1 -1
- data/lib/ship_engine/models/list_manifests_response_body.rb +1 -1
- data/lib/ship_engine/models/list_package_types_response_body.rb +1 -1
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +1 -1
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +1 -1
- data/lib/ship_engine/models/list_shipments_response_body.rb +1 -1
- data/lib/ship_engine/models/list_tags_response_body.rb +1 -1
- data/lib/ship_engine/models/list_warehouses_response_body.rb +1 -1
- data/lib/ship_engine/models/manifest.rb +1 -1
- data/lib/ship_engine/models/manifest_download.rb +1 -1
- data/lib/ship_engine/models/manifests.rb +1 -1
- data/lib/ship_engine/models/modify_batch.rb +1 -1
- data/lib/ship_engine/models/monetary_value.rb +1 -1
- data/lib/ship_engine/models/optional_link.rb +1 -1
- data/lib/ship_engine/models/package.rb +1 -1
- data/lib/ship_engine/models/package_type.rb +1 -1
- data/lib/ship_engine/models/paged_list_response_body.rb +1 -1
- data/lib/ship_engine/models/pagination_link.rb +1 -1
- data/lib/ship_engine/models/parse_address_request_body.rb +1 -1
- data/lib/ship_engine/models/parse_address_response_body.rb +1 -1
- data/lib/ship_engine/models/parse_shipment_request_body.rb +1 -1
- data/lib/ship_engine/models/parse_shipment_response_body.rb +1 -1
- data/lib/ship_engine/models/partial_address.rb +1 -1
- data/lib/ship_engine/models/partial_shipment.rb +1 -1
- data/lib/ship_engine/models/payment_amount.rb +1 -1
- data/lib/ship_engine/models/process_batch_request_body.rb +1 -1
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +1 -1
- data/lib/ship_engine/models/rate.rb +1 -1
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +1 -1
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +1 -1
- data/lib/ship_engine/models/rate_estimate_options.rb +1 -1
- data/lib/ship_engine/models/rate_request_body.rb +1 -1
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +1 -1
- data/lib/ship_engine/models/rate_request_by_shipments.rb +1 -1
- data/lib/ship_engine/models/rate_request_options.rb +1 -1
- data/lib/ship_engine/models/rate_request_rate_options.rb +1 -1
- data/lib/ship_engine/models/rate_response.rb +1 -1
- data/lib/ship_engine/models/rates_information.rb +1 -1
- data/lib/ship_engine/models/recognized_entity.rb +1 -1
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +1 -1
- data/lib/ship_engine/models/response_message.rb +1 -1
- data/lib/ship_engine/models/service.rb +1 -1
- data/lib/ship_engine/models/shipment.rb +1 -1
- data/lib/ship_engine/models/shipment_id_request.rb +1 -1
- data/lib/ship_engine/models/shipment_item.rb +1 -1
- data/lib/ship_engine/models/shipment_request.rb +1 -1
- data/lib/ship_engine/models/shipment_response_error.rb +1 -1
- data/lib/ship_engine/models/tag.rb +1 -1
- data/lib/ship_engine/models/tag_shipment_response_body.rb +1 -1
- data/lib/ship_engine/models/track_event.rb +1 -1
- data/lib/ship_engine/models/tracking_information.rb +1 -1
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +1 -1
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +2 -2
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +1 -1
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +1 -1
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +1 -1
- data/lib/ship_engine/models/update_package_type_request_body.rb +1 -1
- data/lib/ship_engine/models/update_shipment_fields.rb +1 -1
- data/lib/ship_engine/models/update_shipment_request_body.rb +1 -1
- data/lib/ship_engine/models/update_shipment_response_body.rb +1 -1
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +1 -1
- data/lib/ship_engine/models/update_warehouse_request_body.rb +1 -1
- data/lib/ship_engine/models/update_webhook_request_body.rb +1 -1
- data/lib/ship_engine/models/ups_account_settings.rb +1 -1
- data/lib/ship_engine/models/ups_invoice.rb +1 -1
- data/lib/ship_engine/models/ups_settings_response_body.rb +1 -1
- data/lib/ship_engine/models/validate_shipment_fields.rb +1 -1
- data/lib/ship_engine/models/void_label_response_body.rb +1 -1
- data/lib/ship_engine/models/warehouse.rb +1 -1
- data/lib/ship_engine/models/webhook.rb +1 -1
- data/lib/ship_engine/models/weight.rb +1 -1
- data/lib/ship_engine/version.rb +1 -1
- data/ship_engine-1.0.1.gem +0 -0
- data/spec/api_client_spec.rb +6 -6
- data/spec/configuration_spec.rb +1 -1
- metadata +2 -1
data/docs/InsuranceApi.md
CHANGED
|
@@ -23,7 +23,7 @@ You may need to auto fund your account from time to time. For example, if you do
|
|
|
23
23
|
# load the gem
|
|
24
24
|
require 'openapi_client'
|
|
25
25
|
# setup authorization
|
|
26
|
-
|
|
26
|
+
ShipEngine.configure do |config|
|
|
27
27
|
# Configure API key authorization: api_key
|
|
28
28
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
29
29
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -75,7 +75,7 @@ Connect a Shipsurance Account
|
|
|
75
75
|
# load the gem
|
|
76
76
|
require 'openapi_client'
|
|
77
77
|
# setup authorization
|
|
78
|
-
|
|
78
|
+
ShipEngine.configure do |config|
|
|
79
79
|
# Configure API key authorization: api_key
|
|
80
80
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
81
81
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -127,7 +127,7 @@ Disconnect a Shipsurance Account
|
|
|
127
127
|
# load the gem
|
|
128
128
|
require 'openapi_client'
|
|
129
129
|
# setup authorization
|
|
130
|
-
|
|
130
|
+
ShipEngine.configure do |config|
|
|
131
131
|
# Configure API key authorization: api_key
|
|
132
132
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
133
133
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -176,7 +176,7 @@ Retrieve the balance of your Shipsurance account.
|
|
|
176
176
|
# load the gem
|
|
177
177
|
require 'openapi_client'
|
|
178
178
|
# setup authorization
|
|
179
|
-
|
|
179
|
+
ShipEngine.configure do |config|
|
|
180
180
|
# Configure API key authorization: api_key
|
|
181
181
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
182
182
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
data/docs/InsuranceProvider.md
CHANGED
data/docs/Label.md
CHANGED
|
@@ -2,46 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**label_id**
|
|
8
|
-
**status**
|
|
9
|
-
**shipment_id**
|
|
10
|
-
**shipment**
|
|
11
|
-
**ship_date**
|
|
12
|
-
**created_at**
|
|
13
|
-
**shipment_cost**
|
|
14
|
-
**insurance_cost**
|
|
15
|
-
**tracking_number**
|
|
16
|
-
**is_return_label**
|
|
17
|
-
**rma_number**
|
|
18
|
-
**is_international**
|
|
19
|
-
**batch_id**
|
|
20
|
-
**carrier_id**
|
|
21
|
-
**charge_event**
|
|
22
|
-
**outbound_label_id**
|
|
23
|
-
**service_code**
|
|
24
|
-
**test_label**
|
|
25
|
-
**package_code**
|
|
26
|
-
**validate_address**
|
|
27
|
-
**voided**
|
|
28
|
-
**voided_at**
|
|
29
|
-
**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) |
|
|
30
|
-
**label_format**
|
|
31
|
-
**label_layout**
|
|
32
|
-
**trackable**
|
|
33
|
-
**label_image_id**
|
|
34
|
-
**carrier_code**
|
|
35
|
-
**tracking_status**
|
|
36
|
-
**label_download**
|
|
37
|
-
**form_download**
|
|
38
|
-
**insurance_claim**
|
|
39
|
-
**packages**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
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] |
|
|
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] |
|
|
40
40
|
|
|
41
41
|
## Code Sample
|
|
42
42
|
|
|
43
43
|
```ruby
|
|
44
|
-
require '
|
|
44
|
+
require 'ShipEngine'
|
|
45
45
|
|
|
46
46
|
instance = ShipEngine::Label.new(label_id: null,
|
|
47
47
|
status: null,
|
|
@@ -77,5 +77,3 @@ instance = ShipEngine::Label.new(label_id: null,
|
|
|
77
77
|
insurance_claim: null,
|
|
78
78
|
packages: null)
|
|
79
79
|
```
|
|
80
|
-
|
|
81
|
-
|
data/docs/LabelChargeEvent.md
CHANGED
data/docs/LabelDownload.md
CHANGED
data/docs/LabelDownloadType.md
CHANGED
data/docs/LabelFormat.md
CHANGED
data/docs/LabelLayout.md
CHANGED
data/docs/LabelMessages.md
CHANGED
data/docs/LabelStatus.md
CHANGED
data/docs/LabelsApi.md
CHANGED
|
@@ -28,7 +28,7 @@ Purchase and print a label for shipment
|
|
|
28
28
|
# load the gem
|
|
29
29
|
require 'openapi_client'
|
|
30
30
|
# setup authorization
|
|
31
|
-
|
|
31
|
+
ShipEngine.configure do |config|
|
|
32
32
|
# Configure API key authorization: api_key
|
|
33
33
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
34
34
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -80,7 +80,7 @@ When retrieving rates for shipments using the `/rates` endpoint, the returned in
|
|
|
80
80
|
# load the gem
|
|
81
81
|
require 'openapi_client'
|
|
82
82
|
# setup authorization
|
|
83
|
-
|
|
83
|
+
ShipEngine.configure do |config|
|
|
84
84
|
# Configure API key authorization: api_key
|
|
85
85
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
86
86
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -134,7 +134,7 @@ Purchase a label using a shipment ID that has already been created with the desi
|
|
|
134
134
|
# load the gem
|
|
135
135
|
require 'openapi_client'
|
|
136
136
|
# setup authorization
|
|
137
|
-
|
|
137
|
+
ShipEngine.configure do |config|
|
|
138
138
|
# Configure API key authorization: api_key
|
|
139
139
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
140
140
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -188,7 +188,7 @@ Create a return label
|
|
|
188
188
|
# load the gem
|
|
189
189
|
require 'openapi_client'
|
|
190
190
|
# setup authorization
|
|
191
|
-
|
|
191
|
+
ShipEngine.configure do |config|
|
|
192
192
|
# Configure API key authorization: api_key
|
|
193
193
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
194
194
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -242,7 +242,7 @@ Find a label by using the external shipment id that was used during label creati
|
|
|
242
242
|
# load the gem
|
|
243
243
|
require 'openapi_client'
|
|
244
244
|
# setup authorization
|
|
245
|
-
|
|
245
|
+
ShipEngine.configure do |config|
|
|
246
246
|
# Configure API key authorization: api_key
|
|
247
247
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
248
248
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -298,7 +298,7 @@ Retrieve information for individual labels.
|
|
|
298
298
|
# load the gem
|
|
299
299
|
require 'openapi_client'
|
|
300
300
|
# setup authorization
|
|
301
|
-
|
|
301
|
+
ShipEngine.configure do |config|
|
|
302
302
|
# Configure API key authorization: api_key
|
|
303
303
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
304
304
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -354,7 +354,7 @@ Retrieve the label's tracking information
|
|
|
354
354
|
# load the gem
|
|
355
355
|
require 'openapi_client'
|
|
356
356
|
# setup authorization
|
|
357
|
-
|
|
357
|
+
ShipEngine.configure do |config|
|
|
358
358
|
# Configure API key authorization: api_key
|
|
359
359
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
360
360
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -406,7 +406,7 @@ This endpoint returns a list of labels that you've [created](https://www.shipeng
|
|
|
406
406
|
# load the gem
|
|
407
407
|
require 'openapi_client'
|
|
408
408
|
# setup authorization
|
|
409
|
-
|
|
409
|
+
ShipEngine.configure do |config|
|
|
410
410
|
# Configure API key authorization: api_key
|
|
411
411
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
412
412
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -486,7 +486,7 @@ Void a label by ID to get a refund.
|
|
|
486
486
|
# load the gem
|
|
487
487
|
require 'openapi_client'
|
|
488
488
|
# setup authorization
|
|
489
|
-
|
|
489
|
+
ShipEngine.configure do |config|
|
|
490
490
|
# Configure API key authorization: api_key
|
|
491
491
|
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
492
492
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
data/docs/Link.md
CHANGED