ship_engine 1.0.0 → 1.0.5

data/docs/Rate.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Rate
+# ShipEngine::Rate
 
 ## Properties
 
@@ -33,9 +33,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Rate.new(rate_id: null,
+instance = ShipEngine::Rate.new(rate_id: null,
                                  rate_type: null,
                                  carrier_id: null,
                                  shipping_amount: null,

data/docs/RateEstimateByCarrierId.md

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

data/docs/RateEstimateByCarrierIds.md

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

data/docs/RateEstimateOptions.md

@@ -1,4 +1,4 @@
-# OpenapiClient::RateEstimateOptions
+# ShipEngine::RateEstimateOptions
 
 ## Properties
 
@@ -21,9 +21,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::RateEstimateOptions.new(from_country_code: null,
+instance = ShipEngine::RateEstimateOptions.new(from_country_code: null,
                                  from_postal_code: null,
                                  from_city_locality: Austin,
                                  from_state_province: Austin,

data/docs/RateRequestBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::RateRequestBody
+# ShipEngine::RateRequestBody
 
 ## Properties
 
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::RateRequestBody.new(carrier_ids: null,
+instance = ShipEngine::RateRequestBody.new(carrier_ids: null,
                                  package_types: null,
                                  service_codes: null,
                                  calculate_tax_amount: null,

data/docs/RateRequestByShipmentIds.md

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

data/docs/RateRequestByShipments.md

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

data/docs/RateRequestOptions.md

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

data/docs/RateRequestRateOptions.md

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

data/docs/RateResponse.md

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

data/docs/RateResponseStatus.md

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

data/docs/RateType.md

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

data/docs/RatesApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::RatesApi
+# ShipEngine::RatesApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -23,23 +23,23 @@ It's not uncommon that you want to give your customer the choice between whether
 
 ```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::RatesApi.new
-calculate_rates_request_body = OpenapiClient::CalculateRatesRequestBody.new # CalculateRatesRequestBody | 
+api_instance = ShipEngine::RatesApi.new
+calculate_rates_request_body = ShipEngine::CalculateRatesRequestBody.new # CalculateRatesRequestBody | 
 
 begin
   #Get Shipping Rates
   result = api_instance.calculate_rates(calculate_rates_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling RatesApi->calculate_rates: #{e}"
 end
 ```
@@ -77,23 +77,23 @@ Get Bulk Shipment Rates
 
 ```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::RatesApi.new
-compare_bulk_rates_request_body = OpenapiClient::CompareBulkRatesRequestBody.new # CompareBulkRatesRequestBody | 
+api_instance = ShipEngine::RatesApi.new
+compare_bulk_rates_request_body = ShipEngine::CompareBulkRatesRequestBody.new # CompareBulkRatesRequestBody | 
 
 begin
   #Get Bulk Rates
   result = api_instance.compare_bulk_rates(compare_bulk_rates_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling RatesApi->compare_bulk_rates: #{e}"
 end
 ```
@@ -131,23 +131,23 @@ Get Rate Estimates
 
 ```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::RatesApi.new
-estimate_rates_request_body = OpenapiClient::EstimateRatesRequestBody.new # EstimateRatesRequestBody | 
+api_instance = ShipEngine::RatesApi.new
+estimate_rates_request_body = ShipEngine::EstimateRatesRequestBody.new # EstimateRatesRequestBody | 
 
 begin
   #Estimate Rates
   result = api_instance.estimate_rates(estimate_rates_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling RatesApi->estimate_rates: #{e}"
 end
 ```
@@ -185,23 +185,23 @@ Retrieve a previously queried rate by 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::RatesApi.new
+api_instance = ShipEngine::RatesApi.new
 rate_id = 'rate_id_example' # String | Rate ID
 
 begin
   #Get Rate By ID
   result = api_instance.get_rate_by_id(rate_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling RatesApi->get_rate_by_id: #{e}"
 end
 ```

data/docs/RatesInformation.md

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

data/docs/RecognizedEntity.md

@@ -1,4 +1,4 @@
-# OpenapiClient::RecognizedEntity
+# ShipEngine::RecognizedEntity
 
 ## Properties
 
@@ -14,9 +14,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::RecognizedEntity.new(type: null,
+instance = ShipEngine::RecognizedEntity.new(type: null,
                                  score: null,
                                  text: null,
                                  start_index: null,

data/docs/RemoveFromBatchRequestBody.md

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

data/docs/ResponseMessage.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ResponseMessage
+# ShipEngine::ResponseMessage
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ResponseMessage.new(code: null,
+instance = ShipEngine::ResponseMessage.new(code: null,
                                  message: Invalid Postal Code,
                                  type: null,
                                  detail_code: null)

data/docs/Service.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Service
+# ShipEngine::Service
 
 ## Properties
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Service.new(carrier_id: null,
+instance = ShipEngine::Service.new(carrier_id: null,
                                  carrier_code: null,
                                  service_code: usps_media_mail,
                                  name: USPS First Class Mail,

data/docs/Shipment.md

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