ultracart_api 4.1.226 → 4.1.228

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 95c3131895afcb281803e49d636846ec15358a684552f90cab1b880e15cd1355
4
- data.tar.gz: ab6bdf275099e086dd4d36ce07cb705894ab7d0b9b9fcd410041d92ff93bd921
3
+ metadata.gz: c64fd152d42f965a2ef426e407e1258fe1e7b46be93a9cfc578955d6dc3638b1
4
+ data.tar.gz: 7a54648d773d9dc420e048a8056dcb80ff54a968dbf9579c0d8eecfddd9dffd6
5
5
  SHA512:
6
- metadata.gz: c53f4efbd29f1be9d09b314f9ae2080436116dc33aea108454a482b337ade38506fd89aa3da59419225155cb5070dc0e222993aa0c1098e60ed980ca36a561fe
7
- data.tar.gz: e42f873a047fb0b2dc7dc3e8a3eaeb107d6d0498ee482462a5214e98228ad1d9d332ec54a7137fc98a7bff32cc384af9d6be3769b76ebebcc70d4b4f92b263b3
6
+ metadata.gz: 6b3e8e124b3f40204cef7eb855d34b008422574f478baaebcaae1550d7eeebcdc48a85c5878657ea5ee1b7bfa470aa1112456c70ab64beb1fdf4a0e037b06440
7
+ data.tar.gz: ff5e768083598808d88e5f536a05f3630ad334880c8e2cef8282c09fb2d6377fd14f03596271882225999ab6116968e821237590247018f83e9f8e20d09a23e4
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.1.226
10
+ - Package version: 4.1.228
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.226'
19
+ gem 'ultracart_api', '4.1.228'
20
20
  ```
21
21
 
22
22
  install:
@@ -582,8 +582,10 @@ Class | Method | HTTP request | Description
582
582
  *UltracartClient::SfvbApi* | [**get_sfvb_secret_request**](docs/SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request
583
583
  *UltracartClient::SfvbApi* | [**get_sfvb_secret_requests**](docs/SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests
584
584
  *UltracartClient::SfvbApi* | [**get_sfvb_sequence**](docs/SfvbApi.md#get_sfvb_sequence) | **GET** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid} | Get a campaign's or flow's steps as a tree
585
+ *UltracartClient::SfvbApi* | [**get_sfvb_sequence_step_dispatch_logs**](docs/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
585
586
  *UltracartClient::SfvbApi* | [**get_sfvb_server_log**](docs/SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log
586
587
  *UltracartClient::SfvbApi* | [**get_sfvb_site_attributes**](docs/SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes
588
+ *UltracartClient::SfvbApi* | [**get_sfvb_sitemaps**](docs/SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt
587
589
  *UltracartClient::SfvbApi* | [**get_sfvb_smart_attribution**](docs/SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration
588
590
  *UltracartClient::SfvbApi* | [**get_sfvb_test_orders**](docs/SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders
589
591
  *UltracartClient::SfvbApi* | [**get_sfvb_theme**](docs/SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme
@@ -2145,6 +2147,7 @@ Class | Method | HTTP request | Description
2145
2147
  - [UltracartClient::SfvbRedirectsResponse](docs/SfvbRedirectsResponse.md)
2146
2148
  - [UltracartClient::SfvbRenderRequest](docs/SfvbRenderRequest.md)
2147
2149
  - [UltracartClient::SfvbRenderResponse](docs/SfvbRenderResponse.md)
2150
+ - [UltracartClient::SfvbRobotsTxt](docs/SfvbRobotsTxt.md)
2148
2151
  - [UltracartClient::SfvbSecretHandle](docs/SfvbSecretHandle.md)
2149
2152
  - [UltracartClient::SfvbSecretKind](docs/SfvbSecretKind.md)
2150
2153
  - [UltracartClient::SfvbSecretKindsResponse](docs/SfvbSecretKindsResponse.md)
@@ -2170,9 +2173,15 @@ Class | Method | HTTP request | Description
2170
2173
  - [UltracartClient::SfvbSiteAttributeUpdate](docs/SfvbSiteAttributeUpdate.md)
2171
2174
  - [UltracartClient::SfvbSiteAttributeUpdateRequest](docs/SfvbSiteAttributeUpdateRequest.md)
2172
2175
  - [UltracartClient::SfvbSiteAttributesResponse](docs/SfvbSiteAttributesResponse.md)
2176
+ - [UltracartClient::SfvbSitemap](docs/SfvbSitemap.md)
2177
+ - [UltracartClient::SfvbSitemapFile](docs/SfvbSitemapFile.md)
2178
+ - [UltracartClient::SfvbSitemapsResponse](docs/SfvbSitemapsResponse.md)
2173
2179
  - [UltracartClient::SfvbSmartAttribution](docs/SfvbSmartAttribution.md)
2174
2180
  - [UltracartClient::SfvbSmartAttributionPlatform](docs/SfvbSmartAttributionPlatform.md)
2175
2181
  - [UltracartClient::SfvbSmartAttributionRequest](docs/SfvbSmartAttributionRequest.md)
2182
+ - [UltracartClient::SfvbStepCounts](docs/SfvbStepCounts.md)
2183
+ - [UltracartClient::SfvbStepDispatchLog](docs/SfvbStepDispatchLog.md)
2184
+ - [UltracartClient::SfvbStepDispatchLogsResponse](docs/SfvbStepDispatchLogsResponse.md)
2176
2185
  - [UltracartClient::SfvbStorefront](docs/SfvbStorefront.md)
2177
2186
  - [UltracartClient::SfvbStorefrontsResponse](docs/SfvbStorefrontsResponse.md)
2178
2187
  - [UltracartClient::SfvbTemplate](docs/SfvbTemplate.md)
@@ -2403,6 +2412,8 @@ Not every change is committed to every SDK.
2403
2412
 
2404
2413
  | Version | Date | Comments |
2405
2414
  | --: | :-: | --- |
2415
+ | 4.1.228 | 11/04/2026 | sfvb internal testing |
2416
+ | 4.1.227 | 11/04/2026 | sfvb internal testing |
2406
2417
  | 4.1.226 | 11/04/2026 | sfvb internal testing |
2407
2418
  | 4.1.225 | 11/03/2026 | sfvb internal testing |
2408
2419
  | 4.1.224 | 11/03/2026 | sfvb internal testing |
data/docs/SfvbApi.md CHANGED
@@ -110,8 +110,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
110
110
  | [**get_sfvb_secret_request**](SfvbApi.md#get_sfvb_secret_request) | **GET** /sfvb/secrets/{request_id} | Read one secret request |
111
111
  | [**get_sfvb_secret_requests**](SfvbApi.md#get_sfvb_secret_requests) | **GET** /sfvb/secrets | List this sign-in's secret requests |
112
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 |
113
+ | [**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
114
  | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
114
115
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
116
+ | [**get_sfvb_sitemaps**](SfvbApi.md#get_sfvb_sitemaps) | **GET** /sfvb/storefronts/{storefront_oid}/sitemaps | Read a storefront's sitemaps and robots.txt |
115
117
  | [**get_sfvb_smart_attribution**](SfvbApi.md#get_sfvb_smart_attribution) | **GET** /sfvb/storefronts/{storefront_oid}/smart_attribution | Read a storefront's Smart Attribution configuration |
116
118
  | [**get_sfvb_test_orders**](SfvbApi.md#get_sfvb_test_orders) | **GET** /sfvb/storefronts/{storefront_oid}/test_orders | List recent test orders |
117
119
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
@@ -5996,6 +5998,64 @@ end
5996
5998
  - **Accept**: application/json
5997
5999
 
5998
6000
 
6001
+ ## get_sfvb_sequence_step_dispatch_logs
6002
+
6003
+ > <SfvbStepDispatchLogsResponse> get_sfvb_sequence_step_dispatch_logs(storefront_oid, sequence_uuid, step_uuid, opts)
6004
+
6005
+ Read a flow or campaign step's dispatch log and counts
6006
+
6007
+ 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.
6008
+
6009
+
6010
+ ### Examples
6011
+
6012
+
6013
+ (No example for this operation).
6014
+
6015
+
6016
+ #### Using the get_sfvb_sequence_step_dispatch_logs_with_http_info variant
6017
+
6018
+ This returns an Array which contains the response data, status code and headers.
6019
+
6020
+ > <Array(<SfvbStepDispatchLogsResponse>, Integer, Hash)> get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts)
6021
+
6022
+ ```ruby
6023
+ begin
6024
+ # Read a flow or campaign step's dispatch log and counts
6025
+ data, status_code, headers = api_instance.get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts)
6026
+ p status_code # => 2xx
6027
+ p headers # => { ... }
6028
+ p data # => <SfvbStepDispatchLogsResponse>
6029
+ rescue UltracartClient::ApiError => e
6030
+ puts "Error when calling SfvbApi->get_sfvb_sequence_step_dispatch_logs_with_http_info: #{e}"
6031
+ end
6032
+ ```
6033
+
6034
+ ### Parameters
6035
+
6036
+ | Name | Type | Description | Notes |
6037
+ | ---- | ---- | ----------- | ----- |
6038
+ | **storefront_oid** | **Integer** | | |
6039
+ | **sequence_uuid** | **String** | | |
6040
+ | **step_uuid** | **String** | | |
6041
+ | **since** | **String** | | [optional] |
6042
+ | **limit** | **Integer** | | [optional] |
6043
+ | **offset** | **Integer** | | [optional] |
6044
+
6045
+ ### Return type
6046
+
6047
+ [**SfvbStepDispatchLogsResponse**](SfvbStepDispatchLogsResponse.md)
6048
+
6049
+ ### Authorization
6050
+
6051
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6052
+
6053
+ ### HTTP request headers
6054
+
6055
+ - **Content-Type**: Not defined
6056
+ - **Accept**: application/json
6057
+
6058
+
5999
6059
  ## get_sfvb_server_log
6000
6060
 
6001
6061
  > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
@@ -6104,6 +6164,59 @@ end
6104
6164
  - **Accept**: application/json
6105
6165
 
6106
6166
 
6167
+ ## get_sfvb_sitemaps
6168
+
6169
+ > <SfvbSitemapsResponse> get_sfvb_sitemaps(storefront_oid)
6170
+
6171
+ Read a storefront's sitemaps and robots.txt
6172
+
6173
+ The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
6174
+
6175
+
6176
+ ### Examples
6177
+
6178
+
6179
+ (No example for this operation).
6180
+
6181
+
6182
+ #### Using the get_sfvb_sitemaps_with_http_info variant
6183
+
6184
+ This returns an Array which contains the response data, status code and headers.
6185
+
6186
+ > <Array(<SfvbSitemapsResponse>, Integer, Hash)> get_sfvb_sitemaps_with_http_info(storefront_oid)
6187
+
6188
+ ```ruby
6189
+ begin
6190
+ # Read a storefront's sitemaps and robots.txt
6191
+ data, status_code, headers = api_instance.get_sfvb_sitemaps_with_http_info(storefront_oid)
6192
+ p status_code # => 2xx
6193
+ p headers # => { ... }
6194
+ p data # => <SfvbSitemapsResponse>
6195
+ rescue UltracartClient::ApiError => e
6196
+ puts "Error when calling SfvbApi->get_sfvb_sitemaps_with_http_info: #{e}"
6197
+ end
6198
+ ```
6199
+
6200
+ ### Parameters
6201
+
6202
+ | Name | Type | Description | Notes |
6203
+ | ---- | ---- | ----------- | ----- |
6204
+ | **storefront_oid** | **Integer** | | |
6205
+
6206
+ ### Return type
6207
+
6208
+ [**SfvbSitemapsResponse**](SfvbSitemapsResponse.md)
6209
+
6210
+ ### Authorization
6211
+
6212
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6213
+
6214
+ ### HTTP request headers
6215
+
6216
+ - **Content-Type**: Not defined
6217
+ - **Accept**: application/json
6218
+
6219
+
6107
6220
  ## get_sfvb_smart_attribution
6108
6221
 
6109
6222
  > <SfvbSmartAttribution> get_sfvb_smart_attribution(storefront_oid)
@@ -9,6 +9,7 @@
9
9
  | **blog_post_oid** | **Integer** | The blog post&#39;s oid. This is what a page&#39;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&lt;SfvbBlogPostImage&gt;**](SfvbBlogPostImage.md) | The post&#39;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,
@@ -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&#39;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&#39;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&#39;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,
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbRobotsTxt
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **custom_file** | **Boolean** | True when the merchant has their own /robots.txt file, which is served after UltraCart&#39;s entries. | [optional] |
8
+ | **sitemap_lines** | **Array&lt;String&gt;** | The Sitemap lines it serves, UltraCart&#39;s own first, then any in the merchant&#39;s own robots.txt file. | [optional] |
9
+ | **url** | **String** | The robots.txt URL on the storefront&#39;s host. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbRobotsTxt.new(
17
+ custom_file: null,
18
+ sitemap_lines: null,
19
+ url: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbSitemap
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **child_files** | [**Array&lt;SfvbSitemapFile&gt;**](SfvbSitemapFile.md) | For an index, the child files it lists, in order. | [optional] |
8
+ | **format** | **String** | sitemaps.org (the index to register with Google Search Console and Bing), google-0.84 (the older Google schema) or urllist (a plain URL list). | [optional] |
9
+ | **last_built** | **String** | When the nightly build last wrote the sitemap, as ISO 8601. | [optional] |
10
+ | **path** | **String** | The sitemap&#39;s path on the storefront. | [optional] |
11
+ | **size_bytes** | **Integer** | The file&#39;s size in bytes. | [optional] |
12
+ | **url** | **String** | The sitemap&#39;s https URL, the one to register. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbSitemap.new(
20
+ child_files: null,
21
+ format: null,
22
+ last_built: null,
23
+ path: null,
24
+ size_bytes: null,
25
+ url: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbSitemapFile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **last_built** | **String** | When the nightly build last wrote the file, as ISO 8601. | [optional] |
8
+ | **path** | **String** | The file&#39;s path on the storefront, such as /sitemapsdotorg1.xml.gz. | [optional] |
9
+ | **size_bytes** | **Integer** | The file&#39;s size in bytes, compressed for a .gz file. | [optional] |
10
+ | **url** | **String** | The file&#39;s https URL on the storefront&#39;s host. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbSitemapFile.new(
18
+ last_built: null,
19
+ path: null,
20
+ size_bytes: null,
21
+ url: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbSitemapsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **host** | **String** | The host the sitemaps are built for. | [optional] |
8
+ | **notes** | **Array&lt;String&gt;** | What a person should know about these sitemaps, such as when they are rebuilt. | [optional] |
9
+ | **prevent_indexing** | **Boolean** | True when the storefront&#39;s Prevent Indexing setting is on. The sitemaps are still served, but every page tells search engines not to index it. | [optional] |
10
+ | **robots_txt** | [**SfvbRobotsTxt**](SfvbRobotsTxt.md) | | [optional] |
11
+ | **sitemaps** | [**Array&lt;SfvbSitemap&gt;**](SfvbSitemap.md) | The sitemaps that exist, sitemaps.org first. Empty until the nightly build has run. | [optional] |
12
+ | **storefront_oid** | **Integer** | The storefront. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbSitemapsResponse.new(
20
+ host: null,
21
+ notes: null,
22
+ prevent_indexing: null,
23
+ robots_txt: null,
24
+ sitemaps: null,
25
+ storefront_oid: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,34 @@
1
+ # UltracartClient::SfvbStepCounts
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **clicked** | **Integer** | Messages with a click. | [optional] |
8
+ | **customers** | **Integer** | For a step that isn&#39;t an email, the customers that passed through it. | [optional] |
9
+ | **delivered** | **Integer** | Messages delivered. | [optional] |
10
+ | **opened** | **Integer** | Emails opened. | [optional] |
11
+ | **sent** | **Integer** | Messages sent. | [optional] |
12
+ | **skipped** | **Integer** | Customers who reached the step and were not sent anything. The dispatch log says why. | [optional] |
13
+ | **source** | **String** | email (the step&#39;s email, all time) or step (this step, the last 90 days). | [optional] |
14
+ | **spam** | **Integer** | Spam complaints. | [optional] |
15
+ | **unsubscribed** | **Integer** | Unsubscribes from these messages. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ultracart_api'
21
+
22
+ instance = UltracartClient::SfvbStepCounts.new(
23
+ clicked: null,
24
+ customers: null,
25
+ delivered: null,
26
+ opened: null,
27
+ sent: null,
28
+ skipped: null,
29
+ source: null,
30
+ spam: null,
31
+ unsubscribed: null
32
+ )
33
+ ```
34
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::SfvbStepDispatchLog
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **customer_uuid** | **String** | The customer the entry is about. | [optional] |
8
+ | **detail** | **String** | What happened, as the admin&#39;s Dispatch Logs screen shows it, with email addresses and phone numbers masked. | [optional] |
9
+ | **logged_at** | **String** | When the entry was written, as ISO 8601 with the server&#39;s offset. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::SfvbStepDispatchLog.new(
17
+ customer_uuid: null,
18
+ detail: null,
19
+ logged_at: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,32 @@
1
+ # UltracartClient::SfvbStepDispatchLogsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **counts** | [**SfvbStepCounts**](SfvbStepCounts.md) | | [optional] |
8
+ | **entries** | [**Array&lt;SfvbStepDispatchLog&gt;**](SfvbStepDispatchLog.md) | The entries in the window, newest first. | [optional] |
9
+ | **next_offset** | **Integer** | Send this as offset for the next page. Absent on the last page. | [optional] |
10
+ | **notes** | **Array&lt;String&gt;** | What a person should know about reading these entries. | [optional] |
11
+ | **sequence_uuid** | **String** | The communication sequence the step is in. | [optional] |
12
+ | **since** | **String** | The start of the window read, as ISO 8601. | [optional] |
13
+ | **step_type** | **String** | The step&#39;s type, such as email, sms or wait. | [optional] |
14
+ | **step_uuid** | **String** | The step. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::SfvbStepDispatchLogsResponse.new(
22
+ counts: null,
23
+ entries: null,
24
+ next_offset: null,
25
+ notes: null,
26
+ sequence_uuid: null,
27
+ since: null,
28
+ step_type: null,
29
+ step_uuid: null
30
+ )
31
+ ```
32
+
@@ -7625,6 +7625,91 @@ module UltracartClient
7625
7625
  return data, status_code, headers
7626
7626
  end
7627
7627
 
7628
+ # Read a flow or campaign step's dispatch log and counts
7629
+ # 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.
7630
+ # @param storefront_oid [Integer]
7631
+ # @param sequence_uuid [String]
7632
+ # @param step_uuid [String]
7633
+ # @param [Hash] opts the optional parameters
7634
+ # @option opts [String] :since
7635
+ # @option opts [Integer] :limit
7636
+ # @option opts [Integer] :offset
7637
+ # @return [SfvbStepDispatchLogsResponse]
7638
+ def get_sfvb_sequence_step_dispatch_logs(storefront_oid, sequence_uuid, step_uuid, opts = {})
7639
+ data, _status_code, _headers = get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts)
7640
+ data
7641
+ end
7642
+
7643
+ # Read a flow or campaign step&#39;s dispatch log and counts
7644
+ # Why customers were sent, skipped or ended at this step, newest first, as the admin&#39;s Dispatch Logs screen shows it, with the step&#39;s counts. An email step&#39;s counts are its email&#39;s; any other step&#39;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.
7645
+ # @param storefront_oid [Integer]
7646
+ # @param sequence_uuid [String]
7647
+ # @param step_uuid [String]
7648
+ # @param [Hash] opts the optional parameters
7649
+ # @option opts [String] :since
7650
+ # @option opts [Integer] :limit
7651
+ # @option opts [Integer] :offset
7652
+ # @return [Array<(SfvbStepDispatchLogsResponse, Integer, Hash)>] SfvbStepDispatchLogsResponse data, response status code and response headers
7653
+ def get_sfvb_sequence_step_dispatch_logs_with_http_info(storefront_oid, sequence_uuid, step_uuid, opts = {})
7654
+ if @api_client.config.debugging
7655
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_sequence_step_dispatch_logs ...'
7656
+ end
7657
+ # verify the required parameter 'storefront_oid' is set
7658
+ if @api_client.config.client_side_validation && storefront_oid.nil?
7659
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_sequence_step_dispatch_logs"
7660
+ end
7661
+ # verify the required parameter 'sequence_uuid' is set
7662
+ if @api_client.config.client_side_validation && sequence_uuid.nil?
7663
+ fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.get_sfvb_sequence_step_dispatch_logs"
7664
+ end
7665
+ # verify the required parameter 'step_uuid' is set
7666
+ if @api_client.config.client_side_validation && step_uuid.nil?
7667
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.get_sfvb_sequence_step_dispatch_logs"
7668
+ end
7669
+ # resource path
7670
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
7671
+
7672
+ # query parameters
7673
+ query_params = opts[:query_params] || {}
7674
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
7675
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
7676
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
7677
+
7678
+ # header parameters
7679
+ header_params = opts[:header_params] || {}
7680
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7681
+ # HTTP header 'Accept' (if needed)
7682
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7683
+
7684
+ # form parameters
7685
+ form_params = opts[:form_params] || {}
7686
+
7687
+ # http body (model)
7688
+ post_body = opts[:debug_body]
7689
+
7690
+ # return_type
7691
+ return_type = opts[:debug_return_type] || 'SfvbStepDispatchLogsResponse'
7692
+
7693
+ # auth_names
7694
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7695
+
7696
+ new_options = opts.merge(
7697
+ :operation => :"SfvbApi.get_sfvb_sequence_step_dispatch_logs",
7698
+ :header_params => header_params,
7699
+ :query_params => query_params,
7700
+ :form_params => form_params,
7701
+ :body => post_body,
7702
+ :auth_names => auth_names,
7703
+ :return_type => return_type
7704
+ )
7705
+
7706
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
7707
+ if @api_client.config.debugging
7708
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_sequence_step_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7709
+ end
7710
+ return data, status_code, headers
7711
+ end
7712
+
7628
7713
  # Get one storefront render log
7629
7714
  # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
7630
7715
  # @param storefront_oid [Integer]
@@ -7762,6 +7847,70 @@ module UltracartClient
7762
7847
  return data, status_code, headers
7763
7848
  end
7764
7849
 
7850
+ # Read a storefront's sitemaps and robots.txt
7851
+ # The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
7852
+ # @param storefront_oid [Integer]
7853
+ # @param [Hash] opts the optional parameters
7854
+ # @return [SfvbSitemapsResponse]
7855
+ def get_sfvb_sitemaps(storefront_oid, opts = {})
7856
+ data, _status_code, _headers = get_sfvb_sitemaps_with_http_info(storefront_oid, opts)
7857
+ data
7858
+ end
7859
+
7860
+ # Read a storefront&#39;s sitemaps and robots.txt
7861
+ # The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
7862
+ # @param storefront_oid [Integer]
7863
+ # @param [Hash] opts the optional parameters
7864
+ # @return [Array<(SfvbSitemapsResponse, Integer, Hash)>] SfvbSitemapsResponse data, response status code and response headers
7865
+ def get_sfvb_sitemaps_with_http_info(storefront_oid, opts = {})
7866
+ if @api_client.config.debugging
7867
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_sitemaps ...'
7868
+ end
7869
+ # verify the required parameter 'storefront_oid' is set
7870
+ if @api_client.config.client_side_validation && storefront_oid.nil?
7871
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_sitemaps"
7872
+ end
7873
+ # resource path
7874
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/sitemaps'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
7875
+
7876
+ # query parameters
7877
+ query_params = opts[:query_params] || {}
7878
+
7879
+ # header parameters
7880
+ header_params = opts[:header_params] || {}
7881
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7882
+ # HTTP header 'Accept' (if needed)
7883
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7884
+
7885
+ # form parameters
7886
+ form_params = opts[:form_params] || {}
7887
+
7888
+ # http body (model)
7889
+ post_body = opts[:debug_body]
7890
+
7891
+ # return_type
7892
+ return_type = opts[:debug_return_type] || 'SfvbSitemapsResponse'
7893
+
7894
+ # auth_names
7895
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7896
+
7897
+ new_options = opts.merge(
7898
+ :operation => :"SfvbApi.get_sfvb_sitemaps",
7899
+ :header_params => header_params,
7900
+ :query_params => query_params,
7901
+ :form_params => form_params,
7902
+ :body => post_body,
7903
+ :auth_names => auth_names,
7904
+ :return_type => return_type
7905
+ )
7906
+
7907
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
7908
+ if @api_client.config.debugging
7909
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_sitemaps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7910
+ end
7911
+ return data, status_code, headers
7912
+ end
7913
+
7765
7914
  # Read a storefront's Smart Attribution configuration
7766
7915
  # 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.
7767
7916
  # @param storefront_oid [Integer]
@@ -30,6 +30,9 @@ module UltracartClient
30
30
  # When the post was created (ISO 8601, UTC).
31
31
  attr_accessor :created_dts
32
32
 
33
+ # True when this is the result of a dry run and nothing was saved. The post is shown as it is stored.
34
+ attr_accessor :dry_run
35
+
33
36
  # The post excerpt as HTML, exactly as stored.
34
37
  attr_accessor :excerpt
35
38
 
@@ -77,6 +80,7 @@ module UltracartClient
77
80
  :'blog_post_oid' => :'blog_post_oid',
78
81
  :'body' => :'body',
79
82
  :'created_dts' => :'created_dts',
83
+ :'dry_run' => :'dry_run',
80
84
  :'excerpt' => :'excerpt',
81
85
  :'images' => :'images',
82
86
  :'last_modified_dts' => :'last_modified_dts',
@@ -106,6 +110,7 @@ module UltracartClient
106
110
  :'blog_post_oid' => :'Integer',
107
111
  :'body' => :'String',
108
112
  :'created_dts' => :'String',
113
+ :'dry_run' => :'Boolean',
109
114
  :'excerpt' => :'String',
110
115
  :'images' => :'Array<SfvbBlogPostImage>',
111
116
  :'last_modified_dts' => :'String',
@@ -163,6 +168,10 @@ module UltracartClient
163
168
  self.created_dts = attributes[:'created_dts']
164
169
  end
165
170
 
171
+ if attributes.key?(:'dry_run')
172
+ self.dry_run = attributes[:'dry_run']
173
+ end
174
+
166
175
  if attributes.key?(:'excerpt')
167
176
  self.excerpt = attributes[:'excerpt']
168
177
  end
@@ -243,6 +252,7 @@ module UltracartClient
243
252
  blog_post_oid == o.blog_post_oid &&
244
253
  body == o.body &&
245
254
  created_dts == o.created_dts &&
255
+ dry_run == o.dry_run &&
246
256
  excerpt == o.excerpt &&
247
257
  images == o.images &&
248
258
  last_modified_dts == o.last_modified_dts &&
@@ -267,7 +277,7 @@ module UltracartClient
267
277
  # Calculates hash code according to all attributes.
268
278
  # @return [Integer] Hash code
269
279
  def hash
270
- [allow_comments, author, blog_post_oid, body, created_dts, excerpt, images, last_modified_dts, publication_dts, seo_description, seo_keywords, seo_title, tags, title, unassigned, url_part, view_url, visibility].hash
280
+ [allow_comments, author, blog_post_oid, body, created_dts, dry_run, excerpt, images, last_modified_dts, publication_dts, seo_description, seo_keywords, seo_title, tags, title, unassigned, url_part, view_url, visibility].hash
271
281
  end
272
282
 
273
283
  # Builds the object from hash