ship_engine 1.0.0

data/docs/Link.md

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

data/docs/ListBatchErrorsResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ListBatchErrorsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<BatchResponseError>**](BatchResponseError.md) | The errors currently associated with the batch | [readonly] 
+**links** | [**PaginationLink**](PaginationLink.md) |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListBatchErrorsResponseBody.new(errors: null,
+                                 links: null)
+```
+
+

data/docs/ListBatchesResponseBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ListBatchesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**batches** | [**Array<Batch>**](Batch.md) | Batch List | [readonly] 
+**total** | **Integer** | The total number of batches the API call returned | [readonly] 
+**page** | **Integer** | The page that is currently being read | [readonly] 
+**pages** | **Integer** | The total number of batch pages the API call returned | [readonly] 
+**links** | [**PaginationLink**](PaginationLink.md) |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListBatchesResponseBody.new(batches: null,
+                                 total: 10,
+                                 page: 1,
+                                 pages: 10,
+                                 links: null)
+```
+
+

data/docs/ListCarrierPackageTypesResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListCarrierPackageTypesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**packages** | [**Array<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListCarrierPackageTypesResponseBody.new(packages: null)
+```
+
+

data/docs/ListCarrierServicesResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListCarrierServicesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**services** | [**Array<Service>**](Service.md) | An array of services associated with the carrier | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListCarrierServicesResponseBody.new(services: null)
+```
+
+

data/docs/ListCarriersResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListCarriersResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**carriers** | [**Array<Carrier>**](Carrier.md) | The carrier response body | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListCarriersResponseBody.new(carriers: null)
+```
+
+

data/docs/ListLabelsResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListLabelsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**labels** | **Array<Object>** | The labels that matched the query criteria.  If no matching labels were found, then this array is empty; otherwise, it contains one page of results.  The last page of results may have fewer labels than the `page_size`.  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListLabelsResponseBody.new(labels: null)
+```
+
+

data/docs/ListManifestsResponseBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ListManifestsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manifests** | [**Array<Manifest>**](Manifest.md) | The list of available manifests | [readonly] 
+**total** | **Integer** | The total number of manifests returned | [readonly] 
+**page** | **Integer** | Current page of the list manifests results | [readonly] 
+**pages** | **Integer** | Total number of pages for list manifests results | [readonly] 
+**links** | [**PaginationLink**](PaginationLink.md) | Helpful links to other pages of results | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListManifestsResponseBody.new(manifests: null,
+                                 total: 3,
+                                 page: 3,
+                                 pages: 4,
+                                 links: null)
+```
+
+

data/docs/ListPackageTypesResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListPackageTypesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**packages** | [**Array<PackageType>**](PackageType.md) | An array of custom package types | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListPackageTypesResponseBody.new(packages: null)
+```
+
+

data/docs/ListShipmentErrorsResponseBody.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ListShipmentErrorsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<ShipmentResponseError>**](ShipmentResponseError.md) | The errors associated with the shipment. | [readonly] 
+**links** | [**PaginationLink**](PaginationLink.md) |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListShipmentErrorsResponseBody.new(errors: null,
+                                 links: null)
+```
+
+

data/docs/ListShipmentRatesResponseBody.md

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

data/docs/ListShipmentsResponseBody.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ListShipmentsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipments** | [**Array<Shipment>**](Shipment.md) | The list of shipments returned by the api call | [readonly] 
+**total** | **Integer** | Total number of shipments returned by the api call | [readonly] 
+**page** | **Integer** |  | [readonly] 
+**pages** | **Integer** |  | [readonly] 
+**links** | [**PaginationLink**](PaginationLink.md) |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListShipmentsResponseBody.new(shipments: null,
+                                 total: 1990,
+                                 page: null,
+                                 pages: null,
+                                 links: null)
+```
+
+

data/docs/ListTagsResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListTagsResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tags** | [**Array<Tag>**](Tag.md) | The array of tags returned by the API call | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListTagsResponseBody.new(tags: null)
+```
+
+

data/docs/ListWarehousesResponseBody.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ListWarehousesResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**warehouses** | [**Array<Warehouse>**](Warehouse.md) | The array of warehouses returned by the API call | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ListWarehousesResponseBody.new(warehouses: null)
+```
+
+

data/docs/Manifest.md

@@ -0,0 +1,33 @@
+# OpenapiClient::Manifest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manifest_id** | **String** | A string that uniquely identifies the manifest | [optional] [readonly] 
+**form_id** | **String** | A string that uniquely identifies the form | [optional] [readonly] 
+**created_at** | **DateTime** | The date-time that the manifest was created | [optional] [readonly] 
+**ship_date** | **DateTime** | The date-time that the manifests shipments will be picked up | [optional] [readonly] 
+**shipments** | **Integer** | The number of shipments that are included in this manifest | [optional] [readonly] 
+**warehouse_id** | **String** | A string that uniquely identifies the warehouse | [optional] [readonly] 
+**submission_id** | **String** | A string that uniquely identifies the submission | [optional] [readonly] 
+**carrier_id** | **String** | A string that uniquely identifies the carrier | [optional] [readonly] 
+**manifest_download** | [**ManifestDownload**](ManifestDownload.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Manifest.new(manifest_id: null,
+                                 form_id: null,
+                                 created_at: 2019-07-12T13:37:39.050Z,
+                                 ship_date: 2019-07-12T13:37:39.050Z,
+                                 shipments: 100,
+                                 warehouse_id: null,
+                                 submission_id: 9.475711899564878E+21,
+                                 carrier_id: null,
+                                 manifest_download: null)
+```
+
+

data/docs/ManifestDownload.md

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

data/docs/Manifests.md

@@ -0,0 +1,17 @@
+# OpenapiClient::Manifests
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**manifests** | [**Array<Manifest>**](Manifest.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Manifests.new(manifests: null)
+```
+
+

data/docs/ManifestsApi.md

@@ -0,0 +1,191 @@
+# OpenapiClient::ManifestsApi
+
+All URIs are relative to *https://api.shipengine.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_manifest**](ManifestsApi.md#create_manifest) | **POST** /v1/manifests | Create Manifest
+[**get_manifest_by_id**](ManifestsApi.md#get_manifest_by_id) | **GET** /v1/manifests/{manifest_id} | Get Manifest By Id
+[**list_manifests**](ManifestsApi.md#list_manifests) | **GET** /v1/manifests | List Manifests
+
+
+
+## create_manifest
+
+> CreateManifestResponseBody create_manifest(create_manifest_request_body)
+
+Create Manifest
+
+Each ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a warehouse for each location that you want to create manifests for. 
+
+### 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::ManifestsApi.new
+create_manifest_request_body = OpenapiClient::CreateManifestRequestBody.new # CreateManifestRequestBody | 
+
+begin
+  #Create Manifest
+  result = api_instance.create_manifest(create_manifest_request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ManifestsApi->create_manifest: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_manifest_request_body** | [**CreateManifestRequestBody**](CreateManifestRequestBody.md)|  | 
+
+### Return type
+
+[**CreateManifestResponseBody**](CreateManifestResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_manifest_by_id
+
+> GetManifestByIdResponseBody get_manifest_by_id(manifest_id)
+
+Get Manifest By Id
+
+Get Manifest 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::ManifestsApi.new
+manifest_id = 'manifest_id_example' # String | The Manifest Id
+
+begin
+  #Get Manifest By Id
+  result = api_instance.get_manifest_by_id(manifest_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ManifestsApi->get_manifest_by_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **manifest_id** | **String**| The Manifest Id | 
+
+### Return type
+
+[**GetManifestByIdResponseBody**](GetManifestByIdResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_manifests
+
+> ListManifestsResponseBody list_manifests(opts)
+
+List Manifests
+
+Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
+
+### 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::ManifestsApi.new
+opts = {
+  warehouse_id: 'warehouse_id_example', # String | Warehouse ID
+  ship_date_start: DateTime.parse('2018-09-23T15:00:00.000Z'), # DateTime | ship date start range
+  ship_date_end: DateTime.parse('2018-09-23T15:00:00.000Z'), # DateTime | ship date end range
+  created_at_start: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
+  created_at_end: DateTime.parse('2019-03-12T19:24:13.657Z'), # DateTime | Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
+  carrier_id: 'carrier_id_example', # String | Carrier ID
+  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.
+  label_ids: ['label_ids_example'] # Array<String> | 
+}
+
+begin
+  #List Manifests
+  result = api_instance.list_manifests(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ManifestsApi->list_manifests: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **warehouse_id** | **String**| Warehouse ID | [optional] 
+ **ship_date_start** | **DateTime**| ship date start range | [optional] 
+ **ship_date_end** | **DateTime**| ship date end range | [optional] 
+ **created_at_start** | **DateTime**| Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time) | [optional] 
+ **created_at_end** | **DateTime**| Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time) | [optional] 
+ **carrier_id** | **String**| Carrier ID | [optional] 
+ **page** | **Integer**| Return a specific page of results. Defaults to the first page. If set to a number that&#39;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]
+ **label_ids** | [**Array&lt;String&gt;**](String.md)|  | [optional] 
+
+### Return type
+
+[**ListManifestsResponseBody**](ListManifestsResponseBody.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+