ultracart_api 3.10.123 → 3.10.125
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +37 -4
- data/docs/DatawarehouseApi.md +461 -0
- data/docs/OrderRefundableResponse.md +1 -0
- data/docs/Report.md +17 -0
- data/docs/ReportAuth.md +11 -0
- data/docs/ReportAuthResponse.md +12 -0
- data/docs/ReportDataSet.md +22 -0
- data/docs/ReportDataSetColumn.md +8 -0
- data/docs/ReportDataSetPage.md +17 -0
- data/docs/ReportDataSetPageResponse.md +12 -0
- data/docs/ReportDataSetQuery.md +19 -0
- data/docs/ReportDataSetResponse.md +12 -0
- data/docs/ReportDataSetRow.md +8 -0
- data/docs/ReportDataSetSchema.md +9 -0
- data/docs/ReportDataSource.md +13 -0
- data/docs/ReportDataSourceSchema.md +10 -0
- data/docs/ReportExecuteQueriesRequest.md +14 -0
- data/docs/ReportFilter.md +13 -0
- data/docs/ReportFilterConnection.md +9 -0
- data/docs/ReportPage.md +11 -0
- data/docs/ReportPageVisualization.md +16 -0
- data/docs/ReportPageVisualizationDimension.md +14 -0
- data/docs/ReportPageVisualizationMetric.md +11 -0
- data/docs/ReportResponse.md +12 -0
- data/docs/ReportsResponse.md +12 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +529 -0
- data/lib/ultracart_api/models/order_refundable_response.rb +11 -1
- data/lib/ultracart_api/models/report.rb +307 -0
- data/lib/ultracart_api/models/report_auth.rb +212 -0
- data/lib/ultracart_api/models/report_auth_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set.rb +362 -0
- data/lib/ultracart_api/models/report_data_set_column.rb +184 -0
- data/lib/ultracart_api/models/report_data_set_page.rb +273 -0
- data/lib/ultracart_api/models/report_data_set_page_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set_query.rb +330 -0
- data/lib/ultracart_api/models/report_data_set_response.rb +221 -0
- data/lib/ultracart_api/models/report_data_set_row.rb +186 -0
- data/lib/ultracart_api/models/report_data_set_schema.rb +228 -0
- data/lib/ultracart_api/models/report_data_source.rb +232 -0
- data/lib/ultracart_api/models/report_data_source_schema.rb +238 -0
- data/lib/ultracart_api/models/report_execute_queries_request.rb +278 -0
- data/lib/ultracart_api/models/report_filter.rb +272 -0
- data/lib/ultracart_api/models/report_filter_connection.rb +193 -0
- data/lib/ultracart_api/models/report_page.rb +216 -0
- data/lib/ultracart_api/models/report_page_visualization.rb +299 -0
- data/lib/ultracart_api/models/report_page_visualization_dimension.rb +244 -0
- data/lib/ultracart_api/models/report_page_visualization_metric.rb +248 -0
- data/lib/ultracart_api/models/report_response.rb +221 -0
- data/lib/ultracart_api/models/reports_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +23 -0
- metadata +48 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bf58195910f46fde5ef8031b5cbc2558f7b9918a2e9488aa480130c14d356c48
|
4
|
+
data.tar.gz: e8072049e8bb737eccdeb5f3b152dd7e003e41a011caf016f1ee51a6e4fa21d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 23f21a0fa71d9e4310d912059868b9803973eeb764eea3f383946f0080855c0106f2da05adaa6f1ba9d5022f765bc31ba1ba64f29e759e804d7bcfff79d93b8e
|
7
|
+
data.tar.gz: 94d3421051eea455f89c066d9a1007673094be93f32074b10629699967b153fae8d4b4b23cba8dc12472e93646fbae94f1c1525f2b29f2c03be962256d9abd53
|
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.10.
|
10
|
+
- Package version: 3.10.125
|
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.10.
|
27
|
+
gem install ./ultracart_api-3.10.125.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.125.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.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.125'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -204,6 +204,15 @@ Class | Method | HTTP request | Description
|
|
204
204
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
205
205
|
*UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
206
206
|
*UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
207
|
+
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
208
|
+
*UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
209
|
+
*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
210
|
+
*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
211
|
+
*UltracartClient::DatawarehouseApi* | [**get_report_data_set_page**](docs/DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
|
212
|
+
*UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
213
|
+
*UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
214
|
+
*UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
215
|
+
*UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
207
216
|
*UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
|
208
217
|
*UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
|
209
218
|
*UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
|
@@ -1118,6 +1127,28 @@ Class | Method | HTTP request | Description
|
|
1118
1127
|
- [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
|
1119
1128
|
- [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
|
1120
1129
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
1130
|
+
- [UltracartClient::Report](docs/Report.md)
|
1131
|
+
- [UltracartClient::ReportAuth](docs/ReportAuth.md)
|
1132
|
+
- [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
|
1133
|
+
- [UltracartClient::ReportDataSet](docs/ReportDataSet.md)
|
1134
|
+
- [UltracartClient::ReportDataSetColumn](docs/ReportDataSetColumn.md)
|
1135
|
+
- [UltracartClient::ReportDataSetPage](docs/ReportDataSetPage.md)
|
1136
|
+
- [UltracartClient::ReportDataSetPageResponse](docs/ReportDataSetPageResponse.md)
|
1137
|
+
- [UltracartClient::ReportDataSetQuery](docs/ReportDataSetQuery.md)
|
1138
|
+
- [UltracartClient::ReportDataSetResponse](docs/ReportDataSetResponse.md)
|
1139
|
+
- [UltracartClient::ReportDataSetRow](docs/ReportDataSetRow.md)
|
1140
|
+
- [UltracartClient::ReportDataSetSchema](docs/ReportDataSetSchema.md)
|
1141
|
+
- [UltracartClient::ReportDataSource](docs/ReportDataSource.md)
|
1142
|
+
- [UltracartClient::ReportDataSourceSchema](docs/ReportDataSourceSchema.md)
|
1143
|
+
- [UltracartClient::ReportExecuteQueriesRequest](docs/ReportExecuteQueriesRequest.md)
|
1144
|
+
- [UltracartClient::ReportFilter](docs/ReportFilter.md)
|
1145
|
+
- [UltracartClient::ReportFilterConnection](docs/ReportFilterConnection.md)
|
1146
|
+
- [UltracartClient::ReportPage](docs/ReportPage.md)
|
1147
|
+
- [UltracartClient::ReportPageVisualization](docs/ReportPageVisualization.md)
|
1148
|
+
- [UltracartClient::ReportPageVisualizationDimension](docs/ReportPageVisualizationDimension.md)
|
1149
|
+
- [UltracartClient::ReportPageVisualizationMetric](docs/ReportPageVisualizationMetric.md)
|
1150
|
+
- [UltracartClient::ReportResponse](docs/ReportResponse.md)
|
1151
|
+
- [UltracartClient::ReportsResponse](docs/ReportsResponse.md)
|
1121
1152
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
1122
1153
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
1123
1154
|
- [UltracartClient::RulerValidationRequest](docs/RulerValidationRequest.md)
|
@@ -1307,6 +1338,8 @@ Not every change is committed to every SDK.
|
|
1307
1338
|
|
1308
1339
|
| Version | Date | Comments |
|
1309
1340
|
| --: | :-: | --- |
|
1341
|
+
| 3.10.125 | 03/22/2023 | dw initial framework |
|
1342
|
+
| 3.10.124 | 03/22/2023 | order api - refundable response added manual_because_multiple_charges boolean field |
|
1310
1343
|
| 3.10.123 | 03/21/2023 | order api - new stage named Hold |
|
1311
1344
|
| 3.10.122 | 03/14/2023 | order.getOrderEdiDocuments |
|
1312
1345
|
| 3.10.121 | 03/01/2023 | convo - add sentiment record to conversation obj |
|
@@ -0,0 +1,461 @@
|
|
1
|
+
# UltracartClient::DatawarehouseApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
8
|
+
[**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
9
|
+
[**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
10
|
+
[**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
11
|
+
[**get_report_data_set_page**](DatawarehouseApi.md#get_report_data_set_page) | **GET** /datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number} | Get a report data set page
|
12
|
+
[**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
13
|
+
[**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
14
|
+
[**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
15
|
+
[**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
16
|
+
|
17
|
+
|
18
|
+
# **delete_report**
|
19
|
+
> delete_report(report_oid)
|
20
|
+
|
21
|
+
Delete a report
|
22
|
+
|
23
|
+
Delete a report on the UltraCart account.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
```ruby
|
27
|
+
# load the gem
|
28
|
+
require 'ultracart_api'
|
29
|
+
|
30
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
31
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
32
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
33
|
+
|
34
|
+
|
35
|
+
report_oid = 56 # Integer | The report oid to delete.
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
#Delete a report
|
40
|
+
api_instance.delete_report(report_oid)
|
41
|
+
rescue UltracartClient::ApiError => e
|
42
|
+
puts "Exception when calling DatawarehouseApi->delete_report: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**report_oid** | **Integer**| The report oid to delete. |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
nil (empty response body)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: application/json
|
63
|
+
- **Accept**: application/json
|
64
|
+
|
65
|
+
|
66
|
+
|
67
|
+
# **execute_report_queries**
|
68
|
+
> execute_report_queries(query_request)
|
69
|
+
|
70
|
+
Execute the report queries
|
71
|
+
|
72
|
+
Execute the report queries
|
73
|
+
|
74
|
+
### Example
|
75
|
+
```ruby
|
76
|
+
# load the gem
|
77
|
+
require 'ultracart_api'
|
78
|
+
|
79
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
80
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
81
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
82
|
+
|
83
|
+
|
84
|
+
query_request = UltracartClient::ReportExecuteQueriesRequest.new # ReportExecuteQueriesRequest | Query request
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
#Execute the report queries
|
89
|
+
api_instance.execute_report_queries(query_request)
|
90
|
+
rescue UltracartClient::ApiError => e
|
91
|
+
puts "Exception when calling DatawarehouseApi->execute_report_queries: #{e}"
|
92
|
+
end
|
93
|
+
```
|
94
|
+
|
95
|
+
### Parameters
|
96
|
+
|
97
|
+
Name | Type | Description | Notes
|
98
|
+
------------- | ------------- | ------------- | -------------
|
99
|
+
**query_request** | [**ReportExecuteQueriesRequest**](ReportExecuteQueriesRequest.md)| Query request |
|
100
|
+
|
101
|
+
### Return type
|
102
|
+
|
103
|
+
nil (empty response body)
|
104
|
+
|
105
|
+
### Authorization
|
106
|
+
|
107
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
108
|
+
|
109
|
+
### HTTP request headers
|
110
|
+
|
111
|
+
- **Content-Type**: application/json
|
112
|
+
- **Accept**: application/json
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
# **get_report**
|
117
|
+
> ReportResponse get_report(report_oid)
|
118
|
+
|
119
|
+
Get a report
|
120
|
+
|
121
|
+
Retrieve a report
|
122
|
+
|
123
|
+
### Example
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'ultracart_api'
|
127
|
+
|
128
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
129
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
130
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
131
|
+
|
132
|
+
|
133
|
+
report_oid = 56 # Integer |
|
134
|
+
|
135
|
+
|
136
|
+
begin
|
137
|
+
#Get a report
|
138
|
+
result = api_instance.get_report(report_oid)
|
139
|
+
p result
|
140
|
+
rescue UltracartClient::ApiError => e
|
141
|
+
puts "Exception when calling DatawarehouseApi->get_report: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
### Parameters
|
146
|
+
|
147
|
+
Name | Type | Description | Notes
|
148
|
+
------------- | ------------- | ------------- | -------------
|
149
|
+
**report_oid** | **Integer**| |
|
150
|
+
|
151
|
+
### Return type
|
152
|
+
|
153
|
+
[**ReportResponse**](ReportResponse.md)
|
154
|
+
|
155
|
+
### Authorization
|
156
|
+
|
157
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
158
|
+
|
159
|
+
### HTTP request headers
|
160
|
+
|
161
|
+
- **Content-Type**: application/json
|
162
|
+
- **Accept**: application/json
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
# **get_report_data_set**
|
167
|
+
> ReportDataSetResponse get_report_data_set(dataset_uuid)
|
168
|
+
|
169
|
+
Get a report data set
|
170
|
+
|
171
|
+
Retrieve a report data set
|
172
|
+
|
173
|
+
### Example
|
174
|
+
```ruby
|
175
|
+
# load the gem
|
176
|
+
require 'ultracart_api'
|
177
|
+
|
178
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
179
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
180
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
181
|
+
|
182
|
+
|
183
|
+
dataset_uuid = 'dataset_uuid_example' # String |
|
184
|
+
|
185
|
+
|
186
|
+
begin
|
187
|
+
#Get a report data set
|
188
|
+
result = api_instance.get_report_data_set(dataset_uuid)
|
189
|
+
p result
|
190
|
+
rescue UltracartClient::ApiError => e
|
191
|
+
puts "Exception when calling DatawarehouseApi->get_report_data_set: #{e}"
|
192
|
+
end
|
193
|
+
```
|
194
|
+
|
195
|
+
### Parameters
|
196
|
+
|
197
|
+
Name | Type | Description | Notes
|
198
|
+
------------- | ------------- | ------------- | -------------
|
199
|
+
**dataset_uuid** | **String**| |
|
200
|
+
|
201
|
+
### Return type
|
202
|
+
|
203
|
+
[**ReportDataSetResponse**](ReportDataSetResponse.md)
|
204
|
+
|
205
|
+
### Authorization
|
206
|
+
|
207
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
208
|
+
|
209
|
+
### HTTP request headers
|
210
|
+
|
211
|
+
- **Content-Type**: application/json
|
212
|
+
- **Accept**: application/json
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
# **get_report_data_set_page**
|
217
|
+
> ReportDataSetPageResponse get_report_data_set_page(dataset_uuid, page_number)
|
218
|
+
|
219
|
+
Get a report data set page
|
220
|
+
|
221
|
+
Retrieve a report data set page
|
222
|
+
|
223
|
+
### Example
|
224
|
+
```ruby
|
225
|
+
# load the gem
|
226
|
+
require 'ultracart_api'
|
227
|
+
|
228
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
229
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
230
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
231
|
+
|
232
|
+
|
233
|
+
dataset_uuid = 'dataset_uuid_example' # String |
|
234
|
+
|
235
|
+
page_number = 56 # Integer |
|
236
|
+
|
237
|
+
|
238
|
+
begin
|
239
|
+
#Get a report data set page
|
240
|
+
result = api_instance.get_report_data_set_page(dataset_uuid, page_number)
|
241
|
+
p result
|
242
|
+
rescue UltracartClient::ApiError => e
|
243
|
+
puts "Exception when calling DatawarehouseApi->get_report_data_set_page: #{e}"
|
244
|
+
end
|
245
|
+
```
|
246
|
+
|
247
|
+
### Parameters
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**dataset_uuid** | **String**| |
|
252
|
+
**page_number** | **Integer**| |
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
[**ReportDataSetPageResponse**](ReportDataSetPageResponse.md)
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: application/json
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
# **get_report_websocket_authorization**
|
270
|
+
> ReportAuthResponse get_report_websocket_authorization
|
271
|
+
|
272
|
+
Get report websocket authorization
|
273
|
+
|
274
|
+
Retrieve a JWT to authorize a report to make a websocket connection.
|
275
|
+
|
276
|
+
### Example
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'ultracart_api'
|
280
|
+
|
281
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
282
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
283
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
begin
|
288
|
+
#Get report websocket authorization
|
289
|
+
result = api_instance.get_report_websocket_authorization
|
290
|
+
p result
|
291
|
+
rescue UltracartClient::ApiError => e
|
292
|
+
puts "Exception when calling DatawarehouseApi->get_report_websocket_authorization: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
### Parameters
|
297
|
+
This endpoint does not need any parameter.
|
298
|
+
|
299
|
+
### Return type
|
300
|
+
|
301
|
+
[**ReportAuthResponse**](ReportAuthResponse.md)
|
302
|
+
|
303
|
+
### Authorization
|
304
|
+
|
305
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
306
|
+
|
307
|
+
### HTTP request headers
|
308
|
+
|
309
|
+
- **Content-Type**: application/json
|
310
|
+
- **Accept**: application/json
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
# **get_reports**
|
315
|
+
> ReportsResponse get_reports
|
316
|
+
|
317
|
+
Get list of reports available
|
318
|
+
|
319
|
+
Retrieve a list of reports available
|
320
|
+
|
321
|
+
### Example
|
322
|
+
```ruby
|
323
|
+
# load the gem
|
324
|
+
require 'ultracart_api'
|
325
|
+
|
326
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
327
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
328
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
begin
|
333
|
+
#Get list of reports available
|
334
|
+
result = api_instance.get_reports
|
335
|
+
p result
|
336
|
+
rescue UltracartClient::ApiError => e
|
337
|
+
puts "Exception when calling DatawarehouseApi->get_reports: #{e}"
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
### Parameters
|
342
|
+
This endpoint does not need any parameter.
|
343
|
+
|
344
|
+
### Return type
|
345
|
+
|
346
|
+
[**ReportsResponse**](ReportsResponse.md)
|
347
|
+
|
348
|
+
### Authorization
|
349
|
+
|
350
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
351
|
+
|
352
|
+
### HTTP request headers
|
353
|
+
|
354
|
+
- **Content-Type**: application/json
|
355
|
+
- **Accept**: application/json
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
# **insert_report**
|
360
|
+
> ReportResponse insert_report(report)
|
361
|
+
|
362
|
+
Create a report
|
363
|
+
|
364
|
+
Create a new report on the UltraCart account.
|
365
|
+
|
366
|
+
### Example
|
367
|
+
```ruby
|
368
|
+
# load the gem
|
369
|
+
require 'ultracart_api'
|
370
|
+
|
371
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
372
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
373
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
374
|
+
|
375
|
+
|
376
|
+
report = UltracartClient::Report.new # Report | Report to create
|
377
|
+
|
378
|
+
|
379
|
+
begin
|
380
|
+
#Create a report
|
381
|
+
result = api_instance.insert_report(report)
|
382
|
+
p result
|
383
|
+
rescue UltracartClient::ApiError => e
|
384
|
+
puts "Exception when calling DatawarehouseApi->insert_report: #{e}"
|
385
|
+
end
|
386
|
+
```
|
387
|
+
|
388
|
+
### Parameters
|
389
|
+
|
390
|
+
Name | Type | Description | Notes
|
391
|
+
------------- | ------------- | ------------- | -------------
|
392
|
+
**report** | [**Report**](Report.md)| Report to create |
|
393
|
+
|
394
|
+
### Return type
|
395
|
+
|
396
|
+
[**ReportResponse**](ReportResponse.md)
|
397
|
+
|
398
|
+
### Authorization
|
399
|
+
|
400
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
401
|
+
|
402
|
+
### HTTP request headers
|
403
|
+
|
404
|
+
- **Content-Type**: application/json; charset=UTF-8
|
405
|
+
- **Accept**: application/json
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
# **update_report**
|
410
|
+
> ReportResponse update_report(report, report_oid)
|
411
|
+
|
412
|
+
Update a report
|
413
|
+
|
414
|
+
Update a report on the UltraCart account.
|
415
|
+
|
416
|
+
### Example
|
417
|
+
```ruby
|
418
|
+
# load the gem
|
419
|
+
require 'ultracart_api'
|
420
|
+
|
421
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
422
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
423
|
+
api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
|
424
|
+
|
425
|
+
|
426
|
+
report = UltracartClient::Report.new # Report | Report to update
|
427
|
+
|
428
|
+
report_oid = 56 # Integer | The report oid to update.
|
429
|
+
|
430
|
+
|
431
|
+
begin
|
432
|
+
#Update a report
|
433
|
+
result = api_instance.update_report(report, report_oid)
|
434
|
+
p result
|
435
|
+
rescue UltracartClient::ApiError => e
|
436
|
+
puts "Exception when calling DatawarehouseApi->update_report: #{e}"
|
437
|
+
end
|
438
|
+
```
|
439
|
+
|
440
|
+
### Parameters
|
441
|
+
|
442
|
+
Name | Type | Description | Notes
|
443
|
+
------------- | ------------- | ------------- | -------------
|
444
|
+
**report** | [**Report**](Report.md)| Report to update |
|
445
|
+
**report_oid** | **Integer**| The report oid to update. |
|
446
|
+
|
447
|
+
### Return type
|
448
|
+
|
449
|
+
[**ReportResponse**](ReportResponse.md)
|
450
|
+
|
451
|
+
### Authorization
|
452
|
+
|
453
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
454
|
+
|
455
|
+
### HTTP request headers
|
456
|
+
|
457
|
+
- **Content-Type**: application/json; charset=UTF-8
|
458
|
+
- **Accept**: application/json
|
459
|
+
|
460
|
+
|
461
|
+
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**item_level_refund_reason_required** | **BOOLEAN** | True if the item level refund reason is required | [optional]
|
8
8
|
**item_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the item level. | [optional]
|
9
9
|
**item_level_return_reasons** | [**Array<OrderReason>**](OrderReason.md) | Return codes available at the item level. | [optional]
|
10
|
+
**manual_because_multiple_charges** | **BOOLEAN** | If true, this refund will have to be manually done because of additional charges with the virtual terminal were made | [optional]
|
10
11
|
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
11
12
|
**order_level_refund_reason_required** | **BOOLEAN** | True if the order level refund reason is required | [optional]
|
12
13
|
**order_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the order level. | [optional]
|
data/docs/Report.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::Report
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**active** | **BOOLEAN** | | [optional]
|
7
|
+
**data_sources** | [**Array<ReportDataSource>**](ReportDataSource.md) | | [optional]
|
8
|
+
**default_dataset_id** | **String** | | [optional]
|
9
|
+
**default_project_id** | **String** | | [optional]
|
10
|
+
**filters** | [**Array<ReportFilter>**](ReportFilter.md) | | [optional]
|
11
|
+
**merchant_id** | **String** | | [optional]
|
12
|
+
**name** | **String** | | [optional]
|
13
|
+
**pages** | [**Array<ReportPage>**](ReportPage.md) | | [optional]
|
14
|
+
**report_oid** | **Integer** | Object identifier for this report. | [optional]
|
15
|
+
**security_level** | **String** | Security level to execute report under | [optional]
|
16
|
+
|
17
|
+
|
data/docs/ReportAuth.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::ReportAuth
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_uuid** | **String** | Unique UUID assigned to this client | [optional]
|
7
|
+
**jwt** | **String** | | [optional]
|
8
|
+
**merchant_id** | **String** | | [optional]
|
9
|
+
**websocket_url** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ReportAuthResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**report_auth** | [**ReportAuth**](ReportAuth.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::ReportDataSet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data_set_query_uuid** | **String** | A unique identifier assigned to the data set query that is returned. | [optional]
|
7
|
+
**data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional]
|
8
|
+
**destination_table_id** | **String** | The BigQuery destination table id that contains the result. | [optional]
|
9
|
+
**error_message** | **String** | Error message if the query failed. | [optional]
|
10
|
+
**for_object_id** | **String** | An identifier that can be used to help match up the returned data set | [optional]
|
11
|
+
**for_object_type** | **String** | The type of object this data set is for | [optional]
|
12
|
+
**initial_pages** | [**Array<ReportDataSetPage>**](ReportDataSetPage.md) | Initial pages returned in the dataset | [optional]
|
13
|
+
**max_results** | **Integer** | The total number of results | [optional]
|
14
|
+
**merchant_id** | **String** | Merchant that owns this data set | [optional]
|
15
|
+
**page_count** | **Integer** | The size of the pages | [optional]
|
16
|
+
**page_size** | **Integer** | The size of the pages | [optional]
|
17
|
+
**schema** | [**Array<ReportDataSetSchema>**](ReportDataSetSchema.md) | The schema associated with the data set. | [optional]
|
18
|
+
**security_level** | **String** | Security level this dataset was read from. | [optional]
|
19
|
+
**timezone** | **String** | | [optional]
|
20
|
+
**user_data** | **String** | Any other data that needs to be returned with the response to help the UI | [optional]
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# UltracartClient::ReportDataSetPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data_set_uuid** | **String** | A unique identifier assigned to the data set that is returned. | [optional]
|
7
|
+
**merchant_id** | **String** | Merchant that owns this data set | [optional]
|
8
|
+
**next_page_token** | **String** | | [optional]
|
9
|
+
**next_start_index** | **Integer** | | [optional]
|
10
|
+
**page_number** | **Integer** | | [optional]
|
11
|
+
**row_count** | **Integer** | | [optional]
|
12
|
+
**rows** | [**Array<ReportDataSetRow>**](ReportDataSetRow.md) | Rows returned for the data set | [optional]
|
13
|
+
**rows_s3_url** | **String** | Signed S3 URL where the page rows can be downloaded from | [optional]
|
14
|
+
**start_index** | **Integer** | Zero based index of the starting row | [optional]
|
15
|
+
**table_id** | **String** | The BigQuery destination table id that contains the result. | [optional]
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ReportDataSetPageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**page** | [**ReportDataSetPage**](ReportDataSetPage.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|