openapi_client 1.0.0

data/docs/ShipmentsSortBy.md

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

data/docs/SmartPostHub.md

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

data/docs/SortDir.md

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

data/docs/Tag.md

@@ -0,0 +1,17 @@
+# OpenapiClient::Tag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The tag name. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Tag.new(name: Fragile)
+```
+
+

data/docs/TagShipmentResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::TagShipmentResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [readonly] 
+**tag** | [**Tag**](Tag.md) | The tag that is now associated with this shipment | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TagShipmentResponseBody.new(shipment_id: null,
+                                 tag: null)
+```
+
+

data/docs/TagsApi.md

@@ -0,0 +1,226 @@
+# OpenapiClient::TagsApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_tag**](TagsApi.md#create_tag) | **POST** /v1/tags/{tag_name} | Create a New Tag
+[**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /v1/tags/{tag_name} | Delete Tag
+[**list_tags**](TagsApi.md#list_tags) | **GET** /v1/tags | Get Tags
+[**rename_tag**](TagsApi.md#rename_tag) | **PUT** /v1/tags/{tag_name}/{new_tag_name} | Update Tag Name
+
+
+
+## create_tag
+
+> CreateTagResponseBody create_tag(tag_name)
+
+Create a New Tag
+
+Create a new Tag for customizing how you track your shipments
+
+### 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::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
+  puts "Exception when calling TagsApi->create_tag: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_name** | **String**|  | 
+
+### Return type
+
+[**CreateTagResponseBody**](CreateTagResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_tag
+
+> String delete_tag(tag_name)
+
+Delete Tag
+
+Delete a tag that is no longer needed
+
+### 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::TagsApi.new
+tag_name = 'tag_name_example' # String | 
+
+begin
+  #Delete Tag
+  result = api_instance.delete_tag(tag_name)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TagsApi->delete_tag: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_name** | **String**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## list_tags
+
+> ListTagsResponseBody list_tags
+
+Get Tags
+
+Get a list of all tags associated with an account.
+
+### 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::TagsApi.new
+
+begin
+  #Get Tags
+  result = api_instance.list_tags
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TagsApi->list_tags: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListTagsResponseBody**](ListTagsResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rename_tag
+
+> String rename_tag(tag_name, new_tag_name)
+
+Update Tag Name
+
+Change a tag name while still keeping the relevant shipments attached to it
+
+### 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::TagsApi.new
+tag_name = 'tag_name_example' # String | 
+new_tag_name = 'new_tag_name_example' # String | 
+
+begin
+  #Update Tag Name
+  result = api_instance.rename_tag(tag_name, new_tag_name)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TagsApi->rename_tag: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tag_name** | **String**|  | 
+ **new_tag_name** | **String**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+

data/docs/TrackEvent.md

@@ -0,0 +1,39 @@
+# OpenapiClient::TrackEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**occurred_at** | **DateTime** | Timestamp for carrier event | 
+**carrier_occurred_at** | **DateTime** | Carrier timestamp for the event, it is assumed to be the local time of where the event occurred. | [optional] 
+**description** | **String** | Event description | [optional] [readonly] 
+**city_locality** | **String** | City locality | [readonly] 
+**state_province** | **String** | State province | [readonly] 
+**postal_code** | **String** | Postal code | [readonly] 
+**country_code** | **String** |  | [optional] 
+**company_name** | **String** | Company Name | [optional] [readonly] 
+**signer** | **String** | Signer information | [optional] [readonly] 
+**event_code** | **String** | Event Code | [optional] 
+**latitude** | **Float** | Latitude coordinate of tracking event. | [optional] 
+**longitude** | **Float** | Longitude coordinate of tracking event. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TrackEvent.new(occurred_at: null,
+                                 carrier_occurred_at: null,
+                                 description: Delivered, In/At Mailbox,
+                                 city_locality: AUSTIN,
+                                 state_province: TX,
+                                 postal_code: 78756,
+                                 country_code: null,
+                                 company_name: Stamps.com,
+                                 signer: null,
+                                 event_code: null,
+                                 latitude: null,
+                                 longitude: null)
+```
+
+

data/docs/TrackingApi.md

@@ -0,0 +1,185 @@
+# OpenapiClient::TrackingApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_tracking_log**](TrackingApi.md#get_tracking_log) | **GET** /v1/tracking | Get Tracking Information
+[**start_tracking**](TrackingApi.md#start_tracking) | **POST** /v1/tracking/start | Start Tracking a Package
+[**stop_tracking**](TrackingApi.md#stop_tracking) | **POST** /v1/tracking/stop | Stop Tracking a Package
+
+
+
+## get_tracking_log
+
+> GetTrackingLogResponseBody get_tracking_log(opts)
+
+Get Tracking Information
+
+Retrieve package 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::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
+}
+
+begin
+  #Get Tracking Information
+  result = api_instance.get_tracking_log(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TrackingApi->get_tracking_log: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_code** | **String**| Carrier code used to retrieve tracking information | [optional] 
+ **tracking_number** | **String**| The tracking number associated with a shipment | [optional] 
+
+### Return type
+
+[**GetTrackingLogResponseBody**](GetTrackingLogResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## start_tracking
+
+> String start_tracking(opts)
+
+Start Tracking a Package
+
+Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes. 
+
+### 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::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
+}
+
+begin
+  #Start Tracking a Package
+  result = api_instance.start_tracking(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TrackingApi->start_tracking: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_code** | **String**| Carrier code used to retrieve tracking information | [optional] 
+ **tracking_number** | **String**| The tracking number associated with a shipment | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## stop_tracking
+
+> String stop_tracking(opts)
+
+Stop Tracking a Package
+
+Unsubscribe from tracking updates for a package.
+
+### 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::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
+}
+
+begin
+  #Stop Tracking a Package
+  result = api_instance.stop_tracking(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling TrackingApi->stop_tracking: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_code** | **String**| Carrier code used to retrieve tracking information | [optional] 
+ **tracking_number** | **String**| The tracking number associated with a shipment | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+