ultracart_api 4.1.15 → 4.1.17

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -5
  3. data/docs/CustomDashboard.md +24 -0
  4. data/docs/CustomDashboardPage.md +22 -0
  5. data/docs/CustomDashboardPageReport.md +26 -0
  6. data/docs/CustomDashboardResponse.md +26 -0
  7. data/docs/CustomDashboardsResponse.md +26 -0
  8. data/docs/CustomReportExecutionResponse.md +32 -0
  9. data/docs/CustomReportsExecutionReportData.md +22 -0
  10. data/docs/CustomReportsExecutionRequest.md +20 -0
  11. data/docs/CustomReportsExecutionResponse.md +28 -0
  12. data/docs/CustomReportsResponse.md +26 -0
  13. data/docs/DatawarehouseApi.md +379 -4
  14. data/docs/EmailEditorValuesResponse.md +26 -0
  15. data/docs/OrderApi.md +32 -67
  16. data/docs/StorefrontApi.md +52 -0
  17. data/docs/WebhookApi.md +0 -8
  18. data/lib/ultracart_api/api/datawarehouse_api.rb +460 -3
  19. data/lib/ultracart_api/api/order_api.rb +2 -93
  20. data/lib/ultracart_api/api/storefront_api.rb +62 -0
  21. data/lib/ultracart_api/api/webhook_api.rb +0 -24
  22. data/lib/ultracart_api/models/custom_dashboard.rb +248 -0
  23. data/lib/ultracart_api/models/custom_dashboard_page.rb +239 -0
  24. data/lib/ultracart_api/models/custom_dashboard_page_report.rb +255 -0
  25. data/lib/ultracart_api/models/custom_dashboard_response.rb +256 -0
  26. data/lib/ultracart_api/models/custom_dashboards_response.rb +259 -0
  27. data/lib/ultracart_api/models/custom_report_execution_response.rb +285 -0
  28. data/lib/ultracart_api/models/custom_reports_execution_report_data.rb +237 -0
  29. data/lib/ultracart_api/models/custom_reports_execution_request.rb +232 -0
  30. data/lib/ultracart_api/models/custom_reports_execution_response.rb +269 -0
  31. data/lib/ultracart_api/models/custom_reports_response.rb +259 -0
  32. data/lib/ultracart_api/models/email_editor_values_response.rb +258 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +11 -0
  35. metadata +24 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 88b53e73ee66470db4628071562e135f24c4ed2fd083e8590ce5be1e9e9bbb89
4
- data.tar.gz: 61db53c58daef42a6fddd83dfbd4a131ed9ecfd64b579f84ca1a3dc00649824a
3
+ metadata.gz: b9a6c3d8e360959ec36364b5631fa119489757e22f95d59f231eec854b56a643
4
+ data.tar.gz: f97b0ee1dcd0c980f1902c188f39bec5dc110d4e4ef3be0453adfbf521b54420
5
5
  SHA512:
6
- metadata.gz: e3656f6385e94d3a2d71a86e09364176e42564c10808583f7553441ceb32654f7507cd6ed2d188f3ae4a495695c6c135991058bf01aeb902bd829503408c63e1
7
- data.tar.gz: 6c4787a05dd1def0585e5bc55ab64371ebe901c08d630e78aa790d8bd188218ba6618f1b1e29e9f5ad26ea09a54693127263c9e97820dc536f4ec82ea14b216f
6
+ metadata.gz: c494b85df669b3525b07bdd08aa95015ab911f6911c84ba4f36f7cec3c2a89ca15b88a0b3adef5f43272158dffd905694005aaaa1b1ffcda9edf51a6b499a4c4
7
+ data.tar.gz: 2292427f95e7794a3bb3a33670710383536a901c85e5f3fd8bfe31e652aca87e3d65520345ee82996b077b3f05df83b8cfe6d8d978acde80b4808d49836ba6fb
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.15
10
+ - Package version: 4.1.17
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.15'
19
+ gem 'ultracart_api', '4.1.17'
20
20
  ```
21
21
 
22
22
  install:
@@ -265,20 +265,27 @@ Class | Method | HTTP request | Description
265
265
  *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
266
266
  *UltracartClient::CustomerApi* | [**update_wish_list_item**](docs/CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
267
267
  *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
268
+ *UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
268
269
  *UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
269
270
  *UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
270
271
  *UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
271
272
  *UltracartClient::DatawarehouseApi* | [**execute_custom_report**](docs/DatawarehouseApi.md#execute_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/execute | Execute a custom report
273
+ *UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
272
274
  *UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
275
+ *UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
276
+ *UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
273
277
  *UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
274
278
  *UltracartClient::DatawarehouseApi* | [**get_custom_report_account_config**](docs/DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
279
+ *UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
275
280
  *UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
276
281
  *UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
277
282
  *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
278
283
  *UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
279
284
  *UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
285
+ *UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
280
286
  *UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
281
287
  *UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
288
+ *UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
282
289
  *UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
283
290
  *UltracartClient::DatawarehouseApi* | [**update_custom_report_account_config**](docs/DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
284
291
  *UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -327,7 +334,7 @@ Class | Method | HTTP request | Description
327
334
  *UltracartClient::OauthApi* | [**oauth_access_token**](docs/OauthApi.md#oauth_access_token) | **POST** /oauth/token | Exchange authorization code for access token.
328
335
  *UltracartClient::OauthApi* | [**oauth_revoke**](docs/OauthApi.md#oauth_revoke) | **POST** /oauth/revoke | Revoke this OAuth application.
329
336
  *UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
330
- *UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **POST** /order/orders/{order_id}/refund_block | Set a refund block on an order
337
+ *UltracartClient::OrderApi* | [**block_refund_on_order**](docs/OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
331
338
  *UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
332
339
  *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
333
340
  *UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
@@ -348,11 +355,10 @@ Class | Method | HTTP request | Description
348
355
  *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
349
356
  *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
350
357
  *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
351
- *UltracartClient::OrderApi* | [**refund_order_completely**](docs/OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
352
358
  *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
353
359
  *UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
354
360
  *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
355
- *UltracartClient::OrderApi* | [**unblock_refund_on_order**](docs/OrderApi.md#unblock_refund_on_order) | **POST** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
361
+ *UltracartClient::OrderApi* | [**unblock_refund_on_order**](docs/OrderApi.md#unblock_refund_on_order) | **GET** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
356
362
  *UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
357
363
  *UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
358
364
  *UltracartClient::OrderApi* | [**validate_order**](docs/OrderApi.md#validate_order) | **POST** /order/validate | Validate
@@ -400,6 +406,7 @@ Class | Method | HTTP request | Description
400
406
  *UltracartClient::StorefrontApi* | [**get_email_campaigns**](docs/StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns
401
407
  *UltracartClient::StorefrontApi* | [**get_email_campaigns_with_stats**](docs/StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats
402
408
  *UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
409
+ *UltracartClient::StorefrontApi* | [**get_email_commseq_editor_values**](docs/StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values
403
410
  *UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
404
411
  *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
405
412
  *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
@@ -905,16 +912,26 @@ Class | Method | HTTP request | Description
905
912
  - [UltracartClient::CouponsRequest](docs/CouponsRequest.md)
906
913
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
907
914
  - [UltracartClient::Currency](docs/Currency.md)
915
+ - [UltracartClient::CustomDashboard](docs/CustomDashboard.md)
916
+ - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
917
+ - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
918
+ - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
919
+ - [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
908
920
  - [UltracartClient::CustomReport](docs/CustomReport.md)
909
921
  - [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
910
922
  - [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
911
923
  - [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
912
924
  - [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
925
+ - [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
913
926
  - [UltracartClient::CustomReportParameter](docs/CustomReportParameter.md)
914
927
  - [UltracartClient::CustomReportParameterOption](docs/CustomReportParameterOption.md)
915
928
  - [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
916
929
  - [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
917
930
  - [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
931
+ - [UltracartClient::CustomReportsExecutionReportData](docs/CustomReportsExecutionReportData.md)
932
+ - [UltracartClient::CustomReportsExecutionRequest](docs/CustomReportsExecutionRequest.md)
933
+ - [UltracartClient::CustomReportsExecutionResponse](docs/CustomReportsExecutionResponse.md)
934
+ - [UltracartClient::CustomReportsResponse](docs/CustomReportsResponse.md)
918
935
  - [UltracartClient::Customer](docs/Customer.md)
919
936
  - [UltracartClient::CustomerActivity](docs/CustomerActivity.md)
920
937
  - [UltracartClient::CustomerAffiliate](docs/CustomerAffiliate.md)
@@ -997,6 +1014,7 @@ Class | Method | HTTP request | Description
997
1014
  - [UltracartClient::EmailDashboardStatsResponse](docs/EmailDashboardStatsResponse.md)
998
1015
  - [UltracartClient::EmailDomain](docs/EmailDomain.md)
999
1016
  - [UltracartClient::EmailEditorTokenResponse](docs/EmailEditorTokenResponse.md)
1017
+ - [UltracartClient::EmailEditorValuesResponse](docs/EmailEditorValuesResponse.md)
1000
1018
  - [UltracartClient::EmailFlow](docs/EmailFlow.md)
1001
1019
  - [UltracartClient::EmailFlowBackPopulateRequest](docs/EmailFlowBackPopulateRequest.md)
1002
1020
  - [UltracartClient::EmailFlowBackPopulateResponse](docs/EmailFlowBackPopulateResponse.md)
@@ -1549,6 +1567,8 @@ Not every change is committed to every SDK.
1549
1567
 
1550
1568
  | Version | Date | Comments |
1551
1569
  | --: | :-: | --- |
1570
+ | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
1571
+ | 4.1.16 | 07/28/2025 | updated doc samples |
1552
1572
  | 4.1.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
1553
1573
  | 4.1.14 | 07/10/2025 | automation test |
1554
1574
  | 4.1.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
@@ -0,0 +1,24 @@
1
+ # UltracartClient::CustomDashboard
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data_warehouse_custom_dashboard_oid** | **Integer** | | [optional] |
8
+ | **merchant_id** | **String** | | [optional] |
9
+ | **name** | **String** | | [optional] |
10
+ | **pages** | [**Array<CustomDashboardPage>**](CustomDashboardPage.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::CustomDashboard.new(
18
+ data_warehouse_custom_dashboard_oid: null,
19
+ merchant_id: null,
20
+ name: null,
21
+ pages: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::CustomDashboardPage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **page_height_inches** | **Float** | | [optional] |
8
+ | **page_width_inches** | **Float** | | [optional] |
9
+ | **reports** | [**Array<CustomDashboardPageReport>**](CustomDashboardPageReport.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::CustomDashboardPage.new(
17
+ page_height_inches: null,
18
+ page_width_inches: null,
19
+ reports: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomDashboardPageReport
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data_warehouse_report_config_oid** | **Integer** | | [optional] |
8
+ | **grid_height** | **Integer** | | [optional] |
9
+ | **grid_width** | **Integer** | | [optional] |
10
+ | **grid_x** | **Integer** | | [optional] |
11
+ | **grid_y** | **Integer** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::CustomDashboardPageReport.new(
19
+ data_warehouse_report_config_oid: null,
20
+ grid_height: null,
21
+ grid_width: null,
22
+ grid_x: null,
23
+ grid_y: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomDashboardResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dashboard** | [**CustomDashboard**](CustomDashboard.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::CustomDashboardResponse.new(
19
+ dashboard: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomDashboardsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **dashboards** | [**Array<CustomDashboard>**](CustomDashboard.md) | reports | [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::CustomDashboardsResponse.new(
19
+ dashboards: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,32 @@
1
+ # UltracartClient::CustomReportExecutionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional] |
10
+ | **report** | [**CustomReport**](CustomReport.md) | | [optional] |
11
+ | **result_schema_json** | **String** | | [optional] |
12
+ | **result_url** | **String** | | [optional] |
13
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
14
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::CustomReportExecutionResponse.new(
22
+ error: null,
23
+ metadata: null,
24
+ parameters: null,
25
+ report: null,
26
+ result_schema_json: null,
27
+ result_url: null,
28
+ success: null,
29
+ warning: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::CustomReportsExecutionReportData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data_warehouse_report_config_oid** | **Integer** | | [optional] |
8
+ | **error_message** | **String** | | [optional] |
9
+ | **result_url** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::CustomReportsExecutionReportData.new(
17
+ data_warehouse_report_config_oid: null,
18
+ error_message: null,
19
+ result_url: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::CustomReportsExecutionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data_warehouse_report_config_oids** | **Array<Integer>** | | [optional] |
8
+ | **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::CustomReportsExecutionRequest.new(
16
+ data_warehouse_report_config_oids: null,
17
+ parameters: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::CustomReportsExecutionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **parameters** | [**Array<CustomReportExecutionParameter>**](CustomReportExecutionParameter.md) | | [optional] |
10
+ | **reports** | [**Array<CustomReportsExecutionReportData>**](CustomReportsExecutionReportData.md) | | [optional] |
11
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
12
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::CustomReportsExecutionResponse.new(
20
+ error: null,
21
+ metadata: null,
22
+ parameters: null,
23
+ reports: null,
24
+ success: null,
25
+ warning: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::CustomReportsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **reports** | [**Array<CustomReport>**](CustomReport.md) | reports | [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::CustomReportsResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ reports: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+