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.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -2
  3. data/docs/SfvbApi.md +445 -0
  4. data/docs/SfvbApprovalCreateRequest.md +2 -0
  5. data/docs/SfvbBlogPostDetail.md +2 -0
  6. data/docs/SfvbBlogPostRequest.md +2 -0
  7. data/docs/SfvbNotFoundEntry.md +2 -0
  8. data/docs/SfvbNotFoundSummary.md +28 -0
  9. data/docs/SfvbRedirectImportRow.md +2 -0
  10. data/docs/SfvbRedirectRequest.md +2 -0
  11. data/docs/SfvbRedirectResolveBatchRequest.md +18 -0
  12. data/docs/SfvbRedirectResolveBatchResponse.md +24 -0
  13. data/docs/SfvbSiteSeo.md +40 -0
  14. data/docs/SfvbSiteSeoChange.md +26 -0
  15. data/docs/SfvbSiteSeoRequest.md +24 -0
  16. data/docs/SfvbStepCounts.md +34 -0
  17. data/docs/SfvbStepDispatchLog.md +22 -0
  18. data/docs/SfvbStepDispatchLogsResponse.md +32 -0
  19. data/lib/ultracart_api/api/sfvb_api.rb +583 -0
  20. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
  21. data/lib/ultracart_api/models/sfvb_blog_post_detail.rb +11 -1
  22. data/lib/ultracart_api/models/sfvb_blog_post_request.rb +11 -1
  23. data/lib/ultracart_api/models/sfvb_not_found_entry.rb +11 -1
  24. data/lib/ultracart_api/models/sfvb_not_found_summary.rb +280 -0
  25. data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +11 -1
  26. data/lib/ultracart_api/models/sfvb_redirect_request.rb +11 -1
  27. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb +222 -0
  28. data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb +252 -0
  29. data/lib/ultracart_api/models/sfvb_site_seo.rb +334 -0
  30. data/lib/ultracart_api/models/sfvb_site_seo_change.rb +260 -0
  31. data/lib/ultracart_api/models/sfvb_site_seo_request.rb +250 -0
  32. data/lib/ultracart_api/models/sfvb_step_counts.rb +300 -0
  33. data/lib/ultracart_api/models/sfvb_step_dispatch_log.rb +240 -0
  34. data/lib/ultracart_api/models/sfvb_step_dispatch_logs_response.rb +293 -0
  35. data/lib/ultracart_api/version.rb +1 -1
  36. data/lib/ultracart_api.rb +9 -0
  37. metadata +19 -1
data/docs/SfvbRedirectResolveBatchRequest.md ADDED
@@ -0,0 +1,18 @@
1
+ # UltracartClient::SfvbRedirectResolveBatchRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **paths** | **Array<String>** | 1 to 1,000 paths, each starting with /. A query string is kept, as on the single resolve. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::SfvbRedirectResolveBatchRequest.new(
15
+ paths: null
16
+ )
17
+ ```
18
+
data/docs/SfvbRedirectResolveBatchResponse.md ADDED
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbRedirectResolveBatchResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **not_found** | **Integer** | How many paths end on a 404 (lands_on not_found), the ones to redirect or create. | [optional] |
8
+ | **redirected** | **Integer** | How many paths at least one rule redirects. | [optional] |
9
+ | **results** | [**Array<SfvbRedirectResolveResponse>**](SfvbRedirectResolveResponse.md) | One result per path, in the order sent, the same as the single resolve's answer. | [optional] |
10
+ | **total** | **Integer** | How many paths were resolved. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbRedirectResolveBatchResponse.new(
18
+ not_found: null,
19
+ redirected: null,
20
+ results: null,
21
+ total: null
22
+ )
23
+ ```
24
+
data/docs/SfvbSiteSeo.md ADDED
@@ -0,0 +1,40 @@
1
+ # UltracartClient::SfvbSiteSeo
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **approval_needed** | **Boolean** | On a change, true when it needs an approved site_seo.change request. | [optional] |
8
+ | **canonical** | **Boolean** | True when pages output canonical links. | [optional] |
9
+ | **changed** | **Boolean** | On a change, true when anything was saved, or would be on a dry run. | [optional] |
10
+ | **changes** | [**Array<SfvbSiteSeoChange>**](SfvbSiteSeoChange.md) | On a change, each switch it changed, or would change on a dry run. | [optional] |
11
+ | **description** | **String** | The default meta description, the storefrontSEODescription site attribute. | [optional] |
12
+ | **dry_run** | **Boolean** | True when nothing was saved because the request was a dry run. | [optional] |
13
+ | **hash_sha256** | **String** | The hash of the three switches. Send it as If-Match on a change. | [optional] |
14
+ | **keywords** | **String** | The default meta keywords, the storefrontSEOKeywords site attribute. | [optional] |
15
+ | **notes** | **Array<String>** | What a person should know about these settings. | [optional] |
16
+ | **prevent_indexing** | **Boolean** | True when every page tells search engines not to index it. For a development store only. | [optional] |
17
+ | **schema_org** | **Boolean** | True when pages output Schema.org structured data. | [optional] |
18
+ | **storefront_oid** | **Integer** | The storefront. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ultracart_api'
24
+
25
+ instance = UltracartClient::SfvbSiteSeo.new(
26
+ approval_needed: null,
27
+ canonical: null,
28
+ changed: null,
29
+ changes: null,
30
+ description: null,
31
+ dry_run: null,
32
+ hash_sha256: null,
33
+ keywords: null,
34
+ notes: null,
35
+ prevent_indexing: null,
36
+ schema_org: null,
37
+ storefront_oid: null
38
+ )
39
+ ```
40
+
data/docs/SfvbSiteSeoChange.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::SfvbSiteSeoChange
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **approval_needed** | **Boolean** | True when this change needs an approved site_seo.change request. | [optional] |
8
+ | **fresh_code** | **Boolean** | True when the approval asks for an authenticator code even inside an open approval session. | [optional] |
9
+ | **from** | **Boolean** | The value before. | [optional] |
10
+ | **setting** | **String** | canonical, schema_org or prevent_indexing. | [optional] |
11
+ | **to** | **Boolean** | The value after. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::SfvbSiteSeoChange.new(
19
+ approval_needed: null,
20
+ fresh_code: null,
21
+ from: null,
22
+ setting: null,
23
+ to: null
24
+ )
25
+ ```
26
+
data/docs/SfvbSiteSeoRequest.md ADDED
@@ -0,0 +1,24 @@
1
+ # UltracartClient::SfvbSiteSeoRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **canonical** | **Boolean** | True to turn Canonical Links on. Turning them off needs an approved site_seo.change request. | [optional] |
8
+ | **dry_run** | **Boolean** | True to check the change and report it without saving. | [optional] |
9
+ | **prevent_indexing** | **Boolean** | True to tell search engines not to index any page. Either direction needs an approved site_seo.change request, and turning it on needs a fresh authenticator code. | [optional] |
10
+ | **schema_org** | **Boolean** | True to turn Schema.org structured data on. Turning it off needs an approved site_seo.change request. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ultracart_api'
16
+
17
+ instance = UltracartClient::SfvbSiteSeoRequest.new(
18
+ canonical: null,
19
+ dry_run: null,
20
+ prevent_indexing: null,
21
+ schema_org: null
22
+ )
23
+ ```
24
+
data/docs/SfvbStepCounts.md ADDED
@@ -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'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'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
+
data/docs/SfvbStepDispatchLog.md ADDED
@@ -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'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'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
+
data/docs/SfvbStepDispatchLogsResponse.md ADDED
@@ -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<SfvbStepDispatchLog>**](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<String>** | 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'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
+