ultracart_api 3.11.18 → 3.11.20

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 (32) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -12
  3. data/docs/ConversationVirtualAgentCapabilities.md +3 -0
  4. data/docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md +9 -0
  5. data/docs/CustomDashboard.md +1 -0
  6. data/docs/CustomDashboardExecutionParameter.md +11 -0
  7. data/docs/CustomDashboardSchedule.md +12 -0
  8. data/docs/{ChargebackDisputeResponse.md → CustomDashboardScheduleResponse.md} +2 -2
  9. data/docs/{ChargebackDisputesResponse.md → CustomDashboardSchedulesResponse.md} +2 -2
  10. data/docs/CustomReport.md +1 -0
  11. data/docs/CustomReportExecutionParameter.md +1 -0
  12. data/docs/DatawarehouseApi.md +215 -0
  13. data/docs/EmailCampaign.md +2 -0
  14. data/lib/ultracart_api/api/datawarehouse_api.rb +243 -0
  15. data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +38 -6
  16. data/lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb +193 -0
  17. data/lib/ultracart_api/models/custom_dashboard.rb +15 -4
  18. data/lib/ultracart_api/models/custom_dashboard_execution_parameter.rb +211 -0
  19. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +223 -0
  20. data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +11 -11
  21. data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +14 -13
  22. data/lib/ultracart_api/models/custom_report.rb +10 -1
  23. data/lib/ultracart_api/models/custom_report_execution_parameter.rb +10 -1
  24. data/lib/ultracart_api/models/email_campaign.rb +21 -1
  25. data/lib/ultracart_api/models/order_payment.rb +2 -2
  26. data/lib/ultracart_api/version.rb +1 -1
  27. data/lib/ultracart_api.rb +5 -4
  28. metadata +12 -10
  29. data/docs/ChargebackApi.md +0 -301
  30. data/docs/ChargebackDispute.md +0 -30
  31. data/lib/ultracart_api/api/chargeback_api.rb +0 -356
  32. data/lib/ultracart_api/models/chargeback_dispute.rb +0 -614
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4b8eff51a39002262cf310b2b17f4bc56c390847951a1e3bda57cc0c0fe5b033
4
- data.tar.gz: c7593a062115b62040ab4f4fb4791483a7de229dc8bc59a73487423423b6ca7d
3
+ metadata.gz: 9dbe553fe3fdcecfa6d8d2d45c7275caff1bec2d4a3e984853e2938261a599c4
4
+ data.tar.gz: 2c5840911199a04d345677b36aa7a3393784e7d9a64ac89143a4e1a611a05d69
5
5
  SHA512:
6
- metadata.gz: e0b92b0fb98fe3e3f2da01a99e75e98123ff8f7d3533b7ab32f93adea38b38a85b7c2ecc922edce3efbbdf1be6ee1c2d8a5200455b79c270054afb8cacb52e52
7
- data.tar.gz: feafaa57c5fedc649a05826516876a46a7284e5af68c273927cdcf31ffe064f591eec92cf3b59d568484e7a2646e486c3beed2078052c7babafb23e17bde400b
6
+ metadata.gz: e17440de4cd9aaa4407f1d698dd18977d87781e9c97e36e5d3fe47607085c84010c0d3a8b63238b2d0c80c5c7c2d15d60e8de50305f8e1956e61dbee14ba916e
7
+ data.tar.gz: 28bcca885c13631d4fa88610c784b66ba575f377f315e230159e5e0aef729bf1c48696bc0ecc48486b0b53e9d0febaac926a07d2beb3099e6c861ff59422a4dc
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.11.18
10
+ - Package version: 3.11.20
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
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.11.18.gem
27
+ gem install ./ultracart_api-3.11.20.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.11.18.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.11.20.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.11.18'
35
+ gem 'ultracart_api', '~> 3.11.20'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -114,11 +114,6 @@ Class | Method | HTTP request | Description
114
114
  *UltracartClient::ChannelPartnerApi* | [**insert_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
115
115
  *UltracartClient::ChannelPartnerApi* | [**refund_channel_partner_order**](docs/ChannelPartnerApi.md#refund_channel_partner_order) | **PUT** /channel_partner/orders/{order_id}/refund | Refund a channel partner order
116
116
  *UltracartClient::ChannelPartnerApi* | [**update_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
117
- *UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
118
- *UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
119
- *UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
120
- *UltracartClient::ChargebackApi* | [**insert_chargeback**](docs/ChargebackApi.md#insert_chargeback) | **POST** /chargeback/chargebacks | Insert a chargeback
121
- *UltracartClient::ChargebackApi* | [**update_chargeback**](docs/ChargebackApi.md#update_chargeback) | **PUT** /chargeback/chargebacks/{chargeback_dispute_oid} | Update a chargeback
122
117
  *UltracartClient::CheckoutApi* | [**city_state**](docs/CheckoutApi.md#city_state) | **POST** /checkout/city_state | City/State for Zip
123
118
  *UltracartClient::CheckoutApi* | [**finalize_order**](docs/CheckoutApi.md#finalize_order) | **POST** /checkout/cart/finalizeOrder | Finalize Order
124
119
  *UltracartClient::CheckoutApi* | [**get_affirm_checkout**](docs/CheckoutApi.md#get_affirm_checkout) | **GET** /checkout/cart/{cart_id}/affirmCheckout | Get affirm checkout (by cart id)
@@ -270,6 +265,7 @@ Class | Method | HTTP request | Description
270
265
  *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
271
266
  *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
272
267
  *UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
268
+ *UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard_schedule**](docs/DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule
273
269
  *UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
274
270
  *UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
275
271
  *UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
@@ -277,6 +273,7 @@ Class | Method | HTTP request | Description
277
273
  *UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
278
274
  *UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
279
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_dashboard_schedules**](docs/DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards
280
277
  *UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
281
278
  *UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
282
279
  *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
@@ -287,9 +284,11 @@ Class | Method | HTTP request | Description
287
284
  *UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
288
285
  *UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
289
286
  *UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
287
+ *UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard_schedule**](docs/DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule
290
288
  *UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
291
289
  *UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
292
290
  *UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
291
+ *UltracartClient::DatawarehouseApi* | [**update_custom_dashboard_schedule**](docs/DatawarehouseApi.md#update_custom_dashboard_schedule) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule
293
292
  *UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
294
293
  *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
295
294
  *UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -732,9 +731,6 @@ Class | Method | HTTP request | Description
732
731
  - [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
733
732
  - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
734
733
  - [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
735
- - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
736
- - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
737
- - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
738
734
  - [UltracartClient::CheckoutAllowedCountriesResponse](docs/CheckoutAllowedCountriesResponse.md)
739
735
  - [UltracartClient::CheckoutHandoffRequest](docs/CheckoutHandoffRequest.md)
740
736
  - [UltracartClient::CheckoutHandoffResponse](docs/CheckoutHandoffResponse.md)
@@ -837,6 +833,7 @@ Class | Method | HTTP request | Description
837
833
  - [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
838
834
  - [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
839
835
  - [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
836
+ - [UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment](docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md)
840
837
  - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
841
838
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
842
839
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
@@ -918,9 +915,13 @@ Class | Method | HTTP request | Description
918
915
  - [UltracartClient::CouponsResponse](docs/CouponsResponse.md)
919
916
  - [UltracartClient::Currency](docs/Currency.md)
920
917
  - [UltracartClient::CustomDashboard](docs/CustomDashboard.md)
918
+ - [UltracartClient::CustomDashboardExecutionParameter](docs/CustomDashboardExecutionParameter.md)
921
919
  - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
922
920
  - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
923
921
  - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
922
+ - [UltracartClient::CustomDashboardSchedule](docs/CustomDashboardSchedule.md)
923
+ - [UltracartClient::CustomDashboardScheduleResponse](docs/CustomDashboardScheduleResponse.md)
924
+ - [UltracartClient::CustomDashboardSchedulesResponse](docs/CustomDashboardSchedulesResponse.md)
924
925
  - [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
925
926
  - [UltracartClient::CustomReport](docs/CustomReport.md)
926
927
  - [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
@@ -1569,6 +1570,8 @@ Not every change is committed to every SDK.
1569
1570
 
1570
1571
  | Version | Date | Comments |
1571
1572
  | --: | :-: | --- |
1573
+ | 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
1574
+ | 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
1572
1575
  | 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
1573
1576
  | 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
1574
1577
  | 3.11.16 | 07/28/2025 | updated doc samples |
@@ -10,9 +10,12 @@ Name | Type | Description | Notes
10
10
  **open_support_ticket** | **BOOLEAN** | | [optional]
11
11
  **open_support_ticket_channel** | **String** | Channel to use to open the support ticket | [optional]
12
12
  **open_support_ticket_channel_email** | **String** | Email to send support ticket to | [optional]
13
+ **open_support_ticket_zoho_desk_department_id** | **String** | Department ID to open a Zoho Desk ticket for | [optional]
13
14
  **pause_subscription** | **BOOLEAN** | | [optional]
14
15
  **resume_subscription** | **BOOLEAN** | | [optional]
15
16
  **transfer_chat_to_live_agent** | **BOOLEAN** | | [optional]
16
17
  **update_subscription_credit_card** | **BOOLEAN** | | [optional]
18
+ **zoho_desk_available** | **BOOLEAN** | True if Zoho Desk is connected to UltraCart | [optional]
19
+ **zoho_desk_departments** | [**Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>**](ConversationVirtualAgentCapabilityZohoDeskDepartment.md) | Array of Zoho Desk Department if zoho desk is connected to UltraCart | [optional]
17
20
 
18
21
 
@@ -0,0 +1,9 @@
1
+ # UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **department_id** | **String** | | [optional]
7
+ **department_name** | **String** | | [optional]
8
+
9
+
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
7
7
  **merchant_id** | **String** | | [optional]
8
8
  **name** | **String** | | [optional]
9
9
  **pages** | [**Array<CustomDashboardPage>**](CustomDashboardPage.md) | | [optional]
10
+ **parameters** | [**Array<CustomDashboardExecutionParameter>**](CustomDashboardExecutionParameter.md) | | [optional]
10
11
 
11
12
 
@@ -0,0 +1,11 @@
1
+ # UltracartClient::CustomDashboardExecutionParameter
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **quick_pick_key** | **String** | | [optional]
8
+ **type** | **String** | | [optional]
9
+ **value** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::CustomDashboardSchedule
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cron_trigger_expression** | **String** | | [optional]
7
+ **data_warehouse_custom_dashboard_oid** | **Integer** | | [optional]
8
+ **data_warehouse_custom_dashboard_schedule_oid** | **Integer** | | [optional]
9
+ **emails** | **Array<String>** | | [optional]
10
+ **next_send_dts** | **String** | Date/time that the next send will occur. | [optional]
11
+
12
+
@@ -1,11 +1,11 @@
1
- # UltracartClient::ChargebackDisputeResponse
1
+ # UltracartClient::CustomDashboardScheduleResponse
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | | [optional]
7
6
  **error** | [**Error**](Error.md) | | [optional]
8
7
  **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | | [optional]
9
9
  **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
10
  **warning** | [**Warning**](Warning.md) | | [optional]
11
11
 
@@ -1,11 +1,11 @@
1
- # UltracartClient::ChargebackDisputesResponse
1
+ # UltracartClient::CustomDashboardSchedulesResponse
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **chargebacks** | [**Array<ChargebackDispute>**](ChargebackDispute.md) | | [optional]
7
6
  **error** | [**Error**](Error.md) | | [optional]
8
7
  **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **schedules** | [**Array<CustomDashboardSchedule>**](CustomDashboardSchedule.md) | schedules | [optional]
9
9
  **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
10
  **warning** | [**Warning**](Warning.md) | | [optional]
11
11
 
data/docs/CustomReport.md CHANGED
@@ -3,6 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **business_analysis_prompt** | **String** | | [optional]
6
7
  **chart_javascript** | **String** | | [optional]
7
8
  **chart_javascript_url** | **String** | | [optional]
8
9
  **data_warehouse_report_config_oid** | **Integer** | | [optional]
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | | [optional]
7
+ **quick_pick_key** | **String** | | [optional]
7
8
  **type** | **String** | | [optional]
8
9
  **value** | **String** | | [optional]
9
10
 
@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
8
+ [**delete_custom_dashboard_schedule**](DatawarehouseApi.md#delete_custom_dashboard_schedule) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Delete a custom dashboard schedule
8
9
  [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
9
10
  [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
10
11
  [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
@@ -12,6 +13,7 @@ Method | HTTP request | Description
12
13
  [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
13
14
  [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
14
15
  [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
16
+ [**get_custom_dashboard_schedules**](DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards
15
17
  [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
16
18
  [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
17
19
  [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
@@ -22,9 +24,11 @@ Method | HTTP request | Description
22
24
  [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
23
25
  [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
24
26
  [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
27
+ [**insert_custom_dashboard_schedule**](DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule
25
28
  [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
26
29
  [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
27
30
  [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
31
+ [**update_custom_dashboard_schedule**](DatawarehouseApi.md#update_custom_dashboard_schedule) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid} | Update a custom dashboard schedule
28
32
  [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
29
33
  [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
30
34
  [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -79,6 +83,58 @@ nil (empty response body)
79
83
 
80
84
 
81
85
 
86
+ # **delete_custom_dashboard_schedule**
87
+ > delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
88
+
89
+ Delete a custom dashboard schedule
90
+
91
+ delete a custom dashboard schedule on the UltraCart account.
92
+
93
+ ### Example
94
+ ```ruby
95
+ # load the gem
96
+ require 'ultracart_api'
97
+
98
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
99
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
100
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
101
+
102
+
103
+ custom_dashboard_schedule_oid = 56 # Integer | The dashboard schedule oid to delete.
104
+
105
+ custom_dashboard_oid = 56 # Integer | The dashboard oid that owns the schedule.
106
+
107
+
108
+ begin
109
+ #Delete a custom dashboard schedule
110
+ api_instance.delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
111
+ rescue UltracartClient::ApiError => e
112
+ puts "Exception when calling DatawarehouseApi->delete_custom_dashboard_schedule: #{e}"
113
+ end
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ Name | Type | Description | Notes
119
+ ------------- | ------------- | ------------- | -------------
120
+ **custom_dashboard_schedule_oid** | **Integer**| The dashboard schedule oid to delete. |
121
+ **custom_dashboard_oid** | **Integer**| The dashboard oid that owns the schedule. |
122
+
123
+ ### Return type
124
+
125
+ nil (empty response body)
126
+
127
+ ### Authorization
128
+
129
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
130
+
131
+ ### HTTP request headers
132
+
133
+ - **Content-Type**: application/json; charset=UTF-8
134
+ - **Accept**: application/json
135
+
136
+
137
+
82
138
  # **delete_custom_report**
83
139
  > delete_custom_report(custom_report_oid)
84
140
 
@@ -429,6 +485,56 @@ Name | Type | Description | Notes
429
485
 
430
486
 
431
487
 
488
+ # **get_custom_dashboard_schedules**
489
+ > CustomDashboardSchedulesResponse get_custom_dashboard_schedules(custom_dashboard_oid)
490
+
491
+ Get custom dashboards
492
+
493
+ Retrieve a custom dashboards
494
+
495
+ ### Example
496
+ ```ruby
497
+ # load the gem
498
+ require 'ultracart_api'
499
+
500
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
501
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
502
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
503
+
504
+
505
+ custom_dashboard_oid = 56 # Integer |
506
+
507
+
508
+ begin
509
+ #Get custom dashboards
510
+ result = api_instance.get_custom_dashboard_schedules(custom_dashboard_oid)
511
+ p result
512
+ rescue UltracartClient::ApiError => e
513
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboard_schedules: #{e}"
514
+ end
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ Name | Type | Description | Notes
520
+ ------------- | ------------- | ------------- | -------------
521
+ **custom_dashboard_oid** | **Integer**| |
522
+
523
+ ### Return type
524
+
525
+ [**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.md)
526
+
527
+ ### Authorization
528
+
529
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: application/json
534
+ - **Accept**: application/json
535
+
536
+
537
+
432
538
  # **get_custom_dashboards**
433
539
  > CustomDashboardsResponse get_custom_dashboards
434
540
 
@@ -907,6 +1013,59 @@ Name | Type | Description | Notes
907
1013
 
908
1014
 
909
1015
 
1016
+ # **insert_custom_dashboard_schedule**
1017
+ > CustomDashboardScheduleResponse insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1018
+
1019
+ Create a custom dashboard schedule
1020
+
1021
+ Create a new custom dashboard schedule on the UltraCart account.
1022
+
1023
+ ### Example
1024
+ ```ruby
1025
+ # load the gem
1026
+ require 'ultracart_api'
1027
+
1028
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1029
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1030
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1031
+
1032
+
1033
+ custom_dashboard_oid = 56 # Integer |
1034
+
1035
+ dashboard_schedule = UltracartClient::CustomDashboardSchedule.new # CustomDashboardSchedule | Dashboard schedule to create
1036
+
1037
+
1038
+ begin
1039
+ #Create a custom dashboard schedule
1040
+ result = api_instance.insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1041
+ p result
1042
+ rescue UltracartClient::ApiError => e
1043
+ puts "Exception when calling DatawarehouseApi->insert_custom_dashboard_schedule: #{e}"
1044
+ end
1045
+ ```
1046
+
1047
+ ### Parameters
1048
+
1049
+ Name | Type | Description | Notes
1050
+ ------------- | ------------- | ------------- | -------------
1051
+ **custom_dashboard_oid** | **Integer**| |
1052
+ **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md)| Dashboard schedule to create |
1053
+
1054
+ ### Return type
1055
+
1056
+ [**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.md)
1057
+
1058
+ ### Authorization
1059
+
1060
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1061
+
1062
+ ### HTTP request headers
1063
+
1064
+ - **Content-Type**: application/json; charset=UTF-8
1065
+ - **Accept**: application/json
1066
+
1067
+
1068
+
910
1069
  # **insert_custom_report**
911
1070
  > CustomReportResponse insert_custom_report(report)
912
1071
 
@@ -1060,6 +1219,62 @@ Name | Type | Description | Notes
1060
1219
 
1061
1220
 
1062
1221
 
1222
+ # **update_custom_dashboard_schedule**
1223
+ > CustomDashboardResponse update_custom_dashboard_schedule(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid)
1224
+
1225
+ Update a custom dashboard schedule
1226
+
1227
+ Update a custom dashboard schedule on the UltraCart account.
1228
+
1229
+ ### Example
1230
+ ```ruby
1231
+ # load the gem
1232
+ require 'ultracart_api'
1233
+
1234
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1235
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1236
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1237
+
1238
+
1239
+ dashboard_schedule = UltracartClient::CustomDashboardSchedule.new # CustomDashboardSchedule | Dashboard schedule to update
1240
+
1241
+ custom_dashboard_schedule_oid = 56 # Integer | The dashboard schedule oid to update.
1242
+
1243
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to update.
1244
+
1245
+
1246
+ begin
1247
+ #Update a custom dashboard schedule
1248
+ result = api_instance.update_custom_dashboard_schedule(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid)
1249
+ p result
1250
+ rescue UltracartClient::ApiError => e
1251
+ puts "Exception when calling DatawarehouseApi->update_custom_dashboard_schedule: #{e}"
1252
+ end
1253
+ ```
1254
+
1255
+ ### Parameters
1256
+
1257
+ Name | Type | Description | Notes
1258
+ ------------- | ------------- | ------------- | -------------
1259
+ **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md)| Dashboard schedule to update |
1260
+ **custom_dashboard_schedule_oid** | **Integer**| The dashboard schedule oid to update. |
1261
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to update. |
1262
+
1263
+ ### Return type
1264
+
1265
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1266
+
1267
+ ### Authorization
1268
+
1269
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1270
+
1271
+ ### HTTP request headers
1272
+
1273
+ - **Content-Type**: application/json; charset=UTF-8
1274
+ - **Accept**: application/json
1275
+
1276
+
1277
+
1063
1278
  # **update_custom_report**
1064
1279
  > CustomReportResponse update_custom_report(report, custom_report_oid)
1065
1280
 
@@ -20,6 +20,8 @@ Name | Type | Description | Notes
20
20
  **name** | **String** | Name of email campaign | [optional]
21
21
  **open_rate_formatted** | **String** | Open rate of emails | [optional]
22
22
  **prevent_sending_due_to_spam** | **BOOLEAN** | True if this campaign is prevented from sending at this time due to spam complaints. | [optional]
23
+ **repeat_monthly** | **BOOLEAN** | True if the campaign should repeat on a monthly basis | [optional]
24
+ **repeat_weekly** | **BOOLEAN** | True if the campaign should repeat on a weekly basis | [optional]
23
25
  **revenue_formatted** | **String** | Revenue associated with campaign | [optional]
24
26
  **revenue_per_customer_formatted** | **String** | Revenue per customer associated with campaign | [optional]
25
27
  **scheduled_dts** | **String** | Scheduled date | [optional]