ultracart_api 3.1.47 → 3.1.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc1598c02759ead7baee655363e0267c41ad7565baa2181aca07df8a59bb7a03
-  data.tar.gz: 64558108de3c9aac79c5fea2c9fbcf8e26e5227d72df272d5ed715d05cab84bf
+  metadata.gz: 15a4920821243ee879d4dd4e8a66fb03fb5a88cf02854920787e45bce9e8ef00
+  data.tar.gz: 03a59ca867aeb01f41814dd5b3fa80aacd6674befd244dc60f5465bdba11b20d
 SHA512:
-  metadata.gz: 8c9625cba309a39eb27ee90e833ff4ab6a2fab4133d0c9d8e6510af00f2a6337ee6d2f30d1a456f924fb399754dddcc8c34fbd6e6b64a5760469978bb90f655b
-  data.tar.gz: 100f489070993e75d290bb39bacb759f877707d3bfc82ff87618aabfe744ea727e9b58823c24545961ef400a996f310c57f8888f2f32b10ac7b24d1fce28319c
+  metadata.gz: e0d31acc4523ec97641b0472536ff8422cbea2584121cf21efce65305afc933213bfa87ed5484bcd83f370d18f0148da11f8038ef5b69c8de34c7e443b717fd1
+  data.tar.gz: 74e80fdcae47129b64fed3dcda13545347c33ad51fa1d01ae493793e79c8792cd86bfa0d446b0ee09d64260b86d92c4be9945d2491b8df5d6c8e88f9aaed45a1

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.1.47
+- Package version: 3.1.48
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.1.47.gem
+gem install ./ultracart_api-3.1.48.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.1.47.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.1.48.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.1.47'
+    gem 'ultracart_api', '~> 3.1.48'
 
 ### Install from Git
 
@@ -157,6 +157,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
 *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
 *UltracartClient::FulfillmentApi* | [**update_inventory**](docs/FulfillmentApi.md#update_inventory) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/inventory | Update inventory
+*UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
+*UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
 *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
 *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
 *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
@@ -694,6 +696,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
  - [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
  - [UltracartClient::HTTPHeader](docs/HTTPHeader.md)
+ - [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
+ - [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
+ - [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
+ - [UltracartClient::IntegrationLogQueryFilterValues](docs/IntegrationLogQueryFilterValues.md)
+ - [UltracartClient::IntegrationLogQueryRequest](docs/IntegrationLogQueryRequest.md)
+ - [UltracartClient::IntegrationLogQueryResponse](docs/IntegrationLogQueryResponse.md)
  - [UltracartClient::Item](docs/Item.md)
  - [UltracartClient::ItemAccounting](docs/ItemAccounting.md)
  - [UltracartClient::ItemAmember](docs/ItemAmember.md)

data/docs/IntegrationLog.md

@@ -0,0 +1,22 @@
+# UltracartClient::IntegrationLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** |  | [optional] 
+**direction** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**files** | [**Array<IntegrationLogFile>**](IntegrationLogFile.md) |  | [optional] 
+**integration_log_oid** | **Integer** |  | [optional] 
+**item_id** | **String** |  | [optional] 
+**item_ipn_oid** | **Integer** |  | [optional] 
+**log_dts** | **String** |  | [optional] 
+**log_type** | **String** |  | [optional] 
+**logger_id** | **String** |  | [optional] 
+**logs** | [**Array<IntegrationLogLog>**](IntegrationLogLog.md) |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**pk** | **String** |  | [optional] 
+**sk** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogApi.md

@@ -0,0 +1,121 @@
+# UltracartClient::IntegrationLogApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
+[**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
+
+
+# **get_integration_log**
+> IntegrationLog get_integration_log(pk, sk)
+
+Retrieve an integration log
+
+Retrieve an integration logs from the account based identifiers 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
+
+
+pk = 'pk_example' # String | 
+
+sk = 'sk_example' # String | 
+
+
+begin
+  #Retrieve an integration log
+  result = api_instance.get_integration_log(pk, sk)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling IntegrationLogApi->get_integration_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pk** | **String**|  | 
+ **sk** | **String**|  | 
+
+### Return type
+
+[**IntegrationLog**](IntegrationLog.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_integration_logs_query**
+> IntegrationLogQueryResponse get_integration_logs_query(integration_log_query, opts)
+
+Retrieve integration logs
+
+Retrieves a set of integration logs from the account based on a query object. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
+
+
+integration_log_query = UltracartClient::IntegrationLogQueryRequest.new # IntegrationLogQueryRequest | Integration log query
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
+  _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _sort: '_sort_example' # String | The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+}
+
+begin
+  #Retrieve integration logs
+  result = api_instance.get_integration_logs_query(integration_log_query, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling IntegrationLogApi->get_integration_logs_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_log_query** | [**IntegrationLogQueryRequest**](IntegrationLogQueryRequest.md)| Integration log query | 
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+ **_sort** | **String**| The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 
+
+### Return type
+
+[**IntegrationLogQueryResponse**](IntegrationLogQueryResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/IntegrationLogFile.md

@@ -0,0 +1,10 @@
+# UltracartClient::IntegrationLogFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**uuid** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogLog.md

@@ -0,0 +1,9 @@
+# UltracartClient::IntegrationLogLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**contents** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogQueryFilterValues.md

@@ -0,0 +1,16 @@
+# UltracartClient::IntegrationLogQueryFilterValues
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actions** | **Array<String>** |  | [optional] 
+**directions** | **Array<String>** |  | [optional] 
+**emails** | **Array<String>** |  | [optional] 
+**file_names** | **Array<String>** |  | [optional] 
+**item_ids** | **Array<String>** |  | [optional] 
+**item_ipn_oids** | **Array<Integer>** |  | [optional] 
+**log_types** | **Array<String>** |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**statuses** | **Array<String>** |  | [optional] 
+
+

data/docs/IntegrationLogQueryRequest.md

@@ -0,0 +1,19 @@
+# UltracartClient::IntegrationLogQueryRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** |  | [optional] 
+**direction** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**file_names** | **Array<String>** |  | [optional] 
+**item_id** | **String** |  | [optional] 
+**item_ipn_oid** | **Integer** |  | [optional] 
+**log_dts_begin** | **String** | Log date/time begin | [optional] 
+**log_dts_end** | **String** | Log date/time end | [optional] 
+**log_type** | **String** |  | [optional] 
+**logger_id** | **String** |  | [optional] 
+**order_ids** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/IntegrationLogQueryResponse.md

@@ -0,0 +1,13 @@
+# UltracartClient::IntegrationLogQueryResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**filter_values** | [**IntegrationLogQueryFilterValues**](IntegrationLogQueryFilterValues.md) |  | [optional] 
+**integration_logs** | [**Array<IntegrationLog>**](IntegrationLog.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/LibraryItemAttribute.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**library_item_oid** | **Integer** |  | [optional] 
 **name** | **String** |  | [optional] 
 **value** | **String** |  | [optional] 
 

data/lib/ultracart_api.rb

@@ -325,6 +325,12 @@ require 'ultracart_api/models/group_response'
 require 'ultracart_api/models/group_user_membership'
 require 'ultracart_api/models/groups_response'
 require 'ultracart_api/models/http_header'
+require 'ultracart_api/models/integration_log'
+require 'ultracart_api/models/integration_log_file'
+require 'ultracart_api/models/integration_log_log'
+require 'ultracart_api/models/integration_log_query_filter_values'
+require 'ultracart_api/models/integration_log_query_request'
+require 'ultracart_api/models/integration_log_query_response'
 require 'ultracart_api/models/item'
 require 'ultracart_api/models/item_accounting'
 require 'ultracart_api/models/item_amember'
@@ -600,6 +606,7 @@ require 'ultracart_api/api/checkout_api'
 require 'ultracart_api/api/coupon_api'
 require 'ultracart_api/api/customer_api'
 require 'ultracart_api/api/fulfillment_api'
+require 'ultracart_api/api/integration_log_api'
 require 'ultracart_api/api/item_api'
 require 'ultracart_api/api/oauth_api'
 require 'ultracart_api/api/order_api'

data/lib/ultracart_api/api/integration_log_api.rb

@@ -0,0 +1,161 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module UltracartClient
+  class IntegrationLogApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
+      api_config = Configuration.new
+      api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
+      api_config.api_version = '2017-03-01'
+      api_config.verify_ssl = verify_ssl
+
+      api_client = ApiClient.new(api_config)
+      api_client.config.debugging = debugging
+
+      UltracartClient::IntegrationLogApi.new(api_client)
+    end
+
+    # Retrieve an integration log
+    # Retrieve an integration logs from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param [Hash] opts the optional parameters
+    # @return [IntegrationLog]
+    def get_integration_log(pk, sk, opts = {})
+      data, _status_code, _headers = get_integration_log_with_http_info(pk, sk, opts)
+      data
+    end
+
+    # Retrieve an integration log
+    # Retrieve an integration logs from the account based identifiers 
+    # @param pk 
+    # @param sk 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IntegrationLog, Fixnum, Hash)>] IntegrationLog data, response status code and response headers
+    def get_integration_log_with_http_info(pk, sk, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log ...'
+      end
+      # verify the required parameter 'pk' is set
+      if @api_client.config.client_side_validation && pk.nil?
+        fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log"
+      end
+      # verify the required parameter 'sk' is set
+      if @api_client.config.client_side_validation && sk.nil?
+        fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log"
+      end
+      # resource path
+      local_var_path = '/integration_log/query/{pk}/{sk}'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'IntegrationLog')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve integration logs
+    # Retrieves a set of integration logs from the account based on a query object. 
+    # @param integration_log_query Integration log query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [IntegrationLogQueryResponse]
+    def get_integration_logs_query(integration_log_query, opts = {})
+      data, _status_code, _headers = get_integration_logs_query_with_http_info(integration_log_query, opts)
+      data
+    end
+
+    # Retrieve integration logs
+    # Retrieves a set of integration logs from the account based on a query object. 
+    # @param integration_log_query Integration log query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @return [Array<(IntegrationLogQueryResponse, Fixnum, Hash)>] IntegrationLogQueryResponse data, response status code and response headers
+    def get_integration_logs_query_with_http_info(integration_log_query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_logs_query ...'
+      end
+      # verify the required parameter 'integration_log_query' is set
+      if @api_client.config.client_side_validation && integration_log_query.nil?
+        fail ArgumentError, "Missing the required parameter 'integration_log_query' when calling IntegrationLogApi.get_integration_logs_query"
+      end
+      # resource path
+      local_var_path = '/integration_log/query'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(integration_log_query)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'IntegrationLogQueryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_logs_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end