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/SfvbTrackingProviderSecrets.md ADDED
@@ -0,0 +1,46 @@
1
+ # UltracartClient::SfvbTrackingProviderSecrets
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **attentive_private_api_key** | **String** | Attentive SMS Private API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.attentive.private_api_key, or an empty string to clear it. | [optional] |
8
+ | **awin_conversion_api_key** | **String** | Awin Conversion API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.awin.conversion_api_key, or an empty string to clear it. | [optional] |
9
+ | **axon_conversion_api_key** | **String** | AppLovin / Axon Conversion API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.axon.conversion_api_key, or an empty string to clear it. | [optional] |
10
+ | **converge_webhook_token** | **String** | Converge Webhook Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.converge.webhook_token, or an empty string to clear it. | [optional] |
11
+ | **customerio_write_key** | **String** | customer.io Write Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.customerio.write_key, or an empty string to clear it. | [optional] |
12
+ | **facebook_server_side_access_token** | **String** | Facebook Server Side Access Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.facebook.capi_access_token, or an empty string to clear it. | [optional] |
13
+ | **ga4_api_secret** | **String** | Google Analytics GA4 Api Secret. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.ga4.api_secret, or an empty string to clear it. | [optional] |
14
+ | **hyros_api_key** | **String** | Hyros API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.hyros.api_key, or an empty string to clear it. | [optional] |
15
+ | **kissmetrics_api_key** | **String** | KISSmetrics API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.kissmetrics.api_key, or an empty string to clear it. | [optional] |
16
+ | **klaviyo_private_api_key** | **String** | Klaviyo API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.klaviyo.private_api_key, or an empty string to clear it. | [optional] |
17
+ | **nextdoor_access_token** | **String** | Nextdoor Access Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.nextdoor.access_token, or an empty string to clear it. | [optional] |
18
+ | **northbeam_api_key** | **String** | Northbeam API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.northbeam.api_key, or an empty string to clear it. | [optional] |
19
+ | **pinterest_token** | **String** | Pinterest Conversion Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.pinterest.capi_token, or an empty string to clear it. | [optional] |
20
+ | **referralcandy_secret_key** | **String** | ReferralCandy Secret Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.referralcandy.secret_key, or an empty string to clear it. | [optional] |
21
+ | **retention_key** | **String** | Retention.com Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.retention.api_key, or an empty string to clear it. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'ultracart_api'
27
+
28
+ instance = UltracartClient::SfvbTrackingProviderSecrets.new(
29
+ attentive_private_api_key: null,
30
+ awin_conversion_api_key: null,
31
+ axon_conversion_api_key: null,
32
+ converge_webhook_token: null,
33
+ customerio_write_key: null,
34
+ facebook_server_side_access_token: null,
35
+ ga4_api_secret: null,
36
+ hyros_api_key: null,
37
+ kissmetrics_api_key: null,
38
+ klaviyo_private_api_key: null,
39
+ nextdoor_access_token: null,
40
+ northbeam_api_key: null,
41
+ pinterest_token: null,
42
+ referralcandy_secret_key: null,
43
+ retention_key: null
44
+ )
45
+ ```
46
+
data/docs/SfvbTrackingProvidersResponse.md ADDED
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbTrackingProvidersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **catalog_version** | **Integer** | Bumped whenever a provider or field is added, removed or renamed. | [optional] |
8
+ | **providers** | [**Array<SfvbTrackingProvider>**](SfvbTrackingProvider.md) | Every provider, Google first, in the order the admin shows them. | [optional] |
9
+ | **storefront_oid** | **Integer** | The storefront. Also the target_id of a secret request for a provider secret. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbTrackingProvidersResponse.new(
17
+ catalog_version: null,
18
+ providers: null,
19
+ storefront_oid: null
20
+ )
21
+ ```
22
+
data/docs/SfvbTrackingSettingsResponse.md ADDED
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbTrackingSettingsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **advanced** | [**SfvbTrackingAdvanced**](SfvbTrackingAdvanced.md) | | [optional] |
8
+ | **changes** | [**Array<SfvbTrackingChange>**](SfvbTrackingChange.md) | On a write, each setting it changed, or would change on a dry run. Empty when nothing changed. Absent on a read. | [optional] |
9
+ | **currencies** | **Array<String>** | The currency codes default_currency accepts. | [optional] |
10
+ | **dry_run** | **Boolean** | On a write, true when nothing was saved. Absent on a read. | [optional] |
11
+ | **privacy** | [**SfvbTrackingPrivacy**](SfvbTrackingPrivacy.md) | | [optional] |
12
+ | **storefront_oid** | **Integer** | The storefront these settings belong to. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbTrackingSettingsResponse.new(
20
+ advanced: null,
21
+ changes: null,
22
+ currencies: null,
23
+ dry_run: null,
24
+ privacy: null,
25
+ storefront_oid: null
26
+ )
27
+ ```
28
+
data/docs/SfvbTrackingWholesaleTier.md ADDED
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbTrackingWholesaleTier
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_number** | **String** | The account number for shoppers in this tier, up to 20 characters. Null or an empty string uses the default. | [optional] |
8
+ | **name** | **String** | The pricing tier's name. Set by the server. | [optional] |
9
+ | **pricing_tier_oid** | **Integer** | The pricing tier. One of the account's non-default tiers. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbTrackingWholesaleTier.new(
17
+ account_number: null,
18
+ name: null,
19
+ pricing_tier_oid: null
20
+ )
21
+ ```
22
+
data/docs/SfvbUtmShortcode.md ADDED
@@ -0,0 +1,56 @@
1
+ # UltracartClient::SfvbUtmShortcode
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | The shortcode. Matched ignoring case. | [optional] |
8
+ | **creation_dts** | **String** | When the shortcode was created, ISO 8601. | [optional] |
9
+ | **description** | **String** | What the shortcode is for. Null when blank. | [optional] |
10
+ | **hash_sha256** | **String** | The hash of the code, description and values. Send it as If-Match when changing or deleting the shortcode. | [optional] |
11
+ | **itm_campaign** | **String** | ITM campaign the shortcode applies. Null when blank. | [optional] |
12
+ | **itm_content** | **String** | ITM content the shortcode applies. Null when blank. | [optional] |
13
+ | **itm_id** | **String** | ITM id the shortcode applies. Null when blank. | [optional] |
14
+ | **itm_medium** | **String** | ITM medium the shortcode applies. Null when blank. | [optional] |
15
+ | **itm_source** | **String** | ITM (internal tracking) source the shortcode applies. Null when blank. | [optional] |
16
+ | **itm_term** | **String** | ITM term the shortcode applies. Null when blank. | [optional] |
17
+ | **last_modified_dts** | **String** | When the shortcode last changed, ISO 8601. | [optional] |
18
+ | **path_segment** | **String** | Append this to a storefront path (as its last segment) to apply the shortcode. Fires only where that full path is not itself a page. | [optional] |
19
+ | **query_parameter** | **String** | Add this query parameter to a link on any page running UC Analytics, including other sites, to apply the shortcode. | [optional] |
20
+ | **shortcode_oid** | **Integer** | The shortcode's id on this storefront. | [optional] |
21
+ | **utm_campaign** | **String** | UTM campaign the shortcode applies. Null when blank. | [optional] |
22
+ | **utm_content** | **String** | UTM content the shortcode applies. Null when blank. | [optional] |
23
+ | **utm_id** | **String** | UTM id the shortcode applies. Null when blank. | [optional] |
24
+ | **utm_medium** | **String** | UTM medium the shortcode applies. Null when blank. | [optional] |
25
+ | **utm_source** | **String** | UTM source the shortcode applies. Null when blank. | [optional] |
26
+ | **utm_term** | **String** | UTM term the shortcode applies. Null when blank. | [optional] |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'ultracart_api'
32
+
33
+ instance = UltracartClient::SfvbUtmShortcode.new(
34
+ code: null,
35
+ creation_dts: null,
36
+ description: null,
37
+ hash_sha256: null,
38
+ itm_campaign: null,
39
+ itm_content: null,
40
+ itm_id: null,
41
+ itm_medium: null,
42
+ itm_source: null,
43
+ itm_term: null,
44
+ last_modified_dts: null,
45
+ path_segment: null,
46
+ query_parameter: null,
47
+ shortcode_oid: null,
48
+ utm_campaign: null,
49
+ utm_content: null,
50
+ utm_id: null,
51
+ utm_medium: null,
52
+ utm_source: null,
53
+ utm_term: null
54
+ )
55
+ ```
56
+
data/docs/SfvbUtmShortcodeRequest.md ADDED
@@ -0,0 +1,44 @@
1
+ # UltracartClient::SfvbUtmShortcodeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | The shortcode. Letters, digits, underscore and hyphen, 1 to 50 characters. Required on create. | [optional] |
8
+ | **description** | **String** | What the shortcode is for, up to 250 characters. An empty string clears it. | [optional] |
9
+ | **itm_campaign** | **String** | ITM campaign, up to 100 characters. An empty string clears it. | [optional] |
10
+ | **itm_content** | **String** | ITM content, up to 100 characters. An empty string clears it. | [optional] |
11
+ | **itm_id** | **String** | ITM id, up to 100 characters. An empty string clears it. | [optional] |
12
+ | **itm_medium** | **String** | ITM medium, up to 100 characters. An empty string clears it. | [optional] |
13
+ | **itm_source** | **String** | ITM (internal tracking) source, up to 100 characters. An empty string clears it. | [optional] |
14
+ | **itm_term** | **String** | ITM term, up to 100 characters. An empty string clears it. | [optional] |
15
+ | **utm_campaign** | **String** | UTM campaign, up to 100 characters. An empty string clears it. | [optional] |
16
+ | **utm_content** | **String** | UTM content, up to 100 characters. An empty string clears it. | [optional] |
17
+ | **utm_id** | **String** | UTM id, up to 100 characters. An empty string clears it. | [optional] |
18
+ | **utm_medium** | **String** | UTM medium, up to 100 characters. An empty string clears it. | [optional] |
19
+ | **utm_source** | **String** | UTM source, up to 100 characters. An empty string clears it. | [optional] |
20
+ | **utm_term** | **String** | UTM term, up to 100 characters. An empty string clears it. | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'ultracart_api'
26
+
27
+ instance = UltracartClient::SfvbUtmShortcodeRequest.new(
28
+ code: null,
29
+ description: null,
30
+ itm_campaign: null,
31
+ itm_content: null,
32
+ itm_id: null,
33
+ itm_medium: null,
34
+ itm_source: null,
35
+ itm_term: null,
36
+ utm_campaign: null,
37
+ utm_content: null,
38
+ utm_id: null,
39
+ utm_medium: null,
40
+ utm_source: null,
41
+ utm_term: null
42
+ )
43
+ ```
44
+
data/docs/SfvbUtmShortcodesResponse.md ADDED
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbUtmShortcodesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **count** | **Integer** | How many shortcodes are listed. | [optional] |
8
+ | **limit** | **Integer** | The most shortcodes the API will create on one storefront. | [optional] |
9
+ | **shortcodes** | [**Array<SfvbUtmShortcode>**](SfvbUtmShortcode.md) | Every live shortcode, sorted by code. | [optional] |
10
+ | **storefront_oid** | **Integer** | The storefront the shortcodes belong to. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbUtmShortcodesResponse.new(
18
+ count: null,
19
+ limit: null,
20
+ shortcodes: null,
21
+ storefront_oid: null
22
+ )
23
+ ```
24
+