ship_engine 1.0.0

data/docs/BatchesSortBy.md

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

data/docs/BillToParty.md

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

data/docs/BulkRate.md

@@ -0,0 +1,25 @@
+# OpenapiClient::BulkRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate_request_id** | **String** | A string that uniquely identifies the rate request | [readonly] 
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [readonly] 
+**created_at** | **DateTime** |  | [readonly] 
+**status** | [**RateResponseStatus**](RateResponseStatus.md) |  | [readonly] 
+**errors** | [**Array<Error>**](Error.md) | An array of errors that were returned while retrieving the bulk rate | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::BulkRate.new(rate_request_id: null,
+                                 shipment_id: null,
+                                 created_at: null,
+                                 status: null,
+                                 errors: null)
+```
+
+

data/docs/CalculateRatesRequestBody.md

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

data/docs/CalculateRatesResponseBody.md

@@ -0,0 +1,61 @@
+# OpenapiClient::CalculateRatesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipment_id** | **String** | A string that uniquely identifies the shipment | [readonly] 
+**carrier_id** | **String** | The carrier account that is billed for the shipping charges | [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] 
+**external_order_id** | **String** | ID that the Order Source assigned | [optional] 
+**items** | [**Array<ShipmentItem>**](ShipmentItem.md) | Describe the packages included in this shipment as related to potential metadata that was imported from external order sources  | [optional] 
+**external_shipment_id** | **String** | You can optionally use this field to store your own identifier for this shipment.  > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.  | [optional] 
+**ship_date** | **DateTime** | The date that the shipment 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.  | 
+**created_at** | **DateTime** | The date and time that the shipment was created in ShipEngine. | [readonly] 
+**modified_at** | **DateTime** | The date and time that the shipment was created or last modified. | [readonly] 
+**shipment_status** | [**ShipmentStatus**](ShipmentStatus.md) | The current status of the shipment | [readonly] 
+**ship_to** | [**Address**](Address.md) | The recipient's mailing address | [optional] 
+**ship_from** | [**Address**](Address.md) | The shipment's origin address. If you frequently ship from the same location, consider [creating a warehouse](https://www.shipengine.com/docs/reference/create-warehouse/). Then you can simply specify the `warehouse_id` rather than the complete address each time.  | [optional] 
+**warehouse_id** | **String** | The [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/) that the shipment is being shipped from.  Either `warehouse_id` or `ship_from` must be specified.  | [optional] 
+**return_to** | [**Address**](Address.md) | The return address for this shipment.  Defaults to the `ship_from` address.  | 
+**confirmation** | [**DeliveryConfirmation**](DeliveryConfirmation.md) | The type of delivery confirmation that is required for this shipment. | 
+**customs** | [**InternationalShipmentOptions**](InternationalShipmentOptions.md) | Customs information.  This is usually only needed for international shipments.  | 
+**advanced_options** | [**AdvancedShipmentOptions**](AdvancedShipmentOptions.md) | Advanced shipment options.  These are entirely optional. | 
+**insurance_provider** | [**InsuranceProvider**](InsuranceProvider.md) | The insurance provider to use for any insured packages in the shipment.  | 
+**tags** | [**Array<Tag>**](Tag.md) | Arbitrary tags associated with this shipment.  Tags can be used to categorize shipments, and shipments can be queried by their tags.  | [readonly] 
+**order_source_code** | [**OrderSourceName**](OrderSourceName.md) |  | [optional] 
+**packages** | [**Array<Package>**](Package.md) | The packages in the shipment.  > **Note:** Some carriers only allow one package per shipment.  If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.  | 
+**total_weight** | [**Weight**](Weight.md) | The combined weight of all packages in the shipment | [readonly] 
+**rate_response** | [**RatesInformation**](RatesInformation.md) | The rates response | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CalculateRatesResponseBody.new(shipment_id: null,
+                                 carrier_id: null,
+                                 service_code: null,
+                                 external_order_id: null,
+                                 items: null,
+                                 external_shipment_id: null,
+                                 ship_date: null,
+                                 created_at: null,
+                                 modified_at: null,
+                                 shipment_status: null,
+                                 ship_to: null,
+                                 ship_from: null,
+                                 warehouse_id: null,
+                                 return_to: null,
+                                 confirmation: null,
+                                 customs: null,
+                                 advanced_options: null,
+                                 insurance_provider: null,
+                                 tags: null,
+                                 order_source_code: null,
+                                 packages: null,
+                                 total_weight: null,
+                                 rate_response: null)
+```
+
+

data/docs/Carrier.md

@@ -0,0 +1,41 @@
+# OpenapiClient::Carrier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carrier_id** | **String** | A string that uniquely identifies the carrier. | [optional] [readonly] 
+**carrier_code** | **String** | A string that uniquely identifies the carrier. | [optional] 
+**account_number** | **String** | The account number that the carrier is connected to. | [optional] [readonly] 
+**requires_funded_amount** | **Boolean** | Indicates whether the carrier requires funding to use its services | [optional] [readonly] 
+**balance** | **Float** | Current available balance | [optional] [readonly] 
+**nickname** | **String** | Nickname given to the account when initially setting up the carrier. | [optional] [readonly] 
+**friendly_name** | **String** | Screen readable name | [optional] [readonly] 
+**primary** | **Boolean** | Is this the primary carrier that is used by default when no carrier is specified in label/shipment creation | [optional] [readonly] 
+**has_multi_package_supporting_services** | **Boolean** | Carrier supports multiple packages per shipment | [optional] [readonly] 
+**supports_label_messages** | **Boolean** | The carrier supports adding custom label messages to an order. | [optional] [readonly] 
+**services** | [**Array<Service>**](Service.md) | A list of services that are offered by the carrier | [optional] [readonly] 
+**packages** | [**Array<PackageType>**](PackageType.md) | A list of package types that are supported by the carrier | [optional] [readonly] 
+**options** | [**Array<CarrierAdvancedOption>**](CarrierAdvancedOption.md) | A list of options that are available to that carrier | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Carrier.new(carrier_id: null,
+                                 carrier_code: null,
+                                 account_number: account_570827,
+                                 requires_funded_amount: null,
+                                 balance: 3799.52,
+                                 nickname: ShipEngine Account - Stamps.com,
+                                 friendly_name: Stamps.com,
+                                 primary: null,
+                                 has_multi_package_supporting_services: null,
+                                 supports_label_messages: null,
+                                 services: null,
+                                 packages: null,
+                                 options: null)
+```
+
+

data/docs/CarrierAccountsApi.md

@@ -0,0 +1,238 @@
+# OpenapiClient::CarrierAccountsApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**connect_carrier**](CarrierAccountsApi.md#connect_carrier) | **POST** /v1/connections/carriers/{carrier_name} | Connect a carrier account
+[**disconnect_carrier**](CarrierAccountsApi.md#disconnect_carrier) | **DELETE** /v1/connections/carriers/{carrier_name}/{carrier_id} | Disconnect a carrier
+[**get_carrier_settings**](CarrierAccountsApi.md#get_carrier_settings) | **GET** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Get carrier settings
+[**update_carrier_settings**](CarrierAccountsApi.md#update_carrier_settings) | **PUT** /v1/connections/carriers/{carrier_name}/{carrier_id}/settings | Update carrier settings
+
+
+
+## connect_carrier
+
+> ConnectCarrierResponseBody connect_carrier(carrier_name, connect_carrier_request_body)
+
+Connect a carrier account
+
+Connect a carrier 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::CarrierAccountsApi.new
+carrier_name = OpenapiClient::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+connect_carrier_request_body = OpenapiClient::ConnectCarrierRequestBody.new # ConnectCarrierRequestBody | 
+
+begin
+  #Connect a carrier account
+  result = api_instance.connect_carrier(carrier_name, connect_carrier_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling CarrierAccountsApi->connect_carrier: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
+ **connect_carrier_request_body** | [**ConnectCarrierRequestBody**](ConnectCarrierRequestBody.md)|  | 
+
+### Return type
+
+[**ConnectCarrierResponseBody**](ConnectCarrierResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## disconnect_carrier
+
+> String disconnect_carrier(carrier_name, carrier_id)
+
+Disconnect a carrier
+
+Disconnect a carrier
+
+### 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::CarrierAccountsApi.new
+carrier_name = OpenapiClient::CarrierName.new # CarrierName | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+carrier_id = 'se-28529731' # String | Carrier ID
+
+begin
+  #Disconnect a carrier
+  result = api_instance.disconnect_carrier(carrier_name, carrier_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling CarrierAccountsApi->disconnect_carrier: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_name** | [**CarrierName**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
+ **carrier_id** | **String**| Carrier ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## get_carrier_settings
+
+> GetCarrierSettingsResponseBody get_carrier_settings(carrier_name, carrier_id)
+
+Get carrier settings
+
+Get carrier settings
+
+### 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::CarrierAccountsApi.new
+carrier_name = OpenapiClient::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+carrier_id = 'se-28529731' # String | Carrier ID
+
+begin
+  #Get carrier settings
+  result = api_instance.get_carrier_settings(carrier_name, carrier_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling CarrierAccountsApi->get_carrier_settings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_name** | [**CarrierNameWithSettings**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
+ **carrier_id** | **String**| Carrier ID | 
+
+### Return type
+
+[**GetCarrierSettingsResponseBody**](GetCarrierSettingsResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_carrier_settings
+
+> String update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
+
+Update carrier settings
+
+Update carrier settings
+
+### 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::CarrierAccountsApi.new
+carrier_name = OpenapiClient::CarrierNameWithSettings.new # CarrierNameWithSettings | The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`.
+carrier_id = 'se-28529731' # String | Carrier ID
+update_carrier_settings_request_body = OpenapiClient::UpdateCarrierSettingsRequestBody.new # UpdateCarrierSettingsRequestBody | 
+
+begin
+  #Update carrier settings
+  result = api_instance.update_carrier_settings(carrier_name, carrier_id, update_carrier_settings_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling CarrierAccountsApi->update_carrier_settings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **carrier_name** | [**CarrierNameWithSettings**](.md)| The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`. | 
+ **carrier_id** | **String**| Carrier ID | 
+ **update_carrier_settings_request_body** | [**UpdateCarrierSettingsRequestBody**](UpdateCarrierSettingsRequestBody.md)|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: text/plain, application/json
+

data/docs/CarrierAdvancedOption.md

@@ -0,0 +1,21 @@
+# OpenapiClient::CarrierAdvancedOption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of advanced option | [optional] [readonly] 
+**default_value** | **String** | Default value of option | [optional] [readonly] 
+**description** | **String** | Description of option | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CarrierAdvancedOption.new(name: contains_alcohol,
+                                 default_value: false,
+                                 description: null)
+```
+
+

data/docs/CarrierName.md

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