ultracart_api 4.1.176 → 4.1.178

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.
data/docs/SfvbApi.md CHANGED
@@ -7,14 +7,17 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
7
7
  | [**add_sfvb_page_blog_posts**](SfvbApi.md#add_sfvb_page_blog_posts) | **POST** /sfvb/storefronts/{storefront_oid}/pages/blog_posts/add | Assign blog posts to a page |
8
8
  | [**add_sfvb_page_items**](SfvbApi.md#add_sfvb_page_items) | **POST** /sfvb/storefronts/{storefront_oid}/pages/items/add | Assign items to a page |
9
9
  | [**archive_sfvb_upsell_path**](SfvbApi.md#archive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/archive | Archive an upsell path |
10
+ | [**attach_sfvb_blog_post_image**](SfvbApi.md#attach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/attach | Attach an image to a blog post |
10
11
  | [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
11
12
  | [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
12
13
  | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
14
+ | [**delete_sfvb_blog_post**](SfvbApi.md#delete_sfvb_blog_post) | **DELETE** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Delete a blog post |
13
15
  | [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
14
16
  | [**delete_sfvb_item_attribute**](SfvbApi.md#delete_sfvb_item_attribute) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/attributes | Delete an attribute from an item |
15
17
  | [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
16
18
  | [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
17
19
  | [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
20
+ | [**detach_sfvb_blog_post_image**](SfvbApi.md#detach_sfvb_blog_post_image) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}/images/detach | Detach an image from a blog post |
18
21
  | [**disable_sfvb_upsell_offer**](SfvbApi.md#disable_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/disable | Disable an upsell offer |
19
22
  | [**disable_sfvb_upsell_path**](SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path |
20
23
  | [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
@@ -23,6 +26,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
23
26
  | [**duplicate_sfvb_upsell_offer**](SfvbApi.md#duplicate_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid}/duplicate | Duplicate an upsell offer |
24
27
  | [**duplicate_sfvb_upsell_path**](SfvbApi.md#duplicate_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/duplicate | Duplicate an upsell path or one of its variations |
25
28
  | [**end_sfvb_experiment**](SfvbApi.md#end_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/end | End an experiment |
29
+ | [**get_sfvb_blog_post**](SfvbApi.md#get_sfvb_blog_post) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Read a blog post |
26
30
  | [**get_sfvb_cjson_used_elements**](SfvbApi.md#get_sfvb_cjson_used_elements) | **POST** /sfvb/cjson/elements | Element types used by a container |
27
31
  | [**get_sfvb_container**](SfvbApi.md#get_sfvb_container) | **GET** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Read a container stored outside the file system |
28
32
  | [**get_sfvb_container_version**](SfvbApi.md#get_sfvb_container_version) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions/{container_history_oid} | Read the CJSON stored in one container history entry |
@@ -40,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
40
44
  | [**get_sfvb_page_items**](SfvbApi.md#get_sfvb_page_items) | **GET** /sfvb/storefronts/{storefront_oid}/pages/items | Read the items assigned to a page |
41
45
  | [**get_sfvb_page_selectors**](SfvbApi.md#get_sfvb_page_selectors) | **GET** /sfvb/storefronts/{storefront_oid}/pages/selectors | Read a page's selectors |
42
46
  | [**get_sfvb_preview_url**](SfvbApi.md#get_sfvb_preview_url) | **GET** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/url | URL that renders a preview session |
47
+ | [**get_sfvb_server_log**](SfvbApi.md#get_sfvb_server_log) | **GET** /sfvb/storefronts/{storefront_oid}/logs/{log_id} | Get one storefront render log |
43
48
  | [**get_sfvb_site_attributes**](SfvbApi.md#get_sfvb_site_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/attributes | Read a storefront's site attributes |
44
49
  | [**get_sfvb_theme**](SfvbApi.md#get_sfvb_theme) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid} | Get a theme |
45
50
  | [**get_sfvb_theme_attributes**](SfvbApi.md#get_sfvb_theme_attributes) | **GET** /sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes | Read a theme's colors, fonts and settings |
@@ -48,6 +53,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
48
53
  | [**get_sfvb_upsell_path**](SfvbApi.md#get_sfvb_upsell_path) | **GET** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Get an upsell path |
49
54
  | [**get_sfvb_version**](SfvbApi.md#get_sfvb_version) | **GET** /sfvb/version | Compiler version for this merchant |
50
55
  | [**get_sfvb_whoami**](SfvbApi.md#get_sfvb_whoami) | **GET** /sfvb/whoami | Who this token is |
56
+ | [**insert_sfvb_blog_post**](SfvbApi.md#insert_sfvb_blog_post) | **POST** /sfvb/storefronts/{storefront_oid}/blog_posts | Create a blog post |
51
57
  | [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
52
58
  | [**insert_sfvb_upsell_offer**](SfvbApi.md#insert_sfvb_upsell_offer) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_offers | Create an upsell offer |
53
59
  | [**insert_sfvb_upsell_path**](SfvbApi.md#insert_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths | Create an upsell path |
@@ -60,6 +66,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
60
66
  | [**list_sfvb_files**](SfvbApi.md#list_sfvb_files) | **GET** /sfvb/storefronts/{storefront_oid}/files | List a storefront directory |
61
67
  | [**list_sfvb_item_containers**](SfvbApi.md#list_sfvb_item_containers) | **GET** /sfvb/storefronts/{storefront_oid}/item_containers | List the item containers on the account |
62
68
  | [**list_sfvb_pages**](SfvbApi.md#list_sfvb_pages) | **GET** /sfvb/storefronts/{storefront_oid}/pages/list | List the storefront's pages |
69
+ | [**list_sfvb_server_logs**](SfvbApi.md#list_sfvb_server_logs) | **GET** /sfvb/storefronts/{storefront_oid}/logs | List recent storefront render logs |
63
70
  | [**list_sfvb_storefronts**](SfvbApi.md#list_sfvb_storefronts) | **GET** /sfvb/storefronts | List storefronts |
64
71
  | [**list_sfvb_templates**](SfvbApi.md#list_sfvb_templates) | **GET** /sfvb/storefronts/{storefront_oid}/templates | List the active theme's templates |
65
72
  | [**list_sfvb_themes**](SfvbApi.md#list_sfvb_themes) | **GET** /sfvb/storefronts/{storefront_oid}/themes | List themes for a storefront |
@@ -93,6 +100,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
93
100
  | [**search_sfvb_library**](SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library |
94
101
  | [**start_sfvb_experiment**](SfvbApi.md#start_sfvb_experiment) | **POST** /sfvb/storefronts/{storefront_oid}/experiments | Start an experiment |
95
102
  | [**unarchive_sfvb_upsell_path**](SfvbApi.md#unarchive_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/unarchive | Unarchive an upsell path |
103
+ | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
96
104
  | [**update_sfvb_upsell_offer**](SfvbApi.md#update_sfvb_upsell_offer) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_offers/{upsell_offer_oid} | Update an upsell offer |
97
105
  | [**update_sfvb_upsell_path**](SfvbApi.md#update_sfvb_upsell_path) | **PUT** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid} | Update an upsell path |
98
106
  | [**upload_sfvb_file**](SfvbApi.md#upload_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/upload | Store a binary asset that was already uploaded |
@@ -264,6 +272,61 @@ end
264
272
  - **Accept**: application/json
265
273
 
266
274
 
275
+ ## attach_sfvb_blog_post_image
276
+
277
+ > <SfvbBlogPostDetail> attach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
278
+
279
+ Attach an image to a blog post
280
+
281
+ Three calls, like the admin blog editor's upload. Request an upload URL with files/upload_url, send the bytes to it, then attach with the key and a filename. No storefront file is created, and the key is redeemed, so it cannot be used twice. default_image replaces the post's default image and code replaces the image with that code; with neither, the image is added for use in the body at the url the response reports. JPEG, PNG, GIF or WebP, checked by content. A post that is not a draft needs sfvb_publish.
282
+
283
+
284
+ ### Examples
285
+
286
+
287
+ (No example for this operation).
288
+
289
+
290
+ #### Using the attach_sfvb_blog_post_image_with_http_info variant
291
+
292
+ This returns an Array which contains the response data, status code and headers.
293
+
294
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> attach_sfvb_blog_post_image_with_http_info(storefront_oid, blog_post_oid, blog_post_image_request)
295
+
296
+ ```ruby
297
+ begin
298
+ # Attach an image to a blog post
299
+ data, status_code, headers = api_instance.attach_sfvb_blog_post_image_with_http_info(storefront_oid, blog_post_oid, blog_post_image_request)
300
+ p status_code # => 2xx
301
+ p headers # => { ... }
302
+ p data # => <SfvbBlogPostDetail>
303
+ rescue UltracartClient::ApiError => e
304
+ puts "Error when calling SfvbApi->attach_sfvb_blog_post_image_with_http_info: #{e}"
305
+ end
306
+ ```
307
+
308
+ ### Parameters
309
+
310
+ | Name | Type | Description | Notes |
311
+ | ---- | ---- | ----------- | ----- |
312
+ | **storefront_oid** | **Integer** | | |
313
+ | **blog_post_oid** | **Integer** | | |
314
+ | **blog_post_image_request** | [**SfvbBlogPostImageRequest**](SfvbBlogPostImageRequest.md) | Image to attach | |
315
+
316
+ ### Return type
317
+
318
+ [**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
319
+
320
+ ### Authorization
321
+
322
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
323
+
324
+ ### HTTP request headers
325
+
326
+ - **Content-Type**: application/json; charset=UTF-8
327
+ - **Accept**: application/json
328
+
329
+
267
330
  ## compile_sfvb_cjson
268
331
 
269
332
  > <SfvbCompileResponse> compile_sfvb_cjson(compile_request)
@@ -424,6 +487,60 @@ end
424
487
  - **Accept**: application/json
425
488
 
426
489
 
490
+ ## delete_sfvb_blog_post
491
+
492
+ > delete_sfvb_blog_post(storefront_oid, blog_post_oid)
493
+
494
+ Delete a blog post
495
+
496
+ Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
497
+
498
+
499
+ ### Examples
500
+
501
+
502
+ (No example for this operation).
503
+
504
+
505
+ #### Using the delete_sfvb_blog_post_with_http_info variant
506
+
507
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
508
+
509
+ > <Array(nil, Integer, Hash)> delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
510
+
511
+ ```ruby
512
+ begin
513
+ # Delete a blog post
514
+ data, status_code, headers = api_instance.delete_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
515
+ p status_code # => 2xx
516
+ p headers # => { ... }
517
+ p data # => nil
518
+ rescue UltracartClient::ApiError => e
519
+ puts "Error when calling SfvbApi->delete_sfvb_blog_post_with_http_info: #{e}"
520
+ end
521
+ ```
522
+
523
+ ### Parameters
524
+
525
+ | Name | Type | Description | Notes |
526
+ | ---- | ---- | ----------- | ----- |
527
+ | **storefront_oid** | **Integer** | | |
528
+ | **blog_post_oid** | **Integer** | | |
529
+
530
+ ### Return type
531
+
532
+ nil (empty response body)
533
+
534
+ ### Authorization
535
+
536
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
537
+
538
+ ### HTTP request headers
539
+
540
+ - **Content-Type**: Not defined
541
+ - **Accept**: application/json
542
+
543
+
427
544
  ## delete_sfvb_file
428
545
 
429
546
  > delete_sfvb_file(storefront_oid, if_match, opts)
@@ -702,6 +819,61 @@ nil (empty response body)
702
819
  - **Accept**: application/json
703
820
 
704
821
 
822
+ ## detach_sfvb_blog_post_image
823
+
824
+ > <SfvbBlogPostDetail> detach_sfvb_blog_post_image(storefront_oid, blog_post_oid, blog_post_image_request)
825
+
826
+ Detach an image from a blog post
827
+
828
+ Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
829
+
830
+
831
+ ### Examples
832
+
833
+
834
+ (No example for this operation).
835
+
836
+
837
+ #### Using the detach_sfvb_blog_post_image_with_http_info variant
838
+
839
+ This returns an Array which contains the response data, status code and headers.
840
+
841
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> detach_sfvb_blog_post_image_with_http_info(storefront_oid, blog_post_oid, blog_post_image_request)
842
+
843
+ ```ruby
844
+ begin
845
+ # Detach an image from a blog post
846
+ data, status_code, headers = api_instance.detach_sfvb_blog_post_image_with_http_info(storefront_oid, blog_post_oid, blog_post_image_request)
847
+ p status_code # => 2xx
848
+ p headers # => { ... }
849
+ p data # => <SfvbBlogPostDetail>
850
+ rescue UltracartClient::ApiError => e
851
+ puts "Error when calling SfvbApi->detach_sfvb_blog_post_image_with_http_info: #{e}"
852
+ end
853
+ ```
854
+
855
+ ### Parameters
856
+
857
+ | Name | Type | Description | Notes |
858
+ | ---- | ---- | ----------- | ----- |
859
+ | **storefront_oid** | **Integer** | | |
860
+ | **blog_post_oid** | **Integer** | | |
861
+ | **blog_post_image_request** | [**SfvbBlogPostImageRequest**](SfvbBlogPostImageRequest.md) | Image to detach | |
862
+
863
+ ### Return type
864
+
865
+ [**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
866
+
867
+ ### Authorization
868
+
869
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
870
+
871
+ ### HTTP request headers
872
+
873
+ - **Content-Type**: application/json; charset=UTF-8
874
+ - **Accept**: application/json
875
+
876
+
705
877
  ## disable_sfvb_upsell_offer
706
878
 
707
879
  > <SfvbUpsellOffer> disable_sfvb_upsell_offer(storefront_oid, upsell_offer_oid)
@@ -1137,6 +1309,60 @@ end
1137
1309
  - **Accept**: application/json
1138
1310
 
1139
1311
 
1312
+ ## get_sfvb_blog_post
1313
+
1314
+ > <SfvbBlogPostDetail> get_sfvb_blog_post(storefront_oid, blog_post_oid)
1315
+
1316
+ Read a blog post
1317
+
1318
+ The whole post - body, excerpt, tags, images and where it is shown. An image's url is the address to use for it in the body.
1319
+
1320
+
1321
+ ### Examples
1322
+
1323
+
1324
+ (No example for this operation).
1325
+
1326
+
1327
+ #### Using the get_sfvb_blog_post_with_http_info variant
1328
+
1329
+ This returns an Array which contains the response data, status code and headers.
1330
+
1331
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> get_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
1332
+
1333
+ ```ruby
1334
+ begin
1335
+ # Read a blog post
1336
+ data, status_code, headers = api_instance.get_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid)
1337
+ p status_code # => 2xx
1338
+ p headers # => { ... }
1339
+ p data # => <SfvbBlogPostDetail>
1340
+ rescue UltracartClient::ApiError => e
1341
+ puts "Error when calling SfvbApi->get_sfvb_blog_post_with_http_info: #{e}"
1342
+ end
1343
+ ```
1344
+
1345
+ ### Parameters
1346
+
1347
+ | Name | Type | Description | Notes |
1348
+ | ---- | ---- | ----------- | ----- |
1349
+ | **storefront_oid** | **Integer** | | |
1350
+ | **blog_post_oid** | **Integer** | | |
1351
+
1352
+ ### Return type
1353
+
1354
+ [**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
1355
+
1356
+ ### Authorization
1357
+
1358
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1359
+
1360
+ ### HTTP request headers
1361
+
1362
+ - **Content-Type**: Not defined
1363
+ - **Accept**: application/json
1364
+
1365
+
1140
1366
  ## get_sfvb_cjson_used_elements
1141
1367
 
1142
1368
  > <SfvbElementsResponse> get_sfvb_cjson_used_elements(compile_request)
@@ -2058,6 +2284,61 @@ end
2058
2284
  - **Accept**: application/json
2059
2285
 
2060
2286
 
2287
+ ## get_sfvb_server_log
2288
+
2289
+ > <SfvbServerLogDetail> get_sfvb_server_log(storefront_oid, log_id, opts)
2290
+
2291
+ Get one storefront render log
2292
+
2293
+ 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.
2294
+
2295
+
2296
+ ### Examples
2297
+
2298
+
2299
+ (No example for this operation).
2300
+
2301
+
2302
+ #### Using the get_sfvb_server_log_with_http_info variant
2303
+
2304
+ This returns an Array which contains the response data, status code and headers.
2305
+
2306
+ > <Array(<SfvbServerLogDetail>, Integer, Hash)> get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
2307
+
2308
+ ```ruby
2309
+ begin
2310
+ # Get one storefront render log
2311
+ data, status_code, headers = api_instance.get_sfvb_server_log_with_http_info(storefront_oid, log_id, opts)
2312
+ p status_code # => 2xx
2313
+ p headers # => { ... }
2314
+ p data # => <SfvbServerLogDetail>
2315
+ rescue UltracartClient::ApiError => e
2316
+ puts "Error when calling SfvbApi->get_sfvb_server_log_with_http_info: #{e}"
2317
+ end
2318
+ ```
2319
+
2320
+ ### Parameters
2321
+
2322
+ | Name | Type | Description | Notes |
2323
+ | ---- | ---- | ----------- | ----- |
2324
+ | **storefront_oid** | **Integer** | | |
2325
+ | **log_id** | **String** | | |
2326
+ | **min_level** | **String** | | [optional] |
2327
+
2328
+ ### Return type
2329
+
2330
+ [**SfvbServerLogDetail**](SfvbServerLogDetail.md)
2331
+
2332
+ ### Authorization
2333
+
2334
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2335
+
2336
+ ### HTTP request headers
2337
+
2338
+ - **Content-Type**: Not defined
2339
+ - **Accept**: application/json
2340
+
2341
+
2061
2342
  ## get_sfvb_site_attributes
2062
2343
 
2063
2344
  > <SfvbSiteAttributesResponse> get_sfvb_site_attributes(storefront_oid)
@@ -2489,6 +2770,60 @@ This endpoint does not need any parameter.
2489
2770
  - **Accept**: application/json
2490
2771
 
2491
2772
 
2773
+ ## insert_sfvb_blog_post
2774
+
2775
+ > <SfvbBlogPostDetail> insert_sfvb_blog_post(storefront_oid, blog_post_request)
2776
+
2777
+ Create a blog post
2778
+
2779
+ title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page's selectors choose it.
2780
+
2781
+
2782
+ ### Examples
2783
+
2784
+
2785
+ (No example for this operation).
2786
+
2787
+
2788
+ #### Using the insert_sfvb_blog_post_with_http_info variant
2789
+
2790
+ This returns an Array which contains the response data, status code and headers.
2791
+
2792
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
2793
+
2794
+ ```ruby
2795
+ begin
2796
+ # Create a blog post
2797
+ data, status_code, headers = api_instance.insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request)
2798
+ p status_code # => 2xx
2799
+ p headers # => { ... }
2800
+ p data # => <SfvbBlogPostDetail>
2801
+ rescue UltracartClient::ApiError => e
2802
+ puts "Error when calling SfvbApi->insert_sfvb_blog_post_with_http_info: #{e}"
2803
+ end
2804
+ ```
2805
+
2806
+ ### Parameters
2807
+
2808
+ | Name | Type | Description | Notes |
2809
+ | ---- | ---- | ----------- | ----- |
2810
+ | **storefront_oid** | **Integer** | | |
2811
+ | **blog_post_request** | [**SfvbBlogPostRequest**](SfvbBlogPostRequest.md) | The blog post to create | |
2812
+
2813
+ ### Return type
2814
+
2815
+ [**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
2816
+
2817
+ ### Authorization
2818
+
2819
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2820
+
2821
+ ### HTTP request headers
2822
+
2823
+ - **Content-Type**: application/json; charset=UTF-8
2824
+ - **Accept**: application/json
2825
+
2826
+
2492
2827
  ## insert_sfvb_page
2493
2828
 
2494
2829
  > <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
@@ -3147,6 +3482,63 @@ end
3147
3482
  - **Accept**: application/json
3148
3483
 
3149
3484
 
3485
+ ## list_sfvb_server_logs
3486
+
3487
+ > <SfvbServerLogsResponse> list_sfvb_server_logs(storefront_oid, opts)
3488
+
3489
+ List recent storefront render logs
3490
+
3491
+ The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
3492
+
3493
+
3494
+ ### Examples
3495
+
3496
+
3497
+ (No example for this operation).
3498
+
3499
+
3500
+ #### Using the list_sfvb_server_logs_with_http_info variant
3501
+
3502
+ This returns an Array which contains the response data, status code and headers.
3503
+
3504
+ > <Array(<SfvbServerLogsResponse>, Integer, Hash)> list_sfvb_server_logs_with_http_info(storefront_oid, opts)
3505
+
3506
+ ```ruby
3507
+ begin
3508
+ # List recent storefront render logs
3509
+ data, status_code, headers = api_instance.list_sfvb_server_logs_with_http_info(storefront_oid, opts)
3510
+ p status_code # => 2xx
3511
+ p headers # => { ... }
3512
+ p data # => <SfvbServerLogsResponse>
3513
+ rescue UltracartClient::ApiError => e
3514
+ puts "Error when calling SfvbApi->list_sfvb_server_logs_with_http_info: #{e}"
3515
+ end
3516
+ ```
3517
+
3518
+ ### Parameters
3519
+
3520
+ | Name | Type | Description | Notes |
3521
+ | ---- | ---- | ----------- | ----- |
3522
+ | **storefront_oid** | **Integer** | | |
3523
+ | **uri** | **String** | | [optional] |
3524
+ | **since** | **String** | | [optional] |
3525
+ | **errors_only** | **Boolean** | | [optional] |
3526
+ | **limit** | **Integer** | | [optional] |
3527
+
3528
+ ### Return type
3529
+
3530
+ [**SfvbServerLogsResponse**](SfvbServerLogsResponse.md)
3531
+
3532
+ ### Authorization
3533
+
3534
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3535
+
3536
+ ### HTTP request headers
3537
+
3538
+ - **Content-Type**: Not defined
3539
+ - **Accept**: application/json
3540
+
3541
+
3150
3542
  ## list_sfvb_storefronts
3151
3543
 
3152
3544
  > <SfvbStorefrontsResponse> list_sfvb_storefronts
@@ -4972,6 +5364,61 @@ end
4972
5364
  - **Accept**: application/json
4973
5365
 
4974
5366
 
5367
+ ## update_sfvb_blog_post
5368
+
5369
+ > <SfvbBlogPostDetail> update_sfvb_blog_post(storefront_oid, blog_post_oid, blog_post_request)
5370
+
5371
+ Change a blog post
5372
+
5373
+ Only the fields sent change; tags, when sent, replaces every tag. The post's images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
5374
+
5375
+
5376
+ ### Examples
5377
+
5378
+
5379
+ (No example for this operation).
5380
+
5381
+
5382
+ #### Using the update_sfvb_blog_post_with_http_info variant
5383
+
5384
+ This returns an Array which contains the response data, status code and headers.
5385
+
5386
+ > <Array(<SfvbBlogPostDetail>, Integer, Hash)> update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request)
5387
+
5388
+ ```ruby
5389
+ begin
5390
+ # Change a blog post
5391
+ data, status_code, headers = api_instance.update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request)
5392
+ p status_code # => 2xx
5393
+ p headers # => { ... }
5394
+ p data # => <SfvbBlogPostDetail>
5395
+ rescue UltracartClient::ApiError => e
5396
+ puts "Error when calling SfvbApi->update_sfvb_blog_post_with_http_info: #{e}"
5397
+ end
5398
+ ```
5399
+
5400
+ ### Parameters
5401
+
5402
+ | Name | Type | Description | Notes |
5403
+ | ---- | ---- | ----------- | ----- |
5404
+ | **storefront_oid** | **Integer** | | |
5405
+ | **blog_post_oid** | **Integer** | | |
5406
+ | **blog_post_request** | [**SfvbBlogPostRequest**](SfvbBlogPostRequest.md) | The fields to change | |
5407
+
5408
+ ### Return type
5409
+
5410
+ [**SfvbBlogPostDetail**](SfvbBlogPostDetail.md)
5411
+
5412
+ ### Authorization
5413
+
5414
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
5415
+
5416
+ ### HTTP request headers
5417
+
5418
+ - **Content-Type**: application/json; charset=UTF-8
5419
+ - **Accept**: application/json
5420
+
5421
+
4975
5422
  ## update_sfvb_upsell_offer
4976
5423
 
4977
5424
  > <SfvbUpsellOffer> update_sfvb_upsell_offer(storefront_oid, upsell_offer_oid, if_match, upsell_offer)
@@ -0,0 +1,46 @@
1
+ # UltracartClient::SfvbBlogPostDetail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allow_comments** | **Boolean** | Whether shoppers may comment. | [optional] |
8
+ | **author** | **String** | The post author. | [optional] |
9
+ | **blog_post_oid** | **Integer** | The blog post&#39;s oid. This is what a page&#39;s blog post assignment names. | [optional] |
10
+ | **body** | **String** | The post body as HTML, exactly as stored. | [optional] |
11
+ | **created_dts** | **String** | When the post was created (ISO 8601, UTC). | [optional] |
12
+ | **excerpt** | **String** | The post excerpt as HTML, exactly as stored. | [optional] |
13
+ | **images** | [**Array&lt;SfvbBlogPostImage&gt;**](SfvbBlogPostImage.md) | The post&#39;s images, the default image first. | [optional] |
14
+ | **last_modified_dts** | **String** | When the post was last changed (ISO 8601, UTC), or null if it never was. | [optional] |
15
+ | **publication_dts** | **String** | When the post is published (ISO 8601, UTC), or null for a draft. | [optional] |
16
+ | **tags** | **Array&lt;String&gt;** | The post&#39;s tags. | [optional] |
17
+ | **title** | **String** | The post title. | [optional] |
18
+ | **unassigned** | **Boolean** | True when no page shows this post yet. | [optional] |
19
+ | **url_part** | **String** | The post&#39;s name in its URL. | [optional] |
20
+ | **view_url** | **String** | The post&#39;s address on the storefront, or null until a page shows it. | [optional] |
21
+ | **visibility** | **String** | P public, L logged in customers only, D draft. | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'ultracart_api'
27
+
28
+ instance = UltracartClient::SfvbBlogPostDetail.new(
29
+ allow_comments: null,
30
+ author: null,
31
+ blog_post_oid: null,
32
+ body: null,
33
+ created_dts: null,
34
+ excerpt: null,
35
+ images: null,
36
+ last_modified_dts: null,
37
+ publication_dts: null,
38
+ tags: null,
39
+ title: null,
40
+ unassigned: null,
41
+ url_part: null,
42
+ view_url: null,
43
+ visibility: null
44
+ )
45
+ ```
46
+
@@ -0,0 +1,32 @@
1
+ # UltracartClient::SfvbBlogPostImage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **blog_post_multimedia_oid** | **Integer** | The image&#39;s oid. Detach names it this way. | [optional] |
8
+ | **code** | **String** | The image code, or null for the default image and for an image used only in the body. | [optional] |
9
+ | **default_image** | **Boolean** | True for the post&#39;s default image, which a blogpostimage element and og image use. | [optional] |
10
+ | **description** | **String** | The description stored with the image, used as its alt text. | [optional] |
11
+ | **filename** | **String** | The image&#39;s file name. | [optional] |
12
+ | **height** | **Integer** | Height in pixels, when it could be measured. | [optional] |
13
+ | **url** | **String** | The address to use in the post body, for example in an img src. The storefront serves it from its image CDN once the image has been copied there. | [optional] |
14
+ | **width** | **Integer** | Width in pixels, when it could be measured. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::SfvbBlogPostImage.new(
22
+ blog_post_multimedia_oid: null,
23
+ code: null,
24
+ default_image: null,
25
+ description: null,
26
+ filename: null,
27
+ height: null,
28
+ url: null,
29
+ width: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,28 @@
1
+ # UltracartClient::SfvbBlogPostImageRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **blog_post_multimedia_oid** | **Integer** | Detach only. The oid of the image to remove, as the post&#39;s images report it. | [optional] |
8
+ | **code** | **String** | An image code. On attach it replaces any image with that code. Leave out both code and default_image on attach to add an image used only in the body. | [optional] |
9
+ | **default_image** | **Boolean** | True for the post&#39;s default image, which a blogpostimage element and og image use. On attach it replaces any existing default. | [optional] |
10
+ | **description** | **String** | Attach only. Stored with the image and used as its alt text, as plain text. | [optional] |
11
+ | **filename** | **String** | Attach only. The image&#39;s name in its address, for example hero.png, with the same extension the upload was requested with. Letters, digits, dots, hyphens, underscores and parentheses, and not already used by another image on the post. | [optional] |
12
+ | **key** | **String** | Attach only. The key files/upload_url returned for the image&#39;s bytes. A JPEG, PNG, GIF or WebP image. Attaching redeems the key, so it cannot be used again. | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ultracart_api'
18
+
19
+ instance = UltracartClient::SfvbBlogPostImageRequest.new(
20
+ blog_post_multimedia_oid: null,
21
+ code: null,
22
+ default_image: null,
23
+ description: null,
24
+ filename: null,
25
+ key: null
26
+ )
27
+ ```
28
+