ship_engine 1.0.4 → 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/BatchesApi.md +12 -12
- data/docs/CarrierAccountsApi.md +8 -8
- data/docs/CarriersApi.md +4 -4
- data/docs/LabelsApi.md +12 -12
- data/docs/PackageTypesApi.md +4 -4
- data/docs/ShipmentsApi.md +4 -4
- data/docs/WarehousesApi.md +4 -4
- data/docs/WebhooksApi.md +4 -4
- data/lib/ship_engine/api/batches_api.rb +27 -27
- data/lib/ship_engine/api/carrier_accounts_api.rb +18 -18
- data/lib/ship_engine/api/carriers_api.rb +9 -9
- data/lib/ship_engine/api/labels_api.rb +27 -27
- data/lib/ship_engine/api/package_types_api.rb +9 -9
- data/lib/ship_engine/api/shipments_api.rb +9 -9
- data/lib/ship_engine/api/warehouses_api.rb +9 -9
- data/lib/ship_engine/api/webhooks_api.rb +9 -9
- data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +3 -5
- data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +3 -5
- data/lib/ship_engine/models/add_to_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/address.rb +4 -6
- data/lib/ship_engine/models/address_to_validate.rb +4 -6
- data/lib/ship_engine/models/address_validating_shipment.rb +14 -16
- data/lib/ship_engine/models/address_validation_result.rb +3 -5
- data/lib/ship_engine/models/advanced_shipment_options.rb +14 -16
- data/lib/ship_engine/models/batch.rb +4 -6
- data/lib/ship_engine/models/batch_response_error.rb +3 -5
- data/lib/ship_engine/models/bulk_rate.rb +3 -5
- data/lib/ship_engine/models/calculate_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/calculate_rates_response_body.rb +14 -16
- data/lib/ship_engine/models/carrier.rb +4 -6
- data/lib/ship_engine/models/carrier_advanced_option.rb +3 -5
- data/lib/ship_engine/models/collect_on_delivery.rb +3 -5
- data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_apc_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_asendia_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_australia_post_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_canada_post_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_carrier_request_body.rb +4 -6
- data/lib/ship_engine/models/connect_carrier_response_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +5 -7
- data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_dpd_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_endicia_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_fedex_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_firstmile_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_globegistics_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_imex_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_insurer_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_newgistics_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_ontrac_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_purolator_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_royal_mail_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_seko_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_sendle_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_stamps_request_body.rb +3 -5
- data/lib/ship_engine/models/connect_ups_request_body.rb +3 -5
- data/lib/ship_engine/models/create_and_validate_shipment.rb +14 -16
- data/lib/ship_engine/models/create_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/create_batch_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_rate_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_rate_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/create_label_request_body.rb +3 -5
- data/lib/ship_engine/models/create_label_response_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_request_body.rb +3 -5
- data/lib/ship_engine/models/create_manifest_response_body.rb +3 -5
- data/lib/ship_engine/models/create_package_type_request_body.rb +3 -5
- data/lib/ship_engine/models/create_package_type_response_body.rb +3 -5
- data/lib/ship_engine/models/create_return_label_request_body.rb +6 -8
- data/lib/ship_engine/models/create_return_label_response_body.rb +3 -5
- data/lib/ship_engine/models/create_shipment_response_body_fields.rb +3 -5
- data/lib/ship_engine/models/create_shipments_request_body.rb +3 -5
- data/lib/ship_engine/models/create_shipments_response_body.rb +3 -5
- data/lib/ship_engine/models/create_tag_response_body.rb +3 -5
- data/lib/ship_engine/models/create_warehouse_request_body.rb +3 -5
- data/lib/ship_engine/models/create_warehouse_response_body.rb +3 -5
- data/lib/ship_engine/models/create_webhook_request_body.rb +3 -5
- data/lib/ship_engine/models/create_webhook_response_body.rb +3 -5
- data/lib/ship_engine/models/customs_item.rb +4 -6
- data/lib/ship_engine/models/deprecated_manifest.rb +3 -5
- data/lib/ship_engine/models/dhl_express_account_settings.rb +3 -5
- data/lib/ship_engine/models/dhl_express_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/dimensions.rb +3 -5
- data/lib/ship_engine/models/error.rb +4 -6
- data/lib/ship_engine/models/error_response_body.rb +4 -6
- data/lib/ship_engine/models/estimate_rates_request_body.rb +3 -5
- data/lib/ship_engine/models/fedex_account_settings.rb +3 -5
- data/lib/ship_engine/models/fedex_account_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/fedex_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_batch_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_options_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carrier_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/get_carriers_response_body.rb +4 -6
- data/lib/ship_engine/models/get_insurance_balance_response_body.rb +3 -5
- data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_label_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_rate_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +3 -5
- data/lib/ship_engine/models/get_tracking_log_response_body.rb +3 -5
- data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +3 -5
- data/lib/ship_engine/models/international_shipment_options.rb +3 -5
- data/lib/ship_engine/models/label.rb +27 -29
- data/lib/ship_engine/models/label_download.rb +4 -6
- data/lib/ship_engine/models/label_messages.rb +7 -9
- data/lib/ship_engine/models/link.rb +3 -5
- data/lib/ship_engine/models/list_batch_errors_response_body.rb +3 -5
- data/lib/ship_engine/models/list_batches_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carrier_services_response_body.rb +3 -5
- data/lib/ship_engine/models/list_carriers_response_body.rb +3 -5
- data/lib/ship_engine/models/list_labels_response_body.rb +4 -6
- data/lib/ship_engine/models/list_manifests_response_body.rb +3 -5
- data/lib/ship_engine/models/list_package_types_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipment_errors_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipment_rates_response_body.rb +3 -5
- data/lib/ship_engine/models/list_shipments_response_body.rb +3 -5
- data/lib/ship_engine/models/list_tags_response_body.rb +3 -5
- data/lib/ship_engine/models/list_warehouses_response_body.rb +3 -5
- data/lib/ship_engine/models/manifest.rb +4 -6
- data/lib/ship_engine/models/manifest_download.rb +3 -5
- data/lib/ship_engine/models/manifests.rb +3 -5
- data/lib/ship_engine/models/modify_batch.rb +3 -5
- data/lib/ship_engine/models/monetary_value.rb +4 -6
- data/lib/ship_engine/models/optional_link.rb +3 -5
- data/lib/ship_engine/models/package.rb +6 -8
- data/lib/ship_engine/models/package_type.rb +3 -5
- data/lib/ship_engine/models/paged_list_response_body.rb +4 -6
- data/lib/ship_engine/models/pagination_link.rb +7 -9
- data/lib/ship_engine/models/parse_address_request_body.rb +5 -7
- data/lib/ship_engine/models/parse_address_response_body.rb +7 -9
- data/lib/ship_engine/models/parse_shipment_request_body.rb +5 -7
- data/lib/ship_engine/models/parse_shipment_response_body.rb +7 -9
- data/lib/ship_engine/models/partial_address.rb +11 -13
- data/lib/ship_engine/models/partial_shipment.rb +15 -17
- data/lib/ship_engine/models/payment_amount.rb +3 -5
- data/lib/ship_engine/models/process_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/purchase_label_without_shipment.rb +3 -5
- data/lib/ship_engine/models/rate.rb +5 -7
- data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +3 -5
- data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +3 -5
- data/lib/ship_engine/models/rate_estimate_options.rb +3 -5
- data/lib/ship_engine/models/rate_request_body.rb +3 -5
- data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +3 -5
- data/lib/ship_engine/models/rate_request_by_shipments.rb +3 -5
- data/lib/ship_engine/models/rate_request_options.rb +3 -5
- data/lib/ship_engine/models/rate_request_rate_options.rb +3 -5
- data/lib/ship_engine/models/rate_response.rb +3 -5
- data/lib/ship_engine/models/rates_information.rb +3 -5
- data/lib/ship_engine/models/recognized_entity.rb +6 -8
- data/lib/ship_engine/models/remove_from_batch_request_body.rb +3 -5
- data/lib/ship_engine/models/response_message.rb +3 -5
- data/lib/ship_engine/models/service.rb +3 -5
- data/lib/ship_engine/models/shipment.rb +4 -6
- data/lib/ship_engine/models/shipment_id_request.rb +3 -5
- data/lib/ship_engine/models/shipment_item.rb +3 -5
- data/lib/ship_engine/models/shipment_request.rb +3 -5
- data/lib/ship_engine/models/shipment_response_error.rb +3 -5
- data/lib/ship_engine/models/tag.rb +4 -6
- data/lib/ship_engine/models/tag_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/track_event.rb +3 -5
- data/lib/ship_engine/models/tracking_information.rb +3 -5
- data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +3 -5
- data/lib/ship_engine/models/update_carrier_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_fedex_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_package_type_request_body.rb +3 -5
- data/lib/ship_engine/models/update_shipment_fields.rb +3 -5
- data/lib/ship_engine/models/update_shipment_request_body.rb +14 -16
- data/lib/ship_engine/models/update_shipment_response_body.rb +3 -5
- data/lib/ship_engine/models/update_ups_settings_request_body.rb +3 -5
- data/lib/ship_engine/models/update_warehouse_request_body.rb +3 -5
- data/lib/ship_engine/models/update_webhook_request_body.rb +3 -5
- data/lib/ship_engine/models/ups_account_settings.rb +3 -5
- data/lib/ship_engine/models/ups_invoice.rb +3 -5
- data/lib/ship_engine/models/ups_settings_response_body.rb +3 -5
- data/lib/ship_engine/models/validate_shipment_fields.rb +3 -5
- data/lib/ship_engine/models/void_label_response_body.rb +3 -5
- data/lib/ship_engine/models/warehouse.rb +3 -5
- data/lib/ship_engine/models/webhook.rb +3 -5
- data/lib/ship_engine/models/weight.rb +3 -5
- data/lib/ship_engine/version.rb +1 -1
- data/ship_engine-1.0.4.gem +0 -0
- data/ship_engine.gemspec +1 -1
- metadata +2 -1
@@ -21,33 +21,33 @@ module ShipEngine
|
|
21
21
|
end
|
22
22
|
# Connect a carrier account
|
23
23
|
# Connect a carrier account
|
24
|
-
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
25
24
|
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
25
|
+
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [ConnectCarrierResponseBody]
|
28
|
-
def connect_carrier(
|
29
|
-
data, _status_code, _headers = connect_carrier_with_http_info(
|
28
|
+
def connect_carrier(connect_carrier_request_body, carrier_name, opts = {})
|
29
|
+
data, _status_code, _headers = connect_carrier_with_http_info(connect_carrier_request_body, carrier_name, opts)
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
33
|
# Connect a carrier account
|
34
34
|
# Connect a carrier account
|
35
|
-
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
36
35
|
# @param connect_carrier_request_body [ConnectCarrierRequestBody]
|
36
|
+
# @param carrier_name [CarrierName] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(ConnectCarrierResponseBody, Integer, Hash)>] ConnectCarrierResponseBody data, response status code and response headers
|
39
|
-
def connect_carrier_with_http_info(
|
39
|
+
def connect_carrier_with_http_info(connect_carrier_request_body, carrier_name, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug 'Calling API: CarrierAccountsApi.connect_carrier ...'
|
42
42
|
end
|
43
|
-
# verify the required parameter 'carrier_name' is set
|
44
|
-
if @api_client.config.client_side_validation && carrier_name.nil?
|
45
|
-
fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.connect_carrier"
|
46
|
-
end
|
47
43
|
# verify the required parameter 'connect_carrier_request_body' is set
|
48
44
|
if @api_client.config.client_side_validation && connect_carrier_request_body.nil?
|
49
45
|
fail ArgumentError, "Missing the required parameter 'connect_carrier_request_body' when calling CarrierAccountsApi.connect_carrier"
|
50
46
|
end
|
47
|
+
# verify the required parameter 'carrier_name' is set
|
48
|
+
if @api_client.config.client_side_validation && carrier_name.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.connect_carrier"
|
50
|
+
end
|
51
51
|
# resource path
|
52
52
|
local_var_path = '/v1/connections/carriers/{carrier_name}'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s))
|
53
53
|
|
@@ -253,27 +253,31 @@ module ShipEngine
|
|
253
253
|
|
254
254
|
# Update carrier settings
|
255
255
|
# Update carrier settings
|
256
|
+
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
256
257
|
# @param carrier_name [CarrierNameWithSettings] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
257
258
|
# @param carrier_id [String] Carrier ID
|
258
|
-
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
259
259
|
# @param [Hash] opts the optional parameters
|
260
260
|
# @return [String]
|
261
|
-
def update_carrier_settings(carrier_name, carrier_id,
|
262
|
-
data, _status_code, _headers = update_carrier_settings_with_http_info(carrier_name, carrier_id,
|
261
|
+
def update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {})
|
262
|
+
data, _status_code, _headers = update_carrier_settings_with_http_info(update_carrier_settings_request_body, carrier_name, carrier_id, opts)
|
263
263
|
data
|
264
264
|
end
|
265
265
|
|
266
266
|
# Update carrier settings
|
267
267
|
# Update carrier settings
|
268
|
+
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
268
269
|
# @param carrier_name [CarrierNameWithSettings] The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
|
269
270
|
# @param carrier_id [String] Carrier ID
|
270
|
-
# @param update_carrier_settings_request_body [UpdateCarrierSettingsRequestBody]
|
271
271
|
# @param [Hash] opts the optional parameters
|
272
272
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
273
|
-
def update_carrier_settings_with_http_info(carrier_name, carrier_id,
|
273
|
+
def update_carrier_settings_with_http_info(update_carrier_settings_request_body, carrier_name, carrier_id, opts = {})
|
274
274
|
if @api_client.config.debugging
|
275
275
|
@api_client.config.logger.debug 'Calling API: CarrierAccountsApi.update_carrier_settings ...'
|
276
276
|
end
|
277
|
+
# verify the required parameter 'update_carrier_settings_request_body' is set
|
278
|
+
if @api_client.config.client_side_validation && update_carrier_settings_request_body.nil?
|
279
|
+
fail ArgumentError, "Missing the required parameter 'update_carrier_settings_request_body' when calling CarrierAccountsApi.update_carrier_settings"
|
280
|
+
end
|
277
281
|
# verify the required parameter 'carrier_name' is set
|
278
282
|
if @api_client.config.client_side_validation && carrier_name.nil?
|
279
283
|
fail ArgumentError, "Missing the required parameter 'carrier_name' when calling CarrierAccountsApi.update_carrier_settings"
|
@@ -295,10 +299,6 @@ module ShipEngine
|
|
295
299
|
fail ArgumentError, "invalid value for 'carrier_id' when calling CarrierAccountsApi.update_carrier_settings, must conform to the pattern #{pattern}."
|
296
300
|
end
|
297
301
|
|
298
|
-
# verify the required parameter 'update_carrier_settings_request_body' is set
|
299
|
-
if @api_client.config.client_side_validation && update_carrier_settings_request_body.nil?
|
300
|
-
fail ArgumentError, "Missing the required parameter 'update_carrier_settings_request_body' when calling CarrierAccountsApi.update_carrier_settings"
|
301
|
-
end
|
302
302
|
# resource path
|
303
303
|
local_var_path = '/v1/connections/carriers/{carrier_name}/{carrier_id}/settings'.sub('{' + 'carrier_name' + '}', CGI.escape(carrier_name.to_s)).sub('{' + 'carrier_id' + '}', CGI.escape(carrier_id.to_s))
|
304
304
|
|
@@ -21,25 +21,29 @@ module ShipEngine
|
|
21
21
|
end
|
22
22
|
# Add Funds To Carrier
|
23
23
|
# Add Funds To A Carrier
|
24
|
-
# @param carrier_id [String] Carrier ID
|
25
24
|
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
25
|
+
# @param carrier_id [String] Carrier ID
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
27
|
# @return [AddFundsToCarrierResponseBody]
|
28
|
-
def add_funds_to_carrier(
|
29
|
-
data, _status_code, _headers = add_funds_to_carrier_with_http_info(
|
28
|
+
def add_funds_to_carrier(add_funds_to_carrier_request_body, carrier_id, opts = {})
|
29
|
+
data, _status_code, _headers = add_funds_to_carrier_with_http_info(add_funds_to_carrier_request_body, carrier_id, opts)
|
30
30
|
data
|
31
31
|
end
|
32
32
|
|
33
33
|
# Add Funds To Carrier
|
34
34
|
# Add Funds To A Carrier
|
35
|
-
# @param carrier_id [String] Carrier ID
|
36
35
|
# @param add_funds_to_carrier_request_body [AddFundsToCarrierRequestBody]
|
36
|
+
# @param carrier_id [String] Carrier ID
|
37
37
|
# @param [Hash] opts the optional parameters
|
38
38
|
# @return [Array<(AddFundsToCarrierResponseBody, Integer, Hash)>] AddFundsToCarrierResponseBody data, response status code and response headers
|
39
|
-
def add_funds_to_carrier_with_http_info(
|
39
|
+
def add_funds_to_carrier_with_http_info(add_funds_to_carrier_request_body, carrier_id, opts = {})
|
40
40
|
if @api_client.config.debugging
|
41
41
|
@api_client.config.logger.debug 'Calling API: CarriersApi.add_funds_to_carrier ...'
|
42
42
|
end
|
43
|
+
# verify the required parameter 'add_funds_to_carrier_request_body' is set
|
44
|
+
if @api_client.config.client_side_validation && add_funds_to_carrier_request_body.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'add_funds_to_carrier_request_body' when calling CarriersApi.add_funds_to_carrier"
|
46
|
+
end
|
43
47
|
# verify the required parameter 'carrier_id' is set
|
44
48
|
if @api_client.config.client_side_validation && carrier_id.nil?
|
45
49
|
fail ArgumentError, "Missing the required parameter 'carrier_id' when calling CarriersApi.add_funds_to_carrier"
|
@@ -57,10 +61,6 @@ module ShipEngine
|
|
57
61
|
fail ArgumentError, "invalid value for 'carrier_id' when calling CarriersApi.add_funds_to_carrier, must conform to the pattern #{pattern}."
|
58
62
|
end
|
59
63
|
|
60
|
-
# verify the required parameter 'add_funds_to_carrier_request_body' is set
|
61
|
-
if @api_client.config.client_side_validation && add_funds_to_carrier_request_body.nil?
|
62
|
-
fail ArgumentError, "Missing the required parameter 'add_funds_to_carrier_request_body' when calling CarriersApi.add_funds_to_carrier"
|
63
|
-
end
|
64
64
|
# resource path
|
65
65
|
local_var_path = '/v1/carriers/{carrier_id}/add_funds'.sub('{' + 'carrier_id' + '}', CGI.escape(carrier_id.to_s))
|
66
66
|
|
@@ -85,25 +85,29 @@ module ShipEngine
|
|
85
85
|
|
86
86
|
# Purchase Label with Rate ID
|
87
87
|
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
88
|
-
# @param rate_id [String] Rate ID
|
89
88
|
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
89
|
+
# @param rate_id [String] Rate ID
|
90
90
|
# @param [Hash] opts the optional parameters
|
91
91
|
# @return [CreateLabelFromRateResponseBody]
|
92
|
-
def create_label_from_rate(
|
93
|
-
data, _status_code, _headers = create_label_from_rate_with_http_info(
|
92
|
+
def create_label_from_rate(create_label_from_rate_request_body, rate_id, opts = {})
|
93
|
+
data, _status_code, _headers = create_label_from_rate_with_http_info(create_label_from_rate_request_body, rate_id, opts)
|
94
94
|
data
|
95
95
|
end
|
96
96
|
|
97
97
|
# Purchase Label with Rate ID
|
98
98
|
# When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.
|
99
|
-
# @param rate_id [String] Rate ID
|
100
99
|
# @param create_label_from_rate_request_body [CreateLabelFromRateRequestBody]
|
100
|
+
# @param rate_id [String] Rate ID
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @return [Array<(CreateLabelFromRateResponseBody, Integer, Hash)>] CreateLabelFromRateResponseBody data, response status code and response headers
|
103
|
-
def create_label_from_rate_with_http_info(
|
103
|
+
def create_label_from_rate_with_http_info(create_label_from_rate_request_body, rate_id, opts = {})
|
104
104
|
if @api_client.config.debugging
|
105
105
|
@api_client.config.logger.debug 'Calling API: LabelsApi.create_label_from_rate ...'
|
106
106
|
end
|
107
|
+
# verify the required parameter 'create_label_from_rate_request_body' is set
|
108
|
+
if @api_client.config.client_side_validation && create_label_from_rate_request_body.nil?
|
109
|
+
fail ArgumentError, "Missing the required parameter 'create_label_from_rate_request_body' when calling LabelsApi.create_label_from_rate"
|
110
|
+
end
|
107
111
|
# verify the required parameter 'rate_id' is set
|
108
112
|
if @api_client.config.client_side_validation && rate_id.nil?
|
109
113
|
fail ArgumentError, "Missing the required parameter 'rate_id' when calling LabelsApi.create_label_from_rate"
|
@@ -121,10 +125,6 @@ module ShipEngine
|
|
121
125
|
fail ArgumentError, "invalid value for 'rate_id' when calling LabelsApi.create_label_from_rate, must conform to the pattern #{pattern}."
|
122
126
|
end
|
123
127
|
|
124
|
-
# verify the required parameter 'create_label_from_rate_request_body' is set
|
125
|
-
if @api_client.config.client_side_validation && create_label_from_rate_request_body.nil?
|
126
|
-
fail ArgumentError, "Missing the required parameter 'create_label_from_rate_request_body' when calling LabelsApi.create_label_from_rate"
|
127
|
-
end
|
128
128
|
# resource path
|
129
129
|
local_var_path = '/v1/labels/rates/{rate_id}'.sub('{' + 'rate_id' + '}', CGI.escape(rate_id.to_s))
|
130
130
|
|
@@ -168,25 +168,29 @@ module ShipEngine
|
|
168
168
|
|
169
169
|
# Purchase Label with Shipment ID
|
170
170
|
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
171
|
-
# @param shipment_id [String] Shipment ID
|
172
171
|
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
172
|
+
# @param shipment_id [String] Shipment ID
|
173
173
|
# @param [Hash] opts the optional parameters
|
174
174
|
# @return [CreateLabelFromShipmentResponseBody]
|
175
|
-
def create_label_from_shipment(
|
176
|
-
data, _status_code, _headers = create_label_from_shipment_with_http_info(
|
175
|
+
def create_label_from_shipment(create_label_from_shipment_request_body, shipment_id, opts = {})
|
176
|
+
data, _status_code, _headers = create_label_from_shipment_with_http_info(create_label_from_shipment_request_body, shipment_id, opts)
|
177
177
|
data
|
178
178
|
end
|
179
179
|
|
180
180
|
# Purchase Label with Shipment ID
|
181
181
|
# Purchase a label using a shipment ID that has already been created with the desired address and package info.
|
182
|
-
# @param shipment_id [String] Shipment ID
|
183
182
|
# @param create_label_from_shipment_request_body [CreateLabelFromShipmentRequestBody]
|
183
|
+
# @param shipment_id [String] Shipment ID
|
184
184
|
# @param [Hash] opts the optional parameters
|
185
185
|
# @return [Array<(CreateLabelFromShipmentResponseBody, Integer, Hash)>] CreateLabelFromShipmentResponseBody data, response status code and response headers
|
186
|
-
def create_label_from_shipment_with_http_info(
|
186
|
+
def create_label_from_shipment_with_http_info(create_label_from_shipment_request_body, shipment_id, opts = {})
|
187
187
|
if @api_client.config.debugging
|
188
188
|
@api_client.config.logger.debug 'Calling API: LabelsApi.create_label_from_shipment ...'
|
189
189
|
end
|
190
|
+
# verify the required parameter 'create_label_from_shipment_request_body' is set
|
191
|
+
if @api_client.config.client_side_validation && create_label_from_shipment_request_body.nil?
|
192
|
+
fail ArgumentError, "Missing the required parameter 'create_label_from_shipment_request_body' when calling LabelsApi.create_label_from_shipment"
|
193
|
+
end
|
190
194
|
# verify the required parameter 'shipment_id' is set
|
191
195
|
if @api_client.config.client_side_validation && shipment_id.nil?
|
192
196
|
fail ArgumentError, "Missing the required parameter 'shipment_id' when calling LabelsApi.create_label_from_shipment"
|
@@ -204,10 +208,6 @@ module ShipEngine
|
|
204
208
|
fail ArgumentError, "invalid value for 'shipment_id' when calling LabelsApi.create_label_from_shipment, must conform to the pattern #{pattern}."
|
205
209
|
end
|
206
210
|
|
207
|
-
# verify the required parameter 'create_label_from_shipment_request_body' is set
|
208
|
-
if @api_client.config.client_side_validation && create_label_from_shipment_request_body.nil?
|
209
|
-
fail ArgumentError, "Missing the required parameter 'create_label_from_shipment_request_body' when calling LabelsApi.create_label_from_shipment"
|
210
|
-
end
|
211
211
|
# resource path
|
212
212
|
local_var_path = '/v1/labels/shipment/{shipment_id}'.sub('{' + 'shipment_id' + '}', CGI.escape(shipment_id.to_s))
|
213
213
|
|
@@ -251,25 +251,29 @@ module ShipEngine
|
|
251
251
|
|
252
252
|
# Create a return label
|
253
253
|
# Create a return label
|
254
|
-
# @param label_id [String] Label ID
|
255
254
|
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
255
|
+
# @param label_id [String] Label ID
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [CreateReturnLabelResponseBody]
|
258
|
-
def create_return_label(
|
259
|
-
data, _status_code, _headers = create_return_label_with_http_info(
|
258
|
+
def create_return_label(create_return_label_request_body, label_id, opts = {})
|
259
|
+
data, _status_code, _headers = create_return_label_with_http_info(create_return_label_request_body, label_id, opts)
|
260
260
|
data
|
261
261
|
end
|
262
262
|
|
263
263
|
# Create a return label
|
264
264
|
# Create a return label
|
265
|
-
# @param label_id [String] Label ID
|
266
265
|
# @param create_return_label_request_body [CreateReturnLabelRequestBody]
|
266
|
+
# @param label_id [String] Label ID
|
267
267
|
# @param [Hash] opts the optional parameters
|
268
268
|
# @return [Array<(CreateReturnLabelResponseBody, Integer, Hash)>] CreateReturnLabelResponseBody data, response status code and response headers
|
269
|
-
def create_return_label_with_http_info(
|
269
|
+
def create_return_label_with_http_info(create_return_label_request_body, label_id, opts = {})
|
270
270
|
if @api_client.config.debugging
|
271
271
|
@api_client.config.logger.debug 'Calling API: LabelsApi.create_return_label ...'
|
272
272
|
end
|
273
|
+
# verify the required parameter 'create_return_label_request_body' is set
|
274
|
+
if @api_client.config.client_side_validation && create_return_label_request_body.nil?
|
275
|
+
fail ArgumentError, "Missing the required parameter 'create_return_label_request_body' when calling LabelsApi.create_return_label"
|
276
|
+
end
|
273
277
|
# verify the required parameter 'label_id' is set
|
274
278
|
if @api_client.config.client_side_validation && label_id.nil?
|
275
279
|
fail ArgumentError, "Missing the required parameter 'label_id' when calling LabelsApi.create_return_label"
|
@@ -287,10 +291,6 @@ module ShipEngine
|
|
287
291
|
fail ArgumentError, "invalid value for 'label_id' when calling LabelsApi.create_return_label, must conform to the pattern #{pattern}."
|
288
292
|
end
|
289
293
|
|
290
|
-
# verify the required parameter 'create_return_label_request_body' is set
|
291
|
-
if @api_client.config.client_side_validation && create_return_label_request_body.nil?
|
292
|
-
fail ArgumentError, "Missing the required parameter 'create_return_label_request_body' when calling LabelsApi.create_return_label"
|
293
|
-
end
|
294
294
|
# resource path
|
295
295
|
local_var_path = '/v1/labels/{label_id}/return'.sub('{' + 'label_id' + '}', CGI.escape(label_id.to_s))
|
296
296
|
|
@@ -291,25 +291,29 @@ module ShipEngine
|
|
291
291
|
|
292
292
|
# Update Custom Package Type By ID
|
293
293
|
# Update the custom package type object by ID
|
294
|
-
# @param package_id [String] Package ID
|
295
294
|
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
295
|
+
# @param package_id [String] Package ID
|
296
296
|
# @param [Hash] opts the optional parameters
|
297
297
|
# @return [String]
|
298
|
-
def update_package_type(
|
299
|
-
data, _status_code, _headers = update_package_type_with_http_info(
|
298
|
+
def update_package_type(update_package_type_request_body, package_id, opts = {})
|
299
|
+
data, _status_code, _headers = update_package_type_with_http_info(update_package_type_request_body, package_id, opts)
|
300
300
|
data
|
301
301
|
end
|
302
302
|
|
303
303
|
# Update Custom Package Type By ID
|
304
304
|
# Update the custom package type object by ID
|
305
|
-
# @param package_id [String] Package ID
|
306
305
|
# @param update_package_type_request_body [UpdatePackageTypeRequestBody]
|
306
|
+
# @param package_id [String] Package ID
|
307
307
|
# @param [Hash] opts the optional parameters
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
309
|
-
def update_package_type_with_http_info(
|
309
|
+
def update_package_type_with_http_info(update_package_type_request_body, package_id, opts = {})
|
310
310
|
if @api_client.config.debugging
|
311
311
|
@api_client.config.logger.debug 'Calling API: PackageTypesApi.update_package_type ...'
|
312
312
|
end
|
313
|
+
# verify the required parameter 'update_package_type_request_body' is set
|
314
|
+
if @api_client.config.client_side_validation && update_package_type_request_body.nil?
|
315
|
+
fail ArgumentError, "Missing the required parameter 'update_package_type_request_body' when calling PackageTypesApi.update_package_type"
|
316
|
+
end
|
313
317
|
# verify the required parameter 'package_id' is set
|
314
318
|
if @api_client.config.client_side_validation && package_id.nil?
|
315
319
|
fail ArgumentError, "Missing the required parameter 'package_id' when calling PackageTypesApi.update_package_type"
|
@@ -327,10 +331,6 @@ module ShipEngine
|
|
327
331
|
fail ArgumentError, "invalid value for 'package_id' when calling PackageTypesApi.update_package_type, must conform to the pattern #{pattern}."
|
328
332
|
end
|
329
333
|
|
330
|
-
# verify the required parameter 'update_package_type_request_body' is set
|
331
|
-
if @api_client.config.client_side_validation && update_package_type_request_body.nil?
|
332
|
-
fail ArgumentError, "Missing the required parameter 'update_package_type_request_body' when calling PackageTypesApi.update_package_type"
|
333
|
-
end
|
334
334
|
# resource path
|
335
335
|
local_var_path = '/v1/packages/{package_id}'.sub('{' + 'package_id' + '}', CGI.escape(package_id.to_s))
|
336
336
|
|
@@ -815,25 +815,29 @@ module ShipEngine
|
|
815
815
|
|
816
816
|
# Update Shipment By ID
|
817
817
|
# Update a shipment object based on its ID
|
818
|
-
# @param shipment_id [String] Shipment ID
|
819
818
|
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
819
|
+
# @param shipment_id [String] Shipment ID
|
820
820
|
# @param [Hash] opts the optional parameters
|
821
821
|
# @return [UpdateShipmentResponseBody]
|
822
|
-
def update_shipment(
|
823
|
-
data, _status_code, _headers = update_shipment_with_http_info(
|
822
|
+
def update_shipment(update_shipment_request_body, shipment_id, opts = {})
|
823
|
+
data, _status_code, _headers = update_shipment_with_http_info(update_shipment_request_body, shipment_id, opts)
|
824
824
|
data
|
825
825
|
end
|
826
826
|
|
827
827
|
# Update Shipment By ID
|
828
828
|
# Update a shipment object based on its ID
|
829
|
-
# @param shipment_id [String] Shipment ID
|
830
829
|
# @param update_shipment_request_body [UpdateShipmentRequestBody]
|
830
|
+
# @param shipment_id [String] Shipment ID
|
831
831
|
# @param [Hash] opts the optional parameters
|
832
832
|
# @return [Array<(UpdateShipmentResponseBody, Integer, Hash)>] UpdateShipmentResponseBody data, response status code and response headers
|
833
|
-
def update_shipment_with_http_info(
|
833
|
+
def update_shipment_with_http_info(update_shipment_request_body, shipment_id, opts = {})
|
834
834
|
if @api_client.config.debugging
|
835
835
|
@api_client.config.logger.debug 'Calling API: ShipmentsApi.update_shipment ...'
|
836
836
|
end
|
837
|
+
# verify the required parameter 'update_shipment_request_body' is set
|
838
|
+
if @api_client.config.client_side_validation && update_shipment_request_body.nil?
|
839
|
+
fail ArgumentError, "Missing the required parameter 'update_shipment_request_body' when calling ShipmentsApi.update_shipment"
|
840
|
+
end
|
837
841
|
# verify the required parameter 'shipment_id' is set
|
838
842
|
if @api_client.config.client_side_validation && shipment_id.nil?
|
839
843
|
fail ArgumentError, "Missing the required parameter 'shipment_id' when calling ShipmentsApi.update_shipment"
|
@@ -851,10 +855,6 @@ module ShipEngine
|
|
851
855
|
fail ArgumentError, "invalid value for 'shipment_id' when calling ShipmentsApi.update_shipment, must conform to the pattern #{pattern}."
|
852
856
|
end
|
853
857
|
|
854
|
-
# verify the required parameter 'update_shipment_request_body' is set
|
855
|
-
if @api_client.config.client_side_validation && update_shipment_request_body.nil?
|
856
|
-
fail ArgumentError, "Missing the required parameter 'update_shipment_request_body' when calling ShipmentsApi.update_shipment"
|
857
|
-
end
|
858
858
|
# resource path
|
859
859
|
local_var_path = '/v1/shipments/{shipment_id}'.sub('{' + 'shipment_id' + '}', CGI.escape(shipment_id.to_s))
|
860
860
|
|
@@ -291,25 +291,29 @@ module ShipEngine
|
|
291
291
|
|
292
292
|
# Update WareHouse By Id
|
293
293
|
# Update Warehouse object information
|
294
|
-
# @param warehouse_id [String] Warehouse ID
|
295
294
|
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
295
|
+
# @param warehouse_id [String] Warehouse ID
|
296
296
|
# @param [Hash] opts the optional parameters
|
297
297
|
# @return [String]
|
298
|
-
def update_warehouse(
|
299
|
-
data, _status_code, _headers = update_warehouse_with_http_info(
|
298
|
+
def update_warehouse(update_warehouse_request_body, warehouse_id, opts = {})
|
299
|
+
data, _status_code, _headers = update_warehouse_with_http_info(update_warehouse_request_body, warehouse_id, opts)
|
300
300
|
data
|
301
301
|
end
|
302
302
|
|
303
303
|
# Update WareHouse By Id
|
304
304
|
# Update Warehouse object information
|
305
|
-
# @param warehouse_id [String] Warehouse ID
|
306
305
|
# @param update_warehouse_request_body [UpdateWarehouseRequestBody]
|
306
|
+
# @param warehouse_id [String] Warehouse ID
|
307
307
|
# @param [Hash] opts the optional parameters
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
309
|
-
def update_warehouse_with_http_info(
|
309
|
+
def update_warehouse_with_http_info(update_warehouse_request_body, warehouse_id, opts = {})
|
310
310
|
if @api_client.config.debugging
|
311
311
|
@api_client.config.logger.debug 'Calling API: WarehousesApi.update_warehouse ...'
|
312
312
|
end
|
313
|
+
# verify the required parameter 'update_warehouse_request_body' is set
|
314
|
+
if @api_client.config.client_side_validation && update_warehouse_request_body.nil?
|
315
|
+
fail ArgumentError, "Missing the required parameter 'update_warehouse_request_body' when calling WarehousesApi.update_warehouse"
|
316
|
+
end
|
313
317
|
# verify the required parameter 'warehouse_id' is set
|
314
318
|
if @api_client.config.client_side_validation && warehouse_id.nil?
|
315
319
|
fail ArgumentError, "Missing the required parameter 'warehouse_id' when calling WarehousesApi.update_warehouse"
|
@@ -327,10 +331,6 @@ module ShipEngine
|
|
327
331
|
fail ArgumentError, "invalid value for 'warehouse_id' when calling WarehousesApi.update_warehouse, must conform to the pattern #{pattern}."
|
328
332
|
end
|
329
333
|
|
330
|
-
# verify the required parameter 'update_warehouse_request_body' is set
|
331
|
-
if @api_client.config.client_side_validation && update_warehouse_request_body.nil?
|
332
|
-
fail ArgumentError, "Missing the required parameter 'update_warehouse_request_body' when calling WarehousesApi.update_warehouse"
|
333
|
-
end
|
334
334
|
# resource path
|
335
335
|
local_var_path = '/v1/warehouses/{warehouse_id}'.sub('{' + 'warehouse_id' + '}', CGI.escape(warehouse_id.to_s))
|
336
336
|
|
@@ -291,25 +291,29 @@ module ShipEngine
|
|
291
291
|
|
292
292
|
# Update a Webhook
|
293
293
|
# Update the webhook url property
|
294
|
-
# @param webhook_id [String] Webhook ID
|
295
294
|
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
295
|
+
# @param webhook_id [String] Webhook ID
|
296
296
|
# @param [Hash] opts the optional parameters
|
297
297
|
# @return [String]
|
298
|
-
def update_webhook(
|
299
|
-
data, _status_code, _headers = update_webhook_with_http_info(
|
298
|
+
def update_webhook(update_webhook_request_body, webhook_id, opts = {})
|
299
|
+
data, _status_code, _headers = update_webhook_with_http_info(update_webhook_request_body, webhook_id, opts)
|
300
300
|
data
|
301
301
|
end
|
302
302
|
|
303
303
|
# Update a Webhook
|
304
304
|
# Update the webhook url property
|
305
|
-
# @param webhook_id [String] Webhook ID
|
306
305
|
# @param update_webhook_request_body [UpdateWebhookRequestBody]
|
306
|
+
# @param webhook_id [String] Webhook ID
|
307
307
|
# @param [Hash] opts the optional parameters
|
308
308
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
309
|
-
def update_webhook_with_http_info(
|
309
|
+
def update_webhook_with_http_info(update_webhook_request_body, webhook_id, opts = {})
|
310
310
|
if @api_client.config.debugging
|
311
311
|
@api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook ...'
|
312
312
|
end
|
313
|
+
# verify the required parameter 'update_webhook_request_body' is set
|
314
|
+
if @api_client.config.client_side_validation && update_webhook_request_body.nil?
|
315
|
+
fail ArgumentError, "Missing the required parameter 'update_webhook_request_body' when calling WebhooksApi.update_webhook"
|
316
|
+
end
|
313
317
|
# verify the required parameter 'webhook_id' is set
|
314
318
|
if @api_client.config.client_side_validation && webhook_id.nil?
|
315
319
|
fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.update_webhook"
|
@@ -327,10 +331,6 @@ module ShipEngine
|
|
327
331
|
fail ArgumentError, "invalid value for 'webhook_id' when calling WebhooksApi.update_webhook, must conform to the pattern #{pattern}."
|
328
332
|
end
|
329
333
|
|
330
|
-
# verify the required parameter 'update_webhook_request_body' is set
|
331
|
-
if @api_client.config.client_side_validation && update_webhook_request_body.nil?
|
332
|
-
fail ArgumentError, "Missing the required parameter 'update_webhook_request_body' when calling WebhooksApi.update_webhook"
|
333
|
-
end
|
334
334
|
# resource path
|
335
335
|
local_var_path = '/v1/environment/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))
|
336
336
|
|