ultracart_api 4.1.208 → 4.1.210

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -2
  3. data/docs/SfvbApi.md +717 -48
  4. data/docs/SfvbArchiveRequest.md +18 -0
  5. data/docs/SfvbCampaign.md +16 -0
  6. data/docs/SfvbCampaignMembership.md +24 -0
  7. data/docs/SfvbCampaignWriteRequest.md +32 -0
  8. data/docs/SfvbCommsEmail.md +6 -0
  9. data/docs/SfvbCommsList.md +24 -0
  10. data/docs/SfvbCommsListsResponse.md +18 -0
  11. data/docs/SfvbCommsSegment.md +26 -0
  12. data/docs/SfvbCommsSegmentsResponse.md +18 -0
  13. data/docs/SfvbEmail.md +2 -0
  14. data/docs/SfvbEmailReviewRequest.md +18 -0
  15. data/docs/SfvbFlow.md +22 -0
  16. data/docs/SfvbFlowStatusRequest.md +18 -0
  17. data/docs/SfvbFlowWriteRequest.md +38 -0
  18. data/lib/ultracart_api/api/sfvb_api.rb +1027 -88
  19. data/lib/ultracart_api/models/sfvb_archive_request.rb +220 -0
  20. data/lib/ultracart_api/models/sfvb_campaign.rb +85 -1
  21. data/lib/ultracart_api/models/sfvb_campaign_membership.rb +250 -0
  22. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +292 -0
  23. data/lib/ultracart_api/models/sfvb_comms_email.rb +31 -1
  24. data/lib/ultracart_api/models/sfvb_comms_list.rb +250 -0
  25. data/lib/ultracart_api/models/sfvb_comms_lists_response.rb +222 -0
  26. data/lib/ultracart_api/models/sfvb_comms_segment.rb +260 -0
  27. data/lib/ultracart_api/models/sfvb_comms_segments_response.rb +222 -0
  28. data/lib/ultracart_api/models/sfvb_email.rb +13 -1
  29. data/lib/ultracart_api/models/sfvb_email_review_request.rb +220 -0
  30. data/lib/ultracart_api/models/sfvb_flow.rb +113 -1
  31. data/lib/ultracart_api/models/sfvb_flow_status_request.rb +254 -0
  32. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +354 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +10 -0
  35. metadata +22 -2
data/docs/SfvbApi.md CHANGED
@@ -6,11 +6,17 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
6
6
  | ------ | ------------ | ----------- |
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
+ | [**archive_sfvb_campaign**](SfvbApi.md#archive_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/archive | Archive or unarchive a campaign |
10
+ | [**archive_sfvb_flow**](SfvbApi.md#archive_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/archive | Archive or unarchive a flow |
9
11
  | [**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
12
  | [**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 |
11
13
  | [**check_sfvb_redirect**](SfvbApi.md#check_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/check | Check a redirect rule without creating it |
12
14
  | [**clear_sfvb_library_screenshot**](SfvbApi.md#clear_sfvb_library_screenshot) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot | Remove a library entry's screenshot |
15
+ | [**clone_sfvb_campaign**](SfvbApi.md#clone_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}/clone | Copy a campaign on the same storefront |
16
+ | [**clone_sfvb_flow**](SfvbApi.md#clone_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/clone | Copy a flow on the same storefront |
13
17
  | [**compile_sfvb_cjson**](SfvbApi.md#compile_sfvb_cjson) | **POST** /sfvb/cjson/compile | Compile CJSON to Velocity |
18
+ | [**create_sfvb_campaign**](SfvbApi.md#create_sfvb_campaign) | **POST** /sfvb/storefronts/{storefront_oid}/campaigns | Create a draft campaign |
19
+ | [**create_sfvb_flow**](SfvbApi.md#create_sfvb_flow) | **POST** /sfvb/storefronts/{storefront_oid}/flows | Create a draft flow |
14
20
  | [**create_sfvb_library_entry**](SfvbApi.md#create_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library | Save a fragment to the library |
15
21
  | [**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 |
16
22
  | [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
@@ -119,6 +125,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
119
125
  | [**install_sfvb_library_entry**](SfvbApi.md#install_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/install | Install a library entry into a storefront |
120
126
  | [**list_sfvb_blog_posts**](SfvbApi.md#list_sfvb_blog_posts) | **GET** /sfvb/storefronts/{storefront_oid}/blog_posts | List the storefront's blog posts |
121
127
  | [**list_sfvb_campaigns**](SfvbApi.md#list_sfvb_campaigns) | **GET** /sfvb/storefronts/{storefront_oid}/campaigns | List the storefront's campaigns |
128
+ | [**list_sfvb_comms_lists**](SfvbApi.md#list_sfvb_comms_lists) | **GET** /sfvb/storefronts/{storefront_oid}/lists | List the storefront's email lists |
129
+ | [**list_sfvb_comms_segments**](SfvbApi.md#list_sfvb_comms_segments) | **GET** /sfvb/storefronts/{storefront_oid}/segments | List the storefront's segments |
122
130
  | [**list_sfvb_container_versions**](SfvbApi.md#list_sfvb_container_versions) | **GET** /sfvb/storefronts/{storefront_oid}/container_versions | Version history for a container stored outside the file system |
123
131
  | [**list_sfvb_elements**](SfvbApi.md#list_sfvb_elements) | **GET** /sfvb/elements | List every SFVB element type |
124
132
  | [**list_sfvb_experiments**](SfvbApi.md#list_sfvb_experiments) | **GET** /sfvb/storefronts/{storefront_oid}/experiments | List the storefront's experiments |
@@ -171,6 +179,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
171
179
  | [**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 |
172
180
  | [**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 |
173
181
  | [**revert_sfvb_file**](SfvbApi.md#revert_sfvb_file) | **POST** /sfvb/storefronts/{storefront_oid}/files/revert | Revert a storefront file to an earlier version |
182
+ | [**review_sfvb_email**](SfvbApi.md#review_sfvb_email) | **POST** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid}/review | Request a content review of a flow or campaign email |
174
183
  | [**revoke_sfvb_secret_request**](SfvbApi.md#revoke_sfvb_secret_request) | **POST** /sfvb/secrets/{request_id}/revoke | Revoke a fulfilled request's unused handles |
175
184
  | [**search_sfvb_files**](SfvbApi.md#search_sfvb_files) | **POST** /sfvb/storefronts/{storefront_oid}/files/search | Search storefront files |
176
185
  | [**search_sfvb_library**](SfvbApi.md#search_sfvb_library) | **GET** /sfvb/storefronts/{storefront_oid}/library | Search the element library |
@@ -183,9 +192,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
183
192
  | [**unpublish_sfvb_library_entry**](SfvbApi.md#unpublish_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/unpublish | Narrow who can see a library entry |
184
193
  | [**unshare_sfvb_library_entry**](SfvbApi.md#unshare_sfvb_library_entry) | **DELETE** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares/{merchant_id} | Stop sharing a library entry with an account |
185
194
  | [**update_sfvb_blog_post**](SfvbApi.md#update_sfvb_blog_post) | **PUT** /sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid} | Change a blog post |
195
+ | [**update_sfvb_campaign**](SfvbApi.md#update_sfvb_campaign) | **PUT** /sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid} | Change a campaign |
186
196
  | [**update_sfvb_comms_sending_domain**](SfvbApi.md#update_sfvb_comms_sending_domain) | **PUT** /sfvb/comms/sending_domains/{domain} | Update a sending domain |
187
197
  | [**update_sfvb_comms_twilio_account**](SfvbApi.md#update_sfvb_comms_twilio_account) | **PUT** /sfvb/comms/twilio_account | Update the Twilio account |
188
198
  | [**update_sfvb_email**](SfvbApi.md#update_sfvb_email) | **PUT** /sfvb/storefronts/{storefront_oid}/emails/{email_uuid} | Change a flow or campaign email's subject or preview text |
199
+ | [**update_sfvb_flow**](SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow |
200
+ | [**update_sfvb_flow_status**](SfvbApi.md#update_sfvb_flow_status) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/status | Turn a flow on or off |
189
201
  | [**update_sfvb_item_attribute_batch**](SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call |
190
202
  | [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
191
203
  | [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
@@ -306,6 +318,118 @@ end
306
318
  - **Accept**: application/json
307
319
 
308
320
 
321
+ ## archive_sfvb_campaign
322
+
323
+ > <SfvbCampaign> archive_sfvb_campaign(storefront_oid, campaign_uuid, if_match, archive_request)
324
+
325
+ Archive or unarchive a campaign
326
+
327
+ Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so. A campaign whose send is under way is refused with sfvb.campaign_sending. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish.
328
+
329
+
330
+ ### Examples
331
+
332
+
333
+ (No example for this operation).
334
+
335
+
336
+ #### Using the archive_sfvb_campaign_with_http_info variant
337
+
338
+ This returns an Array which contains the response data, status code and headers.
339
+
340
+ > <Array(<SfvbCampaign>, Integer, Hash)> archive_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, archive_request)
341
+
342
+ ```ruby
343
+ begin
344
+ # Archive or unarchive a campaign
345
+ data, status_code, headers = api_instance.archive_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, archive_request)
346
+ p status_code # => 2xx
347
+ p headers # => { ... }
348
+ p data # => <SfvbCampaign>
349
+ rescue UltracartClient::ApiError => e
350
+ puts "Error when calling SfvbApi->archive_sfvb_campaign_with_http_info: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Name | Type | Description | Notes |
357
+ | ---- | ---- | ----------- | ----- |
358
+ | **storefront_oid** | **Integer** | | |
359
+ | **campaign_uuid** | **String** | | |
360
+ | **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
361
+ | **archive_request** | [**SfvbArchiveRequest**](SfvbArchiveRequest.md) | Whether to archive | |
362
+
363
+ ### Return type
364
+
365
+ [**SfvbCampaign**](SfvbCampaign.md)
366
+
367
+ ### Authorization
368
+
369
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
370
+
371
+ ### HTTP request headers
372
+
373
+ - **Content-Type**: application/json
374
+ - **Accept**: application/json
375
+
376
+
377
+ ## archive_sfvb_flow
378
+
379
+ > <SfvbFlow> archive_sfvb_flow(storefront_oid, flow_uuid, if_match, archive_request)
380
+
381
+ Archive or unarchive a flow
382
+
383
+ A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
384
+
385
+
386
+ ### Examples
387
+
388
+
389
+ (No example for this operation).
390
+
391
+
392
+ #### Using the archive_sfvb_flow_with_http_info variant
393
+
394
+ This returns an Array which contains the response data, status code and headers.
395
+
396
+ > <Array(<SfvbFlow>, Integer, Hash)> archive_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, archive_request)
397
+
398
+ ```ruby
399
+ begin
400
+ # Archive or unarchive a flow
401
+ data, status_code, headers = api_instance.archive_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, archive_request)
402
+ p status_code # => 2xx
403
+ p headers # => { ... }
404
+ p data # => <SfvbFlow>
405
+ rescue UltracartClient::ApiError => e
406
+ puts "Error when calling SfvbApi->archive_sfvb_flow_with_http_info: #{e}"
407
+ end
408
+ ```
409
+
410
+ ### Parameters
411
+
412
+ | Name | Type | Description | Notes |
413
+ | ---- | ---- | ----------- | ----- |
414
+ | **storefront_oid** | **Integer** | | |
415
+ | **flow_uuid** | **String** | | |
416
+ | **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
417
+ | **archive_request** | [**SfvbArchiveRequest**](SfvbArchiveRequest.md) | Whether to archive | |
418
+
419
+ ### Return type
420
+
421
+ [**SfvbFlow**](SfvbFlow.md)
422
+
423
+ ### Authorization
424
+
425
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
426
+
427
+ ### HTTP request headers
428
+
429
+ - **Content-Type**: application/json
430
+ - **Accept**: application/json
431
+
432
+
309
433
  ## archive_sfvb_upsell_path
310
434
 
311
435
  > <SfvbUpsellPath> archive_sfvb_upsell_path(storefront_oid, upsell_path_oid)
@@ -524,6 +648,114 @@ end
524
648
  - **Accept**: application/json
525
649
 
526
650
 
651
+ ## clone_sfvb_campaign
652
+
653
+ > <SfvbCampaign> clone_sfvb_campaign(storefront_oid, campaign_uuid)
654
+
655
+ Copy a campaign on the same storefront
656
+
657
+ A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
658
+
659
+
660
+ ### Examples
661
+
662
+
663
+ (No example for this operation).
664
+
665
+
666
+ #### Using the clone_sfvb_campaign_with_http_info variant
667
+
668
+ This returns an Array which contains the response data, status code and headers.
669
+
670
+ > <Array(<SfvbCampaign>, Integer, Hash)> clone_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
671
+
672
+ ```ruby
673
+ begin
674
+ # Copy a campaign on the same storefront
675
+ data, status_code, headers = api_instance.clone_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid)
676
+ p status_code # => 2xx
677
+ p headers # => { ... }
678
+ p data # => <SfvbCampaign>
679
+ rescue UltracartClient::ApiError => e
680
+ puts "Error when calling SfvbApi->clone_sfvb_campaign_with_http_info: #{e}"
681
+ end
682
+ ```
683
+
684
+ ### Parameters
685
+
686
+ | Name | Type | Description | Notes |
687
+ | ---- | ---- | ----------- | ----- |
688
+ | **storefront_oid** | **Integer** | | |
689
+ | **campaign_uuid** | **String** | | |
690
+
691
+ ### Return type
692
+
693
+ [**SfvbCampaign**](SfvbCampaign.md)
694
+
695
+ ### Authorization
696
+
697
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
698
+
699
+ ### HTTP request headers
700
+
701
+ - **Content-Type**: Not defined
702
+ - **Accept**: application/json
703
+
704
+
705
+ ## clone_sfvb_flow
706
+
707
+ > <SfvbFlow> clone_sfvb_flow(storefront_oid, flow_uuid)
708
+
709
+ Copy a flow on the same storefront
710
+
711
+ A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived. It enrolls nobody until it is turned on. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
712
+
713
+
714
+ ### Examples
715
+
716
+
717
+ (No example for this operation).
718
+
719
+
720
+ #### Using the clone_sfvb_flow_with_http_info variant
721
+
722
+ This returns an Array which contains the response data, status code and headers.
723
+
724
+ > <Array(<SfvbFlow>, Integer, Hash)> clone_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
725
+
726
+ ```ruby
727
+ begin
728
+ # Copy a flow on the same storefront
729
+ data, status_code, headers = api_instance.clone_sfvb_flow_with_http_info(storefront_oid, flow_uuid)
730
+ p status_code # => 2xx
731
+ p headers # => { ... }
732
+ p data # => <SfvbFlow>
733
+ rescue UltracartClient::ApiError => e
734
+ puts "Error when calling SfvbApi->clone_sfvb_flow_with_http_info: #{e}"
735
+ end
736
+ ```
737
+
738
+ ### Parameters
739
+
740
+ | Name | Type | Description | Notes |
741
+ | ---- | ---- | ----------- | ----- |
742
+ | **storefront_oid** | **Integer** | | |
743
+ | **flow_uuid** | **String** | | |
744
+
745
+ ### Return type
746
+
747
+ [**SfvbFlow**](SfvbFlow.md)
748
+
749
+ ### Authorization
750
+
751
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
752
+
753
+ ### HTTP request headers
754
+
755
+ - **Content-Type**: Not defined
756
+ - **Accept**: application/json
757
+
758
+
527
759
  ## compile_sfvb_cjson
528
760
 
529
761
  > <SfvbCompileResponse> compile_sfvb_cjson(compile_request)
@@ -577,6 +809,114 @@ end
577
809
  - **Accept**: application/json
578
810
 
579
811
 
812
+ ## create_sfvb_campaign
813
+
814
+ > <SfvbCampaign> create_sfvb_campaign(storefront_oid, campaign_write_request)
815
+
816
+ Create a draft campaign
817
+
818
+ A new draft campaign with an empty communication sequence. name is required. The sender defaults to the storefront's marketing sending settings. Nothing here starts a campaign.
819
+
820
+
821
+ ### Examples
822
+
823
+
824
+ (No example for this operation).
825
+
826
+
827
+ #### Using the create_sfvb_campaign_with_http_info variant
828
+
829
+ This returns an Array which contains the response data, status code and headers.
830
+
831
+ > <Array(<SfvbCampaign>, Integer, Hash)> create_sfvb_campaign_with_http_info(storefront_oid, campaign_write_request)
832
+
833
+ ```ruby
834
+ begin
835
+ # Create a draft campaign
836
+ data, status_code, headers = api_instance.create_sfvb_campaign_with_http_info(storefront_oid, campaign_write_request)
837
+ p status_code # => 2xx
838
+ p headers # => { ... }
839
+ p data # => <SfvbCampaign>
840
+ rescue UltracartClient::ApiError => e
841
+ puts "Error when calling SfvbApi->create_sfvb_campaign_with_http_info: #{e}"
842
+ end
843
+ ```
844
+
845
+ ### Parameters
846
+
847
+ | Name | Type | Description | Notes |
848
+ | ---- | ---- | ----------- | ----- |
849
+ | **storefront_oid** | **Integer** | | |
850
+ | **campaign_write_request** | [**SfvbCampaignWriteRequest**](SfvbCampaignWriteRequest.md) | The campaign to create | |
851
+
852
+ ### Return type
853
+
854
+ [**SfvbCampaign**](SfvbCampaign.md)
855
+
856
+ ### Authorization
857
+
858
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
859
+
860
+ ### HTTP request headers
861
+
862
+ - **Content-Type**: application/json
863
+ - **Accept**: application/json
864
+
865
+
866
+ ## create_sfvb_flow
867
+
868
+ > <SfvbFlow> create_sfvb_flow(storefront_oid, flow_write_request)
869
+
870
+ Create a draft flow
871
+
872
+ A new draft flow with an empty communication sequence. name and trigger_type are required. A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront. The sender defaults to the storefront's marketing sending settings. A draft flow enrolls nobody until it is turned on.
873
+
874
+
875
+ ### Examples
876
+
877
+
878
+ (No example for this operation).
879
+
880
+
881
+ #### Using the create_sfvb_flow_with_http_info variant
882
+
883
+ This returns an Array which contains the response data, status code and headers.
884
+
885
+ > <Array(<SfvbFlow>, Integer, Hash)> create_sfvb_flow_with_http_info(storefront_oid, flow_write_request)
886
+
887
+ ```ruby
888
+ begin
889
+ # Create a draft flow
890
+ data, status_code, headers = api_instance.create_sfvb_flow_with_http_info(storefront_oid, flow_write_request)
891
+ p status_code # => 2xx
892
+ p headers # => { ... }
893
+ p data # => <SfvbFlow>
894
+ rescue UltracartClient::ApiError => e
895
+ puts "Error when calling SfvbApi->create_sfvb_flow_with_http_info: #{e}"
896
+ end
897
+ ```
898
+
899
+ ### Parameters
900
+
901
+ | Name | Type | Description | Notes |
902
+ | ---- | ---- | ----------- | ----- |
903
+ | **storefront_oid** | **Integer** | | |
904
+ | **flow_write_request** | [**SfvbFlowWriteRequest**](SfvbFlowWriteRequest.md) | The flow to create | |
905
+
906
+ ### Return type
907
+
908
+ [**SfvbFlow**](SfvbFlow.md)
909
+
910
+ ### Authorization
911
+
912
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
913
+
914
+ ### HTTP request headers
915
+
916
+ - **Content-Type**: application/json
917
+ - **Accept**: application/json
918
+
919
+
580
920
  ## create_sfvb_library_entry
581
921
 
582
922
  > <SfvbLibraryEntry> create_sfvb_library_entry(storefront_oid, library_entry)
@@ -6234,9 +6574,118 @@ begin
6234
6574
  data, status_code, headers = api_instance.insert_sfvb_upsell_path_with_http_info(storefront_oid, upsell_path)
6235
6575
  p status_code # => 2xx
6236
6576
  p headers # => { ... }
6237
- p data # => <SfvbUpsellPath>
6577
+ p data # => <SfvbUpsellPath>
6578
+ rescue UltracartClient::ApiError => e
6579
+ puts "Error when calling SfvbApi->insert_sfvb_upsell_path_with_http_info: #{e}"
6580
+ end
6581
+ ```
6582
+
6583
+ ### Parameters
6584
+
6585
+ | Name | Type | Description | Notes |
6586
+ | ---- | ---- | ----------- | ----- |
6587
+ | **storefront_oid** | **Integer** | | |
6588
+ | **upsell_path** | [**SfvbUpsellPath**](SfvbUpsellPath.md) | The path to create | |
6589
+
6590
+ ### Return type
6591
+
6592
+ [**SfvbUpsellPath**](SfvbUpsellPath.md)
6593
+
6594
+ ### Authorization
6595
+
6596
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6597
+
6598
+ ### HTTP request headers
6599
+
6600
+ - **Content-Type**: application/json; charset=UTF-8
6601
+ - **Accept**: application/json
6602
+
6603
+
6604
+ ## install_sfvb_library_entry
6605
+
6606
+ > <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
6607
+
6608
+ Install a library entry into a storefront
6609
+
6610
+ Copies the fragment's referenced files into the storefront file system and returns a receipt with the CJSON's paths resolved, ready to place. It never places the CJSON. Read content_manifest first; executable content needs acknowledge_executable true. A file that already exists with different content is a conflict - on_conflict fail (the default) refuses with 409 and writes nothing, skip keeps the existing file, overwrite replaces it. A recipient installs a published revision. This writes, which is why it is a POST, and it requires sfvb_publish because the files land in the shared storefront file system, which is served to shoppers whichever theme is active.
6611
+
6612
+
6613
+ ### Examples
6614
+
6615
+
6616
+ (No example for this operation).
6617
+
6618
+
6619
+ #### Using the install_sfvb_library_entry_with_http_info variant
6620
+
6621
+ This returns an Array which contains the response data, status code and headers.
6622
+
6623
+ > <Array(<SfvbLibraryInstallReceipt>, Integer, Hash)> install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
6624
+
6625
+ ```ruby
6626
+ begin
6627
+ # Install a library entry into a storefront
6628
+ data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
6629
+ p status_code # => 2xx
6630
+ p headers # => { ... }
6631
+ p data # => <SfvbLibraryInstallReceipt>
6632
+ rescue UltracartClient::ApiError => e
6633
+ puts "Error when calling SfvbApi->install_sfvb_library_entry_with_http_info: #{e}"
6634
+ end
6635
+ ```
6636
+
6637
+ ### Parameters
6638
+
6639
+ | Name | Type | Description | Notes |
6640
+ | ---- | ---- | ----------- | ----- |
6641
+ | **storefront_oid** | **Integer** | | |
6642
+ | **library_oid** | **Integer** | | |
6643
+ | **install_request** | [**SfvbLibraryInstallRequest**](SfvbLibraryInstallRequest.md) | Revision, conflict handling and acknowledgement | [optional] |
6644
+
6645
+ ### Return type
6646
+
6647
+ [**SfvbLibraryInstallReceipt**](SfvbLibraryInstallReceipt.md)
6648
+
6649
+ ### Authorization
6650
+
6651
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6652
+
6653
+ ### HTTP request headers
6654
+
6655
+ - **Content-Type**: application/json; charset=UTF-8
6656
+ - **Accept**: application/json
6657
+
6658
+
6659
+ ## list_sfvb_blog_posts
6660
+
6661
+ > <SfvbBlogPostsResponse> list_sfvb_blog_posts(storefront_oid, opts)
6662
+
6663
+ List the storefront's blog posts
6664
+
6665
+ One page of blog posts, newest first, without their bodies. search matches the title, body, excerpt, url part or author, or a tag exactly. unassigned marks posts no page shows yet. Use a post's blog_post_oid to assign it to a page.
6666
+
6667
+
6668
+ ### Examples
6669
+
6670
+
6671
+ (No example for this operation).
6672
+
6673
+
6674
+ #### Using the list_sfvb_blog_posts_with_http_info variant
6675
+
6676
+ This returns an Array which contains the response data, status code and headers.
6677
+
6678
+ > <Array(<SfvbBlogPostsResponse>, Integer, Hash)> list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
6679
+
6680
+ ```ruby
6681
+ begin
6682
+ # List the storefront's blog posts
6683
+ data, status_code, headers = api_instance.list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
6684
+ p status_code # => 2xx
6685
+ p headers # => { ... }
6686
+ p data # => <SfvbBlogPostsResponse>
6238
6687
  rescue UltracartClient::ApiError => e
6239
- puts "Error when calling SfvbApi->insert_sfvb_upsell_path_with_http_info: #{e}"
6688
+ puts "Error when calling SfvbApi->list_sfvb_blog_posts_with_http_info: #{e}"
6240
6689
  end
6241
6690
  ```
6242
6691
 
@@ -6245,11 +6694,13 @@ end
6245
6694
  | Name | Type | Description | Notes |
6246
6695
  | ---- | ---- | ----------- | ----- |
6247
6696
  | **storefront_oid** | **Integer** | | |
6248
- | **upsell_path** | [**SfvbUpsellPath**](SfvbUpsellPath.md) | The path to create | |
6697
+ | **search** | **String** | Text to search for | [optional] |
6698
+ | **page** | **Integer** | Page number, starting at 1 | [optional] |
6699
+ | **page_size** | **Integer** | Posts per page, 1 to 100, default 50 | [optional] |
6249
6700
 
6250
6701
  ### Return type
6251
6702
 
6252
- [**SfvbUpsellPath**](SfvbUpsellPath.md)
6703
+ [**SfvbBlogPostsResponse**](SfvbBlogPostsResponse.md)
6253
6704
 
6254
6705
  ### Authorization
6255
6706
 
@@ -6257,17 +6708,17 @@ end
6257
6708
 
6258
6709
  ### HTTP request headers
6259
6710
 
6260
- - **Content-Type**: application/json; charset=UTF-8
6711
+ - **Content-Type**: Not defined
6261
6712
  - **Accept**: application/json
6262
6713
 
6263
6714
 
6264
- ## install_sfvb_library_entry
6715
+ ## list_sfvb_campaigns
6265
6716
 
6266
- > <SfvbLibraryInstallReceipt> install_sfvb_library_entry(storefront_oid, library_oid, opts)
6717
+ > <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
6267
6718
 
6268
- Install a library entry into a storefront
6719
+ List the storefront's campaigns
6269
6720
 
6270
- Copies the fragment's referenced files into the storefront file system and returns a receipt with the CJSON's paths resolved, ready to place. It never places the CJSON. Read content_manifest first; executable content needs acknowledge_executable true. A file that already exists with different content is a conflict - on_conflict fail (the default) refuses with 409 and writes nothing, skip keeps the existing file, overwrite replaces it. A recipient installs a published revision. This writes, which is why it is a POST, and it requires sfvb_publish because the files land in the shared storefront file system, which is served to shoppers whichever theme is active.
6721
+ One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
6271
6722
 
6272
6723
 
6273
6724
  ### Examples
@@ -6276,21 +6727,21 @@ Copies the fragment's referenced files into the storefront file system and retur
6276
6727
  (No example for this operation).
6277
6728
 
6278
6729
 
6279
- #### Using the install_sfvb_library_entry_with_http_info variant
6730
+ #### Using the list_sfvb_campaigns_with_http_info variant
6280
6731
 
6281
6732
  This returns an Array which contains the response data, status code and headers.
6282
6733
 
6283
- > <Array(<SfvbLibraryInstallReceipt>, Integer, Hash)> install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
6734
+ > <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
6284
6735
 
6285
6736
  ```ruby
6286
6737
  begin
6287
- # Install a library entry into a storefront
6288
- data, status_code, headers = api_instance.install_sfvb_library_entry_with_http_info(storefront_oid, library_oid, opts)
6738
+ # List the storefront's campaigns
6739
+ data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
6289
6740
  p status_code # => 2xx
6290
6741
  p headers # => { ... }
6291
- p data # => <SfvbLibraryInstallReceipt>
6742
+ p data # => <SfvbCampaignsResponse>
6292
6743
  rescue UltracartClient::ApiError => e
6293
- puts "Error when calling SfvbApi->install_sfvb_library_entry_with_http_info: #{e}"
6744
+ puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
6294
6745
  end
6295
6746
  ```
6296
6747
 
@@ -6299,12 +6750,14 @@ end
6299
6750
  | Name | Type | Description | Notes |
6300
6751
  | ---- | ---- | ----------- | ----- |
6301
6752
  | **storefront_oid** | **Integer** | | |
6302
- | **library_oid** | **Integer** | | |
6303
- | **install_request** | [**SfvbLibraryInstallRequest**](SfvbLibraryInstallRequest.md) | Revision, conflict handling and acknowledgement | [optional] |
6753
+ | **search** | **String** | Text to search for in the name | [optional] |
6754
+ | **page** | **Integer** | Page number, starting at 1 | [optional] |
6755
+ | **page_size** | **Integer** | Campaigns per page, 1 to 100, default 50 | [optional] |
6756
+ | **include_deleted** | **Boolean** | Include deleted campaigns | [optional] |
6304
6757
 
6305
6758
  ### Return type
6306
6759
 
6307
- [**SfvbLibraryInstallReceipt**](SfvbLibraryInstallReceipt.md)
6760
+ [**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
6308
6761
 
6309
6762
  ### Authorization
6310
6763
 
@@ -6312,17 +6765,17 @@ end
6312
6765
 
6313
6766
  ### HTTP request headers
6314
6767
 
6315
- - **Content-Type**: application/json; charset=UTF-8
6768
+ - **Content-Type**: Not defined
6316
6769
  - **Accept**: application/json
6317
6770
 
6318
6771
 
6319
- ## list_sfvb_blog_posts
6772
+ ## list_sfvb_comms_lists
6320
6773
 
6321
- > <SfvbBlogPostsResponse> list_sfvb_blog_posts(storefront_oid, opts)
6774
+ > <SfvbCommsListsResponse> list_sfvb_comms_lists(storefront_oid)
6322
6775
 
6323
- List the storefront's blog posts
6776
+ List the storefront's email lists
6324
6777
 
6325
- One page of blog posts, newest first, without their bodies. search matches the title, body, excerpt, url part or author, or a tag exactly. unassigned marks posts no page shows yet. Use a post's blog_post_oid to assign it to a page.
6778
+ Each list's uuid, name and member count, by name, for a campaign's memberships or a list trigger. Never its members. Archived lists are left out.
6326
6779
 
6327
6780
 
6328
6781
  ### Examples
@@ -6331,21 +6784,21 @@ One page of blog posts, newest first, without their bodies. search matches the
6331
6784
  (No example for this operation).
6332
6785
 
6333
6786
 
6334
- #### Using the list_sfvb_blog_posts_with_http_info variant
6787
+ #### Using the list_sfvb_comms_lists_with_http_info variant
6335
6788
 
6336
6789
  This returns an Array which contains the response data, status code and headers.
6337
6790
 
6338
- > <Array(<SfvbBlogPostsResponse>, Integer, Hash)> list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
6791
+ > <Array(<SfvbCommsListsResponse>, Integer, Hash)> list_sfvb_comms_lists_with_http_info(storefront_oid)
6339
6792
 
6340
6793
  ```ruby
6341
6794
  begin
6342
- # List the storefront's blog posts
6343
- data, status_code, headers = api_instance.list_sfvb_blog_posts_with_http_info(storefront_oid, opts)
6795
+ # List the storefront's email lists
6796
+ data, status_code, headers = api_instance.list_sfvb_comms_lists_with_http_info(storefront_oid)
6344
6797
  p status_code # => 2xx
6345
6798
  p headers # => { ... }
6346
- p data # => <SfvbBlogPostsResponse>
6799
+ p data # => <SfvbCommsListsResponse>
6347
6800
  rescue UltracartClient::ApiError => e
6348
- puts "Error when calling SfvbApi->list_sfvb_blog_posts_with_http_info: #{e}"
6801
+ puts "Error when calling SfvbApi->list_sfvb_comms_lists_with_http_info: #{e}"
6349
6802
  end
6350
6803
  ```
6351
6804
 
@@ -6354,13 +6807,10 @@ end
6354
6807
  | Name | Type | Description | Notes |
6355
6808
  | ---- | ---- | ----------- | ----- |
6356
6809
  | **storefront_oid** | **Integer** | | |
6357
- | **search** | **String** | Text to search for | [optional] |
6358
- | **page** | **Integer** | Page number, starting at 1 | [optional] |
6359
- | **page_size** | **Integer** | Posts per page, 1 to 100, default 50 | [optional] |
6360
6810
 
6361
6811
  ### Return type
6362
6812
 
6363
- [**SfvbBlogPostsResponse**](SfvbBlogPostsResponse.md)
6813
+ [**SfvbCommsListsResponse**](SfvbCommsListsResponse.md)
6364
6814
 
6365
6815
  ### Authorization
6366
6816
 
@@ -6372,13 +6822,13 @@ end
6372
6822
  - **Accept**: application/json
6373
6823
 
6374
6824
 
6375
- ## list_sfvb_campaigns
6825
+ ## list_sfvb_comms_segments
6376
6826
 
6377
- > <SfvbCampaignsResponse> list_sfvb_campaigns(storefront_oid, opts)
6827
+ > <SfvbCommsSegmentsResponse> list_sfvb_comms_segments(storefront_oid)
6378
6828
 
6379
- List the storefront's campaigns
6829
+ List the storefront's segments
6380
6830
 
6381
- One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
6831
+ Each segment's uuid, name and member count at its last rebuild, by name, for a campaign's memberships or a segment trigger. Never its members or its rule. Archived segments are left out.
6382
6832
 
6383
6833
 
6384
6834
  ### Examples
@@ -6387,21 +6837,21 @@ One page of campaigns, newest first, each with its emails and postcards in step
6387
6837
  (No example for this operation).
6388
6838
 
6389
6839
 
6390
- #### Using the list_sfvb_campaigns_with_http_info variant
6840
+ #### Using the list_sfvb_comms_segments_with_http_info variant
6391
6841
 
6392
6842
  This returns an Array which contains the response data, status code and headers.
6393
6843
 
6394
- > <Array(<SfvbCampaignsResponse>, Integer, Hash)> list_sfvb_campaigns_with_http_info(storefront_oid, opts)
6844
+ > <Array(<SfvbCommsSegmentsResponse>, Integer, Hash)> list_sfvb_comms_segments_with_http_info(storefront_oid)
6395
6845
 
6396
6846
  ```ruby
6397
6847
  begin
6398
- # List the storefront's campaigns
6399
- data, status_code, headers = api_instance.list_sfvb_campaigns_with_http_info(storefront_oid, opts)
6848
+ # List the storefront's segments
6849
+ data, status_code, headers = api_instance.list_sfvb_comms_segments_with_http_info(storefront_oid)
6400
6850
  p status_code # => 2xx
6401
6851
  p headers # => { ... }
6402
- p data # => <SfvbCampaignsResponse>
6852
+ p data # => <SfvbCommsSegmentsResponse>
6403
6853
  rescue UltracartClient::ApiError => e
6404
- puts "Error when calling SfvbApi->list_sfvb_campaigns_with_http_info: #{e}"
6854
+ puts "Error when calling SfvbApi->list_sfvb_comms_segments_with_http_info: #{e}"
6405
6855
  end
6406
6856
  ```
6407
6857
 
@@ -6410,14 +6860,10 @@ end
6410
6860
  | Name | Type | Description | Notes |
6411
6861
  | ---- | ---- | ----------- | ----- |
6412
6862
  | **storefront_oid** | **Integer** | | |
6413
- | **search** | **String** | Text to search for in the name | [optional] |
6414
- | **page** | **Integer** | Page number, starting at 1 | [optional] |
6415
- | **page_size** | **Integer** | Campaigns per page, 1 to 100, default 50 | [optional] |
6416
- | **include_deleted** | **Boolean** | Include deleted campaigns | [optional] |
6417
6863
 
6418
6864
  ### Return type
6419
6865
 
6420
- [**SfvbCampaignsResponse**](SfvbCampaignsResponse.md)
6866
+ [**SfvbCommsSegmentsResponse**](SfvbCommsSegmentsResponse.md)
6421
6867
 
6422
6868
  ### Authorization
6423
6869
 
@@ -9315,6 +9761,61 @@ end
9315
9761
  - **Accept**: application/json
9316
9762
 
9317
9763
 
9764
+ ## review_sfvb_email
9765
+
9766
+ > <SfvbEmail> review_sfvb_email(storefront_oid, email_uuid, email_review_request)
9767
+
9768
+ Request a content review of a flow or campaign email
9769
+
9770
+ Starts a review the way the admin's Request Review does. One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling. Refused with sfvb.review_not_needed when it doesn't need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
9771
+
9772
+
9773
+ ### Examples
9774
+
9775
+
9776
+ (No example for this operation).
9777
+
9778
+
9779
+ #### Using the review_sfvb_email_with_http_info variant
9780
+
9781
+ This returns an Array which contains the response data, status code and headers.
9782
+
9783
+ > <Array(<SfvbEmail>, Integer, Hash)> review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request)
9784
+
9785
+ ```ruby
9786
+ begin
9787
+ # Request a content review of a flow or campaign email
9788
+ data, status_code, headers = api_instance.review_sfvb_email_with_http_info(storefront_oid, email_uuid, email_review_request)
9789
+ p status_code # => 2xx
9790
+ p headers # => { ... }
9791
+ p data # => <SfvbEmail>
9792
+ rescue UltracartClient::ApiError => e
9793
+ puts "Error when calling SfvbApi->review_sfvb_email_with_http_info: #{e}"
9794
+ end
9795
+ ```
9796
+
9797
+ ### Parameters
9798
+
9799
+ | Name | Type | Description | Notes |
9800
+ | ---- | ---- | ----------- | ----- |
9801
+ | **storefront_oid** | **Integer** | | |
9802
+ | **email_uuid** | **String** | | |
9803
+ | **email_review_request** | [**SfvbEmailReviewRequest**](SfvbEmailReviewRequest.md) | The test order, for an email in an order-triggered flow | |
9804
+
9805
+ ### Return type
9806
+
9807
+ [**SfvbEmail**](SfvbEmail.md)
9808
+
9809
+ ### Authorization
9810
+
9811
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
9812
+
9813
+ ### HTTP request headers
9814
+
9815
+ - **Content-Type**: application/json
9816
+ - **Accept**: application/json
9817
+
9818
+
9318
9819
  ## revoke_sfvb_secret_request
9319
9820
 
9320
9821
  > <SfvbSecretRequest> revoke_sfvb_secret_request(request_id)
@@ -9972,6 +10473,62 @@ end
9972
10473
  - **Accept**: application/json
9973
10474
 
9974
10475
 
10476
+ ## update_sfvb_campaign
10477
+
10478
+ > <SfvbCampaign> update_sfvb_campaign(storefront_oid, campaign_uuid, if_match, campaign_write_request)
10479
+
10480
+ Change a campaign
10481
+
10482
+ A field left out keeps its value; memberships replaces the whole set. The status is never changed here. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming. notes lists any emails a sending domain change put back to needing review.
10483
+
10484
+
10485
+ ### Examples
10486
+
10487
+
10488
+ (No example for this operation).
10489
+
10490
+
10491
+ #### Using the update_sfvb_campaign_with_http_info variant
10492
+
10493
+ This returns an Array which contains the response data, status code and headers.
10494
+
10495
+ > <Array(<SfvbCampaign>, Integer, Hash)> update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request)
10496
+
10497
+ ```ruby
10498
+ begin
10499
+ # Change a campaign
10500
+ data, status_code, headers = api_instance.update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request)
10501
+ p status_code # => 2xx
10502
+ p headers # => { ... }
10503
+ p data # => <SfvbCampaign>
10504
+ rescue UltracartClient::ApiError => e
10505
+ puts "Error when calling SfvbApi->update_sfvb_campaign_with_http_info: #{e}"
10506
+ end
10507
+ ```
10508
+
10509
+ ### Parameters
10510
+
10511
+ | Name | Type | Description | Notes |
10512
+ | ---- | ---- | ----------- | ----- |
10513
+ | **storefront_oid** | **Integer** | | |
10514
+ | **campaign_uuid** | **String** | | |
10515
+ | **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
10516
+ | **campaign_write_request** | [**SfvbCampaignWriteRequest**](SfvbCampaignWriteRequest.md) | The fields to change | |
10517
+
10518
+ ### Return type
10519
+
10520
+ [**SfvbCampaign**](SfvbCampaign.md)
10521
+
10522
+ ### Authorization
10523
+
10524
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
10525
+
10526
+ ### HTTP request headers
10527
+
10528
+ - **Content-Type**: application/json
10529
+ - **Accept**: application/json
10530
+
10531
+
9975
10532
  ## update_sfvb_comms_sending_domain
9976
10533
 
9977
10534
  > <SfvbCommsSendingDomain> update_sfvb_comms_sending_domain(domain, sending_domain)
@@ -10135,6 +10692,118 @@ end
10135
10692
  - **Accept**: application/json
10136
10693
 
10137
10694
 
10695
+ ## update_sfvb_flow
10696
+
10697
+ > <SfvbFlow> update_sfvb_flow(storefront_oid, flow_uuid, if_match, flow_write_request)
10698
+
10699
+ Change a flow
10700
+
10701
+ A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
10702
+
10703
+
10704
+ ### Examples
10705
+
10706
+
10707
+ (No example for this operation).
10708
+
10709
+
10710
+ #### Using the update_sfvb_flow_with_http_info variant
10711
+
10712
+ This returns an Array which contains the response data, status code and headers.
10713
+
10714
+ > <Array(<SfvbFlow>, Integer, Hash)> update_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, flow_write_request)
10715
+
10716
+ ```ruby
10717
+ begin
10718
+ # Change a flow
10719
+ data, status_code, headers = api_instance.update_sfvb_flow_with_http_info(storefront_oid, flow_uuid, if_match, flow_write_request)
10720
+ p status_code # => 2xx
10721
+ p headers # => { ... }
10722
+ p data # => <SfvbFlow>
10723
+ rescue UltracartClient::ApiError => e
10724
+ puts "Error when calling SfvbApi->update_sfvb_flow_with_http_info: #{e}"
10725
+ end
10726
+ ```
10727
+
10728
+ ### Parameters
10729
+
10730
+ | Name | Type | Description | Notes |
10731
+ | ---- | ---- | ----------- | ----- |
10732
+ | **storefront_oid** | **Integer** | | |
10733
+ | **flow_uuid** | **String** | | |
10734
+ | **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
10735
+ | **flow_write_request** | [**SfvbFlowWriteRequest**](SfvbFlowWriteRequest.md) | The fields to change | |
10736
+
10737
+ ### Return type
10738
+
10739
+ [**SfvbFlow**](SfvbFlow.md)
10740
+
10741
+ ### Authorization
10742
+
10743
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
10744
+
10745
+ ### HTTP request headers
10746
+
10747
+ - **Content-Type**: application/json
10748
+ - **Accept**: application/json
10749
+
10750
+
10751
+ ## update_sfvb_flow_status
10752
+
10753
+ > <SfvbFlow> update_sfvb_flow_status(storefront_oid, flow_uuid, if_match, flow_status_request)
10754
+
10755
+ Turn a flow on or off
10756
+
10757
+ active enrolls customers as they trigger the flow from now on, and they receive its emails. inactive stops new enrollments. Always needs sfvb_publish. Send the hash_sha256 you read as If-Match.
10758
+
10759
+
10760
+ ### Examples
10761
+
10762
+
10763
+ (No example for this operation).
10764
+
10765
+
10766
+ #### Using the update_sfvb_flow_status_with_http_info variant
10767
+
10768
+ This returns an Array which contains the response data, status code and headers.
10769
+
10770
+ > <Array(<SfvbFlow>, Integer, Hash)> update_sfvb_flow_status_with_http_info(storefront_oid, flow_uuid, if_match, flow_status_request)
10771
+
10772
+ ```ruby
10773
+ begin
10774
+ # Turn a flow on or off
10775
+ data, status_code, headers = api_instance.update_sfvb_flow_status_with_http_info(storefront_oid, flow_uuid, if_match, flow_status_request)
10776
+ p status_code # => 2xx
10777
+ p headers # => { ... }
10778
+ p data # => <SfvbFlow>
10779
+ rescue UltracartClient::ApiError => e
10780
+ puts "Error when calling SfvbApi->update_sfvb_flow_status_with_http_info: #{e}"
10781
+ end
10782
+ ```
10783
+
10784
+ ### Parameters
10785
+
10786
+ | Name | Type | Description | Notes |
10787
+ | ---- | ---- | ----------- | ----- |
10788
+ | **storefront_oid** | **Integer** | | |
10789
+ | **flow_uuid** | **String** | | |
10790
+ | **if_match** | **String** | hash_sha256 from the last read. Required; 428 when absent, 412 when stale. | |
10791
+ | **flow_status_request** | [**SfvbFlowStatusRequest**](SfvbFlowStatusRequest.md) | The status to set | |
10792
+
10793
+ ### Return type
10794
+
10795
+ [**SfvbFlow**](SfvbFlow.md)
10796
+
10797
+ ### Authorization
10798
+
10799
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
10800
+
10801
+ ### HTTP request headers
10802
+
10803
+ - **Content-Type**: application/json
10804
+ - **Accept**: application/json
10805
+
10806
+
10138
10807
  ## update_sfvb_item_attribute_batch
10139
10808
 
10140
10809
  > <SfvbItemAttributeBatchResponse> update_sfvb_item_attribute_batch(storefront_oid, item_attribute_batch_request, opts)