docs/IntegrationLogApi.md in ultracart_api-3.10.220 vs docs/IntegrationLogApi.md in ultracart_api-4.0.32.rc

- old
+ new

@@ -1,286 +1,400 @@ -# 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_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file -[**get_integration_log_file_pdf**](IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF -[**get_integration_log_summaries_query**](IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries -[**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs - - -# **get_integration_log** -> IntegrationLogResponse 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 - -[**IntegrationLogResponse**](IntegrationLogResponse.md) - -### Authorization - -[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - - -# **get_integration_log_file** -> File get_integration_log_file(pk, sk, uuid) - -Retrieve an integration log file - -Retrieve an integration log file 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 | - -uuid = 'uuid_example' # String | - - -begin - #Retrieve an integration log file - result = api_instance.get_integration_log_file(pk, sk, uuid) - p result -rescue UltracartClient::ApiError => e - puts "Exception when calling IntegrationLogApi->get_integration_log_file: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pk** | **String**| | - **sk** | **String**| | - **uuid** | **String**| | - -### Return type - -**File** - -### Authorization - -[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/octet-stream - - - -# **get_integration_log_file_pdf** -> File get_integration_log_file_pdf(pk, sk, uuid) - -Retrieve an integration log file converted to PDF - -Retrieve an integration log file 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 | - -uuid = 'uuid_example' # String | - - -begin - #Retrieve an integration log file converted to PDF - result = api_instance.get_integration_log_file_pdf(pk, sk, uuid) - p result -rescue UltracartClient::ApiError => e - puts "Exception when calling IntegrationLogApi->get_integration_log_file_pdf: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pk** | **String**| | - **sk** | **String**| | - **uuid** | **String**| | - -### Return type - -**File** - -### Authorization - -[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/octet-stream - - - -# **get_integration_log_summaries_query** -> IntegrationLogSummaryQueryResponse get_integration_log_summaries_query(integration_log_summaries_query) - -Retrieve integration log summaries - -Retrieves a set of integration log summaries 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_summaries_query = UltracartClient::IntegrationLogSummaryQueryRequest.new # IntegrationLogSummaryQueryRequest | Integration log summaries query - - -begin - #Retrieve integration log summaries - result = api_instance.get_integration_log_summaries_query(integration_log_summaries_query) - p result -rescue UltracartClient::ApiError => e - puts "Exception when calling IntegrationLogApi->get_integration_log_summaries_query: #{e}" -end -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **integration_log_summaries_query** | [**IntegrationLogSummaryQueryRequest**](IntegrationLogSummaryQueryRequest.md)| Integration log summaries query | - -### Return type - -[**IntegrationLogSummaryQueryResponse**](IntegrationLogSummaryQueryResponse.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 - - - +# 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_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file | +| [**get_integration_log_file_pdf**](IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF | +| [**get_integration_log_summaries_query**](IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries | +| [**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs | + + +## get_integration_log + +> <IntegrationLogResponse> get_integration_log(pk, sk) + +Retrieve an integration log + +Retrieve an integration logs from the account based identifiers + +### Examples + +```ruby +require 'time' +require 'ultracart_api' +# setup authorization +UltracartClient.configure do |config| + # Configure OAuth2 access token for authorization: ultraCartOauth + config.access_token = 'YOUR ACCESS TOKEN' + + # Configure API key authorization: ultraCartSimpleApiKey + config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer' +end + +api_instance = UltracartClient::IntegrationLogApi.new +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 "Error when calling IntegrationLogApi->get_integration_log: #{e}" +end +``` + +#### Using the get_integration_log_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<IntegrationLogResponse>, Integer, Hash)> get_integration_log_with_http_info(pk, sk) + +```ruby +begin + # Retrieve an integration log + data, status_code, headers = api_instance.get_integration_log_with_http_info(pk, sk) + p status_code # => 2xx + p headers # => { ... } + p data # => <IntegrationLogResponse> +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **pk** | **String** | | | +| **sk** | **String** | | | + +### Return type + +[**IntegrationLogResponse**](IntegrationLogResponse.md) + +### Authorization + +[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_integration_log_file + +> File get_integration_log_file(pk, sk, uuid) + +Retrieve an integration log file + +Retrieve an integration log file from the account based identifiers + +### Examples + +```ruby +require 'time' +require 'ultracart_api' +# setup authorization +UltracartClient.configure do |config| + # Configure OAuth2 access token for authorization: ultraCartOauth + config.access_token = 'YOUR ACCESS TOKEN' + + # Configure API key authorization: ultraCartSimpleApiKey + config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer' +end + +api_instance = UltracartClient::IntegrationLogApi.new +pk = 'pk_example' # String | +sk = 'sk_example' # String | +uuid = 'uuid_example' # String | + +begin + # Retrieve an integration log file + result = api_instance.get_integration_log_file(pk, sk, uuid) + p result +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_file: #{e}" +end +``` + +#### Using the get_integration_log_file_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(File, Integer, Hash)> get_integration_log_file_with_http_info(pk, sk, uuid) + +```ruby +begin + # Retrieve an integration log file + data, status_code, headers = api_instance.get_integration_log_file_with_http_info(pk, sk, uuid) + p status_code # => 2xx + p headers # => { ... } + p data # => File +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_file_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **pk** | **String** | | | +| **sk** | **String** | | | +| **uuid** | **String** | | | + +### Return type + +**File** + +### Authorization + +[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/octet-stream + + +## get_integration_log_file_pdf + +> File get_integration_log_file_pdf(pk, sk, uuid) + +Retrieve an integration log file converted to PDF + +Retrieve an integration log file from the account based identifiers + +### Examples + +```ruby +require 'time' +require 'ultracart_api' +# setup authorization +UltracartClient.configure do |config| + # Configure OAuth2 access token for authorization: ultraCartOauth + config.access_token = 'YOUR ACCESS TOKEN' + + # Configure API key authorization: ultraCartSimpleApiKey + config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer' +end + +api_instance = UltracartClient::IntegrationLogApi.new +pk = 'pk_example' # String | +sk = 'sk_example' # String | +uuid = 'uuid_example' # String | + +begin + # Retrieve an integration log file converted to PDF + result = api_instance.get_integration_log_file_pdf(pk, sk, uuid) + p result +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_file_pdf: #{e}" +end +``` + +#### Using the get_integration_log_file_pdf_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(File, Integer, Hash)> get_integration_log_file_pdf_with_http_info(pk, sk, uuid) + +```ruby +begin + # Retrieve an integration log file converted to PDF + data, status_code, headers = api_instance.get_integration_log_file_pdf_with_http_info(pk, sk, uuid) + p status_code # => 2xx + p headers # => { ... } + p data # => File +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_file_pdf_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **pk** | **String** | | | +| **sk** | **String** | | | +| **uuid** | **String** | | | + +### Return type + +**File** + +### Authorization + +[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/octet-stream + + +## get_integration_log_summaries_query + +> <IntegrationLogSummaryQueryResponse> get_integration_log_summaries_query(integration_log_summaries_query) + +Retrieve integration log summaries + +Retrieves a set of integration log summaries from the account based on a query object. + +### Examples + +```ruby +require 'time' +require 'ultracart_api' +# setup authorization +UltracartClient.configure do |config| + # Configure OAuth2 access token for authorization: ultraCartOauth + config.access_token = 'YOUR ACCESS TOKEN' + + # Configure API key authorization: ultraCartSimpleApiKey + config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer' +end + +api_instance = UltracartClient::IntegrationLogApi.new +integration_log_summaries_query = UltracartClient::IntegrationLogSummaryQueryRequest.new # IntegrationLogSummaryQueryRequest | Integration log summaries query + +begin + # Retrieve integration log summaries + result = api_instance.get_integration_log_summaries_query(integration_log_summaries_query) + p result +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_summaries_query: #{e}" +end +``` + +#### Using the get_integration_log_summaries_query_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<IntegrationLogSummaryQueryResponse>, Integer, Hash)> get_integration_log_summaries_query_with_http_info(integration_log_summaries_query) + +```ruby +begin + # Retrieve integration log summaries + data, status_code, headers = api_instance.get_integration_log_summaries_query_with_http_info(integration_log_summaries_query) + p status_code # => 2xx + p headers # => { ... } + p data # => <IntegrationLogSummaryQueryResponse> +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_log_summaries_query_with_http_info: #{e}" +end +``` + +### Parameters + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| **integration_log_summaries_query** | [**IntegrationLogSummaryQueryRequest**](IntegrationLogSummaryQueryRequest.md) | Integration log summaries query | | + +### Return type + +[**IntegrationLogSummaryQueryResponse**](IntegrationLogSummaryQueryResponse.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. + +### Examples + +```ruby +require 'time' +require 'ultracart_api' +# setup authorization +UltracartClient.configure do |config| + # Configure OAuth2 access token for authorization: ultraCartOauth + config.access_token = 'YOUR ACCESS TOKEN' + + # Configure API key authorization: ultraCartSimpleApiKey + config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer' +end + +api_instance = UltracartClient::IntegrationLogApi.new +integration_log_query = UltracartClient::IntegrationLogQueryRequest.new # IntegrationLogQueryRequest | Integration log query +opts = { + _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500) + _offset: 56, # 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 "Error when calling IntegrationLogApi->get_integration_logs_query: #{e}" +end +``` + +#### Using the get_integration_logs_query_with_http_info variant + +This returns an Array which contains the response data, status code and headers. + +> <Array(<IntegrationLogQueryResponse>, Integer, Hash)> get_integration_logs_query_with_http_info(integration_log_query, opts) + +```ruby +begin + # Retrieve integration logs + data, status_code, headers = api_instance.get_integration_logs_query_with_http_info(integration_log_query, opts) + p status_code # => 2xx + p headers # => { ... } + p data # => <IntegrationLogQueryResponse> +rescue UltracartClient::ApiError => e + puts "Error when calling IntegrationLogApi->get_integration_logs_query_with_http_info: #{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 +