ultracart_api 3.11.19 → 3.11.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.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -12
  3. data/docs/CustomDashboardSchedule.md +12 -0
  4. data/docs/{ChargebackDisputesResponse.md → CustomDashboardScheduleResponse.md} +2 -2
  5. data/docs/CustomDashboardSchedulesResponse.md +12 -0
  6. data/docs/CustomReport.md +1 -0
  7. data/docs/CustomReportAccountConfig.md +1 -0
  8. data/docs/CustomReportAnalysisRequest.md +9 -0
  9. data/docs/{ChargebackDisputeResponse.md → CustomReportAnalysisResponse.md} +2 -2
  10. data/docs/CustomReportChartPngUploadResponse.md +13 -0
  11. data/docs/DatawarehouseApi.md +320 -0
  12. data/docs/EmailCampaign.md +2 -0
  13. data/docs/ItemTag.md +1 -1
  14. data/docs/OrderApi.md +58 -0
  15. data/docs/ReplaceOrderItemIdRequest.md +11 -0
  16. data/lib/ultracart_api/api/datawarehouse_api.rb +359 -0
  17. data/lib/ultracart_api/api/order_api.rb +64 -0
  18. data/lib/ultracart_api/models/custom_dashboard_schedule.rb +223 -0
  19. data/lib/ultracart_api/models/{chargeback_dispute_response.rb → custom_dashboard_schedule_response.rb} +11 -11
  20. data/lib/ultracart_api/models/{chargeback_disputes_response.rb → custom_dashboard_schedules_response.rb} +14 -13
  21. data/lib/ultracart_api/models/custom_report.rb +10 -1
  22. data/lib/ultracart_api/models/custom_report_account_config.rb +10 -1
  23. data/lib/ultracart_api/models/custom_report_analysis_request.rb +193 -0
  24. data/lib/ultracart_api/models/custom_report_analysis_response.rb +221 -0
  25. data/lib/ultracart_api/models/custom_report_chart_png_upload_response.rb +230 -0
  26. data/lib/ultracart_api/models/email_campaign.rb +21 -1
  27. data/lib/ultracart_api/models/item_tag.rb +1 -1
  28. data/lib/ultracart_api/models/order_payment.rb +2 -2
  29. data/lib/ultracart_api/models/replace_order_item_id_request.rb +245 -0
  30. data/lib/ultracart_api/version.rb +1 -1
  31. data/lib/ultracart_api.rb +7 -4
  32. metadata +16 -10
  33. data/docs/ChargebackApi.md +0 -301
  34. data/docs/ChargebackDispute.md +0 -30
  35. data/lib/ultracart_api/api/chargeback_api.rb +0 -356
  36. 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: e732d8cc0f0d4a756220396cf16ae8d67d3421e003504600772831fb44338017
4
- data.tar.gz: 2236cbf50c29c360b03640870b4f8a66926100724af7009d1e7f5466243d7f7f
3
+ metadata.gz: d20e4cccc3734a6fa9c16a641520fbe569d0cbf42ec7d9ac5dad1d373e0353a8
4
+ data.tar.gz: 264507e5e031c6b06b455a44afa57bd1ffeabeaafff67c1bbe7f54dd425f2c88
5
5
  SHA512:
6
- metadata.gz: 2b1efa6024cfd94dbb4f30e42802400ced7217413f7fcac312b00791678b04316ea514cc3c0e0769f31c4008e678298c54d279072ea1a1c8d50984b093051d10
7
- data.tar.gz: 9208add239c38ec5bf0d68e785350aaa46bec7308ec47fc27f562f46e9723fc033017af8bbf1b88ec081862846e79b162bdf2cb780fe3ab1a1ef55b2bfb9891b
6
+ metadata.gz: ad83c0433866612348aa5422f4ebbf763ddf490e1ce746fccc92d2ddd446374c12d64e0523d7b91a0610148e0ecbc700f2f3025a756d3d4a83b126d2bbcadfe4
7
+ data.tar.gz: b31439125febf3a0f5a0f4352bd19f1f8a633dc1e78b4450d2fe4a5a5d819db29c3ca9cd8804f6a7577a3972cc9a874edb24d48283e733db3fb507484dfa92c0
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.19
10
+ - Package version: 3.11.21
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.19.gem
27
+ gem install ./ultracart_api-3.11.21.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.11.19.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.11.21.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.19'
35
+ gem 'ultracart_api', '~> 3.11.21'
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)
@@ -269,7 +264,9 @@ Class | Method | HTTP request | Description
269
264
  *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
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
267
+ *UltracartClient::DatawarehouseApi* | [**analyze_custom_report**](docs/DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
272
268
  *UltracartClient::DatawarehouseApi* | [**delete_custom_dashboard**](docs/DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
269
+ *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
270
  *UltracartClient::DatawarehouseApi* | [**delete_custom_report**](docs/DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
274
271
  *UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
275
272
  *UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
@@ -277,9 +274,11 @@ Class | Method | HTTP request | Description
277
274
  *UltracartClient::DatawarehouseApi* | [**execute_custom_reports**](docs/DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
278
275
  *UltracartClient::DatawarehouseApi* | [**execute_report_queries**](docs/DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
279
276
  *UltracartClient::DatawarehouseApi* | [**get_custom_dashboard**](docs/DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
277
+ *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
278
  *UltracartClient::DatawarehouseApi* | [**get_custom_dashboards**](docs/DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
281
279
  *UltracartClient::DatawarehouseApi* | [**get_custom_report**](docs/DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
282
280
  *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
281
+ *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
283
282
  *UltracartClient::DatawarehouseApi* | [**get_custom_reports**](docs/DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
284
283
  *UltracartClient::DatawarehouseApi* | [**get_report**](docs/DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
285
284
  *UltracartClient::DatawarehouseApi* | [**get_report_data_set**](docs/DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
@@ -287,9 +286,11 @@ Class | Method | HTTP request | Description
287
286
  *UltracartClient::DatawarehouseApi* | [**get_report_websocket_authorization**](docs/DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
288
287
  *UltracartClient::DatawarehouseApi* | [**get_reports**](docs/DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
289
288
  *UltracartClient::DatawarehouseApi* | [**insert_custom_dashboard**](docs/DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
289
+ *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
290
  *UltracartClient::DatawarehouseApi* | [**insert_custom_report**](docs/DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
291
291
  *UltracartClient::DatawarehouseApi* | [**insert_report**](docs/DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
292
292
  *UltracartClient::DatawarehouseApi* | [**update_custom_dashboard**](docs/DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
293
+ *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
294
  *UltracartClient::DatawarehouseApi* | [**update_custom_report**](docs/DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
294
295
  *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
296
  *UltracartClient::DatawarehouseApi* | [**update_report**](docs/DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
@@ -359,6 +360,7 @@ Class | Method | HTTP request | Description
359
360
  *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
360
361
  *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
361
362
  *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
363
+ *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
362
364
  *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
363
365
  *UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
364
366
  *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
@@ -732,9 +734,6 @@ Class | Method | HTTP request | Description
732
734
  - [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
733
735
  - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
734
736
  - [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
735
- - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
736
- - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
737
- - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
738
737
  - [UltracartClient::CheckoutAllowedCountriesResponse](docs/CheckoutAllowedCountriesResponse.md)
739
738
  - [UltracartClient::CheckoutHandoffRequest](docs/CheckoutHandoffRequest.md)
740
739
  - [UltracartClient::CheckoutHandoffResponse](docs/CheckoutHandoffResponse.md)
@@ -923,10 +922,16 @@ Class | Method | HTTP request | Description
923
922
  - [UltracartClient::CustomDashboardPage](docs/CustomDashboardPage.md)
924
923
  - [UltracartClient::CustomDashboardPageReport](docs/CustomDashboardPageReport.md)
925
924
  - [UltracartClient::CustomDashboardResponse](docs/CustomDashboardResponse.md)
925
+ - [UltracartClient::CustomDashboardSchedule](docs/CustomDashboardSchedule.md)
926
+ - [UltracartClient::CustomDashboardScheduleResponse](docs/CustomDashboardScheduleResponse.md)
927
+ - [UltracartClient::CustomDashboardSchedulesResponse](docs/CustomDashboardSchedulesResponse.md)
926
928
  - [UltracartClient::CustomDashboardsResponse](docs/CustomDashboardsResponse.md)
927
929
  - [UltracartClient::CustomReport](docs/CustomReport.md)
928
930
  - [UltracartClient::CustomReportAccountConfig](docs/CustomReportAccountConfig.md)
929
931
  - [UltracartClient::CustomReportAccountConfigResponse](docs/CustomReportAccountConfigResponse.md)
932
+ - [UltracartClient::CustomReportAnalysisRequest](docs/CustomReportAnalysisRequest.md)
933
+ - [UltracartClient::CustomReportAnalysisResponse](docs/CustomReportAnalysisResponse.md)
934
+ - [UltracartClient::CustomReportChartPngUploadResponse](docs/CustomReportChartPngUploadResponse.md)
930
935
  - [UltracartClient::CustomReportExecutionParameter](docs/CustomReportExecutionParameter.md)
931
936
  - [UltracartClient::CustomReportExecutionRequest](docs/CustomReportExecutionRequest.md)
932
937
  - [UltracartClient::CustomReportExecutionResponse](docs/CustomReportExecutionResponse.md)
@@ -1333,6 +1338,7 @@ Class | Method | HTTP request | Description
1333
1338
  - [UltracartClient::PublishLibraryItemRequest](docs/PublishLibraryItemRequest.md)
1334
1339
  - [UltracartClient::RegisterAffiliateClickRequest](docs/RegisterAffiliateClickRequest.md)
1335
1340
  - [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
1341
+ - [UltracartClient::ReplaceOrderItemIdRequest](docs/ReplaceOrderItemIdRequest.md)
1336
1342
  - [UltracartClient::Report](docs/Report.md)
1337
1343
  - [UltracartClient::ReportAuth](docs/ReportAuth.md)
1338
1344
  - [UltracartClient::ReportAuthResponse](docs/ReportAuthResponse.md)
@@ -1571,6 +1577,8 @@ Not every change is committed to every SDK.
1571
1577
 
1572
1578
  | Version | Date | Comments |
1573
1579
  | --: | :-: | --- |
1580
+ | 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
1581
+ | 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
1574
1582
  | 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
1575
1583
  | 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
1576
1584
  | 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
@@ -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::ChargebackDisputesResponse
1
+ # UltracartClient::CustomDashboardScheduleResponse
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
+ **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
 
@@ -0,0 +1,12 @@
1
+ # UltracartClient::CustomDashboardSchedulesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **schedules** | [**Array<CustomDashboardSchedule>**](CustomDashboardSchedule.md) | schedules | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
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]
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **opt_in** | **BOOLEAN** | True if they have opted into custom reports | [optional]
11
11
  **opt_in_by_user** | **String** | User that opted into custom reporting | [optional]
12
12
  **opt_in_date** | **String** | Date/time that custom reporting was opted in to | [optional]
13
+ **read_only** | **BOOLEAN** | | [optional]
13
14
  **sql_budget** | **Float** | | [optional]
14
15
  **sql_usage** | **Float** | | [optional]
15
16
 
@@ -0,0 +1,9 @@
1
+ # UltracartClient::CustomReportAnalysisRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **png_url** | **String** | | [optional]
7
+ **result_url** | **String** | | [optional]
8
+
9
+
@@ -1,10 +1,10 @@
1
- # UltracartClient::ChargebackDisputeResponse
1
+ # UltracartClient::CustomReportAnalysisResponse
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]
7
+ **html** | **String** | | [optional]
8
8
  **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
9
  **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
10
  **warning** | [**Warning**](Warning.md) | | [optional]
@@ -0,0 +1,13 @@
1
+ # UltracartClient::CustomReportChartPngUploadResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **signed_download_url** | **String** | | [optional]
9
+ **signed_upload_url** | **String** | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
@@ -4,7 +4,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**analyze_custom_report**](DatawarehouseApi.md#analyze_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid}/analysis | Analyze a custom report
7
8
  [**delete_custom_dashboard**](DatawarehouseApi.md#delete_custom_dashboard) | **DELETE** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Delete a custom dashboard
9
+ [**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
10
  [**delete_custom_report**](DatawarehouseApi.md#delete_custom_report) | **DELETE** /datawarehouse/custom_reports/{custom_report_oid} | Delete a custom report
9
11
  [**delete_report**](DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
10
12
  [**dry_run_report_queries**](DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
@@ -12,9 +14,11 @@ Method | HTTP request | Description
12
14
  [**execute_custom_reports**](DatawarehouseApi.md#execute_custom_reports) | **PUT** /datawarehouse/custom_reports/execute | Execute a custom reports
13
15
  [**execute_report_queries**](DatawarehouseApi.md#execute_report_queries) | **PUT** /datawarehouse/reports/execute | Execute the report queries
14
16
  [**get_custom_dashboard**](DatawarehouseApi.md#get_custom_dashboard) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Get a custom dashboard
17
+ [**get_custom_dashboard_schedules**](DatawarehouseApi.md#get_custom_dashboard_schedules) | **GET** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Get custom dashboards
15
18
  [**get_custom_dashboards**](DatawarehouseApi.md#get_custom_dashboards) | **GET** /datawarehouse/custom_dashboards | Get custom dashboards
16
19
  [**get_custom_report**](DatawarehouseApi.md#get_custom_report) | **GET** /datawarehouse/custom_reports/{custom_report_oid} | Get a custom report
17
20
  [**get_custom_report_account_config**](DatawarehouseApi.md#get_custom_report_account_config) | **GET** /datawarehouse/custom_reports/account_config | Get custom report account configuration
21
+ [**get_custom_report_chart_png_upload_url**](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
18
22
  [**get_custom_reports**](DatawarehouseApi.md#get_custom_reports) | **GET** /datawarehouse/custom_reports | Get custom reports
19
23
  [**get_report**](DatawarehouseApi.md#get_report) | **GET** /datawarehouse/reports/{report_oid} | Get a report
20
24
  [**get_report_data_set**](DatawarehouseApi.md#get_report_data_set) | **GET** /datawarehouse/reports/dataset/{dataset_uuid} | Get a report data set
@@ -22,14 +26,69 @@ Method | HTTP request | Description
22
26
  [**get_report_websocket_authorization**](DatawarehouseApi.md#get_report_websocket_authorization) | **PUT** /datawarehouse/reports/auth | Get report websocket authorization
23
27
  [**get_reports**](DatawarehouseApi.md#get_reports) | **GET** /datawarehouse/reports | Get list of reports available
24
28
  [**insert_custom_dashboard**](DatawarehouseApi.md#insert_custom_dashboard) | **POST** /datawarehouse/custom_dashboards | Create a custom dashboard
29
+ [**insert_custom_dashboard_schedule**](DatawarehouseApi.md#insert_custom_dashboard_schedule) | **POST** /datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules | Create a custom dashboard schedule
25
30
  [**insert_custom_report**](DatawarehouseApi.md#insert_custom_report) | **POST** /datawarehouse/custom_reports | Create a custom report
26
31
  [**insert_report**](DatawarehouseApi.md#insert_report) | **POST** /datawarehouse/reports | Create a report
27
32
  [**update_custom_dashboard**](DatawarehouseApi.md#update_custom_dashboard) | **PUT** /datawarehouse/custom_dashboards/{custom_dashboard_oid} | Update a custom dashboard
33
+ [**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
34
  [**update_custom_report**](DatawarehouseApi.md#update_custom_report) | **PUT** /datawarehouse/custom_reports/{custom_report_oid} | Update a custom report
29
35
  [**update_custom_report_account_config**](DatawarehouseApi.md#update_custom_report_account_config) | **PUT** /datawarehouse/custom_reports/account_config | Update custom report account config
30
36
  [**update_report**](DatawarehouseApi.md#update_report) | **PUT** /datawarehouse/reports/{report_oid} | Update a report
31
37
 
32
38
 
39
+ # **analyze_custom_report**
40
+ > CustomReportAnalysisResponse analyze_custom_report(analyze_request, custom_report_oid)
41
+
42
+ Analyze a custom report
43
+
44
+ Analyze a custom report on the UltraCart account.
45
+
46
+ ### Example
47
+ ```ruby
48
+ # load the gem
49
+ require 'ultracart_api'
50
+
51
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
52
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
53
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
54
+
55
+
56
+ analyze_request = UltracartClient::CustomReportAnalysisRequest.new # CustomReportAnalysisRequest | Request to analyze custom report
57
+
58
+ custom_report_oid = 56 # Integer | The report oid to analyze.
59
+
60
+
61
+ begin
62
+ #Analyze a custom report
63
+ result = api_instance.analyze_custom_report(analyze_request, custom_report_oid)
64
+ p result
65
+ rescue UltracartClient::ApiError => e
66
+ puts "Exception when calling DatawarehouseApi->analyze_custom_report: #{e}"
67
+ end
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ Name | Type | Description | Notes
73
+ ------------- | ------------- | ------------- | -------------
74
+ **analyze_request** | [**CustomReportAnalysisRequest**](CustomReportAnalysisRequest.md)| Request to analyze custom report |
75
+ **custom_report_oid** | **Integer**| The report oid to analyze. |
76
+
77
+ ### Return type
78
+
79
+ [**CustomReportAnalysisResponse**](CustomReportAnalysisResponse.md)
80
+
81
+ ### Authorization
82
+
83
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: application/json; charset=UTF-8
88
+ - **Accept**: application/json
89
+
90
+
91
+
33
92
  # **delete_custom_dashboard**
34
93
  > delete_custom_dashboard(custom_dashboard_oid)
35
94
 
@@ -79,6 +138,58 @@ nil (empty response body)
79
138
 
80
139
 
81
140
 
141
+ # **delete_custom_dashboard_schedule**
142
+ > delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
143
+
144
+ Delete a custom dashboard schedule
145
+
146
+ delete a custom dashboard schedule on the UltraCart account.
147
+
148
+ ### Example
149
+ ```ruby
150
+ # load the gem
151
+ require 'ultracart_api'
152
+
153
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
154
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
155
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
156
+
157
+
158
+ custom_dashboard_schedule_oid = 56 # Integer | The dashboard schedule oid to delete.
159
+
160
+ custom_dashboard_oid = 56 # Integer | The dashboard oid that owns the schedule.
161
+
162
+
163
+ begin
164
+ #Delete a custom dashboard schedule
165
+ api_instance.delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid)
166
+ rescue UltracartClient::ApiError => e
167
+ puts "Exception when calling DatawarehouseApi->delete_custom_dashboard_schedule: #{e}"
168
+ end
169
+ ```
170
+
171
+ ### Parameters
172
+
173
+ Name | Type | Description | Notes
174
+ ------------- | ------------- | ------------- | -------------
175
+ **custom_dashboard_schedule_oid** | **Integer**| The dashboard schedule oid to delete. |
176
+ **custom_dashboard_oid** | **Integer**| The dashboard oid that owns the schedule. |
177
+
178
+ ### Return type
179
+
180
+ nil (empty response body)
181
+
182
+ ### Authorization
183
+
184
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
185
+
186
+ ### HTTP request headers
187
+
188
+ - **Content-Type**: application/json; charset=UTF-8
189
+ - **Accept**: application/json
190
+
191
+
192
+
82
193
  # **delete_custom_report**
83
194
  > delete_custom_report(custom_report_oid)
84
195
 
@@ -429,6 +540,56 @@ Name | Type | Description | Notes
429
540
 
430
541
 
431
542
 
543
+ # **get_custom_dashboard_schedules**
544
+ > CustomDashboardSchedulesResponse get_custom_dashboard_schedules(custom_dashboard_oid)
545
+
546
+ Get custom dashboards
547
+
548
+ Retrieve a custom dashboards
549
+
550
+ ### Example
551
+ ```ruby
552
+ # load the gem
553
+ require 'ultracart_api'
554
+
555
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
556
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
557
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
558
+
559
+
560
+ custom_dashboard_oid = 56 # Integer |
561
+
562
+
563
+ begin
564
+ #Get custom dashboards
565
+ result = api_instance.get_custom_dashboard_schedules(custom_dashboard_oid)
566
+ p result
567
+ rescue UltracartClient::ApiError => e
568
+ puts "Exception when calling DatawarehouseApi->get_custom_dashboard_schedules: #{e}"
569
+ end
570
+ ```
571
+
572
+ ### Parameters
573
+
574
+ Name | Type | Description | Notes
575
+ ------------- | ------------- | ------------- | -------------
576
+ **custom_dashboard_oid** | **Integer**| |
577
+
578
+ ### Return type
579
+
580
+ [**CustomDashboardSchedulesResponse**](CustomDashboardSchedulesResponse.md)
581
+
582
+ ### Authorization
583
+
584
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
585
+
586
+ ### HTTP request headers
587
+
588
+ - **Content-Type**: application/json
589
+ - **Accept**: application/json
590
+
591
+
592
+
432
593
  # **get_custom_dashboards**
433
594
  > CustomDashboardsResponse get_custom_dashboards
434
595
 
@@ -569,6 +730,56 @@ This endpoint does not need any parameter.
569
730
 
570
731
 
571
732
 
733
+ # **get_custom_report_chart_png_upload_url**
734
+ > CustomReportChartPngUploadResponse get_custom_report_chart_png_upload_url(custom_report_oid)
735
+
736
+ Upload a PNG of a custom report chart
737
+
738
+ Upload a PNG of a custom report chart
739
+
740
+ ### Example
741
+ ```ruby
742
+ # load the gem
743
+ require 'ultracart_api'
744
+
745
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
746
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
747
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
748
+
749
+
750
+ custom_report_oid = 56 # Integer | The report oid to upload a chart PNG for.
751
+
752
+
753
+ begin
754
+ #Upload a PNG of a custom report chart
755
+ result = api_instance.get_custom_report_chart_png_upload_url(custom_report_oid)
756
+ p result
757
+ rescue UltracartClient::ApiError => e
758
+ puts "Exception when calling DatawarehouseApi->get_custom_report_chart_png_upload_url: #{e}"
759
+ end
760
+ ```
761
+
762
+ ### Parameters
763
+
764
+ Name | Type | Description | Notes
765
+ ------------- | ------------- | ------------- | -------------
766
+ **custom_report_oid** | **Integer**| The report oid to upload a chart PNG for. |
767
+
768
+ ### Return type
769
+
770
+ [**CustomReportChartPngUploadResponse**](CustomReportChartPngUploadResponse.md)
771
+
772
+ ### Authorization
773
+
774
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: application/json; charset=UTF-8
779
+ - **Accept**: application/json
780
+
781
+
782
+
572
783
  # **get_custom_reports**
573
784
  > CustomReportsResponse get_custom_reports
574
785
 
@@ -907,6 +1118,59 @@ Name | Type | Description | Notes
907
1118
 
908
1119
 
909
1120
 
1121
+ # **insert_custom_dashboard_schedule**
1122
+ > CustomDashboardScheduleResponse insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1123
+
1124
+ Create a custom dashboard schedule
1125
+
1126
+ Create a new custom dashboard schedule on the UltraCart account.
1127
+
1128
+ ### Example
1129
+ ```ruby
1130
+ # load the gem
1131
+ require 'ultracart_api'
1132
+
1133
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1134
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1135
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1136
+
1137
+
1138
+ custom_dashboard_oid = 56 # Integer |
1139
+
1140
+ dashboard_schedule = UltracartClient::CustomDashboardSchedule.new # CustomDashboardSchedule | Dashboard schedule to create
1141
+
1142
+
1143
+ begin
1144
+ #Create a custom dashboard schedule
1145
+ result = api_instance.insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule)
1146
+ p result
1147
+ rescue UltracartClient::ApiError => e
1148
+ puts "Exception when calling DatawarehouseApi->insert_custom_dashboard_schedule: #{e}"
1149
+ end
1150
+ ```
1151
+
1152
+ ### Parameters
1153
+
1154
+ Name | Type | Description | Notes
1155
+ ------------- | ------------- | ------------- | -------------
1156
+ **custom_dashboard_oid** | **Integer**| |
1157
+ **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md)| Dashboard schedule to create |
1158
+
1159
+ ### Return type
1160
+
1161
+ [**CustomDashboardScheduleResponse**](CustomDashboardScheduleResponse.md)
1162
+
1163
+ ### Authorization
1164
+
1165
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1166
+
1167
+ ### HTTP request headers
1168
+
1169
+ - **Content-Type**: application/json; charset=UTF-8
1170
+ - **Accept**: application/json
1171
+
1172
+
1173
+
910
1174
  # **insert_custom_report**
911
1175
  > CustomReportResponse insert_custom_report(report)
912
1176
 
@@ -1060,6 +1324,62 @@ Name | Type | Description | Notes
1060
1324
 
1061
1325
 
1062
1326
 
1327
+ # **update_custom_dashboard_schedule**
1328
+ > CustomDashboardResponse update_custom_dashboard_schedule(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid)
1329
+
1330
+ Update a custom dashboard schedule
1331
+
1332
+ Update a custom dashboard schedule on the UltraCart account.
1333
+
1334
+ ### Example
1335
+ ```ruby
1336
+ # load the gem
1337
+ require 'ultracart_api'
1338
+
1339
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1340
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1341
+ api_instance = UltracartClient::DatawarehouseApi.new_using_api_key(simple_key, false, false)
1342
+
1343
+
1344
+ dashboard_schedule = UltracartClient::CustomDashboardSchedule.new # CustomDashboardSchedule | Dashboard schedule to update
1345
+
1346
+ custom_dashboard_schedule_oid = 56 # Integer | The dashboard schedule oid to update.
1347
+
1348
+ custom_dashboard_oid = 56 # Integer | The dashboard oid to update.
1349
+
1350
+
1351
+ begin
1352
+ #Update a custom dashboard schedule
1353
+ result = api_instance.update_custom_dashboard_schedule(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid)
1354
+ p result
1355
+ rescue UltracartClient::ApiError => e
1356
+ puts "Exception when calling DatawarehouseApi->update_custom_dashboard_schedule: #{e}"
1357
+ end
1358
+ ```
1359
+
1360
+ ### Parameters
1361
+
1362
+ Name | Type | Description | Notes
1363
+ ------------- | ------------- | ------------- | -------------
1364
+ **dashboard_schedule** | [**CustomDashboardSchedule**](CustomDashboardSchedule.md)| Dashboard schedule to update |
1365
+ **custom_dashboard_schedule_oid** | **Integer**| The dashboard schedule oid to update. |
1366
+ **custom_dashboard_oid** | **Integer**| The dashboard oid to update. |
1367
+
1368
+ ### Return type
1369
+
1370
+ [**CustomDashboardResponse**](CustomDashboardResponse.md)
1371
+
1372
+ ### Authorization
1373
+
1374
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1375
+
1376
+ ### HTTP request headers
1377
+
1378
+ - **Content-Type**: application/json; charset=UTF-8
1379
+ - **Accept**: application/json
1380
+
1381
+
1382
+
1063
1383
  # **update_custom_report**
1064
1384
  > CustomReportResponse update_custom_report(report, custom_report_oid)
1065
1385
 
@@ -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]
data/docs/ItemTag.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **tag_type** | **String** | tag_tpe | [optional]
6
+ **tag_type** | **String** | tag_type | [optional]
7
7
  **tag_value** | **String** | tag_value | [optional]
8
8
 
9
9