ultracart_api 4.1.19 → 4.1.21
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 +18 -10
- data/docs/CustomDashboardSchedule.md +26 -0
- data/docs/{ChargebackDisputesResponse.md → CustomDashboardScheduleResponse.md} +4 -4
- data/docs/CustomDashboardSchedulesResponse.md +26 -0
- data/docs/CustomReport.md +2 -0
- data/docs/CustomReportAccountConfig.md +2 -0
- data/docs/CustomReportAnalysisRequest.md +20 -0
- data/docs/{ChargebackDisputeResponse.md → CustomReportAnalysisResponse.md} +4 -4
- data/docs/CustomReportChartPngUploadResponse.md +28 -0
- data/docs/DatawarehouseApi.md +329 -0
- data/docs/EmailCampaign.md +4 -0
- data/docs/ItemTag.md +1 -1
- data/docs/OrderApi.md +56 -0
- data/docs/ReplaceOrderItemIdRequest.md +24 -0
- data/lib/ultracart_api/api/datawarehouse_api.rb +429 -0
- data/lib/ultracart_api/api/order_api.rb +78 -0
- data/lib/ultracart_api/models/custom_dashboard_schedule.rb +258 -0
- data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedule_response.rb} +13 -15
- data/lib/ultracart_api/models/custom_dashboard_schedules_response.rb +259 -0
- data/lib/ultracart_api/models/custom_report.rb +10 -1
- data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
- data/lib/ultracart_api/models/custom_report_analysis_request.rb +228 -0
- data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_report_analysis_response.rb} +13 -13
- data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +265 -0
- data/lib/ultracart_api/models/email_campaign.rb +21 -1
- data/lib/ultracart_api/models/item_tag.rb +1 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +280 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -4
- metadata +16 -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: a81555a84d9f7c6491053430ac98dd5168369622872b6aea0baa55a4041398b4
|
4
|
+
data.tar.gz: a0e067baf5005e9baba770d466e75f165153072002565f76297d93ea83a2a205
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c6b067c6e4e63dd5abc91be738a77231d6d8ca273c3a07f16b6b01ac33e5e173bba366f8ab68b7bbcf40dc48d1883c8a1fafe5cb47b1bc2f6873e3e56c6072e5
|
7
|
+
data.tar.gz: 0cc19e313437722ed16a70f1475ed4594d023174342567b4e7c7f784528b04240594305739161261445faae73a5cf5f1e571ea6ce5df165812ebb7dde19f064a
|
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.21
|
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.21'
|
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)
|
@@ -265,7 +260,9 @@ Class | Method | HTTP request | Description
|
|
265
260
|
*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
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
|
263
|
+
*UltracartClient::DatawarehouseApi* | [**analyze_custom_report**](docs/DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
|
268
264
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
|
265
|
+
*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
266
|
*UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
|
270
267
|
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
271
268
|
*UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
@@ -273,9 +270,11 @@ Class | Method | HTTP request | Description
|
|
273
270
|
*UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
|
274
271
|
*UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
|
275
272
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
|
273
|
+
*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
274
|
*UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
|
277
275
|
*UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
|
278
276
|
*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
|
277
|
+
*UltracartClient::DatawarehouseApi* | [**get_custom_report_chart_png_upload_url**](docs/DatawarehouseApi.md#get_custom_report_chart_png_upload_url) | **GET** /datawarehouse/custom_reports/{custom_report_oid}/chart_png | Upload a PNG of a custom report chart
|
279
278
|
*UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
|
280
279
|
*UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
|
281
280
|
*UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
|
@@ -283,9 +282,11 @@ Class | Method | HTTP request | Description
|
|
283
282
|
*UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
|
284
283
|
*UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
|
285
284
|
*UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
|
285
|
+
*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
286
|
*UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
|
287
287
|
*UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
|
288
288
|
*UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
|
289
|
+
*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
290
|
*UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
|
290
291
|
*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
292
|
*UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
|
@@ -355,6 +356,7 @@ Class | Method | HTTP request | Description
|
|
355
356
|
*UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
|
356
357
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
357
358
|
*UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
359
|
+
*UltracartClient::OrderApi* | [**replace_order_item_merchant_item_id**](docs/OrderApi.md#replace_order_item_merchant_item_id) | **PUT** /order/orders/{order_id}/replace_item_id | Replaces an order item id
|
358
360
|
*UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
|
359
361
|
*UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
|
360
362
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
@@ -728,9 +730,6 @@ Class | Method | HTTP request | Description
|
|
728
730
|
- [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
|
729
731
|
- [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
|
730
732
|
- [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
|
731
|
-
- [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
|
732
|
-
- [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
|
733
|
-
- [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
|
734
733
|
- [UltracartClient::CheckoutAllowedCountriesResponse](docs/CheckoutAllowedCountriesResponse.md)
|
735
734
|
- [UltracartClient::CheckoutHandoffRequest](docs/CheckoutHandoffRequest.md)
|
736
735
|
- [UltracartClient::CheckoutHandoffResponse](docs/CheckoutHandoffResponse.md)
|
@@ -918,10 +917,16 @@ Class | Method | HTTP request | Description
|
|
918
917
|
- [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
|
919
918
|
- [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
|
920
919
|
- [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
|
920
|
+
- [UltracartClient::CustomDashboardSchedule](docs/CustomDashboardSchedule.md)
|
921
|
+
- [UltracartClient::CustomDashboardScheduleResponse](docs/CustomDashboardScheduleResponse.md)
|
922
|
+
- [UltracartClient::CustomDashboardSchedulesResponse](docs/CustomDashboardSchedulesResponse.md)
|
921
923
|
- [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
|
922
924
|
- [UltracartClient::CustomReport](docs/CustomReport.md)
|
923
925
|
- [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
|
924
926
|
- [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
|
927
|
+
- [UltracartClient::CustomReportAnalysisRequest](docs/CustomReportAnalysisRequest.md)
|
928
|
+
- [UltracartClient::CustomReportAnalysisResponse](docs/CustomReportAnalysisResponse.md)
|
929
|
+
- [UltracartClient::CustomReportChartPngUploadResponse](docs/CustomReportChartPngUploadResponse.md)
|
925
930
|
- [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
|
926
931
|
- [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
|
927
932
|
- [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
|
@@ -1328,6 +1333,7 @@ Class | Method | HTTP request | Description
|
|
1328
1333
|
- [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
|
1329
1334
|
- [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
|
1330
1335
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
1336
|
+
- [UltracartClient::ReplaceOrderItemIdRequest](docs/ReplaceOrderItemIdRequest.md)
|
1331
1337
|
- [UltracartClient::Report](docs/Report.md)
|
1332
1338
|
- [UltracartClient::ReportAuth](docs/ReportAuth.md)
|
1333
1339
|
- [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
|
@@ -1569,6 +1575,8 @@ Not every change is committed to every SDK.
|
|
1569
1575
|
|
1570
1576
|
| Version | Date | Comments |
|
1571
1577
|
| --: | :-: | --- |
|
1578
|
+
| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1579
|
+
| 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1572
1580
|
| 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
1573
1581
|
| 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
1574
1582
|
| 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
|
-
| **chargebacks** | [**Array<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
|
-
chargebacks: 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
|
)
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomDashboardSchedulesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **schedules** | [**Array<CustomDashboardSchedule>**](CustomDashboardSchedule.md) | schedules | [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::CustomDashboardSchedulesResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
schedules: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
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,
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **opt_in** | **Boolean** | True if they have opted into custom reports | [optional] |
|
12
12
|
| **opt_in_by_user** | **String** | User that opted into custom reporting | [optional] |
|
13
13
|
| **opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional] |
|
14
|
+
| **read_only** | **Boolean** | | [optional] |
|
14
15
|
| **sql_budget** | **Float** | | [optional] |
|
15
16
|
| **sql_usage** | **Float** | | [optional] |
|
16
17
|
|
@@ -27,6 +28,7 @@ instance = UltracartClient::CustomReportAccountConfig.new(
|
|
27
28
|
opt_in: null,
|
28
29
|
opt_in_by_user: null,
|
29
30
|
opt_in_date: null,
|
31
|
+
read_only: null,
|
30
32
|
sql_budget: null,
|
31
33
|
sql_usage: null
|
32
34
|
)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::CustomReportAnalysisRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **png_url** | **String** | | [optional] |
|
8
|
+
| **result_url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::CustomReportAnalysisRequest.new(
|
16
|
+
png_url: null,
|
17
|
+
result_url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -1,11 +1,11 @@
|
|
1
|
-
# UltracartClient::
|
1
|
+
# UltracartClient::CustomReportAnalysisResponse
|
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] |
|
8
|
+
| **html** | **String** | | [optional] |
|
9
9
|
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
10
|
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
11
|
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
@@ -15,9 +15,9 @@
|
|
15
15
|
```ruby
|
16
16
|
require 'ultracart_api'
|
17
17
|
|
18
|
-
instance = UltracartClient::
|
19
|
-
chargeback: null,
|
18
|
+
instance = UltracartClient::CustomReportAnalysisResponse.new(
|
20
19
|
error: null,
|
20
|
+
html: null,
|
21
21
|
metadata: null,
|
22
22
|
success: null,
|
23
23
|
warning: null
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# UltracartClient::CustomReportChartPngUploadResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **signed_download_url** | **String** | | [optional] |
|
10
|
+
| **signed_upload_url** | **String** | | [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::CustomReportChartPngUploadResponse.new(
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
signed_download_url: null,
|
23
|
+
signed_upload_url: null,
|
24
|
+
success: null,
|
25
|
+
warning: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|