ship_engine 1.0.0 → 1.0.5

data/docs/SmartPostHub.md

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

data/docs/SortDir.md

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

data/docs/Tag.md

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

data/docs/TagShipmentResponseBody.md

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

data/docs/TagsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TagsApi
+# ShipEngine::TagsApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -23,23 +23,23 @@ Create a new Tag for customizing how you track your 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::TagsApi.new
+api_instance = ShipEngine::TagsApi.new
 tag_name = 'tag_name_example' # String | 
 
 begin
   #Create a New Tag
   result = api_instance.create_tag(tag_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TagsApi->create_tag: #{e}"
 end
 ```
@@ -77,23 +77,23 @@ Delete a tag that is no longer needed
 
 ```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::TagsApi.new
+api_instance = ShipEngine::TagsApi.new
 tag_name = 'tag_name_example' # String | 
 
 begin
   #Delete Tag
   result = api_instance.delete_tag(tag_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TagsApi->delete_tag: #{e}"
 end
 ```
@@ -131,22 +131,22 @@ Get a list of all tags associated with an 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::TagsApi.new
+api_instance = ShipEngine::TagsApi.new
 
 begin
   #Get Tags
   result = api_instance.list_tags
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TagsApi->list_tags: #{e}"
 end
 ```
@@ -181,16 +181,16 @@ Change a tag name while still keeping the relevant shipments attached to it
 
 ```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::TagsApi.new
+api_instance = ShipEngine::TagsApi.new
 tag_name = 'tag_name_example' # String | 
 new_tag_name = 'new_tag_name_example' # String | 
 
@@ -198,7 +198,7 @@ begin
   #Update Tag Name
   result = api_instance.rename_tag(tag_name, new_tag_name)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TagsApi->rename_tag: #{e}"
 end
 ```

data/docs/TrackEvent.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackEvent
+# ShipEngine::TrackEvent
 
 ## Properties
 
@@ -20,9 +20,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::TrackEvent.new(occurred_at: null,
+instance = ShipEngine::TrackEvent.new(occurred_at: null,
                                  carrier_occurred_at: null,
                                  description: Delivered, In/At Mailbox,
                                  city_locality: AUSTIN,

data/docs/TrackingApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackingApi
+# ShipEngine::TrackingApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -22,16 +22,16 @@ Retrieve package tracking 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::TrackingApi.new
+api_instance = ShipEngine::TrackingApi.new
 opts = {
   carrier_code: 'stamps_com', # String | Carrier code used to retrieve tracking information
   tracking_number: '9.405511899223197E+21' # String | The tracking number associated with a shipment
@@ -41,7 +41,7 @@ begin
   #Get Tracking Information
   result = api_instance.get_tracking_log(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TrackingApi->get_tracking_log: #{e}"
 end
 ```
@@ -80,16 +80,16 @@ Allows you to subscribe to tracking updates for a package. You specify the carri
 
 ```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::TrackingApi.new
+api_instance = ShipEngine::TrackingApi.new
 opts = {
   carrier_code: 'stamps_com', # String | Carrier code used to retrieve tracking information
   tracking_number: '9.405511899223197E+21' # String | The tracking number associated with a shipment
@@ -99,7 +99,7 @@ begin
   #Start Tracking a Package
   result = api_instance.start_tracking(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TrackingApi->start_tracking: #{e}"
 end
 ```
@@ -138,16 +138,16 @@ Unsubscribe from tracking updates for a package.
 
 ```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::TrackingApi.new
+api_instance = ShipEngine::TrackingApi.new
 opts = {
   carrier_code: 'stamps_com', # String | Carrier code used to retrieve tracking information
   tracking_number: '9.405511899223197E+21' # String | The tracking number associated with a shipment
@@ -157,7 +157,7 @@ begin
   #Stop Tracking a Package
   result = api_instance.stop_tracking(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling TrackingApi->stop_tracking: #{e}"
 end
 ```

data/docs/TrackingInformation.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackingInformation
+# ShipEngine::TrackingInformation
 
 ## Properties
 
@@ -18,9 +18,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::TrackingInformation.new(tracking_number: null,
+instance = ShipEngine::TrackingInformation.new(tracking_number: null,
                                  status_code: DE,
                                  status_description: Delivered,
                                  carrier_status_code: 1,

data/docs/TrackingStatus.md

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

data/docs/UpdateAmazonBuyShippingRequestBody.md

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

data/docs/UpdateCarrierSettingsRequestBody.md

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

data/docs/UpdateDhlExpressSettingsRequestBody.md

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

data/docs/UpdateFedexSettingsRequestBody.md

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

data/docs/UpdateNewgisticsSettingsRequestBody.md

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

data/docs/UpdatePackageTypeRequestBody.md

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

data/docs/UpdateShipmentFields.md

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