ultracart_api 4.1.19 → 4.1.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.
- checksums.yaml +4 -4
- data/README.md +10 -10
- data/docs/CustomDashboardSchedule.md +26 -0
- data/docs/{ChargebackDisputeResponse.md → CustomDashboardScheduleResponse.md} +4 -4
- data/docs/{ChargebackDisputesResponse.md → CustomDashboardSchedulesResponse.md} +4 -4
- data/docs/CustomReport.md +2 -0
- data/docs/DatawarehouseApi.md +220 -0
- data/docs/EmailCampaign.md +4 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +290 -0
- data/lib/ultracart_api/models/custom_dashboard_schedule.rb +258 -0
- data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +13 -13
- data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +16 -15
- data/lib/ultracart_api/models/custom_report.rb +10 -1
- data/lib/ultracart_api/models/email_campaign.rb +21 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -4
- metadata +8 -10
- data/docs/ChargebackApi.md +0 -297
- data/docs/ChargebackDispute.md +0 -62
- data/lib/ultracart_api/api/chargeback_api.rb +0 -410
- data/lib/ultracart_api/models/chargeback_dispute.rb +0 -649
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 69705c49d27deb04aa9fff2d876a8a2e11baf71af8d209246c860a2dfe1accf9
|
4
|
+
data.tar.gz: fd42b8854656d01e5c321772ab01f67cc646131e7238aa5f84e3979b99c6a661
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a8459d5f5027a146e36f18c432802a1a268c6ab7a46d19e319200aec80eda512ac26009c4ca1291f069cc29410c2760ccf8424b7b5b5aa648ca2932645099f7
|
7
|
+
data.tar.gz: 444fbafb0317b2171cac4fbe3001fce35f66fbfed5e6ebee3f36aed67031a7f0f45cf9e8b05b7d0a3d43420a8b058c92edede57df78f10383830d8e0ddfbf9dd
|
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.
|
10
|
+
- Package version: 4.1.20
|
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.
|
19
|
+
gem 'ultracart_api', '4.1.20'
|
20
20
|
```
|
21
21
|
|
22
22
|
install:
|
@@ -110,11 +110,6 @@ Class | Method | HTTP request | Description
|
|
110
110
|
*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.
|
111
111
|
*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
|
112
112
|
*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.
|
113
|
-
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
114
|
-
*UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
|
115
|
-
*UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
|
116
|
-
*UltracartClient::ChargebackApi* | [**insert_chargeback**](docs/ChargebackApi.md#insert_chargeback) | **POST** /chargeback/chargebacks | Insert a chargeback
|
117
|
-
*UltracartClient::ChargebackApi* | [**update_chargeback**](docs/ChargebackApi.md#update_chargeback) | **PUT** /chargeback/chargebacks/{chargeback_dispute_oid} | Update a chargeback
|
118
113
|
*UltracartClient::CheckoutApi* | [**city_state**](docs/CheckoutApi.md#city_state) | **POST** /checkout/city_state | City/State for Zip
|
119
114
|
*UltracartClient::CheckoutApi* | [**finalize_order**](docs/CheckoutApi.md#finalize_order) | **POST** /checkout/cart/finalizeOrder | Finalize Order
|
120
115
|
*UltracartClient::CheckoutApi* | [**get_affirm_checkout**](docs/CheckoutApi.md#get_affirm_checkout) | **GET** /checkout/cart/{cart_id}/affirmCheckout | Get affirm checkout (by cart id)
|
@@ -266,6 +261,7 @@ Class | Method | HTTP request | Description
|
|
266
261
|
*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
262
|
*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
263
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
|
264
|
+
*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
|
269
265
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
270
266
|
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
271
267
|
*UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
@@ -273,6 +269,7 @@ Class | Method | HTTP request | Description
|
|
273
269
|
*UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
|
274
270
|
*UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
275
271
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
|
272
|
+
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboard_schedules**](docs/DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards
|
276
273
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
|
277
274
|
*UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
278
275
|
*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
|
@@ -283,9 +280,11 @@ Class | Method | HTTP request | Description
|
|
283
280
|
*UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
284
281
|
*UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
285
282
|
*UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
|
283
|
+
*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
|
286
284
|
*UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
|
287
285
|
*UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
288
286
|
*UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
|
287
|
+
*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
|
289
288
|
*UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
|
290
289
|
*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
|
291
290
|
*UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
@@ -728,9 +727,6 @@ Class | Method | HTTP request | Description
|
|
728
727
|
- [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
|
729
728
|
- [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
|
730
729
|
- [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
|
731
|
-
- [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
|
732
|
-
- [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
|
733
|
-
- [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
|
734
730
|
- [UltracartClient::CheckoutAllowedCountriesResponse](docs/CheckoutAllowedCountriesResponse.md)
|
735
731
|
- [UltracartClient::CheckoutHandoffRequest](docs/CheckoutHandoffRequest.md)
|
736
732
|
- [UltracartClient::CheckoutHandoffResponse](docs/CheckoutHandoffResponse.md)
|
@@ -918,6 +914,9 @@ Class | Method | HTTP request | Description
|
|
918
914
|
- [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
|
919
915
|
- [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
|
920
916
|
- [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
|
917
|
+
- [UltracartClient::CustomDashboardSchedule](docs/CustomDashboardSchedule.md)
|
918
|
+
- [UltracartClient::CustomDashboardScheduleResponse](docs/CustomDashboardScheduleResponse.md)
|
919
|
+
- [UltracartClient::CustomDashboardSchedulesResponse](docs/CustomDashboardSchedulesResponse.md)
|
921
920
|
- [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
|
922
921
|
- [UltracartClient::CustomReport](docs/CustomReport.md)
|
923
922
|
- [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
|
@@ -1569,6 +1568,7 @@ Not every change is committed to every SDK.
|
|
1569
1568
|
|
1570
1569
|
| Version | Date | Comments |
|
1571
1570
|
| --: | :-: | --- |
|
1571
|
+
| 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1572
1572
|
| 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
1573
1573
|
| 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
1574
1574
|
| 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomDashboardSchedule
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cron_trigger_expression** | **String** | | [optional] |
|
8
|
+
| **data_warehouse_custom_dashboard_oid** | **Integer** | | [optional] |
|
9
|
+
| **data_warehouse_custom_dashboard_schedule_oid** | **Integer** | | [optional] |
|
10
|
+
| **emails** | **Array<String>** | | [optional] |
|
11
|
+
| **next_send_dts** | **String** | Date/time that the next send will occur. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::CustomDashboardSchedule.new(
|
19
|
+
cron_trigger_expression: null,
|
20
|
+
data_warehouse_custom_dashboard_oid: null,
|
21
|
+
data_warehouse_custom_dashboard_schedule_oid: null,
|
22
|
+
emails: null,
|
23
|
+
next_send_dts: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -1,12 +1,12 @@
|
|
1
|
-
# UltracartClient::
|
1
|
+
# UltracartClient::CustomDashboardScheduleResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **chargeback** | [**ChargebackDispute**](ChargebackDispute.md) | | [optional] |
|
8
7
|
| **error** | [**Error**](Error.md) | | [optional] |
|
9
8
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | | [optional] |
|
10
10
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
11
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
12
|
|
@@ -15,10 +15,10 @@
|
|
15
15
|
```ruby
|
16
16
|
require 'ultracart_api'
|
17
17
|
|
18
|
-
instance = UltracartClient::
|
19
|
-
chargeback: null,
|
18
|
+
instance = UltracartClient::CustomDashboardScheduleResponse.new(
|
20
19
|
error: null,
|
21
20
|
metadata: null,
|
21
|
+
schedule: null,
|
22
22
|
success: null,
|
23
23
|
warning: null
|
24
24
|
)
|
@@ -1,12 +1,12 @@
|
|
1
|
-
# UltracartClient::
|
1
|
+
# UltracartClient::CustomDashboardSchedulesResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **chargebacks** | [**Array<ChargebackDispute>**](ChargebackDispute.md) | | [optional] |
|
8
7
|
| **error** | [**Error**](Error.md) | | [optional] |
|
9
8
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **schedules** | [**Array<CustomDashboardSchedule>**](CustomDashboardSchedule.md) | schedules | [optional] |
|
10
10
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
11
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
12
|
|
@@ -15,10 +15,10 @@
|
|
15
15
|
```ruby
|
16
16
|
require 'ultracart_api'
|
17
17
|
|
18
|
-
instance = UltracartClient::
|
19
|
-
chargebacks: null,
|
18
|
+
instance = UltracartClient::CustomDashboardSchedulesResponse.new(
|
20
19
|
error: null,
|
21
20
|
metadata: null,
|
21
|
+
schedules: null,
|
22
22
|
success: null,
|
23
23
|
warning: null
|
24
24
|
)
|
data/docs/CustomReport.md
CHANGED
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **business_analysis_prompt** | **String** | | [optional] |
|
7
8
|
| **chart_javascript** | **String** | | [optional] |
|
8
9
|
| **chart_javascript_url** | **String** | | [optional] |
|
9
10
|
| **data_warehouse_report_config_oid** | **Integer** | | [optional] |
|
@@ -21,6 +22,7 @@
|
|
21
22
|
require 'ultracart_api'
|
22
23
|
|
23
24
|
instance = UltracartClient::CustomReport.new(
|
25
|
+
business_analysis_prompt: null,
|
24
26
|
chart_javascript: null,
|
25
27
|
chart_javascript_url: null,
|
26
28
|
data_warehouse_report_config_oid: null,
|
data/docs/DatawarehouseApi.md
CHANGED
@@ -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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 |
|
@@ -83,6 +87,60 @@ nil (empty response body)
|
|
83
87
|
- **Accept**: application/json
|
84
88
|
|
85
89
|
|
90
|
+
## delete_custom_dashboard_schedule
|
91
|
+
|
92
|
+
> delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
|
93
|
+
|
94
|
+
Delete a custom dashboard schedule
|
95
|
+
|
96
|
+
delete a custom dashboard schedule on the UltraCart account.
|
97
|
+
|
98
|
+
|
99
|
+
### Examples
|
100
|
+
|
101
|
+
|
102
|
+
(No example for this operation).
|
103
|
+
|
104
|
+
|
105
|
+
#### Using the delete_custom_dashboard_schedule_with_http_info variant
|
106
|
+
|
107
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
108
|
+
|
109
|
+
> <Array(nil, Integer, Hash)> delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
|
110
|
+
|
111
|
+
```ruby
|
112
|
+
begin
|
113
|
+
# Delete a custom dashboard schedule
|
114
|
+
data, status_code, headers = api_instance.delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid)
|
115
|
+
p status_code # => 2xx
|
116
|
+
p headers # => { ... }
|
117
|
+
p data # => nil
|
118
|
+
rescue UltracartClient::ApiError => e
|
119
|
+
puts "Error when calling DatawarehouseApi->delete_custom_dashboard_schedule_with_http_info: #{e}"
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
| Name | Type | Description | Notes |
|
126
|
+
| ---- | ---- | ----------- | ----- |
|
127
|
+
| **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to delete. | |
|
128
|
+
| **custom_dashboard_oid** | **Integer** | The dashboard oid that owns the schedule. | |
|
129
|
+
|
130
|
+
### Return type
|
131
|
+
|
132
|
+
nil (empty response body)
|
133
|
+
|
134
|
+
### Authorization
|
135
|
+
|
136
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
137
|
+
|
138
|
+
### HTTP request headers
|
139
|
+
|
140
|
+
- **Content-Type**: Not defined
|
141
|
+
- **Accept**: application/json
|
142
|
+
|
143
|
+
|
86
144
|
## delete_custom_report
|
87
145
|
|
88
146
|
> delete_custom_report(custom_report_oid)
|
@@ -458,6 +516,59 @@ end
|
|
458
516
|
- **Accept**: application/json
|
459
517
|
|
460
518
|
|
519
|
+
## get_custom_dashboard_schedules
|
520
|
+
|
521
|
+
> <CustomDashboardSchedulesResponse> get_custom_dashboard_schedules(custom_dashboard_oid)
|
522
|
+
|
523
|
+
Get custom dashboards
|
524
|
+
|
525
|
+
Retrieve a custom dashboards
|
526
|
+
|
527
|
+
|
528
|
+
### Examples
|
529
|
+
|
530
|
+
|
531
|
+
(No example for this operation).
|
532
|
+
|
533
|
+
|
534
|
+
#### Using the get_custom_dashboard_schedules_with_http_info variant
|
535
|
+
|
536
|
+
This returns an Array which contains the response data, status code and headers.
|
537
|
+
|
538
|
+
> <Array(<CustomDashboardSchedulesResponse>, Integer, Hash)> get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
|
539
|
+
|
540
|
+
```ruby
|
541
|
+
begin
|
542
|
+
# Get custom dashboards
|
543
|
+
data, status_code, headers = api_instance.get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid)
|
544
|
+
p status_code # => 2xx
|
545
|
+
p headers # => { ... }
|
546
|
+
p data # => <CustomDashboardSchedulesResponse>
|
547
|
+
rescue UltracartClient::ApiError => e
|
548
|
+
puts "Error when calling DatawarehouseApi->get_custom_dashboard_schedules_with_http_info: #{e}"
|
549
|
+
end
|
550
|
+
```
|
551
|
+
|
552
|
+
### Parameters
|
553
|
+
|
554
|
+
| Name | Type | Description | Notes |
|
555
|
+
| ---- | ---- | ----------- | ----- |
|
556
|
+
| **custom_dashboard_oid** | **Integer** | | |
|
557
|
+
|
558
|
+
### Return type
|
559
|
+
|
560
|
+
[**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.md)
|
561
|
+
|
562
|
+
### Authorization
|
563
|
+
|
564
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
565
|
+
|
566
|
+
### HTTP request headers
|
567
|
+
|
568
|
+
- **Content-Type**: Not defined
|
569
|
+
- **Accept**: application/json
|
570
|
+
|
571
|
+
|
461
572
|
## get_custom_dashboards
|
462
573
|
|
463
574
|
> <CustomDashboardsResponse> get_custom_dashboards
|
@@ -984,6 +1095,60 @@ end
|
|
984
1095
|
- **Accept**: application/json
|
985
1096
|
|
986
1097
|
|
1098
|
+
## insert_custom_dashboard_schedule
|
1099
|
+
|
1100
|
+
> <CustomDashboardScheduleResponse> insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
|
1101
|
+
|
1102
|
+
Create a custom dashboard schedule
|
1103
|
+
|
1104
|
+
Create a new custom dashboard schedule on the UltraCart account.
|
1105
|
+
|
1106
|
+
|
1107
|
+
### Examples
|
1108
|
+
|
1109
|
+
|
1110
|
+
(No example for this operation).
|
1111
|
+
|
1112
|
+
|
1113
|
+
#### Using the insert_custom_dashboard_schedule_with_http_info variant
|
1114
|
+
|
1115
|
+
This returns an Array which contains the response data, status code and headers.
|
1116
|
+
|
1117
|
+
> <Array(<CustomDashboardScheduleResponse>, Integer, Hash)> insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
|
1118
|
+
|
1119
|
+
```ruby
|
1120
|
+
begin
|
1121
|
+
# Create a custom dashboard schedule
|
1122
|
+
data, status_code, headers = api_instance.insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule)
|
1123
|
+
p status_code # => 2xx
|
1124
|
+
p headers # => { ... }
|
1125
|
+
p data # => <CustomDashboardScheduleResponse>
|
1126
|
+
rescue UltracartClient::ApiError => e
|
1127
|
+
puts "Error when calling DatawarehouseApi->insert_custom_dashboard_schedule_with_http_info: #{e}"
|
1128
|
+
end
|
1129
|
+
```
|
1130
|
+
|
1131
|
+
### Parameters
|
1132
|
+
|
1133
|
+
| Name | Type | Description | Notes |
|
1134
|
+
| ---- | ---- | ----------- | ----- |
|
1135
|
+
| **custom_dashboard_oid** | **Integer** | | |
|
1136
|
+
| **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to create | |
|
1137
|
+
|
1138
|
+
### Return type
|
1139
|
+
|
1140
|
+
[**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.md)
|
1141
|
+
|
1142
|
+
### Authorization
|
1143
|
+
|
1144
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1145
|
+
|
1146
|
+
### HTTP request headers
|
1147
|
+
|
1148
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1149
|
+
- **Accept**: application/json
|
1150
|
+
|
1151
|
+
|
987
1152
|
## insert_custom_report
|
988
1153
|
|
989
1154
|
> <CustomReportResponse> insert_custom_report(report)
|
@@ -1145,6 +1310,61 @@ end
|
|
1145
1310
|
- **Accept**: application/json
|
1146
1311
|
|
1147
1312
|
|
1313
|
+
## update_custom_dashboard_schedule
|
1314
|
+
|
1315
|
+
> <CustomDashboardResponse> update_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
|
1316
|
+
|
1317
|
+
Update a custom dashboard schedule
|
1318
|
+
|
1319
|
+
Update a custom dashboard schedule on the UltraCart account.
|
1320
|
+
|
1321
|
+
|
1322
|
+
### Examples
|
1323
|
+
|
1324
|
+
|
1325
|
+
(No example for this operation).
|
1326
|
+
|
1327
|
+
|
1328
|
+
#### Using the update_custom_dashboard_schedule_with_http_info variant
|
1329
|
+
|
1330
|
+
This returns an Array which contains the response data, status code and headers.
|
1331
|
+
|
1332
|
+
> <Array(<CustomDashboardResponse>, Integer, Hash)> update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
|
1333
|
+
|
1334
|
+
```ruby
|
1335
|
+
begin
|
1336
|
+
# Update a custom dashboard schedule
|
1337
|
+
data, status_code, headers = api_instance.update_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, dashboard_schedule)
|
1338
|
+
p status_code # => 2xx
|
1339
|
+
p headers # => { ... }
|
1340
|
+
p data # => <CustomDashboardResponse>
|
1341
|
+
rescue UltracartClient::ApiError => e
|
1342
|
+
puts "Error when calling DatawarehouseApi->update_custom_dashboard_schedule_with_http_info: #{e}"
|
1343
|
+
end
|
1344
|
+
```
|
1345
|
+
|
1346
|
+
### Parameters
|
1347
|
+
|
1348
|
+
| Name | Type | Description | Notes |
|
1349
|
+
| ---- | ---- | ----------- | ----- |
|
1350
|
+
| **custom_dashboard_schedule_oid** | **Integer** | The dashboard schedule oid to update. | |
|
1351
|
+
| **custom_dashboard_oid** | **Integer** | The dashboard oid to update. | |
|
1352
|
+
| **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md) | Dashboard schedule to update | |
|
1353
|
+
|
1354
|
+
### Return type
|
1355
|
+
|
1356
|
+
[**CustomDashboardResponse**](CustomDashboardResponse.md)
|
1357
|
+
|
1358
|
+
### Authorization
|
1359
|
+
|
1360
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1361
|
+
|
1362
|
+
### HTTP request headers
|
1363
|
+
|
1364
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1365
|
+
- **Accept**: application/json
|
1366
|
+
|
1367
|
+
|
1148
1368
|
## update_custom_report
|
1149
1369
|
|
1150
1370
|
> <CustomReportResponse> update_custom_report(custom_report_oid, report)
|
data/docs/EmailCampaign.md
CHANGED
@@ -21,6 +21,8 @@
|
|
21
21
|
| **name** | **String** | Name of email campaign | [optional] |
|
22
22
|
| **open_rate_formatted** | **String** | Open rate of emails | [optional] |
|
23
23
|
| **prevent_sending_due_to_spam** | **Boolean** | True if this campaign is prevented from sending at this time due to spam complaints. | [optional] |
|
24
|
+
| **repeat_monthly** | **Boolean** | True if the campaign should repeat on a monthly basis | [optional] |
|
25
|
+
| **repeat_weekly** | **Boolean** | True if the campaign should repeat on a weekly basis | [optional] |
|
24
26
|
| **revenue_formatted** | **String** | Revenue associated with campaign | [optional] |
|
25
27
|
| **revenue_per_customer_formatted** | **String** | Revenue per customer associated with campaign | [optional] |
|
26
28
|
| **scheduled_dts** | **String** | Scheduled date | [optional] |
|
@@ -54,6 +56,8 @@ instance = UltracartClient::EmailCampaign.new(
|
|
54
56
|
name: null,
|
55
57
|
open_rate_formatted: null,
|
56
58
|
prevent_sending_due_to_spam: null,
|
59
|
+
repeat_monthly: null,
|
60
|
+
repeat_weekly: null,
|
57
61
|
revenue_formatted: null,
|
58
62
|
revenue_per_customer_formatted: null,
|
59
63
|
scheduled_dts: null,
|