ship_engine 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +431 -0
- data/Rakefile +10 -0
- data/docs/AddFundsToCarrierRequestBody.md +16 -0
- data/docs/AddFundsToCarrierResponseBody.md +17 -0
- data/docs/AddFundsToInsuranceRequestBody.md +16 -0
- data/docs/AddFundsToInsuranceResponseBody.md +16 -0
- data/docs/AddToBatchRequestBody.md +16 -0
- data/docs/Address.md +16 -0
- data/docs/AddressResidentialIndicator.md +16 -0
- data/docs/AddressToValidate.md +16 -0
- data/docs/AddressValidatingShipment.md +61 -0
- data/docs/AddressValidationCode.md +16 -0
- data/docs/AddressValidationDetailCode.md +16 -0
- data/docs/AddressValidationMessageType.md +16 -0
- data/docs/AddressValidationResult.md +23 -0
- data/docs/AddressValidationStatus.md +16 -0
- data/docs/AddressesApi.md +118 -0
- data/docs/AdvancedShipmentOptions.md +47 -0
- data/docs/AncillaryServiceEndorsement.md +16 -0
- data/docs/Batch.md +51 -0
- data/docs/BatchResponseError.md +19 -0
- data/docs/BatchStatus.md +16 -0
- data/docs/BatchesApi.md +580 -0
- data/docs/BatchesSortBy.md +16 -0
- data/docs/BillToParty.md +16 -0
- data/docs/BulkRate.md +25 -0
- data/docs/CalculateRatesRequestBody.md +16 -0
- data/docs/CalculateRatesResponseBody.md +61 -0
- data/docs/Carrier.md +41 -0
- data/docs/CarrierAccountsApi.md +238 -0
- data/docs/CarrierAdvancedOption.md +21 -0
- data/docs/CarrierName.md +16 -0
- data/docs/CarrierNameWithSettings.md +16 -0
- data/docs/CarriersApi.md +336 -0
- data/docs/CollectOnDelivery.md +19 -0
- data/docs/CollectOnDeliveryPaymentType.md +16 -0
- data/docs/CompareBulkRatesRequestBody.md +16 -0
- data/docs/ConnectAccessWorldwideRequestBody.md +21 -0
- data/docs/ConnectAmazonBuyShippingRequestBody.md +23 -0
- data/docs/ConnectApcRequestBody.md +21 -0
- data/docs/ConnectAsendiaRequestBody.md +23 -0
- data/docs/ConnectAustraliaPostRequestBody.md +23 -0
- data/docs/ConnectCanadaPostRequestBody.md +25 -0
- data/docs/ConnectCarrierRequestBody.md +113 -0
- data/docs/ConnectCarrierResponseBody.md +17 -0
- data/docs/ConnectDhlEcommerceRequestBody.md +39 -0
- data/docs/ConnectDhlExpressAuRequestBody.md +19 -0
- data/docs/ConnectDhlExpressCaRequestBody.md +19 -0
- data/docs/ConnectDhlExpressRequestBody.md +19 -0
- data/docs/ConnectDhlExpressUkRequestBody.md +23 -0
- data/docs/ConnectDpdRequestBody.md +21 -0
- data/docs/ConnectEndiciaRequestBody.md +21 -0
- data/docs/ConnectFedexRequestBody.md +45 -0
- data/docs/ConnectFedexUkRequestBody.md +45 -0
- data/docs/ConnectFirstmileRequestBody.md +23 -0
- data/docs/ConnectGlobegisticsRequestBody.md +21 -0
- data/docs/ConnectImexRequestBody.md +21 -0
- data/docs/ConnectInsurerRequestBody.md +19 -0
- data/docs/ConnectNewgisticsRequestBody.md +23 -0
- data/docs/ConnectOntracRequestBody.md +21 -0
- data/docs/ConnectPurolatorRequestBody.md +21 -0
- data/docs/ConnectRoyalMailRequestBody.md +39 -0
- data/docs/ConnectRrDonnelleyRequestBody.md +21 -0
- data/docs/ConnectSekoRequestBody.md +19 -0
- data/docs/ConnectSendleRequestBody.md +21 -0
- data/docs/ConnectStampsRequestBody.md +21 -0
- data/docs/ConnectUpsRequestBody.md +51 -0
- data/docs/CreateAndValidateShipment.md +63 -0
- data/docs/CreateBatchRequestBody.md +23 -0
- data/docs/CreateBatchResponseBody.md +16 -0
- data/docs/CreateLabelFromRateRequestBody.md +16 -0
- data/docs/CreateLabelFromRateResponseBody.md +16 -0
- data/docs/CreateLabelFromShipmentRequestBody.md +23 -0
- data/docs/CreateLabelFromShipmentResponseBody.md +16 -0
- data/docs/CreateLabelRequestBody.md +16 -0
- data/docs/CreateLabelResponseBody.md +16 -0
- data/docs/CreateManifestByObjectRequestBody.md +25 -0
- data/docs/CreateManifestLabelIdsRequestBody.md +17 -0
- data/docs/CreateManifestRequestBody.md +25 -0
- data/docs/CreateManifestResponseBody.md +35 -0
- data/docs/CreatePackageTypeRequestBody.md +16 -0
- data/docs/CreatePackageTypeResponseBody.md +16 -0
- data/docs/CreateReturnLabelRequestBody.md +25 -0
- data/docs/CreateReturnLabelResponseBody.md +16 -0
- data/docs/CreateShipmentResponseBodyFields.md +19 -0
- data/docs/CreateShipmentsRequestBody.md +17 -0
- data/docs/CreateShipmentsResponseBody.md +19 -0
- data/docs/CreateTagResponseBody.md +16 -0
- data/docs/CreateWarehouseRequestBody.md +16 -0
- data/docs/CreateWarehouseResponseBody.md +16 -0
- data/docs/CreateWebhookRequestBody.md +19 -0
- data/docs/CreateWebhookResponseBody.md +16 -0
- data/docs/Currency.md +16 -0
- data/docs/CustomsItem.md +33 -0
- data/docs/DeliveryConfirmation.md +16 -0
- data/docs/DeprecatedManifest.md +33 -0
- data/docs/DhlExpressAccountSettings.md +21 -0
- data/docs/DhlExpressSettingsResponseBody.md +16 -0
- data/docs/DimensionUnit.md +16 -0
- data/docs/Dimensions.md +23 -0
- data/docs/DownloadsApi.md +71 -0
- data/docs/Error.md +23 -0
- data/docs/ErrorCode.md +16 -0
- data/docs/ErrorResponseBody.md +19 -0
- data/docs/ErrorSource.md +16 -0
- data/docs/ErrorType.md +16 -0
- data/docs/EstimateRatesRequestBody.md +16 -0
- data/docs/FedexAccountSettings.md +25 -0
- data/docs/FedexAccountSettingsRequestBody.md +16 -0
- data/docs/FedexPickupType.md +16 -0
- data/docs/FedexSettingsResponseBody.md +16 -0
- data/docs/GetBatchByExternalIdResponseBody.md +16 -0
- data/docs/GetBatchByIdResponseBody.md +16 -0
- data/docs/GetCarrierByIdResponseBody.md +16 -0
- data/docs/GetCarrierOptionsResponseBody.md +17 -0
- data/docs/GetCarrierSettingsResponseBody.md +45 -0
- data/docs/GetCarriersResponseBody.md +21 -0
- data/docs/GetInsuranceBalanceResponseBody.md +16 -0
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +16 -0
- data/docs/GetLabelByIdResponseBody.md +16 -0
- data/docs/GetManifestByIdResponseBody.md +16 -0
- data/docs/GetPackageTypeByIdResponseBody.md +16 -0
- data/docs/GetRateByIdResponseBody.md +16 -0
- data/docs/GetShipmentByExternalIdResponseBody.md +16 -0
- data/docs/GetShipmentByIdResponseBody.md +16 -0
- data/docs/GetTrackingLogFromLabelResponseBody.md +16 -0
- data/docs/GetTrackingLogResponseBody.md +16 -0
- data/docs/GetWarehouseByIdResponseBody.md +16 -0
- data/docs/GetWebhookByIdResponseBody.md +16 -0
- data/docs/InsuranceApi.md +220 -0
- data/docs/InsuranceProvider.md +16 -0
- data/docs/InternationalShipmentOptions.md +21 -0
- data/docs/Label.md +81 -0
- data/docs/LabelChargeEvent.md +16 -0
- data/docs/LabelDownload.md +23 -0
- data/docs/LabelDownloadType.md +16 -0
- data/docs/LabelFormat.md +16 -0
- data/docs/LabelLayout.md +16 -0
- data/docs/LabelMessages.md +21 -0
- data/docs/LabelStatus.md +16 -0
- data/docs/LabelsApi.md +545 -0
- data/docs/Link.md +16 -0
- data/docs/ListBatchErrorsResponseBody.md +19 -0
- data/docs/ListBatchesResponseBody.md +25 -0
- data/docs/ListCarrierPackageTypesResponseBody.md +17 -0
- data/docs/ListCarrierServicesResponseBody.md +17 -0
- data/docs/ListCarriersResponseBody.md +17 -0
- data/docs/ListLabelsResponseBody.md +17 -0
- data/docs/ListManifestsResponseBody.md +25 -0
- data/docs/ListPackageTypesResponseBody.md +17 -0
- data/docs/ListShipmentErrorsResponseBody.md +19 -0
- data/docs/ListShipmentRatesResponseBody.md +16 -0
- data/docs/ListShipmentsResponseBody.md +25 -0
- data/docs/ListTagsResponseBody.md +17 -0
- data/docs/ListWarehousesResponseBody.md +17 -0
- data/docs/Manifest.md +33 -0
- data/docs/ManifestDownload.md +17 -0
- data/docs/Manifests.md +17 -0
- data/docs/ManifestsApi.md +191 -0
- data/docs/ModifyBatch.md +19 -0
- data/docs/MonetaryValue.md +19 -0
- data/docs/NonDelivery.md +16 -0
- data/docs/OptionalLink.md +19 -0
- data/docs/OrderSourceName.md +16 -0
- data/docs/Package.md +29 -0
- data/docs/PackageContents.md +16 -0
- data/docs/PackageType.md +25 -0
- data/docs/PackageTypesApi.md +281 -0
- data/docs/PagedListResponseBody.md +23 -0
- data/docs/PaginationLink.md +23 -0
- data/docs/ParseAddressRequestBody.md +19 -0
- data/docs/ParseAddressResponseBody.md +21 -0
- data/docs/ParseShipmentRequestBody.md +20 -0
- data/docs/ParseShipmentResponseBody.md +21 -0
- data/docs/PartialAddress.md +37 -0
- data/docs/PartialShipment.md +59 -0
- data/docs/PaymentAmount.md +19 -0
- data/docs/ProcessBatchRequestBody.md +21 -0
- data/docs/PurchaseLabelWithoutShipment.md +23 -0
- data/docs/Rate.md +65 -0
- data/docs/RateEstimateByCarrierId.md +17 -0
- data/docs/RateEstimateByCarrierIds.md +17 -0
- data/docs/RateEstimateOptions.md +41 -0
- data/docs/RateRequestBody.md +25 -0
- data/docs/RateRequestByShipmentIds.md +17 -0
- data/docs/RateRequestByShipments.md +17 -0
- data/docs/RateRequestOptions.md +17 -0
- data/docs/RateRequestRateOptions.md +17 -0
- data/docs/RateResponse.md +17 -0
- data/docs/RateResponseStatus.md +16 -0
- data/docs/RateType.md +16 -0
- data/docs/RatesApi.md +228 -0
- data/docs/RatesInformation.md +29 -0
- data/docs/RecognizedEntity.md +27 -0
- data/docs/RemoveFromBatchRequestBody.md +16 -0
- data/docs/ResponseMessage.md +23 -0
- data/docs/Service.md +29 -0
- data/docs/Shipment.md +16 -0
- data/docs/ShipmentIdRequest.md +17 -0
- data/docs/ShipmentItem.md +33 -0
- data/docs/ShipmentRequest.md +17 -0
- data/docs/ShipmentResponseError.md +21 -0
- data/docs/ShipmentStatus.md +16 -0
- data/docs/ShipmentsApi.md +653 -0
- data/docs/ShipmentsSortBy.md +16 -0
- data/docs/SmartPostHub.md +16 -0
- data/docs/SortDir.md +16 -0
- data/docs/Tag.md +17 -0
- data/docs/TagShipmentResponseBody.md +19 -0
- data/docs/TagsApi.md +226 -0
- data/docs/TrackEvent.md +39 -0
- data/docs/TrackingApi.md +185 -0
- data/docs/TrackingInformation.md +35 -0
- data/docs/TrackingStatus.md +16 -0
- data/docs/UpdateAmazonBuyShippingRequestBody.md +17 -0
- data/docs/UpdateCarrierSettingsRequestBody.md +51 -0
- data/docs/UpdateDhlExpressSettingsRequestBody.md +16 -0
- data/docs/UpdateFedexSettingsRequestBody.md +16 -0
- data/docs/UpdateNewgisticsSettingsRequestBody.md +19 -0
- data/docs/UpdatePackageTypeRequestBody.md +16 -0
- data/docs/UpdateShipmentFields.md +17 -0
- data/docs/UpdateShipmentRequestBody.md +61 -0
- data/docs/UpdateShipmentResponseBody.md +16 -0
- data/docs/UpdateUpsSettingsRequestBody.md +16 -0
- data/docs/UpdateWarehouseRequestBody.md +16 -0
- data/docs/UpdateWebhookRequestBody.md +17 -0
- data/docs/UpsAccountSettings.md +39 -0
- data/docs/UpsInvoice.md +23 -0
- data/docs/UpsPickupType.md +16 -0
- data/docs/UpsSettingsResponseBody.md +16 -0
- data/docs/ValidateAddress.md +16 -0
- data/docs/ValidateShipmentFields.md +17 -0
- data/docs/ValidationStatus.md +16 -0
- data/docs/VoidLabelResponseBody.md +19 -0
- data/docs/Warehouse.md +25 -0
- data/docs/WarehousesApi.md +281 -0
- data/docs/Webhook.md +21 -0
- data/docs/WebhookEvent.md +16 -0
- data/docs/WebhooksApi.md +281 -0
- data/docs/Weight.md +19 -0
- data/docs/WeightUnit.md +16 -0
- data/git_push.sh +58 -0
- data/lib/openapi_client.rb +278 -0
- data/lib/openapi_client/api/addresses_api.rb +150 -0
- data/lib/openapi_client/api/batches_api.rb +790 -0
- data/lib/openapi_client/api/carrier_accounts_api.rb +343 -0
- data/lib/openapi_client/api/carriers_api.rb +461 -0
- data/lib/openapi_client/api/downloads_api.rb +99 -0
- data/lib/openapi_client/api/insurance_api.rb +262 -0
- data/lib/openapi_client/api/labels_api.rb +812 -0
- data/lib/openapi_client/api/manifests_api.rb +278 -0
- data/lib/openapi_client/api/package_types_api.rb +375 -0
- data/lib/openapi_client/api/rates_api.rb +289 -0
- data/lib/openapi_client/api/shipments_api.rb +899 -0
- data/lib/openapi_client/api/tags_api.rb +286 -0
- data/lib/openapi_client/api/tracking_api.rb +232 -0
- data/lib/openapi_client/api/warehouses_api.rb +375 -0
- data/lib/openapi_client/api/webhooks_api.rb +375 -0
- data/lib/openapi_client/api_client.rb +388 -0
- data/lib/openapi_client/api_error.rb +57 -0
- data/lib/openapi_client/configuration.rb +248 -0
- data/lib/openapi_client/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/openapi_client/models/add_funds_to_carrier_response_body.rb +213 -0
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +209 -0
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +209 -0
- data/lib/openapi_client/models/add_to_batch_request_body.rb +209 -0
- data/lib/openapi_client/models/address.rb +209 -0
- data/lib/openapi_client/models/address_residential_indicator.rb +37 -0
- data/lib/openapi_client/models/address_to_validate.rb +209 -0
- data/lib/openapi_client/models/address_validating_shipment.rb +484 -0
- data/lib/openapi_client/models/address_validation_code.rb +47 -0
- data/lib/openapi_client/models/address_validation_detail_code.rb +92 -0
- data/lib/openapi_client/models/address_validation_message_type.rb +37 -0
- data/lib/openapi_client/models/address_validation_result.rb +259 -0
- data/lib/openapi_client/models/address_validation_status.rb +38 -0
- data/lib/openapi_client/models/advanced_shipment_options.rb +434 -0
- data/lib/openapi_client/models/ancillary_service_endorsement.rb +40 -0
- data/lib/openapi_client/models/batch.rb +566 -0
- data/lib/openapi_client/models/batch_response_error.rb +233 -0
- data/lib/openapi_client/models/batch_status.rb +42 -0
- data/lib/openapi_client/models/batches_sort_by.rb +36 -0
- data/lib/openapi_client/models/bill_to_party.rb +36 -0
- data/lib/openapi_client/models/bulk_rate.rb +273 -0
- data/lib/openapi_client/models/calculate_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/calculate_rates_response_body.rb +525 -0
- data/lib/openapi_client/models/carrier.rb +394 -0
- data/lib/openapi_client/models/carrier_advanced_option.rb +273 -0
- data/lib/openapi_client/models/carrier_name.rb +61 -0
- data/lib/openapi_client/models/carrier_name_with_settings.rb +38 -0
- data/lib/openapi_client/models/collect_on_delivery.rb +216 -0
- data/lib/openapi_client/models/collect_on_delivery_payment_type.rb +38 -0
- data/lib/openapi_client/models/compare_bulk_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/connect_access_worldwide_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_amazon_buy_shipping_request_body.rb +312 -0
- data/lib/openapi_client/models/connect_apc_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_asendia_request_body.rb +334 -0
- data/lib/openapi_client/models/connect_australia_post_request_body.rb +334 -0
- data/lib/openapi_client/models/connect_canada_post_request_body.rb +368 -0
- data/lib/openapi_client/models/connect_carrier_request_body.rb +1661 -0
- data/lib/openapi_client/models/connect_carrier_response_body.rb +213 -0
- data/lib/openapi_client/models/connect_dhl_ecommerce_request_body.rb +536 -0
- data/lib/openapi_client/models/connect_dhl_express_au_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_ca_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_dhl_express_uk_request_body.rb +315 -0
- data/lib/openapi_client/models/connect_dpd_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_endicia_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_fedex_request_body.rb +643 -0
- data/lib/openapi_client/models/connect_fedex_uk_request_body.rb +643 -0
- data/lib/openapi_client/models/connect_firstmile_request_body.rb +306 -0
- data/lib/openapi_client/models/connect_globegistics_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_imex_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_insurer_request_body.rb +245 -0
- data/lib/openapi_client/models/connect_newgistics_request_body.rb +316 -0
- data/lib/openapi_client/models/connect_ontrac_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_purolator_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_royal_mail_request_body.rb +513 -0
- data/lib/openapi_client/models/connect_rr_donnelley_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_seko_request_body.rb +266 -0
- data/lib/openapi_client/models/connect_sendle_request_body.rb +281 -0
- data/lib/openapi_client/models/connect_stamps_request_body.rb +300 -0
- data/lib/openapi_client/models/connect_ups_request_body.rb +730 -0
- data/lib/openapi_client/models/create_and_validate_shipment.rb +472 -0
- data/lib/openapi_client/models/create_batch_request_body.rb +257 -0
- data/lib/openapi_client/models/create_batch_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_rate_request_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_from_shipment_request_body.rb +234 -0
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +209 -0
- data/lib/openapi_client/models/create_label_request_body.rb +209 -0
- data/lib/openapi_client/models/create_label_response_body.rb +209 -0
- data/lib/openapi_client/models/create_manifest_by_object_request_body.rb +267 -0
- data/lib/openapi_client/models/create_manifest_label_ids_request_body.rb +215 -0
- data/lib/openapi_client/models/create_manifest_request_body.rb +295 -0
- data/lib/openapi_client/models/create_manifest_response_body.rb +389 -0
- data/lib/openapi_client/models/create_package_type_request_body.rb +209 -0
- data/lib/openapi_client/models/create_package_type_response_body.rb +209 -0
- data/lib/openapi_client/models/create_return_label_request_body.rb +248 -0
- data/lib/openapi_client/models/create_return_label_response_body.rb +209 -0
- data/lib/openapi_client/models/create_shipment_response_body_fields.rb +219 -0
- data/lib/openapi_client/models/create_shipments_request_body.rb +215 -0
- data/lib/openapi_client/models/create_shipments_response_body.rb +232 -0
- data/lib/openapi_client/models/create_tag_response_body.rb +209 -0
- data/lib/openapi_client/models/create_warehouse_request_body.rb +209 -0
- data/lib/openapi_client/models/create_warehouse_response_body.rb +209 -0
- data/lib/openapi_client/models/create_webhook_request_body.rb +227 -0
- data/lib/openapi_client/models/create_webhook_response_body.rb +209 -0
- data/lib/openapi_client/models/currency.rb +40 -0
- data/lib/openapi_client/models/customs_item.rb +334 -0
- data/lib/openapi_client/models/delivery_confirmation.rb +40 -0
- data/lib/openapi_client/models/deprecated_manifest.rb +317 -0
- data/lib/openapi_client/models/dhl_express_account_settings.rb +243 -0
- data/lib/openapi_client/models/dhl_express_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/dimension_unit.rb +36 -0
- data/lib/openapi_client/models/dimensions.rb +320 -0
- data/lib/openapi_client/models/error.rb +274 -0
- data/lib/openapi_client/models/error_code.rb +71 -0
- data/lib/openapi_client/models/error_response_body.rb +230 -0
- data/lib/openapi_client/models/error_source.rb +37 -0
- data/lib/openapi_client/models/error_type.rb +40 -0
- data/lib/openapi_client/models/estimate_rates_request_body.rb +225 -0
- data/lib/openapi_client/models/fedex_account_settings.rb +259 -0
- data/lib/openapi_client/models/fedex_account_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/fedex_pickup_type.rb +40 -0
- data/lib/openapi_client/models/fedex_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/get_batch_by_external_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_batch_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_carrier_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_carrier_options_response_body.rb +210 -0
- data/lib/openapi_client/models/get_carrier_settings_response_body.rb +413 -0
- data/lib/openapi_client/models/get_carriers_response_body.rb +254 -0
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/openapi_client/models/get_label_by_external_shipment_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_label_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_shipment_by_external_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_tracking_log_from_label_response_body.rb +209 -0
- data/lib/openapi_client/models/get_tracking_log_response_body.rb +209 -0
- data/lib/openapi_client/models/get_warehouse_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/get_webhook_by_id_response_body.rb +209 -0
- data/lib/openapi_client/models/insurance_provider.rb +38 -0
- data/lib/openapi_client/models/international_shipment_options.rb +240 -0
- data/lib/openapi_client/models/label.rb +548 -0
- data/lib/openapi_client/models/label_charge_event.rb +37 -0
- data/lib/openapi_client/models/label_download.rb +238 -0
- data/lib/openapi_client/models/label_download_type.rb +36 -0
- data/lib/openapi_client/models/label_format.rb +37 -0
- data/lib/openapi_client/models/label_layout.rb +36 -0
- data/lib/openapi_client/models/label_messages.rb +237 -0
- data/lib/openapi_client/models/label_status.rb +38 -0
- data/lib/openapi_client/models/link.rb +209 -0
- data/lib/openapi_client/models/list_batch_errors_response_body.rb +229 -0
- data/lib/openapi_client/models/list_batches_response_body.rb +331 -0
- data/lib/openapi_client/models/list_carrier_package_types_response_body.rb +210 -0
- data/lib/openapi_client/models/list_carrier_services_response_body.rb +210 -0
- data/lib/openapi_client/models/list_carriers_response_body.rb +215 -0
- data/lib/openapi_client/models/list_labels_response_body.rb +226 -0
- data/lib/openapi_client/models/list_manifests_response_body.rb +332 -0
- data/lib/openapi_client/models/list_package_types_response_body.rb +210 -0
- data/lib/openapi_client/models/list_shipment_errors_response_body.rb +229 -0
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +209 -0
- data/lib/openapi_client/models/list_shipments_response_body.rb +329 -0
- data/lib/openapi_client/models/list_tags_response_body.rb +210 -0
- data/lib/openapi_client/models/list_warehouses_response_body.rb +215 -0
- data/lib/openapi_client/models/manifest.rb +317 -0
- data/lib/openapi_client/models/manifest_download.rb +208 -0
- data/lib/openapi_client/models/manifests.rb +209 -0
- data/lib/openapi_client/models/modify_batch.rb +222 -0
- data/lib/openapi_client/models/monetary_value.rb +246 -0
- data/lib/openapi_client/models/non_delivery.rb +36 -0
- data/lib/openapi_client/models/optional_link.rb +233 -0
- data/lib/openapi_client/models/order_source_name.rb +54 -0
- data/lib/openapi_client/models/package.rb +287 -0
- data/lib/openapi_client/models/package_contents.rb +39 -0
- data/lib/openapi_client/models/package_type.rb +276 -0
- data/lib/openapi_client/models/paged_list_response_body.rb +314 -0
- data/lib/openapi_client/models/pagination_link.rb +258 -0
- data/lib/openapi_client/models/parse_address_request_body.rb +242 -0
- data/lib/openapi_client/models/parse_address_response_body.rb +273 -0
- data/lib/openapi_client/models/parse_shipment_request_body.rb +242 -0
- data/lib/openapi_client/models/parse_shipment_response_body.rb +273 -0
- data/lib/openapi_client/models/partial_address.rb +432 -0
- data/lib/openapi_client/models/partial_shipment.rb +442 -0
- data/lib/openapi_client/models/payment_amount.rb +230 -0
- data/lib/openapi_client/models/process_batch_request_body.rb +228 -0
- data/lib/openapi_client/models/purchase_label_without_shipment.rb +234 -0
- data/lib/openapi_client/models/rate.rb +696 -0
- data/lib/openapi_client/models/rate_estimate_by_carrier_id.rb +207 -0
- data/lib/openapi_client/models/rate_estimate_by_carrier_ids.rb +209 -0
- data/lib/openapi_client/models/rate_estimate_options.rb +381 -0
- data/lib/openapi_client/models/rate_request_body.rb +256 -0
- data/lib/openapi_client/models/rate_request_by_shipment_ids.rb +214 -0
- data/lib/openapi_client/models/rate_request_by_shipments.rb +214 -0
- data/lib/openapi_client/models/rate_request_options.rb +207 -0
- data/lib/openapi_client/models/rate_request_rate_options.rb +207 -0
- data/lib/openapi_client/models/rate_response.rb +207 -0
- data/lib/openapi_client/models/rate_response_status.rb +38 -0
- data/lib/openapi_client/models/rate_type.rb +36 -0
- data/lib/openapi_client/models/rates_information.rb +272 -0
- data/lib/openapi_client/models/recognized_entity.rb +389 -0
- data/lib/openapi_client/models/remove_from_batch_request_body.rb +209 -0
- data/lib/openapi_client/models/response_message.rb +251 -0
- data/lib/openapi_client/models/service.rb +297 -0
- data/lib/openapi_client/models/shipment.rb +209 -0
- data/lib/openapi_client/models/shipment_id_request.rb +207 -0
- data/lib/openapi_client/models/shipment_item.rb +347 -0
- data/lib/openapi_client/models/shipment_request.rb +207 -0
- data/lib/openapi_client/models/shipment_response_error.rb +257 -0
- data/lib/openapi_client/models/shipment_status.rb +38 -0
- data/lib/openapi_client/models/shipments_sort_by.rb +36 -0
- data/lib/openapi_client/models/smart_post_hub.rb +68 -0
- data/lib/openapi_client/models/sort_dir.rb +36 -0
- data/lib/openapi_client/models/tag.rb +232 -0
- data/lib/openapi_client/models/tag_shipment_response_body.rb +228 -0
- data/lib/openapi_client/models/track_event.rb +502 -0
- data/lib/openapi_client/models/tracking_information.rb +371 -0
- data/lib/openapi_client/models/tracking_status.rb +38 -0
- data/lib/openapi_client/models/update_amazon_buy_shipping_request_body.rb +223 -0
- data/lib/openapi_client/models/update_carrier_settings_request_body.rb +458 -0
- data/lib/openapi_client/models/update_dhl_express_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_fedex_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_newgistics_settings_request_body.rb +216 -0
- data/lib/openapi_client/models/update_package_type_request_body.rb +209 -0
- data/lib/openapi_client/models/update_shipment_fields.rb +206 -0
- data/lib/openapi_client/models/update_shipment_request_body.rb +469 -0
- data/lib/openapi_client/models/update_shipment_response_body.rb +209 -0
- data/lib/openapi_client/models/update_ups_settings_request_body.rb +209 -0
- data/lib/openapi_client/models/update_warehouse_request_body.rb +209 -0
- data/lib/openapi_client/models/update_webhook_request_body.rb +208 -0
- data/lib/openapi_client/models/ups_account_settings.rb +361 -0
- data/lib/openapi_client/models/ups_invoice.rb +267 -0
- data/lib/openapi_client/models/ups_pickup_type.rb +37 -0
- data/lib/openapi_client/models/ups_settings_response_body.rb +209 -0
- data/lib/openapi_client/models/validate_address.rb +37 -0
- data/lib/openapi_client/models/validate_shipment_fields.rb +206 -0
- data/lib/openapi_client/models/validation_status.rb +38 -0
- data/lib/openapi_client/models/void_label_response_body.rb +246 -0
- data/lib/openapi_client/models/warehouse.rb +263 -0
- data/lib/openapi_client/models/webhook.rb +227 -0
- data/lib/openapi_client/models/webhook_event.rb +41 -0
- data/lib/openapi_client/models/weight.rb +246 -0
- data/lib/openapi_client/models/weight_unit.rb +38 -0
- data/lib/openapi_client/version.rb +15 -0
- data/openapi_client-1.0.0.gem +0 -0
- data/ship_engine.gemspec +39 -0
- data/spec/api/addresses_api_spec.rb +59 -0
- data/spec/api/batches_api_spec.rb +164 -0
- data/spec/api/carrier_accounts_api_spec.rb +88 -0
- data/spec/api/carriers_api_spec.rb +107 -0
- data/spec/api/downloads_api_spec.rb +50 -0
- data/spec/api/insurance_api_spec.rb +81 -0
- data/spec/api/labels_api_spec.rb +161 -0
- data/spec/api/manifests_api_spec.rb +79 -0
- data/spec/api/package_types_api_spec.rb +95 -0
- data/spec/api/rates_api_spec.rb +83 -0
- data/spec/api/shipments_api_spec.rb +184 -0
- data/spec/api/tags_api_spec.rb +83 -0
- data/spec/api/tracking_api_spec.rb +74 -0
- data/spec/api/warehouses_api_spec.rb +95 -0
- data/spec/api/webhooks_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +35 -0
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +41 -0
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +35 -0
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +35 -0
- data/spec/models/add_to_batch_request_body_spec.rb +35 -0
- data/spec/models/address_residential_indicator_spec.rb +35 -0
- data/spec/models/address_spec.rb +35 -0
- data/spec/models/address_to_validate_spec.rb +35 -0
- data/spec/models/address_validating_shipment_spec.rb +173 -0
- data/spec/models/address_validation_code_spec.rb +35 -0
- data/spec/models/address_validation_detail_code_spec.rb +35 -0
- data/spec/models/address_validation_message_type_spec.rb +35 -0
- data/spec/models/address_validation_result_spec.rb +59 -0
- data/spec/models/address_validation_status_spec.rb +35 -0
- data/spec/models/advanced_shipment_options_spec.rb +131 -0
- data/spec/models/ancillary_service_endorsement_spec.rb +35 -0
- data/spec/models/batch_response_error_spec.rb +47 -0
- data/spec/models/batch_spec.rb +143 -0
- data/spec/models/batch_status_spec.rb +35 -0
- data/spec/models/batches_sort_by_spec.rb +35 -0
- data/spec/models/bill_to_party_spec.rb +35 -0
- data/spec/models/bulk_rate_spec.rb +65 -0
- data/spec/models/calculate_rates_request_body_spec.rb +35 -0
- data/spec/models/calculate_rates_response_body_spec.rb +173 -0
- data/spec/models/carrier_advanced_option_spec.rb +53 -0
- data/spec/models/carrier_name_spec.rb +35 -0
- data/spec/models/carrier_name_with_settings_spec.rb +35 -0
- data/spec/models/carrier_spec.rb +113 -0
- data/spec/models/collect_on_delivery_payment_type_spec.rb +35 -0
- data/spec/models/collect_on_delivery_spec.rb +47 -0
- data/spec/models/compare_bulk_rates_request_body_spec.rb +35 -0
- data/spec/models/connect_access_worldwide_request_body_spec.rb +53 -0
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +59 -0
- data/spec/models/connect_apc_request_body_spec.rb +53 -0
- data/spec/models/connect_asendia_request_body_spec.rb +59 -0
- data/spec/models/connect_australia_post_request_body_spec.rb +59 -0
- data/spec/models/connect_canada_post_request_body_spec.rb +65 -0
- data/spec/models/connect_carrier_request_body_spec.rb +329 -0
- data/spec/models/connect_carrier_response_body_spec.rb +41 -0
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +107 -0
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_request_body_spec.rb +47 -0
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +59 -0
- data/spec/models/connect_dpd_request_body_spec.rb +53 -0
- data/spec/models/connect_endicia_request_body_spec.rb +53 -0
- data/spec/models/connect_fedex_request_body_spec.rb +125 -0
- data/spec/models/connect_fedex_uk_request_body_spec.rb +125 -0
- data/spec/models/connect_firstmile_request_body_spec.rb +59 -0
- data/spec/models/connect_globegistics_request_body_spec.rb +53 -0
- data/spec/models/connect_imex_request_body_spec.rb +53 -0
- data/spec/models/connect_insurer_request_body_spec.rb +47 -0
- data/spec/models/connect_newgistics_request_body_spec.rb +59 -0
- data/spec/models/connect_ontrac_request_body_spec.rb +53 -0
- data/spec/models/connect_purolator_request_body_spec.rb +53 -0
- data/spec/models/connect_royal_mail_request_body_spec.rb +107 -0
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +53 -0
- data/spec/models/connect_seko_request_body_spec.rb +47 -0
- data/spec/models/connect_sendle_request_body_spec.rb +53 -0
- data/spec/models/connect_stamps_request_body_spec.rb +53 -0
- data/spec/models/connect_ups_request_body_spec.rb +143 -0
- data/spec/models/create_and_validate_shipment_spec.rb +179 -0
- data/spec/models/create_batch_request_body_spec.rb +59 -0
- data/spec/models/create_batch_response_body_spec.rb +35 -0
- data/spec/models/create_label_from_rate_request_body_spec.rb +35 -0
- data/spec/models/create_label_from_rate_response_body_spec.rb +35 -0
- data/spec/models/create_label_from_shipment_request_body_spec.rb +59 -0
- data/spec/models/create_label_from_shipment_response_body_spec.rb +35 -0
- data/spec/models/create_label_request_body_spec.rb +35 -0
- data/spec/models/create_label_response_body_spec.rb +35 -0
- data/spec/models/create_manifest_by_object_request_body_spec.rb +65 -0
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +41 -0
- data/spec/models/create_manifest_request_body_spec.rb +65 -0
- data/spec/models/create_manifest_response_body_spec.rb +95 -0
- data/spec/models/create_package_type_request_body_spec.rb +35 -0
- data/spec/models/create_package_type_response_body_spec.rb +35 -0
- data/spec/models/create_return_label_request_body_spec.rb +65 -0
- data/spec/models/create_return_label_response_body_spec.rb +35 -0
- data/spec/models/create_shipment_response_body_fields_spec.rb +47 -0
- data/spec/models/create_shipments_request_body_spec.rb +41 -0
- data/spec/models/create_shipments_response_body_spec.rb +47 -0
- data/spec/models/create_tag_response_body_spec.rb +35 -0
- data/spec/models/create_warehouse_request_body_spec.rb +35 -0
- data/spec/models/create_warehouse_response_body_spec.rb +35 -0
- data/spec/models/create_webhook_request_body_spec.rb +47 -0
- data/spec/models/create_webhook_response_body_spec.rb +35 -0
- data/spec/models/currency_spec.rb +35 -0
- data/spec/models/customs_item_spec.rb +89 -0
- data/spec/models/delivery_confirmation_spec.rb +35 -0
- data/spec/models/deprecated_manifest_spec.rb +89 -0
- data/spec/models/dhl_express_account_settings_spec.rb +53 -0
- data/spec/models/dhl_express_settings_response_body_spec.rb +35 -0
- data/spec/models/dimension_unit_spec.rb +35 -0
- data/spec/models/dimensions_spec.rb +59 -0
- data/spec/models/error_code_spec.rb +35 -0
- data/spec/models/error_response_body_spec.rb +47 -0
- data/spec/models/error_source_spec.rb +35 -0
- data/spec/models/error_spec.rb +59 -0
- data/spec/models/error_type_spec.rb +35 -0
- data/spec/models/estimate_rates_request_body_spec.rb +35 -0
- data/spec/models/fedex_account_settings_request_body_spec.rb +35 -0
- data/spec/models/fedex_account_settings_spec.rb +65 -0
- data/spec/models/fedex_pickup_type_spec.rb +35 -0
- data/spec/models/fedex_settings_response_body_spec.rb +35 -0
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +35 -0
- data/spec/models/get_batch_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_carrier_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_carrier_options_response_body_spec.rb +41 -0
- data/spec/models/get_carrier_settings_response_body_spec.rb +125 -0
- data/spec/models/get_carriers_response_body_spec.rb +53 -0
- data/spec/models/get_insurance_balance_response_body_spec.rb +35 -0
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +35 -0
- data/spec/models/get_label_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_manifest_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_package_type_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_rate_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +35 -0
- data/spec/models/get_shipment_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +35 -0
- data/spec/models/get_tracking_log_response_body_spec.rb +35 -0
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +35 -0
- data/spec/models/get_webhook_by_id_response_body_spec.rb +35 -0
- data/spec/models/insurance_provider_spec.rb +35 -0
- data/spec/models/international_shipment_options_spec.rb +53 -0
- data/spec/models/label_charge_event_spec.rb +35 -0
- data/spec/models/label_download_spec.rb +59 -0
- data/spec/models/label_download_type_spec.rb +35 -0
- data/spec/models/label_format_spec.rb +35 -0
- data/spec/models/label_layout_spec.rb +35 -0
- data/spec/models/label_messages_spec.rb +53 -0
- data/spec/models/label_spec.rb +233 -0
- data/spec/models/label_status_spec.rb +35 -0
- data/spec/models/link_spec.rb +35 -0
- data/spec/models/list_batch_errors_response_body_spec.rb +47 -0
- data/spec/models/list_batches_response_body_spec.rb +65 -0
- data/spec/models/list_carrier_package_types_response_body_spec.rb +41 -0
- data/spec/models/list_carrier_services_response_body_spec.rb +41 -0
- data/spec/models/list_carriers_response_body_spec.rb +41 -0
- data/spec/models/list_labels_response_body_spec.rb +41 -0
- data/spec/models/list_manifests_response_body_spec.rb +65 -0
- data/spec/models/list_package_types_response_body_spec.rb +41 -0
- data/spec/models/list_shipment_errors_response_body_spec.rb +47 -0
- data/spec/models/list_shipment_rates_response_body_spec.rb +35 -0
- data/spec/models/list_shipments_response_body_spec.rb +65 -0
- data/spec/models/list_tags_response_body_spec.rb +41 -0
- data/spec/models/list_warehouses_response_body_spec.rb +41 -0
- data/spec/models/manifest_download_spec.rb +41 -0
- data/spec/models/manifest_spec.rb +89 -0
- data/spec/models/manifests_spec.rb +41 -0
- data/spec/models/modify_batch_spec.rb +47 -0
- data/spec/models/monetary_value_spec.rb +47 -0
- data/spec/models/non_delivery_spec.rb +35 -0
- data/spec/models/optional_link_spec.rb +47 -0
- data/spec/models/order_source_name_spec.rb +35 -0
- data/spec/models/package_contents_spec.rb +35 -0
- data/spec/models/package_spec.rb +77 -0
- data/spec/models/package_type_spec.rb +65 -0
- data/spec/models/paged_list_response_body_spec.rb +59 -0
- data/spec/models/pagination_link_spec.rb +59 -0
- data/spec/models/parse_address_request_body_spec.rb +47 -0
- data/spec/models/parse_address_response_body_spec.rb +53 -0
- data/spec/models/parse_shipment_request_body_spec.rb +47 -0
- data/spec/models/parse_shipment_response_body_spec.rb +53 -0
- data/spec/models/partial_address_spec.rb +101 -0
- data/spec/models/partial_shipment_spec.rb +167 -0
- data/spec/models/payment_amount_spec.rb +47 -0
- data/spec/models/process_batch_request_body_spec.rb +53 -0
- data/spec/models/purchase_label_without_shipment_spec.rb +59 -0
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +41 -0
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +41 -0
- data/spec/models/rate_estimate_options_spec.rb +113 -0
- data/spec/models/rate_request_body_spec.rb +65 -0
- data/spec/models/rate_request_by_shipment_ids_spec.rb +41 -0
- data/spec/models/rate_request_by_shipments_spec.rb +41 -0
- data/spec/models/rate_request_options_spec.rb +41 -0
- data/spec/models/rate_request_rate_options_spec.rb +41 -0
- data/spec/models/rate_response_spec.rb +41 -0
- data/spec/models/rate_response_status_spec.rb +35 -0
- data/spec/models/rate_spec.rb +185 -0
- data/spec/models/rate_type_spec.rb +35 -0
- data/spec/models/rates_information_spec.rb +77 -0
- data/spec/models/recognized_entity_spec.rb +71 -0
- data/spec/models/remove_from_batch_request_body_spec.rb +35 -0
- data/spec/models/response_message_spec.rb +59 -0
- data/spec/models/service_spec.rb +77 -0
- data/spec/models/shipment_id_request_spec.rb +41 -0
- data/spec/models/shipment_item_spec.rb +89 -0
- data/spec/models/shipment_request_spec.rb +41 -0
- data/spec/models/shipment_response_error_spec.rb +53 -0
- data/spec/models/shipment_spec.rb +35 -0
- data/spec/models/shipment_status_spec.rb +35 -0
- data/spec/models/shipments_sort_by_spec.rb +35 -0
- data/spec/models/smart_post_hub_spec.rb +35 -0
- data/spec/models/sort_dir_spec.rb +35 -0
- data/spec/models/tag_shipment_response_body_spec.rb +47 -0
- data/spec/models/tag_spec.rb +41 -0
- data/spec/models/track_event_spec.rb +107 -0
- data/spec/models/tracking_information_spec.rb +95 -0
- data/spec/models/tracking_status_spec.rb +35 -0
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +41 -0
- data/spec/models/update_carrier_settings_request_body_spec.rb +143 -0
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +35 -0
- data/spec/models/update_fedex_settings_request_body_spec.rb +35 -0
- data/spec/models/update_newgistics_settings_request_body_spec.rb +47 -0
- data/spec/models/update_package_type_request_body_spec.rb +35 -0
- data/spec/models/update_shipment_fields_spec.rb +41 -0
- data/spec/models/update_shipment_request_body_spec.rb +173 -0
- data/spec/models/update_shipment_response_body_spec.rb +35 -0
- data/spec/models/update_ups_settings_request_body_spec.rb +35 -0
- data/spec/models/update_warehouse_request_body_spec.rb +35 -0
- data/spec/models/update_webhook_request_body_spec.rb +41 -0
- data/spec/models/ups_account_settings_spec.rb +107 -0
- data/spec/models/ups_invoice_spec.rb +59 -0
- data/spec/models/ups_pickup_type_spec.rb +35 -0
- data/spec/models/ups_settings_response_body_spec.rb +35 -0
- data/spec/models/validate_address_spec.rb +35 -0
- data/spec/models/validate_shipment_fields_spec.rb +41 -0
- data/spec/models/validation_status_spec.rb +35 -0
- data/spec/models/void_label_response_body_spec.rb +47 -0
- data/spec/models/warehouse_spec.rb +65 -0
- data/spec/models/webhook_event_spec.rb +35 -0
- data/spec/models/webhook_spec.rb +53 -0
- data/spec/models/weight_spec.rb +47 -0
- data/spec/models/weight_unit_spec.rb +35 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1110 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 9f6153ffb7a90cd2c1ae310e60a6626db2ef7255b9e013ae0a1d1641c7a2172f
|
|
4
|
+
data.tar.gz: 4fd7ec4c262cc271bcd6f7a088c09fbe1ca87eb49ec58e68338986cab76d4905
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: d20c863515397b3b36b027bdf6c8075d1ff107feb3cabf895470d09701a2d1820aba92c10f53bb401bce796151812cb9641d3a46b90f99c38c7ddfdb3ae62c3b
|
|
7
|
+
data.tar.gz: 4dc83503aecb81abed2e924aa628f57bd3ec488ba68672b0ec08c855ef4222bcc7777fd68e49adbe46265640f4fc17b6ce34da635e5589f0ea203736ec7de31c
|
data/Gemfile
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,431 @@
|
|
|
1
|
+
# openapi_client
|
|
2
|
+
|
|
3
|
+
OpenapiClient - the Ruby gem for the ShipEngine API
|
|
4
|
+
|
|
5
|
+
ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.
|
|
6
|
+
|
|
7
|
+
Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.
|
|
8
|
+
|
|
9
|
+
## Getting Started
|
|
10
|
+
If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.
|
|
11
|
+
|
|
12
|
+
Here are some step-by-step **tutorials** to get you started:
|
|
13
|
+
|
|
14
|
+
- [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)
|
|
15
|
+
- [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)
|
|
16
|
+
- [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)
|
|
17
|
+
- [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## Shipping Labels for Every Major Carrier
|
|
21
|
+
ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## Real-Time Package Tracking
|
|
25
|
+
With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Compare Shipping Costs Across Carriers
|
|
29
|
+
Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## Worldwide Address Validation
|
|
33
|
+
ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
37
|
+
|
|
38
|
+
- API version: 1.1.202006302006
|
|
39
|
+
- Package version: 1.0.0
|
|
40
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
41
|
+
For more information, please visit [https://www.shipengine.com/contact/](https://www.shipengine.com/contact/)
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
### Build a gem
|
|
46
|
+
|
|
47
|
+
To build the Ruby code into a gem:
|
|
48
|
+
|
|
49
|
+
```shell
|
|
50
|
+
gem build openapi_client.gemspec
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Then either install the gem locally:
|
|
54
|
+
|
|
55
|
+
```shell
|
|
56
|
+
gem install ./openapi_client-1.0.0.gem
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
|
|
60
|
+
|
|
61
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
62
|
+
|
|
63
|
+
Finally add this to the Gemfile:
|
|
64
|
+
|
|
65
|
+
gem 'openapi_client', '~> 1.0.0'
|
|
66
|
+
|
|
67
|
+
### Install from Git
|
|
68
|
+
|
|
69
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
70
|
+
|
|
71
|
+
gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
72
|
+
|
|
73
|
+
### Include the Ruby code directly
|
|
74
|
+
|
|
75
|
+
Include the Ruby code directly using `-I` as follows:
|
|
76
|
+
|
|
77
|
+
```shell
|
|
78
|
+
ruby -Ilib script.rb
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Getting Started
|
|
82
|
+
|
|
83
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
84
|
+
|
|
85
|
+
```ruby
|
|
86
|
+
# Load the gem
|
|
87
|
+
require 'openapi_client'
|
|
88
|
+
|
|
89
|
+
# Setup authorization
|
|
90
|
+
OpenapiClient.configure do |config|
|
|
91
|
+
# Configure API key authorization: api_key
|
|
92
|
+
config.api_key['API-Key'] = 'YOUR API KEY'
|
|
93
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
94
|
+
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
api_instance = OpenapiClient::AddressesApi.new
|
|
98
|
+
parse_address_request_body = {"text":"Margie McMiller at 3800 North Lamar suite 200 in austin, tx. The zip code there is 78652."} # ParseAddressRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide an `address` containing already-known values. For example, you may already know the recipient's name, city, and country, and only want to parse the street address into separate lines.
|
|
99
|
+
|
|
100
|
+
begin
|
|
101
|
+
#Parse an address
|
|
102
|
+
result = api_instance.parse_address(parse_address_request_body)
|
|
103
|
+
p result
|
|
104
|
+
rescue OpenapiClient::ApiError => e
|
|
105
|
+
puts "Exception when calling AddressesApi->parse_address: #{e}"
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Documentation for API Endpoints
|
|
111
|
+
|
|
112
|
+
All URIs are relative to *https://api.shipengine.com*
|
|
113
|
+
|
|
114
|
+
Class | Method | HTTP request | Description
|
|
115
|
+
------------ | ------------- | ------------- | -------------
|
|
116
|
+
*OpenapiClient::AddressesApi* | [**parse_address**](docs/AddressesApi.md#parse_address) | **PUT** /v1/addresses/recognize | Parse an address
|
|
117
|
+
*OpenapiClient::AddressesApi* | [**validate_address**](docs/AddressesApi.md#validate_address) | **POST** /v1/addresses/validate | Validate An Address
|
|
118
|
+
*OpenapiClient::BatchesApi* | [**add_to_batch**](docs/BatchesApi.md#add_to_batch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch
|
|
119
|
+
*OpenapiClient::BatchesApi* | [**create_batch**](docs/BatchesApi.md#create_batch) | **POST** /v1/batches | Create A Batch
|
|
120
|
+
*OpenapiClient::BatchesApi* | [**delete_batch**](docs/BatchesApi.md#delete_batch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id
|
|
121
|
+
*OpenapiClient::BatchesApi* | [**get_batch_by_external_id**](docs/BatchesApi.md#get_batch_by_external_id) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID
|
|
122
|
+
*OpenapiClient::BatchesApi* | [**get_batch_by_id**](docs/BatchesApi.md#get_batch_by_id) | **GET** /v1/batches/{batch_id} | Get Batch By ID
|
|
123
|
+
*OpenapiClient::BatchesApi* | [**list_batch_errors**](docs/BatchesApi.md#list_batch_errors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors
|
|
124
|
+
*OpenapiClient::BatchesApi* | [**list_batches**](docs/BatchesApi.md#list_batches) | **GET** /v1/batches | List Batches
|
|
125
|
+
*OpenapiClient::BatchesApi* | [**process_batch**](docs/BatchesApi.md#process_batch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels
|
|
126
|
+
*OpenapiClient::BatchesApi* | [**remove_from_batch**](docs/BatchesApi.md#remove_from_batch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch
|
|
127
|
+
*OpenapiClient::BatchesApi* | [**update_batch**](docs/BatchesApi.md#update_batch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id
|
|
128
|
+
*OpenapiClient::CarrierAccountsApi* | [**connect_carrier**](docs/CarrierAccountsApi.md#connect_carrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account
|
|
129
|
+
*OpenapiClient::CarrierAccountsApi* | [**disconnect_carrier**](docs/CarrierAccountsApi.md#disconnect_carrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier
|
|
130
|
+
*OpenapiClient::CarrierAccountsApi* | [**get_carrier_settings**](docs/CarrierAccountsApi.md#get_carrier_settings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings
|
|
131
|
+
*OpenapiClient::CarrierAccountsApi* | [**update_carrier_settings**](docs/CarrierAccountsApi.md#update_carrier_settings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings
|
|
132
|
+
*OpenapiClient::CarriersApi* | [**add_funds_to_carrier**](docs/CarriersApi.md#add_funds_to_carrier) | **PUT** /v1/carriers/{carrier_id}/add_funds | Add Funds To Carrier
|
|
133
|
+
*OpenapiClient::CarriersApi* | [**get_carrier_by_id**](docs/CarriersApi.md#get_carrier_by_id) | **GET** /v1/carriers/{carrier_id} | Get Carrier By ID
|
|
134
|
+
*OpenapiClient::CarriersApi* | [**get_carrier_options**](docs/CarriersApi.md#get_carrier_options) | **GET** /v1/carriers/{carrier_id}/options | Get Carrier Options
|
|
135
|
+
*OpenapiClient::CarriersApi* | [**list_carrier_package_types**](docs/CarriersApi.md#list_carrier_package_types) | **GET** /v1/carriers/{carrier_id}/packages | List Carrier Package Types
|
|
136
|
+
*OpenapiClient::CarriersApi* | [**list_carrier_services**](docs/CarriersApi.md#list_carrier_services) | **GET** /v1/carriers/{carrier_id}/services | List Carrier Services
|
|
137
|
+
*OpenapiClient::CarriersApi* | [**list_carriers**](docs/CarriersApi.md#list_carriers) | **GET** /v1/carriers | List Carriers
|
|
138
|
+
*OpenapiClient::DownloadsApi* | [**download_file**](docs/DownloadsApi.md#download_file) | **GET** /v1/downloads/{dir}/{subdir}/{filename} | Download File
|
|
139
|
+
*OpenapiClient::InsuranceApi* | [**add_funds_to_insurance**](docs/InsuranceApi.md#add_funds_to_insurance) | **PATCH** /v1/insurance/shipsurance/add_funds | Add Funds To Insurance
|
|
140
|
+
*OpenapiClient::InsuranceApi* | [**connect_insurer**](docs/InsuranceApi.md#connect_insurer) | **POST** /v1/connections/insurance/shipsurance | Connect a Shipsurance Account
|
|
141
|
+
*OpenapiClient::InsuranceApi* | [**disconnect_insurer**](docs/InsuranceApi.md#disconnect_insurer) | **DELETE** /v1/connections/insurance/shipsurance | Disconnect a Shipsurance Account
|
|
142
|
+
*OpenapiClient::InsuranceApi* | [**get_insurance_balance**](docs/InsuranceApi.md#get_insurance_balance) | **GET** /v1/insurance/shipsurance/balance | Get Insurance Funds Balance
|
|
143
|
+
*OpenapiClient::LabelsApi* | [**create_label**](docs/LabelsApi.md#create_label) | **POST** /v1/labels | Purchase Label
|
|
144
|
+
*OpenapiClient::LabelsApi* | [**create_label_from_rate**](docs/LabelsApi.md#create_label_from_rate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID
|
|
145
|
+
*OpenapiClient::LabelsApi* | [**create_label_from_shipment**](docs/LabelsApi.md#create_label_from_shipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID
|
|
146
|
+
*OpenapiClient::LabelsApi* | [**create_return_label**](docs/LabelsApi.md#create_return_label) | **POST** /v1/labels/{label_id}/return | Create a return label
|
|
147
|
+
*OpenapiClient::LabelsApi* | [**get_label_by_external_shipment_id**](docs/LabelsApi.md#get_label_by_external_shipment_id) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID
|
|
148
|
+
*OpenapiClient::LabelsApi* | [**get_label_by_id**](docs/LabelsApi.md#get_label_by_id) | **GET** /v1/labels/{label_id} | Get Label By ID
|
|
149
|
+
*OpenapiClient::LabelsApi* | [**get_tracking_log_from_label**](docs/LabelsApi.md#get_tracking_log_from_label) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information
|
|
150
|
+
*OpenapiClient::LabelsApi* | [**list_labels**](docs/LabelsApi.md#list_labels) | **GET** /v1/labels | List labels
|
|
151
|
+
*OpenapiClient::LabelsApi* | [**void_label**](docs/LabelsApi.md#void_label) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID
|
|
152
|
+
*OpenapiClient::ManifestsApi* | [**create_manifest**](docs/ManifestsApi.md#create_manifest) | **POST** /v1/manifests | Create Manifest
|
|
153
|
+
*OpenapiClient::ManifestsApi* | [**get_manifest_by_id**](docs/ManifestsApi.md#get_manifest_by_id) | **GET** /v1/manifests/{manifest_id} | Get Manifest By Id
|
|
154
|
+
*OpenapiClient::ManifestsApi* | [**list_manifests**](docs/ManifestsApi.md#list_manifests) | **GET** /v1/manifests | List Manifests
|
|
155
|
+
*OpenapiClient::PackageTypesApi* | [**create_package_type**](docs/PackageTypesApi.md#create_package_type) | **POST** /v1/packages | Create Custom Package Type
|
|
156
|
+
*OpenapiClient::PackageTypesApi* | [**delete_package_type**](docs/PackageTypesApi.md#delete_package_type) | **DELETE** /v1/packages/{package_id} | Delete A Custom Package By ID
|
|
157
|
+
*OpenapiClient::PackageTypesApi* | [**get_package_type_by_id**](docs/PackageTypesApi.md#get_package_type_by_id) | **GET** /v1/packages/{package_id} | Get Custom Package Type By ID
|
|
158
|
+
*OpenapiClient::PackageTypesApi* | [**list_package_types**](docs/PackageTypesApi.md#list_package_types) | **GET** /v1/packages | List Custom Package Types
|
|
159
|
+
*OpenapiClient::PackageTypesApi* | [**update_package_type**](docs/PackageTypesApi.md#update_package_type) | **PUT** /v1/packages/{package_id} | Update Custom Package Type By ID
|
|
160
|
+
*OpenapiClient::RatesApi* | [**calculate_rates**](docs/RatesApi.md#calculate_rates) | **POST** /v1/rates | Get Shipping Rates
|
|
161
|
+
*OpenapiClient::RatesApi* | [**compare_bulk_rates**](docs/RatesApi.md#compare_bulk_rates) | **POST** /v1/rates/bulk | Get Bulk Rates
|
|
162
|
+
*OpenapiClient::RatesApi* | [**estimate_rates**](docs/RatesApi.md#estimate_rates) | **POST** /v1/rates/estimate | Estimate Rates
|
|
163
|
+
*OpenapiClient::RatesApi* | [**get_rate_by_id**](docs/RatesApi.md#get_rate_by_id) | **GET** /v1/rates/{rate_id} | Get Rate By ID
|
|
164
|
+
*OpenapiClient::ShipmentsApi* | [**cancel_shipments**](docs/ShipmentsApi.md#cancel_shipments) | **PUT** /v1/shipments/{shipment_id}/cancel | Cancel a Shipment
|
|
165
|
+
*OpenapiClient::ShipmentsApi* | [**create_shipments**](docs/ShipmentsApi.md#create_shipments) | **POST** /v1/shipments | Create Shipments
|
|
166
|
+
*OpenapiClient::ShipmentsApi* | [**get_shipment_by_external_id**](docs/ShipmentsApi.md#get_shipment_by_external_id) | **GET** /v1/shipments/external_shipment_id/{external_shipment_id} | Get Shipment By External ID
|
|
167
|
+
*OpenapiClient::ShipmentsApi* | [**get_shipment_by_id**](docs/ShipmentsApi.md#get_shipment_by_id) | **GET** /v1/shipments/{shipment_id} | Get Shipment By ID
|
|
168
|
+
*OpenapiClient::ShipmentsApi* | [**list_shipment_errors**](docs/ShipmentsApi.md#list_shipment_errors) | **GET** /v1/shipments/{shipment_id}/errors | Get Shipment Errors
|
|
169
|
+
*OpenapiClient::ShipmentsApi* | [**list_shipment_rates**](docs/ShipmentsApi.md#list_shipment_rates) | **GET** /v1/shipments/{shipment_id}/rates | Get Shipment Rates
|
|
170
|
+
*OpenapiClient::ShipmentsApi* | [**list_shipments**](docs/ShipmentsApi.md#list_shipments) | **GET** /v1/shipments | List Shipments
|
|
171
|
+
*OpenapiClient::ShipmentsApi* | [**parse_shipment**](docs/ShipmentsApi.md#parse_shipment) | **PUT** /v1/shipments/recognize | Parse shipping info
|
|
172
|
+
*OpenapiClient::ShipmentsApi* | [**tag_shipment**](docs/ShipmentsApi.md#tag_shipment) | **POST** /v1/shipments/{shipment_id}/tags/{tag_name} | Add Tag to Shipment
|
|
173
|
+
*OpenapiClient::ShipmentsApi* | [**untag_shipment**](docs/ShipmentsApi.md#untag_shipment) | **DELETE** /v1/shipments/{shipment_id}/tags/{tag_name} | Remove Tag from Shipment
|
|
174
|
+
*OpenapiClient::ShipmentsApi* | [**update_shipment**](docs/ShipmentsApi.md#update_shipment) | **PUT** /v1/shipments/{shipment_id} | Update Shipment By ID
|
|
175
|
+
*OpenapiClient::TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /v1/tags/{tag_name} | Create a New Tag
|
|
176
|
+
*OpenapiClient::TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /v1/tags/{tag_name} | Delete Tag
|
|
177
|
+
*OpenapiClient::TagsApi* | [**list_tags**](docs/TagsApi.md#list_tags) | **GET** /v1/tags | Get Tags
|
|
178
|
+
*OpenapiClient::TagsApi* | [**rename_tag**](docs/TagsApi.md#rename_tag) | **PUT** /v1/tags/{tag_name}/{new_tag_name} | Update Tag Name
|
|
179
|
+
*OpenapiClient::TrackingApi* | [**get_tracking_log**](docs/TrackingApi.md#get_tracking_log) | **GET** /v1/tracking | Get Tracking Information
|
|
180
|
+
*OpenapiClient::TrackingApi* | [**start_tracking**](docs/TrackingApi.md#start_tracking) | **POST** /v1/tracking/start | Start Tracking a Package
|
|
181
|
+
*OpenapiClient::TrackingApi* | [**stop_tracking**](docs/TrackingApi.md#stop_tracking) | **POST** /v1/tracking/stop | Stop Tracking a Package
|
|
182
|
+
*OpenapiClient::WarehousesApi* | [**create_warehouse**](docs/WarehousesApi.md#create_warehouse) | **POST** /v1/warehouses | Create Warehouse
|
|
183
|
+
*OpenapiClient::WarehousesApi* | [**delete_warehouse**](docs/WarehousesApi.md#delete_warehouse) | **DELETE** /v1/warehouses/{warehouse_id} | Delete Warehouse By ID
|
|
184
|
+
*OpenapiClient::WarehousesApi* | [**get_warehouse_by_id**](docs/WarehousesApi.md#get_warehouse_by_id) | **GET** /v1/warehouses/{warehouse_id} | Get Warehouse By Id
|
|
185
|
+
*OpenapiClient::WarehousesApi* | [**list_warehouses**](docs/WarehousesApi.md#list_warehouses) | **GET** /v1/warehouses | List Warehouses
|
|
186
|
+
*OpenapiClient::WarehousesApi* | [**update_warehouse**](docs/WarehousesApi.md#update_warehouse) | **PUT** /v1/warehouses/{warehouse_id} | Update WareHouse By Id
|
|
187
|
+
*OpenapiClient::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v1/environment/webhooks | Create a Webhook
|
|
188
|
+
*OpenapiClient::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v1/environment/webhooks/{webhook_id} | Delete Webhook By ID
|
|
189
|
+
*OpenapiClient::WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /v1/environment/webhooks/{webhook_id} | Get Webhook By ID
|
|
190
|
+
*OpenapiClient::WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /v1/environment/webhooks | List Webhooks
|
|
191
|
+
*OpenapiClient::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /v1/environment/webhooks/{webhook_id} | Update a Webhook
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
## Documentation for Models
|
|
195
|
+
|
|
196
|
+
- [OpenapiClient::AddFundsToCarrierRequestBody](docs/AddFundsToCarrierRequestBody.md)
|
|
197
|
+
- [OpenapiClient::AddFundsToCarrierResponseBody](docs/AddFundsToCarrierResponseBody.md)
|
|
198
|
+
- [OpenapiClient::AddFundsToInsuranceRequestBody](docs/AddFundsToInsuranceRequestBody.md)
|
|
199
|
+
- [OpenapiClient::AddFundsToInsuranceResponseBody](docs/AddFundsToInsuranceResponseBody.md)
|
|
200
|
+
- [OpenapiClient::AddToBatchRequestBody](docs/AddToBatchRequestBody.md)
|
|
201
|
+
- [OpenapiClient::Address](docs/Address.md)
|
|
202
|
+
- [OpenapiClient::AddressResidentialIndicator](docs/AddressResidentialIndicator.md)
|
|
203
|
+
- [OpenapiClient::AddressToValidate](docs/AddressToValidate.md)
|
|
204
|
+
- [OpenapiClient::AddressValidatingShipment](docs/AddressValidatingShipment.md)
|
|
205
|
+
- [OpenapiClient::AddressValidationCode](docs/AddressValidationCode.md)
|
|
206
|
+
- [OpenapiClient::AddressValidationDetailCode](docs/AddressValidationDetailCode.md)
|
|
207
|
+
- [OpenapiClient::AddressValidationMessageType](docs/AddressValidationMessageType.md)
|
|
208
|
+
- [OpenapiClient::AddressValidationResult](docs/AddressValidationResult.md)
|
|
209
|
+
- [OpenapiClient::AddressValidationStatus](docs/AddressValidationStatus.md)
|
|
210
|
+
- [OpenapiClient::AdvancedShipmentOptions](docs/AdvancedShipmentOptions.md)
|
|
211
|
+
- [OpenapiClient::AncillaryServiceEndorsement](docs/AncillaryServiceEndorsement.md)
|
|
212
|
+
- [OpenapiClient::Batch](docs/Batch.md)
|
|
213
|
+
- [OpenapiClient::BatchResponseError](docs/BatchResponseError.md)
|
|
214
|
+
- [OpenapiClient::BatchStatus](docs/BatchStatus.md)
|
|
215
|
+
- [OpenapiClient::BatchesSortBy](docs/BatchesSortBy.md)
|
|
216
|
+
- [OpenapiClient::BillToParty](docs/BillToParty.md)
|
|
217
|
+
- [OpenapiClient::BulkRate](docs/BulkRate.md)
|
|
218
|
+
- [OpenapiClient::CalculateRatesRequestBody](docs/CalculateRatesRequestBody.md)
|
|
219
|
+
- [OpenapiClient::CalculateRatesResponseBody](docs/CalculateRatesResponseBody.md)
|
|
220
|
+
- [OpenapiClient::Carrier](docs/Carrier.md)
|
|
221
|
+
- [OpenapiClient::CarrierAdvancedOption](docs/CarrierAdvancedOption.md)
|
|
222
|
+
- [OpenapiClient::CarrierName](docs/CarrierName.md)
|
|
223
|
+
- [OpenapiClient::CarrierNameWithSettings](docs/CarrierNameWithSettings.md)
|
|
224
|
+
- [OpenapiClient::CollectOnDelivery](docs/CollectOnDelivery.md)
|
|
225
|
+
- [OpenapiClient::CollectOnDeliveryPaymentType](docs/CollectOnDeliveryPaymentType.md)
|
|
226
|
+
- [OpenapiClient::CompareBulkRatesRequestBody](docs/CompareBulkRatesRequestBody.md)
|
|
227
|
+
- [OpenapiClient::ConnectAccessWorldwideRequestBody](docs/ConnectAccessWorldwideRequestBody.md)
|
|
228
|
+
- [OpenapiClient::ConnectAmazonBuyShippingRequestBody](docs/ConnectAmazonBuyShippingRequestBody.md)
|
|
229
|
+
- [OpenapiClient::ConnectApcRequestBody](docs/ConnectApcRequestBody.md)
|
|
230
|
+
- [OpenapiClient::ConnectAsendiaRequestBody](docs/ConnectAsendiaRequestBody.md)
|
|
231
|
+
- [OpenapiClient::ConnectAustraliaPostRequestBody](docs/ConnectAustraliaPostRequestBody.md)
|
|
232
|
+
- [OpenapiClient::ConnectCanadaPostRequestBody](docs/ConnectCanadaPostRequestBody.md)
|
|
233
|
+
- [OpenapiClient::ConnectCarrierRequestBody](docs/ConnectCarrierRequestBody.md)
|
|
234
|
+
- [OpenapiClient::ConnectCarrierResponseBody](docs/ConnectCarrierResponseBody.md)
|
|
235
|
+
- [OpenapiClient::ConnectDhlEcommerceRequestBody](docs/ConnectDhlEcommerceRequestBody.md)
|
|
236
|
+
- [OpenapiClient::ConnectDhlExpressAuRequestBody](docs/ConnectDhlExpressAuRequestBody.md)
|
|
237
|
+
- [OpenapiClient::ConnectDhlExpressCaRequestBody](docs/ConnectDhlExpressCaRequestBody.md)
|
|
238
|
+
- [OpenapiClient::ConnectDhlExpressRequestBody](docs/ConnectDhlExpressRequestBody.md)
|
|
239
|
+
- [OpenapiClient::ConnectDhlExpressUkRequestBody](docs/ConnectDhlExpressUkRequestBody.md)
|
|
240
|
+
- [OpenapiClient::ConnectDpdRequestBody](docs/ConnectDpdRequestBody.md)
|
|
241
|
+
- [OpenapiClient::ConnectEndiciaRequestBody](docs/ConnectEndiciaRequestBody.md)
|
|
242
|
+
- [OpenapiClient::ConnectFedexRequestBody](docs/ConnectFedexRequestBody.md)
|
|
243
|
+
- [OpenapiClient::ConnectFedexUkRequestBody](docs/ConnectFedexUkRequestBody.md)
|
|
244
|
+
- [OpenapiClient::ConnectFirstmileRequestBody](docs/ConnectFirstmileRequestBody.md)
|
|
245
|
+
- [OpenapiClient::ConnectGlobegisticsRequestBody](docs/ConnectGlobegisticsRequestBody.md)
|
|
246
|
+
- [OpenapiClient::ConnectImexRequestBody](docs/ConnectImexRequestBody.md)
|
|
247
|
+
- [OpenapiClient::ConnectInsurerRequestBody](docs/ConnectInsurerRequestBody.md)
|
|
248
|
+
- [OpenapiClient::ConnectNewgisticsRequestBody](docs/ConnectNewgisticsRequestBody.md)
|
|
249
|
+
- [OpenapiClient::ConnectOntracRequestBody](docs/ConnectOntracRequestBody.md)
|
|
250
|
+
- [OpenapiClient::ConnectPurolatorRequestBody](docs/ConnectPurolatorRequestBody.md)
|
|
251
|
+
- [OpenapiClient::ConnectRoyalMailRequestBody](docs/ConnectRoyalMailRequestBody.md)
|
|
252
|
+
- [OpenapiClient::ConnectRrDonnelleyRequestBody](docs/ConnectRrDonnelleyRequestBody.md)
|
|
253
|
+
- [OpenapiClient::ConnectSekoRequestBody](docs/ConnectSekoRequestBody.md)
|
|
254
|
+
- [OpenapiClient::ConnectSendleRequestBody](docs/ConnectSendleRequestBody.md)
|
|
255
|
+
- [OpenapiClient::ConnectStampsRequestBody](docs/ConnectStampsRequestBody.md)
|
|
256
|
+
- [OpenapiClient::ConnectUpsRequestBody](docs/ConnectUpsRequestBody.md)
|
|
257
|
+
- [OpenapiClient::CreateAndValidateShipment](docs/CreateAndValidateShipment.md)
|
|
258
|
+
- [OpenapiClient::CreateBatchRequestBody](docs/CreateBatchRequestBody.md)
|
|
259
|
+
- [OpenapiClient::CreateBatchResponseBody](docs/CreateBatchResponseBody.md)
|
|
260
|
+
- [OpenapiClient::CreateLabelFromRateRequestBody](docs/CreateLabelFromRateRequestBody.md)
|
|
261
|
+
- [OpenapiClient::CreateLabelFromRateResponseBody](docs/CreateLabelFromRateResponseBody.md)
|
|
262
|
+
- [OpenapiClient::CreateLabelFromShipmentRequestBody](docs/CreateLabelFromShipmentRequestBody.md)
|
|
263
|
+
- [OpenapiClient::CreateLabelFromShipmentResponseBody](docs/CreateLabelFromShipmentResponseBody.md)
|
|
264
|
+
- [OpenapiClient::CreateLabelRequestBody](docs/CreateLabelRequestBody.md)
|
|
265
|
+
- [OpenapiClient::CreateLabelResponseBody](docs/CreateLabelResponseBody.md)
|
|
266
|
+
- [OpenapiClient::CreateManifestByObjectRequestBody](docs/CreateManifestByObjectRequestBody.md)
|
|
267
|
+
- [OpenapiClient::CreateManifestLabelIdsRequestBody](docs/CreateManifestLabelIdsRequestBody.md)
|
|
268
|
+
- [OpenapiClient::CreateManifestRequestBody](docs/CreateManifestRequestBody.md)
|
|
269
|
+
- [OpenapiClient::CreateManifestResponseBody](docs/CreateManifestResponseBody.md)
|
|
270
|
+
- [OpenapiClient::CreatePackageTypeRequestBody](docs/CreatePackageTypeRequestBody.md)
|
|
271
|
+
- [OpenapiClient::CreatePackageTypeResponseBody](docs/CreatePackageTypeResponseBody.md)
|
|
272
|
+
- [OpenapiClient::CreateReturnLabelRequestBody](docs/CreateReturnLabelRequestBody.md)
|
|
273
|
+
- [OpenapiClient::CreateReturnLabelResponseBody](docs/CreateReturnLabelResponseBody.md)
|
|
274
|
+
- [OpenapiClient::CreateShipmentResponseBodyFields](docs/CreateShipmentResponseBodyFields.md)
|
|
275
|
+
- [OpenapiClient::CreateShipmentsRequestBody](docs/CreateShipmentsRequestBody.md)
|
|
276
|
+
- [OpenapiClient::CreateShipmentsResponseBody](docs/CreateShipmentsResponseBody.md)
|
|
277
|
+
- [OpenapiClient::CreateTagResponseBody](docs/CreateTagResponseBody.md)
|
|
278
|
+
- [OpenapiClient::CreateWarehouseRequestBody](docs/CreateWarehouseRequestBody.md)
|
|
279
|
+
- [OpenapiClient::CreateWarehouseResponseBody](docs/CreateWarehouseResponseBody.md)
|
|
280
|
+
- [OpenapiClient::CreateWebhookRequestBody](docs/CreateWebhookRequestBody.md)
|
|
281
|
+
- [OpenapiClient::CreateWebhookResponseBody](docs/CreateWebhookResponseBody.md)
|
|
282
|
+
- [OpenapiClient::Currency](docs/Currency.md)
|
|
283
|
+
- [OpenapiClient::CustomsItem](docs/CustomsItem.md)
|
|
284
|
+
- [OpenapiClient::DeliveryConfirmation](docs/DeliveryConfirmation.md)
|
|
285
|
+
- [OpenapiClient::DeprecatedManifest](docs/DeprecatedManifest.md)
|
|
286
|
+
- [OpenapiClient::DhlExpressAccountSettings](docs/DhlExpressAccountSettings.md)
|
|
287
|
+
- [OpenapiClient::DhlExpressSettingsResponseBody](docs/DhlExpressSettingsResponseBody.md)
|
|
288
|
+
- [OpenapiClient::DimensionUnit](docs/DimensionUnit.md)
|
|
289
|
+
- [OpenapiClient::Dimensions](docs/Dimensions.md)
|
|
290
|
+
- [OpenapiClient::Error](docs/Error.md)
|
|
291
|
+
- [OpenapiClient::ErrorCode](docs/ErrorCode.md)
|
|
292
|
+
- [OpenapiClient::ErrorResponseBody](docs/ErrorResponseBody.md)
|
|
293
|
+
- [OpenapiClient::ErrorSource](docs/ErrorSource.md)
|
|
294
|
+
- [OpenapiClient::ErrorType](docs/ErrorType.md)
|
|
295
|
+
- [OpenapiClient::EstimateRatesRequestBody](docs/EstimateRatesRequestBody.md)
|
|
296
|
+
- [OpenapiClient::FedexAccountSettings](docs/FedexAccountSettings.md)
|
|
297
|
+
- [OpenapiClient::FedexAccountSettingsRequestBody](docs/FedexAccountSettingsRequestBody.md)
|
|
298
|
+
- [OpenapiClient::FedexPickupType](docs/FedexPickupType.md)
|
|
299
|
+
- [OpenapiClient::FedexSettingsResponseBody](docs/FedexSettingsResponseBody.md)
|
|
300
|
+
- [OpenapiClient::GetBatchByExternalIdResponseBody](docs/GetBatchByExternalIdResponseBody.md)
|
|
301
|
+
- [OpenapiClient::GetBatchByIdResponseBody](docs/GetBatchByIdResponseBody.md)
|
|
302
|
+
- [OpenapiClient::GetCarrierByIdResponseBody](docs/GetCarrierByIdResponseBody.md)
|
|
303
|
+
- [OpenapiClient::GetCarrierOptionsResponseBody](docs/GetCarrierOptionsResponseBody.md)
|
|
304
|
+
- [OpenapiClient::GetCarrierSettingsResponseBody](docs/GetCarrierSettingsResponseBody.md)
|
|
305
|
+
- [OpenapiClient::GetCarriersResponseBody](docs/GetCarriersResponseBody.md)
|
|
306
|
+
- [OpenapiClient::GetInsuranceBalanceResponseBody](docs/GetInsuranceBalanceResponseBody.md)
|
|
307
|
+
- [OpenapiClient::GetLabelByExternalShipmentIdResponseBody](docs/GetLabelByExternalShipmentIdResponseBody.md)
|
|
308
|
+
- [OpenapiClient::GetLabelByIdResponseBody](docs/GetLabelByIdResponseBody.md)
|
|
309
|
+
- [OpenapiClient::GetManifestByIdResponseBody](docs/GetManifestByIdResponseBody.md)
|
|
310
|
+
- [OpenapiClient::GetPackageTypeByIdResponseBody](docs/GetPackageTypeByIdResponseBody.md)
|
|
311
|
+
- [OpenapiClient::GetRateByIdResponseBody](docs/GetRateByIdResponseBody.md)
|
|
312
|
+
- [OpenapiClient::GetShipmentByExternalIdResponseBody](docs/GetShipmentByExternalIdResponseBody.md)
|
|
313
|
+
- [OpenapiClient::GetShipmentByIdResponseBody](docs/GetShipmentByIdResponseBody.md)
|
|
314
|
+
- [OpenapiClient::GetTrackingLogFromLabelResponseBody](docs/GetTrackingLogFromLabelResponseBody.md)
|
|
315
|
+
- [OpenapiClient::GetTrackingLogResponseBody](docs/GetTrackingLogResponseBody.md)
|
|
316
|
+
- [OpenapiClient::GetWarehouseByIdResponseBody](docs/GetWarehouseByIdResponseBody.md)
|
|
317
|
+
- [OpenapiClient::GetWebhookByIdResponseBody](docs/GetWebhookByIdResponseBody.md)
|
|
318
|
+
- [OpenapiClient::InsuranceProvider](docs/InsuranceProvider.md)
|
|
319
|
+
- [OpenapiClient::InternationalShipmentOptions](docs/InternationalShipmentOptions.md)
|
|
320
|
+
- [OpenapiClient::Label](docs/Label.md)
|
|
321
|
+
- [OpenapiClient::LabelChargeEvent](docs/LabelChargeEvent.md)
|
|
322
|
+
- [OpenapiClient::LabelDownload](docs/LabelDownload.md)
|
|
323
|
+
- [OpenapiClient::LabelDownloadType](docs/LabelDownloadType.md)
|
|
324
|
+
- [OpenapiClient::LabelFormat](docs/LabelFormat.md)
|
|
325
|
+
- [OpenapiClient::LabelLayout](docs/LabelLayout.md)
|
|
326
|
+
- [OpenapiClient::LabelMessages](docs/LabelMessages.md)
|
|
327
|
+
- [OpenapiClient::LabelStatus](docs/LabelStatus.md)
|
|
328
|
+
- [OpenapiClient::Link](docs/Link.md)
|
|
329
|
+
- [OpenapiClient::ListBatchErrorsResponseBody](docs/ListBatchErrorsResponseBody.md)
|
|
330
|
+
- [OpenapiClient::ListBatchesResponseBody](docs/ListBatchesResponseBody.md)
|
|
331
|
+
- [OpenapiClient::ListCarrierPackageTypesResponseBody](docs/ListCarrierPackageTypesResponseBody.md)
|
|
332
|
+
- [OpenapiClient::ListCarrierServicesResponseBody](docs/ListCarrierServicesResponseBody.md)
|
|
333
|
+
- [OpenapiClient::ListCarriersResponseBody](docs/ListCarriersResponseBody.md)
|
|
334
|
+
- [OpenapiClient::ListLabelsResponseBody](docs/ListLabelsResponseBody.md)
|
|
335
|
+
- [OpenapiClient::ListManifestsResponseBody](docs/ListManifestsResponseBody.md)
|
|
336
|
+
- [OpenapiClient::ListPackageTypesResponseBody](docs/ListPackageTypesResponseBody.md)
|
|
337
|
+
- [OpenapiClient::ListShipmentErrorsResponseBody](docs/ListShipmentErrorsResponseBody.md)
|
|
338
|
+
- [OpenapiClient::ListShipmentRatesResponseBody](docs/ListShipmentRatesResponseBody.md)
|
|
339
|
+
- [OpenapiClient::ListShipmentsResponseBody](docs/ListShipmentsResponseBody.md)
|
|
340
|
+
- [OpenapiClient::ListTagsResponseBody](docs/ListTagsResponseBody.md)
|
|
341
|
+
- [OpenapiClient::ListWarehousesResponseBody](docs/ListWarehousesResponseBody.md)
|
|
342
|
+
- [OpenapiClient::Manifest](docs/Manifest.md)
|
|
343
|
+
- [OpenapiClient::ManifestDownload](docs/ManifestDownload.md)
|
|
344
|
+
- [OpenapiClient::Manifests](docs/Manifests.md)
|
|
345
|
+
- [OpenapiClient::ModifyBatch](docs/ModifyBatch.md)
|
|
346
|
+
- [OpenapiClient::MonetaryValue](docs/MonetaryValue.md)
|
|
347
|
+
- [OpenapiClient::NonDelivery](docs/NonDelivery.md)
|
|
348
|
+
- [OpenapiClient::OptionalLink](docs/OptionalLink.md)
|
|
349
|
+
- [OpenapiClient::OrderSourceName](docs/OrderSourceName.md)
|
|
350
|
+
- [OpenapiClient::Package](docs/Package.md)
|
|
351
|
+
- [OpenapiClient::PackageContents](docs/PackageContents.md)
|
|
352
|
+
- [OpenapiClient::PackageType](docs/PackageType.md)
|
|
353
|
+
- [OpenapiClient::PagedListResponseBody](docs/PagedListResponseBody.md)
|
|
354
|
+
- [OpenapiClient::PaginationLink](docs/PaginationLink.md)
|
|
355
|
+
- [OpenapiClient::ParseAddressRequestBody](docs/ParseAddressRequestBody.md)
|
|
356
|
+
- [OpenapiClient::ParseAddressResponseBody](docs/ParseAddressResponseBody.md)
|
|
357
|
+
- [OpenapiClient::ParseShipmentRequestBody](docs/ParseShipmentRequestBody.md)
|
|
358
|
+
- [OpenapiClient::ParseShipmentResponseBody](docs/ParseShipmentResponseBody.md)
|
|
359
|
+
- [OpenapiClient::PartialAddress](docs/PartialAddress.md)
|
|
360
|
+
- [OpenapiClient::PartialShipment](docs/PartialShipment.md)
|
|
361
|
+
- [OpenapiClient::PaymentAmount](docs/PaymentAmount.md)
|
|
362
|
+
- [OpenapiClient::ProcessBatchRequestBody](docs/ProcessBatchRequestBody.md)
|
|
363
|
+
- [OpenapiClient::PurchaseLabelWithoutShipment](docs/PurchaseLabelWithoutShipment.md)
|
|
364
|
+
- [OpenapiClient::Rate](docs/Rate.md)
|
|
365
|
+
- [OpenapiClient::RateEstimateByCarrierId](docs/RateEstimateByCarrierId.md)
|
|
366
|
+
- [OpenapiClient::RateEstimateByCarrierIds](docs/RateEstimateByCarrierIds.md)
|
|
367
|
+
- [OpenapiClient::RateEstimateOptions](docs/RateEstimateOptions.md)
|
|
368
|
+
- [OpenapiClient::RateRequestBody](docs/RateRequestBody.md)
|
|
369
|
+
- [OpenapiClient::RateRequestByShipmentIds](docs/RateRequestByShipmentIds.md)
|
|
370
|
+
- [OpenapiClient::RateRequestByShipments](docs/RateRequestByShipments.md)
|
|
371
|
+
- [OpenapiClient::RateRequestOptions](docs/RateRequestOptions.md)
|
|
372
|
+
- [OpenapiClient::RateRequestRateOptions](docs/RateRequestRateOptions.md)
|
|
373
|
+
- [OpenapiClient::RateResponse](docs/RateResponse.md)
|
|
374
|
+
- [OpenapiClient::RateResponseStatus](docs/RateResponseStatus.md)
|
|
375
|
+
- [OpenapiClient::RateType](docs/RateType.md)
|
|
376
|
+
- [OpenapiClient::RatesInformation](docs/RatesInformation.md)
|
|
377
|
+
- [OpenapiClient::RecognizedEntity](docs/RecognizedEntity.md)
|
|
378
|
+
- [OpenapiClient::RemoveFromBatchRequestBody](docs/RemoveFromBatchRequestBody.md)
|
|
379
|
+
- [OpenapiClient::ResponseMessage](docs/ResponseMessage.md)
|
|
380
|
+
- [OpenapiClient::Service](docs/Service.md)
|
|
381
|
+
- [OpenapiClient::Shipment](docs/Shipment.md)
|
|
382
|
+
- [OpenapiClient::ShipmentIdRequest](docs/ShipmentIdRequest.md)
|
|
383
|
+
- [OpenapiClient::ShipmentItem](docs/ShipmentItem.md)
|
|
384
|
+
- [OpenapiClient::ShipmentRequest](docs/ShipmentRequest.md)
|
|
385
|
+
- [OpenapiClient::ShipmentResponseError](docs/ShipmentResponseError.md)
|
|
386
|
+
- [OpenapiClient::ShipmentStatus](docs/ShipmentStatus.md)
|
|
387
|
+
- [OpenapiClient::ShipmentsSortBy](docs/ShipmentsSortBy.md)
|
|
388
|
+
- [OpenapiClient::SmartPostHub](docs/SmartPostHub.md)
|
|
389
|
+
- [OpenapiClient::SortDir](docs/SortDir.md)
|
|
390
|
+
- [OpenapiClient::Tag](docs/Tag.md)
|
|
391
|
+
- [OpenapiClient::TagShipmentResponseBody](docs/TagShipmentResponseBody.md)
|
|
392
|
+
- [OpenapiClient::TrackEvent](docs/TrackEvent.md)
|
|
393
|
+
- [OpenapiClient::TrackingInformation](docs/TrackingInformation.md)
|
|
394
|
+
- [OpenapiClient::TrackingStatus](docs/TrackingStatus.md)
|
|
395
|
+
- [OpenapiClient::UpdateAmazonBuyShippingRequestBody](docs/UpdateAmazonBuyShippingRequestBody.md)
|
|
396
|
+
- [OpenapiClient::UpdateCarrierSettingsRequestBody](docs/UpdateCarrierSettingsRequestBody.md)
|
|
397
|
+
- [OpenapiClient::UpdateDhlExpressSettingsRequestBody](docs/UpdateDhlExpressSettingsRequestBody.md)
|
|
398
|
+
- [OpenapiClient::UpdateFedexSettingsRequestBody](docs/UpdateFedexSettingsRequestBody.md)
|
|
399
|
+
- [OpenapiClient::UpdateNewgisticsSettingsRequestBody](docs/UpdateNewgisticsSettingsRequestBody.md)
|
|
400
|
+
- [OpenapiClient::UpdatePackageTypeRequestBody](docs/UpdatePackageTypeRequestBody.md)
|
|
401
|
+
- [OpenapiClient::UpdateShipmentFields](docs/UpdateShipmentFields.md)
|
|
402
|
+
- [OpenapiClient::UpdateShipmentRequestBody](docs/UpdateShipmentRequestBody.md)
|
|
403
|
+
- [OpenapiClient::UpdateShipmentResponseBody](docs/UpdateShipmentResponseBody.md)
|
|
404
|
+
- [OpenapiClient::UpdateUpsSettingsRequestBody](docs/UpdateUpsSettingsRequestBody.md)
|
|
405
|
+
- [OpenapiClient::UpdateWarehouseRequestBody](docs/UpdateWarehouseRequestBody.md)
|
|
406
|
+
- [OpenapiClient::UpdateWebhookRequestBody](docs/UpdateWebhookRequestBody.md)
|
|
407
|
+
- [OpenapiClient::UpsAccountSettings](docs/UpsAccountSettings.md)
|
|
408
|
+
- [OpenapiClient::UpsInvoice](docs/UpsInvoice.md)
|
|
409
|
+
- [OpenapiClient::UpsPickupType](docs/UpsPickupType.md)
|
|
410
|
+
- [OpenapiClient::UpsSettingsResponseBody](docs/UpsSettingsResponseBody.md)
|
|
411
|
+
- [OpenapiClient::ValidateAddress](docs/ValidateAddress.md)
|
|
412
|
+
- [OpenapiClient::ValidateShipmentFields](docs/ValidateShipmentFields.md)
|
|
413
|
+
- [OpenapiClient::ValidationStatus](docs/ValidationStatus.md)
|
|
414
|
+
- [OpenapiClient::VoidLabelResponseBody](docs/VoidLabelResponseBody.md)
|
|
415
|
+
- [OpenapiClient::Warehouse](docs/Warehouse.md)
|
|
416
|
+
- [OpenapiClient::Webhook](docs/Webhook.md)
|
|
417
|
+
- [OpenapiClient::WebhookEvent](docs/WebhookEvent.md)
|
|
418
|
+
- [OpenapiClient::Weight](docs/Weight.md)
|
|
419
|
+
- [OpenapiClient::WeightUnit](docs/WeightUnit.md)
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
## Documentation for Authorization
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
### api_key
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
- **Type**: API key
|
|
429
|
+
- **API key parameter name**: API-Key
|
|
430
|
+
- **Location**: HTTP header
|
|
431
|
+
|