ship_engine 1.0.0 → 1.0.5

data/docs/BatchesSortBy.md

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

data/docs/BillToParty.md

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

data/docs/BulkRate.md

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

data/docs/CalculateRatesRequestBody.md

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

data/docs/CalculateRatesResponseBody.md

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

data/docs/Carrier.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Carrier
+# ShipEngine::Carrier
 
 ## Properties
 
@@ -21,9 +21,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Carrier.new(carrier_id: null,
+instance = ShipEngine::Carrier.new(carrier_id: null,
                                  carrier_code: null,
                                  account_number: account_570827,
                                  requires_funded_amount: null,

data/docs/CarrierAccountsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CarrierAccountsApi
+# ShipEngine::CarrierAccountsApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -13,7 +13,7 @@ Method | HTTP request | Description
 
 ## connect_carrier
 
-> ConnectCarrierResponseBody connect_carrier(carrier_name, connect_carrier_request_body)
+> ConnectCarrierResponseBody connect_carrier(connect_carrier_request_body, carrier_name)
 
 Connect a carrier account
 
@@ -23,24 +23,24 @@ Connect a carrier account
 
 ```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::CarrierAccountsApi.new
-carrier_name = OpenapiClient::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
-connect_carrier_request_body = OpenapiClient::ConnectCarrierRequestBody.new # ConnectCarrierRequestBody | 
+api_instance = ShipEngine::CarrierAccountsApi.new
+connect_carrier_request_body = ShipEngine::ConnectCarrierRequestBody.new # ConnectCarrierRequestBody | 
+carrier_name = ShipEngine::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
 
 begin
   #Connect a carrier account
-  result = api_instance.connect_carrier(carrier_name, connect_carrier_request_body)
+  result = api_instance.connect_carrier(connect_carrier_request_body, carrier_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarrierAccountsApi->connect_carrier: #{e}"
 end
 ```
@@ -50,8 +50,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
  **connect_carrier_request_body** | [**ConnectCarrierRequestBody**](ConnectCarrierRequestBody.md)|  | 
+ **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
 
 ### Return type
 
@@ -79,24 +79,24 @@ Disconnect a carrier
 
 ```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::CarrierAccountsApi.new
-carrier_name = OpenapiClient::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+api_instance = ShipEngine::CarrierAccountsApi.new
+carrier_name = ShipEngine::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #Disconnect a carrier
   result = api_instance.disconnect_carrier(carrier_name, carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarrierAccountsApi->disconnect_carrier: #{e}"
 end
 ```
@@ -135,24 +135,24 @@ Get carrier settings
 
 ```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::CarrierAccountsApi.new
-carrier_name = OpenapiClient::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+api_instance = ShipEngine::CarrierAccountsApi.new
+carrier_name = ShipEngine::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #Get carrier settings
   result = api_instance.get_carrier_settings(carrier_name, carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarrierAccountsApi->get_carrier_settings: #{e}"
 end
 ```
@@ -181,7 +181,7 @@ Name | Type | Description  | Notes
 
 ## update_carrier_settings
 
-> String update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
+> String update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id)
 
 Update carrier settings
 
@@ -191,25 +191,25 @@ Update carrier settings
 
 ```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::CarrierAccountsApi.new
-carrier_name = OpenapiClient::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+api_instance = ShipEngine::CarrierAccountsApi.new
+update_carrier_settings_request_body = ShipEngine::UpdateCarrierSettingsRequestBody.new # UpdateCarrierSettingsRequestBody | 
+carrier_name = ShipEngine::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
 carrier_id = 'se-28529731' # String | Carrier ID
-update_carrier_settings_request_body = OpenapiClient::UpdateCarrierSettingsRequestBody.new # UpdateCarrierSettingsRequestBody | 
 
 begin
   #Update carrier settings
-  result = api_instance.update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
+  result = api_instance.update_carrier_settings(update_carrier_settings_request_body, carrier_name, carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarrierAccountsApi->update_carrier_settings: #{e}"
 end
 ```
@@ -219,9 +219,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **update_carrier_settings_request_body** | [**UpdateCarrierSettingsRequestBody**](UpdateCarrierSettingsRequestBody.md)|  | 
  **carrier_name** | [**CarrierNameWithSettings**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
  **carrier_id** | **String**| Carrier ID | 
- **update_carrier_settings_request_body** | [**UpdateCarrierSettingsRequestBody**](UpdateCarrierSettingsRequestBody.md)|  | 
 
 ### Return type
 

data/docs/CarrierAdvancedOption.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CarrierAdvancedOption
+# ShipEngine::CarrierAdvancedOption
 
 ## Properties
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::CarrierAdvancedOption.new(name: contains_alcohol,
+instance = ShipEngine::CarrierAdvancedOption.new(name: contains_alcohol,
                                  default_value: false,
                                  description: null)
 ```

data/docs/CarrierName.md

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

data/docs/CarrierNameWithSettings.md

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

data/docs/CarriersApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CarriersApi
+# ShipEngine::CarriersApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## add_funds_to_carrier
 
-> AddFundsToCarrierResponseBody add_funds_to_carrier(carrier_id, add_funds_to_carrier_request_body)
+> AddFundsToCarrierResponseBody add_funds_to_carrier(add_funds_to_carrier_request_body, carrier_id)
 
 Add Funds To Carrier
 
@@ -25,24 +25,24 @@ Add Funds To A Carrier
 
 ```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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
+add_funds_to_carrier_request_body = ShipEngine::AddFundsToCarrierRequestBody.new # AddFundsToCarrierRequestBody | 
 carrier_id = 'se-28529731' # String | Carrier ID
-add_funds_to_carrier_request_body = OpenapiClient::AddFundsToCarrierRequestBody.new # AddFundsToCarrierRequestBody | 
 
 begin
   #Add Funds To Carrier
-  result = api_instance.add_funds_to_carrier(carrier_id, add_funds_to_carrier_request_body)
+  result = api_instance.add_funds_to_carrier(add_funds_to_carrier_request_body, carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->add_funds_to_carrier: #{e}"
 end
 ```
@@ -52,8 +52,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **carrier_id** | **String**| Carrier ID | 
  **add_funds_to_carrier_request_body** | [**AddFundsToCarrierRequestBody**](AddFundsToCarrierRequestBody.md)|  | 
+ **carrier_id** | **String**| Carrier ID | 
 
 ### Return type
 
@@ -81,23 +81,23 @@ Retrive carrier info by 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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #Get Carrier By ID
   result = api_instance.get_carrier_by_id(carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->get_carrier_by_id: #{e}"
 end
 ```
@@ -135,23 +135,23 @@ Get a list of the options available for the carrier
 
 ```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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #Get Carrier Options
   result = api_instance.get_carrier_options(carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->get_carrier_options: #{e}"
 end
 ```
@@ -189,23 +189,23 @@ List the package types associated with the carrier
 
 ```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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #List Carrier Package Types
   result = api_instance.list_carrier_package_types(carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->list_carrier_package_types: #{e}"
 end
 ```
@@ -243,23 +243,23 @@ List the services associated with the carrier 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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
 carrier_id = 'se-28529731' # String | Carrier ID
 
 begin
   #List Carrier Services
   result = api_instance.list_carrier_services(carrier_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->list_carrier_services: #{e}"
 end
 ```
@@ -297,22 +297,22 @@ List all carriers that have been added to this account
 
 ```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::CarriersApi.new
+api_instance = ShipEngine::CarriersApi.new
 
 begin
   #List Carriers
   result = api_instance.list_carriers
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling CarriersApi->list_carriers: #{e}"
 end
 ```