ultracart_api 4.1.222 → 4.1.224

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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +55 -2
  3. data/docs/OauthTokenResponse.md +2 -0
  4. data/docs/SfvbAffiliateNetwork.md +60 -0
  5. data/docs/SfvbAffiliateNetworkRequest.md +50 -0
  6. data/docs/SfvbAffiliateNetworksResponse.md +20 -0
  7. data/docs/SfvbApi.md +1456 -120
  8. data/docs/SfvbApprovalCreateRequest.md +8 -2
  9. data/docs/SfvbApprovalParams.md +7 -3
  10. data/docs/SfvbContainerResponse.md +3 -1
  11. data/docs/SfvbSmartAttribution.md +38 -0
  12. data/docs/SfvbSmartAttributionPlatform.md +34 -0
  13. data/docs/SfvbSmartAttributionRequest.md +30 -0
  14. data/docs/SfvbTrackingAdvanced.md +34 -0
  15. data/docs/SfvbTrackingAdvancedRequest.md +34 -0
  16. data/docs/SfvbTrackingChange.md +24 -0
  17. data/docs/SfvbTrackingHtml.md +36 -0
  18. data/docs/SfvbTrackingHtmlRequest.md +20 -0
  19. data/docs/SfvbTrackingHtmlResponse.md +22 -0
  20. data/docs/SfvbTrackingPrivacy.md +28 -0
  21. data/docs/SfvbTrackingPrivacyRequest.md +28 -0
  22. data/docs/SfvbTrackingProvider.md +48 -0
  23. data/docs/SfvbTrackingProviderConsent.md +22 -0
  24. data/docs/SfvbTrackingProviderEvent.md +20 -0
  25. data/docs/SfvbTrackingProviderField.md +42 -0
  26. data/docs/SfvbTrackingProviderOauth.md +28 -0
  27. data/docs/SfvbTrackingProviderRequest.md +32 -0
  28. data/docs/SfvbTrackingProviderSecrets.md +46 -0
  29. data/docs/SfvbTrackingProvidersResponse.md +22 -0
  30. data/docs/SfvbTrackingSettingsResponse.md +28 -0
  31. data/docs/SfvbTrackingWholesaleTier.md +22 -0
  32. data/docs/SfvbUtmShortcode.md +56 -0
  33. data/docs/SfvbUtmShortcodeRequest.md +44 -0
  34. data/docs/SfvbUtmShortcodesResponse.md +24 -0
  35. data/lib/ultracart_api/api/sfvb_api.rb +4602 -2793
  36. data/lib/ultracart_api/models/oauth_token_response.rb +11 -1
  37. data/lib/ultracart_api/models/sfvb_affiliate_network.rb +478 -0
  38. data/lib/ultracart_api/models/sfvb_affiliate_network_request.rb +428 -0
  39. data/lib/ultracart_api/models/sfvb_affiliate_networks_response.rb +232 -0
  40. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +34 -7
  41. data/lib/ultracart_api/models/sfvb_approval_params.rb +24 -4
  42. data/lib/ultracart_api/models/sfvb_container_response.rb +16 -4
  43. data/lib/ultracart_api/models/sfvb_smart_attribution.rb +324 -0
  44. data/lib/ultracart_api/models/sfvb_smart_attribution_platform.rb +300 -0
  45. data/lib/ultracart_api/models/sfvb_smart_attribution_request.rb +282 -0
  46. data/lib/ultracart_api/models/sfvb_tracking_advanced.rb +300 -0
  47. data/lib/ultracart_api/models/sfvb_tracking_advanced_request.rb +302 -0
  48. data/lib/ultracart_api/models/sfvb_tracking_change.rb +250 -0
  49. data/lib/ultracart_api/models/sfvb_tracking_html.rb +344 -0
  50. data/lib/ultracart_api/models/sfvb_tracking_html_request.rb +230 -0
  51. data/lib/ultracart_api/models/sfvb_tracking_html_response.rb +242 -0
  52. data/lib/ultracart_api/models/sfvb_tracking_privacy.rb +352 -0
  53. data/lib/ultracart_api/models/sfvb_tracking_privacy_request.rb +352 -0
  54. data/lib/ultracart_api/models/sfvb_tracking_provider.rb +378 -0
  55. data/lib/ultracart_api/models/sfvb_tracking_provider_consent.rb +240 -0
  56. data/lib/ultracart_api/models/sfvb_tracking_provider_event.rb +230 -0
  57. data/lib/ultracart_api/models/sfvb_tracking_provider_field.rb +342 -0
  58. data/lib/ultracart_api/models/sfvb_tracking_provider_oauth.rb +270 -0
  59. data/lib/ultracart_api/models/sfvb_tracking_provider_request.rb +292 -0
  60. data/lib/ultracart_api/models/sfvb_tracking_provider_secrets.rb +360 -0
  61. data/lib/ultracart_api/models/sfvb_tracking_providers_response.rb +242 -0
  62. data/lib/ultracart_api/models/sfvb_tracking_settings_response.rb +272 -0
  63. data/lib/ultracart_api/models/sfvb_tracking_wholesale_tier.rb +240 -0
  64. data/lib/ultracart_api/models/sfvb_utm_shortcode.rb +410 -0
  65. data/lib/ultracart_api/models/sfvb_utm_shortcode_request.rb +350 -0
  66. data/lib/ultracart_api/models/sfvb_utm_shortcodes_response.rb +252 -0
  67. data/lib/ultracart_api/version.rb +1 -1
  68. data/lib/ultracart_api.rb +27 -0
  69. metadata +55 -1
data/docs/SfvbApi.md CHANGED
@@ -20,6 +20,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
20
20
  | [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
21
21
  | [**create_sfvb_preview_access**](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 |
22
22
  | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
23
+ | [**delete_sfvb_affiliate_network**](SfvbApi.md#delete_sfvb_affiliate_network) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Delete an affiliate network |
23
24
  | [**delete_sfvb_approval**](SfvbApi.md#delete_sfvb_approval) | **DELETE** /sfvb/approvals/{approval_id} | Cancel a pending approval request |
24
25
  | [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
25
26
  | [**delete_sfvb_comms_sending_domain**](SfvbApi.md#delete_sfvb_comms_sending_domain) | **DELETE** /sfvb/comms/sending_domains/{domain} | Remove a sending domain |
@@ -34,6 +35,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
34
35
  | [**delete_sfvb_redirects**](SfvbApi.md#delete_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete | Delete up to 5,000 redirect rules in one call |
35
36
  | [**delete_sfvb_secret_request**](SfvbApi.md#delete_sfvb_secret_request) | **DELETE** /sfvb/secrets/{request_id} | Cancel a pending secret request |
36
37
  | [**delete_sfvb_sequence_step**](SfvbApi.md#delete_sfvb_sequence_step) | **DELETE** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Remove one step |
38
+ | [**delete_sfvb_smart_attribution**](SfvbApi.md#delete_sfvb_smart_attribution) | **DELETE** /sfvb/storefronts/{storefront_oid}/smart_attribution | Delete a storefront's Smart Attribution configuration |
39
+ | [**delete_sfvb_tracking_provider**](SfvbApi.md#delete_sfvb_tracking_provider) | **DELETE** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Clear one tracking provider |
40
+ | [**delete_sfvb_utm_shortcode**](SfvbApi.md#delete_sfvb_utm_shortcode) | **DELETE** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Delete a UTM shortcode |
37
41
  | [**detach_sfvb_blog_post_image**](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 |
38
42
  | [**disable_sfvb_i18n_language**](SfvbApi.md#disable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/disable | Disable a language |
39
43
  | [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
@@ -48,10 +52,13 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
48
52
  | [**duplicate_sfvb_upsell_offer**](SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer |
49
53
  | [**duplicate_sfvb_upsell_path**](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 |
50
54
  | [**enable_sfvb_i18n_language**](SfvbApi.md#enable_sfvb_i18n_language) | **POST** /sfvb/storefronts/{storefront_oid}/i18n/languages/{code}/enable | Enable a language |
55
+ | [**enable_sfvb_smart_attribution**](SfvbApi.md#enable_sfvb_smart_attribution) | **POST** /sfvb/storefronts/{storefront_oid}/smart_attribution/enable | Turn Smart Attribution on in report_only mode |
51
56
  | [**enable_sfvb_upsell_offer**](SfvbApi.md#enable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/enable | Enable an upsell offer |
52
57
  | [**enable_sfvb_upsell_path**](SfvbApi.md#enable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/enable | Enable an upsell path |
53
58
  | [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
54
59
  | [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
60
+ | [**get_sfvb_affiliate_network**](SfvbApi.md#get_sfvb_affiliate_network) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Read one affiliate network |
61
+ | [**get_sfvb_affiliate_networks**](SfvbApi.md#get_sfvb_affiliate_networks) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | List a storefront's affiliate networks |
55
62
  | [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
56
63
  | [**get_sfvb_approvals**](SfvbApi.md#get_sfvb_approvals) | **GET** /sfvb/approvals | List this sign-in's approval requests |
57
64
  | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
@@ -105,17 +112,26 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
105
112
  | [**get_sfvb_sequence**](SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree |
106
113
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
107
114
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
115
+ | [**get_sfvb_smart_attribution**](SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration |
108
116
  | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
109
117
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
110
118
  | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
111
119
  | [**get_sfvb_theme_job**](SfvbApi.md#get_sfvb_theme_job) | **GET** /sfvb/storefronts/{storefront_oid}/theme_jobs/{job_id} | Status of an asynchronous theme job |
120
+ | [**get_sfvb_tracking_html**](SfvbApi.md#get_sfvb_tracking_html) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Read one custom tracking HTML slot |
121
+ | [**get_sfvb_tracking_html_slots**](SfvbApi.md#get_sfvb_tracking_html_slots) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/html | List a storefront's custom tracking HTML slots |
122
+ | [**get_sfvb_tracking_provider**](SfvbApi.md#get_sfvb_tracking_provider) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Read one tracking provider |
123
+ | [**get_sfvb_tracking_providers**](SfvbApi.md#get_sfvb_tracking_providers) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/providers | List a storefront's tracking providers |
124
+ | [**get_sfvb_tracking_settings**](SfvbApi.md#get_sfvb_tracking_settings) | **GET** /sfvb/storefronts/{storefront_oid}/tracking | Read a storefront's privacy rules and advanced conversion settings |
112
125
  | [**get_sfvb_transactional_emails**](SfvbApi.md#get_sfvb_transactional_emails) | **GET** /sfvb/storefronts/{storefront_oid}/transactional_emails | List the transactional emails a storefront sends |
113
126
  | [**get_sfvb_upsell_offer**](SfvbApi.md#get_sfvb_upsell_offer) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Get an upsell offer |
114
127
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
128
+ | [**get_sfvb_utm_shortcode**](SfvbApi.md#get_sfvb_utm_shortcode) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Read one UTM shortcode |
129
+ | [**get_sfvb_utm_shortcodes**](SfvbApi.md#get_sfvb_utm_shortcodes) | **GET** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | List a storefront's UTM shortcodes |
115
130
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
116
131
  | [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
117
132
  | [**ignore_sfvb_not_found_entry**](SfvbApi.md#ignore_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Ignore a 404 path |
118
133
  | [**import_sfvb_redirects**](SfvbApi.md#import_sfvb_redirects) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import | Apply a reviewed redirect import |
134
+ | [**insert_sfvb_affiliate_network**](SfvbApi.md#insert_sfvb_affiliate_network) | **POST** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | Add an affiliate network |
119
135
  | [**insert_sfvb_approval**](SfvbApi.md#insert_sfvb_approval) | **POST** /sfvb/approvals | Request a human approval |
120
136
  | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
121
137
  | [**insert_sfvb_comms_segment**](SfvbApi.md#insert_sfvb_comms_segment) | **POST** /sfvb/storefronts/{storefront_oid}/segments | Create a segment |
@@ -127,6 +143,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
127
143
  | [**insert_sfvb_sequence_step**](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 |
128
144
  | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
129
145
  | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
146
+ | [**insert_sfvb_utm_shortcode**](SfvbApi.md#insert_sfvb_utm_shortcode) | **POST** /sfvb/storefronts/{storefront_oid}/utm_shortcodes | Create a UTM shortcode |
130
147
  | [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
131
148
  | [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
132
149
  | [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
@@ -199,6 +216,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
199
216
  | [**unignore_sfvb_not_found_entry**](SfvbApi.md#unignore_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore | Stop ignoring a 404 path |
200
217
  | [**unpublish_sfvb_library_entry**](SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry |
201
218
  | [**unshare_sfvb_library_entry**](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 |
219
+ | [**update_sfvb_affiliate_network**](SfvbApi.md#update_sfvb_affiliate_network) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid} | Change an affiliate network |
202
220
  | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
203
221
  | [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
204
222
  | [**update_sfvb_comms_segment**](SfvbApi.md#update_sfvb_comms_segment) | **PUT** /sfvb/storefronts/{storefront_oid}/segments/{segment_uuid} | Change a segment's name, rule or folder |
@@ -211,8 +229,14 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
211
229
  | [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
212
230
  | [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
213
231
  | [**update_sfvb_sequence_step**](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 |
232
+ | [**update_sfvb_smart_attribution**](SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration |
233
+ | [**update_sfvb_tracking_advanced**](SfvbApi.md#update_sfvb_tracking_advanced) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/advanced | Change a storefront's advanced conversion settings |
234
+ | [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
235
+ | [**update_sfvb_tracking_privacy**](SfvbApi.md#update_sfvb_tracking_privacy) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/privacy | Change a storefront's privacy rules |
236
+ | [**update_sfvb_tracking_provider**](SfvbApi.md#update_sfvb_tracking_provider) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/providers/{provider} | Change one tracking provider |
214
237
  | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
215
238
  | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
239
+ | [**update_sfvb_utm_shortcode**](SfvbApi.md#update_sfvb_utm_shortcode) | **PUT** /sfvb/storefronts/{storefront_oid}/utm_shortcodes/{shortcode_oid} | Change a UTM shortcode |
216
240
  | [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
217
241
  | [**validate_sfvb_cjson**](SfvbApi.md#validate_sfvb_cjson) | **POST** /sfvb/cjson/validate | Validate CJSON |
218
242
  | [**validate_sfvb_velocity**](SfvbApi.md#validate_sfvb_velocity) | **POST** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/velocity/validate | Validate a Velocity template against a theme |
@@ -1088,6 +1112,62 @@ end
1088
1112
  - **Accept**: application/json
1089
1113
 
1090
1114
 
1115
+ ## delete_sfvb_affiliate_network
1116
+
1117
+ > delete_sfvb_affiliate_network(storefront_oid, affiliate_network_oid, if_match, approval_id)
1118
+
1119
+ Delete an affiliate network
1120
+
1121
+ Visits from the network stop being recognized and its pixel stops firing. Refused with 409 while Smart Attribution names the network as a platform. Send the network's hash_sha256 as If-Match. Needs sfvb_publish and an approved affiliate_network.delete request (Approval-Id).
1122
+
1123
+
1124
+ ### Examples
1125
+
1126
+
1127
+ (No example for this operation).
1128
+
1129
+
1130
+ #### Using the delete_sfvb_affiliate_network_with_http_info variant
1131
+
1132
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1133
+
1134
+ > <Array(nil, Integer, Hash)> delete_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, approval_id)
1135
+
1136
+ ```ruby
1137
+ begin
1138
+ # Delete an affiliate network
1139
+ data, status_code, headers = api_instance.delete_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, approval_id)
1140
+ p status_code # => 2xx
1141
+ p headers # => { ... }
1142
+ p data # => nil
1143
+ rescue UltracartClient::ApiError => e
1144
+ puts "Error when calling SfvbApi->delete_sfvb_affiliate_network_with_http_info: #{e}"
1145
+ end
1146
+ ```
1147
+
1148
+ ### Parameters
1149
+
1150
+ | Name | Type | Description | Notes |
1151
+ | ---- | ---- | ----------- | ----- |
1152
+ | **storefront_oid** | **Integer** | | |
1153
+ | **affiliate_network_oid** | **Integer** | | |
1154
+ | **if_match** | **String** | The network&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
1155
+ | **approval_id** | **String** | The approval_id of an approved affiliate_network.delete request for this network. See POST /sfvb/approvals. | |
1156
+
1157
+ ### Return type
1158
+
1159
+ nil (empty response body)
1160
+
1161
+ ### Authorization
1162
+
1163
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1164
+
1165
+ ### HTTP request headers
1166
+
1167
+ - **Content-Type**: Not defined
1168
+ - **Accept**: application/json
1169
+
1170
+
1091
1171
  ## delete_sfvb_approval
1092
1172
 
1093
1173
  > delete_sfvb_approval(approval_id)
@@ -1857,6 +1937,171 @@ end
1857
1937
  - **Accept**: application/json
1858
1938
 
1859
1939
 
1940
+ ## delete_sfvb_smart_attribution
1941
+
1942
+ > delete_sfvb_smart_attribution(storefront_oid, if_match, opts)
1943
+
1944
+ Delete a storefront's Smart Attribution configuration
1945
+
1946
+ Every platform goes back to being sent conversions as it was before Smart Attribution, and the settings are gone. Send the hash_sha256 you read as If-Match. Needs sfvb_publish and an approved smart_attribution.delete request (Approval-Id). An unconfigured storefront is 404.
1947
+
1948
+
1949
+ ### Examples
1950
+
1951
+
1952
+ (No example for this operation).
1953
+
1954
+
1955
+ #### Using the delete_sfvb_smart_attribution_with_http_info variant
1956
+
1957
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1958
+
1959
+ > <Array(nil, Integer, Hash)> delete_sfvb_smart_attribution_with_http_info(storefront_oid, if_match, opts)
1960
+
1961
+ ```ruby
1962
+ begin
1963
+ # Delete a storefront's Smart Attribution configuration
1964
+ data, status_code, headers = api_instance.delete_sfvb_smart_attribution_with_http_info(storefront_oid, if_match, opts)
1965
+ p status_code # => 2xx
1966
+ p headers # => { ... }
1967
+ p data # => nil
1968
+ rescue UltracartClient::ApiError => e
1969
+ puts "Error when calling SfvbApi->delete_sfvb_smart_attribution_with_http_info: #{e}"
1970
+ end
1971
+ ```
1972
+
1973
+ ### Parameters
1974
+
1975
+ | Name | Type | Description | Notes |
1976
+ | ---- | ---- | ----------- | ----- |
1977
+ | **storefront_oid** | **Integer** | | |
1978
+ | **if_match** | **String** | hash_sha256 from the Smart Attribution read. 428 when absent, 412 when stale. | |
1979
+ | **approval_id** | **String** | The approval_id of an approved smart_attribution.delete request. Required. See POST /sfvb/approvals. | [optional] |
1980
+
1981
+ ### Return type
1982
+
1983
+ nil (empty response body)
1984
+
1985
+ ### Authorization
1986
+
1987
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1988
+
1989
+ ### HTTP request headers
1990
+
1991
+ - **Content-Type**: Not defined
1992
+ - **Accept**: application/json
1993
+
1994
+
1995
+ ## delete_sfvb_tracking_provider
1996
+
1997
+ > <SfvbTrackingProvider> delete_sfvb_tracking_provider(storefront_oid, provider, if_match)
1998
+
1999
+ Clear one tracking provider
2000
+
2001
+ Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider's hash_sha256 as If-Match. Needs sfvb_publish. No approval.
2002
+
2003
+
2004
+ ### Examples
2005
+
2006
+
2007
+ (No example for this operation).
2008
+
2009
+
2010
+ #### Using the delete_sfvb_tracking_provider_with_http_info variant
2011
+
2012
+ This returns an Array which contains the response data, status code and headers.
2013
+
2014
+ > <Array(<SfvbTrackingProvider>, Integer, Hash)> delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
2015
+
2016
+ ```ruby
2017
+ begin
2018
+ # Clear one tracking provider
2019
+ data, status_code, headers = api_instance.delete_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match)
2020
+ p status_code # => 2xx
2021
+ p headers # => { ... }
2022
+ p data # => <SfvbTrackingProvider>
2023
+ rescue UltracartClient::ApiError => e
2024
+ puts "Error when calling SfvbApi->delete_sfvb_tracking_provider_with_http_info: #{e}"
2025
+ end
2026
+ ```
2027
+
2028
+ ### Parameters
2029
+
2030
+ | Name | Type | Description | Notes |
2031
+ | ---- | ---- | ----------- | ----- |
2032
+ | **storefront_oid** | **Integer** | | |
2033
+ | **provider** | **String** | | |
2034
+ | **if_match** | **String** | The provider&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
2035
+
2036
+ ### Return type
2037
+
2038
+ [**SfvbTrackingProvider**](SfvbTrackingProvider.md)
2039
+
2040
+ ### Authorization
2041
+
2042
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2043
+
2044
+ ### HTTP request headers
2045
+
2046
+ - **Content-Type**: Not defined
2047
+ - **Accept**: application/json
2048
+
2049
+
2050
+ ## delete_sfvb_utm_shortcode
2051
+
2052
+ > delete_sfvb_utm_shortcode(storefront_oid, shortcode_oid, if_match)
2053
+
2054
+ Delete a UTM shortcode
2055
+
2056
+ The shortcode stops attributing at once. A link that uses it as a path segment still opens its page, without the UTM values. Send the hash_sha256 you read as If-Match. Needs sfvb_publish.
2057
+
2058
+
2059
+ ### Examples
2060
+
2061
+
2062
+ (No example for this operation).
2063
+
2064
+
2065
+ #### Using the delete_sfvb_utm_shortcode_with_http_info variant
2066
+
2067
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2068
+
2069
+ > <Array(nil, Integer, Hash)> delete_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid, if_match)
2070
+
2071
+ ```ruby
2072
+ begin
2073
+ # Delete a UTM shortcode
2074
+ data, status_code, headers = api_instance.delete_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid, if_match)
2075
+ p status_code # => 2xx
2076
+ p headers # => { ... }
2077
+ p data # => nil
2078
+ rescue UltracartClient::ApiError => e
2079
+ puts "Error when calling SfvbApi->delete_sfvb_utm_shortcode_with_http_info: #{e}"
2080
+ end
2081
+ ```
2082
+
2083
+ ### Parameters
2084
+
2085
+ | Name | Type | Description | Notes |
2086
+ | ---- | ---- | ----------- | ----- |
2087
+ | **storefront_oid** | **Integer** | | |
2088
+ | **shortcode_oid** | **Integer** | | |
2089
+ | **if_match** | **String** | The shortcode&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
2090
+
2091
+ ### Return type
2092
+
2093
+ nil (empty response body)
2094
+
2095
+ ### Authorization
2096
+
2097
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2098
+
2099
+ ### HTTP request headers
2100
+
2101
+ - **Content-Type**: Not defined
2102
+ - **Accept**: application/json
2103
+
2104
+
1860
2105
  ## detach_sfvb_blog_post_image
1861
2106
 
1862
2107
  > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
@@ -2620,6 +2865,59 @@ end
2620
2865
  - **Accept**: application/json
2621
2866
 
2622
2867
 
2868
+ ## enable_sfvb_smart_attribution
2869
+
2870
+ > <SfvbSmartAttribution> enable_sfvb_smart_attribution(storefront_oid)
2871
+
2872
+ Turn Smart Attribution on in report_only mode
2873
+
2874
+ What the admin's Enable button saves: report_only, position_based, a 40/20/40 split, a 7 day lookback and every detected platform. report_only records decisions and changes nothing any platform is sent. A storefront that already has a configuration is 409 sfvb.smart_attribution_configured. Needs sfvb_publish.
2875
+
2876
+
2877
+ ### Examples
2878
+
2879
+
2880
+ (No example for this operation).
2881
+
2882
+
2883
+ #### Using the enable_sfvb_smart_attribution_with_http_info variant
2884
+
2885
+ This returns an Array which contains the response data, status code and headers.
2886
+
2887
+ > <Array(<SfvbSmartAttribution>, Integer, Hash)> enable_sfvb_smart_attribution_with_http_info(storefront_oid)
2888
+
2889
+ ```ruby
2890
+ begin
2891
+ # Turn Smart Attribution on in report_only mode
2892
+ data, status_code, headers = api_instance.enable_sfvb_smart_attribution_with_http_info(storefront_oid)
2893
+ p status_code # => 2xx
2894
+ p headers # => { ... }
2895
+ p data # => <SfvbSmartAttribution>
2896
+ rescue UltracartClient::ApiError => e
2897
+ puts "Error when calling SfvbApi->enable_sfvb_smart_attribution_with_http_info: #{e}"
2898
+ end
2899
+ ```
2900
+
2901
+ ### Parameters
2902
+
2903
+ | Name | Type | Description | Notes |
2904
+ | ---- | ---- | ----------- | ----- |
2905
+ | **storefront_oid** | **Integer** | | |
2906
+
2907
+ ### Return type
2908
+
2909
+ [**SfvbSmartAttribution**](SfvbSmartAttribution.md)
2910
+
2911
+ ### Authorization
2912
+
2913
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2914
+
2915
+ ### HTTP request headers
2916
+
2917
+ - **Content-Type**: Not defined
2918
+ - **Accept**: application/json
2919
+
2920
+
2623
2921
  ## enable_sfvb_upsell_offer
2624
2922
 
2625
2923
  > <SfvbUpsellOffer> enable_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts)
@@ -2840,13 +3138,13 @@ nil (empty response body)
2840
3138
  - **Accept**: application/json
2841
3139
 
2842
3140
 
2843
- ## get_sfvb_approval
3141
+ ## get_sfvb_affiliate_network
2844
3142
 
2845
- > <SfvbApproval> get_sfvb_approval(approval_id)
3143
+ > <SfvbAffiliateNetwork> get_sfvb_affiliate_network(storefront_oid, affiliate_network_oid)
2846
3144
 
2847
- Read one approval request
3145
+ Read one affiliate network
2848
3146
 
2849
- Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
3147
+ The network with its conversion_pixel, and the hash_sha256 an update or delete sends back as If-Match.
2850
3148
 
2851
3149
 
2852
3150
  ### Examples
@@ -2855,21 +3153,21 @@ Poll this every interval_seconds after requesting an approval. status is pendin
2855
3153
  (No example for this operation).
2856
3154
 
2857
3155
 
2858
- #### Using the get_sfvb_approval_with_http_info variant
3156
+ #### Using the get_sfvb_affiliate_network_with_http_info variant
2859
3157
 
2860
3158
  This returns an Array which contains the response data, status code and headers.
2861
3159
 
2862
- > <Array(<SfvbApproval>, Integer, Hash)> get_sfvb_approval_with_http_info(approval_id)
3160
+ > <Array(<SfvbAffiliateNetwork>, Integer, Hash)> get_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid)
2863
3161
 
2864
3162
  ```ruby
2865
3163
  begin
2866
- # Read one approval request
2867
- data, status_code, headers = api_instance.get_sfvb_approval_with_http_info(approval_id)
3164
+ # Read one affiliate network
3165
+ data, status_code, headers = api_instance.get_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid)
2868
3166
  p status_code # => 2xx
2869
3167
  p headers # => { ... }
2870
- p data # => <SfvbApproval>
3168
+ p data # => <SfvbAffiliateNetwork>
2871
3169
  rescue UltracartClient::ApiError => e
2872
- puts "Error when calling SfvbApi->get_sfvb_approval_with_http_info: #{e}"
3170
+ puts "Error when calling SfvbApi->get_sfvb_affiliate_network_with_http_info: #{e}"
2873
3171
  end
2874
3172
  ```
2875
3173
 
@@ -2877,11 +3175,12 @@ end
2877
3175
 
2878
3176
  | Name | Type | Description | Notes |
2879
3177
  | ---- | ---- | ----------- | ----- |
2880
- | **approval_id** | **String** | | |
3178
+ | **storefront_oid** | **Integer** | | |
3179
+ | **affiliate_network_oid** | **Integer** | | |
2881
3180
 
2882
3181
  ### Return type
2883
3182
 
2884
- [**SfvbApproval**](SfvbApproval.md)
3183
+ [**SfvbAffiliateNetwork**](SfvbAffiliateNetwork.md)
2885
3184
 
2886
3185
  ### Authorization
2887
3186
 
@@ -2893,13 +3192,13 @@ end
2893
3192
  - **Accept**: application/json
2894
3193
 
2895
3194
 
2896
- ## get_sfvb_approvals
3195
+ ## get_sfvb_affiliate_networks
2897
3196
 
2898
- > <SfvbApprovalsResponse> get_sfvb_approvals
3197
+ > <SfvbAffiliateNetworksResponse> get_sfvb_affiliate_networks(storefront_oid)
2899
3198
 
2900
- List this sign-in's approval requests
3199
+ List a storefront's affiliate networks
2901
3200
 
2902
- Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
3201
+ Every affiliate network pixel, by name, with its settings and hash_sha256. conversion_pixel is left out; its size and hash are shown. Read one network for it.
2903
3202
 
2904
3203
 
2905
3204
  ### Examples
@@ -2908,31 +3207,33 @@ Requests made with this sign-in in the last 24 hours, newest first, at most 50,
2908
3207
  (No example for this operation).
2909
3208
 
2910
3209
 
2911
- #### Using the get_sfvb_approvals_with_http_info variant
3210
+ #### Using the get_sfvb_affiliate_networks_with_http_info variant
2912
3211
 
2913
3212
  This returns an Array which contains the response data, status code and headers.
2914
3213
 
2915
- > <Array(<SfvbApprovalsResponse>, Integer, Hash)> get_sfvb_approvals_with_http_info
3214
+ > <Array(<SfvbAffiliateNetworksResponse>, Integer, Hash)> get_sfvb_affiliate_networks_with_http_info(storefront_oid)
2916
3215
 
2917
3216
  ```ruby
2918
3217
  begin
2919
- # List this sign-in's approval requests
2920
- data, status_code, headers = api_instance.get_sfvb_approvals_with_http_info
3218
+ # List a storefront's affiliate networks
3219
+ data, status_code, headers = api_instance.get_sfvb_affiliate_networks_with_http_info(storefront_oid)
2921
3220
  p status_code # => 2xx
2922
3221
  p headers # => { ... }
2923
- p data # => <SfvbApprovalsResponse>
3222
+ p data # => <SfvbAffiliateNetworksResponse>
2924
3223
  rescue UltracartClient::ApiError => e
2925
- puts "Error when calling SfvbApi->get_sfvb_approvals_with_http_info: #{e}"
3224
+ puts "Error when calling SfvbApi->get_sfvb_affiliate_networks_with_http_info: #{e}"
2926
3225
  end
2927
3226
  ```
2928
3227
 
2929
3228
  ### Parameters
2930
3229
 
2931
- This endpoint does not need any parameter.
3230
+ | Name | Type | Description | Notes |
3231
+ | ---- | ---- | ----------- | ----- |
3232
+ | **storefront_oid** | **Integer** | | |
2932
3233
 
2933
3234
  ### Return type
2934
3235
 
2935
- [**SfvbApprovalsResponse**](SfvbApprovalsResponse.md)
3236
+ [**SfvbAffiliateNetworksResponse**](SfvbAffiliateNetworksResponse.md)
2936
3237
 
2937
3238
  ### Authorization
2938
3239
 
@@ -2944,13 +3245,13 @@ This endpoint does not need any parameter.
2944
3245
  - **Accept**: application/json
2945
3246
 
2946
3247
 
2947
- ## get_sfvb_blog_post
3248
+ ## get_sfvb_approval
2948
3249
 
2949
- > <SfvbBlogPostDetail> get_sfvb_blog_post(storefront_oid, blog_post_oid)
3250
+ > <SfvbApproval> get_sfvb_approval(approval_id)
2950
3251
 
2951
- Read a blog post
3252
+ Read one approval request
2952
3253
 
2953
- The whole post - body, excerpt, tags, images and where it is shown. An image's url is the address to use for it in the body.
3254
+ Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
2954
3255
 
2955
3256
 
2956
3257
  ### Examples
@@ -2959,11 +3260,115 @@ The whole post - body, excerpt, tags, images and where it is shown. An image's
2959
3260
  (No example for this operation).
2960
3261
 
2961
3262
 
2962
- #### Using the get_sfvb_blog_post_with_http_info variant
3263
+ #### Using the get_sfvb_approval_with_http_info variant
2963
3264
 
2964
3265
  This returns an Array which contains the response data, status code and headers.
2965
3266
 
2966
- > <Array(<SfvbBlogPostDetail>, Integer, Hash)> get_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
3267
+ > <Array(<SfvbApproval>, Integer, Hash)> get_sfvb_approval_with_http_info(approval_id)
3268
+
3269
+ ```ruby
3270
+ begin
3271
+ # Read one approval request
3272
+ data, status_code, headers = api_instance.get_sfvb_approval_with_http_info(approval_id)
3273
+ p status_code # => 2xx
3274
+ p headers # => { ... }
3275
+ p data # => <SfvbApproval>
3276
+ rescue UltracartClient::ApiError => e
3277
+ puts "Error when calling SfvbApi->get_sfvb_approval_with_http_info: #{e}"
3278
+ end
3279
+ ```
3280
+
3281
+ ### Parameters
3282
+
3283
+ | Name | Type | Description | Notes |
3284
+ | ---- | ---- | ----------- | ----- |
3285
+ | **approval_id** | **String** | | |
3286
+
3287
+ ### Return type
3288
+
3289
+ [**SfvbApproval**](SfvbApproval.md)
3290
+
3291
+ ### Authorization
3292
+
3293
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3294
+
3295
+ ### HTTP request headers
3296
+
3297
+ - **Content-Type**: Not defined
3298
+ - **Accept**: application/json
3299
+
3300
+
3301
+ ## get_sfvb_approvals
3302
+
3303
+ > <SfvbApprovalsResponse> get_sfvb_approvals
3304
+
3305
+ List this sign-in's approval requests
3306
+
3307
+ Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
3308
+
3309
+
3310
+ ### Examples
3311
+
3312
+
3313
+ (No example for this operation).
3314
+
3315
+
3316
+ #### Using the get_sfvb_approvals_with_http_info variant
3317
+
3318
+ This returns an Array which contains the response data, status code and headers.
3319
+
3320
+ > <Array(<SfvbApprovalsResponse>, Integer, Hash)> get_sfvb_approvals_with_http_info
3321
+
3322
+ ```ruby
3323
+ begin
3324
+ # List this sign-in's approval requests
3325
+ data, status_code, headers = api_instance.get_sfvb_approvals_with_http_info
3326
+ p status_code # => 2xx
3327
+ p headers # => { ... }
3328
+ p data # => <SfvbApprovalsResponse>
3329
+ rescue UltracartClient::ApiError => e
3330
+ puts "Error when calling SfvbApi->get_sfvb_approvals_with_http_info: #{e}"
3331
+ end
3332
+ ```
3333
+
3334
+ ### Parameters
3335
+
3336
+ This endpoint does not need any parameter.
3337
+
3338
+ ### Return type
3339
+
3340
+ [**SfvbApprovalsResponse**](SfvbApprovalsResponse.md)
3341
+
3342
+ ### Authorization
3343
+
3344
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3345
+
3346
+ ### HTTP request headers
3347
+
3348
+ - **Content-Type**: Not defined
3349
+ - **Accept**: application/json
3350
+
3351
+
3352
+ ## get_sfvb_blog_post
3353
+
3354
+ > <SfvbBlogPostDetail> get_sfvb_blog_post(storefront_oid, blog_post_oid)
3355
+
3356
+ Read a blog post
3357
+
3358
+ The whole post - body, excerpt, tags, images and where it is shown. An image's url is the address to use for it in the body.
3359
+
3360
+
3361
+ ### Examples
3362
+
3363
+
3364
+ (No example for this operation).
3365
+
3366
+
3367
+ #### Using the get_sfvb_blog_post_with_http_info variant
3368
+
3369
+ This returns an Array which contains the response data, status code and headers.
3370
+
3371
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> get_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
2967
3372
 
2968
3373
  ```ruby
2969
3374
  begin
@@ -5699,6 +6104,59 @@ end
5699
6104
  - **Accept**: application/json
5700
6105
 
5701
6106
 
6107
+ ## get_sfvb_smart_attribution
6108
+
6109
+ > <SfvbSmartAttribution> get_sfvb_smart_attribution(storefront_oid)
6110
+
6111
+ Read a storefront's Smart Attribution configuration
6112
+
6113
+ The mode, model, global credit split, lookback and platforms, the platforms detected from the tracking integrations that are not configured yet, and the hash_sha256 a change or delete sends back as If-Match. When configured is false the values are the defaults an enable would save.
6114
+
6115
+
6116
+ ### Examples
6117
+
6118
+
6119
+ (No example for this operation).
6120
+
6121
+
6122
+ #### Using the get_sfvb_smart_attribution_with_http_info variant
6123
+
6124
+ This returns an Array which contains the response data, status code and headers.
6125
+
6126
+ > <Array(<SfvbSmartAttribution>, Integer, Hash)> get_sfvb_smart_attribution_with_http_info(storefront_oid)
6127
+
6128
+ ```ruby
6129
+ begin
6130
+ # Read a storefront's Smart Attribution configuration
6131
+ data, status_code, headers = api_instance.get_sfvb_smart_attribution_with_http_info(storefront_oid)
6132
+ p status_code # => 2xx
6133
+ p headers # => { ... }
6134
+ p data # => <SfvbSmartAttribution>
6135
+ rescue UltracartClient::ApiError => e
6136
+ puts "Error when calling SfvbApi->get_sfvb_smart_attribution_with_http_info: #{e}"
6137
+ end
6138
+ ```
6139
+
6140
+ ### Parameters
6141
+
6142
+ | Name | Type | Description | Notes |
6143
+ | ---- | ---- | ----------- | ----- |
6144
+ | **storefront_oid** | **Integer** | | |
6145
+
6146
+ ### Return type
6147
+
6148
+ [**SfvbSmartAttribution**](SfvbSmartAttribution.md)
6149
+
6150
+ ### Authorization
6151
+
6152
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6153
+
6154
+ ### HTTP request headers
6155
+
6156
+ - **Content-Type**: Not defined
6157
+ - **Accept**: application/json
6158
+
6159
+
5702
6160
  ## get_sfvb_test_orders
5703
6161
 
5704
6162
  > <SfvbTestOrdersResponse> get_sfvb_test_orders(storefront_oid, opts)
@@ -5915,13 +6373,13 @@ end
5915
6373
  - **Accept**: application/json
5916
6374
 
5917
6375
 
5918
- ## get_sfvb_transactional_emails
6376
+ ## get_sfvb_tracking_html
5919
6377
 
5920
- > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
6378
+ > <SfvbTrackingHtml> get_sfvb_tracking_html(storefront_oid, slot)
5921
6379
 
5922
- List the transactional emails a storefront sends
6380
+ Read one custom tracking HTML slot
5923
6381
 
5924
- The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
6382
+ The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
5925
6383
 
5926
6384
 
5927
6385
  ### Examples
@@ -5930,21 +6388,21 @@ The order, shipment, auto order and other transactional emails this storefront s
5930
6388
  (No example for this operation).
5931
6389
 
5932
6390
 
5933
- #### Using the get_sfvb_transactional_emails_with_http_info variant
6391
+ #### Using the get_sfvb_tracking_html_with_http_info variant
5934
6392
 
5935
6393
  This returns an Array which contains the response data, status code and headers.
5936
6394
 
5937
- > <Array(<SfvbTransactionalEmailsResponse>, Integer, Hash)> get_sfvb_transactional_emails_with_http_info(storefront_oid)
6395
+ > <Array(<SfvbTrackingHtml>, Integer, Hash)> get_sfvb_tracking_html_with_http_info(storefront_oid, slot)
5938
6396
 
5939
6397
  ```ruby
5940
6398
  begin
5941
- # List the transactional emails a storefront sends
5942
- data, status_code, headers = api_instance.get_sfvb_transactional_emails_with_http_info(storefront_oid)
6399
+ # Read one custom tracking HTML slot
6400
+ data, status_code, headers = api_instance.get_sfvb_tracking_html_with_http_info(storefront_oid, slot)
5943
6401
  p status_code # => 2xx
5944
6402
  p headers # => { ... }
5945
- p data # => <SfvbTransactionalEmailsResponse>
6403
+ p data # => <SfvbTrackingHtml>
5946
6404
  rescue UltracartClient::ApiError => e
5947
- puts "Error when calling SfvbApi->get_sfvb_transactional_emails_with_http_info: #{e}"
6405
+ puts "Error when calling SfvbApi->get_sfvb_tracking_html_with_http_info: #{e}"
5948
6406
  end
5949
6407
  ```
5950
6408
 
@@ -5953,10 +6411,11 @@ end
5953
6411
  | Name | Type | Description | Notes |
5954
6412
  | ---- | ---- | ----------- | ----- |
5955
6413
  | **storefront_oid** | **Integer** | | |
6414
+ | **slot** | **String** | tracking or conversion | |
5956
6415
 
5957
6416
  ### Return type
5958
6417
 
5959
- [**SfvbTransactionalEmailsResponse**](SfvbTransactionalEmailsResponse.md)
6418
+ [**SfvbTrackingHtml**](SfvbTrackingHtml.md)
5960
6419
 
5961
6420
  ### Authorization
5962
6421
 
@@ -5968,13 +6427,13 @@ end
5968
6427
  - **Accept**: application/json
5969
6428
 
5970
6429
 
5971
- ## get_sfvb_upsell_offer
6430
+ ## get_sfvb_tracking_html_slots
5972
6431
 
5973
- > <SfvbUpsellOffer> get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts)
6432
+ > <SfvbTrackingHtmlResponse> get_sfvb_tracking_html_slots(storefront_oid)
5974
6433
 
5975
- Get an upsell offer
6434
+ List a storefront's custom tracking HTML slots
5976
6435
 
5977
- The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
6436
+ tracking (every page but the receipt) and conversion (the receipt only), each with its size and hash_sha256. Read one slot for its content.
5978
6437
 
5979
6438
 
5980
6439
  ### Examples
@@ -5983,21 +6442,21 @@ The whole offer, with the hash an update sends back in If-Match, which upsell it
5983
6442
  (No example for this operation).
5984
6443
 
5985
6444
 
5986
- #### Using the get_sfvb_upsell_offer_with_http_info variant
6445
+ #### Using the get_sfvb_tracking_html_slots_with_http_info variant
5987
6446
 
5988
6447
  This returns an Array which contains the response data, status code and headers.
5989
6448
 
5990
- > <Array(<SfvbUpsellOffer>, Integer, Hash)> get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
6449
+ > <Array(<SfvbTrackingHtmlResponse>, Integer, Hash)> get_sfvb_tracking_html_slots_with_http_info(storefront_oid)
5991
6450
 
5992
6451
  ```ruby
5993
6452
  begin
5994
- # Get an upsell offer
5995
- data, status_code, headers = api_instance.get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
6453
+ # List a storefront's custom tracking HTML slots
6454
+ data, status_code, headers = api_instance.get_sfvb_tracking_html_slots_with_http_info(storefront_oid)
5996
6455
  p status_code # => 2xx
5997
6456
  p headers # => { ... }
5998
- p data # => <SfvbUpsellOffer>
6457
+ p data # => <SfvbTrackingHtmlResponse>
5999
6458
  rescue UltracartClient::ApiError => e
6000
- puts "Error when calling SfvbApi->get_sfvb_upsell_offer_with_http_info: #{e}"
6459
+ puts "Error when calling SfvbApi->get_sfvb_tracking_html_slots_with_http_info: #{e}"
6001
6460
  end
6002
6461
  ```
6003
6462
 
@@ -6006,15 +6465,10 @@ end
6006
6465
  | Name | Type | Description | Notes |
6007
6466
  | ---- | ---- | ----------- | ----- |
6008
6467
  | **storefront_oid** | **Integer** | | |
6009
- | **upsell_offer_oid** | **Integer** | | |
6010
- | **stats** | **Boolean** | Include stats | [optional] |
6011
- | **stats_start** | **String** | Stats window start, YYYY-MM-DD | [optional] |
6012
- | **stats_end** | **String** | Stats window end, YYYY-MM-DD | [optional] |
6013
- | **stats_weekdays** | **String** | Only these weekdays, comma separated mon to sun | [optional] |
6014
6468
 
6015
6469
  ### Return type
6016
6470
 
6017
- [**SfvbUpsellOffer**](SfvbUpsellOffer.md)
6471
+ [**SfvbTrackingHtmlResponse**](SfvbTrackingHtmlResponse.md)
6018
6472
 
6019
6473
  ### Authorization
6020
6474
 
@@ -6026,13 +6480,13 @@ end
6026
6480
  - **Accept**: application/json
6027
6481
 
6028
6482
 
6029
- ## get_sfvb_upsell_path
6483
+ ## get_sfvb_tracking_provider
6030
6484
 
6031
- > <SfvbUpsellPath> get_sfvb_upsell_path(storefront_oid, upsell_path_oid, opts)
6485
+ > <SfvbTrackingProvider> get_sfvb_tracking_provider(storefront_oid, provider)
6032
6486
 
6033
- Get an upsell path
6487
+ Read one tracking provider
6034
6488
 
6035
- The whole path, with the hash an update sends back in If-Match. Stats as on the list.
6489
+ The provider as the list shows it, with the hash_sha256 a change or clear sends back as If-Match.
6036
6490
 
6037
6491
 
6038
6492
  ### Examples
@@ -6041,21 +6495,21 @@ The whole path, with the hash an update sends back in If-Match. Stats as on the
6041
6495
  (No example for this operation).
6042
6496
 
6043
6497
 
6044
- #### Using the get_sfvb_upsell_path_with_http_info variant
6498
+ #### Using the get_sfvb_tracking_provider_with_http_info variant
6045
6499
 
6046
6500
  This returns an Array which contains the response data, status code and headers.
6047
6501
 
6048
- > <Array(<SfvbUpsellPath>, Integer, Hash)> get_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path_oid, opts)
6502
+ > <Array(<SfvbTrackingProvider>, Integer, Hash)> get_sfvb_tracking_provider_with_http_info(storefront_oid, provider)
6049
6503
 
6050
6504
  ```ruby
6051
6505
  begin
6052
- # Get an upsell path
6053
- data, status_code, headers = api_instance.get_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path_oid, opts)
6506
+ # Read one tracking provider
6507
+ data, status_code, headers = api_instance.get_sfvb_tracking_provider_with_http_info(storefront_oid, provider)
6054
6508
  p status_code # => 2xx
6055
6509
  p headers # => { ... }
6056
- p data # => <SfvbUpsellPath>
6510
+ p data # => <SfvbTrackingProvider>
6057
6511
  rescue UltracartClient::ApiError => e
6058
- puts "Error when calling SfvbApi->get_sfvb_upsell_path_with_http_info: #{e}"
6512
+ puts "Error when calling SfvbApi->get_sfvb_tracking_provider_with_http_info: #{e}"
6059
6513
  end
6060
6514
  ```
6061
6515
 
@@ -6064,15 +6518,11 @@ end
6064
6518
  | Name | Type | Description | Notes |
6065
6519
  | ---- | ---- | ----------- | ----- |
6066
6520
  | **storefront_oid** | **Integer** | | |
6067
- | **upsell_path_oid** | **Integer** | | |
6068
- | **stats** | **Boolean** | Include stats | [optional] |
6069
- | **stats_start** | **String** | Stats window start, YYYY-MM-DD | [optional] |
6070
- | **stats_end** | **String** | Stats window end, YYYY-MM-DD | [optional] |
6071
- | **stats_weekdays** | **String** | Only these weekdays, comma separated mon to sun | [optional] |
6521
+ | **provider** | **String** | | |
6072
6522
 
6073
6523
  ### Return type
6074
6524
 
6075
- [**SfvbUpsellPath**](SfvbUpsellPath.md)
6525
+ [**SfvbTrackingProvider**](SfvbTrackingProvider.md)
6076
6526
 
6077
6527
  ### Authorization
6078
6528
 
@@ -6084,13 +6534,13 @@ end
6084
6534
  - **Accept**: application/json
6085
6535
 
6086
6536
 
6087
- ## get_sfvb_version
6537
+ ## get_sfvb_tracking_providers
6088
6538
 
6089
- > <SfvbVersionResponse> get_sfvb_version
6539
+ > <SfvbTrackingProvidersResponse> get_sfvb_tracking_providers(storefront_oid, opts)
6090
6540
 
6091
- Compiler version for this merchant
6541
+ List a storefront's tracking providers
6092
6542
 
6093
- The visual builder release channel is per merchant, so a CLI holding cached schema or element data should compare against this to know when it has gone stale.
6543
+ Every provider on the admin's Google and Other tabs, with each field's type and value, its consent gate, events, OAuth connection state and hash_sha256. A secret's value is never returned, only whether one is set, its mask and the sink to request a handle for. configured=true lists only the providers that are on.
6094
6544
 
6095
6545
 
6096
6546
  ### Examples
@@ -6099,31 +6549,34 @@ The visual builder release channel is per merchant, so a CLI holding cached sche
6099
6549
  (No example for this operation).
6100
6550
 
6101
6551
 
6102
- #### Using the get_sfvb_version_with_http_info variant
6552
+ #### Using the get_sfvb_tracking_providers_with_http_info variant
6103
6553
 
6104
6554
  This returns an Array which contains the response data, status code and headers.
6105
6555
 
6106
- > <Array(<SfvbVersionResponse>, Integer, Hash)> get_sfvb_version_with_http_info
6556
+ > <Array(<SfvbTrackingProvidersResponse>, Integer, Hash)> get_sfvb_tracking_providers_with_http_info(storefront_oid, opts)
6107
6557
 
6108
6558
  ```ruby
6109
6559
  begin
6110
- # Compiler version for this merchant
6111
- data, status_code, headers = api_instance.get_sfvb_version_with_http_info
6560
+ # List a storefront's tracking providers
6561
+ data, status_code, headers = api_instance.get_sfvb_tracking_providers_with_http_info(storefront_oid, opts)
6112
6562
  p status_code # => 2xx
6113
6563
  p headers # => { ... }
6114
- p data # => <SfvbVersionResponse>
6564
+ p data # => <SfvbTrackingProvidersResponse>
6115
6565
  rescue UltracartClient::ApiError => e
6116
- puts "Error when calling SfvbApi->get_sfvb_version_with_http_info: #{e}"
6566
+ puts "Error when calling SfvbApi->get_sfvb_tracking_providers_with_http_info: #{e}"
6117
6567
  end
6118
6568
  ```
6119
6569
 
6120
6570
  ### Parameters
6121
6571
 
6122
- This endpoint does not need any parameter.
6572
+ | Name | Type | Description | Notes |
6573
+ | ---- | ---- | ----------- | ----- |
6574
+ | **storefront_oid** | **Integer** | | |
6575
+ | **configured** | **Boolean** | | [optional] |
6123
6576
 
6124
6577
  ### Return type
6125
6578
 
6126
- [**SfvbVersionResponse**](SfvbVersionResponse.md)
6579
+ [**SfvbTrackingProvidersResponse**](SfvbTrackingProvidersResponse.md)
6127
6580
 
6128
6581
  ### Authorization
6129
6582
 
@@ -6135,13 +6588,13 @@ This endpoint does not need any parameter.
6135
6588
  - **Accept**: application/json
6136
6589
 
6137
6590
 
6138
- ## get_sfvb_whoami
6591
+ ## get_sfvb_tracking_settings
6139
6592
 
6140
- > <SfvbWhoamiResponse> get_sfvb_whoami
6593
+ > <SfvbTrackingSettingsResponse> get_sfvb_tracking_settings(storefront_oid)
6141
6594
 
6142
- Who this token is
6595
+ Read a storefront's privacy rules and advanced conversion settings
6143
6596
 
6144
- Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
6597
+ The five privacy rules (which shoppers each applies to) and the advanced conversion settings, each section with the hash_sha256 a write sends back as If-Match. The order hash secret key is shared by every storefront on the account and is reported only as set or not.
6145
6598
 
6146
6599
 
6147
6600
  ### Examples
@@ -6150,31 +6603,33 @@ Returns the merchant, user, granted scopes and reachable storefronts for the cal
6150
6603
  (No example for this operation).
6151
6604
 
6152
6605
 
6153
- #### Using the get_sfvb_whoami_with_http_info variant
6606
+ #### Using the get_sfvb_tracking_settings_with_http_info variant
6154
6607
 
6155
6608
  This returns an Array which contains the response data, status code and headers.
6156
6609
 
6157
- > <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_whoami_with_http_info
6610
+ > <Array(<SfvbTrackingSettingsResponse>, Integer, Hash)> get_sfvb_tracking_settings_with_http_info(storefront_oid)
6158
6611
 
6159
6612
  ```ruby
6160
6613
  begin
6161
- # Who this token is
6162
- data, status_code, headers = api_instance.get_sfvb_whoami_with_http_info
6614
+ # Read a storefront's privacy rules and advanced conversion settings
6615
+ data, status_code, headers = api_instance.get_sfvb_tracking_settings_with_http_info(storefront_oid)
6163
6616
  p status_code # => 2xx
6164
6617
  p headers # => { ... }
6165
- p data # => <SfvbWhoamiResponse>
6618
+ p data # => <SfvbTrackingSettingsResponse>
6166
6619
  rescue UltracartClient::ApiError => e
6167
- puts "Error when calling SfvbApi->get_sfvb_whoami_with_http_info: #{e}"
6620
+ puts "Error when calling SfvbApi->get_sfvb_tracking_settings_with_http_info: #{e}"
6168
6621
  end
6169
6622
  ```
6170
6623
 
6171
6624
  ### Parameters
6172
6625
 
6173
- This endpoint does not need any parameter.
6626
+ | Name | Type | Description | Notes |
6627
+ | ---- | ---- | ----------- | ----- |
6628
+ | **storefront_oid** | **Integer** | | |
6174
6629
 
6175
6630
  ### Return type
6176
6631
 
6177
- [**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
6632
+ [**SfvbTrackingSettingsResponse**](SfvbTrackingSettingsResponse.md)
6178
6633
 
6179
6634
  ### Authorization
6180
6635
 
@@ -6186,13 +6641,13 @@ This endpoint does not need any parameter.
6186
6641
  - **Accept**: application/json
6187
6642
 
6188
6643
 
6189
- ## ignore_sfvb_not_found_entry
6644
+ ## get_sfvb_transactional_emails
6190
6645
 
6191
- > <SfvbNotFoundEntry> ignore_sfvb_not_found_entry(storefront_oid, not_found_id)
6646
+ > <SfvbTransactionalEmailsResponse> get_sfvb_transactional_emails(storefront_oid)
6192
6647
 
6193
- Ignore a 404 path
6648
+ List the transactional emails a storefront sends
6194
6649
 
6195
- Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
6650
+ The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
6196
6651
 
6197
6652
 
6198
6653
  ### Examples
@@ -6201,21 +6656,21 @@ Hides one path from the list and stops counting its hits, for example scanner no
6201
6656
  (No example for this operation).
6202
6657
 
6203
6658
 
6204
- #### Using the ignore_sfvb_not_found_entry_with_http_info variant
6659
+ #### Using the get_sfvb_transactional_emails_with_http_info variant
6205
6660
 
6206
6661
  This returns an Array which contains the response data, status code and headers.
6207
6662
 
6208
- > <Array(<SfvbNotFoundEntry>, Integer, Hash)> ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
6663
+ > <Array(<SfvbTransactionalEmailsResponse>, Integer, Hash)> get_sfvb_transactional_emails_with_http_info(storefront_oid)
6209
6664
 
6210
6665
  ```ruby
6211
6666
  begin
6212
- # Ignore a 404 path
6213
- data, status_code, headers = api_instance.ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
6667
+ # List the transactional emails a storefront sends
6668
+ data, status_code, headers = api_instance.get_sfvb_transactional_emails_with_http_info(storefront_oid)
6214
6669
  p status_code # => 2xx
6215
6670
  p headers # => { ... }
6216
- p data # => <SfvbNotFoundEntry>
6671
+ p data # => <SfvbTransactionalEmailsResponse>
6217
6672
  rescue UltracartClient::ApiError => e
6218
- puts "Error when calling SfvbApi->ignore_sfvb_not_found_entry_with_http_info: #{e}"
6673
+ puts "Error when calling SfvbApi->get_sfvb_transactional_emails_with_http_info: #{e}"
6219
6674
  end
6220
6675
  ```
6221
6676
 
@@ -6224,11 +6679,10 @@ end
6224
6679
  | Name | Type | Description | Notes |
6225
6680
  | ---- | ---- | ----------- | ----- |
6226
6681
  | **storefront_oid** | **Integer** | | |
6227
- | **not_found_id** | **String** | | |
6228
6682
 
6229
6683
  ### Return type
6230
6684
 
6231
- [**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
6685
+ [**SfvbTransactionalEmailsResponse**](SfvbTransactionalEmailsResponse.md)
6232
6686
 
6233
6687
  ### Authorization
6234
6688
 
@@ -6240,13 +6694,13 @@ end
6240
6694
  - **Accept**: application/json
6241
6695
 
6242
6696
 
6243
- ## import_sfvb_redirects
6697
+ ## get_sfvb_upsell_offer
6244
6698
 
6245
- > <SfvbRedirectImportResponse> import_sfvb_redirects(storefront_oid, redirect_import_request)
6699
+ > <SfvbUpsellOffer> get_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, opts)
6246
6700
 
6247
- Apply a reviewed redirect import
6701
+ Get an upsell offer
6248
6702
 
6249
- Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
6703
+ The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
6250
6704
 
6251
6705
 
6252
6706
  ### Examples
@@ -6255,16 +6709,396 @@ Applies exactly the rows of a dry run, given its plan_hash, in one transaction.
6255
6709
  (No example for this operation).
6256
6710
 
6257
6711
 
6258
- #### Using the import_sfvb_redirects_with_http_info variant
6712
+ #### Using the get_sfvb_upsell_offer_with_http_info variant
6259
6713
 
6260
6714
  This returns an Array which contains the response data, status code and headers.
6261
6715
 
6262
- > <Array(<SfvbRedirectImportResponse>, Integer, Hash)> import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
6716
+ > <Array(<SfvbUpsellOffer>, Integer, Hash)> get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
6263
6717
 
6264
6718
  ```ruby
6265
6719
  begin
6266
- # Apply a reviewed redirect import
6267
- data, status_code, headers = api_instance.import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
6720
+ # Get an upsell offer
6721
+ data, status_code, headers = api_instance.get_sfvb_upsell_offer_with_http_info(storefront_oid, upsell_offer_oid, opts)
6722
+ p status_code # => 2xx
6723
+ p headers # => { ... }
6724
+ p data # => <SfvbUpsellOffer>
6725
+ rescue UltracartClient::ApiError => e
6726
+ puts "Error when calling SfvbApi->get_sfvb_upsell_offer_with_http_info: #{e}"
6727
+ end
6728
+ ```
6729
+
6730
+ ### Parameters
6731
+
6732
+ | Name | Type | Description | Notes |
6733
+ | ---- | ---- | ----------- | ----- |
6734
+ | **storefront_oid** | **Integer** | | |
6735
+ | **upsell_offer_oid** | **Integer** | | |
6736
+ | **stats** | **Boolean** | Include stats | [optional] |
6737
+ | **stats_start** | **String** | Stats window start, YYYY-MM-DD | [optional] |
6738
+ | **stats_end** | **String** | Stats window end, YYYY-MM-DD | [optional] |
6739
+ | **stats_weekdays** | **String** | Only these weekdays, comma separated mon to sun | [optional] |
6740
+
6741
+ ### Return type
6742
+
6743
+ [**SfvbUpsellOffer**](SfvbUpsellOffer.md)
6744
+
6745
+ ### Authorization
6746
+
6747
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6748
+
6749
+ ### HTTP request headers
6750
+
6751
+ - **Content-Type**: Not defined
6752
+ - **Accept**: application/json
6753
+
6754
+
6755
+ ## get_sfvb_upsell_path
6756
+
6757
+ > <SfvbUpsellPath> get_sfvb_upsell_path(storefront_oid, upsell_path_oid, opts)
6758
+
6759
+ Get an upsell path
6760
+
6761
+ The whole path, with the hash an update sends back in If-Match. Stats as on the list.
6762
+
6763
+
6764
+ ### Examples
6765
+
6766
+
6767
+ (No example for this operation).
6768
+
6769
+
6770
+ #### Using the get_sfvb_upsell_path_with_http_info variant
6771
+
6772
+ This returns an Array which contains the response data, status code and headers.
6773
+
6774
+ > <Array(<SfvbUpsellPath>, Integer, Hash)> get_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path_oid, opts)
6775
+
6776
+ ```ruby
6777
+ begin
6778
+ # Get an upsell path
6779
+ data, status_code, headers = api_instance.get_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path_oid, opts)
6780
+ p status_code # => 2xx
6781
+ p headers # => { ... }
6782
+ p data # => <SfvbUpsellPath>
6783
+ rescue UltracartClient::ApiError => e
6784
+ puts "Error when calling SfvbApi->get_sfvb_upsell_path_with_http_info: #{e}"
6785
+ end
6786
+ ```
6787
+
6788
+ ### Parameters
6789
+
6790
+ | Name | Type | Description | Notes |
6791
+ | ---- | ---- | ----------- | ----- |
6792
+ | **storefront_oid** | **Integer** | | |
6793
+ | **upsell_path_oid** | **Integer** | | |
6794
+ | **stats** | **Boolean** | Include stats | [optional] |
6795
+ | **stats_start** | **String** | Stats window start, YYYY-MM-DD | [optional] |
6796
+ | **stats_end** | **String** | Stats window end, YYYY-MM-DD | [optional] |
6797
+ | **stats_weekdays** | **String** | Only these weekdays, comma separated mon to sun | [optional] |
6798
+
6799
+ ### Return type
6800
+
6801
+ [**SfvbUpsellPath**](SfvbUpsellPath.md)
6802
+
6803
+ ### Authorization
6804
+
6805
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6806
+
6807
+ ### HTTP request headers
6808
+
6809
+ - **Content-Type**: Not defined
6810
+ - **Accept**: application/json
6811
+
6812
+
6813
+ ## get_sfvb_utm_shortcode
6814
+
6815
+ > <SfvbUtmShortcode> get_sfvb_utm_shortcode(storefront_oid, shortcode_oid)
6816
+
6817
+ Read one UTM shortcode
6818
+
6819
+ The shortcode with the hash_sha256 an update or delete sends back as If-Match. A deleted shortcode is 404.
6820
+
6821
+
6822
+ ### Examples
6823
+
6824
+
6825
+ (No example for this operation).
6826
+
6827
+
6828
+ #### Using the get_sfvb_utm_shortcode_with_http_info variant
6829
+
6830
+ This returns an Array which contains the response data, status code and headers.
6831
+
6832
+ > <Array(<SfvbUtmShortcode>, Integer, Hash)> get_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid)
6833
+
6834
+ ```ruby
6835
+ begin
6836
+ # Read one UTM shortcode
6837
+ data, status_code, headers = api_instance.get_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid)
6838
+ p status_code # => 2xx
6839
+ p headers # => { ... }
6840
+ p data # => <SfvbUtmShortcode>
6841
+ rescue UltracartClient::ApiError => e
6842
+ puts "Error when calling SfvbApi->get_sfvb_utm_shortcode_with_http_info: #{e}"
6843
+ end
6844
+ ```
6845
+
6846
+ ### Parameters
6847
+
6848
+ | Name | Type | Description | Notes |
6849
+ | ---- | ---- | ----------- | ----- |
6850
+ | **storefront_oid** | **Integer** | | |
6851
+ | **shortcode_oid** | **Integer** | | |
6852
+
6853
+ ### Return type
6854
+
6855
+ [**SfvbUtmShortcode**](SfvbUtmShortcode.md)
6856
+
6857
+ ### Authorization
6858
+
6859
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6860
+
6861
+ ### HTTP request headers
6862
+
6863
+ - **Content-Type**: Not defined
6864
+ - **Accept**: application/json
6865
+
6866
+
6867
+ ## get_sfvb_utm_shortcodes
6868
+
6869
+ > <SfvbUtmShortcodesResponse> get_sfvb_utm_shortcodes(storefront_oid, opts)
6870
+
6871
+ List a storefront's UTM shortcodes
6872
+
6873
+ Every live shortcode, sorted by code, each with its hash_sha256. q matches the code or the description, ignoring case.
6874
+
6875
+
6876
+ ### Examples
6877
+
6878
+
6879
+ (No example for this operation).
6880
+
6881
+
6882
+ #### Using the get_sfvb_utm_shortcodes_with_http_info variant
6883
+
6884
+ This returns an Array which contains the response data, status code and headers.
6885
+
6886
+ > <Array(<SfvbUtmShortcodesResponse>, Integer, Hash)> get_sfvb_utm_shortcodes_with_http_info(storefront_oid, opts)
6887
+
6888
+ ```ruby
6889
+ begin
6890
+ # List a storefront's UTM shortcodes
6891
+ data, status_code, headers = api_instance.get_sfvb_utm_shortcodes_with_http_info(storefront_oid, opts)
6892
+ p status_code # => 2xx
6893
+ p headers # => { ... }
6894
+ p data # => <SfvbUtmShortcodesResponse>
6895
+ rescue UltracartClient::ApiError => e
6896
+ puts "Error when calling SfvbApi->get_sfvb_utm_shortcodes_with_http_info: #{e}"
6897
+ end
6898
+ ```
6899
+
6900
+ ### Parameters
6901
+
6902
+ | Name | Type | Description | Notes |
6903
+ | ---- | ---- | ----------- | ----- |
6904
+ | **storefront_oid** | **Integer** | | |
6905
+ | **q** | **String** | | [optional] |
6906
+
6907
+ ### Return type
6908
+
6909
+ [**SfvbUtmShortcodesResponse**](SfvbUtmShortcodesResponse.md)
6910
+
6911
+ ### Authorization
6912
+
6913
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6914
+
6915
+ ### HTTP request headers
6916
+
6917
+ - **Content-Type**: Not defined
6918
+ - **Accept**: application/json
6919
+
6920
+
6921
+ ## get_sfvb_version
6922
+
6923
+ > <SfvbVersionResponse> get_sfvb_version
6924
+
6925
+ Compiler version for this merchant
6926
+
6927
+ The visual builder release channel is per merchant, so a CLI holding cached schema or element data should compare against this to know when it has gone stale.
6928
+
6929
+
6930
+ ### Examples
6931
+
6932
+
6933
+ (No example for this operation).
6934
+
6935
+
6936
+ #### Using the get_sfvb_version_with_http_info variant
6937
+
6938
+ This returns an Array which contains the response data, status code and headers.
6939
+
6940
+ > <Array(<SfvbVersionResponse>, Integer, Hash)> get_sfvb_version_with_http_info
6941
+
6942
+ ```ruby
6943
+ begin
6944
+ # Compiler version for this merchant
6945
+ data, status_code, headers = api_instance.get_sfvb_version_with_http_info
6946
+ p status_code # => 2xx
6947
+ p headers # => { ... }
6948
+ p data # => <SfvbVersionResponse>
6949
+ rescue UltracartClient::ApiError => e
6950
+ puts "Error when calling SfvbApi->get_sfvb_version_with_http_info: #{e}"
6951
+ end
6952
+ ```
6953
+
6954
+ ### Parameters
6955
+
6956
+ This endpoint does not need any parameter.
6957
+
6958
+ ### Return type
6959
+
6960
+ [**SfvbVersionResponse**](SfvbVersionResponse.md)
6961
+
6962
+ ### Authorization
6963
+
6964
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6965
+
6966
+ ### HTTP request headers
6967
+
6968
+ - **Content-Type**: Not defined
6969
+ - **Accept**: application/json
6970
+
6971
+
6972
+ ## get_sfvb_whoami
6973
+
6974
+ > <SfvbWhoamiResponse> get_sfvb_whoami
6975
+
6976
+ Who this token is
6977
+
6978
+ Returns the merchant, user, granted scopes and reachable storefronts for the calling token. Declared for any scope so an application can always discover which account it is connected to.
6979
+
6980
+
6981
+ ### Examples
6982
+
6983
+
6984
+ (No example for this operation).
6985
+
6986
+
6987
+ #### Using the get_sfvb_whoami_with_http_info variant
6988
+
6989
+ This returns an Array which contains the response data, status code and headers.
6990
+
6991
+ > <Array(<SfvbWhoamiResponse>, Integer, Hash)> get_sfvb_whoami_with_http_info
6992
+
6993
+ ```ruby
6994
+ begin
6995
+ # Who this token is
6996
+ data, status_code, headers = api_instance.get_sfvb_whoami_with_http_info
6997
+ p status_code # => 2xx
6998
+ p headers # => { ... }
6999
+ p data # => <SfvbWhoamiResponse>
7000
+ rescue UltracartClient::ApiError => e
7001
+ puts "Error when calling SfvbApi->get_sfvb_whoami_with_http_info: #{e}"
7002
+ end
7003
+ ```
7004
+
7005
+ ### Parameters
7006
+
7007
+ This endpoint does not need any parameter.
7008
+
7009
+ ### Return type
7010
+
7011
+ [**SfvbWhoamiResponse**](SfvbWhoamiResponse.md)
7012
+
7013
+ ### Authorization
7014
+
7015
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7016
+
7017
+ ### HTTP request headers
7018
+
7019
+ - **Content-Type**: Not defined
7020
+ - **Accept**: application/json
7021
+
7022
+
7023
+ ## ignore_sfvb_not_found_entry
7024
+
7025
+ > <SfvbNotFoundEntry> ignore_sfvb_not_found_entry(storefront_oid, not_found_id)
7026
+
7027
+ Ignore a 404 path
7028
+
7029
+ Hides one path from the list and stops counting its hits, for example scanner noise. Reversible.
7030
+
7031
+
7032
+ ### Examples
7033
+
7034
+
7035
+ (No example for this operation).
7036
+
7037
+
7038
+ #### Using the ignore_sfvb_not_found_entry_with_http_info variant
7039
+
7040
+ This returns an Array which contains the response data, status code and headers.
7041
+
7042
+ > <Array(<SfvbNotFoundEntry>, Integer, Hash)> ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
7043
+
7044
+ ```ruby
7045
+ begin
7046
+ # Ignore a 404 path
7047
+ data, status_code, headers = api_instance.ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
7048
+ p status_code # => 2xx
7049
+ p headers # => { ... }
7050
+ p data # => <SfvbNotFoundEntry>
7051
+ rescue UltracartClient::ApiError => e
7052
+ puts "Error when calling SfvbApi->ignore_sfvb_not_found_entry_with_http_info: #{e}"
7053
+ end
7054
+ ```
7055
+
7056
+ ### Parameters
7057
+
7058
+ | Name | Type | Description | Notes |
7059
+ | ---- | ---- | ----------- | ----- |
7060
+ | **storefront_oid** | **Integer** | | |
7061
+ | **not_found_id** | **String** | | |
7062
+
7063
+ ### Return type
7064
+
7065
+ [**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
7066
+
7067
+ ### Authorization
7068
+
7069
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7070
+
7071
+ ### HTTP request headers
7072
+
7073
+ - **Content-Type**: Not defined
7074
+ - **Accept**: application/json
7075
+
7076
+
7077
+ ## import_sfvb_redirects
7078
+
7079
+ > <SfvbRedirectImportResponse> import_sfvb_redirects(storefront_oid, redirect_import_request)
7080
+
7081
+ Apply a reviewed redirect import
7082
+
7083
+ Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
7084
+
7085
+
7086
+ ### Examples
7087
+
7088
+
7089
+ (No example for this operation).
7090
+
7091
+
7092
+ #### Using the import_sfvb_redirects_with_http_info variant
7093
+
7094
+ This returns an Array which contains the response data, status code and headers.
7095
+
7096
+ > <Array(<SfvbRedirectImportResponse>, Integer, Hash)> import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
7097
+
7098
+ ```ruby
7099
+ begin
7100
+ # Apply a reviewed redirect import
7101
+ data, status_code, headers = api_instance.import_sfvb_redirects_with_http_info(storefront_oid, redirect_import_request)
6268
7102
  p status_code # => 2xx
6269
7103
  p headers # => { ... }
6270
7104
  p data # => <SfvbRedirectImportResponse>
@@ -6294,13 +7128,68 @@ end
6294
7128
  - **Accept**: application/json
6295
7129
 
6296
7130
 
7131
+ ## insert_sfvb_affiliate_network
7132
+
7133
+ > <SfvbAffiliateNetwork> insert_sfvb_affiliate_network(storefront_oid, affiliate_network_request, opts)
7134
+
7135
+ Add an affiliate network
7136
+
7137
+ network_name, parameter_name and parameter_value are required; the rest start from the admin's defaults. Internal affiliate oids must be the account's own. Needs sfvb_publish. A network with a conversion_pixel that a custom or server_to_server network will use needs an approved affiliate_network.change request for exactly this create (Approval-Id), which UltraCart reviews first. dry_run says whether it needs one, without saving.
7138
+
7139
+
7140
+ ### Examples
7141
+
7142
+
7143
+ (No example for this operation).
7144
+
7145
+
7146
+ #### Using the insert_sfvb_affiliate_network_with_http_info variant
7147
+
7148
+ This returns an Array which contains the response data, status code and headers.
7149
+
7150
+ > <Array(<SfvbAffiliateNetwork>, Integer, Hash)> insert_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_request, opts)
7151
+
7152
+ ```ruby
7153
+ begin
7154
+ # Add an affiliate network
7155
+ data, status_code, headers = api_instance.insert_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_request, opts)
7156
+ p status_code # => 2xx
7157
+ p headers # => { ... }
7158
+ p data # => <SfvbAffiliateNetwork>
7159
+ rescue UltracartClient::ApiError => e
7160
+ puts "Error when calling SfvbApi->insert_sfvb_affiliate_network_with_http_info: #{e}"
7161
+ end
7162
+ ```
7163
+
7164
+ ### Parameters
7165
+
7166
+ | Name | Type | Description | Notes |
7167
+ | ---- | ---- | ----------- | ----- |
7168
+ | **storefront_oid** | **Integer** | | |
7169
+ | **affiliate_network_request** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) | The network | |
7170
+ | **approval_id** | **String** | For a network with a conversion pixel it will use, the approval_id of an approved affiliate_network.change request for exactly this create. See POST /sfvb/approvals. | [optional] |
7171
+
7172
+ ### Return type
7173
+
7174
+ [**SfvbAffiliateNetwork**](SfvbAffiliateNetwork.md)
7175
+
7176
+ ### Authorization
7177
+
7178
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7179
+
7180
+ ### HTTP request headers
7181
+
7182
+ - **Content-Type**: application/json; charset=UTF-8
7183
+ - **Accept**: application/json
7184
+
7185
+
6297
7186
  ## insert_sfvb_approval
6298
7187
 
6299
7188
  > <SfvbApproval> insert_sfvb_approval(approval_request, opts)
6300
7189
 
6301
7190
  Request a human approval
6302
7191
 
6303
- Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert. The request starts as reviewing while UltraCart's scanner and two AI models read it, then becomes pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same bytes.
7192
+ Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
6304
7193
 
6305
7194
 
6306
7195
  ### Examples
@@ -6887,6 +7776,60 @@ end
6887
7776
  - **Accept**: application/json
6888
7777
 
6889
7778
 
7779
+ ## insert_sfvb_utm_shortcode
7780
+
7781
+ > <SfvbUtmShortcode> insert_sfvb_utm_shortcode(storefront_oid, utm_shortcode_request)
7782
+
7783
+ Create a UTM shortcode
7784
+
7785
+ code is letters, digits, underscore and hyphen, 1 to 50 characters, and at least one UTM or ITM value is required. A code another live shortcode has, ignoring case, is 409 sfvb.utm_shortcode_exists. A code that is one of the account's affiliate short codes is 409 sfvb.utm_shortcode_affiliate_conflict, because the storefront checks those first and this one would never fire. Up to 5,000 per storefront. Needs sfvb_write only, because no link sent before it existed changes.
7786
+
7787
+
7788
+ ### Examples
7789
+
7790
+
7791
+ (No example for this operation).
7792
+
7793
+
7794
+ #### Using the insert_sfvb_utm_shortcode_with_http_info variant
7795
+
7796
+ This returns an Array which contains the response data, status code and headers.
7797
+
7798
+ > <Array(<SfvbUtmShortcode>, Integer, Hash)> insert_sfvb_utm_shortcode_with_http_info(storefront_oid, utm_shortcode_request)
7799
+
7800
+ ```ruby
7801
+ begin
7802
+ # Create a UTM shortcode
7803
+ data, status_code, headers = api_instance.insert_sfvb_utm_shortcode_with_http_info(storefront_oid, utm_shortcode_request)
7804
+ p status_code # => 2xx
7805
+ p headers # => { ... }
7806
+ p data # => <SfvbUtmShortcode>
7807
+ rescue UltracartClient::ApiError => e
7808
+ puts "Error when calling SfvbApi->insert_sfvb_utm_shortcode_with_http_info: #{e}"
7809
+ end
7810
+ ```
7811
+
7812
+ ### Parameters
7813
+
7814
+ | Name | Type | Description | Notes |
7815
+ | ---- | ---- | ----------- | ----- |
7816
+ | **storefront_oid** | **Integer** | | |
7817
+ | **utm_shortcode_request** | [**SfvbUtmShortcodeRequest**](SfvbUtmShortcodeRequest.md) | The shortcode | |
7818
+
7819
+ ### Return type
7820
+
7821
+ [**SfvbUtmShortcode**](SfvbUtmShortcode.md)
7822
+
7823
+ ### Authorization
7824
+
7825
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7826
+
7827
+ ### HTTP request headers
7828
+
7829
+ - **Content-Type**: application/json; charset=UTF-8
7830
+ - **Accept**: application/json
7831
+
7832
+
6890
7833
  ## install_sfvb_library_entry
6891
7834
 
6892
7835
  > <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
@@ -10860,7 +11803,64 @@ end
10860
11803
 
10861
11804
  ### Return type
10862
11805
 
10863
- [**SfvbLibraryUnshareResult**](SfvbLibraryUnshareResult.md)
11806
+ [**SfvbLibraryUnshareResult**](SfvbLibraryUnshareResult.md)
11807
+
11808
+ ### Authorization
11809
+
11810
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
11811
+
11812
+ ### HTTP request headers
11813
+
11814
+ - **Content-Type**: Not defined
11815
+ - **Accept**: application/json
11816
+
11817
+
11818
+ ## update_sfvb_affiliate_network
11819
+
11820
+ > <SfvbAffiliateNetwork> update_sfvb_affiliate_network(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts)
11821
+
11822
+ Change an affiliate network
11823
+
11824
+ A partial update: only the fields sent change. Send the network's hash_sha256 as If-Match. Needs sfvb_publish. Changing the conversion_pixel, or the conversion_type, of a network whose pixel will be used needs an approved affiliate_network.change request for exactly this change (Approval-Id), which UltraCart reviews first. Other fields, and emptying the pixel, need none. dry_run says whether it needs one, without saving.
11825
+
11826
+
11827
+ ### Examples
11828
+
11829
+
11830
+ (No example for this operation).
11831
+
11832
+
11833
+ #### Using the update_sfvb_affiliate_network_with_http_info variant
11834
+
11835
+ This returns an Array which contains the response data, status code and headers.
11836
+
11837
+ > <Array(<SfvbAffiliateNetwork>, Integer, Hash)> update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts)
11838
+
11839
+ ```ruby
11840
+ begin
11841
+ # Change an affiliate network
11842
+ data, status_code, headers = api_instance.update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts)
11843
+ p status_code # => 2xx
11844
+ p headers # => { ... }
11845
+ p data # => <SfvbAffiliateNetwork>
11846
+ rescue UltracartClient::ApiError => e
11847
+ puts "Error when calling SfvbApi->update_sfvb_affiliate_network_with_http_info: #{e}"
11848
+ end
11849
+ ```
11850
+
11851
+ ### Parameters
11852
+
11853
+ | Name | Type | Description | Notes |
11854
+ | ---- | ---- | ----------- | ----- |
11855
+ | **storefront_oid** | **Integer** | | |
11856
+ | **affiliate_network_oid** | **Integer** | | |
11857
+ | **if_match** | **String** | The network&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
11858
+ | **affiliate_network_request** | [**SfvbAffiliateNetworkRequest**](SfvbAffiliateNetworkRequest.md) | The change | |
11859
+ | **approval_id** | **String** | When the change sets a conversion pixel the network will use, the approval_id of an approved affiliate_network.change request for exactly this change. See POST /sfvb/approvals. | [optional] |
11860
+
11861
+ ### Return type
11862
+
11863
+ [**SfvbAffiliateNetwork**](SfvbAffiliateNetwork.md)
10864
11864
 
10865
11865
  ### Authorization
10866
11866
 
@@ -10868,7 +11868,7 @@ end
10868
11868
 
10869
11869
  ### HTTP request headers
10870
11870
 
10871
- - **Content-Type**: Not defined
11871
+ - **Content-Type**: application/json; charset=UTF-8
10872
11872
  - **Accept**: application/json
10873
11873
 
10874
11874
 
@@ -11540,6 +12540,286 @@ end
11540
12540
  - **Accept**: application/json
11541
12541
 
11542
12542
 
12543
+ ## update_sfvb_smart_attribution
12544
+
12545
+ > <SfvbSmartAttribution> update_sfvb_smart_attribution(storefront_oid, if_match, smart_attribution_request, opts)
12546
+
12547
+ Change a storefront's Smart Attribution configuration
12548
+
12549
+ A partial update of the mode, model, global split and lookback. platforms, when sent, replaces the whole list. The global split must total exactly 1 and the lookback is 7 to 365. On an unconfigured storefront it creates the configuration. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, and when the mode is active or the change makes it active, an approved smart_attribution.change request for exactly this change (Approval-Id), because active mode decides which conversions each platform is sent. A change that stores what is already stored returns the configuration unchanged and uses no approval.
12550
+
12551
+
12552
+ ### Examples
12553
+
12554
+
12555
+ (No example for this operation).
12556
+
12557
+
12558
+ #### Using the update_sfvb_smart_attribution_with_http_info variant
12559
+
12560
+ This returns an Array which contains the response data, status code and headers.
12561
+
12562
+ > <Array(<SfvbSmartAttribution>, Integer, Hash)> update_sfvb_smart_attribution_with_http_info(storefront_oid, if_match, smart_attribution_request, opts)
12563
+
12564
+ ```ruby
12565
+ begin
12566
+ # Change a storefront's Smart Attribution configuration
12567
+ data, status_code, headers = api_instance.update_sfvb_smart_attribution_with_http_info(storefront_oid, if_match, smart_attribution_request, opts)
12568
+ p status_code # => 2xx
12569
+ p headers # => { ... }
12570
+ p data # => <SfvbSmartAttribution>
12571
+ rescue UltracartClient::ApiError => e
12572
+ puts "Error when calling SfvbApi->update_sfvb_smart_attribution_with_http_info: #{e}"
12573
+ end
12574
+ ```
12575
+
12576
+ ### Parameters
12577
+
12578
+ | Name | Type | Description | Notes |
12579
+ | ---- | ---- | ----------- | ----- |
12580
+ | **storefront_oid** | **Integer** | | |
12581
+ | **if_match** | **String** | hash_sha256 from the Smart Attribution read. 428 when absent, 412 when stale. | |
12582
+ | **smart_attribution_request** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) | The change | |
12583
+ | **approval_id** | **String** | When the mode is or becomes active, the approval_id of an approved smart_attribution.change request for this change. See POST /sfvb/approvals. | [optional] |
12584
+
12585
+ ### Return type
12586
+
12587
+ [**SfvbSmartAttribution**](SfvbSmartAttribution.md)
12588
+
12589
+ ### Authorization
12590
+
12591
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12592
+
12593
+ ### HTTP request headers
12594
+
12595
+ - **Content-Type**: application/json; charset=UTF-8
12596
+ - **Accept**: application/json
12597
+
12598
+
12599
+ ## update_sfvb_tracking_advanced
12600
+
12601
+ > <SfvbTrackingSettingsResponse> update_sfvb_tracking_advanced(storefront_oid, if_match, tracking_advanced_request)
12602
+
12603
+ Change a storefront's advanced conversion settings
12604
+
12605
+ A partial update. Fields left out keep their value, and a text setting is cleared by naming it in unset. URLs are a path starting with / or an absolute http or https URL, and one over its limit is refused rather than cut short. The currency must be one the read lists. The order hash secret key cannot be changed here. Every field is checked before any is written. Send the advanced hash_sha256 you read as If-Match. dry_run reports the changes without saving. Always needs sfvb_publish, because the settings apply to shoppers as soon as they are saved. The admin saves the whole tab, so a merchant with it open can still overwrite a change made here.
12606
+
12607
+
12608
+ ### Examples
12609
+
12610
+
12611
+ (No example for this operation).
12612
+
12613
+
12614
+ #### Using the update_sfvb_tracking_advanced_with_http_info variant
12615
+
12616
+ This returns an Array which contains the response data, status code and headers.
12617
+
12618
+ > <Array(<SfvbTrackingSettingsResponse>, Integer, Hash)> update_sfvb_tracking_advanced_with_http_info(storefront_oid, if_match, tracking_advanced_request)
12619
+
12620
+ ```ruby
12621
+ begin
12622
+ # Change a storefront's advanced conversion settings
12623
+ data, status_code, headers = api_instance.update_sfvb_tracking_advanced_with_http_info(storefront_oid, if_match, tracking_advanced_request)
12624
+ p status_code # => 2xx
12625
+ p headers # => { ... }
12626
+ p data # => <SfvbTrackingSettingsResponse>
12627
+ rescue UltracartClient::ApiError => e
12628
+ puts "Error when calling SfvbApi->update_sfvb_tracking_advanced_with_http_info: #{e}"
12629
+ end
12630
+ ```
12631
+
12632
+ ### Parameters
12633
+
12634
+ | Name | Type | Description | Notes |
12635
+ | ---- | ---- | ----------- | ----- |
12636
+ | **storefront_oid** | **Integer** | | |
12637
+ | **if_match** | **String** | The advanced hash_sha256 from the last read. 428 when absent, 412 when stale. | |
12638
+ | **tracking_advanced_request** | [**SfvbTrackingAdvancedRequest**](SfvbTrackingAdvancedRequest.md) | The settings to change | |
12639
+
12640
+ ### Return type
12641
+
12642
+ [**SfvbTrackingSettingsResponse**](SfvbTrackingSettingsResponse.md)
12643
+
12644
+ ### Authorization
12645
+
12646
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12647
+
12648
+ ### HTTP request headers
12649
+
12650
+ - **Content-Type**: application/json; charset=UTF-8
12651
+ - **Accept**: application/json
12652
+
12653
+
12654
+ ## update_sfvb_tracking_html
12655
+
12656
+ > <SfvbTrackingHtml> update_sfvb_tracking_html(storefront_oid, slot, if_match, tracking_html_request, opts)
12657
+
12658
+ Write one custom tracking HTML slot
12659
+
12660
+ Replaces the whole slot, at most 256 KB. Content the storefront's templates may not use is refused with its lines. Send the slot's hash_sha256 as If-Match. Needs sfvb_publish. Any HTML but an empty string needs an approved tracking_html.put request for exactly this content (Approval-Id), which UltraCart reviews first. An empty string empties the slot without one. dry_run says whether the write needs one, without saving.
12661
+
12662
+
12663
+ ### Examples
12664
+
12665
+
12666
+ (No example for this operation).
12667
+
12668
+
12669
+ #### Using the update_sfvb_tracking_html_with_http_info variant
12670
+
12671
+ This returns an Array which contains the response data, status code and headers.
12672
+
12673
+ > <Array(<SfvbTrackingHtml>, Integer, Hash)> update_sfvb_tracking_html_with_http_info(storefront_oid, slot, if_match, tracking_html_request, opts)
12674
+
12675
+ ```ruby
12676
+ begin
12677
+ # Write one custom tracking HTML slot
12678
+ data, status_code, headers = api_instance.update_sfvb_tracking_html_with_http_info(storefront_oid, slot, if_match, tracking_html_request, opts)
12679
+ p status_code # => 2xx
12680
+ p headers # => { ... }
12681
+ p data # => <SfvbTrackingHtml>
12682
+ rescue UltracartClient::ApiError => e
12683
+ puts "Error when calling SfvbApi->update_sfvb_tracking_html_with_http_info: #{e}"
12684
+ end
12685
+ ```
12686
+
12687
+ ### Parameters
12688
+
12689
+ | Name | Type | Description | Notes |
12690
+ | ---- | ---- | ----------- | ----- |
12691
+ | **storefront_oid** | **Integer** | | |
12692
+ | **slot** | **String** | tracking or conversion | |
12693
+ | **if_match** | **String** | The slot&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
12694
+ | **tracking_html_request** | [**SfvbTrackingHtmlRequest**](SfvbTrackingHtmlRequest.md) | The content | |
12695
+ | **approval_id** | **String** | For any content but an empty string, the approval_id of an approved tracking_html.put request for exactly this content. See POST /sfvb/approvals. | [optional] |
12696
+
12697
+ ### Return type
12698
+
12699
+ [**SfvbTrackingHtml**](SfvbTrackingHtml.md)
12700
+
12701
+ ### Authorization
12702
+
12703
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12704
+
12705
+ ### HTTP request headers
12706
+
12707
+ - **Content-Type**: application/json; charset=UTF-8
12708
+ - **Accept**: application/json
12709
+
12710
+
12711
+ ## update_sfvb_tracking_privacy
12712
+
12713
+ > <SfvbTrackingSettingsResponse> update_sfvb_tracking_privacy(storefront_oid, if_match, tracking_privacy_request)
12714
+
12715
+ Change a storefront's privacy rules
12716
+
12717
+ A partial update. Each rule named is set to all, eea, non_us or off, and rules left out keep their value. Every rule is checked before any is written. Send the privacy hash_sha256 you read as If-Match. dry_run reports the changes without saving. Always needs sfvb_publish, because the rules apply to shoppers as soon as they are saved. The admin saves the whole tab, so a merchant with it open can still overwrite a change made here.
12718
+
12719
+
12720
+ ### Examples
12721
+
12722
+
12723
+ (No example for this operation).
12724
+
12725
+
12726
+ #### Using the update_sfvb_tracking_privacy_with_http_info variant
12727
+
12728
+ This returns an Array which contains the response data, status code and headers.
12729
+
12730
+ > <Array(<SfvbTrackingSettingsResponse>, Integer, Hash)> update_sfvb_tracking_privacy_with_http_info(storefront_oid, if_match, tracking_privacy_request)
12731
+
12732
+ ```ruby
12733
+ begin
12734
+ # Change a storefront's privacy rules
12735
+ data, status_code, headers = api_instance.update_sfvb_tracking_privacy_with_http_info(storefront_oid, if_match, tracking_privacy_request)
12736
+ p status_code # => 2xx
12737
+ p headers # => { ... }
12738
+ p data # => <SfvbTrackingSettingsResponse>
12739
+ rescue UltracartClient::ApiError => e
12740
+ puts "Error when calling SfvbApi->update_sfvb_tracking_privacy_with_http_info: #{e}"
12741
+ end
12742
+ ```
12743
+
12744
+ ### Parameters
12745
+
12746
+ | Name | Type | Description | Notes |
12747
+ | ---- | ---- | ----------- | ----- |
12748
+ | **storefront_oid** | **Integer** | | |
12749
+ | **if_match** | **String** | The privacy hash_sha256 from the last read. 428 when absent, 412 when stale. | |
12750
+ | **tracking_privacy_request** | [**SfvbTrackingPrivacyRequest**](SfvbTrackingPrivacyRequest.md) | The rules to change | |
12751
+
12752
+ ### Return type
12753
+
12754
+ [**SfvbTrackingSettingsResponse**](SfvbTrackingSettingsResponse.md)
12755
+
12756
+ ### Authorization
12757
+
12758
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12759
+
12760
+ ### HTTP request headers
12761
+
12762
+ - **Content-Type**: application/json; charset=UTF-8
12763
+ - **Accept**: application/json
12764
+
12765
+
12766
+ ## update_sfvb_tracking_provider
12767
+
12768
+ > <SfvbTrackingProvider> update_sfvb_tracking_provider(storefront_oid, provider, if_match, tracking_provider_request, opts)
12769
+
12770
+ Change one tracking provider
12771
+
12772
+ A partial update of the provider's fields, secrets (as secret handles), consent gate, events and, for google_analytics, wholesale account numbers. Every value is checked for its field's type before anything is written. Send the provider's hash_sha256 as If-Match. dry_run reports the changes without saving. Needs sfvb_publish. Turning the provider on, loosening its consent gate, or turning on Google Tag Gateway (which also needs accept_cost true) needs an approved tracking_provider.change request for exactly this change (Approval-Id). OAuth connections are made in the admin.
12773
+
12774
+
12775
+ ### Examples
12776
+
12777
+
12778
+ (No example for this operation).
12779
+
12780
+
12781
+ #### Using the update_sfvb_tracking_provider_with_http_info variant
12782
+
12783
+ This returns an Array which contains the response data, status code and headers.
12784
+
12785
+ > <Array(<SfvbTrackingProvider>, Integer, Hash)> update_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, tracking_provider_request, opts)
12786
+
12787
+ ```ruby
12788
+ begin
12789
+ # Change one tracking provider
12790
+ data, status_code, headers = api_instance.update_sfvb_tracking_provider_with_http_info(storefront_oid, provider, if_match, tracking_provider_request, opts)
12791
+ p status_code # => 2xx
12792
+ p headers # => { ... }
12793
+ p data # => <SfvbTrackingProvider>
12794
+ rescue UltracartClient::ApiError => e
12795
+ puts "Error when calling SfvbApi->update_sfvb_tracking_provider_with_http_info: #{e}"
12796
+ end
12797
+ ```
12798
+
12799
+ ### Parameters
12800
+
12801
+ | Name | Type | Description | Notes |
12802
+ | ---- | ---- | ----------- | ----- |
12803
+ | **storefront_oid** | **Integer** | | |
12804
+ | **provider** | **String** | | |
12805
+ | **if_match** | **String** | The provider&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
12806
+ | **tracking_provider_request** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) | The change | |
12807
+ | **approval_id** | **String** | When the change turns the provider on, loosens its consent gate or turns on Google Tag Gateway, the approval_id of an approved tracking_provider.change request for this change. See POST /sfvb/approvals. | [optional] |
12808
+
12809
+ ### Return type
12810
+
12811
+ [**SfvbTrackingProvider**](SfvbTrackingProvider.md)
12812
+
12813
+ ### Authorization
12814
+
12815
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12816
+
12817
+ ### HTTP request headers
12818
+
12819
+ - **Content-Type**: application/json; charset=UTF-8
12820
+ - **Accept**: application/json
12821
+
12822
+
11543
12823
  ## update_sfvb_upsell_offer
11544
12824
 
11545
12825
  > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)
@@ -11652,6 +12932,62 @@ end
11652
12932
  - **Accept**: application/json
11653
12933
 
11654
12934
 
12935
+ ## update_sfvb_utm_shortcode
12936
+
12937
+ > <SfvbUtmShortcode> update_sfvb_utm_shortcode(storefront_oid, shortcode_oid, if_match, utm_shortcode_request)
12938
+
12939
+ Change a UTM shortcode
12940
+
12941
+ A partial update. Fields left out keep their value, and an empty string clears a value. A changed code is checked like a new one. The creation date is kept. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, because links already in emails and ads that use the code are attributed differently from now on.
12942
+
12943
+
12944
+ ### Examples
12945
+
12946
+
12947
+ (No example for this operation).
12948
+
12949
+
12950
+ #### Using the update_sfvb_utm_shortcode_with_http_info variant
12951
+
12952
+ This returns an Array which contains the response data, status code and headers.
12953
+
12954
+ > <Array(<SfvbUtmShortcode>, Integer, Hash)> update_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid, if_match, utm_shortcode_request)
12955
+
12956
+ ```ruby
12957
+ begin
12958
+ # Change a UTM shortcode
12959
+ data, status_code, headers = api_instance.update_sfvb_utm_shortcode_with_http_info(storefront_oid, shortcode_oid, if_match, utm_shortcode_request)
12960
+ p status_code # => 2xx
12961
+ p headers # => { ... }
12962
+ p data # => <SfvbUtmShortcode>
12963
+ rescue UltracartClient::ApiError => e
12964
+ puts "Error when calling SfvbApi->update_sfvb_utm_shortcode_with_http_info: #{e}"
12965
+ end
12966
+ ```
12967
+
12968
+ ### Parameters
12969
+
12970
+ | Name | Type | Description | Notes |
12971
+ | ---- | ---- | ----------- | ----- |
12972
+ | **storefront_oid** | **Integer** | | |
12973
+ | **shortcode_oid** | **Integer** | | |
12974
+ | **if_match** | **String** | The shortcode&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale. | |
12975
+ | **utm_shortcode_request** | [**SfvbUtmShortcodeRequest**](SfvbUtmShortcodeRequest.md) | The change | |
12976
+
12977
+ ### Return type
12978
+
12979
+ [**SfvbUtmShortcode**](SfvbUtmShortcode.md)
12980
+
12981
+ ### Authorization
12982
+
12983
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
12984
+
12985
+ ### HTTP request headers
12986
+
12987
+ - **Content-Type**: application/json; charset=UTF-8
12988
+ - **Accept**: application/json
12989
+
12990
+
11655
12991
  ## upload_sfvb_file
11656
12992
 
11657
12993
  > <SfvbFileWriteResponse> upload_sfvb_file(storefront_oid, file_upload_request, opts)