ship_engine 1.0.0 → 1.0.5

data/docs/UpdateShipmentRequestBody.md

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

data/docs/UpdateShipmentResponseBody.md

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

data/docs/UpdateUpsSettingsRequestBody.md

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

data/docs/UpdateWarehouseRequestBody.md

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

data/docs/UpdateWebhookRequestBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UpdateWebhookRequestBody
+# ShipEngine::UpdateWebhookRequestBody
 
 ## Properties
 
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::UpdateWebhookRequestBody.new(url: https://[YOUR ENDPOINT ID].x.requestbin.com)
+instance = ShipEngine::UpdateWebhookRequestBody.new(url: https://[YOUR ENDPOINT ID].x.requestbin.com)
 ```
 
 

data/docs/UpsAccountSettings.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UpsAccountSettings
+# ShipEngine::UpsAccountSettings
 
 ## Properties
 
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::UpsAccountSettings.new(nickname: null,
+instance = ShipEngine::UpsAccountSettings.new(nickname: null,
                                  is_primary_account: null,
                                  pickup_type: null,
                                  use_carbon_neutral_shipping_program: null,

data/docs/UpsInvoice.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UpsInvoice
+# ShipEngine::UpsInvoice
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::UpsInvoice.new(invoice_date: null,
+instance = ShipEngine::UpsInvoice.new(invoice_date: null,
                                  invoice_number: null,
                                  control_id: null,
                                  invoice_amount: null)

data/docs/UpsPickupType.md

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

data/docs/UpsSettingsResponseBody.md

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

data/docs/ValidateAddress.md

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

data/docs/ValidateShipmentFields.md

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

data/docs/ValidationStatus.md

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

data/docs/VoidLabelResponseBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::VoidLabelResponseBody
+# ShipEngine::VoidLabelResponseBody
 
 ## Properties
 
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::VoidLabelResponseBody.new(approved: null,
+instance = ShipEngine::VoidLabelResponseBody.new(approved: null,
                                  message: Request for refund submitted.  This label has been voided.)
 ```
 

data/docs/Warehouse.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Warehouse
+# ShipEngine::Warehouse
 
 ## Properties
 
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Warehouse.new(warehouse_id: null,
+instance = ShipEngine::Warehouse.new(warehouse_id: null,
                                  name: Zero Cool HQ,
                                  created_at: 2019-06-25T18:12:35.583Z,
                                  origin_address: null,

data/docs/WarehousesApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::WarehousesApi
+# ShipEngine::WarehousesApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -24,23 +24,23 @@ Create a warehouse location that you can use to create shipping items by simply
 
 ```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::WarehousesApi.new
-create_warehouse_request_body = OpenapiClient::CreateWarehouseRequestBody.new # CreateWarehouseRequestBody | 
+api_instance = ShipEngine::WarehousesApi.new
+create_warehouse_request_body = ShipEngine::CreateWarehouseRequestBody.new # CreateWarehouseRequestBody | 
 
 begin
   #Create Warehouse
   result = api_instance.create_warehouse(create_warehouse_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling WarehousesApi->create_warehouse: #{e}"
 end
 ```
@@ -78,23 +78,23 @@ Delete a warehouse 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::WarehousesApi.new
+api_instance = ShipEngine::WarehousesApi.new
 warehouse_id = 'warehouse_id_example' # String | Warehouse ID
 
 begin
   #Delete Warehouse By ID
   result = api_instance.delete_warehouse(warehouse_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling WarehousesApi->delete_warehouse: #{e}"
 end
 ```
@@ -132,23 +132,23 @@ Retrieve warehouse data based on the warehouse 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::WarehousesApi.new
+api_instance = ShipEngine::WarehousesApi.new
 warehouse_id = 'warehouse_id_example' # String | Warehouse ID
 
 begin
   #Get Warehouse By Id
   result = api_instance.get_warehouse_by_id(warehouse_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling WarehousesApi->get_warehouse_by_id: #{e}"
 end
 ```
@@ -186,22 +186,22 @@ Retrieve a list of warehouses associated with 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::WarehousesApi.new
+api_instance = ShipEngine::WarehousesApi.new
 
 begin
   #List Warehouses
   result = api_instance.list_warehouses
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling WarehousesApi->list_warehouses: #{e}"
 end
 ```
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
 
 ## update_warehouse
 
-> String update_warehouse(warehouse_id, update_warehouse_request_body)
+> String update_warehouse(update_warehouse_request_body, warehouse_id)
 
 Update WareHouse By Id
 
@@ -236,24 +236,24 @@ Update Warehouse object information
 
 ```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::WarehousesApi.new
+api_instance = ShipEngine::WarehousesApi.new
+update_warehouse_request_body = ShipEngine::UpdateWarehouseRequestBody.new # UpdateWarehouseRequestBody | 
 warehouse_id = 'warehouse_id_example' # String | Warehouse ID
-update_warehouse_request_body = OpenapiClient::UpdateWarehouseRequestBody.new # UpdateWarehouseRequestBody | 
 
 begin
   #Update WareHouse By Id
-  result = api_instance.update_warehouse(warehouse_id, update_warehouse_request_body)
+  result = api_instance.update_warehouse(update_warehouse_request_body, warehouse_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling WarehousesApi->update_warehouse: #{e}"
 end
 ```
@@ -263,8 +263,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **warehouse_id** | **String**| Warehouse ID | 
  **update_warehouse_request_body** | [**UpdateWarehouseRequestBody**](UpdateWarehouseRequestBody.md)|  | 
+ **warehouse_id** | **String**| Warehouse ID | 
 
 ### Return type
 

data/docs/Webhook.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Webhook
+# ShipEngine::Webhook
 
 ## Properties
 
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Webhook.new(webhook_id: null,
+instance = ShipEngine::Webhook.new(webhook_id: null,
                                  url: https://[YOUR ENDPOINT ID].x.requestbin.com,
                                  event: null)
 ```

data/docs/WebhookEvent.md

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