ship_engine 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +315 -320
- data/docs/AddFundsToCarrierRequestBody.md +5 -6
- data/docs/AddFundsToCarrierResponseBody.md +5 -7
- data/docs/AddFundsToInsuranceRequestBody.md +5 -6
- data/docs/AddFundsToInsuranceResponseBody.md +5 -6
- data/docs/AddToBatchRequestBody.md +5 -6
- data/docs/Address.md +5 -6
- data/docs/AddressResidentialIndicator.md +5 -6
- data/docs/AddressToValidate.md +5 -6
- data/docs/AddressValidatingShipment.md +27 -29
- data/docs/AddressValidationCode.md +5 -6
- data/docs/AddressValidationDetailCode.md +5 -6
- data/docs/AddressValidationMessageType.md +5 -6
- data/docs/AddressValidationResult.md +8 -10
- data/docs/AddressValidationStatus.md +5 -6
- data/docs/AddressesApi.md +19 -25
- data/docs/AdvancedShipmentOptions.md +20 -22
- data/docs/AncillaryServiceEndorsement.md +5 -6
- data/docs/Batch.md +22 -24
- data/docs/BatchResponseError.md +6 -8
- data/docs/BatchStatus.md +5 -6
- data/docs/BatchesApi.md +84 -106
- data/docs/BatchesSortBy.md +5 -6
- data/docs/BillToParty.md +5 -6
- data/docs/BulkRate.md +9 -11
- data/docs/CalculateRatesRequestBody.md +5 -6
- data/docs/CalculateRatesResponseBody.md +27 -29
- data/docs/Carrier.md +17 -19
- data/docs/CarrierAccountsApi.md +38 -48
- data/docs/CarrierAdvancedOption.md +7 -9
- data/docs/CarrierName.md +5 -6
- data/docs/CarrierNameWithSettings.md +5 -6
- data/docs/CarriersApi.md +38 -51
- data/docs/CollectOnDelivery.md +6 -8
- data/docs/CollectOnDeliveryPaymentType.md +5 -6
- data/docs/CompareBulkRatesRequestBody.md +5 -6
- data/docs/ConnectAccessWorldwideRequestBody.md +7 -9
- data/docs/ConnectAmazonBuyShippingRequestBody.md +8 -10
- data/docs/ConnectApcRequestBody.md +7 -9
- data/docs/ConnectAsendiaRequestBody.md +8 -10
- data/docs/ConnectAustraliaPostRequestBody.md +8 -10
- data/docs/ConnectCanadaPostRequestBody.md +9 -11
- data/docs/ConnectCarrierRequestBody.md +53 -55
- data/docs/ConnectCarrierResponseBody.md +5 -7
- data/docs/ConnectDhlEcommerceRequestBody.md +16 -18
- data/docs/ConnectDhlExpressAuRequestBody.md +6 -8
- data/docs/ConnectDhlExpressCaRequestBody.md +6 -8
- data/docs/ConnectDhlExpressRequestBody.md +6 -8
- data/docs/ConnectDhlExpressUkRequestBody.md +8 -10
- data/docs/ConnectDpdRequestBody.md +7 -9
- data/docs/ConnectEndiciaRequestBody.md +7 -9
- data/docs/ConnectFedexRequestBody.md +19 -21
- data/docs/ConnectFedexUkRequestBody.md +19 -21
- data/docs/ConnectFirstmileRequestBody.md +8 -10
- data/docs/ConnectGlobegisticsRequestBody.md +7 -9
- data/docs/ConnectImexRequestBody.md +7 -9
- data/docs/ConnectInsurerRequestBody.md +6 -8
- data/docs/ConnectNewgisticsRequestBody.md +8 -10
- data/docs/ConnectOntracRequestBody.md +7 -9
- data/docs/ConnectPurolatorRequestBody.md +7 -9
- data/docs/ConnectRoyalMailRequestBody.md +16 -18
- data/docs/ConnectRrDonnelleyRequestBody.md +7 -9
- data/docs/ConnectSekoRequestBody.md +6 -8
- data/docs/ConnectSendleRequestBody.md +7 -9
- data/docs/ConnectStampsRequestBody.md +7 -9
- data/docs/ConnectUpsRequestBody.md +22 -24
- data/docs/CreateAndValidateShipment.md +28 -30
- data/docs/CreateBatchRequestBody.md +8 -10
- data/docs/CreateBatchResponseBody.md +5 -6
- data/docs/CreateLabelFromRateRequestBody.md +5 -6
- data/docs/CreateLabelFromRateResponseBody.md +5 -6
- data/docs/CreateLabelFromShipmentRequestBody.md +8 -10
- data/docs/CreateLabelFromShipmentResponseBody.md +5 -6
- data/docs/CreateLabelRequestBody.md +5 -6
- data/docs/CreateLabelResponseBody.md +5 -6
- data/docs/CreateManifestByObjectRequestBody.md +9 -11
- data/docs/CreateManifestLabelIdsRequestBody.md +5 -7
- data/docs/CreateManifestRequestBody.md +9 -11
- data/docs/CreateManifestResponseBody.md +14 -16
- data/docs/CreatePackageTypeRequestBody.md +5 -6
- data/docs/CreatePackageTypeResponseBody.md +5 -6
- data/docs/CreateReturnLabelRequestBody.md +9 -11
- data/docs/CreateReturnLabelResponseBody.md +5 -6
- data/docs/CreateShipmentResponseBodyFields.md +6 -8
- data/docs/CreateShipmentsRequestBody.md +5 -7
- data/docs/CreateShipmentsResponseBody.md +6 -8
- data/docs/CreateTagResponseBody.md +5 -6
- data/docs/CreateWarehouseRequestBody.md +5 -6
- data/docs/CreateWarehouseResponseBody.md +5 -6
- data/docs/CreateWebhookRequestBody.md +4 -4
- data/docs/CreateWebhookResponseBody.md +5 -6
- data/docs/Currency.md +5 -6
- data/docs/CustomsItem.md +13 -15
- data/docs/DeliveryConfirmation.md +5 -6
- data/docs/DeprecatedManifest.md +13 -15
- data/docs/DhlExpressAccountSettings.md +7 -9
- data/docs/DhlExpressSettingsResponseBody.md +5 -6
- data/docs/DimensionUnit.md +5 -6
- data/docs/Dimensions.md +8 -10
- data/docs/DownloadsApi.md +16 -20
- data/docs/Error.md +8 -10
- data/docs/ErrorCode.md +5 -6
- data/docs/ErrorResponseBody.md +6 -8
- data/docs/ErrorSource.md +5 -6
- data/docs/ErrorType.md +5 -6
- data/docs/EstimateRatesRequestBody.md +5 -6
- data/docs/FedexAccountSettings.md +9 -11
- data/docs/FedexAccountSettingsRequestBody.md +5 -6
- data/docs/FedexPickupType.md +5 -6
- data/docs/FedexSettingsResponseBody.md +5 -6
- data/docs/GetBatchByExternalIdResponseBody.md +5 -6
- data/docs/GetBatchByIdResponseBody.md +5 -6
- data/docs/GetCarrierByIdResponseBody.md +5 -6
- data/docs/GetCarrierOptionsResponseBody.md +5 -7
- data/docs/GetCarrierSettingsResponseBody.md +19 -21
- data/docs/GetCarriersResponseBody.md +7 -9
- data/docs/GetInsuranceBalanceResponseBody.md +5 -6
- data/docs/GetLabelByExternalShipmentIdResponseBody.md +5 -6
- data/docs/GetLabelByIdResponseBody.md +5 -6
- data/docs/GetManifestByIdResponseBody.md +5 -6
- data/docs/GetPackageTypeByIdResponseBody.md +5 -6
- data/docs/GetRateByIdResponseBody.md +5 -6
- data/docs/GetShipmentByExternalIdResponseBody.md +5 -6
- data/docs/GetShipmentByIdResponseBody.md +5 -6
- data/docs/GetTrackingLogFromLabelResponseBody.md +5 -6
- data/docs/GetTrackingLogResponseBody.md +5 -6
- data/docs/GetWarehouseByIdResponseBody.md +5 -6
- data/docs/GetWebhookByIdResponseBody.md +5 -6
- data/docs/InsuranceApi.md +24 -32
- data/docs/InsuranceProvider.md +5 -6
- data/docs/InternationalShipmentOptions.md +7 -9
- data/docs/Label.md +34 -34
- data/docs/LabelChargeEvent.md +5 -6
- data/docs/LabelDownload.md +8 -10
- data/docs/LabelDownloadType.md +5 -6
- data/docs/LabelFormat.md +5 -6
- data/docs/LabelLayout.md +5 -6
- data/docs/LabelMessages.md +7 -9
- data/docs/LabelStatus.md +5 -6
- data/docs/LabelsApi.md +89 -109
- data/docs/Link.md +5 -6
- data/docs/ListBatchErrorsResponseBody.md +6 -8
- data/docs/ListBatchesResponseBody.md +9 -11
- data/docs/ListCarrierPackageTypesResponseBody.md +5 -7
- data/docs/ListCarrierServicesResponseBody.md +5 -7
- data/docs/ListCarriersResponseBody.md +5 -7
- data/docs/ListLabelsResponseBody.md +5 -7
- data/docs/ListManifestsResponseBody.md +9 -11
- data/docs/ListPackageTypesResponseBody.md +5 -7
- data/docs/ListShipmentErrorsResponseBody.md +6 -8
- data/docs/ListShipmentRatesResponseBody.md +5 -6
- data/docs/ListShipmentsResponseBody.md +9 -11
- data/docs/ListTagsResponseBody.md +5 -7
- data/docs/ListWarehousesResponseBody.md +5 -7
- data/docs/Manifest.md +13 -15
- data/docs/ManifestDownload.md +5 -7
- data/docs/Manifests.md +5 -7
- data/docs/ManifestsApi.md +33 -41
- data/docs/ModifyBatch.md +6 -8
- data/docs/MonetaryValue.md +6 -8
- data/docs/NonDelivery.md +5 -6
- data/docs/OptionalLink.md +6 -8
- data/docs/OrderSourceName.md +5 -6
- data/docs/Package.md +11 -13
- data/docs/PackageContents.md +5 -6
- data/docs/PackageType.md +9 -11
- data/docs/PackageTypesApi.md +33 -44
- data/docs/PagedListResponseBody.md +8 -10
- data/docs/PaginationLink.md +8 -10
- data/docs/ParseAddressRequestBody.md +6 -8
- data/docs/ParseAddressResponseBody.md +7 -9
- data/docs/ParseShipmentRequestBody.md +6 -8
- data/docs/ParseShipmentResponseBody.md +7 -9
- data/docs/PartialAddress.md +15 -17
- data/docs/PartialShipment.md +26 -28
- data/docs/PaymentAmount.md +6 -8
- data/docs/ProcessBatchRequestBody.md +7 -9
- data/docs/PurchaseLabelWithoutShipment.md +8 -10
- data/docs/Rate.md +29 -31
- data/docs/RateEstimateByCarrierId.md +5 -7
- data/docs/RateEstimateByCarrierIds.md +3 -3
- data/docs/RateEstimateOptions.md +17 -19
- data/docs/RateRequestBody.md +9 -11
- data/docs/RateRequestByShipmentIds.md +5 -7
- data/docs/RateRequestByShipments.md +5 -7
- data/docs/RateRequestOptions.md +5 -7
- data/docs/RateRequestRateOptions.md +5 -7
- data/docs/RateResponse.md +5 -7
- data/docs/RateResponseStatus.md +5 -6
- data/docs/RateType.md +5 -6
- data/docs/RatesApi.md +31 -41
- data/docs/RatesInformation.md +11 -13
- data/docs/RecognizedEntity.md +10 -12
- data/docs/RemoveFromBatchRequestBody.md +5 -6
- data/docs/ResponseMessage.md +8 -10
- data/docs/Service.md +11 -13
- data/docs/Shipment.md +5 -6
- data/docs/ShipmentIdRequest.md +5 -7
- data/docs/ShipmentItem.md +13 -15
- data/docs/ShipmentRequest.md +5 -7
- data/docs/ShipmentResponseError.md +7 -9
- data/docs/ShipmentStatus.md +5 -6
- data/docs/ShipmentsApi.md +101 -125
- data/docs/ShipmentsSortBy.md +5 -6
- data/docs/SmartPostHub.md +5 -6
- data/docs/SortDir.md +5 -6
- data/docs/Tag.md +5 -7
- data/docs/TagShipmentResponseBody.md +6 -8
- data/docs/TagsApi.md +29 -38
- data/docs/TrackEvent.md +16 -18
- data/docs/TrackingApi.md +25 -33
- data/docs/TrackingInformation.md +14 -16
- data/docs/TrackingStatus.md +5 -6
- data/docs/UpdateAmazonBuyShippingRequestBody.md +3 -3
- data/docs/UpdateCarrierSettingsRequestBody.md +22 -24
- data/docs/UpdateDhlExpressSettingsRequestBody.md +5 -6
- data/docs/UpdateFedexSettingsRequestBody.md +5 -6
- data/docs/UpdateNewgisticsSettingsRequestBody.md +6 -8
- data/docs/UpdatePackageTypeRequestBody.md +5 -6
- data/docs/UpdateShipmentFields.md +5 -7
- data/docs/UpdateShipmentRequestBody.md +27 -29
- data/docs/UpdateShipmentResponseBody.md +5 -6
- data/docs/UpdateUpsSettingsRequestBody.md +5 -6
- data/docs/UpdateWarehouseRequestBody.md +5 -6
- data/docs/UpdateWebhookRequestBody.md +5 -7
- data/docs/UpsAccountSettings.md +16 -18
- data/docs/UpsInvoice.md +8 -10
- data/docs/UpsPickupType.md +5 -6
- data/docs/UpsSettingsResponseBody.md +5 -6
- data/docs/ValidateAddress.md +5 -6
- data/docs/ValidateShipmentFields.md +5 -7
- data/docs/ValidationStatus.md +5 -6
- data/docs/VoidLabelResponseBody.md +6 -8
- data/docs/Warehouse.md +9 -11
- data/docs/WarehousesApi.md +34 -45
- data/docs/Webhook.md +7 -9
- data/docs/WebhookEvent.md +5 -6
- data/docs/WebhooksApi.md +33 -44
- data/docs/Weight.md +6 -8
- data/docs/WeightUnit.md +5 -6
- data/lib/ship_engine.rb +278 -0
- data/lib/{openapi_client → ship_engine}/api/addresses_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/batches_api.rb +42 -42
- data/lib/{openapi_client → ship_engine}/api/carrier_accounts_api.rb +14 -14
- data/lib/{openapi_client → ship_engine}/api/carriers_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/downloads_api.rb +12 -12
- data/lib/{openapi_client → ship_engine}/api/insurance_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/labels_api.rb +43 -43
- data/lib/{openapi_client → ship_engine}/api/manifests_api.rb +15 -15
- data/lib/{openapi_client → ship_engine}/api/package_types_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api/rates_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/shipments_api.rb +50 -50
- data/lib/{openapi_client → ship_engine}/api/tags_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/tracking_api.rb +10 -10
- data/lib/{openapi_client → ship_engine}/api/warehouses_api.rb +18 -18
- data/lib/{openapi_client → ship_engine}/api/webhooks_api.rb +16 -16
- data/lib/{openapi_client → ship_engine}/api_client.rb +2 -2
- data/lib/{openapi_client → ship_engine}/api_error.rb +2 -2
- data/lib/{openapi_client → ship_engine}/configuration.rb +2 -2
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/add_funds_to_carrier_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_response_body.rb → ship_engine/models/add_funds_to_insurance_request_body.rb} +8 -8
- data/lib/{openapi_client/models/add_funds_to_carrier_request_body.rb → ship_engine/models/add_funds_to_insurance_response_body.rb} +7 -7
- data/lib/{openapi_client → ship_engine}/models/add_to_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_residential_indicator.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_to_validate.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/address_validating_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/address_validation_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_detail_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_message_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/address_validation_result.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/address_validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/advanced_shipment_options.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/ancillary_service_endorsement.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batch.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/batch_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/batch_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/batches_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bill_to_party.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/bulk_rate.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/calculate_rates_response_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/carrier.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/carrier_advanced_option.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/carrier_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/carrier_name_with_settings.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/collect_on_delivery_payment_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/compare_bulk_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_access_worldwide_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_apc_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_asendia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_australia_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_canada_post_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_request_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/connect_carrier_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_ecommerce_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_au_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_ca_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dhl_express_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_dpd_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_endicia_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_fedex_uk_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_firstmile_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_globegistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_imex_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_insurer_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_newgistics_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ontrac_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_purolator_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_royal_mail_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_rr_donnelley_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_seko_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_sendle_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_stamps_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/connect_ups_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_and_validate_shipment.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/create_batch_request_body.rb +5 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_label_from_rate_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_warehouse_by_id_response_body.rb → ship_engine/models/create_label_from_rate_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_label_from_shipment_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_batch_by_external_id_response_body.rb → ship_engine/models/create_label_from_shipment_response_body.rb} +8 -8
- data/lib/ship_engine/models/create_label_request_body.rb +209 -0
- data/lib/ship_engine/models/create_label_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/create_manifest_by_object_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_label_ids_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_manifest_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_package_type_request_body.rb +5 -5
- data/lib/{openapi_client/models/get_carrier_by_id_response_body.rb → ship_engine/models/create_package_type_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_return_label_request_body.rb +8 -8
- data/lib/{openapi_client/models/get_webhook_by_id_response_body.rb → ship_engine/models/create_return_label_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_shipment_response_body_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/create_shipments_response_body.rb +5 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +209 -0
- data/lib/{openapi_client/models/create_batch_response_body.rb → ship_engine/models/create_warehouse_request_body.rb} +8 -8
- data/lib/{openapi_client/models/get_batch_by_id_response_body.rb → ship_engine/models/create_warehouse_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/create_webhook_request_body.rb +5 -5
- data/lib/{openapi_client/models/create_label_request_body.rb → ship_engine/models/create_webhook_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/currency.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/customs_item.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/delivery_confirmation.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/deprecated_manifest.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dhl_express_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/dimension_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/dimensions.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/error.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_code.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/error_source.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/error_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/estimate_rates_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_account_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/fedex_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/fedex_settings_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_return_label_response_body.rb → ship_engine/models/get_batch_by_external_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_tag_response_body.rb → ship_engine/models/get_batch_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/create_label_response_body.rb → ship_engine/models/get_carrier_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/get_carrier_options_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carrier_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_carriers_response_body.rb +6 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_label_by_external_shipment_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +209 -0
- data/lib/{openapi_client/models/get_label_by_id_response_body.rb → ship_engine/models/get_manifest_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_shipment_by_id_response_body.rb → ship_engine/models/get_package_type_by_id_response_body.rb} +8 -8
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_shipment_by_external_id_response_body.rb +5 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +209 -0
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_from_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/get_tracking_log_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_webhook_response_body.rb → ship_engine/models/get_warehouse_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client/models/get_rate_by_id_response_body.rb → ship_engine/models/get_webhook_by_id_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/insurance_provider.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/international_shipment_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/label.rb +29 -29
- data/lib/{openapi_client → ship_engine}/models/label_charge_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_download.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/label_download_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_format.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_layout.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/label_messages.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/label_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batch_errors_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_batches_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carrier_services_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_carriers_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_labels_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/list_manifests_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_package_types_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_shipment_errors_response_body.rb +5 -5
- data/lib/{openapi_client/models/create_warehouse_request_body.rb → ship_engine/models/list_shipment_rates_response_body.rb} +8 -8
- data/lib/{openapi_client → ship_engine}/models/list_shipments_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_tags_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/list_warehouses_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifest.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/manifest_download.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/manifests.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/modify_batch.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/monetary_value.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/non_delivery.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/optional_link.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/order_source_name.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/package_contents.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/package_type.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/paged_list_response_body.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/pagination_link.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_address_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_address_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_request_body.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/parse_shipment_response_body.rb +9 -9
- data/lib/{openapi_client → ship_engine}/models/partial_address.rb +13 -13
- data/lib/{openapi_client → ship_engine}/models/partial_shipment.rb +17 -17
- data/lib/{openapi_client → ship_engine}/models/payment_amount.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/process_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/purchase_label_without_shipment.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate.rb +7 -7
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_id.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_by_carrier_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_estimate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipment_ids.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_by_shipments.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_request_rate_options.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/rate_response_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rate_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/rates_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/recognized_entity.rb +8 -8
- data/lib/{openapi_client → ship_engine}/models/remove_from_batch_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/response_message.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/service.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/shipment_id_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_item.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_request.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_response_error.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/shipment_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/shipments_sort_by.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/smart_post_hub.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/sort_dir.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/tag.rb +6 -6
- data/lib/{openapi_client → ship_engine}/models/tag_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/track_event.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_information.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/tracking_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/update_amazon_buy_shipping_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_carrier_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_dhl_express_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_fedex_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_newgistics_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_package_type_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_shipment_request_body.rb +16 -16
- data/lib/{openapi_client → ship_engine}/models/update_shipment_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_ups_settings_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_warehouse_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/update_webhook_request_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_account_settings.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_invoice.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/ups_pickup_type.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/ups_settings_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validate_address.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/validate_shipment_fields.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/validation_status.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/void_label_response_body.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/warehouse.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/webhook_event.rb +2 -2
- data/lib/{openapi_client → ship_engine}/models/weight.rb +5 -5
- data/lib/{openapi_client → ship_engine}/models/weight_unit.rb +2 -2
- data/lib/{openapi_client → ship_engine}/version.rb +3 -3
- data/ship_engine-1.0.0.gem +0 -0
- data/ship_engine.gemspec +2 -2
- data/spec/api/addresses_api_spec.rb +8 -8
- data/spec/api/batches_api_spec.rb +15 -15
- data/spec/api/carrier_accounts_api_spec.rb +6 -6
- data/spec/api/carriers_api_spec.rb +5 -5
- data/spec/api/downloads_api_spec.rb +8 -8
- data/spec/api/insurance_api_spec.rb +7 -7
- data/spec/api/labels_api_spec.rb +16 -16
- data/spec/api/manifests_api_spec.rb +8 -8
- data/spec/api/package_types_api_spec.rb +6 -6
- data/spec/api/rates_api_spec.rb +8 -8
- data/spec/api/shipments_api_spec.rb +18 -18
- data/spec/api/tags_api_spec.rb +8 -8
- data/spec/api/tracking_api_spec.rb +5 -5
- data/spec/api/warehouses_api_spec.rb +7 -7
- data/spec/api/webhooks_api_spec.rb +6 -6
- data/spec/api_client_spec.rb +24 -24
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/add_funds_to_carrier_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_carrier_response_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_request_body_spec.rb +4 -4
- data/spec/models/add_funds_to_insurance_response_body_spec.rb +4 -4
- data/spec/models/add_to_batch_request_body_spec.rb +4 -4
- data/spec/models/address_residential_indicator_spec.rb +4 -4
- data/spec/models/address_spec.rb +4 -4
- data/spec/models/address_to_validate_spec.rb +4 -4
- data/spec/models/address_validating_shipment_spec.rb +4 -4
- data/spec/models/address_validation_code_spec.rb +4 -4
- data/spec/models/address_validation_detail_code_spec.rb +4 -4
- data/spec/models/address_validation_message_type_spec.rb +4 -4
- data/spec/models/address_validation_result_spec.rb +4 -4
- data/spec/models/address_validation_status_spec.rb +4 -4
- data/spec/models/advanced_shipment_options_spec.rb +4 -4
- data/spec/models/ancillary_service_endorsement_spec.rb +4 -4
- data/spec/models/batch_response_error_spec.rb +4 -4
- data/spec/models/batch_spec.rb +4 -4
- data/spec/models/batch_status_spec.rb +4 -4
- data/spec/models/batches_sort_by_spec.rb +4 -4
- data/spec/models/bill_to_party_spec.rb +4 -4
- data/spec/models/bulk_rate_spec.rb +4 -4
- data/spec/models/calculate_rates_request_body_spec.rb +4 -4
- data/spec/models/calculate_rates_response_body_spec.rb +4 -4
- data/spec/models/carrier_advanced_option_spec.rb +4 -4
- data/spec/models/carrier_name_spec.rb +4 -4
- data/spec/models/carrier_name_with_settings_spec.rb +4 -4
- data/spec/models/carrier_spec.rb +4 -4
- data/spec/models/collect_on_delivery_payment_type_spec.rb +4 -4
- data/spec/models/collect_on_delivery_spec.rb +4 -4
- data/spec/models/compare_bulk_rates_request_body_spec.rb +4 -4
- data/spec/models/connect_access_worldwide_request_body_spec.rb +4 -4
- data/spec/models/connect_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/connect_apc_request_body_spec.rb +4 -4
- data/spec/models/connect_asendia_request_body_spec.rb +4 -4
- data/spec/models/connect_australia_post_request_body_spec.rb +4 -4
- data/spec/models/connect_canada_post_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_request_body_spec.rb +4 -4
- data/spec/models/connect_carrier_response_body_spec.rb +4 -4
- data/spec/models/connect_dhl_ecommerce_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_au_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_ca_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_request_body_spec.rb +4 -4
- data/spec/models/connect_dhl_express_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_dpd_request_body_spec.rb +4 -4
- data/spec/models/connect_endicia_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_request_body_spec.rb +4 -4
- data/spec/models/connect_fedex_uk_request_body_spec.rb +4 -4
- data/spec/models/connect_firstmile_request_body_spec.rb +4 -4
- data/spec/models/connect_globegistics_request_body_spec.rb +4 -4
- data/spec/models/connect_imex_request_body_spec.rb +4 -4
- data/spec/models/connect_insurer_request_body_spec.rb +4 -4
- data/spec/models/connect_newgistics_request_body_spec.rb +4 -4
- data/spec/models/connect_ontrac_request_body_spec.rb +4 -4
- data/spec/models/connect_purolator_request_body_spec.rb +4 -4
- data/spec/models/connect_royal_mail_request_body_spec.rb +4 -4
- data/spec/models/connect_rr_donnelley_request_body_spec.rb +4 -4
- data/spec/models/connect_seko_request_body_spec.rb +4 -4
- data/spec/models/connect_sendle_request_body_spec.rb +4 -4
- data/spec/models/connect_stamps_request_body_spec.rb +4 -4
- data/spec/models/connect_ups_request_body_spec.rb +4 -4
- data/spec/models/create_and_validate_shipment_spec.rb +4 -4
- data/spec/models/create_batch_request_body_spec.rb +4 -4
- data/spec/models/create_batch_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_rate_response_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_request_body_spec.rb +4 -4
- data/spec/models/create_label_from_shipment_response_body_spec.rb +4 -4
- data/spec/models/create_label_request_body_spec.rb +4 -4
- data/spec/models/create_label_response_body_spec.rb +4 -4
- data/spec/models/create_manifest_by_object_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_label_ids_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_request_body_spec.rb +4 -4
- data/spec/models/create_manifest_response_body_spec.rb +4 -4
- data/spec/models/create_package_type_request_body_spec.rb +4 -4
- data/spec/models/create_package_type_response_body_spec.rb +4 -4
- data/spec/models/create_return_label_request_body_spec.rb +4 -4
- data/spec/models/create_return_label_response_body_spec.rb +4 -4
- data/spec/models/create_shipment_response_body_fields_spec.rb +4 -4
- data/spec/models/create_shipments_request_body_spec.rb +4 -4
- data/spec/models/create_shipments_response_body_spec.rb +4 -4
- data/spec/models/create_tag_response_body_spec.rb +4 -4
- data/spec/models/create_warehouse_request_body_spec.rb +4 -4
- data/spec/models/create_warehouse_response_body_spec.rb +4 -4
- data/spec/models/create_webhook_request_body_spec.rb +4 -4
- data/spec/models/create_webhook_response_body_spec.rb +4 -4
- data/spec/models/currency_spec.rb +4 -4
- data/spec/models/customs_item_spec.rb +4 -4
- data/spec/models/delivery_confirmation_spec.rb +4 -4
- data/spec/models/deprecated_manifest_spec.rb +4 -4
- data/spec/models/dhl_express_account_settings_spec.rb +4 -4
- data/spec/models/dhl_express_settings_response_body_spec.rb +4 -4
- data/spec/models/dimension_unit_spec.rb +4 -4
- data/spec/models/dimensions_spec.rb +4 -4
- data/spec/models/error_code_spec.rb +4 -4
- data/spec/models/error_response_body_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/error_spec.rb +4 -4
- data/spec/models/error_type_spec.rb +4 -4
- data/spec/models/estimate_rates_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_request_body_spec.rb +4 -4
- data/spec/models/fedex_account_settings_spec.rb +4 -4
- data/spec/models/fedex_pickup_type_spec.rb +4 -4
- data/spec/models/fedex_settings_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_batch_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_options_response_body_spec.rb +4 -4
- data/spec/models/get_carrier_settings_response_body_spec.rb +4 -4
- data/spec/models/get_carriers_response_body_spec.rb +4 -4
- data/spec/models/get_insurance_balance_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_external_shipment_id_response_body_spec.rb +4 -4
- data/spec/models/get_label_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_manifest_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_package_type_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_rate_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_external_id_response_body_spec.rb +4 -4
- data/spec/models/get_shipment_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_from_label_response_body_spec.rb +4 -4
- data/spec/models/get_tracking_log_response_body_spec.rb +4 -4
- data/spec/models/get_warehouse_by_id_response_body_spec.rb +4 -4
- data/spec/models/get_webhook_by_id_response_body_spec.rb +4 -4
- data/spec/models/insurance_provider_spec.rb +4 -4
- data/spec/models/international_shipment_options_spec.rb +4 -4
- data/spec/models/label_charge_event_spec.rb +4 -4
- data/spec/models/label_download_spec.rb +4 -4
- data/spec/models/label_download_type_spec.rb +4 -4
- data/spec/models/label_format_spec.rb +4 -4
- data/spec/models/label_layout_spec.rb +4 -4
- data/spec/models/label_messages_spec.rb +4 -4
- data/spec/models/label_spec.rb +4 -4
- data/spec/models/label_status_spec.rb +4 -4
- data/spec/models/link_spec.rb +4 -4
- data/spec/models/list_batch_errors_response_body_spec.rb +4 -4
- data/spec/models/list_batches_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_carrier_services_response_body_spec.rb +4 -4
- data/spec/models/list_carriers_response_body_spec.rb +4 -4
- data/spec/models/list_labels_response_body_spec.rb +4 -4
- data/spec/models/list_manifests_response_body_spec.rb +4 -4
- data/spec/models/list_package_types_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_errors_response_body_spec.rb +4 -4
- data/spec/models/list_shipment_rates_response_body_spec.rb +4 -4
- data/spec/models/list_shipments_response_body_spec.rb +4 -4
- data/spec/models/list_tags_response_body_spec.rb +4 -4
- data/spec/models/list_warehouses_response_body_spec.rb +4 -4
- data/spec/models/manifest_download_spec.rb +4 -4
- data/spec/models/manifest_spec.rb +4 -4
- data/spec/models/manifests_spec.rb +4 -4
- data/spec/models/modify_batch_spec.rb +4 -4
- data/spec/models/monetary_value_spec.rb +4 -4
- data/spec/models/non_delivery_spec.rb +4 -4
- data/spec/models/optional_link_spec.rb +4 -4
- data/spec/models/order_source_name_spec.rb +4 -4
- data/spec/models/package_contents_spec.rb +4 -4
- data/spec/models/package_spec.rb +4 -4
- data/spec/models/package_type_spec.rb +4 -4
- data/spec/models/paged_list_response_body_spec.rb +4 -4
- data/spec/models/pagination_link_spec.rb +4 -4
- data/spec/models/parse_address_request_body_spec.rb +4 -4
- data/spec/models/parse_address_response_body_spec.rb +4 -4
- data/spec/models/parse_shipment_request_body_spec.rb +4 -4
- data/spec/models/parse_shipment_response_body_spec.rb +4 -4
- data/spec/models/partial_address_spec.rb +4 -4
- data/spec/models/partial_shipment_spec.rb +4 -4
- data/spec/models/payment_amount_spec.rb +4 -4
- data/spec/models/process_batch_request_body_spec.rb +4 -4
- data/spec/models/purchase_label_without_shipment_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_id_spec.rb +4 -4
- data/spec/models/rate_estimate_by_carrier_ids_spec.rb +4 -4
- data/spec/models/rate_estimate_options_spec.rb +4 -4
- data/spec/models/rate_request_body_spec.rb +4 -4
- data/spec/models/rate_request_by_shipment_ids_spec.rb +4 -4
- data/spec/models/rate_request_by_shipments_spec.rb +4 -4
- data/spec/models/rate_request_options_spec.rb +4 -4
- data/spec/models/rate_request_rate_options_spec.rb +4 -4
- data/spec/models/rate_response_spec.rb +4 -4
- data/spec/models/rate_response_status_spec.rb +4 -4
- data/spec/models/rate_spec.rb +4 -4
- data/spec/models/rate_type_spec.rb +4 -4
- data/spec/models/rates_information_spec.rb +4 -4
- data/spec/models/recognized_entity_spec.rb +4 -4
- data/spec/models/remove_from_batch_request_body_spec.rb +4 -4
- data/spec/models/response_message_spec.rb +4 -4
- data/spec/models/service_spec.rb +4 -4
- data/spec/models/shipment_id_request_spec.rb +4 -4
- data/spec/models/shipment_item_spec.rb +4 -4
- data/spec/models/shipment_request_spec.rb +4 -4
- data/spec/models/shipment_response_error_spec.rb +4 -4
- data/spec/models/shipment_spec.rb +4 -4
- data/spec/models/shipment_status_spec.rb +4 -4
- data/spec/models/shipments_sort_by_spec.rb +4 -4
- data/spec/models/smart_post_hub_spec.rb +4 -4
- data/spec/models/sort_dir_spec.rb +4 -4
- data/spec/models/tag_shipment_response_body_spec.rb +4 -4
- data/spec/models/tag_spec.rb +4 -4
- data/spec/models/track_event_spec.rb +4 -4
- data/spec/models/tracking_information_spec.rb +4 -4
- data/spec/models/tracking_status_spec.rb +4 -4
- data/spec/models/update_amazon_buy_shipping_request_body_spec.rb +4 -4
- data/spec/models/update_carrier_settings_request_body_spec.rb +4 -4
- data/spec/models/update_dhl_express_settings_request_body_spec.rb +4 -4
- data/spec/models/update_fedex_settings_request_body_spec.rb +4 -4
- data/spec/models/update_newgistics_settings_request_body_spec.rb +4 -4
- data/spec/models/update_package_type_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_fields_spec.rb +4 -4
- data/spec/models/update_shipment_request_body_spec.rb +4 -4
- data/spec/models/update_shipment_response_body_spec.rb +4 -4
- data/spec/models/update_ups_settings_request_body_spec.rb +4 -4
- data/spec/models/update_warehouse_request_body_spec.rb +4 -4
- data/spec/models/update_webhook_request_body_spec.rb +4 -4
- data/spec/models/ups_account_settings_spec.rb +4 -4
- data/spec/models/ups_invoice_spec.rb +4 -4
- data/spec/models/ups_pickup_type_spec.rb +4 -4
- data/spec/models/ups_settings_response_body_spec.rb +4 -4
- data/spec/models/validate_address_spec.rb +4 -4
- data/spec/models/validate_shipment_fields_spec.rb +4 -4
- data/spec/models/validation_status_spec.rb +4 -4
- data/spec/models/void_label_response_body_spec.rb +4 -4
- data/spec/models/warehouse_spec.rb +4 -4
- data/spec/models/webhook_event_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/models/weight_spec.rb +4 -4
- data/spec/models/weight_unit_spec.rb +4 -4
- metadata +246 -246
- data/lib/openapi_client.rb +0 -278
- data/lib/openapi_client/models/add_funds_to_insurance_request_body.rb +0 -209
- data/lib/openapi_client/models/add_funds_to_insurance_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_rate_response_body.rb +0 -209
- data/lib/openapi_client/models/create_label_from_shipment_response_body.rb +0 -209
- data/lib/openapi_client/models/create_package_type_response_body.rb +0 -209
- data/lib/openapi_client/models/get_insurance_balance_response_body.rb +0 -209
- data/lib/openapi_client/models/get_manifest_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/get_package_type_by_id_response_body.rb +0 -209
- data/lib/openapi_client/models/list_shipment_rates_response_body.rb +0 -209
- data/openapi_client-1.0.0.gem +0 -0
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::AdvancedShipmentOptions
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**bill_to_account**
|
|
8
|
-
**bill_to_country_code**
|
|
9
|
-
**bill_to_party**
|
|
10
|
-
**bill_to_postal_code**
|
|
11
|
-
**contains_alcohol**
|
|
12
|
-
**delivered_duty_paid**
|
|
13
|
-
**dry_ice**
|
|
14
|
-
**dry_ice_weight**
|
|
15
|
-
**non_machinable**
|
|
16
|
-
**saturday_delivery**
|
|
17
|
-
**use_ups_ground_freight_pricing** | **Boolean**
|
|
18
|
-
**freight_class**
|
|
19
|
-
**custom_field1**
|
|
20
|
-
**custom_field2**
|
|
21
|
-
**custom_field3**
|
|
22
|
-
**collect_on_delivery**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
|
|
7
|
+
| **bill_to_account** | **String** | This field is used to [bill shipping costs to a third party](https://www.shipengine.com/docs/shipping/bill-to-third-party/). This field must be used in conjunction with the `bill_to_country_code`, `bill_to_party`, and `bill_to_postal_code` fields. | [optional] [default to 'null'] |
|
|
8
|
+
| **bill_to_country_code** | **String** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the third-party that is responsible for shipping costs. | [optional] |
|
|
9
|
+
| **bill_to_party** | [**BillToParty**](BillToParty.md) | Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the `bill_to_account`, `bill_to_country_code`, and `bill_to_postal_code` fields must also be set. | [optional] |
|
|
10
|
+
| **bill_to_postal_code** | **String** | The postal code of the third-party that is responsible for shipping costs. | [optional] [default to 'null'] |
|
|
11
|
+
| **contains_alcohol** | **Boolean** | Indicates that the shipment contains alcohol. | [optional] [default to false] |
|
|
12
|
+
| **delivered_duty_paid** | **Boolean** | Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express. | [optional] [default to false] |
|
|
13
|
+
| **dry_ice** | **Boolean** | Indicates if the shipment contain dry ice | [optional] [default to false] |
|
|
14
|
+
| **dry_ice_weight** | [**Weight**](Weight.md) | The weight of the dry ice in the shipment | [optional] |
|
|
15
|
+
| **non_machinable** | **Boolean** | Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See [Section 1.2 of the USPS parcel standards](https://pe.usps.com/text/dmm300/101.htm#ep1047495) for details. | [optional] [default to false] |
|
|
16
|
+
| **saturday_delivery** | **Boolean** | Enables Saturday delivery, if supported by the carrier. | [optional] [default to false] |
|
|
17
|
+
| **use_ups_ground_freight_pricing** | **Boolean** | Whether to use [UPS Ground Freight pricing](https://www.shipengine.com/docs/shipping/ups-ground-freight/). If enabled, then a `freight_class` must also be specified. | [optional] |
|
|
18
|
+
| **freight_class** | **String** | The National Motor Freight Traffic Association [freight class](http://www.nmfta.org/pages/nmfc?AspxAutoDetectCookieSupport=1), such as \"77.5\", \"110\", or \"250\". | [optional] [default to 'null'] |
|
|
19
|
+
| **custom_field1** | **String** | An arbitrary field that can be used to store information about the shipment. | [optional] [default to 'null'] |
|
|
20
|
+
| **custom_field2** | **String** | An arbitrary field that can be used to store information about the shipment. | [optional] [default to 'null'] |
|
|
21
|
+
| **custom_field3** | **String** | An arbitrary field that can be used to store information about the shipment. | [optional] [default to 'null'] |
|
|
22
|
+
| **collect_on_delivery** | [**CollectOnDelivery**](CollectOnDelivery.md) | | [optional] |
|
|
23
23
|
|
|
24
24
|
## Code Sample
|
|
25
25
|
|
|
26
26
|
```ruby
|
|
27
27
|
require 'OpenapiClient'
|
|
28
28
|
|
|
29
|
-
instance =
|
|
29
|
+
instance = ShipEngine::AdvancedShipmentOptions.new(bill_to_account: null,
|
|
30
30
|
bill_to_country_code: null,
|
|
31
31
|
bill_to_party: null,
|
|
32
32
|
bill_to_postal_code: null,
|
|
@@ -43,5 +43,3 @@ instance = OpenapiClient::AdvancedShipmentOptions.new(bill_to_account: null,
|
|
|
43
43
|
custom_field3: null,
|
|
44
44
|
collect_on_delivery: null)
|
|
45
45
|
```
|
|
46
|
-
|
|
47
|
-
|
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::AncillaryServiceEndorsement
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
7
8
|
|
|
8
9
|
## Code Sample
|
|
9
10
|
|
|
10
11
|
```ruby
|
|
11
12
|
require 'OpenapiClient'
|
|
12
13
|
|
|
13
|
-
instance =
|
|
14
|
+
instance = ShipEngine::AncillaryServiceEndorsement.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/Batch.md
CHANGED
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::Batch
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**label_layout**
|
|
8
|
-
**label_format**
|
|
9
|
-
**batch_id**
|
|
10
|
-
**external_batch_id**
|
|
11
|
-
**batch_notes**
|
|
12
|
-
**created_at**
|
|
13
|
-
**processed_at**
|
|
14
|
-
**errors**
|
|
15
|
-
**warnings**
|
|
16
|
-
**completed**
|
|
17
|
-
**forms**
|
|
18
|
-
**count**
|
|
19
|
-
**batch_shipments_url** | [**OptionalLink**](OptionalLink.md)
|
|
20
|
-
**batch_labels_url**
|
|
21
|
-
**batch_errors_url**
|
|
22
|
-
**label_download**
|
|
23
|
-
**form_download**
|
|
24
|
-
**status**
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ----------------------- | ------------------------------------- | --------------------------------------------------------------- | ---------------------------------- |
|
|
7
|
+
| **label_layout** | [**LabelLayout**](LabelLayout.md) | label layout | [readonly] |
|
|
8
|
+
| **label_format** | [**LabelFormat**](LabelFormat.md) | | [readonly] |
|
|
9
|
+
| **batch_id** | **String** | A string that uniquely identifies the batch | [readonly] |
|
|
10
|
+
| **external_batch_id** | **String** | A string that uniquely identifies the external batch | [readonly] |
|
|
11
|
+
| **batch_notes** | **String** | Custom notes you can add for each created batch | [readonly] [default to ''] |
|
|
12
|
+
| **created_at** | **DateTime** | The date and time the batch was created in ShipEngine | [readonly] |
|
|
13
|
+
| **processed_at** | **DateTime** | The date and time the batch was processed in ShipEngine | [readonly] |
|
|
14
|
+
| **errors** | **Integer** | The number of errors that occurred while generating the batch | [readonly] |
|
|
15
|
+
| **warnings** | **Integer** | The number of warnings that occurred while generating the batch | [readonly] |
|
|
16
|
+
| **completed** | **Integer** | The number of labels generated in the batch | [readonly] |
|
|
17
|
+
| **forms** | **Integer** | The number of forms for customs that are available for download | [readonly] |
|
|
18
|
+
| **count** | **Integer** | The total of errors, warnings, and completed properties | [readonly] |
|
|
19
|
+
| **batch_shipments_url** | [**OptionalLink**](OptionalLink.md) | The batch shipments endpoint |
|
|
20
|
+
| **batch_labels_url** | [**OptionalLink**](OptionalLink.md) | Link to batch labels query |
|
|
21
|
+
| **batch_errors_url** | [**OptionalLink**](OptionalLink.md) | Link to batch errors endpoint | [readonly] |
|
|
22
|
+
| **label_download** | [**LabelDownload**](LabelDownload.md) | The label download for the batch | [readonly] |
|
|
23
|
+
| **form_download** | [**OptionalLink**](OptionalLink.md) | The form download for any customs that are needed | [readonly] |
|
|
24
|
+
| **status** | [**BatchStatus**](BatchStatus.md) | | [readonly] |
|
|
25
25
|
|
|
26
26
|
## Code Sample
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
29
|
require 'OpenapiClient'
|
|
30
30
|
|
|
31
|
-
instance =
|
|
31
|
+
instance = ShipEngine::Batch.new(label_layout: null,
|
|
32
32
|
label_format: null,
|
|
33
33
|
batch_id: null,
|
|
34
34
|
external_batch_id: null,
|
|
@@ -47,5 +47,3 @@ instance = OpenapiClient::Batch.new(label_layout: null,
|
|
|
47
47
|
form_download: null,
|
|
48
48
|
status: null)
|
|
49
49
|
```
|
|
50
|
-
|
|
51
|
-
|
data/docs/BatchResponseError.md
CHANGED
|
@@ -1,19 +1,17 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::BatchResponseError
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name
|
|
6
|
-
|
|
7
|
-
**error**
|
|
8
|
-
**shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly]
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| --------------- | ---------- | ---------------------------------------------- | --------------------- |
|
|
7
|
+
| **error** | **String** | Error message associated with the shipment. | [optional] [readonly] |
|
|
8
|
+
| **shipment_id** | **String** | A string that uniquely identifies the shipment | [optional] [readonly] |
|
|
9
9
|
|
|
10
10
|
## Code Sample
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'OpenapiClient'
|
|
14
14
|
|
|
15
|
-
instance =
|
|
15
|
+
instance = ShipEngine::BatchResponseError.new(error: Recipient address has not been verified.,
|
|
16
16
|
shipment_id: null)
|
|
17
17
|
```
|
|
18
|
-
|
|
19
|
-
|
data/docs/BatchStatus.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::BatchStatus
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
Name | Type | Description | Notes
|
|
6
|
-
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
7
8
|
|
|
8
9
|
## Code Sample
|
|
9
10
|
|
|
10
11
|
```ruby
|
|
11
12
|
require 'OpenapiClient'
|
|
12
13
|
|
|
13
|
-
instance =
|
|
14
|
+
instance = ShipEngine::BatchStatus.new()
|
|
14
15
|
```
|
|
15
|
-
|
|
16
|
-
|
data/docs/BatchesApi.md
CHANGED
|
@@ -1,21 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ShipEngine::BatchesApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.shipengine.com*
|
|
4
4
|
|
|
5
|
-
Method
|
|
6
|
-
|
|
7
|
-
[**add_to_batch**](BatchesApi.md#add_to_batch)
|
|
8
|
-
[**create_batch**](BatchesApi.md#create_batch)
|
|
9
|
-
[**delete_batch**](BatchesApi.md#delete_batch)
|
|
10
|
-
[**get_batch_by_external_id**](BatchesApi.md#get_batch_by_external_id) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID
|
|
11
|
-
[**get_batch_by_id**](BatchesApi.md#get_batch_by_id)
|
|
12
|
-
[**list_batch_errors**](BatchesApi.md#list_batch_errors)
|
|
13
|
-
[**list_batches**](BatchesApi.md#list_batches)
|
|
14
|
-
[**process_batch**](BatchesApi.md#process_batch)
|
|
15
|
-
[**remove_from_batch**](BatchesApi.md#remove_from_batch)
|
|
16
|
-
[**update_batch**](BatchesApi.md#update_batch)
|
|
17
|
-
|
|
18
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ---------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------ |
|
|
7
|
+
| [**add_to_batch**](BatchesApi.md#add_to_batch) | **POST** /v1/batches/{batch_id}/add | Add to a Batch |
|
|
8
|
+
| [**create_batch**](BatchesApi.md#create_batch) | **POST** /v1/batches | Create A Batch |
|
|
9
|
+
| [**delete_batch**](BatchesApi.md#delete_batch) | **DELETE** /v1/batches/{batch_id} | Delete Batch By Id |
|
|
10
|
+
| [**get_batch_by_external_id**](BatchesApi.md#get_batch_by_external_id) | **GET** /v1/batches/external_batch_id/{external_batch_id} | Get Batch By External ID |
|
|
11
|
+
| [**get_batch_by_id**](BatchesApi.md#get_batch_by_id) | **GET** /v1/batches/{batch_id} | Get Batch By ID |
|
|
12
|
+
| [**list_batch_errors**](BatchesApi.md#list_batch_errors) | **GET** /v1/batches/{batch_id}/errors | Get Batch Errors |
|
|
13
|
+
| [**list_batches**](BatchesApi.md#list_batches) | **GET** /v1/batches | List Batches |
|
|
14
|
+
| [**process_batch**](BatchesApi.md#process_batch) | **POST** /v1/batches/{batch_id}/process/labels | Process Batch ID Labels |
|
|
15
|
+
| [**remove_from_batch**](BatchesApi.md#remove_from_batch) | **POST** /v1/batches/{batch_id}/remove | Remove From Batch |
|
|
16
|
+
| [**update_batch**](BatchesApi.md#update_batch) | **PUT** /v1/batches/{batch_id} | Update Batch By Id |
|
|
19
17
|
|
|
20
18
|
## add_to_batch
|
|
21
19
|
|
|
@@ -38,26 +36,25 @@ OpenapiClient.configure do |config|
|
|
|
38
36
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
39
37
|
end
|
|
40
38
|
|
|
41
|
-
api_instance =
|
|
39
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
42
40
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
43
|
-
add_to_batch_request_body =
|
|
41
|
+
add_to_batch_request_body = ShipEngine::AddToBatchRequestBody.new # AddToBatchRequestBody |
|
|
44
42
|
|
|
45
43
|
begin
|
|
46
44
|
#Add to a Batch
|
|
47
45
|
result = api_instance.add_to_batch(batch_id, add_to_batch_request_body)
|
|
48
46
|
p result
|
|
49
|
-
rescue
|
|
47
|
+
rescue ShipEngine::ApiError => e
|
|
50
48
|
puts "Exception when calling BatchesApi->add_to_batch: #{e}"
|
|
51
49
|
end
|
|
52
50
|
```
|
|
53
51
|
|
|
54
52
|
### Parameters
|
|
55
53
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
**
|
|
60
|
-
**add_to_batch_request_body** | [**AddToBatchRequestBody**](AddToBatchRequestBody.md)| |
|
|
54
|
+
| Name | Type | Description | Notes |
|
|
55
|
+
| ----------------------------- | ----------------------------------------------------- | ----------- | ----- |
|
|
56
|
+
| **batch_id** | **String** | Batch ID |
|
|
57
|
+
| **add_to_batch_request_body** | [**AddToBatchRequestBody**](AddToBatchRequestBody.md) | |
|
|
61
58
|
|
|
62
59
|
### Return type
|
|
63
60
|
|
|
@@ -72,7 +69,6 @@ Name | Type | Description | Notes
|
|
|
72
69
|
- **Content-Type**: application/json
|
|
73
70
|
- **Accept**: text/plain, application/json
|
|
74
71
|
|
|
75
|
-
|
|
76
72
|
## create_batch
|
|
77
73
|
|
|
78
74
|
> CreateBatchResponseBody create_batch(create_batch_request_body)
|
|
@@ -94,24 +90,23 @@ OpenapiClient.configure do |config|
|
|
|
94
90
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
95
91
|
end
|
|
96
92
|
|
|
97
|
-
api_instance =
|
|
98
|
-
create_batch_request_body =
|
|
93
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
94
|
+
create_batch_request_body = ShipEngine::CreateBatchRequestBody.new # CreateBatchRequestBody |
|
|
99
95
|
|
|
100
96
|
begin
|
|
101
97
|
#Create A Batch
|
|
102
98
|
result = api_instance.create_batch(create_batch_request_body)
|
|
103
99
|
p result
|
|
104
|
-
rescue
|
|
100
|
+
rescue ShipEngine::ApiError => e
|
|
105
101
|
puts "Exception when calling BatchesApi->create_batch: #{e}"
|
|
106
102
|
end
|
|
107
103
|
```
|
|
108
104
|
|
|
109
105
|
### Parameters
|
|
110
106
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
**create_batch_request_body** | [**CreateBatchRequestBody**](CreateBatchRequestBody.md)| |
|
|
107
|
+
| Name | Type | Description | Notes |
|
|
108
|
+
| ----------------------------- | ------------------------------------------------------- | ----------- | ----- |
|
|
109
|
+
| **create_batch_request_body** | [**CreateBatchRequestBody**](CreateBatchRequestBody.md) | |
|
|
115
110
|
|
|
116
111
|
### Return type
|
|
117
112
|
|
|
@@ -126,7 +121,6 @@ Name | Type | Description | Notes
|
|
|
126
121
|
- **Content-Type**: application/json
|
|
127
122
|
- **Accept**: application/json
|
|
128
123
|
|
|
129
|
-
|
|
130
124
|
## delete_batch
|
|
131
125
|
|
|
132
126
|
> String delete_batch(batch_id)
|
|
@@ -148,24 +142,23 @@ OpenapiClient.configure do |config|
|
|
|
148
142
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
149
143
|
end
|
|
150
144
|
|
|
151
|
-
api_instance =
|
|
145
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
152
146
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
153
147
|
|
|
154
148
|
begin
|
|
155
149
|
#Delete Batch By Id
|
|
156
150
|
result = api_instance.delete_batch(batch_id)
|
|
157
151
|
p result
|
|
158
|
-
rescue
|
|
152
|
+
rescue ShipEngine::ApiError => e
|
|
159
153
|
puts "Exception when calling BatchesApi->delete_batch: #{e}"
|
|
160
154
|
end
|
|
161
155
|
```
|
|
162
156
|
|
|
163
157
|
### Parameters
|
|
164
158
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
**batch_id** | **String**| Batch ID |
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
| ------------ | ---------- | ----------- | ----- |
|
|
161
|
+
| **batch_id** | **String** | Batch ID |
|
|
169
162
|
|
|
170
163
|
### Return type
|
|
171
164
|
|
|
@@ -180,7 +173,6 @@ Name | Type | Description | Notes
|
|
|
180
173
|
- **Content-Type**: Not defined
|
|
181
174
|
- **Accept**: text/plain, application/json
|
|
182
175
|
|
|
183
|
-
|
|
184
176
|
## get_batch_by_external_id
|
|
185
177
|
|
|
186
178
|
> GetBatchByExternalIdResponseBody get_batch_by_external_id(external_batch_id)
|
|
@@ -202,24 +194,23 @@ OpenapiClient.configure do |config|
|
|
|
202
194
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
203
195
|
end
|
|
204
196
|
|
|
205
|
-
api_instance =
|
|
206
|
-
external_batch_id = '13553d7f-3c87-4771-bae1-c49bacef11cb' # String |
|
|
197
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
198
|
+
external_batch_id = '13553d7f-3c87-4771-bae1-c49bacef11cb' # String |
|
|
207
199
|
|
|
208
200
|
begin
|
|
209
201
|
#Get Batch By External ID
|
|
210
202
|
result = api_instance.get_batch_by_external_id(external_batch_id)
|
|
211
203
|
p result
|
|
212
|
-
rescue
|
|
204
|
+
rescue ShipEngine::ApiError => e
|
|
213
205
|
puts "Exception when calling BatchesApi->get_batch_by_external_id: #{e}"
|
|
214
206
|
end
|
|
215
207
|
```
|
|
216
208
|
|
|
217
209
|
### Parameters
|
|
218
210
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
**external_batch_id** | **String**| |
|
|
211
|
+
| Name | Type | Description | Notes |
|
|
212
|
+
| --------------------- | ---------- | ----------- | ----- |
|
|
213
|
+
| **external_batch_id** | **String** | |
|
|
223
214
|
|
|
224
215
|
### Return type
|
|
225
216
|
|
|
@@ -234,7 +225,6 @@ Name | Type | Description | Notes
|
|
|
234
225
|
- **Content-Type**: Not defined
|
|
235
226
|
- **Accept**: application/json
|
|
236
227
|
|
|
237
|
-
|
|
238
228
|
## get_batch_by_id
|
|
239
229
|
|
|
240
230
|
> GetBatchByIdResponseBody get_batch_by_id(batch_id)
|
|
@@ -256,24 +246,23 @@ OpenapiClient.configure do |config|
|
|
|
256
246
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
257
247
|
end
|
|
258
248
|
|
|
259
|
-
api_instance =
|
|
249
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
260
250
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
261
251
|
|
|
262
252
|
begin
|
|
263
253
|
#Get Batch By ID
|
|
264
254
|
result = api_instance.get_batch_by_id(batch_id)
|
|
265
255
|
p result
|
|
266
|
-
rescue
|
|
256
|
+
rescue ShipEngine::ApiError => e
|
|
267
257
|
puts "Exception when calling BatchesApi->get_batch_by_id: #{e}"
|
|
268
258
|
end
|
|
269
259
|
```
|
|
270
260
|
|
|
271
261
|
### Parameters
|
|
272
262
|
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
**batch_id** | **String**| Batch ID |
|
|
263
|
+
| Name | Type | Description | Notes |
|
|
264
|
+
| ------------ | ---------- | ----------- | ----- |
|
|
265
|
+
| **batch_id** | **String** | Batch ID |
|
|
277
266
|
|
|
278
267
|
### Return type
|
|
279
268
|
|
|
@@ -288,14 +277,13 @@ Name | Type | Description | Notes
|
|
|
288
277
|
- **Content-Type**: Not defined
|
|
289
278
|
- **Accept**: application/json
|
|
290
279
|
|
|
291
|
-
|
|
292
280
|
## list_batch_errors
|
|
293
281
|
|
|
294
282
|
> ListBatchErrorsResponseBody list_batch_errors(batch_id, opts)
|
|
295
283
|
|
|
296
284
|
Get Batch Errors
|
|
297
285
|
|
|
298
|
-
Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
286
|
+
Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by [getting a batch](https://www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.
|
|
299
287
|
|
|
300
288
|
### Example
|
|
301
289
|
|
|
@@ -310,30 +298,29 @@ OpenapiClient.configure do |config|
|
|
|
310
298
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
311
299
|
end
|
|
312
300
|
|
|
313
|
-
api_instance =
|
|
301
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
314
302
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
315
303
|
opts = {
|
|
316
|
-
page: 1, # Integer | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
317
|
-
pagesize: 56 # Integer |
|
|
304
|
+
page: 1, # Integer | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
305
|
+
pagesize: 56 # Integer |
|
|
318
306
|
}
|
|
319
307
|
|
|
320
308
|
begin
|
|
321
309
|
#Get Batch Errors
|
|
322
310
|
result = api_instance.list_batch_errors(batch_id, opts)
|
|
323
311
|
p result
|
|
324
|
-
rescue
|
|
312
|
+
rescue ShipEngine::ApiError => e
|
|
325
313
|
puts "Exception when calling BatchesApi->list_batch_errors: #{e}"
|
|
326
314
|
end
|
|
327
315
|
```
|
|
328
316
|
|
|
329
317
|
### Parameters
|
|
330
318
|
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
**
|
|
335
|
-
**
|
|
336
|
-
**pagesize** | **Integer**| | [optional]
|
|
319
|
+
| Name | Type | Description | Notes |
|
|
320
|
+
| ------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
|
|
321
|
+
| **batch_id** | **String** | Batch ID |
|
|
322
|
+
| **page** | **Integer** | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. | [optional] [default to 1] |
|
|
323
|
+
| **pagesize** | **Integer** | | [optional] |
|
|
337
324
|
|
|
338
325
|
### Return type
|
|
339
326
|
|
|
@@ -348,7 +335,6 @@ Name | Type | Description | Notes
|
|
|
348
335
|
- **Content-Type**: Not defined
|
|
349
336
|
- **Accept**: application/json
|
|
350
337
|
|
|
351
|
-
|
|
352
338
|
## list_batches
|
|
353
339
|
|
|
354
340
|
> ListBatchesResponseBody list_batches(opts)
|
|
@@ -370,34 +356,33 @@ OpenapiClient.configure do |config|
|
|
|
370
356
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
371
357
|
end
|
|
372
358
|
|
|
373
|
-
api_instance =
|
|
359
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
374
360
|
opts = {
|
|
375
|
-
status:
|
|
376
|
-
page: 1, # Integer | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
361
|
+
status: ShipEngine::BatchStatus.new, # BatchStatus |
|
|
362
|
+
page: 1, # Integer | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
|
|
377
363
|
page_size: 25, # Integer | The number of results to return per response.
|
|
378
|
-
sort_dir:
|
|
379
|
-
sort_by:
|
|
364
|
+
sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
|
|
365
|
+
sort_by: ShipEngine::BatchesSortBy.new # BatchesSortBy |
|
|
380
366
|
}
|
|
381
367
|
|
|
382
368
|
begin
|
|
383
369
|
#List Batches
|
|
384
370
|
result = api_instance.list_batches(opts)
|
|
385
371
|
p result
|
|
386
|
-
rescue
|
|
372
|
+
rescue ShipEngine::ApiError => e
|
|
387
373
|
puts "Exception when calling BatchesApi->list_batches: #{e}"
|
|
388
374
|
end
|
|
389
375
|
```
|
|
390
376
|
|
|
391
377
|
### Parameters
|
|
392
378
|
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
**
|
|
397
|
-
**
|
|
398
|
-
**
|
|
399
|
-
**
|
|
400
|
-
**sort_by** | [**BatchesSortBy**](.md)| | [optional]
|
|
379
|
+
| Name | Type | Description | Notes |
|
|
380
|
+
| ------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
|
381
|
+
| **status** | [**BatchStatus**](.md) | | [optional] |
|
|
382
|
+
| **page** | **Integer** | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. | [optional] [default to 1] |
|
|
383
|
+
| **page_size** | **Integer** | The number of results to return per response. | [optional] [default to 25] |
|
|
384
|
+
| **sort_dir** | [**SortDir**](.md) | Controls the sort order of the query. | [optional] |
|
|
385
|
+
| **sort_by** | [**BatchesSortBy**](.md) | | [optional] |
|
|
401
386
|
|
|
402
387
|
### Return type
|
|
403
388
|
|
|
@@ -412,7 +397,6 @@ Name | Type | Description | Notes
|
|
|
412
397
|
- **Content-Type**: Not defined
|
|
413
398
|
- **Accept**: application/json
|
|
414
399
|
|
|
415
|
-
|
|
416
400
|
## process_batch
|
|
417
401
|
|
|
418
402
|
> String process_batch(batch_id, process_batch_request_body)
|
|
@@ -434,26 +418,25 @@ OpenapiClient.configure do |config|
|
|
|
434
418
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
435
419
|
end
|
|
436
420
|
|
|
437
|
-
api_instance =
|
|
421
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
438
422
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
439
|
-
process_batch_request_body =
|
|
423
|
+
process_batch_request_body = ShipEngine::ProcessBatchRequestBody.new # ProcessBatchRequestBody |
|
|
440
424
|
|
|
441
425
|
begin
|
|
442
426
|
#Process Batch ID Labels
|
|
443
427
|
result = api_instance.process_batch(batch_id, process_batch_request_body)
|
|
444
428
|
p result
|
|
445
|
-
rescue
|
|
429
|
+
rescue ShipEngine::ApiError => e
|
|
446
430
|
puts "Exception when calling BatchesApi->process_batch: #{e}"
|
|
447
431
|
end
|
|
448
432
|
```
|
|
449
433
|
|
|
450
434
|
### Parameters
|
|
451
435
|
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
**
|
|
456
|
-
**process_batch_request_body** | [**ProcessBatchRequestBody**](ProcessBatchRequestBody.md)| |
|
|
436
|
+
| Name | Type | Description | Notes |
|
|
437
|
+
| ------------------------------ | --------------------------------------------------------- | ----------- | ----- |
|
|
438
|
+
| **batch_id** | **String** | Batch ID |
|
|
439
|
+
| **process_batch_request_body** | [**ProcessBatchRequestBody**](ProcessBatchRequestBody.md) | |
|
|
457
440
|
|
|
458
441
|
### Return type
|
|
459
442
|
|
|
@@ -468,7 +451,6 @@ Name | Type | Description | Notes
|
|
|
468
451
|
- **Content-Type**: application/json
|
|
469
452
|
- **Accept**: text/plain, application/json
|
|
470
453
|
|
|
471
|
-
|
|
472
454
|
## remove_from_batch
|
|
473
455
|
|
|
474
456
|
> String remove_from_batch(batch_id, remove_from_batch_request_body)
|
|
@@ -490,26 +472,25 @@ OpenapiClient.configure do |config|
|
|
|
490
472
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
491
473
|
end
|
|
492
474
|
|
|
493
|
-
api_instance =
|
|
475
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
494
476
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
495
|
-
remove_from_batch_request_body =
|
|
477
|
+
remove_from_batch_request_body = ShipEngine::RemoveFromBatchRequestBody.new # RemoveFromBatchRequestBody |
|
|
496
478
|
|
|
497
479
|
begin
|
|
498
480
|
#Remove From Batch
|
|
499
481
|
result = api_instance.remove_from_batch(batch_id, remove_from_batch_request_body)
|
|
500
482
|
p result
|
|
501
|
-
rescue
|
|
483
|
+
rescue ShipEngine::ApiError => e
|
|
502
484
|
puts "Exception when calling BatchesApi->remove_from_batch: #{e}"
|
|
503
485
|
end
|
|
504
486
|
```
|
|
505
487
|
|
|
506
488
|
### Parameters
|
|
507
489
|
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
**
|
|
512
|
-
**remove_from_batch_request_body** | [**RemoveFromBatchRequestBody**](RemoveFromBatchRequestBody.md)| |
|
|
490
|
+
| Name | Type | Description | Notes |
|
|
491
|
+
| ---------------------------------- | --------------------------------------------------------------- | ----------- | ----- |
|
|
492
|
+
| **batch_id** | **String** | Batch ID |
|
|
493
|
+
| **remove_from_batch_request_body** | [**RemoveFromBatchRequestBody**](RemoveFromBatchRequestBody.md) | |
|
|
513
494
|
|
|
514
495
|
### Return type
|
|
515
496
|
|
|
@@ -524,7 +505,6 @@ Name | Type | Description | Notes
|
|
|
524
505
|
- **Content-Type**: application/json
|
|
525
506
|
- **Accept**: text/plain, application/json
|
|
526
507
|
|
|
527
|
-
|
|
528
508
|
## update_batch
|
|
529
509
|
|
|
530
510
|
> String update_batch(batch_id)
|
|
@@ -546,24 +526,23 @@ OpenapiClient.configure do |config|
|
|
|
546
526
|
#config.api_key_prefix['API-Key'] = 'Bearer'
|
|
547
527
|
end
|
|
548
528
|
|
|
549
|
-
api_instance =
|
|
529
|
+
api_instance = ShipEngine::BatchesApi.new
|
|
550
530
|
batch_id = 'batch_id_example' # String | Batch ID
|
|
551
531
|
|
|
552
532
|
begin
|
|
553
533
|
#Update Batch By Id
|
|
554
534
|
result = api_instance.update_batch(batch_id)
|
|
555
535
|
p result
|
|
556
|
-
rescue
|
|
536
|
+
rescue ShipEngine::ApiError => e
|
|
557
537
|
puts "Exception when calling BatchesApi->update_batch: #{e}"
|
|
558
538
|
end
|
|
559
539
|
```
|
|
560
540
|
|
|
561
541
|
### Parameters
|
|
562
542
|
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
**batch_id** | **String**| Batch ID |
|
|
543
|
+
| Name | Type | Description | Notes |
|
|
544
|
+
| ------------ | ---------- | ----------- | ----- |
|
|
545
|
+
| **batch_id** | **String** | Batch ID |
|
|
567
546
|
|
|
568
547
|
### Return type
|
|
569
548
|
|
|
@@ -577,4 +556,3 @@ Name | Type | Description | Notes
|
|
|
577
556
|
|
|
578
557
|
- **Content-Type**: Not defined
|
|
579
558
|
- **Accept**: text/plain, application/json
|
|
580
|
-
|