ultracart_api 3.1.43 → 3.1.48

Sign up to get free protection for your applications and to get access to all the features.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -5
  3. data/docs/Error.md +1 -0
  4. data/docs/IntegrationLog.md +22 -0
  5. data/docs/IntegrationLogApi.md +121 -0
  6. data/docs/IntegrationLogFile.md +10 -0
  7. data/docs/IntegrationLogLog.md +9 -0
  8. data/docs/IntegrationLogQueryFilterValues.md +16 -0
  9. data/docs/IntegrationLogQueryRequest.md +19 -0
  10. data/docs/IntegrationLogQueryResponse.md +13 -0
  11. data/docs/ItemChannelPartnerMapping.md +1 -0
  12. data/docs/ItemReviews.md +2 -0
  13. data/docs/ScreenRecordingHeatmapIndexRequest.md +8 -0
  14. data/docs/ScreenRecordingHeatmapUrl.md +1 -0
  15. data/docs/StorefrontApi.md +13 -2
  16. data/lib/ultracart_api.rb +8 -0
  17. data/lib/ultracart_api/api/integration_log_api.rb +161 -0
  18. data/lib/ultracart_api/api/storefront_api.rb +19 -4
  19. data/lib/ultracart_api/models/error.rb +11 -1
  20. data/lib/ultracart_api/models/integration_log.rb +316 -0
  21. data/lib/ultracart_api/models/integration_log_file.rb +202 -0
  22. data/lib/ultracart_api/models/integration_log_log.rb +193 -0
  23. data/lib/ultracart_api/models/integration_log_query_filter_values.rb +274 -0
  24. data/lib/ultracart_api/models/integration_log_query_request.rb +289 -0
  25. data/lib/ultracart_api/models/integration_log_query_response.rb +232 -0
  26. data/lib/ultracart_api/models/item_channel_partner_mapping.rb +11 -1
  27. data/lib/ultracart_api/models/item_reviews.rb +24 -4
  28. data/lib/ultracart_api/models/screen_recording_heatmap_index_request.rb +184 -0
  29. data/lib/ultracart_api/models/screen_recording_heatmap_url.rb +10 -1
  30. data/lib/ultracart_api/version.rb +1 -1
  31. metadata +18 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a584bb7f1b5227ef69f544f4ec4def7c4ca7ea7518df56e6c5eafc0a49a4ed7
4
- data.tar.gz: 07d1a2187132a73f168b8148ecb48fd9c4c2270643682ea453b089203f789698
3
+ metadata.gz: 15a4920821243ee879d4dd4e8a66fb03fb5a88cf02854920787e45bce9e8ef00
4
+ data.tar.gz: 03a59ca867aeb01f41814dd5b3fa80aacd6674befd244dc60f5465bdba11b20d
5
5
  SHA512:
6
- metadata.gz: 137591dbcaf512304fc96557366f1fafcbd513dd4f51279eedb45b6416bcb5cfb09a12c6658d5545f455fa6ae1c2e58441f53748c66475bc05dcbd7118a33d05
7
- data.tar.gz: 786156668460d885e03803fdc77a28238d8a67d54b8c8013025827db8c170bbd5ad07ed8be1b72fbfce30e59c659cb99a537f18623e082ba4508a74f33631aae
6
+ metadata.gz: e0d31acc4523ec97641b0472536ff8422cbea2584121cf21efce65305afc933213bfa87ed5484bcd83f370d18f0148da11f8038ef5b69c8de34c7e443b717fd1
7
+ data.tar.gz: 74e80fdcae47129b64fed3dcda13545347c33ad51fa1d01ae493793e79c8792cd86bfa0d446b0ee09d64260b86d92c4be9945d2491b8df5d6c8e88f9aaed45a1
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.1.43
10
+ - Package version: 3.1.48
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.1.43.gem
27
+ gem install ./ultracart_api-3.1.48.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.1.43.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.1.48.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.1.43'
35
+ gem 'ultracart_api', '~> 3.1.48'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -157,6 +157,8 @@ Class | Method | HTTP request | Description
157
157
  *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
158
158
  *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
159
159
  *UltracartClient::FulfillmentApi* | [**update_inventory**](docs/FulfillmentApi.md#update_inventory) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/inventory | Update inventory
160
+ *UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
161
+ *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
160
162
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
161
163
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
162
164
  *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
694
696
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
695
697
  - [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
696
698
  - [UltracartClient::HTTPHeader](docs/HTTPHeader.md)
699
+ - [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
700
+ - [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
701
+ - [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
702
+ - [UltracartClient::IntegrationLogQueryFilterValues](docs/IntegrationLogQueryFilterValues.md)
703
+ - [UltracartClient::IntegrationLogQueryRequest](docs/IntegrationLogQueryRequest.md)
704
+ - [UltracartClient::IntegrationLogQueryResponse](docs/IntegrationLogQueryResponse.md)
697
705
  - [UltracartClient::Item](docs/Item.md)
698
706
  - [UltracartClient::ItemAccounting](docs/ItemAccounting.md)
699
707
  - [UltracartClient::ItemAmember](docs/ItemAmember.md)
@@ -874,6 +882,7 @@ Class | Method | HTTP request | Description
874
882
  - [UltracartClient::ScreenRecordingFilterValuesPageParam](docs/ScreenRecordingFilterValuesPageParam.md)
875
883
  - [UltracartClient::ScreenRecordingFilterValuesPageView](docs/ScreenRecordingFilterValuesPageView.md)
876
884
  - [UltracartClient::ScreenRecordingHeatmap](docs/ScreenRecordingHeatmap.md)
885
+ - [UltracartClient::ScreenRecordingHeatmapIndexRequest](docs/ScreenRecordingHeatmapIndexRequest.md)
877
886
  - [UltracartClient::ScreenRecordingHeatmapIndexResponse](docs/ScreenRecordingHeatmapIndexResponse.md)
878
887
  - [UltracartClient::ScreenRecordingHeatmapRequest](docs/ScreenRecordingHeatmapRequest.md)
879
888
  - [UltracartClient::ScreenRecordingHeatmapReset](docs/ScreenRecordingHeatmapReset.md)
@@ -1019,7 +1028,10 @@ Not every change is committed to every SDK.
1019
1028
 
1020
1029
  | Version | Date | Comments |
1021
1030
  | --: | :-: | --- |
1022
- | 3.1.43 | 06/01/2021 | one of us cannot spell, not saying who |
1031
+ | 3.1.47 | 06/16/2021 | Integrated Logging Rest API |
1032
+ | 3.1.46 | 06/14/2021 | Screen recording: server side paginated heat map index with url contains filters, Item: channel partner item mapping unit cost override |
1033
+ | 3.1.44 | 06/02/2021 | new boolean flag on items object to allow sharing of reviews between items |
1034
+ | 3.1.43 | 06/01/2021 | fix item serialized name of item serialized name for channel partner item mappings |
1023
1035
  | 3.1.42 | 06/01/2021 | added quickbooks accounting codes at the tiered level for tiered coupons |
1024
1036
  | 3.1.41 | 05/21/2021 | screen recording heatmap methods |
1025
1037
  | 3.1.40 | 05/20/2021 | Order.summary.actual_payment_processing field added |
data/docs/Error.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **developer_message** | **String** | A technical message meant to be read by a developer | [optional]
7
7
  **error_code** | **String** | HTTP status code | [optional]
8
8
  **more_info** | **String** | Additional information often a link to additional documentation | [optional]
9
+ **object_id** | **String** | Object id that the error is associated with | [optional]
9
10
  **user_message** | **String** | An end-user friendly message suitable for display to the customer | [optional]
10
11
 
11
12
 
@@ -0,0 +1,22 @@
1
+ # UltracartClient::IntegrationLog
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | | [optional]
7
+ **direction** | **String** | | [optional]
8
+ **email** | **String** | | [optional]
9
+ **files** | [**Array<IntegrationLogFile>**](IntegrationLogFile.md) | | [optional]
10
+ **integration_log_oid** | **Integer** | | [optional]
11
+ **item_id** | **String** | | [optional]
12
+ **item_ipn_oid** | **Integer** | | [optional]
13
+ **log_dts** | **String** | | [optional]
14
+ **log_type** | **String** | | [optional]
15
+ **logger_id** | **String** | | [optional]
16
+ **logs** | [**Array<IntegrationLogLog>**](IntegrationLogLog.md) | | [optional]
17
+ **order_ids** | **Array<String>** | | [optional]
18
+ **pk** | **String** | | [optional]
19
+ **sk** | **String** | | [optional]
20
+ **status** | **String** | | [optional]
21
+
22
+
@@ -0,0 +1,121 @@
1
+ # UltracartClient::IntegrationLogApi
2
+
3
+ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
8
+ [**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
9
+
10
+
11
+ # **get_integration_log**
12
+ > IntegrationLog get_integration_log(pk, sk)
13
+
14
+ Retrieve an integration log
15
+
16
+ Retrieve an integration logs from the account based identifiers
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'ultracart_api'
22
+
23
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
24
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
25
+ api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
26
+
27
+
28
+ pk = 'pk_example' # String |
29
+
30
+ sk = 'sk_example' # String |
31
+
32
+
33
+ begin
34
+ #Retrieve an integration log
35
+ result = api_instance.get_integration_log(pk, sk)
36
+ p result
37
+ rescue UltracartClient::ApiError => e
38
+ puts "Exception when calling IntegrationLogApi->get_integration_log: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **pk** | **String**| |
47
+ **sk** | **String**| |
48
+
49
+ ### Return type
50
+
51
+ [**IntegrationLog**](IntegrationLog.md)
52
+
53
+ ### Authorization
54
+
55
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json
60
+ - **Accept**: application/json
61
+
62
+
63
+
64
+ # **get_integration_logs_query**
65
+ > IntegrationLogQueryResponse get_integration_logs_query(integration_log_query, opts)
66
+
67
+ Retrieve integration logs
68
+
69
+ Retrieves a set of integration logs from the account based on a query object.
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'ultracart_api'
75
+
76
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
77
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
78
+ api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
79
+
80
+
81
+ integration_log_query = UltracartClient::IntegrationLogQueryRequest.new # IntegrationLogQueryRequest | Integration log query
82
+
83
+ opts = {
84
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
85
+ _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
86
+ _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.
87
+ }
88
+
89
+ begin
90
+ #Retrieve integration logs
91
+ result = api_instance.get_integration_logs_query(integration_log_query, opts)
92
+ p result
93
+ rescue UltracartClient::ApiError => e
94
+ puts "Exception when calling IntegrationLogApi->get_integration_logs_query: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **integration_log_query** | [**IntegrationLogQueryRequest**](IntegrationLogQueryRequest.md)| Integration log query |
103
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
104
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
105
+ **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
106
+
107
+ ### Return type
108
+
109
+ [**IntegrationLogQueryResponse**](IntegrationLogQueryResponse.md)
110
+
111
+ ### Authorization
112
+
113
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: application/json
118
+ - **Accept**: application/json
119
+
120
+
121
+
@@ -0,0 +1,10 @@
1
+ # UltracartClient::IntegrationLogFile
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **size** | **Integer** | | [optional]
8
+ **uuid** | **String** | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # UltracartClient::IntegrationLogLog
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **contents** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,16 @@
1
+ # UltracartClient::IntegrationLogQueryFilterValues
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **actions** | **Array<String>** | | [optional]
7
+ **directions** | **Array<String>** | | [optional]
8
+ **emails** | **Array<String>** | | [optional]
9
+ **file_names** | **Array<String>** | | [optional]
10
+ **item_ids** | **Array<String>** | | [optional]
11
+ **item_ipn_oids** | **Array<Integer>** | | [optional]
12
+ **log_types** | **Array<String>** | | [optional]
13
+ **order_ids** | **Array<String>** | | [optional]
14
+ **statuses** | **Array<String>** | | [optional]
15
+
16
+
@@ -0,0 +1,19 @@
1
+ # UltracartClient::IntegrationLogQueryRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **action** | **String** | | [optional]
7
+ **direction** | **String** | | [optional]
8
+ **email** | **String** | | [optional]
9
+ **file_names** | **Array<String>** | | [optional]
10
+ **item_id** | **String** | | [optional]
11
+ **item_ipn_oid** | **Integer** | | [optional]
12
+ **log_dts_begin** | **String** | Log date/time begin | [optional]
13
+ **log_dts_end** | **String** | Log date/time end | [optional]
14
+ **log_type** | **String** | | [optional]
15
+ **logger_id** | **String** | | [optional]
16
+ **order_ids** | **Array<String>** | | [optional]
17
+ **status** | **String** | | [optional]
18
+
19
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::IntegrationLogQueryResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **filter_values** | [**IntegrationLogQueryFilterValues**](IntegrationLogQueryFilterValues.md) | | [optional]
8
+ **integration_logs** | [**Array<IntegrationLog>**](IntegrationLog.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **buyer_item_number** | **String** | Buyer item number (EDI only) | [optional]
13
13
  **channel_partner_code** | **String** | Channel partner code | [optional]
14
14
  **channel_partner_oid** | **Integer** | Channel partner object identifier | [optional]
15
+ **cost** | **Float** | Cost given to this channel partner | [optional]
15
16
  **from_item_id** | **String** | From Item ID | [optional]
16
17
  **from_sku** | **String** | From SKU | [optional]
17
18
  **mutually_defined_number** | **String** | Mutually defined number (EDI only) | [optional]
data/docs/ItemReviews.md CHANGED
@@ -10,5 +10,7 @@ Name | Type | Description | Notes
10
10
  **review_template_name** | **String** | Review template name | [optional]
11
11
  **review_template_oid** | **Integer** | Review template object identifier | [optional]
12
12
  **reviewable** | **BOOLEAN** | True if the item is reviewable | [optional]
13
+ **share_reviews_with_merchant_item_id** | **String** | Share reviews with item id. To set, use the share_reviews_with_merchant_item_oid field. | [optional]
14
+ **share_reviews_with_merchant_item_oid** | **Integer** | Share reviews with item oid. To null out this field, set teh value to zero. | [optional]
13
15
 
14
16
 
@@ -0,0 +1,8 @@
1
+ # UltracartClient::ScreenRecordingHeatmapIndexRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url_contains** | **String** | | [optional]
7
+
8
+
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **histogram_data** | **Array<Integer>** | | [optional]
7
7
  **histogram_interval** | **String** | | [optional]
8
8
  **histogram_start_dts** | **String** | | [optional]
9
+ **page_rank** | **Integer** | | [optional]
9
10
  **session_count** | **Integer** | | [optional]
10
11
  **url** | **String** | | [optional]
11
12
 
@@ -4119,7 +4119,7 @@ Name | Type | Description | Notes
4119
4119
 
4120
4120
 
4121
4121
  # **get_heatmap_index**
4122
- > ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid)
4122
+ > ScreenRecordingHeatmapIndexResponse get_heatmap_index(storefront_oid, query, opts)
4123
4123
 
4124
4124
  Get screen recording heatmap index
4125
4125
 
@@ -4137,10 +4137,17 @@ api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, fals
4137
4137
 
4138
4138
  storefront_oid = 56 # Integer |
4139
4139
 
4140
+ query = UltracartClient::ScreenRecordingHeatmapIndexRequest.new # ScreenRecordingHeatmapIndexRequest | Query
4141
+
4142
+ opts = {
4143
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
4144
+ _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
4145
+ _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.
4146
+ }
4140
4147
 
4141
4148
  begin
4142
4149
  #Get screen recording heatmap index
4143
- result = api_instance.get_heatmap_index(storefront_oid)
4150
+ result = api_instance.get_heatmap_index(storefront_oid, query, opts)
4144
4151
  p result
4145
4152
  rescue UltracartClient::ApiError => e
4146
4153
  puts "Exception when calling StorefrontApi->get_heatmap_index: #{e}"
@@ -4152,6 +4159,10 @@ end
4152
4159
  Name | Type | Description | Notes
4153
4160
  ------------- | ------------- | ------------- | -------------
4154
4161
  **storefront_oid** | **Integer**| |
4162
+ **query** | [**ScreenRecordingHeatmapIndexRequest**](ScreenRecordingHeatmapIndexRequest.md)| Query |
4163
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Default 100, Max 500) | [optional] [default to 100]
4164
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
4165
+ **_sort** | **String**| The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
4155
4166
 
4156
4167
  ### Return type
4157
4168
 
data/lib/ultracart_api.rb CHANGED
@@ -325,6 +325,12 @@ require 'ultracart_api/models/group_response'
325
325
  require 'ultracart_api/models/group_user_membership'
326
326
  require 'ultracart_api/models/groups_response'
327
327
  require 'ultracart_api/models/http_header'
328
+ require 'ultracart_api/models/integration_log'
329
+ require 'ultracart_api/models/integration_log_file'
330
+ require 'ultracart_api/models/integration_log_log'
331
+ require 'ultracart_api/models/integration_log_query_filter_values'
332
+ require 'ultracart_api/models/integration_log_query_request'
333
+ require 'ultracart_api/models/integration_log_query_response'
328
334
  require 'ultracart_api/models/item'
329
335
  require 'ultracart_api/models/item_accounting'
330
336
  require 'ultracart_api/models/item_amember'
@@ -505,6 +511,7 @@ require 'ultracart_api/models/screen_recording_filter_values_event_params'
505
511
  require 'ultracart_api/models/screen_recording_filter_values_page_param'
506
512
  require 'ultracart_api/models/screen_recording_filter_values_page_view'
507
513
  require 'ultracart_api/models/screen_recording_heatmap'
514
+ require 'ultracart_api/models/screen_recording_heatmap_index_request'
508
515
  require 'ultracart_api/models/screen_recording_heatmap_index_response'
509
516
  require 'ultracart_api/models/screen_recording_heatmap_request'
510
517
  require 'ultracart_api/models/screen_recording_heatmap_reset'
@@ -599,6 +606,7 @@ require 'ultracart_api/api/checkout_api'
599
606
  require 'ultracart_api/api/coupon_api'
600
607
  require 'ultracart_api/api/customer_api'
601
608
  require 'ultracart_api/api/fulfillment_api'
609
+ require 'ultracart_api/api/integration_log_api'
602
610
  require 'ultracart_api/api/item_api'
603
611
  require 'ultracart_api/api/oauth_api'
604
612
  require 'ultracart_api/api/order_api'
@@ -0,0 +1,161 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module UltracartClient
16
+ class IntegrationLogApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
24
+ api_config = Configuration.new
25
+ api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
26
+ api_config.api_version = '2017-03-01'
27
+ api_config.verify_ssl = verify_ssl
28
+
29
+ api_client = ApiClient.new(api_config)
30
+ api_client.config.debugging = debugging
31
+
32
+ UltracartClient::IntegrationLogApi.new(api_client)
33
+ end
34
+
35
+ # Retrieve an integration log
36
+ # Retrieve an integration logs from the account based identifiers
37
+ # @param pk
38
+ # @param sk
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [IntegrationLog]
41
+ def get_integration_log(pk, sk, opts = {})
42
+ data, _status_code, _headers = get_integration_log_with_http_info(pk, sk, opts)
43
+ data
44
+ end
45
+
46
+ # Retrieve an integration log
47
+ # Retrieve an integration logs from the account based identifiers
48
+ # @param pk
49
+ # @param sk
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [Array<(IntegrationLog, Fixnum, Hash)>] IntegrationLog data, response status code and response headers
52
+ def get_integration_log_with_http_info(pk, sk, opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log ...'
55
+ end
56
+ # verify the required parameter 'pk' is set
57
+ if @api_client.config.client_side_validation && pk.nil?
58
+ fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log"
59
+ end
60
+ # verify the required parameter 'sk' is set
61
+ if @api_client.config.client_side_validation && sk.nil?
62
+ fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log"
63
+ end
64
+ # resource path
65
+ local_var_path = '/integration_log/query/{pk}/{sk}'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s)
66
+
67
+ # query parameters
68
+ query_params = {}
69
+
70
+ # header parameters
71
+ header_params = {}
72
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
+ # HTTP header 'Content-Type'
76
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
77
+
78
+ # form parameters
79
+ form_params = {}
80
+
81
+ # http body (model)
82
+ post_body = nil
83
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
84
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => 'IntegrationLog')
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+ # Retrieve integration logs
97
+ # Retrieves a set of integration logs from the account based on a query object.
98
+ # @param integration_log_query Integration log query
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)
101
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
102
+ # @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.
103
+ # @return [IntegrationLogQueryResponse]
104
+ def get_integration_logs_query(integration_log_query, opts = {})
105
+ data, _status_code, _headers = get_integration_logs_query_with_http_info(integration_log_query, opts)
106
+ data
107
+ end
108
+
109
+ # Retrieve integration logs
110
+ # Retrieves a set of integration logs from the account based on a query object.
111
+ # @param integration_log_query Integration log query
112
+ # @param [Hash] opts the optional parameters
113
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 500)
114
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
115
+ # @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.
116
+ # @return [Array<(IntegrationLogQueryResponse, Fixnum, Hash)>] IntegrationLogQueryResponse data, response status code and response headers
117
+ def get_integration_logs_query_with_http_info(integration_log_query, opts = {})
118
+ if @api_client.config.debugging
119
+ @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_logs_query ...'
120
+ end
121
+ # verify the required parameter 'integration_log_query' is set
122
+ if @api_client.config.client_side_validation && integration_log_query.nil?
123
+ fail ArgumentError, "Missing the required parameter 'integration_log_query' when calling IntegrationLogApi.get_integration_logs_query"
124
+ end
125
+ # resource path
126
+ local_var_path = '/integration_log/query'
127
+
128
+ # query parameters
129
+ query_params = {}
130
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
131
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
132
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
133
+
134
+ # header parameters
135
+ header_params = {}
136
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
137
+ # HTTP header 'Accept' (if needed)
138
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
139
+ # HTTP header 'Content-Type'
140
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
141
+
142
+ # form parameters
143
+ form_params = {}
144
+
145
+ # http body (model)
146
+ post_body = @api_client.object_to_http_body(integration_log_query)
147
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
148
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
149
+ :header_params => header_params,
150
+ :query_params => query_params,
151
+ :form_params => form_params,
152
+ :body => post_body,
153
+ :auth_names => auth_names,
154
+ :return_type => 'IntegrationLogQueryResponse')
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_logs_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+ end
161
+ end