ultracart_api 4.1.227 → 4.1.229
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +21 -2
- data/docs/SfvbApi.md +445 -0
- data/docs/SfvbApprovalCreateRequest.md +2 -0
- data/docs/SfvbBlogPostDetail.md +2 -0
- data/docs/SfvbBlogPostRequest.md +2 -0
- data/docs/SfvbNotFoundEntry.md +2 -0
- data/docs/SfvbNotFoundSummary.md +28 -0
- data/docs/SfvbRedirectImportRow.md +2 -0
- data/docs/SfvbRedirectRequest.md +2 -0
- data/docs/SfvbRedirectResolveBatchRequest.md +18 -0
- data/docs/SfvbRedirectResolveBatchResponse.md +24 -0
- data/docs/SfvbSiteSeo.md +40 -0
- data/docs/SfvbSiteSeoChange.md +26 -0
- data/docs/SfvbSiteSeoRequest.md +24 -0
- data/docs/SfvbStepCounts.md +34 -0
- data/docs/SfvbStepDispatchLog.md +22 -0
- data/docs/SfvbStepDispatchLogsResponse.md +32 -0
- data/lib/ultracart_api/api/sfvb_api.rb +583 -0
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
- data/lib/ultracart_api/models/sfvb_blog_post_detail.rb +11 -1
- data/lib/ultracart_api/models/sfvb_blog_post_request.rb +11 -1
- data/lib/ultracart_api/models/sfvb_not_found_entry.rb +11 -1
- data/lib/ultracart_api/models/sfvb_not_found_summary.rb +280 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +11 -1
- data/lib/ultracart_api/models/sfvb_redirect_request.rb +11 -1
- data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb +252 -0
- data/lib/ultracart_api/models/sfvb_site_seo.rb +334 -0
- data/lib/ultracart_api/models/sfvb_site_seo_change.rb +260 -0
- data/lib/ultracart_api/models/sfvb_site_seo_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_step_counts.rb +300 -0
- data/lib/ultracart_api/models/sfvb_step_dispatch_log.rb +240 -0
- data/lib/ultracart_api/models/sfvb_step_dispatch_logs_response.rb +293 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +9 -0
- metadata +19 -1
data/docs/SfvbApi.md
CHANGED
|
@@ -29,6 +29,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
29
29
|
| [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
|
|
30
30
|
| [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
|
|
31
31
|
| [**delete_sfvb_library_entry**](SfvbApi.md#delete_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Delete or retire a library entry |
|
|
32
|
+
| [**delete_sfvb_not_found_entry**](SfvbApi.md#delete_sfvb_not_found_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id} | Remove a 404 path from the log |
|
|
32
33
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
33
34
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
34
35
|
| [**delete_sfvb_redirect**](SfvbApi.md#delete_sfvb_redirect) | **DELETE** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Delete a redirect rule |
|
|
@@ -56,7 +57,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
56
57
|
| [**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 |
|
|
57
58
|
| [**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 |
|
|
58
59
|
| [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
|
|
60
|
+
| [**export_sfvb_not_found**](SfvbApi.md#export_sfvb_not_found) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/export | Export the open 404 paths |
|
|
59
61
|
| [**favorite_sfvb_library_entry**](SfvbApi.md#favorite_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/favorite | Favorite a library entry |
|
|
62
|
+
| [**fix_sfvb_not_found_entry**](SfvbApi.md#fix_sfvb_not_found_entry) | **POST** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/fixed | Mark a 404 path fixed |
|
|
60
63
|
| [**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
64
|
| [**get_sfvb_affiliate_networks**](SfvbApi.md#get_sfvb_affiliate_networks) | **GET** /sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks | List a storefront's affiliate networks |
|
|
62
65
|
| [**get_sfvb_approval**](SfvbApi.md#get_sfvb_approval) | **GET** /sfvb/approvals/{approval_id} | Read one approval request |
|
|
@@ -96,6 +99,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
96
99
|
| [**get_sfvb_not_found**](SfvbApi.md#get_sfvb_not_found) | **GET** /sfvb/storefronts/{storefront_oid}/not_found | List the paths that answered 404 |
|
|
97
100
|
| [**get_sfvb_not_found_entry**](SfvbApi.md#get_sfvb_not_found_entry) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/{not_found_id} | Read one 404 path with its recent hits |
|
|
98
101
|
| [**get_sfvb_not_found_page**](SfvbApi.md#get_sfvb_not_found_page) | **GET** /sfvb/storefronts/{storefront_oid}/not_found_page | What renders the storefront's 404 page |
|
|
102
|
+
| [**get_sfvb_not_found_summary**](SfvbApi.md#get_sfvb_not_found_summary) | **GET** /sfvb/storefronts/{storefront_oid}/not_found/summary | The 404 log's trend |
|
|
99
103
|
| [**get_sfvb_page**](SfvbApi.md#get_sfvb_page) | **GET** /sfvb/storefronts/{storefront_oid}/pages | Read a page's attributes and images |
|
|
100
104
|
| [**get_sfvb_page_blog_posts**](SfvbApi.md#get_sfvb_page_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/pages/blog_posts | Read the blog posts assigned to a page |
|
|
101
105
|
| [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
|
|
@@ -110,8 +114,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
110
114
|
| [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
|
|
111
115
|
| [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
|
|
112
116
|
| [**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 |
|
|
117
|
+
| [**get_sfvb_sequence_step_dispatch_logs**](SfvbApi.md#get_sfvb_sequence_step_dispatch_logs) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs | Read a flow or campaign step's dispatch log and counts |
|
|
113
118
|
| [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
|
|
114
119
|
| [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
|
|
120
|
+
| [**get_sfvb_site_seo**](SfvbApi.md#get_sfvb_site_seo) | **GET** /sfvb/storefronts/{storefront_oid}/seo | Read a storefront's search engine settings |
|
|
115
121
|
| [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
|
|
116
122
|
| [**get_sfvb_smart_attribution**](SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration |
|
|
117
123
|
| [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
|
|
@@ -202,6 +208,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
202
208
|
| [**reserve_sfvb_widget_ids**](SfvbApi.md#reserve_sfvb_widget_ids) | **POST** /sfvb/storefronts/{storefront_oid}/widget_ids | Reserve a block of widget ids |
|
|
203
209
|
| [**reset_sfvb_i18n_message**](SfvbApi.md#reset_sfvb_i18n_message) | **DELETE** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Reset one built-in message |
|
|
204
210
|
| [**resolve_sfvb_redirect**](SfvbApi.md#resolve_sfvb_redirect) | **GET** /sfvb/storefronts/{storefront_oid}/redirects/resolve | What a shopper gets for a path |
|
|
211
|
+
| [**resolve_sfvb_redirect_batch**](SfvbApi.md#resolve_sfvb_redirect_batch) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/resolve_batch | What a shopper gets for each of many paths |
|
|
205
212
|
| [**resolve_sfvb_template**](SfvbApi.md#resolve_sfvb_template) | **GET** /sfvb/storefronts/{storefront_oid}/templates/resolve | Resolve a template name to the file a page renders |
|
|
206
213
|
| [**revert_sfvb_container**](SfvbApi.md#revert_sfvb_container) | **POST** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id}/revert | Revert a container stored outside the file system |
|
|
207
214
|
| [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
|
|
@@ -230,6 +237,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
230
237
|
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
231
238
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
232
239
|
| [**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 |
|
|
240
|
+
| [**update_sfvb_site_seo**](SfvbApi.md#update_sfvb_site_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/seo | Change a storefront's search engine settings |
|
|
233
241
|
| [**update_sfvb_smart_attribution**](SfvbApi.md#update_sfvb_smart_attribution) | **PUT** /sfvb/storefronts/{storefront_oid}/smart_attribution | Change a storefront's Smart Attribution configuration |
|
|
234
242
|
| [**update_sfvb_tracking_advanced**](SfvbApi.md#update_sfvb_tracking_advanced) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/advanced | Change a storefront's advanced conversion settings |
|
|
235
243
|
| [**update_sfvb_tracking_html**](SfvbApi.md#update_sfvb_tracking_html) | **PUT** /sfvb/storefronts/{storefront_oid}/tracking/html/{slot} | Write one custom tracking HTML slot |
|
|
@@ -1608,6 +1616,60 @@ end
|
|
|
1608
1616
|
- **Accept**: application/json
|
|
1609
1617
|
|
|
1610
1618
|
|
|
1619
|
+
## delete_sfvb_not_found_entry
|
|
1620
|
+
|
|
1621
|
+
> delete_sfvb_not_found_entry(storefront_oid, not_found_id)
|
|
1622
|
+
|
|
1623
|
+
Remove a 404 path from the log
|
|
1624
|
+
|
|
1625
|
+
The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
### Examples
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
(No example for this operation).
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
#### Using the delete_sfvb_not_found_entry_with_http_info variant
|
|
1635
|
+
|
|
1636
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1637
|
+
|
|
1638
|
+
> <Array(nil, Integer, Hash)> delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
1639
|
+
|
|
1640
|
+
```ruby
|
|
1641
|
+
begin
|
|
1642
|
+
# Remove a 404 path from the log
|
|
1643
|
+
data, status_code, headers = api_instance.delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
1644
|
+
p status_code # => 2xx
|
|
1645
|
+
p headers # => { ... }
|
|
1646
|
+
p data # => nil
|
|
1647
|
+
rescue UltracartClient::ApiError => e
|
|
1648
|
+
puts "Error when calling SfvbApi->delete_sfvb_not_found_entry_with_http_info: #{e}"
|
|
1649
|
+
end
|
|
1650
|
+
```
|
|
1651
|
+
|
|
1652
|
+
### Parameters
|
|
1653
|
+
|
|
1654
|
+
| Name | Type | Description | Notes |
|
|
1655
|
+
| ---- | ---- | ----------- | ----- |
|
|
1656
|
+
| **storefront_oid** | **Integer** | | |
|
|
1657
|
+
| **not_found_id** | **String** | | |
|
|
1658
|
+
|
|
1659
|
+
### Return type
|
|
1660
|
+
|
|
1661
|
+
nil (empty response body)
|
|
1662
|
+
|
|
1663
|
+
### Authorization
|
|
1664
|
+
|
|
1665
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1666
|
+
|
|
1667
|
+
### HTTP request headers
|
|
1668
|
+
|
|
1669
|
+
- **Content-Type**: Not defined
|
|
1670
|
+
- **Accept**: application/json
|
|
1671
|
+
|
|
1672
|
+
|
|
1611
1673
|
## delete_sfvb_page_multimedia
|
|
1612
1674
|
|
|
1613
1675
|
> <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
|
|
@@ -3085,6 +3147,61 @@ end
|
|
|
3085
3147
|
- **Accept**: application/json
|
|
3086
3148
|
|
|
3087
3149
|
|
|
3150
|
+
## export_sfvb_not_found
|
|
3151
|
+
|
|
3152
|
+
> <SfvbNotFoundResponse> export_sfvb_not_found(storefront_oid, opts)
|
|
3153
|
+
|
|
3154
|
+
Export the open 404 paths
|
|
3155
|
+
|
|
3156
|
+
Up to 5,000 open paths, most hits first, as the admin's mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
3157
|
+
|
|
3158
|
+
|
|
3159
|
+
### Examples
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
(No example for this operation).
|
|
3163
|
+
|
|
3164
|
+
|
|
3165
|
+
#### Using the export_sfvb_not_found_with_http_info variant
|
|
3166
|
+
|
|
3167
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3168
|
+
|
|
3169
|
+
> <Array(<SfvbNotFoundResponse>, Integer, Hash)> export_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
3170
|
+
|
|
3171
|
+
```ruby
|
|
3172
|
+
begin
|
|
3173
|
+
# Export the open 404 paths
|
|
3174
|
+
data, status_code, headers = api_instance.export_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
3175
|
+
p status_code # => 2xx
|
|
3176
|
+
p headers # => { ... }
|
|
3177
|
+
p data # => <SfvbNotFoundResponse>
|
|
3178
|
+
rescue UltracartClient::ApiError => e
|
|
3179
|
+
puts "Error when calling SfvbApi->export_sfvb_not_found_with_http_info: #{e}"
|
|
3180
|
+
end
|
|
3181
|
+
```
|
|
3182
|
+
|
|
3183
|
+
### Parameters
|
|
3184
|
+
|
|
3185
|
+
| Name | Type | Description | Notes |
|
|
3186
|
+
| ---- | ---- | ----------- | ----- |
|
|
3187
|
+
| **storefront_oid** | **Integer** | | |
|
|
3188
|
+
| **include_bots** | **Boolean** | | [optional] |
|
|
3189
|
+
| **include_tokens** | **Boolean** | | [optional] |
|
|
3190
|
+
|
|
3191
|
+
### Return type
|
|
3192
|
+
|
|
3193
|
+
[**SfvbNotFoundResponse**](SfvbNotFoundResponse.md)
|
|
3194
|
+
|
|
3195
|
+
### Authorization
|
|
3196
|
+
|
|
3197
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3198
|
+
|
|
3199
|
+
### HTTP request headers
|
|
3200
|
+
|
|
3201
|
+
- **Content-Type**: Not defined
|
|
3202
|
+
- **Accept**: application/json
|
|
3203
|
+
|
|
3204
|
+
|
|
3088
3205
|
## favorite_sfvb_library_entry
|
|
3089
3206
|
|
|
3090
3207
|
> favorite_sfvb_library_entry(storefront_oid, library_oid)
|
|
@@ -3139,6 +3256,60 @@ nil (empty response body)
|
|
|
3139
3256
|
- **Accept**: application/json
|
|
3140
3257
|
|
|
3141
3258
|
|
|
3259
|
+
## fix_sfvb_not_found_entry
|
|
3260
|
+
|
|
3261
|
+
> <SfvbNotFoundEntry> fix_sfvb_not_found_entry(storefront_oid, not_found_id)
|
|
3262
|
+
|
|
3263
|
+
Mark a 404 path fixed
|
|
3264
|
+
|
|
3265
|
+
For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin's Mark Fixed.
|
|
3266
|
+
|
|
3267
|
+
|
|
3268
|
+
### Examples
|
|
3269
|
+
|
|
3270
|
+
|
|
3271
|
+
(No example for this operation).
|
|
3272
|
+
|
|
3273
|
+
|
|
3274
|
+
#### Using the fix_sfvb_not_found_entry_with_http_info variant
|
|
3275
|
+
|
|
3276
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3277
|
+
|
|
3278
|
+
> <Array(<SfvbNotFoundEntry>, Integer, Hash)> fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
3279
|
+
|
|
3280
|
+
```ruby
|
|
3281
|
+
begin
|
|
3282
|
+
# Mark a 404 path fixed
|
|
3283
|
+
data, status_code, headers = api_instance.fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id)
|
|
3284
|
+
p status_code # => 2xx
|
|
3285
|
+
p headers # => { ... }
|
|
3286
|
+
p data # => <SfvbNotFoundEntry>
|
|
3287
|
+
rescue UltracartClient::ApiError => e
|
|
3288
|
+
puts "Error when calling SfvbApi->fix_sfvb_not_found_entry_with_http_info: #{e}"
|
|
3289
|
+
end
|
|
3290
|
+
```
|
|
3291
|
+
|
|
3292
|
+
### Parameters
|
|
3293
|
+
|
|
3294
|
+
| Name | Type | Description | Notes |
|
|
3295
|
+
| ---- | ---- | ----------- | ----- |
|
|
3296
|
+
| **storefront_oid** | **Integer** | | |
|
|
3297
|
+
| **not_found_id** | **String** | | |
|
|
3298
|
+
|
|
3299
|
+
### Return type
|
|
3300
|
+
|
|
3301
|
+
[**SfvbNotFoundEntry**](SfvbNotFoundEntry.md)
|
|
3302
|
+
|
|
3303
|
+
### Authorization
|
|
3304
|
+
|
|
3305
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3306
|
+
|
|
3307
|
+
### HTTP request headers
|
|
3308
|
+
|
|
3309
|
+
- **Content-Type**: Not defined
|
|
3310
|
+
- **Accept**: application/json
|
|
3311
|
+
|
|
3312
|
+
|
|
3142
3313
|
## get_sfvb_affiliate_network
|
|
3143
3314
|
|
|
3144
3315
|
> <SfvbAffiliateNetwork> get_sfvb_affiliate_network(storefront_oid, affiliate_network_oid)
|
|
@@ -5244,6 +5415,59 @@ end
|
|
|
5244
5415
|
- **Accept**: application/json
|
|
5245
5416
|
|
|
5246
5417
|
|
|
5418
|
+
## get_sfvb_not_found_summary
|
|
5419
|
+
|
|
5420
|
+
> <SfvbNotFoundSummary> get_sfvb_not_found_summary(storefront_oid)
|
|
5421
|
+
|
|
5422
|
+
The 404 log's trend
|
|
5423
|
+
|
|
5424
|
+
The admin's 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
5425
|
+
|
|
5426
|
+
|
|
5427
|
+
### Examples
|
|
5428
|
+
|
|
5429
|
+
|
|
5430
|
+
(No example for this operation).
|
|
5431
|
+
|
|
5432
|
+
|
|
5433
|
+
#### Using the get_sfvb_not_found_summary_with_http_info variant
|
|
5434
|
+
|
|
5435
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5436
|
+
|
|
5437
|
+
> <Array(<SfvbNotFoundSummary>, Integer, Hash)> get_sfvb_not_found_summary_with_http_info(storefront_oid)
|
|
5438
|
+
|
|
5439
|
+
```ruby
|
|
5440
|
+
begin
|
|
5441
|
+
# The 404 log's trend
|
|
5442
|
+
data, status_code, headers = api_instance.get_sfvb_not_found_summary_with_http_info(storefront_oid)
|
|
5443
|
+
p status_code # => 2xx
|
|
5444
|
+
p headers # => { ... }
|
|
5445
|
+
p data # => <SfvbNotFoundSummary>
|
|
5446
|
+
rescue UltracartClient::ApiError => e
|
|
5447
|
+
puts "Error when calling SfvbApi->get_sfvb_not_found_summary_with_http_info: #{e}"
|
|
5448
|
+
end
|
|
5449
|
+
```
|
|
5450
|
+
|
|
5451
|
+
### Parameters
|
|
5452
|
+
|
|
5453
|
+
| Name | Type | Description | Notes |
|
|
5454
|
+
| ---- | ---- | ----------- | ----- |
|
|
5455
|
+
| **storefront_oid** | **Integer** | | |
|
|
5456
|
+
|
|
5457
|
+
### Return type
|
|
5458
|
+
|
|
5459
|
+
[**SfvbNotFoundSummary**](SfvbNotFoundSummary.md)
|
|
5460
|
+
|
|
5461
|
+
### Authorization
|
|
5462
|
+
|
|
5463
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5464
|
+
|
|
5465
|
+
### HTTP request headers
|
|
5466
|
+
|
|
5467
|
+
- **Content-Type**: Not defined
|
|
5468
|
+
- **Accept**: application/json
|
|
5469
|
+
|
|
5470
|
+
|
|
5247
5471
|
## get_sfvb_page
|
|
5248
5472
|
|
|
5249
5473
|
> <SfvbPageResponse> get_sfvb_page(storefront_oid, path)
|
|
@@ -5997,6 +6221,64 @@ end
|
|
|
5997
6221
|
- **Accept**: application/json
|
|
5998
6222
|
|
|
5999
6223
|
|
|
6224
|
+
## get_sfvb_sequence_step_dispatch_logs
|
|
6225
|
+
|
|
6226
|
+
> <SfvbStepDispatchLogsResponse> get_sfvb_sequence_step_dispatch_logs(storefront_oid, sequence_uuid, step_uuid, opts)
|
|
6227
|
+
|
|
6228
|
+
Read a flow or campaign step's dispatch log and counts
|
|
6229
|
+
|
|
6230
|
+
Why customers were sent, skipped or ended at this step, newest first, as the admin's Dispatch Logs screen shows it, with the step's counts. An email step's counts are its email's; any other step's are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
6231
|
+
|
|
6232
|
+
|
|
6233
|
+
### Examples
|
|
6234
|
+
|
|
6235
|
+
|
|
6236
|
+
(No example for this operation).
|
|
6237
|
+
|
|
6238
|
+
|
|
6239
|
+
#### Using the get_sfvb_sequence_step_dispatch_logs_with_http_info variant
|
|
6240
|
+
|
|
6241
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6242
|
+
|
|
6243
|
+
> <Array(<SfvbStepDispatchLogsResponse>, Integer, Hash)> get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts)
|
|
6244
|
+
|
|
6245
|
+
```ruby
|
|
6246
|
+
begin
|
|
6247
|
+
# Read a flow or campaign step's dispatch log and counts
|
|
6248
|
+
data, status_code, headers = api_instance.get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts)
|
|
6249
|
+
p status_code # => 2xx
|
|
6250
|
+
p headers # => { ... }
|
|
6251
|
+
p data # => <SfvbStepDispatchLogsResponse>
|
|
6252
|
+
rescue UltracartClient::ApiError => e
|
|
6253
|
+
puts "Error when calling SfvbApi->get_sfvb_sequence_step_dispatch_logs_with_http_info: #{e}"
|
|
6254
|
+
end
|
|
6255
|
+
```
|
|
6256
|
+
|
|
6257
|
+
### Parameters
|
|
6258
|
+
|
|
6259
|
+
| Name | Type | Description | Notes |
|
|
6260
|
+
| ---- | ---- | ----------- | ----- |
|
|
6261
|
+
| **storefront_oid** | **Integer** | | |
|
|
6262
|
+
| **sequence_uuid** | **String** | | |
|
|
6263
|
+
| **step_uuid** | **String** | | |
|
|
6264
|
+
| **since** | **String** | | [optional] |
|
|
6265
|
+
| **limit** | **Integer** | | [optional] |
|
|
6266
|
+
| **offset** | **Integer** | | [optional] |
|
|
6267
|
+
|
|
6268
|
+
### Return type
|
|
6269
|
+
|
|
6270
|
+
[**SfvbStepDispatchLogsResponse**](SfvbStepDispatchLogsResponse.md)
|
|
6271
|
+
|
|
6272
|
+
### Authorization
|
|
6273
|
+
|
|
6274
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6275
|
+
|
|
6276
|
+
### HTTP request headers
|
|
6277
|
+
|
|
6278
|
+
- **Content-Type**: Not defined
|
|
6279
|
+
- **Accept**: application/json
|
|
6280
|
+
|
|
6281
|
+
|
|
6000
6282
|
## get_sfvb_server_log
|
|
6001
6283
|
|
|
6002
6284
|
> <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
|
|
@@ -6105,6 +6387,59 @@ end
|
|
|
6105
6387
|
- **Accept**: application/json
|
|
6106
6388
|
|
|
6107
6389
|
|
|
6390
|
+
## get_sfvb_site_seo
|
|
6391
|
+
|
|
6392
|
+
> <SfvbSiteSeo> get_sfvb_site_seo(storefront_oid)
|
|
6393
|
+
|
|
6394
|
+
Read a storefront's search engine settings
|
|
6395
|
+
|
|
6396
|
+
Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
6397
|
+
|
|
6398
|
+
|
|
6399
|
+
### Examples
|
|
6400
|
+
|
|
6401
|
+
|
|
6402
|
+
(No example for this operation).
|
|
6403
|
+
|
|
6404
|
+
|
|
6405
|
+
#### Using the get_sfvb_site_seo_with_http_info variant
|
|
6406
|
+
|
|
6407
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6408
|
+
|
|
6409
|
+
> <Array(<SfvbSiteSeo>, Integer, Hash)> get_sfvb_site_seo_with_http_info(storefront_oid)
|
|
6410
|
+
|
|
6411
|
+
```ruby
|
|
6412
|
+
begin
|
|
6413
|
+
# Read a storefront's search engine settings
|
|
6414
|
+
data, status_code, headers = api_instance.get_sfvb_site_seo_with_http_info(storefront_oid)
|
|
6415
|
+
p status_code # => 2xx
|
|
6416
|
+
p headers # => { ... }
|
|
6417
|
+
p data # => <SfvbSiteSeo>
|
|
6418
|
+
rescue UltracartClient::ApiError => e
|
|
6419
|
+
puts "Error when calling SfvbApi->get_sfvb_site_seo_with_http_info: #{e}"
|
|
6420
|
+
end
|
|
6421
|
+
```
|
|
6422
|
+
|
|
6423
|
+
### Parameters
|
|
6424
|
+
|
|
6425
|
+
| Name | Type | Description | Notes |
|
|
6426
|
+
| ---- | ---- | ----------- | ----- |
|
|
6427
|
+
| **storefront_oid** | **Integer** | | |
|
|
6428
|
+
|
|
6429
|
+
### Return type
|
|
6430
|
+
|
|
6431
|
+
[**SfvbSiteSeo**](SfvbSiteSeo.md)
|
|
6432
|
+
|
|
6433
|
+
### Authorization
|
|
6434
|
+
|
|
6435
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6436
|
+
|
|
6437
|
+
### HTTP request headers
|
|
6438
|
+
|
|
6439
|
+
- **Content-Type**: Not defined
|
|
6440
|
+
- **Accept**: application/json
|
|
6441
|
+
|
|
6442
|
+
|
|
6108
6443
|
## get_sfvb_sitemaps
|
|
6109
6444
|
|
|
6110
6445
|
> <SfvbSitemapsResponse> get_sfvb_sitemaps(storefront_oid)
|
|
@@ -11043,6 +11378,60 @@ end
|
|
|
11043
11378
|
- **Accept**: application/json
|
|
11044
11379
|
|
|
11045
11380
|
|
|
11381
|
+
## resolve_sfvb_redirect_batch
|
|
11382
|
+
|
|
11383
|
+
> <SfvbRedirectResolveBatchResponse> resolve_sfvb_redirect_batch(storefront_oid, redirect_resolve_batch_request)
|
|
11384
|
+
|
|
11385
|
+
What a shopper gets for each of many paths
|
|
11386
|
+
|
|
11387
|
+
Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
11388
|
+
|
|
11389
|
+
|
|
11390
|
+
### Examples
|
|
11391
|
+
|
|
11392
|
+
|
|
11393
|
+
(No example for this operation).
|
|
11394
|
+
|
|
11395
|
+
|
|
11396
|
+
#### Using the resolve_sfvb_redirect_batch_with_http_info variant
|
|
11397
|
+
|
|
11398
|
+
This returns an Array which contains the response data, status code and headers.
|
|
11399
|
+
|
|
11400
|
+
> <Array(<SfvbRedirectResolveBatchResponse>, Integer, Hash)> resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request)
|
|
11401
|
+
|
|
11402
|
+
```ruby
|
|
11403
|
+
begin
|
|
11404
|
+
# What a shopper gets for each of many paths
|
|
11405
|
+
data, status_code, headers = api_instance.resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request)
|
|
11406
|
+
p status_code # => 2xx
|
|
11407
|
+
p headers # => { ... }
|
|
11408
|
+
p data # => <SfvbRedirectResolveBatchResponse>
|
|
11409
|
+
rescue UltracartClient::ApiError => e
|
|
11410
|
+
puts "Error when calling SfvbApi->resolve_sfvb_redirect_batch_with_http_info: #{e}"
|
|
11411
|
+
end
|
|
11412
|
+
```
|
|
11413
|
+
|
|
11414
|
+
### Parameters
|
|
11415
|
+
|
|
11416
|
+
| Name | Type | Description | Notes |
|
|
11417
|
+
| ---- | ---- | ----------- | ----- |
|
|
11418
|
+
| **storefront_oid** | **Integer** | | |
|
|
11419
|
+
| **redirect_resolve_batch_request** | [**SfvbRedirectResolveBatchRequest**](SfvbRedirectResolveBatchRequest.md) | The paths | |
|
|
11420
|
+
|
|
11421
|
+
### Return type
|
|
11422
|
+
|
|
11423
|
+
[**SfvbRedirectResolveBatchResponse**](SfvbRedirectResolveBatchResponse.md)
|
|
11424
|
+
|
|
11425
|
+
### Authorization
|
|
11426
|
+
|
|
11427
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
11428
|
+
|
|
11429
|
+
### HTTP request headers
|
|
11430
|
+
|
|
11431
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
11432
|
+
- **Accept**: application/json
|
|
11433
|
+
|
|
11434
|
+
|
|
11046
11435
|
## resolve_sfvb_template
|
|
11047
11436
|
|
|
11048
11437
|
> <SfvbTemplateResolveResponse> resolve_sfvb_template(storefront_oid, name, opts)
|
|
@@ -12594,6 +12983,62 @@ end
|
|
|
12594
12983
|
- **Accept**: application/json
|
|
12595
12984
|
|
|
12596
12985
|
|
|
12986
|
+
## update_sfvb_site_seo
|
|
12987
|
+
|
|
12988
|
+
> <SfvbSiteSeo> update_sfvb_site_seo(storefront_oid, if_match, site_seo_request, opts)
|
|
12989
|
+
|
|
12990
|
+
Change a storefront's search engine settings
|
|
12991
|
+
|
|
12992
|
+
A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
12993
|
+
|
|
12994
|
+
|
|
12995
|
+
### Examples
|
|
12996
|
+
|
|
12997
|
+
|
|
12998
|
+
(No example for this operation).
|
|
12999
|
+
|
|
13000
|
+
|
|
13001
|
+
#### Using the update_sfvb_site_seo_with_http_info variant
|
|
13002
|
+
|
|
13003
|
+
This returns an Array which contains the response data, status code and headers.
|
|
13004
|
+
|
|
13005
|
+
> <Array(<SfvbSiteSeo>, Integer, Hash)> update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
|
|
13006
|
+
|
|
13007
|
+
```ruby
|
|
13008
|
+
begin
|
|
13009
|
+
# Change a storefront's search engine settings
|
|
13010
|
+
data, status_code, headers = api_instance.update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
|
|
13011
|
+
p status_code # => 2xx
|
|
13012
|
+
p headers # => { ... }
|
|
13013
|
+
p data # => <SfvbSiteSeo>
|
|
13014
|
+
rescue UltracartClient::ApiError => e
|
|
13015
|
+
puts "Error when calling SfvbApi->update_sfvb_site_seo_with_http_info: #{e}"
|
|
13016
|
+
end
|
|
13017
|
+
```
|
|
13018
|
+
|
|
13019
|
+
### Parameters
|
|
13020
|
+
|
|
13021
|
+
| Name | Type | Description | Notes |
|
|
13022
|
+
| ---- | ---- | ----------- | ----- |
|
|
13023
|
+
| **storefront_oid** | **Integer** | | |
|
|
13024
|
+
| **if_match** | **String** | The hash_sha256 from the last read. 428 when absent, 412 when stale. | |
|
|
13025
|
+
| **site_seo_request** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) | The switches to change | |
|
|
13026
|
+
| **approval_id** | **String** | When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals. | [optional] |
|
|
13027
|
+
|
|
13028
|
+
### Return type
|
|
13029
|
+
|
|
13030
|
+
[**SfvbSiteSeo**](SfvbSiteSeo.md)
|
|
13031
|
+
|
|
13032
|
+
### Authorization
|
|
13033
|
+
|
|
13034
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
13035
|
+
|
|
13036
|
+
### HTTP request headers
|
|
13037
|
+
|
|
13038
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
13039
|
+
- **Accept**: application/json
|
|
13040
|
+
|
|
13041
|
+
|
|
12597
13042
|
## update_sfvb_smart_attribution
|
|
12598
13043
|
|
|
12599
13044
|
> <SfvbSmartAttribution> update_sfvb_smart_attribution(storefront_oid, if_match, smart_attribution_request, opts)
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **reason** | **String** | Why the agent wants to do this, in a sentence. Shown to the person as unverified text, capped at 500 characters. | [optional] |
|
|
15
15
|
| **redirect_rows** | [**Array<SfvbRedirectDeleteRow>**](SfvbRedirectDeleteRow.md) | For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256. UltraCart keeps only their hash. | [optional] |
|
|
16
16
|
| **segment_update** | [**SfvbCommsSegmentWriteRequest**](SfvbCommsSegmentWriteRequest.md) | | [optional] |
|
|
17
|
+
| **site_seo** | [**SfvbSiteSeoRequest**](SfvbSiteSeoRequest.md) | | [optional] |
|
|
17
18
|
| **smart_attribution** | [**SfvbSmartAttributionRequest**](SfvbSmartAttributionRequest.md) | | [optional] |
|
|
18
19
|
| **tracking_provider** | [**SfvbTrackingProviderRequest**](SfvbTrackingProviderRequest.md) | | [optional] |
|
|
19
20
|
|
|
@@ -33,6 +34,7 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
|
33
34
|
reason: null,
|
|
34
35
|
redirect_rows: null,
|
|
35
36
|
segment_update: null,
|
|
37
|
+
site_seo: null,
|
|
36
38
|
smart_attribution: null,
|
|
37
39
|
tracking_provider: null
|
|
38
40
|
)
|
data/docs/SfvbBlogPostDetail.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **blog_post_oid** | **Integer** | The blog post's oid. This is what a page's blog post assignment names. | [optional] |
|
|
10
10
|
| **body** | **String** | The post body as HTML, exactly as stored. | [optional] |
|
|
11
11
|
| **created_dts** | **String** | When the post was created (ISO 8601, UTC). | [optional] |
|
|
12
|
+
| **dry_run** | **Boolean** | True when this is the result of a dry run and nothing was saved. The post is shown as it is stored. | [optional] |
|
|
12
13
|
| **excerpt** | **String** | The post excerpt as HTML, exactly as stored. | [optional] |
|
|
13
14
|
| **images** | [**Array<SfvbBlogPostImage>**](SfvbBlogPostImage.md) | The post's images, the default image first. | [optional] |
|
|
14
15
|
| **last_modified_dts** | **String** | When the post was last changed (ISO 8601, UTC), or null if it never was. | [optional] |
|
|
@@ -34,6 +35,7 @@ instance = UltracartClient::SfvbBlogPostDetail.new(
|
|
|
34
35
|
blog_post_oid: null,
|
|
35
36
|
body: null,
|
|
36
37
|
created_dts: null,
|
|
38
|
+
dry_run: null,
|
|
37
39
|
excerpt: null,
|
|
38
40
|
images: null,
|
|
39
41
|
last_modified_dts: null,
|
data/docs/SfvbBlogPostRequest.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **allow_comments** | **Boolean** | Whether shoppers may comment. Defaults to false on create. | [optional] |
|
|
8
8
|
| **author** | **String** | The author's name as plain text, up to 100 characters, with no quotes or angle brackets. | [optional] |
|
|
9
9
|
| **body** | **String** | The post body as HTML, up to 1 MB, rendered exactly as stored. Refused with sfvb.unsafe_html if it could run script - script and other executable tags, on attributes, links that are not http, https, mailto, tel or relative, and iframes other than YouTube or Vimeo players. Reference an attached image by the url the post's images report. | [optional] |
|
|
10
|
+
| **dry_run** | **Boolean** | On an update, true to run every check the write would run and save nothing. A refusal comes back exactly as it would on the real write. | [optional] |
|
|
10
11
|
| **excerpt** | **String** | The post excerpt as HTML, up to 256 KB. Held to the same rule as body. | [optional] |
|
|
11
12
|
| **publication_dts** | **String** | When the post is published, as an ISO 8601 UTC time in the same form publication_dts reads back. Refused on a draft. A post made public without one is published now. | [optional] |
|
|
12
13
|
| **seo_description** | **String** | The meta description (storefrontSEODescription), the search result snippet. Plain text with no angle brackets or double quotes, up to 1000 characters. Left out, it is unchanged; an empty string clears it, and the head falls back to the site's description. | [optional] |
|
|
@@ -26,6 +27,7 @@ instance = UltracartClient::SfvbBlogPostRequest.new(
|
|
|
26
27
|
allow_comments: null,
|
|
27
28
|
author: null,
|
|
28
29
|
body: null,
|
|
30
|
+
dry_run: null,
|
|
29
31
|
excerpt: null,
|
|
30
32
|
publication_dts: null,
|
|
31
33
|
seo_description: null,
|
data/docs/SfvbNotFoundEntry.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **bot_share** | **Object** | bot_hits divided by counted_hits, 0 to 1. Empty when not yet counted. | [optional] |
|
|
9
9
|
| **counted_hits** | **Integer** | Hits since bot counting began, the base for bot_share. | [optional] |
|
|
10
10
|
| **first_seen_dts** | **String** | First hit, ISO 8601. | [optional] |
|
|
11
|
+
| **fixed** | **Boolean** | True when the entry is marked fixed or mapped. The next hit on the path clears it. | [optional] |
|
|
11
12
|
| **hits** | **Integer** | Every recorded hit, bots included. | [optional] |
|
|
12
13
|
| **ignored** | **Boolean** | True when the entry is ignored and no longer counts. | [optional] |
|
|
13
14
|
| **last_seen_dts** | **String** | Latest hit, ISO 8601. | [optional] |
|
|
@@ -26,6 +27,7 @@ instance = UltracartClient::SfvbNotFoundEntry.new(
|
|
|
26
27
|
bot_share: null,
|
|
27
28
|
counted_hits: null,
|
|
28
29
|
first_seen_dts: null,
|
|
30
|
+
fixed: null,
|
|
29
31
|
hits: null,
|
|
30
32
|
ignored: null,
|
|
31
33
|
last_seen_dts: null,
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::SfvbNotFoundSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **last_24_hours** | **Array<Integer>** | 404 hits per hour for the last 24 hours, oldest first. | [optional] |
|
|
8
|
+
| **last_30_days** | **Array<Integer>** | 404 hits per day, oldest first, ending today in the server's time zone. Bots and shoppers together. | [optional] |
|
|
9
|
+
| **last_7_days** | **Array<Integer>** | 404 hits per day for the last 7 days, oldest first. | [optional] |
|
|
10
|
+
| **new_paths** | [**Array<SfvbNotFoundEntry>**](SfvbNotFoundEntry.md) | Up to 10 open paths first seen in the last 30 days, most hits first, leaving out paths only bots have hit. | [optional] |
|
|
11
|
+
| **notes** | **Array<String>** | What a person should know about reading these counts. | [optional] |
|
|
12
|
+
| **total_30_days** | **Integer** | The sum of last_30_days. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::SfvbNotFoundSummary.new(
|
|
20
|
+
last_24_hours: null,
|
|
21
|
+
last_30_days: null,
|
|
22
|
+
last_7_days: null,
|
|
23
|
+
new_paths: null,
|
|
24
|
+
notes: null,
|
|
25
|
+
total_30_days: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap. Left out means false, as in the admin. | [optional] |
|
|
7
8
|
| **note** | **String** | Why the rule exists. | [optional] |
|
|
8
9
|
| **source** | **String** | The path to catch. | [optional] |
|
|
9
10
|
| **target** | **String** | Where to send it. | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
require 'ultracart_api'
|
|
15
16
|
|
|
16
17
|
instance = UltracartClient::SfvbRedirectImportRow.new(
|
|
18
|
+
exclude_from_sitemap: null,
|
|
17
19
|
note: null,
|
|
18
20
|
source: null,
|
|
19
21
|
target: null
|
data/docs/SfvbRedirectRequest.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **exclude_from_sitemap** | **Boolean** | True to leave the rule's source out of the generated sitemap. On a create, left out means false, as in the admin. On an update, left out keeps the rule's value. | [optional] |
|
|
7
8
|
| **note** | **String** | Why the rule exists, up to 500 characters. | [optional] |
|
|
8
9
|
| **over_live_page** | **Boolean** | Allow a source that is a live, visible page or item, which the rule then hides. | [optional] |
|
|
9
10
|
| **source** | **String** | The path to catch, starting with /. End it with /* to catch everything below. | [optional] |
|
|
@@ -16,6 +17,7 @@
|
|
|
16
17
|
require 'ultracart_api'
|
|
17
18
|
|
|
18
19
|
instance = UltracartClient::SfvbRedirectRequest.new(
|
|
20
|
+
exclude_from_sitemap: null,
|
|
19
21
|
note: null,
|
|
20
22
|
over_live_page: null,
|
|
21
23
|
source: null,
|