ultracart_api 4.1.13 → 4.1.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -2
  3. data/docs/AffiliateApi.md +123 -167
  4. data/docs/AutoOrderApi.md +1250 -903
  5. data/docs/CartUpsellAfter.md +6 -2
  6. data/docs/ChannelPartnerApi.md +1678 -1121
  7. data/docs/ChargebackApi.md +297 -405
  8. data/docs/CheckoutApi.md +1622 -1424
  9. data/docs/ConversationApi.md +4820 -6315
  10. data/docs/ConversationVirtualAgentCapabilities.md +4 -0
  11. data/docs/CouponApi.md +1522 -1443
  12. data/docs/CustomReport.md +36 -0
  13. data/docs/CustomReportAccountConfig.md +34 -0
  14. data/docs/CustomReportAccountConfigResponse.md +26 -0
  15. data/docs/CustomReportExecutionParameter.md +22 -0
  16. data/docs/CustomReportExecutionRequest.md +18 -0
  17. data/docs/CustomReportParameter.md +28 -0
  18. data/docs/CustomReportParameterOption.md +20 -0
  19. data/docs/CustomReportQuery.md +28 -0
  20. data/docs/CustomReportResponse.md +26 -0
  21. data/docs/CustomReportTooltip.md +20 -0
  22. data/docs/CustomerApi.md +2570 -1845
  23. data/docs/DatawarehouseApi.md +933 -723
  24. data/docs/FulfillmentApi.md +567 -441
  25. data/docs/GiftCertificateApi.md +617 -598
  26. data/docs/IntegrationLogApi.md +290 -385
  27. data/docs/Item.md +1 -1
  28. data/docs/ItemApi.md +2174 -1746
  29. data/docs/OauthApi.md +203 -163
  30. data/docs/OrderApi.md +2883 -2177
  31. data/docs/SsoApi.md +223 -288
  32. data/docs/StorefrontApi.md +9692 -12967
  33. data/docs/TaxApi.md +1541 -2017
  34. data/docs/UserApi.md +606 -790
  35. data/docs/WebhookApi.md +787 -628
  36. data/docs/WorkflowApi.md +666 -879
  37. data/lib/ultracart_api/api/datawarehouse_api.rb +474 -0
  38. data/lib/ultracart_api/api/order_api.rb +131 -0
  39. data/lib/ultracart_api/models/cart_upsell_after.rb +25 -5
  40. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +55 -1
  41. data/lib/ultracart_api/models/custom_report.rb +306 -0
  42. data/lib/ultracart_api/models/custom_report_account_config.rb +296 -0
  43. data/lib/ultracart_api/models/custom_report_account_config_response.rb +256 -0
  44. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +237 -0
  45. data/lib/ultracart_api/models/custom_report_execution_request.rb +221 -0
  46. data/lib/ultracart_api/models/custom_report_parameter.rb +266 -0
  47. data/lib/ultracart_api/models/custom_report_parameter_option.rb +228 -0
  48. data/lib/ultracart_api/models/custom_report_query.rb +266 -0
  49. data/lib/ultracart_api/models/custom_report_response.rb +256 -0
  50. data/lib/ultracart_api/models/custom_report_tooltip.rb +228 -0
  51. data/lib/ultracart_api/models/item.rb +1 -1
  52. data/lib/ultracart_api/version.rb +1 -1
  53. data/lib/ultracart_api.rb +10 -0
  54. metadata +22 -2
data/docs/CustomReport.md ADDED
@@ -0,0 +1,36 @@
1
+ # UltracartClient::CustomReport
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **chart_javascript** | **String** | | [optional] |
8
+ | **chart_javascript_url** | **String** | | [optional] |
9
+ | **data_warehouse_report_config_oid** | **Integer** | | [optional] |
10
+ | **dataset_security_level** | **String** | | [optional] |
11
+ | **group_name** | **String** | | [optional] |
12
+ | **merchant_id** | **String** | | [optional] |
13
+ | **name** | **String** | | [optional] |
14
+ | **parameters** | [**Array<CustomReportParameter>**](CustomReportParameter.md) | | [optional] |
15
+ | **queries** | [**Array<CustomReportQuery>**](CustomReportQuery.md) | | [optional] |
16
+ | **tooltips** | [**Array<CustomReportTooltip>**](CustomReportTooltip.md) | | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'ultracart_api'
22
+
23
+ instance = UltracartClient::CustomReport.new(
24
+ chart_javascript: null,
25
+ chart_javascript_url: null,
26
+ data_warehouse_report_config_oid: null,
27
+ dataset_security_level: null,
28
+ group_name: null,
29
+ merchant_id: null,
30
+ name: null,
31
+ parameters: null,
32
+ queries: null,
33
+ tooltips: null
34
+ )
35
+ ```
36
+
data/docs/CustomReportAccountConfig.md ADDED
@@ -0,0 +1,34 @@
1
+ # UltracartClient::CustomReportAccountConfig
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ai_budget** | **Float** | | [optional] |
8
+ | **ai_usage** | **Float** | Current AI usage creating reports | [optional] |
9
+ | **merchant_id** | **String** | Current BigQuery SQL usage running reports | [optional] |
10
+ | **novice_sql_comments** | **Boolean** | | [optional] |
11
+ | **opt_in** | **Boolean** | True if they have opted into custom reports | [optional] |
12
+ | **opt_in_by_user** | **String** | User that opted into custom reporting | [optional] |
13
+ | **opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional] |
14
+ | **sql_budget** | **Float** | | [optional] |
15
+ | **sql_usage** | **Float** | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::CustomReportAccountConfig.new(
23
+ ai_budget: null,
24
+ ai_usage: null,
25
+ merchant_id: null,
26
+ novice_sql_comments: null,
27
+ opt_in: null,
28
+ opt_in_by_user: null,
29
+ opt_in_date: null,
30
+ sql_budget: null,
31
+ sql_usage: null
32
+ )
33
+ ```
34
+
data/docs/CustomReportAccountConfigResponse.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomReportAccountConfigResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_config** | [**CustomReportAccountConfig**](CustomReportAccountConfig.md) | | [optional] |
8
+ | **error** | [**Error**](Error.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
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::CustomReportAccountConfigResponse.new(
19
+ account_config: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/CustomReportExecutionParameter.md ADDED
@@ -0,0 +1,22 @@
1
+ # UltracartClient::CustomReportExecutionParameter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | [optional] |
8
+ | **type** | **String** | | [optional] |
9
+ | **value** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::CustomReportExecutionParameter.new(
17
+ name: null,
18
+ type: null,
19
+ value: null
20
+ )
21
+ ```
22
+
data/docs/CustomReportExecutionRequest.md ADDED
@@ -0,0 +1,18 @@
1
+ # UltracartClient::CustomReportExecutionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::CustomReportExecutionRequest.new(
15
+ parameters: null
16
+ )
17
+ ```
18
+
data/docs/CustomReportParameter.md ADDED
@@ -0,0 +1,28 @@
1
+ # UltracartClient::CustomReportParameter
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **display_name** | **String** | | [optional] |
8
+ | **meta** | **String** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **options** | [**Array<CustomReportParameterOption>**](CustomReportParameterOption.md) | | [optional] |
11
+ | **required** | **Boolean** | | [optional] |
12
+ | **type** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::CustomReportParameter.new(
20
+ display_name: null,
21
+ meta: null,
22
+ name: null,
23
+ options: null,
24
+ required: null,
25
+ type: null
26
+ )
27
+ ```
28
+
data/docs/CustomReportParameterOption.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::CustomReportParameterOption
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | | [optional] |
8
+ | **value** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::CustomReportParameterOption.new(
16
+ description: null,
17
+ value: null
18
+ )
19
+ ```
20
+
data/docs/CustomReportQuery.md ADDED
@@ -0,0 +1,28 @@
1
+ # UltracartClient::CustomReportQuery
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conditional_formatting_start_column** | **Integer** | | [optional] |
8
+ | **freeze_columns** | **Integer** | | [optional] |
9
+ | **pii_columns** | **Array<String>** | | [optional] |
10
+ | **query** | **String** | | [optional] |
11
+ | **sheet_name** | **String** | | [optional] |
12
+ | **title** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::CustomReportQuery.new(
20
+ conditional_formatting_start_column: null,
21
+ freeze_columns: null,
22
+ pii_columns: null,
23
+ query: null,
24
+ sheet_name: null,
25
+ title: null
26
+ )
27
+ ```
28
+
data/docs/CustomReportResponse.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomReportResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **report** | [**CustomReport**](CustomReport.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::CustomReportResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ report: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/CustomReportTooltip.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::CustomReportTooltip
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **column_name** | **String** | | [optional] |
8
+ | **tooltip** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::CustomReportTooltip.new(
16
+ column_name: null,
17
+ tooltip: null
18
+ )
19
+ ```
20
+