ultracart_api 4.1.223 → 4.1.225
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 +55 -2
- data/docs/SfvbAffiliateNetwork.md +60 -0
- data/docs/SfvbAffiliateNetworkRequest.md +50 -0
- data/docs/SfvbAffiliateNetworksResponse.md +20 -0
- data/docs/SfvbApi.md +1456 -120
- data/docs/SfvbApprovalCreateRequest.md +8 -2
- data/docs/SfvbApprovalParams.md +7 -3
- data/docs/SfvbContainerResponse.md +3 -1
- data/docs/SfvbSmartAttribution.md +38 -0
- data/docs/SfvbSmartAttributionPlatform.md +34 -0
- data/docs/SfvbSmartAttributionRequest.md +30 -0
- data/docs/SfvbTrackingAdvanced.md +34 -0
- data/docs/SfvbTrackingAdvancedRequest.md +34 -0
- data/docs/SfvbTrackingChange.md +24 -0
- data/docs/SfvbTrackingHtml.md +36 -0
- data/docs/SfvbTrackingHtmlRequest.md +20 -0
- data/docs/SfvbTrackingHtmlResponse.md +22 -0
- data/docs/SfvbTrackingPrivacy.md +28 -0
- data/docs/SfvbTrackingPrivacyRequest.md +28 -0
- data/docs/SfvbTrackingProvider.md +48 -0
- data/docs/SfvbTrackingProviderConsent.md +22 -0
- data/docs/SfvbTrackingProviderEvent.md +20 -0
- data/docs/SfvbTrackingProviderField.md +42 -0
- data/docs/SfvbTrackingProviderOauth.md +28 -0
- data/docs/SfvbTrackingProviderRequest.md +32 -0
- data/docs/SfvbTrackingProviderSecrets.md +46 -0
- data/docs/SfvbTrackingProvidersResponse.md +22 -0
- data/docs/SfvbTrackingSettingsResponse.md +28 -0
- data/docs/SfvbTrackingWholesaleTier.md +22 -0
- data/docs/SfvbUtmShortcode.md +56 -0
- data/docs/SfvbUtmShortcodeRequest.md +44 -0
- data/docs/SfvbUtmShortcodesResponse.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +4602 -2793
- data/lib/ultracart_api/models/sfvb_affiliate_network.rb +478 -0
- data/lib/ultracart_api/models/sfvb_affiliate_network_request.rb +428 -0
- data/lib/ultracart_api/models/sfvb_affiliate_networks_response.rb +232 -0
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +34 -7
- data/lib/ultracart_api/models/sfvb_approval_params.rb +24 -4
- data/lib/ultracart_api/models/sfvb_container_response.rb +16 -4
- data/lib/ultracart_api/models/sfvb_smart_attribution.rb +324 -0
- data/lib/ultracart_api/models/sfvb_smart_attribution_platform.rb +300 -0
- data/lib/ultracart_api/models/sfvb_smart_attribution_request.rb +282 -0
- data/lib/ultracart_api/models/sfvb_tracking_advanced.rb +300 -0
- data/lib/ultracart_api/models/sfvb_tracking_advanced_request.rb +302 -0
- data/lib/ultracart_api/models/sfvb_tracking_change.rb +250 -0
- data/lib/ultracart_api/models/sfvb_tracking_html.rb +344 -0
- data/lib/ultracart_api/models/sfvb_tracking_html_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_tracking_html_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_tracking_privacy.rb +352 -0
- data/lib/ultracart_api/models/sfvb_tracking_privacy_request.rb +352 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider.rb +378 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_consent.rb +240 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_event.rb +230 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_field.rb +342 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_oauth.rb +270 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_request.rb +292 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_secrets.rb +360 -0
- data/lib/ultracart_api/models/sfvb_tracking_providers_response.rb +242 -0
- data/lib/ultracart_api/models/sfvb_tracking_settings_response.rb +272 -0
- data/lib/ultracart_api/models/sfvb_tracking_wholesale_tier.rb +240 -0
- data/lib/ultracart_api/models/sfvb_utm_shortcode.rb +410 -0
- data/lib/ultracart_api/models/sfvb_utm_shortcode_request.rb +350 -0
- data/lib/ultracart_api/models/sfvb_utm_shortcodes_response.rb +252 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +27 -0
- metadata +55 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8a855da364173d6bb3a38d9f122414b3e84606989994a419f49292721d194b63
|
|
4
|
+
data.tar.gz: 5bc3b6d62e2ab814e065f7686e5fa21a14c70e9a2d43241792a8670388ffa70d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 90aaca9f7ad6a0a1c91b096c744c23a99fd1ec6690a493b6d2f74538d45f65dabfd110ee02e5479bf181f188ec8766b1ac98b4a71905f370c7666e0e78bab0f1
|
|
7
|
+
data.tar.gz: 16cd2103702fb4bef3b5fa09bad76b0739156f8a0a54a3a058cc0a07d6d5f16bef03f41f762a9a26159592dd69ae17423e7096d4989f867ab0597942aeedee1c
|
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.225
|
|
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.225'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -492,6 +492,7 @@ Class | Method | HTTP request | Description
|
|
|
492
492
|
*UltracartClient::SfvbApi* | [**create_sfvb_library_entry**](docs/SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library
|
|
493
493
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
|
|
494
494
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
495
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_affiliate_network**](docs/SfvbApi.md#delete_sfvb_affiliate_network) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Delete an affiliate network
|
|
495
496
|
*UltracartClient::SfvbApi* | [**delete_sfvb_approval**](docs/SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request
|
|
496
497
|
*UltracartClient::SfvbApi* | [**delete_sfvb_blog_post**](docs/SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post
|
|
497
498
|
*UltracartClient::SfvbApi* | [**delete_sfvb_comms_sending_domain**](docs/SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain
|
|
@@ -506,6 +507,9 @@ Class | Method | HTTP request | Description
|
|
|
506
507
|
*UltracartClient::SfvbApi* | [**delete_sfvb_redirects**](docs/SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call
|
|
507
508
|
*UltracartClient::SfvbApi* | [**delete_sfvb_secret_request**](docs/SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request
|
|
508
509
|
*UltracartClient::SfvbApi* | [**delete_sfvb_sequence_step**](docs/SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step
|
|
510
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_smart_attribution**](docs/SfvbApi.md#delete_sfvb_smart_attribution) | **DELETE** /sfvb/storefronts/{storefront_oid}/smart_attribution | Delete a storefront's Smart Attribution configuration
|
|
511
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_tracking_provider**](docs/SfvbApi.md#delete_sfvb_tracking_provider) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Clear one tracking provider
|
|
512
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_utm_shortcode**](docs/SfvbApi.md#delete_sfvb_utm_shortcode) | **DELETE** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Delete a UTM shortcode
|
|
509
513
|
*UltracartClient::SfvbApi* | [**detach_sfvb_blog_post_image**](docs/SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post
|
|
510
514
|
*UltracartClient::SfvbApi* | [**disable_sfvb_i18n_language**](docs/SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language
|
|
511
515
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_offer**](docs/SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer
|
|
@@ -520,10 +524,13 @@ Class | Method | HTTP request | Description
|
|
|
520
524
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_upsell_offer**](docs/SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer
|
|
521
525
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_upsell_path**](docs/SfvbApi.md#duplicate_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/duplicate | Duplicate an upsell path or one of its variations
|
|
522
526
|
*UltracartClient::SfvbApi* | [**enable_sfvb_i18n_language**](docs/SfvbApi.md#enable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable | Enable a language
|
|
527
|
+
*UltracartClient::SfvbApi* | [**enable_sfvb_smart_attribution**](docs/SfvbApi.md#enable_sfvb_smart_attribution) | **POST** /sfvb/storefronts/{storefront_oid}/smart_attribution/enable | Turn Smart Attribution on in report_only mode
|
|
523
528
|
*UltracartClient::SfvbApi* | [**enable_sfvb_upsell_offer**](docs/SfvbApi.md#enable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/enable | Enable an upsell offer
|
|
524
529
|
*UltracartClient::SfvbApi* | [**enable_sfvb_upsell_path**](docs/SfvbApi.md#enable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/enable | Enable an upsell path
|
|
525
530
|
*UltracartClient::SfvbApi* | [**end_sfvb_experiment**](docs/SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment
|
|
526
531
|
*UltracartClient::SfvbApi* | [**favorite_sfvb_library_entry**](docs/SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry
|
|
532
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_affiliate_network**](docs/SfvbApi.md#get_sfvb_affiliate_network) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Read one affiliate network
|
|
533
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_affiliate_networks**](docs/SfvbApi.md#get_sfvb_affiliate_networks) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | List a storefront's affiliate networks
|
|
527
534
|
*UltracartClient::SfvbApi* | [**get_sfvb_approval**](docs/SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request
|
|
528
535
|
*UltracartClient::SfvbApi* | [**get_sfvb_approvals**](docs/SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests
|
|
529
536
|
*UltracartClient::SfvbApi* | [**get_sfvb_blog_post**](docs/SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post
|
|
@@ -577,17 +584,26 @@ Class | Method | HTTP request | Description
|
|
|
577
584
|
*UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
|
|
578
585
|
*UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
|
|
579
586
|
*UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
|
|
587
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_smart_attribution**](docs/SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration
|
|
580
588
|
*UltracartClient::SfvbApi* | [**get_sfvb_test_orders**](docs/SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders
|
|
581
589
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
|
|
582
590
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme_attributes**](docs/SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings
|
|
583
591
|
*UltracartClient::SfvbApi* | [**get_sfvb_theme_job**](docs/SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job
|
|
592
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_html**](docs/SfvbApi.md#get_sfvb_tracking_html) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Read one custom tracking HTML slot
|
|
593
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_html_slots**](docs/SfvbApi.md#get_sfvb_tracking_html_slots) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html | List a storefront's custom tracking HTML slots
|
|
594
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_provider**](docs/SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider
|
|
595
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_providers**](docs/SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers
|
|
596
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_tracking_settings**](docs/SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings
|
|
584
597
|
*UltracartClient::SfvbApi* | [**get_sfvb_transactional_emails**](docs/SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends
|
|
585
598
|
*UltracartClient::SfvbApi* | [**get_sfvb_upsell_offer**](docs/SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer
|
|
586
599
|
*UltracartClient::SfvbApi* | [**get_sfvb_upsell_path**](docs/SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path
|
|
600
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcode**](docs/SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode
|
|
601
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_utm_shortcodes**](docs/SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes
|
|
587
602
|
*UltracartClient::SfvbApi* | [**get_sfvb_version**](docs/SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant
|
|
588
603
|
*UltracartClient::SfvbApi* | [**get_sfvb_whoami**](docs/SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is
|
|
589
604
|
*UltracartClient::SfvbApi* | [**ignore_sfvb_not_found_entry**](docs/SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path
|
|
590
605
|
*UltracartClient::SfvbApi* | [**import_sfvb_redirects**](docs/SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import
|
|
606
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_affiliate_network**](docs/SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network
|
|
591
607
|
*UltracartClient::SfvbApi* | [**insert_sfvb_approval**](docs/SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval
|
|
592
608
|
*UltracartClient::SfvbApi* | [**insert_sfvb_blog_post**](docs/SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post
|
|
593
609
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_segment**](docs/SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment
|
|
@@ -599,6 +615,7 @@ Class | Method | HTTP request | Description
|
|
|
599
615
|
*UltracartClient::SfvbApi* | [**insert_sfvb_sequence_step**](docs/SfvbApi.md#insert_sfvb_sequence_step) | **POST** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps | Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
600
616
|
*UltracartClient::SfvbApi* | [**insert_sfvb_upsell_offer**](docs/SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer
|
|
601
617
|
*UltracartClient::SfvbApi* | [**insert_sfvb_upsell_path**](docs/SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path
|
|
618
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_utm_shortcode**](docs/SfvbApi.md#insert_sfvb_utm_shortcode) | **POST** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | Create a UTM shortcode
|
|
602
619
|
*UltracartClient::SfvbApi* | [**install_sfvb_library_entry**](docs/SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront
|
|
603
620
|
*UltracartClient::SfvbApi* | [**list_sfvb_blog_posts**](docs/SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts
|
|
604
621
|
*UltracartClient::SfvbApi* | [**list_sfvb_campaigns**](docs/SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns
|
|
@@ -671,6 +688,7 @@ Class | Method | HTTP request | Description
|
|
|
671
688
|
*UltracartClient::SfvbApi* | [**unignore_sfvb_not_found_entry**](docs/SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path
|
|
672
689
|
*UltracartClient::SfvbApi* | [**unpublish_sfvb_library_entry**](docs/SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry
|
|
673
690
|
*UltracartClient::SfvbApi* | [**unshare_sfvb_library_entry**](docs/SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account
|
|
691
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_affiliate_network**](docs/SfvbApi.md#update_sfvb_affiliate_network) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Change an affiliate network
|
|
674
692
|
*UltracartClient::SfvbApi* | [**update_sfvb_blog_post**](docs/SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post
|
|
675
693
|
*UltracartClient::SfvbApi* | [**update_sfvb_campaign**](docs/SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign
|
|
676
694
|
*UltracartClient::SfvbApi* | [**update_sfvb_comms_segment**](docs/SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder
|
|
@@ -683,8 +701,14 @@ Class | Method | HTTP request | Description
|
|
|
683
701
|
*UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
|
|
684
702
|
*UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
|
|
685
703
|
*UltracartClient::SfvbApi* | [**update_sfvb_sequence_step**](docs/SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter
|
|
704
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_smart_attribution**](docs/SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration
|
|
705
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_advanced**](docs/SfvbApi.md#update_sfvb_tracking_advanced) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/advanced | Change a storefront's advanced conversion settings
|
|
706
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_html**](docs/SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot
|
|
707
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_privacy**](docs/SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules
|
|
708
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_tracking_provider**](docs/SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider
|
|
686
709
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_offer**](docs/SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer
|
|
687
710
|
*UltracartClient::SfvbApi* | [**update_sfvb_upsell_path**](docs/SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path
|
|
711
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_utm_shortcode**](docs/SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode
|
|
688
712
|
*UltracartClient::SfvbApi* | [**upload_sfvb_file**](docs/SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded
|
|
689
713
|
*UltracartClient::SfvbApi* | [**validate_sfvb_cjson**](docs/SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON
|
|
690
714
|
*UltracartClient::SfvbApi* | [**validate_sfvb_velocity**](docs/SfvbApi.md#validate_sfvb_velocity) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/velocity/validate | Validate a Velocity template against a theme
|
|
@@ -1915,6 +1939,9 @@ Class | Method | HTTP request | Description
|
|
|
1915
1939
|
- [UltracartClient::ScreenRecordingUserProperty](docs/ScreenRecordingUserProperty.md)
|
|
1916
1940
|
- [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
|
|
1917
1941
|
- [UltracartClient::SelfConfig](docs/SelfConfig.md)
|
|
1942
|
+
- [UltracartClient::SfvbAffiliateNetwork](docs/SfvbAffiliateNetwork.md)
|
|
1943
|
+
- [UltracartClient::SfvbAffiliateNetworkRequest](docs/SfvbAffiliateNetworkRequest.md)
|
|
1944
|
+
- [UltracartClient::SfvbAffiliateNetworksResponse](docs/SfvbAffiliateNetworksResponse.md)
|
|
1918
1945
|
- [UltracartClient::SfvbApproval](docs/SfvbApproval.md)
|
|
1919
1946
|
- [UltracartClient::SfvbApprovalCreateRequest](docs/SfvbApprovalCreateRequest.md)
|
|
1920
1947
|
- [UltracartClient::SfvbApprovalParams](docs/SfvbApprovalParams.md)
|
|
@@ -2143,6 +2170,9 @@ Class | Method | HTTP request | Description
|
|
|
2143
2170
|
- [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
|
|
2144
2171
|
- [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
|
|
2145
2172
|
- [UltracartClient::SfvbSiteAttributesResponse](docs/SfvbSiteAttributesResponse.md)
|
|
2173
|
+
- [UltracartClient::SfvbSmartAttribution](docs/SfvbSmartAttribution.md)
|
|
2174
|
+
- [UltracartClient::SfvbSmartAttributionPlatform](docs/SfvbSmartAttributionPlatform.md)
|
|
2175
|
+
- [UltracartClient::SfvbSmartAttributionRequest](docs/SfvbSmartAttributionRequest.md)
|
|
2146
2176
|
- [UltracartClient::SfvbStorefront](docs/SfvbStorefront.md)
|
|
2147
2177
|
- [UltracartClient::SfvbStorefrontsResponse](docs/SfvbStorefrontsResponse.md)
|
|
2148
2178
|
- [UltracartClient::SfvbTemplate](docs/SfvbTemplate.md)
|
|
@@ -2162,6 +2192,24 @@ Class | Method | HTTP request | Description
|
|
|
2162
2192
|
- [UltracartClient::SfvbThemeFontFamily](docs/SfvbThemeFontFamily.md)
|
|
2163
2193
|
- [UltracartClient::SfvbThemeJobResponse](docs/SfvbThemeJobResponse.md)
|
|
2164
2194
|
- [UltracartClient::SfvbThemesResponse](docs/SfvbThemesResponse.md)
|
|
2195
|
+
- [UltracartClient::SfvbTrackingAdvanced](docs/SfvbTrackingAdvanced.md)
|
|
2196
|
+
- [UltracartClient::SfvbTrackingAdvancedRequest](docs/SfvbTrackingAdvancedRequest.md)
|
|
2197
|
+
- [UltracartClient::SfvbTrackingChange](docs/SfvbTrackingChange.md)
|
|
2198
|
+
- [UltracartClient::SfvbTrackingHtml](docs/SfvbTrackingHtml.md)
|
|
2199
|
+
- [UltracartClient::SfvbTrackingHtmlRequest](docs/SfvbTrackingHtmlRequest.md)
|
|
2200
|
+
- [UltracartClient::SfvbTrackingHtmlResponse](docs/SfvbTrackingHtmlResponse.md)
|
|
2201
|
+
- [UltracartClient::SfvbTrackingPrivacy](docs/SfvbTrackingPrivacy.md)
|
|
2202
|
+
- [UltracartClient::SfvbTrackingPrivacyRequest](docs/SfvbTrackingPrivacyRequest.md)
|
|
2203
|
+
- [UltracartClient::SfvbTrackingProvider](docs/SfvbTrackingProvider.md)
|
|
2204
|
+
- [UltracartClient::SfvbTrackingProviderConsent](docs/SfvbTrackingProviderConsent.md)
|
|
2205
|
+
- [UltracartClient::SfvbTrackingProviderEvent](docs/SfvbTrackingProviderEvent.md)
|
|
2206
|
+
- [UltracartClient::SfvbTrackingProviderField](docs/SfvbTrackingProviderField.md)
|
|
2207
|
+
- [UltracartClient::SfvbTrackingProviderOauth](docs/SfvbTrackingProviderOauth.md)
|
|
2208
|
+
- [UltracartClient::SfvbTrackingProviderRequest](docs/SfvbTrackingProviderRequest.md)
|
|
2209
|
+
- [UltracartClient::SfvbTrackingProviderSecrets](docs/SfvbTrackingProviderSecrets.md)
|
|
2210
|
+
- [UltracartClient::SfvbTrackingProvidersResponse](docs/SfvbTrackingProvidersResponse.md)
|
|
2211
|
+
- [UltracartClient::SfvbTrackingSettingsResponse](docs/SfvbTrackingSettingsResponse.md)
|
|
2212
|
+
- [UltracartClient::SfvbTrackingWholesaleTier](docs/SfvbTrackingWholesaleTier.md)
|
|
2165
2213
|
- [UltracartClient::SfvbTransactionalEmail](docs/SfvbTransactionalEmail.md)
|
|
2166
2214
|
- [UltracartClient::SfvbTransactionalEmailsResponse](docs/SfvbTransactionalEmailsResponse.md)
|
|
2167
2215
|
- [UltracartClient::SfvbUpsellItemLogic](docs/SfvbUpsellItemLogic.md)
|
|
@@ -2177,6 +2225,9 @@ Class | Method | HTTP request | Description
|
|
|
2177
2225
|
- [UltracartClient::SfvbUpsellStepOffer](docs/SfvbUpsellStepOffer.md)
|
|
2178
2226
|
- [UltracartClient::SfvbUpsellTowerData](docs/SfvbUpsellTowerData.md)
|
|
2179
2227
|
- [UltracartClient::SfvbUpsellVariation](docs/SfvbUpsellVariation.md)
|
|
2228
|
+
- [UltracartClient::SfvbUtmShortcode](docs/SfvbUtmShortcode.md)
|
|
2229
|
+
- [UltracartClient::SfvbUtmShortcodeRequest](docs/SfvbUtmShortcodeRequest.md)
|
|
2230
|
+
- [UltracartClient::SfvbUtmShortcodesResponse](docs/SfvbUtmShortcodesResponse.md)
|
|
2180
2231
|
- [UltracartClient::SfvbValidateRequest](docs/SfvbValidateRequest.md)
|
|
2181
2232
|
- [UltracartClient::SfvbValidationResponse](docs/SfvbValidationResponse.md)
|
|
2182
2233
|
- [UltracartClient::SfvbVelocityValidateRequest](docs/SfvbVelocityValidateRequest.md)
|
|
@@ -2352,6 +2403,8 @@ Not every change is committed to every SDK.
|
|
|
2352
2403
|
|
|
2353
2404
|
| Version | Date | Comments |
|
|
2354
2405
|
| --: | :-: | --- |
|
|
2406
|
+
| 4.1.225 | 11/03/2026 | sfvb internal testing |
|
|
2407
|
+
| 4.1.224 | 11/03/2026 | sfvb internal testing |
|
|
2355
2408
|
| 4.1.223 | 11/03/2026 | sfvb internal testing |
|
|
2356
2409
|
| 4.1.222 | 11/03/2026 | sfvb internal testing |
|
|
2357
2410
|
| 4.1.221 | 11/02/2026 | sfvb internal testing |
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# UltracartClient::SfvbAffiliateNetwork
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **affiliate_network_oid** | **Integer** | The network's oid. Smart Attribution names it as a platform's integration_id. | [optional] |
|
|
8
|
+
| **approval_needed** | **Boolean** | On a dry run, whether the real write needs an approved affiliate_network.change request. | [optional] |
|
|
9
|
+
| **assign_to_affiliate_oid** | **Integer** | The account's own affiliate that orders from this network are assigned to. Null when none. | [optional] |
|
|
10
|
+
| **changes** | [**Array<SfvbTrackingChange>**](SfvbTrackingChange.md) | On a write, what changed, or what would change on a dry run. conversion_pixel shows its size and hash, not its content. | [optional] |
|
|
11
|
+
| **commission** | **Float** | A fixed commission amount, in the account's currency. Null when not set. | [optional] |
|
|
12
|
+
| **conversion_pixel** | **String** | HTML for custom, or the postback URL for server_to_server, with the admin's order tokens. Only on a read of one network and on a write. Empty when not set. | [optional] |
|
|
13
|
+
| **conversion_pixel_sha256** | **String** | The SHA-256 of conversion_pixel as UTF-8. | [optional] |
|
|
14
|
+
| **conversion_pixel_size_bytes** | **Integer** | The size of conversion_pixel in UTF-8 bytes. | [optional] |
|
|
15
|
+
| **conversion_type** | **String** | custom prints conversion_pixel into the receipt page. commission_junction fires the account's Commission Junction setup instead and does not use conversion_pixel. server_to_server has UltraCart's server request conversion_pixel as an https URL after the order. A value stored by the admin that is none of these is shown as stored. | [optional] |
|
|
16
|
+
| **cookie_lifetime_days** | **Integer** | How long the visit is remembered, in days, 1 to 3650. | [optional] |
|
|
17
|
+
| **dry_run** | **Boolean** | On a write, true when nothing was saved. | [optional] |
|
|
18
|
+
| **fire_percentage** | **Float** | The share of this network's orders whose pixel fires, from 0 to 100. | [optional] |
|
|
19
|
+
| **hash_sha256** | **String** | The hash of the network as stored. Send it as If-Match on an update or delete. | [optional] |
|
|
20
|
+
| **if_not_fired** | **String** | What UltraCart's own affiliate system does with an order whose pixel did not fire. process handles it as usual, skip leaves it out, assign credits if_not_fired_affiliate_oid. | [optional] |
|
|
21
|
+
| **if_not_fired_affiliate_oid** | **Integer** | For if_not_fired assign, the account's own affiliate to credit. | [optional] |
|
|
22
|
+
| **network_name** | **String** | The network's name, up to 50 characters. | [optional] |
|
|
23
|
+
| **parameter_name** | **String** | The URL parameter that marks a visit from this network, up to 50 characters. Compared without case. | [optional] |
|
|
24
|
+
| **parameter_value** | **String** | The parameter's value for this network, up to 100 characters. Compared without case. | [optional] |
|
|
25
|
+
| **record_fire_in_custom_field** | **Integer** | The order custom field, 1 to 10, that records whether the pixel fired. | [optional] |
|
|
26
|
+
| **record_name_in_custom_field** | **Integer** | The order custom field, 1 to 10, that records the network's name. | [optional] |
|
|
27
|
+
| **remove_empty_pixel_parameters** | **Boolean** | For server_to_server only, true to drop query parameters that are empty after the tokens are filled in. | [optional] |
|
|
28
|
+
| **stomp_previous_cookie** | **Boolean** | True to replace another network's cookie. False keeps the first network's. | [optional] |
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'ultracart_api'
|
|
34
|
+
|
|
35
|
+
instance = UltracartClient::SfvbAffiliateNetwork.new(
|
|
36
|
+
affiliate_network_oid: null,
|
|
37
|
+
approval_needed: null,
|
|
38
|
+
assign_to_affiliate_oid: null,
|
|
39
|
+
changes: null,
|
|
40
|
+
commission: null,
|
|
41
|
+
conversion_pixel: null,
|
|
42
|
+
conversion_pixel_sha256: null,
|
|
43
|
+
conversion_pixel_size_bytes: null,
|
|
44
|
+
conversion_type: null,
|
|
45
|
+
cookie_lifetime_days: null,
|
|
46
|
+
dry_run: null,
|
|
47
|
+
fire_percentage: null,
|
|
48
|
+
hash_sha256: null,
|
|
49
|
+
if_not_fired: null,
|
|
50
|
+
if_not_fired_affiliate_oid: null,
|
|
51
|
+
network_name: null,
|
|
52
|
+
parameter_name: null,
|
|
53
|
+
parameter_value: null,
|
|
54
|
+
record_fire_in_custom_field: null,
|
|
55
|
+
record_name_in_custom_field: null,
|
|
56
|
+
remove_empty_pixel_parameters: null,
|
|
57
|
+
stomp_previous_cookie: null
|
|
58
|
+
)
|
|
59
|
+
```
|
|
60
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# UltracartClient::SfvbAffiliateNetworkRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **assign_to_affiliate_oid** | **Integer** | One of the account's own affiliates. Name it in unset to clear it. | [optional] |
|
|
8
|
+
| **commission** | **Float** | A fixed commission amount, 0 or more, with at most 6 decimals. Name it in unset to clear it. | [optional] |
|
|
9
|
+
| **conversion_pixel** | **String** | HTML for custom, at most 10,000 characters, or one https URL for server_to_server. An empty string empties it. A pixel that a custom or server_to_server network will use needs an approved affiliate_network.change request for exactly this change. | [optional] |
|
|
10
|
+
| **conversion_type** | **String** | custom, commission_junction or server_to_server. | [optional] |
|
|
11
|
+
| **cookie_lifetime_days** | **Integer** | 1 to 3650. | [optional] |
|
|
12
|
+
| **dry_run** | **Boolean** | True to check the change and say whether it needs an approval, without saving. | [optional] |
|
|
13
|
+
| **fire_percentage** | **Float** | 0 to 100, with at most 2 decimals. | [optional] |
|
|
14
|
+
| **if_not_fired** | **String** | process, skip or assign. assign needs if_not_fired_affiliate_oid. | [optional] |
|
|
15
|
+
| **if_not_fired_affiliate_oid** | **Integer** | For if_not_fired assign, one of the account's own affiliates. | [optional] |
|
|
16
|
+
| **network_name** | **String** | Up to 50 characters. Required on a create. | [optional] |
|
|
17
|
+
| **parameter_name** | **String** | Up to 50 characters. Required on a create. | [optional] |
|
|
18
|
+
| **parameter_value** | **String** | Up to 100 characters. Required on a create. | [optional] |
|
|
19
|
+
| **record_fire_in_custom_field** | **Integer** | 1 to 10. | [optional] |
|
|
20
|
+
| **record_name_in_custom_field** | **Integer** | 1 to 10. | [optional] |
|
|
21
|
+
| **remove_empty_pixel_parameters** | **Boolean** | server_to_server only. | [optional] |
|
|
22
|
+
| **stomp_previous_cookie** | **Boolean** | True to replace another network's cookie. | [optional] |
|
|
23
|
+
| **unset** | **Array<String>** | Fields to clear. commission and assign_to_affiliate_oid only. | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'ultracart_api'
|
|
29
|
+
|
|
30
|
+
instance = UltracartClient::SfvbAffiliateNetworkRequest.new(
|
|
31
|
+
assign_to_affiliate_oid: null,
|
|
32
|
+
commission: null,
|
|
33
|
+
conversion_pixel: null,
|
|
34
|
+
conversion_type: null,
|
|
35
|
+
cookie_lifetime_days: null,
|
|
36
|
+
dry_run: null,
|
|
37
|
+
fire_percentage: null,
|
|
38
|
+
if_not_fired: null,
|
|
39
|
+
if_not_fired_affiliate_oid: null,
|
|
40
|
+
network_name: null,
|
|
41
|
+
parameter_name: null,
|
|
42
|
+
parameter_value: null,
|
|
43
|
+
record_fire_in_custom_field: null,
|
|
44
|
+
record_name_in_custom_field: null,
|
|
45
|
+
remove_empty_pixel_parameters: null,
|
|
46
|
+
stomp_previous_cookie: null,
|
|
47
|
+
unset: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbAffiliateNetworksResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **affiliate_networks** | [**Array<SfvbAffiliateNetwork>**](SfvbAffiliateNetwork.md) | Every network, by name. conversion_pixel is left out; read one network for it. | [optional] |
|
|
8
|
+
| **storefront_oid** | **Integer** | The storefront. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbAffiliateNetworksResponse.new(
|
|
16
|
+
affiliate_networks: null,
|
|
17
|
+
storefront_oid: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|