ship_engine 1.0.0

data/docs/InsuranceProvider.md

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

data/docs/InternationalShipmentOptions.md

@@ -0,0 +1,21 @@
+# OpenapiClient::InternationalShipmentOptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contents** | [**PackageContents**](PackageContents.md) | The type of contents in this shipment.  This may impact import duties or customs treatment. | 
+**non_delivery** | [**NonDelivery**](NonDelivery.md) | Indicates what to do if a package is unable to be delivered. | 
+**customs_items** | [**Array<CustomsItem>**](CustomsItem.md) | Customs declarations for each item in the shipment. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::InternationalShipmentOptions.new(contents: null,
+                                 non_delivery: null,
+                                 customs_items: null)
+```
+
+

data/docs/Label.md

@@ -0,0 +1,81 @@
+# OpenapiClient::Label
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label_id** | **String** | A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created.  | [optional] [readonly] 
+**status** | [**LabelStatus**](LabelStatus.md) |  | [optional] [readonly] 
+**shipment_id** | **String** | The shipment that this label is for.  ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/)  | [optional] [readonly] 
+**shipment** | [**Shipment**](Shipment.md) | The shipment information used to generate the label | [optional] 
+**ship_date** | **DateTime** | The date that the package was (or will be) shippped.  ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead.  | [optional] [readonly] 
+**created_at** | **DateTime** | The date and time that the label was created in ShipEngine. | [optional] [readonly] 
+**shipment_cost** | [**MonetaryValue**](MonetaryValue.md) | The cost of shipping, delivery confirmation, and other carrier charges.  This amount **does not** include insurance costs.  | [optional] [readonly] 
+**insurance_cost** | [**MonetaryValue**](MonetaryValue.md) | The insurance cost for this package.  Add this to the `shipment_cost` field to get the total cost.  | [optional] [readonly] 
+**tracking_number** | **String** | The tracking number for the package. Tracking number formats vary across carriers. | [optional] [readonly] 
+**is_return_label** | **Boolean** | Indicates whether this is a return label.  You may also want to set the `rma_number` so you know what is being returned.  | [optional] 
+**rma_number** | **String** | An optional Return Merchandise Authorization number.  This field is useful for return labels.  You can set it to any string value.  | [optional] 
+**is_international** | **Boolean** | Indicates whether this is an international shipment.  That is, the originating country and destination country are different.  | [optional] [readonly] 
+**batch_id** | **String** | If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch.  | [optional] [readonly] 
+**carrier_id** | **String** | The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label  | [optional] [readonly] 
+**charge_event** | [**LabelChargeEvent**](LabelChargeEvent.md) | The label charge event.  | [optional] 
+**outbound_label_id** | **String** | The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers.  | [optional] 
+**service_code** | **String** | The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.  | [optional] [readonly] 
+**test_label** | **Boolean** | Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account. | [optional] [default to false]
+**package_code** | **String** | The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc.  The code `package` indicates a custom or unknown package type.  | [optional] [readonly] 
+**validate_address** | [**ValidateAddress**](ValidateAddress.md) |  | [optional] 
+**voided** | **Boolean** | Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/)  | [optional] [readonly] 
+**voided_at** | **DateTime** | The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided  | [optional] [readonly] 
+**label_download_type** | [**LabelDownloadType**](LabelDownloadType.md) |  | [optional] 
+**label_format** | [**LabelFormat**](LabelFormat.md) | The file format that you want the label to be in.  We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats.  | [optional] 
+**label_layout** | [**LabelLayout**](LabelLayout.md) | The layout (size) that you want the label to be in.  The `label_format` determines which sizes are allowed.  `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format.  | [optional] 
+**trackable** | **Boolean** | Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`.  | [optional] [readonly] 
+**label_image_id** | **String** | The label image resource that was used to create a custom label image. | [optional] 
+**carrier_code** | **String** | The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc.  | [optional] [readonly] 
+**tracking_status** | [**TrackingStatus**](TrackingStatus.md) | The current status of the package, such as `in_transit` or `delivered` | [optional] [readonly] 
+**label_download** | [**LabelDownload**](LabelDownload.md) |  | [optional] [readonly] 
+**form_download** | [**Link**](Link.md) | The link to downlaod the customs form (a.k.a. commercial invoice) for this shipment, if any.  Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.  | [optional] [readonly] 
+**insurance_claim** | [**Link**](Link.md) | The link to submit an insurance claim for the shipment.  This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.  | [optional] [readonly] 
+**packages** | [**Array<Package>**](Package.md) | The label's package(s).  > **Note:** Some carriers only allow one package per label.  If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Label.new(label_id: null,
+                                 status: null,
+                                 shipment_id: null,
+                                 shipment: null,
+                                 ship_date: null,
+                                 created_at: null,
+                                 shipment_cost: null,
+                                 insurance_cost: null,
+                                 tracking_number: 782758401696,
+                                 is_return_label: null,
+                                 rma_number: null,
+                                 is_international: null,
+                                 batch_id: null,
+                                 carrier_id: null,
+                                 charge_event: null,
+                                 outbound_label_id: null,
+                                 service_code: null,
+                                 test_label: null,
+                                 package_code: null,
+                                 validate_address: null,
+                                 voided: null,
+                                 voided_at: null,
+                                 label_download_type: null,
+                                 label_format: null,
+                                 label_layout: null,
+                                 trackable: null,
+                                 label_image_id: null,
+                                 carrier_code: null,
+                                 tracking_status: null,
+                                 label_download: null,
+                                 form_download: null,
+                                 insurance_claim: null,
+                                 packages: null)
+```
+
+

data/docs/LabelChargeEvent.md

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

data/docs/LabelDownload.md

@@ -0,0 +1,23 @@
+# OpenapiClient::LabelDownload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | The URL of the linked resource, if any | [optional] 
+**pdf** | **String** | The URL for the pdf generated label | [optional] 
+**png** | **String** | The URL for the png generated label | [optional] 
+**zpl** | **String** | The URL for the zpl generated label | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::LabelDownload.new(href: null,
+                                 pdf: null,
+                                 png: null,
+                                 zpl: null)
+```
+
+

data/docs/LabelDownloadType.md

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

data/docs/LabelFormat.md

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

data/docs/LabelLayout.md

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

data/docs/LabelMessages.md

@@ -0,0 +1,21 @@
+# OpenapiClient::LabelMessages
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference1** | **String** | The first line of the custom label message.  Some carriers may prefix this line with something like \"REF\", \"Reference\", \"Trx Ref No.\", etc.  | [default to 'null']
+**reference2** | **String** | The second line of the custom label message.  Some carriers may prefix this line with something like \"INV\", \"Reference 2\", \"Trx Ref No.\", etc.  | [default to 'null']
+**reference3** | **String** | The third line of the custom label message.  Some carriers may prefix this line with something like \"PO\", \"Reference 3\", etc.  | [default to 'null']
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::LabelMessages.new(reference1: null,
+                                 reference2: null,
+                                 reference3: null)
+```
+
+

data/docs/LabelStatus.md

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

data/docs/LabelsApi.md

@@ -0,0 +1,545 @@
+# OpenapiClient::LabelsApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_label**](LabelsApi.md#create_label) | **POST** /v1/labels | Purchase Label
+[**create_label_from_rate**](LabelsApi.md#create_label_from_rate) | **POST** /v1/labels/rates/{rate_id} | Purchase Label with Rate ID
+[**create_label_from_shipment**](LabelsApi.md#create_label_from_shipment) | **POST** /v1/labels/shipment/{shipment_id} | Purchase Label with Shipment ID
+[**create_return_label**](LabelsApi.md#create_return_label) | **POST** /v1/labels/{label_id}/return | Create a return label
+[**get_label_by_external_shipment_id**](LabelsApi.md#get_label_by_external_shipment_id) | **GET** /v1/labels/external_shipment_id/{external_shipment_id} | Get Label By External Shipment ID
+[**get_label_by_id**](LabelsApi.md#get_label_by_id) | **GET** /v1/labels/{label_id} | Get Label By ID
+[**get_tracking_log_from_label**](LabelsApi.md#get_tracking_log_from_label) | **GET** /v1/labels/{label_id}/track | Get Label Tracking Information
+[**list_labels**](LabelsApi.md#list_labels) | **GET** /v1/labels | List labels
+[**void_label**](LabelsApi.md#void_label) | **PUT** /v1/labels/{label_id}/void | Void a Label By ID
+
+
+
+## create_label
+
+> CreateLabelResponseBody create_label(create_label_request_body)
+
+Purchase Label
+
+Purchase and print a label for shipment
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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 | 
+
+begin
+  #Purchase Label
+  result = api_instance.create_label(create_label_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->create_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_label_request_body** | [**CreateLabelRequestBody**](CreateLabelRequestBody.md)|  | 
+
+### Return type
+
+[**CreateLabelResponseBody**](CreateLabelResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_label_from_rate
+
+> CreateLabelFromRateResponseBody create_label_from_rate(rate_id, create_label_from_rate_request_body)
+
+Purchase Label with Rate ID
+
+When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly. 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+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)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->create_label_from_rate: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rate_id** | **String**| Rate ID | 
+ **create_label_from_rate_request_body** | [**CreateLabelFromRateRequestBody**](CreateLabelFromRateRequestBody.md)|  | 
+
+### Return type
+
+[**CreateLabelFromRateResponseBody**](CreateLabelFromRateResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_label_from_shipment
+
+> CreateLabelFromShipmentResponseBody create_label_from_shipment(shipment_id, create_label_from_shipment_request_body)
+
+Purchase Label with Shipment ID
+
+Purchase a label using a shipment ID that has already been created with the desired address and package info. 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+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)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->create_label_from_shipment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **shipment_id** | **String**| Shipment ID | 
+ **create_label_from_shipment_request_body** | [**CreateLabelFromShipmentRequestBody**](CreateLabelFromShipmentRequestBody.md)|  | 
+
+### Return type
+
+[**CreateLabelFromShipmentResponseBody**](CreateLabelFromShipmentResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_return_label
+
+> CreateReturnLabelResponseBody create_return_label(label_id, create_return_label_request_body)
+
+Create a return label
+
+Create a return label
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+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)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->create_return_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **String**| Label ID | 
+ **create_return_label_request_body** | [**CreateReturnLabelRequestBody**](CreateReturnLabelRequestBody.md)|  | 
+
+### Return type
+
+[**CreateReturnLabelResponseBody**](CreateReturnLabelResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_label_by_external_shipment_id
+
+> GetLabelByExternalShipmentIdResponseBody get_label_by_external_shipment_id(external_shipment_id, opts)
+
+Get Label By External Shipment ID
+
+Find a label by using the external shipment id that was used during label creation 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+external_shipment_id = '0bcb569d-1727-4ff9-ab49-b2fec0cee5ae' # String | 
+opts = {
+  label_download_type: OpenapiClient::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
+  puts "Exception when calling LabelsApi->get_label_by_external_shipment_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **external_shipment_id** | **String**|  | 
+ **label_download_type** | [**LabelDownloadType**](.md)|  | [optional] 
+
+### Return type
+
+[**GetLabelByExternalShipmentIdResponseBody**](GetLabelByExternalShipmentIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_label_by_id
+
+> GetLabelByIdResponseBody get_label_by_id(label_id, opts)
+
+Get Label By ID
+
+Retrieve information for individual labels.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+label_id = 'label_id_example' # String | Label ID
+opts = {
+  label_download_type: OpenapiClient::LabelDownloadType.new # LabelDownloadType | 
+}
+
+begin
+  #Get Label By ID
+  result = api_instance.get_label_by_id(label_id, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->get_label_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **String**| Label ID | 
+ **label_download_type** | [**LabelDownloadType**](.md)|  | [optional] 
+
+### Return type
+
+[**GetLabelByIdResponseBody**](GetLabelByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_tracking_log_from_label
+
+> GetTrackingLogFromLabelResponseBody get_tracking_log_from_label(label_id)
+
+Get Label Tracking Information
+
+Retrieve the label's tracking information
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+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
+  puts "Exception when calling LabelsApi->get_tracking_log_from_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **String**| Label ID | 
+
+### Return type
+
+[**GetTrackingLogFromLabelResponseBody**](GetTrackingLogFromLabelResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_labels
+
+> ListLabelsResponseBody list_labels(opts)
+
+List labels
+
+This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time.  By default, all labels are returned, 25 at a time, starting with the most recently created ones.  You can combine multiple filter options to narrow-down the results.  For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id` 
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+opts = {
+  label_status: OpenapiClient::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
+  batch_id: 'batch_id_example', # String | Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)
+  rate_id: 'rate_id_example', # String | Rate ID
+  shipment_id: 'shipment_id_example', # String | Shipment ID
+  warehouse_id: 'warehouse_id_example', # String | Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)
+  created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Only return labels that were created on or after a specific date/time
+  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_by: 'created_at' # String | Controls which field the query is sorted by.
+}
+
+begin
+  #List labels
+  result = api_instance.list_labels(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling LabelsApi->list_labels: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_status** | [**LabelStatus**](.md)| Only return labels that are currently in the specified status | [optional] 
+ **service_code** | **String**| Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) | [optional] 
+ **carrier_id** | **String**| Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/) | [optional] 
+ **tracking_number** | **String**| Only return labels with a specific tracking number | [optional] 
+ **batch_id** | **String**| Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/) | [optional] 
+ **rate_id** | **String**| Rate ID | [optional] 
+ **shipment_id** | **String**| Shipment ID | [optional] 
+ **warehouse_id** | **String**| Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) | [optional] 
+ **created_at_start** | **DateTime**| Only return labels that were created on or after a specific date/time | [optional] 
+ **created_at_end** | **DateTime**| Only return labels that were created on or before a specific date/time | [optional] 
+ **page** | **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.  | [optional] [default to 1]
+ **page_size** | **Integer**| The number of results to return per response. | [optional] [default to 25]
+ **sort_dir** | [**SortDir**](.md)| Controls the sort order of the query. | [optional] 
+ **sort_by** | **String**| Controls which field the query is sorted by. | [optional] [default to 'created_at']
+
+### Return type
+
+[**ListLabelsResponseBody**](ListLabelsResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## void_label
+
+> VoidLabelResponseBody void_label(label_id)
+
+Void a Label By ID
+
+Void a label by ID to get a refund.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.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
+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
+  puts "Exception when calling LabelsApi->void_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **label_id** | **String**| Label ID | 
+
+### Return type
+
+[**VoidLabelResponseBody**](VoidLabelResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+