ship_engine 1.0.0 → 1.0.5

data/docs/OptionalLink.md

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

data/docs/OrderSourceName.md

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

data/docs/Package.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Package
+# ShipEngine::Package
 
 ## Properties
 
@@ -15,9 +15,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Package.new(package_code: null,
+instance = ShipEngine::Package.new(package_code: null,
                                  weight: null,
                                  dimensions: null,
                                  insured_value: null,

data/docs/PackageContents.md

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

data/docs/PackageType.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PackageType
+# ShipEngine::PackageType
 
 ## Properties
 
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::PackageType.new(package_id: null,
+instance = ShipEngine::PackageType.new(package_id: null,
                                  package_code: null,
                                  name: laptop_box,
                                  dimensions: null,

data/docs/PackageTypesApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PackageTypesApi
+# ShipEngine::PackageTypesApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -24,23 +24,23 @@ Create a custom package type to better assist in getting accurate 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::PackageTypesApi.new
-create_package_type_request_body = OpenapiClient::CreatePackageTypeRequestBody.new # CreatePackageTypeRequestBody | 
+api_instance = ShipEngine::PackageTypesApi.new
+create_package_type_request_body = ShipEngine::CreatePackageTypeRequestBody.new # CreatePackageTypeRequestBody | 
 
 begin
   #Create Custom Package Type
   result = api_instance.create_package_type(create_package_type_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling PackageTypesApi->create_package_type: #{e}"
 end
 ```
@@ -78,23 +78,23 @@ Delete a custom package using the 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::PackageTypesApi.new
+api_instance = ShipEngine::PackageTypesApi.new
 package_id = 'package_id_example' # String | Package ID
 
 begin
   #Delete A Custom Package By ID
   result = api_instance.delete_package_type(package_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling PackageTypesApi->delete_package_type: #{e}"
 end
 ```
@@ -132,23 +132,23 @@ Get Custom Package Type 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::PackageTypesApi.new
+api_instance = ShipEngine::PackageTypesApi.new
 package_id = 'package_id_example' # String | Package ID
 
 begin
   #Get Custom Package Type By ID
   result = api_instance.get_package_type_by_id(package_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling PackageTypesApi->get_package_type_by_id: #{e}"
 end
 ```
@@ -186,22 +186,22 @@ List the custom package types associated with the 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::PackageTypesApi.new
+api_instance = ShipEngine::PackageTypesApi.new
 
 begin
   #List Custom Package Types
   result = api_instance.list_package_types
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling PackageTypesApi->list_package_types: #{e}"
 end
 ```
@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
 
 ## update_package_type
 
-> String update_package_type(package_id, update_package_type_request_body)
+> String update_package_type(update_package_type_request_body, package_id)
 
 Update Custom Package Type By ID
 
@@ -236,24 +236,24 @@ Update the custom package type object 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::PackageTypesApi.new
+api_instance = ShipEngine::PackageTypesApi.new
+update_package_type_request_body = ShipEngine::UpdatePackageTypeRequestBody.new # UpdatePackageTypeRequestBody | 
 package_id = 'package_id_example' # String | Package ID
-update_package_type_request_body = OpenapiClient::UpdatePackageTypeRequestBody.new # UpdatePackageTypeRequestBody | 
 
 begin
   #Update Custom Package Type By ID
-  result = api_instance.update_package_type(package_id, update_package_type_request_body)
+  result = api_instance.update_package_type(update_package_type_request_body, package_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling PackageTypesApi->update_package_type: #{e}"
 end
 ```
@@ -263,8 +263,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **package_id** | **String**| Package ID | 
  **update_package_type_request_body** | [**UpdatePackageTypeRequestBody**](UpdatePackageTypeRequestBody.md)|  | 
+ **package_id** | **String**| Package ID | 
 
 ### Return type
 

data/docs/PagedListResponseBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PagedListResponseBody
+# ShipEngine::PagedListResponseBody
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::PagedListResponseBody.new(total: 2750,
+instance = ShipEngine::PagedListResponseBody.new(total: 2750,
                                  page: 1,
                                  pages: 4,
                                  links: null)

data/docs/PaginationLink.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PaginationLink
+# ShipEngine::PaginationLink
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::PaginationLink.new(first: null,
+instance = ShipEngine::PaginationLink.new(first: null,
                                  last: null,
                                  prev: null,
                                  _next: null)

data/docs/ParseAddressRequestBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ParseAddressRequestBody
+# ShipEngine::ParseAddressRequestBody
 
 ## Properties
 
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ParseAddressRequestBody.new(text: Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652.,
+instance = ShipEngine::ParseAddressRequestBody.new(text: Margie McMiller at 3800 North Lamar suite 200 in austin, tx.  The zip code there is 78652.,
                                  address: null)
 ```
 

data/docs/ParseAddressResponseBody.md

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

data/docs/ParseShipmentRequestBody.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ParseShipmentRequestBody
+# ShipEngine::ParseShipmentRequestBody
 
 ## Properties
 
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::ParseShipmentRequestBody.new(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.
+instance = ShipEngine::ParseShipmentRequestBody.new(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.
 ,
                                  shipment: null)
 ```

data/docs/ParseShipmentResponseBody.md

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

data/docs/PartialAddress.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PartialAddress
+# ShipEngine::PartialAddress
 
 ## Properties
 
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::PartialAddress.new(name: John Doe,
+instance = ShipEngine::PartialAddress.new(name: John Doe,
                                  phone: +1 204-253-9411 ext. 123,
                                  company_name: The Home Depot,
                                  address_line1: 1999 Bishop Grandin Blvd.,

data/docs/PartialShipment.md

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

data/docs/PaymentAmount.md

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

data/docs/ProcessBatchRequestBody.md

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

data/docs/PurchaseLabelWithoutShipment.md

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