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.
Files changed (205) hide show
  1. checksums.yaml +4 -4
  2. data/docs/BatchesApi.md +12 -12
  3. data/docs/CarrierAccountsApi.md +8 -8
  4. data/docs/CarriersApi.md +4 -4
  5. data/docs/LabelsApi.md +12 -12
  6. data/docs/PackageTypesApi.md +4 -4
  7. data/docs/ShipmentsApi.md +4 -4
  8. data/docs/WarehousesApi.md +4 -4
  9. data/docs/WebhooksApi.md +4 -4
  10. data/lib/ship_engine/api/batches_api.rb +27 -27
  11. data/lib/ship_engine/api/carrier_accounts_api.rb +18 -18
  12. data/lib/ship_engine/api/carriers_api.rb +9 -9
  13. data/lib/ship_engine/api/labels_api.rb +27 -27
  14. data/lib/ship_engine/api/package_types_api.rb +9 -9
  15. data/lib/ship_engine/api/shipments_api.rb +9 -9
  16. data/lib/ship_engine/api/warehouses_api.rb +9 -9
  17. data/lib/ship_engine/api/webhooks_api.rb +9 -9
  18. data/lib/ship_engine/models/add_funds_to_carrier_request_body.rb +3 -5
  19. data/lib/ship_engine/models/add_funds_to_carrier_response_body.rb +3 -5
  20. data/lib/ship_engine/models/add_funds_to_insurance_request_body.rb +3 -5
  21. data/lib/ship_engine/models/add_funds_to_insurance_response_body.rb +3 -5
  22. data/lib/ship_engine/models/add_to_batch_request_body.rb +3 -5
  23. data/lib/ship_engine/models/address.rb +4 -6
  24. data/lib/ship_engine/models/address_to_validate.rb +4 -6
  25. data/lib/ship_engine/models/address_validating_shipment.rb +14 -16
  26. data/lib/ship_engine/models/address_validation_result.rb +3 -5
  27. data/lib/ship_engine/models/advanced_shipment_options.rb +14 -16
  28. data/lib/ship_engine/models/batch.rb +4 -6
  29. data/lib/ship_engine/models/batch_response_error.rb +3 -5
  30. data/lib/ship_engine/models/bulk_rate.rb +3 -5
  31. data/lib/ship_engine/models/calculate_rates_request_body.rb +3 -5
  32. data/lib/ship_engine/models/calculate_rates_response_body.rb +14 -16
  33. data/lib/ship_engine/models/carrier.rb +4 -6
  34. data/lib/ship_engine/models/carrier_advanced_option.rb +3 -5
  35. data/lib/ship_engine/models/collect_on_delivery.rb +3 -5
  36. data/lib/ship_engine/models/compare_bulk_rates_request_body.rb +3 -5
  37. data/lib/ship_engine/models/connect_access_worldwide_request_body.rb +3 -5
  38. data/lib/ship_engine/models/connect_amazon_buy_shipping_request_body.rb +3 -5
  39. data/lib/ship_engine/models/connect_apc_request_body.rb +3 -5
  40. data/lib/ship_engine/models/connect_asendia_request_body.rb +3 -5
  41. data/lib/ship_engine/models/connect_australia_post_request_body.rb +3 -5
  42. data/lib/ship_engine/models/connect_canada_post_request_body.rb +3 -5
  43. data/lib/ship_engine/models/connect_carrier_request_body.rb +4 -6
  44. data/lib/ship_engine/models/connect_carrier_response_body.rb +3 -5
  45. data/lib/ship_engine/models/connect_dhl_ecommerce_request_body.rb +5 -7
  46. data/lib/ship_engine/models/connect_dhl_express_au_request_body.rb +3 -5
  47. data/lib/ship_engine/models/connect_dhl_express_ca_request_body.rb +3 -5
  48. data/lib/ship_engine/models/connect_dhl_express_request_body.rb +3 -5
  49. data/lib/ship_engine/models/connect_dhl_express_uk_request_body.rb +3 -5
  50. data/lib/ship_engine/models/connect_dpd_request_body.rb +3 -5
  51. data/lib/ship_engine/models/connect_endicia_request_body.rb +3 -5
  52. data/lib/ship_engine/models/connect_fedex_request_body.rb +3 -5
  53. data/lib/ship_engine/models/connect_fedex_uk_request_body.rb +3 -5
  54. data/lib/ship_engine/models/connect_firstmile_request_body.rb +3 -5
  55. data/lib/ship_engine/models/connect_globegistics_request_body.rb +3 -5
  56. data/lib/ship_engine/models/connect_imex_request_body.rb +3 -5
  57. data/lib/ship_engine/models/connect_insurer_request_body.rb +3 -5
  58. data/lib/ship_engine/models/connect_newgistics_request_body.rb +3 -5
  59. data/lib/ship_engine/models/connect_ontrac_request_body.rb +3 -5
  60. data/lib/ship_engine/models/connect_purolator_request_body.rb +3 -5
  61. data/lib/ship_engine/models/connect_royal_mail_request_body.rb +3 -5
  62. data/lib/ship_engine/models/connect_rr_donnelley_request_body.rb +3 -5
  63. data/lib/ship_engine/models/connect_seko_request_body.rb +3 -5
  64. data/lib/ship_engine/models/connect_sendle_request_body.rb +3 -5
  65. data/lib/ship_engine/models/connect_stamps_request_body.rb +3 -5
  66. data/lib/ship_engine/models/connect_ups_request_body.rb +3 -5
  67. data/lib/ship_engine/models/create_and_validate_shipment.rb +14 -16
  68. data/lib/ship_engine/models/create_batch_request_body.rb +3 -5
  69. data/lib/ship_engine/models/create_batch_response_body.rb +3 -5
  70. data/lib/ship_engine/models/create_label_from_rate_request_body.rb +3 -5
  71. data/lib/ship_engine/models/create_label_from_rate_response_body.rb +3 -5
  72. data/lib/ship_engine/models/create_label_from_shipment_request_body.rb +3 -5
  73. data/lib/ship_engine/models/create_label_from_shipment_response_body.rb +3 -5
  74. data/lib/ship_engine/models/create_label_request_body.rb +3 -5
  75. data/lib/ship_engine/models/create_label_response_body.rb +3 -5
  76. data/lib/ship_engine/models/create_manifest_by_object_request_body.rb +3 -5
  77. data/lib/ship_engine/models/create_manifest_label_ids_request_body.rb +3 -5
  78. data/lib/ship_engine/models/create_manifest_request_body.rb +3 -5
  79. data/lib/ship_engine/models/create_manifest_response_body.rb +3 -5
  80. data/lib/ship_engine/models/create_package_type_request_body.rb +3 -5
  81. data/lib/ship_engine/models/create_package_type_response_body.rb +3 -5
  82. data/lib/ship_engine/models/create_return_label_request_body.rb +6 -8
  83. data/lib/ship_engine/models/create_return_label_response_body.rb +3 -5
  84. data/lib/ship_engine/models/create_shipment_response_body_fields.rb +3 -5
  85. data/lib/ship_engine/models/create_shipments_request_body.rb +3 -5
  86. data/lib/ship_engine/models/create_shipments_response_body.rb +3 -5
  87. data/lib/ship_engine/models/create_tag_response_body.rb +3 -5
  88. data/lib/ship_engine/models/create_warehouse_request_body.rb +3 -5
  89. data/lib/ship_engine/models/create_warehouse_response_body.rb +3 -5
  90. data/lib/ship_engine/models/create_webhook_request_body.rb +3 -5
  91. data/lib/ship_engine/models/create_webhook_response_body.rb +3 -5
  92. data/lib/ship_engine/models/customs_item.rb +4 -6
  93. data/lib/ship_engine/models/deprecated_manifest.rb +3 -5
  94. data/lib/ship_engine/models/dhl_express_account_settings.rb +3 -5
  95. data/lib/ship_engine/models/dhl_express_settings_response_body.rb +3 -5
  96. data/lib/ship_engine/models/dimensions.rb +3 -5
  97. data/lib/ship_engine/models/error.rb +4 -6
  98. data/lib/ship_engine/models/error_response_body.rb +4 -6
  99. data/lib/ship_engine/models/estimate_rates_request_body.rb +3 -5
  100. data/lib/ship_engine/models/fedex_account_settings.rb +3 -5
  101. data/lib/ship_engine/models/fedex_account_settings_request_body.rb +3 -5
  102. data/lib/ship_engine/models/fedex_settings_response_body.rb +3 -5
  103. data/lib/ship_engine/models/get_batch_by_external_id_response_body.rb +3 -5
  104. data/lib/ship_engine/models/get_batch_by_id_response_body.rb +3 -5
  105. data/lib/ship_engine/models/get_carrier_by_id_response_body.rb +3 -5
  106. data/lib/ship_engine/models/get_carrier_options_response_body.rb +3 -5
  107. data/lib/ship_engine/models/get_carrier_settings_response_body.rb +3 -5
  108. data/lib/ship_engine/models/get_carriers_response_body.rb +4 -6
  109. data/lib/ship_engine/models/get_insurance_balance_response_body.rb +3 -5
  110. data/lib/ship_engine/models/get_label_by_external_shipment_id_response_body.rb +3 -5
  111. data/lib/ship_engine/models/get_label_by_id_response_body.rb +3 -5
  112. data/lib/ship_engine/models/get_manifest_by_id_response_body.rb +3 -5
  113. data/lib/ship_engine/models/get_package_type_by_id_response_body.rb +3 -5
  114. data/lib/ship_engine/models/get_rate_by_id_response_body.rb +3 -5
  115. data/lib/ship_engine/models/get_shipment_by_external_id_response_body.rb +3 -5
  116. data/lib/ship_engine/models/get_shipment_by_id_response_body.rb +3 -5
  117. data/lib/ship_engine/models/get_tracking_log_from_label_response_body.rb +3 -5
  118. data/lib/ship_engine/models/get_tracking_log_response_body.rb +3 -5
  119. data/lib/ship_engine/models/get_warehouse_by_id_response_body.rb +3 -5
  120. data/lib/ship_engine/models/get_webhook_by_id_response_body.rb +3 -5
  121. data/lib/ship_engine/models/international_shipment_options.rb +3 -5
  122. data/lib/ship_engine/models/label.rb +27 -29
  123. data/lib/ship_engine/models/label_download.rb +4 -6
  124. data/lib/ship_engine/models/label_messages.rb +7 -9
  125. data/lib/ship_engine/models/link.rb +3 -5
  126. data/lib/ship_engine/models/list_batch_errors_response_body.rb +3 -5
  127. data/lib/ship_engine/models/list_batches_response_body.rb +3 -5
  128. data/lib/ship_engine/models/list_carrier_package_types_response_body.rb +3 -5
  129. data/lib/ship_engine/models/list_carrier_services_response_body.rb +3 -5
  130. data/lib/ship_engine/models/list_carriers_response_body.rb +3 -5
  131. data/lib/ship_engine/models/list_labels_response_body.rb +4 -6
  132. data/lib/ship_engine/models/list_manifests_response_body.rb +3 -5
  133. data/lib/ship_engine/models/list_package_types_response_body.rb +3 -5
  134. data/lib/ship_engine/models/list_shipment_errors_response_body.rb +3 -5
  135. data/lib/ship_engine/models/list_shipment_rates_response_body.rb +3 -5
  136. data/lib/ship_engine/models/list_shipments_response_body.rb +3 -5
  137. data/lib/ship_engine/models/list_tags_response_body.rb +3 -5
  138. data/lib/ship_engine/models/list_warehouses_response_body.rb +3 -5
  139. data/lib/ship_engine/models/manifest.rb +4 -6
  140. data/lib/ship_engine/models/manifest_download.rb +3 -5
  141. data/lib/ship_engine/models/manifests.rb +3 -5
  142. data/lib/ship_engine/models/modify_batch.rb +3 -5
  143. data/lib/ship_engine/models/monetary_value.rb +4 -6
  144. data/lib/ship_engine/models/optional_link.rb +3 -5
  145. data/lib/ship_engine/models/package.rb +6 -8
  146. data/lib/ship_engine/models/package_type.rb +3 -5
  147. data/lib/ship_engine/models/paged_list_response_body.rb +4 -6
  148. data/lib/ship_engine/models/pagination_link.rb +7 -9
  149. data/lib/ship_engine/models/parse_address_request_body.rb +5 -7
  150. data/lib/ship_engine/models/parse_address_response_body.rb +7 -9
  151. data/lib/ship_engine/models/parse_shipment_request_body.rb +5 -7
  152. data/lib/ship_engine/models/parse_shipment_response_body.rb +7 -9
  153. data/lib/ship_engine/models/partial_address.rb +11 -13
  154. data/lib/ship_engine/models/partial_shipment.rb +15 -17
  155. data/lib/ship_engine/models/payment_amount.rb +3 -5
  156. data/lib/ship_engine/models/process_batch_request_body.rb +3 -5
  157. data/lib/ship_engine/models/purchase_label_without_shipment.rb +3 -5
  158. data/lib/ship_engine/models/rate.rb +5 -7
  159. data/lib/ship_engine/models/rate_estimate_by_carrier_id.rb +3 -5
  160. data/lib/ship_engine/models/rate_estimate_by_carrier_ids.rb +3 -5
  161. data/lib/ship_engine/models/rate_estimate_options.rb +3 -5
  162. data/lib/ship_engine/models/rate_request_body.rb +3 -5
  163. data/lib/ship_engine/models/rate_request_by_shipment_ids.rb +3 -5
  164. data/lib/ship_engine/models/rate_request_by_shipments.rb +3 -5
  165. data/lib/ship_engine/models/rate_request_options.rb +3 -5
  166. data/lib/ship_engine/models/rate_request_rate_options.rb +3 -5
  167. data/lib/ship_engine/models/rate_response.rb +3 -5
  168. data/lib/ship_engine/models/rates_information.rb +3 -5
  169. data/lib/ship_engine/models/recognized_entity.rb +6 -8
  170. data/lib/ship_engine/models/remove_from_batch_request_body.rb +3 -5
  171. data/lib/ship_engine/models/response_message.rb +3 -5
  172. data/lib/ship_engine/models/service.rb +3 -5
  173. data/lib/ship_engine/models/shipment.rb +4 -6
  174. data/lib/ship_engine/models/shipment_id_request.rb +3 -5
  175. data/lib/ship_engine/models/shipment_item.rb +3 -5
  176. data/lib/ship_engine/models/shipment_request.rb +3 -5
  177. data/lib/ship_engine/models/shipment_response_error.rb +3 -5
  178. data/lib/ship_engine/models/tag.rb +4 -6
  179. data/lib/ship_engine/models/tag_shipment_response_body.rb +3 -5
  180. data/lib/ship_engine/models/track_event.rb +3 -5
  181. data/lib/ship_engine/models/tracking_information.rb +3 -5
  182. data/lib/ship_engine/models/update_amazon_buy_shipping_request_body.rb +3 -5
  183. data/lib/ship_engine/models/update_carrier_settings_request_body.rb +3 -5
  184. data/lib/ship_engine/models/update_dhl_express_settings_request_body.rb +3 -5
  185. data/lib/ship_engine/models/update_fedex_settings_request_body.rb +3 -5
  186. data/lib/ship_engine/models/update_newgistics_settings_request_body.rb +3 -5
  187. data/lib/ship_engine/models/update_package_type_request_body.rb +3 -5
  188. data/lib/ship_engine/models/update_shipment_fields.rb +3 -5
  189. data/lib/ship_engine/models/update_shipment_request_body.rb +14 -16
  190. data/lib/ship_engine/models/update_shipment_response_body.rb +3 -5
  191. data/lib/ship_engine/models/update_ups_settings_request_body.rb +3 -5
  192. data/lib/ship_engine/models/update_warehouse_request_body.rb +3 -5
  193. data/lib/ship_engine/models/update_webhook_request_body.rb +3 -5
  194. data/lib/ship_engine/models/ups_account_settings.rb +3 -5
  195. data/lib/ship_engine/models/ups_invoice.rb +3 -5
  196. data/lib/ship_engine/models/ups_settings_response_body.rb +3 -5
  197. data/lib/ship_engine/models/validate_shipment_fields.rb +3 -5
  198. data/lib/ship_engine/models/void_label_response_body.rb +3 -5
  199. data/lib/ship_engine/models/warehouse.rb +3 -5
  200. data/lib/ship_engine/models/webhook.rb +3 -5
  201. data/lib/ship_engine/models/weight.rb +3 -5
  202. data/lib/ship_engine/version.rb +1 -1
  203. data/ship_engine-1.0.4.gem +0 -0
  204. data/ship_engine.gemspec +1 -1
  205. metadata +2 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bff6f9fe87091300cfeb8367882a1aeff70cd88900058d89c4a615b272b5391b
4
- data.tar.gz: 4ae33dfb71036a68ec1dc9dfdf663233492dc04fa98f777cb8930485700de7dd
3
+ metadata.gz: 3372e8b729c37a76eb81fec8f382880f8e31d33cdce291347b3d6e05b943a695
4
+ data.tar.gz: 50f31432378d9c402f3a64c5d71f1d3b8da1518147f4163c75a172651462d798
5
5
  SHA512:
6
- metadata.gz: 2aaa816a5c793cd464c33ba25db0f414e58bc513a0cbbbf3f63c7305e11db2f42b43abc790bc799350a5f29cc4c27b7748a23c14a505194d60d494957d2c2015
7
- data.tar.gz: 90b1d2703c66832610e1230284a0dfa41f1e845e74265daebd7bd97536f1ac4dc86bdd3495e0e9d616f993e98235ac947b13f3d5cd871cf7499bb0f7e9bf3fec
6
+ metadata.gz: 594e17a90c3a75dd8296afe09a7af3040731e3fee14a5275b4f68758c937b45f17ac4b86129e3cd8bdd0213cfe1ba5fe5b168f4058c7502a58619cad65ee006b
7
+ data.tar.gz: 43c762c521a5b0f783b3fbd247b6bac7f4a57fb2c336373c837e521f3941bab5e2f7627f437a68100cb0344603e6bd9efda7ee1d9b05299a9513c43cc0fa5514
@@ -19,7 +19,7 @@ Method | HTTP request | Description
19
19
 
20
20
  ## add_to_batch
21
21
 
22
- > String add_to_batch(batch_id, add_to_batch_request_body)
22
+ > String add_to_batch(add_to_batch_request_body, batch_id)
23
23
 
24
24
  Add to a Batch
25
25
 
@@ -39,12 +39,12 @@ ShipEngine.configure do |config|
39
39
  end
40
40
 
41
41
  api_instance = ShipEngine::BatchesApi.new
42
- batch_id = 'batch_id_example' # String | Batch ID
43
42
  add_to_batch_request_body = ShipEngine::AddToBatchRequestBody.new # AddToBatchRequestBody |
43
+ batch_id = 'batch_id_example' # String | Batch ID
44
44
 
45
45
  begin
46
46
  #Add to a Batch
47
- result = api_instance.add_to_batch(batch_id, add_to_batch_request_body)
47
+ result = api_instance.add_to_batch(add_to_batch_request_body, batch_id)
48
48
  p result
49
49
  rescue ShipEngine::ApiError => e
50
50
  puts "Exception when calling BatchesApi->add_to_batch: #{e}"
@@ -56,8 +56,8 @@ end
56
56
 
57
57
  Name | Type | Description | Notes
58
58
  ------------- | ------------- | ------------- | -------------
59
- **batch_id** | **String**| Batch ID |
60
59
  **add_to_batch_request_body** | [**AddToBatchRequestBody**](AddToBatchRequestBody.md)| |
60
+ **batch_id** | **String**| Batch ID |
61
61
 
62
62
  ### Return type
63
63
 
@@ -415,7 +415,7 @@ Name | Type | Description | Notes
415
415
 
416
416
  ## process_batch
417
417
 
418
- > String process_batch(batch_id, process_batch_request_body)
418
+ > String process_batch(process_batch_request_body, batch_id)
419
419
 
420
420
  Process Batch ID Labels
421
421
 
@@ -435,12 +435,12 @@ ShipEngine.configure do |config|
435
435
  end
436
436
 
437
437
  api_instance = ShipEngine::BatchesApi.new
438
- batch_id = 'batch_id_example' # String | Batch ID
439
438
  process_batch_request_body = ShipEngine::ProcessBatchRequestBody.new # ProcessBatchRequestBody |
439
+ batch_id = 'batch_id_example' # String | Batch ID
440
440
 
441
441
  begin
442
442
  #Process Batch ID Labels
443
- result = api_instance.process_batch(batch_id, process_batch_request_body)
443
+ result = api_instance.process_batch(process_batch_request_body, batch_id)
444
444
  p result
445
445
  rescue ShipEngine::ApiError => e
446
446
  puts "Exception when calling BatchesApi->process_batch: #{e}"
@@ -452,8 +452,8 @@ end
452
452
 
453
453
  Name | Type | Description | Notes
454
454
  ------------- | ------------- | ------------- | -------------
455
- **batch_id** | **String**| Batch ID |
456
455
  **process_batch_request_body** | [**ProcessBatchRequestBody**](ProcessBatchRequestBody.md)| |
456
+ **batch_id** | **String**| Batch ID |
457
457
 
458
458
  ### Return type
459
459
 
@@ -471,7 +471,7 @@ Name | Type | Description | Notes
471
471
 
472
472
  ## remove_from_batch
473
473
 
474
- > String remove_from_batch(batch_id, remove_from_batch_request_body)
474
+ > String remove_from_batch(remove_from_batch_request_body, batch_id)
475
475
 
476
476
  Remove From Batch
477
477
 
@@ -491,12 +491,12 @@ ShipEngine.configure do |config|
491
491
  end
492
492
 
493
493
  api_instance = ShipEngine::BatchesApi.new
494
- batch_id = 'batch_id_example' # String | Batch ID
495
494
  remove_from_batch_request_body = ShipEngine::RemoveFromBatchRequestBody.new # RemoveFromBatchRequestBody |
495
+ batch_id = 'batch_id_example' # String | Batch ID
496
496
 
497
497
  begin
498
498
  #Remove From Batch
499
- result = api_instance.remove_from_batch(batch_id, remove_from_batch_request_body)
499
+ result = api_instance.remove_from_batch(remove_from_batch_request_body, batch_id)
500
500
  p result
501
501
  rescue ShipEngine::ApiError => e
502
502
  puts "Exception when calling BatchesApi->remove_from_batch: #{e}"
@@ -508,8 +508,8 @@ end
508
508
 
509
509
  Name | Type | Description | Notes
510
510
  ------------- | ------------- | ------------- | -------------
511
- **batch_id** | **String**| Batch ID |
512
511
  **remove_from_batch_request_body** | [**RemoveFromBatchRequestBody**](RemoveFromBatchRequestBody.md)| |
512
+ **batch_id** | **String**| Batch ID |
513
513
 
514
514
  ### Return type
515
515
 
@@ -13,7 +13,7 @@ Method | HTTP request | Description
13
13
 
14
14
  ## connect_carrier
15
15
 
16
- > ConnectCarrierResponseBody connect_carrier(carrier_name, connect_carrier_request_body)
16
+ > ConnectCarrierResponseBody connect_carrier(connect_carrier_request_body, carrier_name)
17
17
 
18
18
  Connect a carrier account
19
19
 
@@ -33,12 +33,12 @@ ShipEngine.configure do |config|
33
33
  end
34
34
 
35
35
  api_instance = ShipEngine::CarrierAccountsApi.new
36
- carrier_name = ShipEngine::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
37
36
  connect_carrier_request_body = ShipEngine::ConnectCarrierRequestBody.new # ConnectCarrierRequestBody |
37
+ carrier_name = ShipEngine::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
38
38
 
39
39
  begin
40
40
  #Connect a carrier account
41
- result = api_instance.connect_carrier(carrier_name, connect_carrier_request_body)
41
+ result = api_instance.connect_carrier(connect_carrier_request_body, carrier_name)
42
42
  p result
43
43
  rescue ShipEngine::ApiError => e
44
44
  puts "Exception when calling CarrierAccountsApi->connect_carrier: #{e}"
@@ -50,8 +50,8 @@ end
50
50
 
51
51
  Name | Type | Description | Notes
52
52
  ------------- | ------------- | ------------- | -------------
53
- **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. |
54
53
  **connect_carrier_request_body** | [**ConnectCarrierRequestBody**](ConnectCarrierRequestBody.md)| |
54
+ **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. |
55
55
 
56
56
  ### Return type
57
57
 
@@ -181,7 +181,7 @@ Name | Type | Description | Notes
181
181
 
182
182
  ## update_carrier_settings
183
183
 
184
- > String update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
184
+ > String update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id)
185
185
 
186
186
  Update carrier settings
187
187
 
@@ -201,13 +201,13 @@ ShipEngine.configure do |config|
201
201
  end
202
202
 
203
203
  api_instance = ShipEngine::CarrierAccountsApi.new
204
+ update_carrier_settings_request_body = ShipEngine::UpdateCarrierSettingsRequestBody.new # UpdateCarrierSettingsRequestBody |
204
205
  carrier_name = ShipEngine::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
205
206
  carrier_id = 'se-28529731' # String | Carrier ID
206
- update_carrier_settings_request_body = ShipEngine::UpdateCarrierSettingsRequestBody.new # UpdateCarrierSettingsRequestBody |
207
207
 
208
208
  begin
209
209
  #Update carrier settings
210
- result = api_instance.update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
210
+ result = api_instance.update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id)
211
211
  p result
212
212
  rescue ShipEngine::ApiError => e
213
213
  puts "Exception when calling CarrierAccountsApi->update_carrier_settings: #{e}"
@@ -219,9 +219,9 @@ end
219
219
 
220
220
  Name | Type | Description | Notes
221
221
  ------------- | ------------- | ------------- | -------------
222
+ **update_carrier_settings_request_body** | [**UpdateCarrierSettingsRequestBody**](UpdateCarrierSettingsRequestBody.md)| |
222
223
  **carrier_name** | [**CarrierNameWithSettings**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. |
223
224
  **carrier_id** | **String**| Carrier ID |
224
- **update_carrier_settings_request_body** | [**UpdateCarrierSettingsRequestBody**](UpdateCarrierSettingsRequestBody.md)| |
225
225
 
226
226
  ### Return type
227
227
 
@@ -15,7 +15,7 @@ Method | HTTP request | Description
15
15
 
16
16
  ## add_funds_to_carrier
17
17
 
18
- > AddFundsToCarrierResponseBody add_funds_to_carrier(carrier_id, add_funds_to_carrier_request_body)
18
+ > AddFundsToCarrierResponseBody add_funds_to_carrier(add_funds_to_carrier_request_body, carrier_id)
19
19
 
20
20
  Add Funds To Carrier
21
21
 
@@ -35,12 +35,12 @@ ShipEngine.configure do |config|
35
35
  end
36
36
 
37
37
  api_instance = ShipEngine::CarriersApi.new
38
- carrier_id = 'se-28529731' # String | Carrier ID
39
38
  add_funds_to_carrier_request_body = ShipEngine::AddFundsToCarrierRequestBody.new # AddFundsToCarrierRequestBody |
39
+ carrier_id = 'se-28529731' # String | Carrier ID
40
40
 
41
41
  begin
42
42
  #Add Funds To Carrier
43
- result = api_instance.add_funds_to_carrier(carrier_id, add_funds_to_carrier_request_body)
43
+ result = api_instance.add_funds_to_carrier(add_funds_to_carrier_request_body, carrier_id)
44
44
  p result
45
45
  rescue ShipEngine::ApiError => e
46
46
  puts "Exception when calling CarriersApi->add_funds_to_carrier: #{e}"
@@ -52,8 +52,8 @@ end
52
52
 
53
53
  Name | Type | Description | Notes
54
54
  ------------- | ------------- | ------------- | -------------
55
- **carrier_id** | **String**| Carrier ID |
56
55
  **add_funds_to_carrier_request_body** | [**AddFundsToCarrierRequestBody**](AddFundsToCarrierRequestBody.md)| |
56
+ **carrier_id** | **String**| Carrier ID |
57
57
 
58
58
  ### Return type
59
59
 
@@ -72,7 +72,7 @@ Name | Type | Description | Notes
72
72
 
73
73
  ## create_label_from_rate
74
74
 
75
- > CreateLabelFromRateResponseBody create_label_from_rate(rate_id, create_label_from_rate_request_body)
75
+ > CreateLabelFromRateResponseBody create_label_from_rate(create_label_from_rate_request_body, rate_id)
76
76
 
77
77
  Purchase Label with Rate ID
78
78
 
@@ -92,12 +92,12 @@ ShipEngine.configure do |config|
92
92
  end
93
93
 
94
94
  api_instance = ShipEngine::LabelsApi.new
95
- rate_id = 'rate_id_example' # String | Rate ID
96
95
  create_label_from_rate_request_body = ShipEngine::CreateLabelFromRateRequestBody.new # CreateLabelFromRateRequestBody |
96
+ rate_id = 'rate_id_example' # String | Rate ID
97
97
 
98
98
  begin
99
99
  #Purchase Label with Rate ID
100
- result = api_instance.create_label_from_rate(rate_id, create_label_from_rate_request_body)
100
+ result = api_instance.create_label_from_rate(create_label_from_rate_request_body, rate_id)
101
101
  p result
102
102
  rescue ShipEngine::ApiError => e
103
103
  puts "Exception when calling LabelsApi->create_label_from_rate: #{e}"
@@ -109,8 +109,8 @@ end
109
109
 
110
110
  Name | Type | Description | Notes
111
111
  ------------- | ------------- | ------------- | -------------
112
- **rate_id** | **String**| Rate ID |
113
112
  **create_label_from_rate_request_body** | [**CreateLabelFromRateRequestBody**](CreateLabelFromRateRequestBody.md)| |
113
+ **rate_id** | **String**| Rate ID |
114
114
 
115
115
  ### Return type
116
116
 
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
128
128
 
129
129
  ## create_label_from_shipment
130
130
 
131
- > CreateLabelFromShipmentResponseBody create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
131
+ > CreateLabelFromShipmentResponseBody create_label_from_shipment(create_label_from_shipment_request_body, shipment_id)
132
132
 
133
133
  Purchase Label with Shipment ID
134
134
 
@@ -148,12 +148,12 @@ ShipEngine.configure do |config|
148
148
  end
149
149
 
150
150
  api_instance = ShipEngine::LabelsApi.new
151
- shipment_id = 'shipment_id_example' # String | Shipment ID
152
151
  create_label_from_shipment_request_body = ShipEngine::CreateLabelFromShipmentRequestBody.new # CreateLabelFromShipmentRequestBody |
152
+ shipment_id = 'shipment_id_example' # String | Shipment ID
153
153
 
154
154
  begin
155
155
  #Purchase Label with Shipment ID
156
- result = api_instance.create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
156
+ result = api_instance.create_label_from_shipment(create_label_from_shipment_request_body, shipment_id)
157
157
  p result
158
158
  rescue ShipEngine::ApiError => e
159
159
  puts "Exception when calling LabelsApi->create_label_from_shipment: #{e}"
@@ -165,8 +165,8 @@ end
165
165
 
166
166
  Name | Type | Description | Notes
167
167
  ------------- | ------------- | ------------- | -------------
168
- **shipment_id** | **String**| Shipment ID |
169
168
  **create_label_from_shipment_request_body** | [**CreateLabelFromShipmentRequestBody**](CreateLabelFromShipmentRequestBody.md)| |
169
+ **shipment_id** | **String**| Shipment ID |
170
170
 
171
171
  ### Return type
172
172
 
@@ -184,7 +184,7 @@ Name | Type | Description | Notes
184
184
 
185
185
  ## create_return_label
186
186
 
187
- > CreateReturnLabelResponseBody create_return_label(label_id, create_return_label_request_body)
187
+ > CreateReturnLabelResponseBody create_return_label(create_return_label_request_body, label_id)
188
188
 
189
189
  Create a return label
190
190
 
@@ -204,12 +204,12 @@ ShipEngine.configure do |config|
204
204
  end
205
205
 
206
206
  api_instance = ShipEngine::LabelsApi.new
207
- label_id = 'label_id_example' # String | Label ID
208
207
  create_return_label_request_body = ShipEngine::CreateReturnLabelRequestBody.new # CreateReturnLabelRequestBody |
208
+ label_id = 'label_id_example' # String | Label ID
209
209
 
210
210
  begin
211
211
  #Create a return label
212
- result = api_instance.create_return_label(label_id, create_return_label_request_body)
212
+ result = api_instance.create_return_label(create_return_label_request_body, label_id)
213
213
  p result
214
214
  rescue ShipEngine::ApiError => e
215
215
  puts "Exception when calling LabelsApi->create_return_label: #{e}"
@@ -221,8 +221,8 @@ end
221
221
 
222
222
  Name | Type | Description | Notes
223
223
  ------------- | ------------- | ------------- | -------------
224
- **label_id** | **String**| Label ID |
225
224
  **create_return_label_request_body** | [**CreateReturnLabelRequestBody**](CreateReturnLabelRequestBody.md)| |
225
+ **label_id** | **String**| Label ID |
226
226
 
227
227
  ### Return type
228
228
 
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
226
226
 
227
227
  ## update_package_type
228
228
 
229
- > String update_package_type(package_id, update_package_type_request_body)
229
+ > String update_package_type(update_package_type_request_body, package_id)
230
230
 
231
231
  Update Custom Package Type By ID
232
232
 
@@ -246,12 +246,12 @@ ShipEngine.configure do |config|
246
246
  end
247
247
 
248
248
  api_instance = ShipEngine::PackageTypesApi.new
249
- package_id = 'package_id_example' # String | Package ID
250
249
  update_package_type_request_body = ShipEngine::UpdatePackageTypeRequestBody.new # UpdatePackageTypeRequestBody |
250
+ package_id = 'package_id_example' # String | Package ID
251
251
 
252
252
  begin
253
253
  #Update Custom Package Type By ID
254
- result = api_instance.update_package_type(package_id, update_package_type_request_body)
254
+ result = api_instance.update_package_type(update_package_type_request_body, package_id)
255
255
  p result
256
256
  rescue ShipEngine::ApiError => e
257
257
  puts "Exception when calling PackageTypesApi->update_package_type: #{e}"
@@ -263,8 +263,8 @@ end
263
263
 
264
264
  Name | Type | Description | Notes
265
265
  ------------- | ------------- | ------------- | -------------
266
- **package_id** | **String**| Package ID |
267
266
  **update_package_type_request_body** | [**UpdatePackageTypeRequestBody**](UpdatePackageTypeRequestBody.md)| |
267
+ **package_id** | **String**| Package ID |
268
268
 
269
269
  ### Return type
270
270
 
@@ -598,7 +598,7 @@ Name | Type | Description | Notes
598
598
 
599
599
  ## update_shipment
600
600
 
601
- > UpdateShipmentResponseBody update_shipment(shipment_id, update_shipment_request_body)
601
+ > UpdateShipmentResponseBody update_shipment(update_shipment_request_body, shipment_id)
602
602
 
603
603
  Update Shipment By ID
604
604
 
@@ -618,12 +618,12 @@ ShipEngine.configure do |config|
618
618
  end
619
619
 
620
620
  api_instance = ShipEngine::ShipmentsApi.new
621
- shipment_id = 'shipment_id_example' # String | Shipment ID
622
621
  update_shipment_request_body = ShipEngine::UpdateShipmentRequestBody.new # UpdateShipmentRequestBody |
622
+ shipment_id = 'shipment_id_example' # String | Shipment ID
623
623
 
624
624
  begin
625
625
  #Update Shipment By ID
626
- result = api_instance.update_shipment(shipment_id, update_shipment_request_body)
626
+ result = api_instance.update_shipment(update_shipment_request_body, shipment_id)
627
627
  p result
628
628
  rescue ShipEngine::ApiError => e
629
629
  puts "Exception when calling ShipmentsApi->update_shipment: #{e}"
@@ -635,8 +635,8 @@ end
635
635
 
636
636
  Name | Type | Description | Notes
637
637
  ------------- | ------------- | ------------- | -------------
638
- **shipment_id** | **String**| Shipment ID |
639
638
  **update_shipment_request_body** | [**UpdateShipmentRequestBody**](UpdateShipmentRequestBody.md)| |
639
+ **shipment_id** | **String**| Shipment ID |
640
640
 
641
641
  ### Return type
642
642
 
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
226
226
 
227
227
  ## update_warehouse
228
228
 
229
- > String update_warehouse(warehouse_id, update_warehouse_request_body)
229
+ > String update_warehouse(update_warehouse_request_body, warehouse_id)
230
230
 
231
231
  Update WareHouse By Id
232
232
 
@@ -246,12 +246,12 @@ ShipEngine.configure do |config|
246
246
  end
247
247
 
248
248
  api_instance = ShipEngine::WarehousesApi.new
249
- warehouse_id = 'warehouse_id_example' # String | Warehouse ID
250
249
  update_warehouse_request_body = ShipEngine::UpdateWarehouseRequestBody.new # UpdateWarehouseRequestBody |
250
+ warehouse_id = 'warehouse_id_example' # String | Warehouse ID
251
251
 
252
252
  begin
253
253
  #Update WareHouse By Id
254
- result = api_instance.update_warehouse(warehouse_id, update_warehouse_request_body)
254
+ result = api_instance.update_warehouse(update_warehouse_request_body, warehouse_id)
255
255
  p result
256
256
  rescue ShipEngine::ApiError => e
257
257
  puts "Exception when calling WarehousesApi->update_warehouse: #{e}"
@@ -263,8 +263,8 @@ end
263
263
 
264
264
  Name | Type | Description | Notes
265
265
  ------------- | ------------- | ------------- | -------------
266
- **warehouse_id** | **String**| Warehouse ID |
267
266
  **update_warehouse_request_body** | [**UpdateWarehouseRequestBody**](UpdateWarehouseRequestBody.md)| |
267
+ **warehouse_id** | **String**| Warehouse ID |
268
268
 
269
269
  ### Return type
270
270
 
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
226
226
 
227
227
  ## update_webhook
228
228
 
229
- > String update_webhook(webhook_id, update_webhook_request_body)
229
+ > String update_webhook(update_webhook_request_body, webhook_id)
230
230
 
231
231
  Update a Webhook
232
232
 
@@ -246,12 +246,12 @@ ShipEngine.configure do |config|
246
246
  end
247
247
 
248
248
  api_instance = ShipEngine::WebhooksApi.new
249
- webhook_id = 'webhook_id_example' # String | Webhook ID
250
249
  update_webhook_request_body = ShipEngine::UpdateWebhookRequestBody.new # UpdateWebhookRequestBody |
250
+ webhook_id = 'webhook_id_example' # String | Webhook ID
251
251
 
252
252
  begin
253
253
  #Update a Webhook
254
- result = api_instance.update_webhook(webhook_id, update_webhook_request_body)
254
+ result = api_instance.update_webhook(update_webhook_request_body, webhook_id)
255
255
  p result
256
256
  rescue ShipEngine::ApiError => e
257
257
  puts "Exception when calling WebhooksApi->update_webhook: #{e}"
@@ -263,8 +263,8 @@ end
263
263
 
264
264
  Name | Type | Description | Notes
265
265
  ------------- | ------------- | ------------- | -------------
266
- **webhook_id** | **String**| Webhook ID |
267
266
  **update_webhook_request_body** | [**UpdateWebhookRequestBody**](UpdateWebhookRequestBody.md)| |
267
+ **webhook_id** | **String**| Webhook ID |
268
268
 
269
269
  ### Return type
270
270
 
@@ -21,25 +21,29 @@ module ShipEngine
21
21
  end
22
22
  # Add to a Batch
23
23
  # Add a Shipment or Rate to a Batch
24
- # @param batch_id [String] Batch ID
25
24
  # @param add_to_batch_request_body [AddToBatchRequestBody]
25
+ # @param batch_id [String] Batch ID
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [String]
28
- def add_to_batch(batch_id, add_to_batch_request_body, opts = {})
29
- data, _status_code, _headers = add_to_batch_with_http_info(batch_id, add_to_batch_request_body, opts)
28
+ def add_to_batch(add_to_batch_request_body, batch_id, opts = {})
29
+ data, _status_code, _headers = add_to_batch_with_http_info(add_to_batch_request_body, batch_id, opts)
30
30
  data
31
31
  end
32
32
 
33
33
  # Add to a Batch
34
34
  # Add a Shipment or Rate to a Batch
35
- # @param batch_id [String] Batch ID
36
35
  # @param add_to_batch_request_body [AddToBatchRequestBody]
36
+ # @param batch_id [String] Batch ID
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
39
- def add_to_batch_with_http_info(batch_id, add_to_batch_request_body, opts = {})
39
+ def add_to_batch_with_http_info(add_to_batch_request_body, batch_id, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: BatchesApi.add_to_batch ...'
42
42
  end
43
+ # verify the required parameter 'add_to_batch_request_body' is set
44
+ if @api_client.config.client_side_validation && add_to_batch_request_body.nil?
45
+ fail ArgumentError, "Missing the required parameter 'add_to_batch_request_body' when calling BatchesApi.add_to_batch"
46
+ end
43
47
  # verify the required parameter 'batch_id' is set
44
48
  if @api_client.config.client_side_validation && batch_id.nil?
45
49
  fail ArgumentError, "Missing the required parameter 'batch_id' when calling BatchesApi.add_to_batch"
@@ -57,10 +61,6 @@ module ShipEngine
57
61
  fail ArgumentError, "invalid value for 'batch_id' when calling BatchesApi.add_to_batch, must conform to the pattern #{pattern}."
58
62
  end
59
63
 
60
- # verify the required parameter 'add_to_batch_request_body' is set
61
- if @api_client.config.client_side_validation && add_to_batch_request_body.nil?
62
- fail ArgumentError, "Missing the required parameter 'add_to_batch_request_body' when calling BatchesApi.add_to_batch"
63
- end
64
64
  # resource path
65
65
  local_var_path = '/v1/batches/{batch_id}/add'.sub('{' + 'batch_id' + '}', CGI.escape(batch_id.to_s))
66
66
 
@@ -548,25 +548,29 @@ module ShipEngine
548
548
 
549
549
  # Process Batch ID Labels
550
550
  # Process Batch ID Labels
551
- # @param batch_id [String] Batch ID
552
551
  # @param process_batch_request_body [ProcessBatchRequestBody]
552
+ # @param batch_id [String] Batch ID
553
553
  # @param [Hash] opts the optional parameters
554
554
  # @return [String]
555
- def process_batch(batch_id, process_batch_request_body, opts = {})
556
- data, _status_code, _headers = process_batch_with_http_info(batch_id, process_batch_request_body, opts)
555
+ def process_batch(process_batch_request_body, batch_id, opts = {})
556
+ data, _status_code, _headers = process_batch_with_http_info(process_batch_request_body, batch_id, opts)
557
557
  data
558
558
  end
559
559
 
560
560
  # Process Batch ID Labels
561
561
  # Process Batch ID Labels
562
- # @param batch_id [String] Batch ID
563
562
  # @param process_batch_request_body [ProcessBatchRequestBody]
563
+ # @param batch_id [String] Batch ID
564
564
  # @param [Hash] opts the optional parameters
565
565
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
566
- def process_batch_with_http_info(batch_id, process_batch_request_body, opts = {})
566
+ def process_batch_with_http_info(process_batch_request_body, batch_id, opts = {})
567
567
  if @api_client.config.debugging
568
568
  @api_client.config.logger.debug 'Calling API: BatchesApi.process_batch ...'
569
569
  end
570
+ # verify the required parameter 'process_batch_request_body' is set
571
+ if @api_client.config.client_side_validation && process_batch_request_body.nil?
572
+ fail ArgumentError, "Missing the required parameter 'process_batch_request_body' when calling BatchesApi.process_batch"
573
+ end
570
574
  # verify the required parameter 'batch_id' is set
571
575
  if @api_client.config.client_side_validation && batch_id.nil?
572
576
  fail ArgumentError, "Missing the required parameter 'batch_id' when calling BatchesApi.process_batch"
@@ -584,10 +588,6 @@ module ShipEngine
584
588
  fail ArgumentError, "invalid value for 'batch_id' when calling BatchesApi.process_batch, must conform to the pattern #{pattern}."
585
589
  end
586
590
 
587
- # verify the required parameter 'process_batch_request_body' is set
588
- if @api_client.config.client_side_validation && process_batch_request_body.nil?
589
- fail ArgumentError, "Missing the required parameter 'process_batch_request_body' when calling BatchesApi.process_batch"
590
- end
591
591
  # resource path
592
592
  local_var_path = '/v1/batches/{batch_id}/process/labels'.sub('{' + 'batch_id' + '}', CGI.escape(batch_id.to_s))
593
593
 
@@ -631,25 +631,29 @@ module ShipEngine
631
631
 
632
632
  # Remove From Batch
633
633
  # Remove a shipment or rate from a batch
634
- # @param batch_id [String] Batch ID
635
634
  # @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
635
+ # @param batch_id [String] Batch ID
636
636
  # @param [Hash] opts the optional parameters
637
637
  # @return [String]
638
- def remove_from_batch(batch_id, remove_from_batch_request_body, opts = {})
639
- data, _status_code, _headers = remove_from_batch_with_http_info(batch_id, remove_from_batch_request_body, opts)
638
+ def remove_from_batch(remove_from_batch_request_body, batch_id, opts = {})
639
+ data, _status_code, _headers = remove_from_batch_with_http_info(remove_from_batch_request_body, batch_id, opts)
640
640
  data
641
641
  end
642
642
 
643
643
  # Remove From Batch
644
644
  # Remove a shipment or rate from a batch
645
- # @param batch_id [String] Batch ID
646
645
  # @param remove_from_batch_request_body [RemoveFromBatchRequestBody]
646
+ # @param batch_id [String] Batch ID
647
647
  # @param [Hash] opts the optional parameters
648
648
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
649
- def remove_from_batch_with_http_info(batch_id, remove_from_batch_request_body, opts = {})
649
+ def remove_from_batch_with_http_info(remove_from_batch_request_body, batch_id, opts = {})
650
650
  if @api_client.config.debugging
651
651
  @api_client.config.logger.debug 'Calling API: BatchesApi.remove_from_batch ...'
652
652
  end
653
+ # verify the required parameter 'remove_from_batch_request_body' is set
654
+ if @api_client.config.client_side_validation && remove_from_batch_request_body.nil?
655
+ fail ArgumentError, "Missing the required parameter 'remove_from_batch_request_body' when calling BatchesApi.remove_from_batch"
656
+ end
653
657
  # verify the required parameter 'batch_id' is set
654
658
  if @api_client.config.client_side_validation && batch_id.nil?
655
659
  fail ArgumentError, "Missing the required parameter 'batch_id' when calling BatchesApi.remove_from_batch"
@@ -667,10 +671,6 @@ module ShipEngine
667
671
  fail ArgumentError, "invalid value for 'batch_id' when calling BatchesApi.remove_from_batch, must conform to the pattern #{pattern}."
668
672
  end
669
673
 
670
- # verify the required parameter 'remove_from_batch_request_body' is set
671
- if @api_client.config.client_side_validation && remove_from_batch_request_body.nil?
672
- fail ArgumentError, "Missing the required parameter 'remove_from_batch_request_body' when calling BatchesApi.remove_from_batch"
673
- end
674
674
  # resource path
675
675
  local_var_path = '/v1/batches/{batch_id}/remove'.sub('{' + 'batch_id' + '}', CGI.escape(batch_id.to_s))
676
676