ship_engine 1.0.0 → 1.0.5

data/docs/ShipmentIdRequest.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentIdRequest
+# ShipEngine::ShipmentIdRequest
 
 ## Properties
 
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentIdRequest.new(shipment_id: null)
+instance = ShipEngine::ShipmentIdRequest.new(shipment_id: null)
 ```
 
 

data/docs/ShipmentItem.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentItem
+# ShipEngine::ShipmentItem
 
 ## Properties
 
@@ -17,9 +17,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentItem.new(name: null,
+instance = ShipEngine::ShipmentItem.new(name: null,
                                  sales_order_id: null,
                                  sales_order_item_id: null,
                                  quantity: null,

data/docs/ShipmentRequest.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentRequest
+# ShipEngine::ShipmentRequest
 
 ## Properties
 
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentRequest.new(shipment: null)
+instance = ShipEngine::ShipmentRequest.new(shipment: null)
 ```
 
 

data/docs/ShipmentResponseError.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentResponseError
+# ShipEngine::ShipmentResponseError
 
 ## Properties
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentResponseError.new(error: null,
+instance = ShipEngine::ShipmentResponseError.new(error: null,
                                  shipment_id: null,
                                  external_shipment_id: null)
 ```

data/docs/ShipmentStatus.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentStatus
+# ShipEngine::ShipmentStatus
 
 ## Properties
 
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentStatus.new()
+instance = ShipEngine::ShipmentStatus.new()
 ```
 
 

data/docs/ShipmentsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentsApi
+# ShipEngine::ShipmentsApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -30,23 +30,23 @@ Mark a shipment cancelled, if it is no longer needed or being used by your organ
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 
 begin
   #Cancel a Shipment
   result = api_instance.cancel_shipments(shipment_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->cancel_shipments: #{e}"
 end
 ```
@@ -84,23 +84,23 @@ Create one or multiple shipments.
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
-create_shipments_request_body = OpenapiClient::CreateShipmentsRequestBody.new # CreateShipmentsRequestBody | 
+api_instance = ShipEngine::ShipmentsApi.new
+create_shipments_request_body = ShipEngine::CreateShipmentsRequestBody.new # CreateShipmentsRequestBody | 
 
 begin
   #Create Shipments
   result = api_instance.create_shipments(create_shipments_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->create_shipments: #{e}"
 end
 ```
@@ -138,23 +138,23 @@ Query Shipments created using your own custom ID convention using this endpint
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String | 
 
 begin
   #Get Shipment By External ID
   result = api_instance.get_shipment_by_external_id(external_shipment_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->get_shipment_by_external_id: #{e}"
 end
 ```
@@ -192,23 +192,23 @@ Get an individual shipment based on its ID
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 
 begin
   #Get Shipment By ID
   result = api_instance.get_shipment_by_id(shipment_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->get_shipment_by_id: #{e}"
 end
 ```
@@ -246,16 +246,16 @@ If there are no errors associated with this shipment then the API will return a
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 opts = {
   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. 
@@ -266,7 +266,7 @@ begin
   #Get Shipment Errors
   result = api_instance.list_shipment_errors(shipment_id, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->list_shipment_errors: #{e}"
 end
 ```
@@ -306,16 +306,16 @@ Get Rates for the shipment information associated with the shipment ID
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 opts = {
   created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z') # DateTime | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
@@ -325,7 +325,7 @@ begin
   #Get Shipment Rates
   result = api_instance.list_shipment_rates(shipment_id, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->list_shipment_rates: #{e}"
 end
 ```
@@ -364,18 +364,18 @@ Get list of Shipments
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 opts = {
-  shipment_status: OpenapiClient::ShipmentStatus.new, # ShipmentStatus | 
+  shipment_status: ShipEngine::ShipmentStatus.new, # ShipmentStatus | 
   batch_id: 'batch_id_example', # String | Batch ID
   tag: 'Letters_to_santa', # String | Search for shipments based on the custom tag added to the shipment object
   created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
@@ -385,15 +385,15 @@ opts = {
   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. 
   page_size: 25, # Integer | The number of results to return per response.
   sales_order_id: 'sales_order_id_example', # String | Sales Order ID
-  sort_dir: OpenapiClient::SortDir.new, # SortDir | Controls the sort order of the query.
-  sort_by: OpenapiClient::ShipmentsSortBy.new # ShipmentsSortBy | 
+  sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
+  sort_by: ShipEngine::ShipmentsSortBy.new # ShipmentsSortBy | 
 }
 
 begin
   #List Shipments
   result = api_instance.list_shipments(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->list_shipments: #{e}"
 end
 ```
@@ -442,23 +442,23 @@ The shipment-recognition API makes it easy for you to extract shipping data from
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 parse_shipment_request_body = {"text":"I have a 4oz package that's 5x10x14in, and I need to ship it to Margie McMiller at 3800 North Lamar suite 200 in austin, tx 78652. Please send it via USPS first class and require an adult signature. It also needs to be insured for $400.\n"} # ParseShipmentRequestBody | The only required field is `text`, which is the text to be parsed. You can optionally also provide a `shipment` containing any already-known values. For example, you probably already know the `ship_from` address, and you may also already know what carrier and service you want to use. 
 
 begin
   #Parse shipping info
   result = api_instance.parse_shipment(parse_shipment_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->parse_shipment: #{e}"
 end
 ```
@@ -496,16 +496,16 @@ Add a tag to the shipment object
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 tag_name = 'tag_name_example' # String | 
 
@@ -513,7 +513,7 @@ begin
   #Add Tag to Shipment
   result = api_instance.tag_shipment(shipment_id, tag_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->tag_shipment: #{e}"
 end
 ```
@@ -552,16 +552,16 @@ Remove an existing tag from the Shipment object
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
 shipment_id = 'shipment_id_example' # String | Shipment ID
 tag_name = 'tag_name_example' # String | 
 
@@ -569,7 +569,7 @@ begin
   #Remove Tag from Shipment
   result = api_instance.untag_shipment(shipment_id, tag_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->untag_shipment: #{e}"
 end
 ```
@@ -598,7 +598,7 @@ Name | Type | Description  | Notes
 
 ## update_shipment
 
-> UpdateShipmentResponseBody update_shipment(shipment_id, update_shipment_request_body)
+> UpdateShipmentResponseBody update_shipment(update_shipment_request_body, shipment_id)
 
 Update Shipment By ID
 
@@ -608,24 +608,24 @@ Update a shipment object based on its ID
 
 ```ruby
 # load the gem
-require 'openapi_client'
+require 'ship_engine'
 # setup authorization
-OpenapiClient.configure do |config|
+ShipEngine.configure do |config|
   # Configure API key authorization: api_key
   config.api_key['API-Key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
   #config.api_key_prefix['API-Key'] = 'Bearer'
 end
 
-api_instance = OpenapiClient::ShipmentsApi.new
+api_instance = ShipEngine::ShipmentsApi.new
+update_shipment_request_body = ShipEngine::UpdateShipmentRequestBody.new # UpdateShipmentRequestBody | 
 shipment_id = 'shipment_id_example' # String | Shipment ID
-update_shipment_request_body = OpenapiClient::UpdateShipmentRequestBody.new # UpdateShipmentRequestBody | 
 
 begin
   #Update Shipment By ID
-  result = api_instance.update_shipment(shipment_id, update_shipment_request_body)
+  result = api_instance.update_shipment(update_shipment_request_body, shipment_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling ShipmentsApi->update_shipment: #{e}"
 end
 ```
@@ -635,8 +635,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **shipment_id** | **String**| Shipment ID | 
  **update_shipment_request_body** | [**UpdateShipmentRequestBody**](UpdateShipmentRequestBody.md)|  | 
+ **shipment_id** | **String**| Shipment ID | 
 
 ### Return type
 

data/docs/ShipmentsSortBy.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ShipmentsSortBy
+# ShipEngine::ShipmentsSortBy
 
 ## Properties
 
@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ShipmentsSortBy.new()
+instance = ShipEngine::ShipmentsSortBy.new()
 ```