ship_engine 1.0.0 → 1.0.5

data/docs/InsuranceProvider.md

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

data/docs/InternationalShipmentOptions.md

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

data/docs/Label.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Label
+# ShipEngine::Label
 
 ## Properties
 
@@ -41,9 +41,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::Label.new(label_id: null,
+instance = ShipEngine::Label.new(label_id: null,
                                  status: null,
                                  shipment_id: null,
                                  shipment: null,

data/docs/LabelChargeEvent.md

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

data/docs/LabelDownload.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LabelDownload
+# ShipEngine::LabelDownload
 
 ## Properties
 
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'OpenapiClient'
+require 'ShipEngine'
 
-instance = OpenapiClient::LabelDownload.new(href: null,
+instance = ShipEngine::LabelDownload.new(href: null,
                                  pdf: null,
                                  png: null,
                                  zpl: null)

data/docs/LabelDownloadType.md

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

data/docs/LabelFormat.md

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

data/docs/LabelLayout.md

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

data/docs/LabelMessages.md

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

data/docs/LabelStatus.md

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

data/docs/LabelsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LabelsApi
+# ShipEngine::LabelsApi
 
 All URIs are relative to *https://api.shipengine.com*
 
@@ -28,23 +28,23 @@ Purchase and print a label for shipment
 
 ```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::LabelsApi.new
-create_label_request_body = OpenapiClient::CreateLabelRequestBody.new # CreateLabelRequestBody | 
+api_instance = ShipEngine::LabelsApi.new
+create_label_request_body = ShipEngine::CreateLabelRequestBody.new # CreateLabelRequestBody | 
 
 begin
   #Purchase Label
   result = api_instance.create_label(create_label_request_body)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->create_label: #{e}"
 end
 ```
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 ## create_label_from_rate
 
-> CreateLabelFromRateResponseBody create_label_from_rate(rate_id, create_label_from_rate_request_body)
+> CreateLabelFromRateResponseBody create_label_from_rate(create_label_from_rate_request_body, rate_id)
 
 Purchase Label with Rate ID
 
@@ -82,24 +82,24 @@ When retrieving rates for shipments using the `/rates` endpoint, the returned in
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
+create_label_from_rate_request_body = ShipEngine::CreateLabelFromRateRequestBody.new # CreateLabelFromRateRequestBody | 
 rate_id = 'rate_id_example' # String | Rate ID
-create_label_from_rate_request_body = OpenapiClient::CreateLabelFromRateRequestBody.new # CreateLabelFromRateRequestBody | 
 
 begin
   #Purchase Label with Rate ID
-  result = api_instance.create_label_from_rate(rate_id, create_label_from_rate_request_body)
+  result = api_instance.create_label_from_rate(create_label_from_rate_request_body, rate_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->create_label_from_rate: #{e}"
 end
 ```
@@ -109,8 +109,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **rate_id** | **String**| Rate ID | 
  **create_label_from_rate_request_body** | [**CreateLabelFromRateRequestBody**](CreateLabelFromRateRequestBody.md)|  | 
+ **rate_id** | **String**| Rate ID | 
 
 ### Return type
 
@@ -128,7 +128,7 @@ Name | Type | Description  | Notes
 
 ## create_label_from_shipment
 
-> CreateLabelFromShipmentResponseBody create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
+> CreateLabelFromShipmentResponseBody create_label_from_shipment(create_label_from_shipment_request_body, shipment_id)
 
 Purchase Label with Shipment ID
 
@@ -138,24 +138,24 @@ Purchase a label using a shipment ID that has already been created with the desi
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
+create_label_from_shipment_request_body = ShipEngine::CreateLabelFromShipmentRequestBody.new # CreateLabelFromShipmentRequestBody | 
 shipment_id = 'shipment_id_example' # String | Shipment ID
-create_label_from_shipment_request_body = OpenapiClient::CreateLabelFromShipmentRequestBody.new # CreateLabelFromShipmentRequestBody | 
 
 begin
   #Purchase Label with Shipment ID
-  result = api_instance.create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
+  result = api_instance.create_label_from_shipment(create_label_from_shipment_request_body, shipment_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->create_label_from_shipment: #{e}"
 end
 ```
@@ -165,8 +165,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **shipment_id** | **String**| Shipment ID | 
  **create_label_from_shipment_request_body** | [**CreateLabelFromShipmentRequestBody**](CreateLabelFromShipmentRequestBody.md)|  | 
+ **shipment_id** | **String**| Shipment ID | 
 
 ### Return type
 
@@ -184,7 +184,7 @@ Name | Type | Description  | Notes
 
 ## create_return_label
 
-> CreateReturnLabelResponseBody create_return_label(label_id, create_return_label_request_body)
+> CreateReturnLabelResponseBody create_return_label(create_return_label_request_body, label_id)
 
 Create a return label
 
@@ -194,24 +194,24 @@ Create a return label
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
+create_return_label_request_body = ShipEngine::CreateReturnLabelRequestBody.new # CreateReturnLabelRequestBody | 
 label_id = 'label_id_example' # String | Label ID
-create_return_label_request_body = OpenapiClient::CreateReturnLabelRequestBody.new # CreateReturnLabelRequestBody | 
 
 begin
   #Create a return label
-  result = api_instance.create_return_label(label_id, create_return_label_request_body)
+  result = api_instance.create_return_label(create_return_label_request_body, label_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->create_return_label: #{e}"
 end
 ```
@@ -221,8 +221,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **label_id** | **String**| Label ID | 
  **create_return_label_request_body** | [**CreateReturnLabelRequestBody**](CreateReturnLabelRequestBody.md)|  | 
+ **label_id** | **String**| Label ID | 
 
 ### Return type
 
@@ -250,26 +250,26 @@ Find a label by using the external shipment id that was used during label creati
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
 external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String | 
 opts = {
-  label_download_type: OpenapiClient::LabelDownloadType.new # LabelDownloadType | 
+  label_download_type: ShipEngine::LabelDownloadType.new # LabelDownloadType | 
 }
 
 begin
   #Get Label By External Shipment ID
   result = api_instance.get_label_by_external_shipment_id(external_shipment_id, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->get_label_by_external_shipment_id: #{e}"
 end
 ```
@@ -308,26 +308,26 @@ Retrieve information for individual labels.
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
 label_id = 'label_id_example' # String | Label ID
 opts = {
-  label_download_type: OpenapiClient::LabelDownloadType.new # LabelDownloadType | 
+  label_download_type: ShipEngine::LabelDownloadType.new # LabelDownloadType | 
 }
 
 begin
   #Get Label By ID
   result = api_instance.get_label_by_id(label_id, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->get_label_by_id: #{e}"
 end
 ```
@@ -366,23 +366,23 @@ Retrieve the label's 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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
 label_id = 'label_id_example' # String | Label ID
 
 begin
   #Get Label Tracking Information
   result = api_instance.get_tracking_log_from_label(label_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->get_tracking_log_from_label: #{e}"
 end
 ```
@@ -420,18 +420,18 @@ This endpoint returns a list of labels that you've [created](https://www.shipeng
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
 opts = {
-  label_status: OpenapiClient::LabelStatus.new, # LabelStatus | Only return labels that are currently in the specified status
+  label_status: ShipEngine::LabelStatus.new, # LabelStatus | Only return labels that are currently in the specified status
   service_code: 'usps_first_class_mail', # String | Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)
   carrier_id: 'carrier_id_example', # String | Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)
   tracking_number: '9.405511899223197E+21', # String | Only return labels with a specific tracking number
@@ -443,7 +443,7 @@ opts = {
   created_at_end: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Only return labels that were created on or before a specific date/time
   page: 1, # Integer | Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned. 
   page_size: 25, # Integer | The number of results to return per response.
-  sort_dir: OpenapiClient::SortDir.new, # SortDir | Controls the sort order of the query.
+  sort_dir: ShipEngine::SortDir.new, # SortDir | Controls the sort order of the query.
   sort_by: 'created_at' # String | Controls which field the query is sorted by.
 }
 
@@ -451,7 +451,7 @@ begin
   #List labels
   result = api_instance.list_labels(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->list_labels: #{e}"
 end
 ```
@@ -502,23 +502,23 @@ Void a label by ID to get a refund.
 
 ```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::LabelsApi.new
+api_instance = ShipEngine::LabelsApi.new
 label_id = 'label_id_example' # String | Label ID
 
 begin
   #Void a Label By ID
   result = api_instance.void_label(label_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue ShipEngine::ApiError => e
   puts "Exception when calling LabelsApi->void_label: #{e}"
 end
 ```