ship_engine 1.0.0

data/docs/ModifyBatch.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ModifyBatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipment_ids** | **Array<String>** | The Shipment Ids to be modified on the batch | [optional] 
+**rate_ids** | **Array<String>** | Array of Rate IDs to be modifed on the batch | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ModifyBatch.new(shipment_ids: null,
+                                 rate_ids: null)
+```
+
+

data/docs/MonetaryValue.md

@@ -0,0 +1,19 @@
+# OpenapiClient::MonetaryValue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | [**Currency**](Currency.md) |  | 
+**amount** | **Float** | The monetary amount, in the specified currency. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::MonetaryValue.new(currency: null,
+                                 amount: null)
+```
+
+

data/docs/NonDelivery.md

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

data/docs/OptionalLink.md

@@ -0,0 +1,19 @@
+# OpenapiClient::OptionalLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | The URL of the linked resource, if any | [optional] 
+**type** | **String** | The type of resource, or the type of relationship to the parent resource | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::OptionalLink.new(href: null,
+                                 type: null)
+```
+
+

data/docs/OrderSourceName.md

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

data/docs/Package.md

@@ -0,0 +1,29 @@
+# OpenapiClient::Package
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**weight** | [**Weight**](Weight.md) | The package weight | 
+**dimensions** | [**Dimensions**](Dimensions.md) | The package dimensions | [optional] 
+**insured_value** | [**MonetaryValue**](MonetaryValue.md) | The insured value of the package.  Requires the `insurance_provider` field of the shipment to be set.  | [optional] 
+**tracking_number** | **String** | The tracking number for the package.  The format depends on the carrier.  | [optional] [readonly] 
+**label_messages** | [**LabelMessages**](LabelMessages.md) |  | [optional] 
+**external_package_id** | **String** | An external package id. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Package.new(package_code: null,
+                                 weight: null,
+                                 dimensions: null,
+                                 insured_value: null,
+                                 tracking_number: null,
+                                 label_messages: null,
+                                 external_package_id: null)
+```
+
+

data/docs/PackageContents.md

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

data/docs/PackageType.md

@@ -0,0 +1,25 @@
+# OpenapiClient::PackageType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**package_id** | **String** | A string that uniquely identifies the package. | [optional] 
+**package_code** | **String** |  | 
+**name** | **String** |  | 
+**dimensions** | [**Dimensions**](Dimensions.md) | The custom dimensions for the package. | [optional] 
+**description** | **String** | Provides a helpful description for the custom package. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::PackageType.new(package_id: null,
+                                 package_code: null,
+                                 name: laptop_box,
+                                 dimensions: null,
+                                 description: Packaging for laptops)
+```
+
+

data/docs/PackageTypesApi.md

@@ -0,0 +1,281 @@
+# OpenapiClient::PackageTypesApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_package_type**](PackageTypesApi.md#create_package_type) | **POST** /v1/packages | Create Custom Package Type
+[**delete_package_type**](PackageTypesApi.md#delete_package_type) | **DELETE** /v1/packages/{package_id} | Delete A Custom Package By ID
+[**get_package_type_by_id**](PackageTypesApi.md#get_package_type_by_id) | **GET** /v1/packages/{package_id} | Get Custom Package Type By ID
+[**list_package_types**](PackageTypesApi.md#list_package_types) | **GET** /v1/packages | List Custom Package Types
+[**update_package_type**](PackageTypesApi.md#update_package_type) | **PUT** /v1/packages/{package_id} | Update Custom Package Type By ID
+
+
+
+## create_package_type
+
+> CreatePackageTypeResponseBody create_package_type(create_package_type_request_body)
+
+Create Custom Package Type
+
+Create a custom package type to better assist in getting accurate rate estimates
+
+### 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::PackageTypesApi.new
+create_package_type_request_body = OpenapiClient::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
+  puts "Exception when calling PackageTypesApi->create_package_type: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_package_type_request_body** | [**CreatePackageTypeRequestBody**](CreatePackageTypeRequestBody.md)|  | 
+
+### Return type
+
+[**CreatePackageTypeResponseBody**](CreatePackageTypeResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_package_type
+
+> String delete_package_type(package_id)
+
+Delete A Custom Package By ID
+
+Delete a custom package using the 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::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
+  puts "Exception when calling PackageTypesApi->delete_package_type: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **String**| Package ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## get_package_type_by_id
+
+> GetPackageTypeByIdResponseBody get_package_type_by_id(package_id)
+
+Get Custom Package Type By ID
+
+Get Custom Package Type by 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::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
+  puts "Exception when calling PackageTypesApi->get_package_type_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **String**| Package ID | 
+
+### Return type
+
+[**GetPackageTypeByIdResponseBody**](GetPackageTypeByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_package_types
+
+> ListPackageTypesResponseBody list_package_types
+
+List Custom Package Types
+
+List the custom package types associated with the 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::PackageTypesApi.new
+
+begin
+  #List Custom Package Types
+  result = api_instance.list_package_types
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PackageTypesApi->list_package_types: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListPackageTypesResponseBody**](ListPackageTypesResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_package_type
+
+> String update_package_type(package_id, update_package_type_request_body)
+
+Update Custom Package Type By ID
+
+Update the custom package type object by 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::PackageTypesApi.new
+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)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling PackageTypesApi->update_package_type: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **String**| Package ID | 
+ **update_package_type_request_body** | [**UpdatePackageTypeRequestBody**](UpdatePackageTypeRequestBody.md)|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+