ultracart_api 4.1.232 → 4.1.233

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 (49) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +29 -2
  3. data/docs/SfvbApi.md +799 -25
  4. data/docs/SfvbApprovalCreateRequest.md +2 -0
  5. data/docs/SfvbCampaign.md +4 -0
  6. data/docs/SfvbCampaignWriteRequest.md +2 -0
  7. data/docs/SfvbCommsLookupOwner.md +26 -0
  8. data/docs/SfvbCommsLookupResponse.md +34 -0
  9. data/docs/SfvbCommsRulerValidateRequest.md +18 -0
  10. data/docs/SfvbCommsRulerValidateResponse.md +22 -0
  11. data/docs/SfvbCommsSequenceFolder.md +28 -0
  12. data/docs/SfvbCommsSequenceFolderResponse.md +22 -0
  13. data/docs/SfvbCommsSequenceFoldersResponse.md +18 -0
  14. data/docs/SfvbCommsStat.md +1 -1
  15. data/docs/SfvbCommsTemplateResponse.md +8 -2
  16. data/docs/SfvbCommsUnreferencedEmail.md +30 -0
  17. data/docs/SfvbCommsUnreferencedPostcard.md +24 -0
  18. data/docs/SfvbCommsUnreferencedResponse.md +32 -0
  19. data/docs/SfvbEmail.md +8 -0
  20. data/docs/SfvbFlow.md +4 -0
  21. data/docs/SfvbFlowBackfillRequest.md +24 -0
  22. data/docs/SfvbFlowBackfillResponse.md +38 -0
  23. data/docs/SfvbFlowWriteRequest.md +2 -0
  24. data/docs/SfvbStepCounts.md +1 -1
  25. data/lib/ultracart_api/api/sfvb_api.rb +1098 -62
  26. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
  27. data/lib/ultracart_api/models/sfvb_campaign.rb +21 -1
  28. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +11 -1
  29. data/lib/ultracart_api/models/sfvb_comms_lookup_owner.rb +260 -0
  30. data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +301 -0
  31. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_request.rb +220 -0
  32. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_response.rb +242 -0
  33. data/lib/ultracart_api/models/sfvb_comms_sequence_folder.rb +270 -0
  34. data/lib/ultracart_api/models/sfvb_comms_sequence_folder_response.rb +243 -0
  35. data/lib/ultracart_api/models/sfvb_comms_sequence_folders_response.rb +222 -0
  36. data/lib/ultracart_api/models/sfvb_comms_stat.rb +1 -1
  37. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +35 -5
  38. data/lib/ultracart_api/models/sfvb_comms_unreferenced_email.rb +280 -0
  39. data/lib/ultracart_api/models/sfvb_comms_unreferenced_postcard.rb +250 -0
  40. data/lib/ultracart_api/models/sfvb_comms_unreferenced_response.rb +296 -0
  41. data/lib/ultracart_api/models/sfvb_email.rb +41 -1
  42. data/lib/ultracart_api/models/sfvb_flow.rb +21 -1
  43. data/lib/ultracart_api/models/sfvb_flow_backfill_request.rb +250 -0
  44. data/lib/ultracart_api/models/sfvb_flow_backfill_response.rb +322 -0
  45. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +11 -1
  46. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  47. data/lib/ultracart_api/version.rb +1 -1
  48. data/lib/ultracart_api.rb +12 -0
  49. metadata +26 -2
@@ -677,6 +677,90 @@ module UltracartClient
677
677
  return data, status_code, headers
678
678
  end
679
679
 
680
+ # Back populate a live flow, or count who it would enroll
681
+ # Enrolls customers who would have met the flow's trigger before it existed: a segment trigger's members, or the orders of the last order_days_old days (1 to 90, default 5, every storefront on the account) for an order trigger, up to the plan's customer limit. The flow must be on. dry_run counts them and enrolls nobody. A real backfill needs sfvb_publish, the sign-in of a person, and an approved flow.backfill request for exactly this flow and window; it runs in the background and mails each customer through the flow.
682
+ # @param storefront_oid [Integer]
683
+ # @param flow_uuid [String]
684
+ # @param flow_backfill_request [SfvbFlowBackfillRequest] The window and dry_run
685
+ # @param [Hash] opts the optional parameters
686
+ # @option opts [String] :approval_id The approval_id of an approved flow.backfill request for exactly this flow and window. See POST /sfvb/approvals.
687
+ # @return [SfvbFlowBackfillResponse]
688
+ def backfill_sfvb_comms_flow(storefront_oid, flow_uuid, flow_backfill_request, opts = {})
689
+ data, _status_code, _headers = backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts)
690
+ data
691
+ end
692
+
693
+ # Back populate a live flow, or count who it would enroll
694
+ # Enrolls customers who would have met the flow's trigger before it existed: a segment trigger's members, or the orders of the last order_days_old days (1 to 90, default 5, every storefront on the account) for an order trigger, up to the plan's customer limit. The flow must be on. dry_run counts them and enrolls nobody. A real backfill needs sfvb_publish, the sign-in of a person, and an approved flow.backfill request for exactly this flow and window; it runs in the background and mails each customer through the flow.
695
+ # @param storefront_oid [Integer]
696
+ # @param flow_uuid [String]
697
+ # @param flow_backfill_request [SfvbFlowBackfillRequest] The window and dry_run
698
+ # @param [Hash] opts the optional parameters
699
+ # @option opts [String] :approval_id The approval_id of an approved flow.backfill request for exactly this flow and window. See POST /sfvb/approvals.
700
+ # @return [Array<(SfvbFlowBackfillResponse, Integer, Hash)>] SfvbFlowBackfillResponse data, response status code and response headers
701
+ def backfill_sfvb_comms_flow_with_http_info(storefront_oid, flow_uuid, flow_backfill_request, opts = {})
702
+ if @api_client.config.debugging
703
+ @api_client.config.logger.debug 'Calling API: SfvbApi.backfill_sfvb_comms_flow ...'
704
+ end
705
+ # verify the required parameter 'storefront_oid' is set
706
+ if @api_client.config.client_side_validation && storefront_oid.nil?
707
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.backfill_sfvb_comms_flow"
708
+ end
709
+ # verify the required parameter 'flow_uuid' is set
710
+ if @api_client.config.client_side_validation && flow_uuid.nil?
711
+ fail ArgumentError, "Missing the required parameter 'flow_uuid' when calling SfvbApi.backfill_sfvb_comms_flow"
712
+ end
713
+ # verify the required parameter 'flow_backfill_request' is set
714
+ if @api_client.config.client_side_validation && flow_backfill_request.nil?
715
+ fail ArgumentError, "Missing the required parameter 'flow_backfill_request' when calling SfvbApi.backfill_sfvb_comms_flow"
716
+ end
717
+ # resource path
718
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/flows/{flow_uuid}/backfill'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'flow_uuid' + '}', CGI.escape(flow_uuid.to_s))
719
+
720
+ # query parameters
721
+ query_params = opts[:query_params] || {}
722
+
723
+ # header parameters
724
+ header_params = opts[:header_params] || {}
725
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
726
+ # HTTP header 'Accept' (if needed)
727
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
728
+ # HTTP header 'Content-Type'
729
+ content_type = @api_client.select_header_content_type(['application/json'])
730
+ if !content_type.nil?
731
+ header_params['Content-Type'] = content_type
732
+ end
733
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
734
+
735
+ # form parameters
736
+ form_params = opts[:form_params] || {}
737
+
738
+ # http body (model)
739
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(flow_backfill_request)
740
+
741
+ # return_type
742
+ return_type = opts[:debug_return_type] || 'SfvbFlowBackfillResponse'
743
+
744
+ # auth_names
745
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
746
+
747
+ new_options = opts.merge(
748
+ :operation => :"SfvbApi.backfill_sfvb_comms_flow",
749
+ :header_params => header_params,
750
+ :query_params => query_params,
751
+ :form_params => form_params,
752
+ :body => post_body,
753
+ :auth_names => auth_names,
754
+ :return_type => return_type
755
+ )
756
+
757
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
758
+ if @api_client.config.debugging
759
+ @api_client.config.logger.debug "API called: SfvbApi#backfill_sfvb_comms_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
760
+ end
761
+ return data, status_code, headers
762
+ end
763
+
680
764
  # Check a redirect rule without creating it
681
765
  # Runs every check a create runs (loops, chains, duplicates, missing or external targets, system paths, live pages, the rule limit) and returns the findings. Writes nothing.
682
766
  # @param storefront_oid [Integer]
@@ -1619,6 +1703,160 @@ module UltracartClient
1619
1703
  return data, status_code, headers
1620
1704
  end
1621
1705
 
1706
+ # Delete a campaign folder
1707
+ # Its campaigns are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
1708
+ # @param storefront_oid [Integer]
1709
+ # @param folder_uuid [String]
1710
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1711
+ # @param [Hash] opts the optional parameters
1712
+ # @return [SfvbCommsSequenceFolderResponse]
1713
+ def delete_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match, opts = {})
1714
+ data, _status_code, _headers = delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts)
1715
+ data
1716
+ end
1717
+
1718
+ # Delete a campaign folder
1719
+ # Its campaigns are kept and filed under no folder, as the admin does; items names each one. Send the folder&#39;s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can&#39;t be deleted here.
1720
+ # @param storefront_oid [Integer]
1721
+ # @param folder_uuid [String]
1722
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1723
+ # @param [Hash] opts the optional parameters
1724
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
1725
+ def delete_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts = {})
1726
+ if @api_client.config.debugging
1727
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_campaign_folder ...'
1728
+ end
1729
+ # verify the required parameter 'storefront_oid' is set
1730
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1731
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_comms_campaign_folder"
1732
+ end
1733
+ # verify the required parameter 'folder_uuid' is set
1734
+ if @api_client.config.client_side_validation && folder_uuid.nil?
1735
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.delete_sfvb_comms_campaign_folder"
1736
+ end
1737
+ # verify the required parameter 'if_match' is set
1738
+ if @api_client.config.client_side_validation && if_match.nil?
1739
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.delete_sfvb_comms_campaign_folder"
1740
+ end
1741
+ # resource path
1742
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
1743
+
1744
+ # query parameters
1745
+ query_params = opts[:query_params] || {}
1746
+
1747
+ # header parameters
1748
+ header_params = opts[:header_params] || {}
1749
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1750
+ # HTTP header 'Accept' (if needed)
1751
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1752
+ header_params[:'If-Match'] = if_match
1753
+
1754
+ # form parameters
1755
+ form_params = opts[:form_params] || {}
1756
+
1757
+ # http body (model)
1758
+ post_body = opts[:debug_body]
1759
+
1760
+ # return_type
1761
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
1762
+
1763
+ # auth_names
1764
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1765
+
1766
+ new_options = opts.merge(
1767
+ :operation => :"SfvbApi.delete_sfvb_comms_campaign_folder",
1768
+ :header_params => header_params,
1769
+ :query_params => query_params,
1770
+ :form_params => form_params,
1771
+ :body => post_body,
1772
+ :auth_names => auth_names,
1773
+ :return_type => return_type
1774
+ )
1775
+
1776
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1777
+ if @api_client.config.debugging
1778
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1779
+ end
1780
+ return data, status_code, headers
1781
+ end
1782
+
1783
+ # Delete a flow folder
1784
+ # Its flows are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
1785
+ # @param storefront_oid [Integer]
1786
+ # @param folder_uuid [String]
1787
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1788
+ # @param [Hash] opts the optional parameters
1789
+ # @return [SfvbCommsSequenceFolderResponse]
1790
+ def delete_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match, opts = {})
1791
+ data, _status_code, _headers = delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts)
1792
+ data
1793
+ end
1794
+
1795
+ # Delete a flow folder
1796
+ # Its flows are kept and filed under no folder, as the admin does; items names each one. Send the folder&#39;s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can&#39;t be deleted here.
1797
+ # @param storefront_oid [Integer]
1798
+ # @param folder_uuid [String]
1799
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1800
+ # @param [Hash] opts the optional parameters
1801
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
1802
+ def delete_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts = {})
1803
+ if @api_client.config.debugging
1804
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_flow_folder ...'
1805
+ end
1806
+ # verify the required parameter 'storefront_oid' is set
1807
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1808
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_comms_flow_folder"
1809
+ end
1810
+ # verify the required parameter 'folder_uuid' is set
1811
+ if @api_client.config.client_side_validation && folder_uuid.nil?
1812
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.delete_sfvb_comms_flow_folder"
1813
+ end
1814
+ # verify the required parameter 'if_match' is set
1815
+ if @api_client.config.client_side_validation && if_match.nil?
1816
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.delete_sfvb_comms_flow_folder"
1817
+ end
1818
+ # resource path
1819
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
1820
+
1821
+ # query parameters
1822
+ query_params = opts[:query_params] || {}
1823
+
1824
+ # header parameters
1825
+ header_params = opts[:header_params] || {}
1826
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1827
+ # HTTP header 'Accept' (if needed)
1828
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1829
+ header_params[:'If-Match'] = if_match
1830
+
1831
+ # form parameters
1832
+ form_params = opts[:form_params] || {}
1833
+
1834
+ # http body (model)
1835
+ post_body = opts[:debug_body]
1836
+
1837
+ # return_type
1838
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
1839
+
1840
+ # auth_names
1841
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1842
+
1843
+ new_options = opts.merge(
1844
+ :operation => :"SfvbApi.delete_sfvb_comms_flow_folder",
1845
+ :header_params => header_params,
1846
+ :query_params => query_params,
1847
+ :form_params => form_params,
1848
+ :body => post_body,
1849
+ :auth_names => auth_names,
1850
+ :return_type => return_type
1851
+ )
1852
+
1853
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1854
+ if @api_client.config.debugging
1855
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1856
+ end
1857
+ return data, status_code, headers
1858
+ end
1859
+
1622
1860
  # Delete a list and segment folder
1623
1861
  # Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
1624
1862
  # @param storefront_oid [Integer]
@@ -4898,6 +5136,140 @@ module UltracartClient
4898
5136
  return data, status_code, headers
4899
5137
  end
4900
5138
 
5139
+ # Read one campaign folder
5140
+ # The folder, with the name and uuid of each campaign filed in it.
5141
+ # @param storefront_oid [Integer]
5142
+ # @param folder_uuid [String]
5143
+ # @param [Hash] opts the optional parameters
5144
+ # @return [SfvbCommsSequenceFolderResponse]
5145
+ def get_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, opts = {})
5146
+ data, _status_code, _headers = get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, opts)
5147
+ data
5148
+ end
5149
+
5150
+ # Read one campaign folder
5151
+ # The folder, with the name and uuid of each campaign filed in it.
5152
+ # @param storefront_oid [Integer]
5153
+ # @param folder_uuid [String]
5154
+ # @param [Hash] opts the optional parameters
5155
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
5156
+ def get_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
5157
+ if @api_client.config.debugging
5158
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_campaign_folder ...'
5159
+ end
5160
+ # verify the required parameter 'storefront_oid' is set
5161
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5162
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_campaign_folder"
5163
+ end
5164
+ # verify the required parameter 'folder_uuid' is set
5165
+ if @api_client.config.client_side_validation && folder_uuid.nil?
5166
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_campaign_folder"
5167
+ end
5168
+ # resource path
5169
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
5170
+
5171
+ # query parameters
5172
+ query_params = opts[:query_params] || {}
5173
+
5174
+ # header parameters
5175
+ header_params = opts[:header_params] || {}
5176
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5177
+ # HTTP header 'Accept' (if needed)
5178
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5179
+
5180
+ # form parameters
5181
+ form_params = opts[:form_params] || {}
5182
+
5183
+ # http body (model)
5184
+ post_body = opts[:debug_body]
5185
+
5186
+ # return_type
5187
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
5188
+
5189
+ # auth_names
5190
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5191
+
5192
+ new_options = opts.merge(
5193
+ :operation => :"SfvbApi.get_sfvb_comms_campaign_folder",
5194
+ :header_params => header_params,
5195
+ :query_params => query_params,
5196
+ :form_params => form_params,
5197
+ :body => post_body,
5198
+ :auth_names => auth_names,
5199
+ :return_type => return_type
5200
+ )
5201
+
5202
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5203
+ if @api_client.config.debugging
5204
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5205
+ end
5206
+ return data, status_code, headers
5207
+ end
5208
+
5209
+ # List the campaign folders
5210
+ # Each campaign folder with how many campaigns are filed in it, whether the admin made it, and its hash_sha256.
5211
+ # @param storefront_oid [Integer]
5212
+ # @param [Hash] opts the optional parameters
5213
+ # @return [SfvbCommsSequenceFoldersResponse]
5214
+ def get_sfvb_comms_campaign_folders(storefront_oid, opts = {})
5215
+ data, _status_code, _headers = get_sfvb_comms_campaign_folders_with_http_info(storefront_oid, opts)
5216
+ data
5217
+ end
5218
+
5219
+ # List the campaign folders
5220
+ # Each campaign folder with how many campaigns are filed in it, whether the admin made it, and its hash_sha256.
5221
+ # @param storefront_oid [Integer]
5222
+ # @param [Hash] opts the optional parameters
5223
+ # @return [Array<(SfvbCommsSequenceFoldersResponse, Integer, Hash)>] SfvbCommsSequenceFoldersResponse data, response status code and response headers
5224
+ def get_sfvb_comms_campaign_folders_with_http_info(storefront_oid, opts = {})
5225
+ if @api_client.config.debugging
5226
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_campaign_folders ...'
5227
+ end
5228
+ # verify the required parameter 'storefront_oid' is set
5229
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5230
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_campaign_folders"
5231
+ end
5232
+ # resource path
5233
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5234
+
5235
+ # query parameters
5236
+ query_params = opts[:query_params] || {}
5237
+
5238
+ # header parameters
5239
+ header_params = opts[:header_params] || {}
5240
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5241
+ # HTTP header 'Accept' (if needed)
5242
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5243
+
5244
+ # form parameters
5245
+ form_params = opts[:form_params] || {}
5246
+
5247
+ # http body (model)
5248
+ post_body = opts[:debug_body]
5249
+
5250
+ # return_type
5251
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFoldersResponse'
5252
+
5253
+ # auth_names
5254
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5255
+
5256
+ new_options = opts.merge(
5257
+ :operation => :"SfvbApi.get_sfvb_comms_campaign_folders",
5258
+ :header_params => header_params,
5259
+ :query_params => query_params,
5260
+ :form_params => form_params,
5261
+ :body => post_body,
5262
+ :auth_names => auth_names,
5263
+ :return_type => return_type
5264
+ )
5265
+
5266
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5267
+ if @api_client.config.debugging
5268
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_campaign_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5269
+ end
5270
+ return data, status_code, headers
5271
+ end
5272
+
4901
5273
  # Read every flow's and campaign's counts over a window, with the account's daily sending
4902
5274
  # rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account's last 31 days of sending, whatever the window. Read only.
4903
5275
  # @param storefront_oid [Integer]
@@ -4988,26 +5360,160 @@ module UltracartClient
4988
5360
  # @return [Array<(SfvbCommsClicksResponse, Integer, Hash)>] SfvbCommsClicksResponse data, response status code and response headers
4989
5361
  def get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts = {})
4990
5362
  if @api_client.config.debugging
4991
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_email_clicks ...'
5363
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_email_clicks ...'
5364
+ end
5365
+ # verify the required parameter 'storefront_oid' is set
5366
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5367
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5368
+ end
5369
+ # verify the required parameter 'commseq_uuid' is set
5370
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
5371
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5372
+ end
5373
+ # verify the required parameter 'email_uuid' is set
5374
+ if @api_client.config.client_side_validation && email_uuid.nil?
5375
+ fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5376
+ end
5377
+ # resource path
5378
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/emails/{email_uuid}/clicks'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
5379
+
5380
+ # query parameters
5381
+ query_params = opts[:query_params] || {}
5382
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5383
+
5384
+ # header parameters
5385
+ header_params = opts[:header_params] || {}
5386
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5387
+ # HTTP header 'Accept' (if needed)
5388
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5389
+
5390
+ # form parameters
5391
+ form_params = opts[:form_params] || {}
5392
+
5393
+ # http body (model)
5394
+ post_body = opts[:debug_body]
5395
+
5396
+ # return_type
5397
+ return_type = opts[:debug_return_type] || 'SfvbCommsClicksResponse'
5398
+
5399
+ # auth_names
5400
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5401
+
5402
+ new_options = opts.merge(
5403
+ :operation => :"SfvbApi.get_sfvb_comms_email_clicks",
5404
+ :header_params => header_params,
5405
+ :query_params => query_params,
5406
+ :form_params => form_params,
5407
+ :body => post_body,
5408
+ :auth_names => auth_names,
5409
+ :return_type => return_type
5410
+ )
5411
+
5412
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5413
+ if @api_client.config.debugging
5414
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_email_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5415
+ end
5416
+ return data, status_code, headers
5417
+ end
5418
+
5419
+ # Read one flow folder
5420
+ # The folder, with the name and uuid of each flow filed in it.
5421
+ # @param storefront_oid [Integer]
5422
+ # @param folder_uuid [String]
5423
+ # @param [Hash] opts the optional parameters
5424
+ # @return [SfvbCommsSequenceFolderResponse]
5425
+ def get_sfvb_comms_flow_folder(storefront_oid, folder_uuid, opts = {})
5426
+ data, _status_code, _headers = get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, opts)
5427
+ data
5428
+ end
5429
+
5430
+ # Read one flow folder
5431
+ # The folder, with the name and uuid of each flow filed in it.
5432
+ # @param storefront_oid [Integer]
5433
+ # @param folder_uuid [String]
5434
+ # @param [Hash] opts the optional parameters
5435
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
5436
+ def get_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
5437
+ if @api_client.config.debugging
5438
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_flow_folder ...'
5439
+ end
5440
+ # verify the required parameter 'storefront_oid' is set
5441
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5442
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_flow_folder"
5443
+ end
5444
+ # verify the required parameter 'folder_uuid' is set
5445
+ if @api_client.config.client_side_validation && folder_uuid.nil?
5446
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_flow_folder"
5447
+ end
5448
+ # resource path
5449
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
5450
+
5451
+ # query parameters
5452
+ query_params = opts[:query_params] || {}
5453
+
5454
+ # header parameters
5455
+ header_params = opts[:header_params] || {}
5456
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5457
+ # HTTP header 'Accept' (if needed)
5458
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5459
+
5460
+ # form parameters
5461
+ form_params = opts[:form_params] || {}
5462
+
5463
+ # http body (model)
5464
+ post_body = opts[:debug_body]
5465
+
5466
+ # return_type
5467
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
5468
+
5469
+ # auth_names
5470
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5471
+
5472
+ new_options = opts.merge(
5473
+ :operation => :"SfvbApi.get_sfvb_comms_flow_folder",
5474
+ :header_params => header_params,
5475
+ :query_params => query_params,
5476
+ :form_params => form_params,
5477
+ :body => post_body,
5478
+ :auth_names => auth_names,
5479
+ :return_type => return_type
5480
+ )
5481
+
5482
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5483
+ if @api_client.config.debugging
5484
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5485
+ end
5486
+ return data, status_code, headers
5487
+ end
5488
+
5489
+ # List the flow folders
5490
+ # Each flow folder with how many flows are filed in it, whether the admin made it, and its hash_sha256.
5491
+ # @param storefront_oid [Integer]
5492
+ # @param [Hash] opts the optional parameters
5493
+ # @return [SfvbCommsSequenceFoldersResponse]
5494
+ def get_sfvb_comms_flow_folders(storefront_oid, opts = {})
5495
+ data, _status_code, _headers = get_sfvb_comms_flow_folders_with_http_info(storefront_oid, opts)
5496
+ data
5497
+ end
5498
+
5499
+ # List the flow folders
5500
+ # Each flow folder with how many flows are filed in it, whether the admin made it, and its hash_sha256.
5501
+ # @param storefront_oid [Integer]
5502
+ # @param [Hash] opts the optional parameters
5503
+ # @return [Array<(SfvbCommsSequenceFoldersResponse, Integer, Hash)>] SfvbCommsSequenceFoldersResponse data, response status code and response headers
5504
+ def get_sfvb_comms_flow_folders_with_http_info(storefront_oid, opts = {})
5505
+ if @api_client.config.debugging
5506
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_flow_folders ...'
4992
5507
  end
4993
5508
  # verify the required parameter 'storefront_oid' is set
4994
5509
  if @api_client.config.client_side_validation && storefront_oid.nil?
4995
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_email_clicks"
4996
- end
4997
- # verify the required parameter 'commseq_uuid' is set
4998
- if @api_client.config.client_side_validation && commseq_uuid.nil?
4999
- fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5000
- end
5001
- # verify the required parameter 'email_uuid' is set
5002
- if @api_client.config.client_side_validation && email_uuid.nil?
5003
- fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5510
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_flow_folders"
5004
5511
  end
5005
5512
  # resource path
5006
- local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/emails/{email_uuid}/clicks'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
5513
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5007
5514
 
5008
5515
  # query parameters
5009
5516
  query_params = opts[:query_params] || {}
5010
- query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5011
5517
 
5012
5518
  # header parameters
5013
5519
  header_params = opts[:header_params] || {}
@@ -5022,13 +5528,13 @@ module UltracartClient
5022
5528
  post_body = opts[:debug_body]
5023
5529
 
5024
5530
  # return_type
5025
- return_type = opts[:debug_return_type] || 'SfvbCommsClicksResponse'
5531
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFoldersResponse'
5026
5532
 
5027
5533
  # auth_names
5028
5534
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5029
5535
 
5030
5536
  new_options = opts.merge(
5031
- :operation => :"SfvbApi.get_sfvb_comms_email_clicks",
5537
+ :operation => :"SfvbApi.get_sfvb_comms_flow_folders",
5032
5538
  :header_params => header_params,
5033
5539
  :query_params => query_params,
5034
5540
  :form_params => form_params,
@@ -5039,7 +5545,7 @@ module UltracartClient
5039
5545
 
5040
5546
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5041
5547
  if @api_client.config.debugging
5042
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_email_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5548
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_flow_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5043
5549
  end
5044
5550
  return data, status_code, headers
5045
5551
  end
@@ -5327,6 +5833,71 @@ module UltracartClient
5327
5833
  return data, status_code, headers
5328
5834
  end
5329
5835
 
5836
+ # Find which storefront a communications uuid lives on
5837
+ # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account's storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account's included, is 404. Read only.
5838
+ # @param uuid [String] The uuid to find.
5839
+ # @param [Hash] opts the optional parameters
5840
+ # @return [SfvbCommsLookupResponse]
5841
+ def get_sfvb_comms_lookup(uuid, opts = {})
5842
+ data, _status_code, _headers = get_sfvb_comms_lookup_with_http_info(uuid, opts)
5843
+ data
5844
+ end
5845
+
5846
+ # Find which storefront a communications uuid lives on
5847
+ # Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account&#39;s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account&#39;s included, is 404. Read only.
5848
+ # @param uuid [String] The uuid to find.
5849
+ # @param [Hash] opts the optional parameters
5850
+ # @return [Array<(SfvbCommsLookupResponse, Integer, Hash)>] SfvbCommsLookupResponse data, response status code and response headers
5851
+ def get_sfvb_comms_lookup_with_http_info(uuid, opts = {})
5852
+ if @api_client.config.debugging
5853
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_lookup ...'
5854
+ end
5855
+ # verify the required parameter 'uuid' is set
5856
+ if @api_client.config.client_side_validation && uuid.nil?
5857
+ fail ArgumentError, "Missing the required parameter 'uuid' when calling SfvbApi.get_sfvb_comms_lookup"
5858
+ end
5859
+ # resource path
5860
+ local_var_path = '/sfvb/comms/lookup'
5861
+
5862
+ # query parameters
5863
+ query_params = opts[:query_params] || {}
5864
+ query_params[:'uuid'] = uuid
5865
+
5866
+ # header parameters
5867
+ header_params = opts[:header_params] || {}
5868
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5869
+ # HTTP header 'Accept' (if needed)
5870
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5871
+
5872
+ # form parameters
5873
+ form_params = opts[:form_params] || {}
5874
+
5875
+ # http body (model)
5876
+ post_body = opts[:debug_body]
5877
+
5878
+ # return_type
5879
+ return_type = opts[:debug_return_type] || 'SfvbCommsLookupResponse'
5880
+
5881
+ # auth_names
5882
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5883
+
5884
+ new_options = opts.merge(
5885
+ :operation => :"SfvbApi.get_sfvb_comms_lookup",
5886
+ :header_params => header_params,
5887
+ :query_params => query_params,
5888
+ :form_params => form_params,
5889
+ :body => post_body,
5890
+ :auth_names => auth_names,
5891
+ :return_type => return_type
5892
+ )
5893
+
5894
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5895
+ if @api_client.config.debugging
5896
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5897
+ end
5898
+ return data, status_code, headers
5899
+ end
5900
+
5330
5901
  # Read the account's communications plan and sending health
5331
5902
  # The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
5332
5903
  # @param storefront_oid [Integer]
@@ -5864,7 +6435,7 @@ module UltracartClient
5864
6435
  end
5865
6436
 
5866
6437
  # Read one saved email template's body
5867
- # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
6438
+ # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints. Read only.
5868
6439
  # @param storefront_oid [Integer]
5869
6440
  # @param email_template_oid [Integer]
5870
6441
  # @param [Hash] opts the optional parameters
@@ -5875,7 +6446,7 @@ module UltracartClient
5875
6446
  end
5876
6447
 
5877
6448
  # Read one saved email template&#39;s body
5878
- # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
6449
+ # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints. Read only.
5879
6450
  # @param storefront_oid [Integer]
5880
6451
  # @param email_template_oid [Integer]
5881
6452
  # @param [Hash] opts the optional parameters
@@ -6055,6 +6626,70 @@ module UltracartClient
6055
6626
  return data, status_code, headers
6056
6627
  end
6057
6628
 
6629
+ # List the emails and postcards on a storefront that no step names
6630
+ # An email or postcard no step of any sequence on this storefront names, an off or archived flow's included, so nothing sends it. The admin's add can leave one when its second call fails. Most recently changed first. Read only, nothing is deleted.
6631
+ # @param storefront_oid [Integer]
6632
+ # @param [Hash] opts the optional parameters
6633
+ # @return [SfvbCommsUnreferencedResponse]
6634
+ def get_sfvb_comms_unreferenced(storefront_oid, opts = {})
6635
+ data, _status_code, _headers = get_sfvb_comms_unreferenced_with_http_info(storefront_oid, opts)
6636
+ data
6637
+ end
6638
+
6639
+ # List the emails and postcards on a storefront that no step names
6640
+ # An email or postcard no step of any sequence on this storefront names, an off or archived flow&#39;s included, so nothing sends it. The admin&#39;s add can leave one when its second call fails. Most recently changed first. Read only, nothing is deleted.
6641
+ # @param storefront_oid [Integer]
6642
+ # @param [Hash] opts the optional parameters
6643
+ # @return [Array<(SfvbCommsUnreferencedResponse, Integer, Hash)>] SfvbCommsUnreferencedResponse data, response status code and response headers
6644
+ def get_sfvb_comms_unreferenced_with_http_info(storefront_oid, opts = {})
6645
+ if @api_client.config.debugging
6646
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_unreferenced ...'
6647
+ end
6648
+ # verify the required parameter 'storefront_oid' is set
6649
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6650
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_unreferenced"
6651
+ end
6652
+ # resource path
6653
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/unreferenced'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
6654
+
6655
+ # query parameters
6656
+ query_params = opts[:query_params] || {}
6657
+
6658
+ # header parameters
6659
+ header_params = opts[:header_params] || {}
6660
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6661
+ # HTTP header 'Accept' (if needed)
6662
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6663
+
6664
+ # form parameters
6665
+ form_params = opts[:form_params] || {}
6666
+
6667
+ # http body (model)
6668
+ post_body = opts[:debug_body]
6669
+
6670
+ # return_type
6671
+ return_type = opts[:debug_return_type] || 'SfvbCommsUnreferencedResponse'
6672
+
6673
+ # auth_names
6674
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6675
+
6676
+ new_options = opts.merge(
6677
+ :operation => :"SfvbApi.get_sfvb_comms_unreferenced",
6678
+ :header_params => header_params,
6679
+ :query_params => query_params,
6680
+ :form_params => form_params,
6681
+ :body => post_body,
6682
+ :auth_names => auth_names,
6683
+ :return_type => return_type
6684
+ )
6685
+
6686
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6687
+ if @api_client.config.debugging
6688
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_unreferenced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6689
+ end
6690
+ return data, status_code, headers
6691
+ end
6692
+
6058
6693
  # Read a container stored outside the file system
6059
6694
  # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
6060
6695
  # @param storefront_oid [Integer]
@@ -6278,7 +6913,7 @@ module UltracartClient
6278
6913
  end
6279
6914
 
6280
6915
  # Get a flow or campaign email's subject and preview text
6281
- # The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront's campaigns and flows.
6916
+ # The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints, whose read reports valid and velocity_errors. Find the uuid in the storefront's campaigns and flows.
6282
6917
  # @param storefront_oid [Integer]
6283
6918
  # @param email_uuid [String]
6284
6919
  # @param [Hash] opts the optional parameters
@@ -6289,7 +6924,7 @@ module UltracartClient
6289
6924
  end
6290
6925
 
6291
6926
  # Get a flow or campaign email&#39;s subject and preview text
6292
- # The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront&#39;s campaigns and flows.
6927
+ # The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). The Velocity template it renders inside is the theme file at template_path; read it with the files endpoints, whose read reports valid and velocity_errors. Find the uuid in the storefront&#39;s campaigns and flows.
6293
6928
  # @param storefront_oid [Integer]
6294
6929
  # @param email_uuid [String]
6295
6930
  # @param [Hash] opts the optional parameters
@@ -11002,33 +11637,183 @@ module UltracartClient
11002
11637
  # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
11003
11638
  # @param approval_request [SfvbApprovalCreateRequest] The request
11004
11639
  # @param [Hash] opts the optional parameters
11005
- # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
11006
- # @return [SfvbApproval]
11007
- def insert_sfvb_approval(approval_request, opts = {})
11008
- data, _status_code, _headers = insert_sfvb_approval_with_http_info(approval_request, opts)
11640
+ # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
11641
+ # @return [SfvbApproval]
11642
+ def insert_sfvb_approval(approval_request, opts = {})
11643
+ data, _status_code, _headers = insert_sfvb_approval_with_http_info(approval_request, opts)
11644
+ data
11645
+ end
11646
+
11647
+ # Request a human approval
11648
+ # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart&#39;s scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
11649
+ # @param approval_request [SfvbApprovalCreateRequest] The request
11650
+ # @param [Hash] opts the optional parameters
11651
+ # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
11652
+ # @return [Array<(SfvbApproval, Integer, Hash)>] SfvbApproval data, response status code and response headers
11653
+ def insert_sfvb_approval_with_http_info(approval_request, opts = {})
11654
+ if @api_client.config.debugging
11655
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_approval ...'
11656
+ end
11657
+ # verify the required parameter 'approval_request' is set
11658
+ if @api_client.config.client_side_validation && approval_request.nil?
11659
+ fail ArgumentError, "Missing the required parameter 'approval_request' when calling SfvbApi.insert_sfvb_approval"
11660
+ end
11661
+ # resource path
11662
+ local_var_path = '/sfvb/approvals'
11663
+
11664
+ # query parameters
11665
+ query_params = opts[:query_params] || {}
11666
+ query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
11667
+
11668
+ # header parameters
11669
+ header_params = opts[:header_params] || {}
11670
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11671
+ # HTTP header 'Accept' (if needed)
11672
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11673
+ # HTTP header 'Content-Type'
11674
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
11675
+ if !content_type.nil?
11676
+ header_params['Content-Type'] = content_type
11677
+ end
11678
+
11679
+ # form parameters
11680
+ form_params = opts[:form_params] || {}
11681
+
11682
+ # http body (model)
11683
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(approval_request)
11684
+
11685
+ # return_type
11686
+ return_type = opts[:debug_return_type] || 'SfvbApproval'
11687
+
11688
+ # auth_names
11689
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11690
+
11691
+ new_options = opts.merge(
11692
+ :operation => :"SfvbApi.insert_sfvb_approval",
11693
+ :header_params => header_params,
11694
+ :query_params => query_params,
11695
+ :form_params => form_params,
11696
+ :body => post_body,
11697
+ :auth_names => auth_names,
11698
+ :return_type => return_type
11699
+ )
11700
+
11701
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11702
+ if @api_client.config.debugging
11703
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11704
+ end
11705
+ return data, status_code, headers
11706
+ end
11707
+
11708
+ # Create a blog post
11709
+ # 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.
11710
+ # @param storefront_oid [Integer]
11711
+ # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
11712
+ # @param [Hash] opts the optional parameters
11713
+ # @return [SfvbBlogPostDetail]
11714
+ def insert_sfvb_blog_post(storefront_oid, blog_post_request, opts = {})
11715
+ data, _status_code, _headers = insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts)
11716
+ data
11717
+ end
11718
+
11719
+ # Create a blog post
11720
+ # 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&#39;s selectors choose it.
11721
+ # @param storefront_oid [Integer]
11722
+ # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
11723
+ # @param [Hash] opts the optional parameters
11724
+ # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
11725
+ def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
11726
+ if @api_client.config.debugging
11727
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
11728
+ end
11729
+ # verify the required parameter 'storefront_oid' is set
11730
+ if @api_client.config.client_side_validation && storefront_oid.nil?
11731
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
11732
+ end
11733
+ # verify the required parameter 'blog_post_request' is set
11734
+ if @api_client.config.client_side_validation && blog_post_request.nil?
11735
+ fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
11736
+ end
11737
+ # resource path
11738
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11739
+
11740
+ # query parameters
11741
+ query_params = opts[:query_params] || {}
11742
+
11743
+ # header parameters
11744
+ header_params = opts[:header_params] || {}
11745
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11746
+ # HTTP header 'Accept' (if needed)
11747
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11748
+ # HTTP header 'Content-Type'
11749
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
11750
+ if !content_type.nil?
11751
+ header_params['Content-Type'] = content_type
11752
+ end
11753
+
11754
+ # form parameters
11755
+ form_params = opts[:form_params] || {}
11756
+
11757
+ # http body (model)
11758
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
11759
+
11760
+ # return_type
11761
+ return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
11762
+
11763
+ # auth_names
11764
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11765
+
11766
+ new_options = opts.merge(
11767
+ :operation => :"SfvbApi.insert_sfvb_blog_post",
11768
+ :header_params => header_params,
11769
+ :query_params => query_params,
11770
+ :form_params => form_params,
11771
+ :body => post_body,
11772
+ :auth_names => auth_names,
11773
+ :return_type => return_type
11774
+ )
11775
+
11776
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11777
+ if @api_client.config.debugging
11778
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11779
+ end
11780
+ return data, status_code, headers
11781
+ end
11782
+
11783
+ # Create a campaign folder
11784
+ # A new, empty folder. File a campaign in it by setting its folder_uuid.
11785
+ # @param storefront_oid [Integer]
11786
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
11787
+ # @param [Hash] opts the optional parameters
11788
+ # @return [SfvbCommsSequenceFolderResponse]
11789
+ def insert_sfvb_comms_campaign_folder(storefront_oid, folder_write_request, opts = {})
11790
+ data, _status_code, _headers = insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request, opts)
11009
11791
  data
11010
11792
  end
11011
11793
 
11012
- # Request a human approval
11013
- # Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart&#39;s scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
11014
- # @param approval_request [SfvbApprovalCreateRequest] The request
11794
+ # Create a campaign folder
11795
+ # A new, empty folder. File a campaign in it by setting its folder_uuid.
11796
+ # @param storefront_oid [Integer]
11797
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
11015
11798
  # @param [Hash] opts the optional parameters
11016
- # @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
11017
- # @return [Array<(SfvbApproval, Integer, Hash)>] SfvbApproval data, response status code and response headers
11018
- def insert_sfvb_approval_with_http_info(approval_request, opts = {})
11799
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
11800
+ def insert_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_write_request, opts = {})
11019
11801
  if @api_client.config.debugging
11020
- @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_approval ...'
11802
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_campaign_folder ...'
11021
11803
  end
11022
- # verify the required parameter 'approval_request' is set
11023
- if @api_client.config.client_side_validation && approval_request.nil?
11024
- fail ArgumentError, "Missing the required parameter 'approval_request' when calling SfvbApi.insert_sfvb_approval"
11804
+ # verify the required parameter 'storefront_oid' is set
11805
+ if @api_client.config.client_side_validation && storefront_oid.nil?
11806
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_campaign_folder"
11807
+ end
11808
+ # verify the required parameter 'folder_write_request' is set
11809
+ if @api_client.config.client_side_validation && folder_write_request.nil?
11810
+ fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.insert_sfvb_comms_campaign_folder"
11025
11811
  end
11026
11812
  # resource path
11027
- local_var_path = '/sfvb/approvals'
11813
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11028
11814
 
11029
11815
  # query parameters
11030
11816
  query_params = opts[:query_params] || {}
11031
- query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
11032
11817
 
11033
11818
  # header parameters
11034
11819
  header_params = opts[:header_params] || {}
@@ -11036,7 +11821,7 @@ module UltracartClient
11036
11821
  # HTTP header 'Accept' (if needed)
11037
11822
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11038
11823
  # HTTP header 'Content-Type'
11039
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
11824
+ content_type = @api_client.select_header_content_type(['application/json'])
11040
11825
  if !content_type.nil?
11041
11826
  header_params['Content-Type'] = content_type
11042
11827
  end
@@ -11045,16 +11830,16 @@ module UltracartClient
11045
11830
  form_params = opts[:form_params] || {}
11046
11831
 
11047
11832
  # http body (model)
11048
- post_body = opts[:debug_body] || @api_client.object_to_http_body(approval_request)
11833
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
11049
11834
 
11050
11835
  # return_type
11051
- return_type = opts[:debug_return_type] || 'SfvbApproval'
11836
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
11052
11837
 
11053
11838
  # auth_names
11054
11839
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11055
11840
 
11056
11841
  new_options = opts.merge(
11057
- :operation => :"SfvbApi.insert_sfvb_approval",
11842
+ :operation => :"SfvbApi.insert_sfvb_comms_campaign_folder",
11058
11843
  :header_params => header_params,
11059
11844
  :query_params => query_params,
11060
11845
  :form_params => form_params,
@@ -11065,42 +11850,42 @@ module UltracartClient
11065
11850
 
11066
11851
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11067
11852
  if @api_client.config.debugging
11068
- @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11853
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11069
11854
  end
11070
11855
  return data, status_code, headers
11071
11856
  end
11072
11857
 
11073
- # Create a blog post
11074
- # 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.
11858
+ # Create a flow folder
11859
+ # A new, empty folder. File a flow in it by setting its folder_uuid.
11075
11860
  # @param storefront_oid [Integer]
11076
- # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
11861
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
11077
11862
  # @param [Hash] opts the optional parameters
11078
- # @return [SfvbBlogPostDetail]
11079
- def insert_sfvb_blog_post(storefront_oid, blog_post_request, opts = {})
11080
- data, _status_code, _headers = insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts)
11863
+ # @return [SfvbCommsSequenceFolderResponse]
11864
+ def insert_sfvb_comms_flow_folder(storefront_oid, folder_write_request, opts = {})
11865
+ data, _status_code, _headers = insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request, opts)
11081
11866
  data
11082
11867
  end
11083
11868
 
11084
- # Create a blog post
11085
- # 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&#39;s selectors choose it.
11869
+ # Create a flow folder
11870
+ # A new, empty folder. File a flow in it by setting its folder_uuid.
11086
11871
  # @param storefront_oid [Integer]
11087
- # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
11872
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
11088
11873
  # @param [Hash] opts the optional parameters
11089
- # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
11090
- def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
11874
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
11875
+ def insert_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_write_request, opts = {})
11091
11876
  if @api_client.config.debugging
11092
- @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
11877
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_flow_folder ...'
11093
11878
  end
11094
11879
  # verify the required parameter 'storefront_oid' is set
11095
11880
  if @api_client.config.client_side_validation && storefront_oid.nil?
11096
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
11881
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_flow_folder"
11097
11882
  end
11098
- # verify the required parameter 'blog_post_request' is set
11099
- if @api_client.config.client_side_validation && blog_post_request.nil?
11100
- fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
11883
+ # verify the required parameter 'folder_write_request' is set
11884
+ if @api_client.config.client_side_validation && folder_write_request.nil?
11885
+ fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.insert_sfvb_comms_flow_folder"
11101
11886
  end
11102
11887
  # resource path
11103
- local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11888
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11104
11889
 
11105
11890
  # query parameters
11106
11891
  query_params = opts[:query_params] || {}
@@ -11111,7 +11896,7 @@ module UltracartClient
11111
11896
  # HTTP header 'Accept' (if needed)
11112
11897
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11113
11898
  # HTTP header 'Content-Type'
11114
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
11899
+ content_type = @api_client.select_header_content_type(['application/json'])
11115
11900
  if !content_type.nil?
11116
11901
  header_params['Content-Type'] = content_type
11117
11902
  end
@@ -11120,16 +11905,16 @@ module UltracartClient
11120
11905
  form_params = opts[:form_params] || {}
11121
11906
 
11122
11907
  # http body (model)
11123
- post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
11908
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
11124
11909
 
11125
11910
  # return_type
11126
- return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
11911
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
11127
11912
 
11128
11913
  # auth_names
11129
11914
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11130
11915
 
11131
11916
  new_options = opts.merge(
11132
- :operation => :"SfvbApi.insert_sfvb_blog_post",
11917
+ :operation => :"SfvbApi.insert_sfvb_comms_flow_folder",
11133
11918
  :header_params => header_params,
11134
11919
  :query_params => query_params,
11135
11920
  :form_params => form_params,
@@ -11140,7 +11925,7 @@ module UltracartClient
11140
11925
 
11141
11926
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11142
11927
  if @api_client.config.debugging
11143
- @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11928
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11144
11929
  end
11145
11930
  return data, status_code, headers
11146
11931
  end
@@ -18236,6 +19021,182 @@ module UltracartClient
18236
19021
  return data, status_code, headers
18237
19022
  end
18238
19023
 
19024
+ # Rename a campaign folder
19025
+ # Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
19026
+ # @param storefront_oid [Integer]
19027
+ # @param folder_uuid [String]
19028
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19029
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
19030
+ # @param [Hash] opts the optional parameters
19031
+ # @return [SfvbCommsSequenceFolderResponse]
19032
+ def update_sfvb_comms_campaign_folder(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
19033
+ data, _status_code, _headers = update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts)
19034
+ data
19035
+ end
19036
+
19037
+ # Rename a campaign folder
19038
+ # Send the folder&#39;s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can&#39;t be renamed here.
19039
+ # @param storefront_oid [Integer]
19040
+ # @param folder_uuid [String]
19041
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19042
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
19043
+ # @param [Hash] opts the optional parameters
19044
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
19045
+ def update_sfvb_comms_campaign_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
19046
+ if @api_client.config.debugging
19047
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_campaign_folder ...'
19048
+ end
19049
+ # verify the required parameter 'storefront_oid' is set
19050
+ if @api_client.config.client_side_validation && storefront_oid.nil?
19051
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_campaign_folder"
19052
+ end
19053
+ # verify the required parameter 'folder_uuid' is set
19054
+ if @api_client.config.client_side_validation && folder_uuid.nil?
19055
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.update_sfvb_comms_campaign_folder"
19056
+ end
19057
+ # verify the required parameter 'if_match' is set
19058
+ if @api_client.config.client_side_validation && if_match.nil?
19059
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_campaign_folder"
19060
+ end
19061
+ # verify the required parameter 'folder_write_request' is set
19062
+ if @api_client.config.client_side_validation && folder_write_request.nil?
19063
+ fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.update_sfvb_comms_campaign_folder"
19064
+ end
19065
+ # resource path
19066
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
19067
+
19068
+ # query parameters
19069
+ query_params = opts[:query_params] || {}
19070
+
19071
+ # header parameters
19072
+ header_params = opts[:header_params] || {}
19073
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
19074
+ # HTTP header 'Accept' (if needed)
19075
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19076
+ # HTTP header 'Content-Type'
19077
+ content_type = @api_client.select_header_content_type(['application/json'])
19078
+ if !content_type.nil?
19079
+ header_params['Content-Type'] = content_type
19080
+ end
19081
+ header_params[:'If-Match'] = if_match
19082
+
19083
+ # form parameters
19084
+ form_params = opts[:form_params] || {}
19085
+
19086
+ # http body (model)
19087
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
19088
+
19089
+ # return_type
19090
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
19091
+
19092
+ # auth_names
19093
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
19094
+
19095
+ new_options = opts.merge(
19096
+ :operation => :"SfvbApi.update_sfvb_comms_campaign_folder",
19097
+ :header_params => header_params,
19098
+ :query_params => query_params,
19099
+ :form_params => form_params,
19100
+ :body => post_body,
19101
+ :auth_names => auth_names,
19102
+ :return_type => return_type
19103
+ )
19104
+
19105
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
19106
+ if @api_client.config.debugging
19107
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19108
+ end
19109
+ return data, status_code, headers
19110
+ end
19111
+
19112
+ # Rename a flow folder
19113
+ # Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
19114
+ # @param storefront_oid [Integer]
19115
+ # @param folder_uuid [String]
19116
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19117
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
19118
+ # @param [Hash] opts the optional parameters
19119
+ # @return [SfvbCommsSequenceFolderResponse]
19120
+ def update_sfvb_comms_flow_folder(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
19121
+ data, _status_code, _headers = update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts)
19122
+ data
19123
+ end
19124
+
19125
+ # Rename a flow folder
19126
+ # Send the folder&#39;s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can&#39;t be renamed here.
19127
+ # @param storefront_oid [Integer]
19128
+ # @param folder_uuid [String]
19129
+ # @param if_match [String] The folder&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19130
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
19131
+ # @param [Hash] opts the optional parameters
19132
+ # @return [Array<(SfvbCommsSequenceFolderResponse, Integer, Hash)>] SfvbCommsSequenceFolderResponse data, response status code and response headers
19133
+ def update_sfvb_comms_flow_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
19134
+ if @api_client.config.debugging
19135
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_flow_folder ...'
19136
+ end
19137
+ # verify the required parameter 'storefront_oid' is set
19138
+ if @api_client.config.client_side_validation && storefront_oid.nil?
19139
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_flow_folder"
19140
+ end
19141
+ # verify the required parameter 'folder_uuid' is set
19142
+ if @api_client.config.client_side_validation && folder_uuid.nil?
19143
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.update_sfvb_comms_flow_folder"
19144
+ end
19145
+ # verify the required parameter 'if_match' is set
19146
+ if @api_client.config.client_side_validation && if_match.nil?
19147
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_flow_folder"
19148
+ end
19149
+ # verify the required parameter 'folder_write_request' is set
19150
+ if @api_client.config.client_side_validation && folder_write_request.nil?
19151
+ fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.update_sfvb_comms_flow_folder"
19152
+ end
19153
+ # resource path
19154
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
19155
+
19156
+ # query parameters
19157
+ query_params = opts[:query_params] || {}
19158
+
19159
+ # header parameters
19160
+ header_params = opts[:header_params] || {}
19161
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
19162
+ # HTTP header 'Accept' (if needed)
19163
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19164
+ # HTTP header 'Content-Type'
19165
+ content_type = @api_client.select_header_content_type(['application/json'])
19166
+ if !content_type.nil?
19167
+ header_params['Content-Type'] = content_type
19168
+ end
19169
+ header_params[:'If-Match'] = if_match
19170
+
19171
+ # form parameters
19172
+ form_params = opts[:form_params] || {}
19173
+
19174
+ # http body (model)
19175
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
19176
+
19177
+ # return_type
19178
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
19179
+
19180
+ # auth_names
19181
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
19182
+
19183
+ new_options = opts.merge(
19184
+ :operation => :"SfvbApi.update_sfvb_comms_flow_folder",
19185
+ :header_params => header_params,
19186
+ :query_params => query_params,
19187
+ :form_params => form_params,
19188
+ :body => post_body,
19189
+ :auth_names => auth_names,
19190
+ :return_type => return_type
19191
+ )
19192
+
19193
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
19194
+ if @api_client.config.debugging
19195
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19196
+ end
19197
+ return data, status_code, headers
19198
+ end
19199
+
18239
19200
  # Rename a list and segment folder
18240
19201
  # Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
18241
19202
  # @param storefront_oid [Integer]
@@ -20365,6 +21326,81 @@ module UltracartClient
20365
21326
  return data, status_code, headers
20366
21327
  end
20367
21328
 
21329
+ # Check an Event Ruler pattern for an Is in BigQuery segment rule
21330
+ # Compiles the pattern the way an Is in BigQuery segment rule's bigquery_ruler is checked, and says whether it is valid and, if not, why. An invalid pattern is a 200 with valid false. Nothing is read or saved. A segment create or update refuses a rule whose pattern doesn't compile, or whose bigquery_table_id isn't project.dataset.table.
21331
+ # @param storefront_oid [Integer]
21332
+ # @param ruler_validate_request [SfvbCommsRulerValidateRequest] The pattern to check
21333
+ # @param [Hash] opts the optional parameters
21334
+ # @return [SfvbCommsRulerValidateResponse]
21335
+ def validate_sfvb_comms_ruler(storefront_oid, ruler_validate_request, opts = {})
21336
+ data, _status_code, _headers = validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request, opts)
21337
+ data
21338
+ end
21339
+
21340
+ # Check an Event Ruler pattern for an Is in BigQuery segment rule
21341
+ # Compiles the pattern the way an Is in BigQuery segment rule&#39;s bigquery_ruler is checked, and says whether it is valid and, if not, why. An invalid pattern is a 200 with valid false. Nothing is read or saved. A segment create or update refuses a rule whose pattern doesn&#39;t compile, or whose bigquery_table_id isn&#39;t project.dataset.table.
21342
+ # @param storefront_oid [Integer]
21343
+ # @param ruler_validate_request [SfvbCommsRulerValidateRequest] The pattern to check
21344
+ # @param [Hash] opts the optional parameters
21345
+ # @return [Array<(SfvbCommsRulerValidateResponse, Integer, Hash)>] SfvbCommsRulerValidateResponse data, response status code and response headers
21346
+ def validate_sfvb_comms_ruler_with_http_info(storefront_oid, ruler_validate_request, opts = {})
21347
+ if @api_client.config.debugging
21348
+ @api_client.config.logger.debug 'Calling API: SfvbApi.validate_sfvb_comms_ruler ...'
21349
+ end
21350
+ # verify the required parameter 'storefront_oid' is set
21351
+ if @api_client.config.client_side_validation && storefront_oid.nil?
21352
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.validate_sfvb_comms_ruler"
21353
+ end
21354
+ # verify the required parameter 'ruler_validate_request' is set
21355
+ if @api_client.config.client_side_validation && ruler_validate_request.nil?
21356
+ fail ArgumentError, "Missing the required parameter 'ruler_validate_request' when calling SfvbApi.validate_sfvb_comms_ruler"
21357
+ end
21358
+ # resource path
21359
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/ruler/validate'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
21360
+
21361
+ # query parameters
21362
+ query_params = opts[:query_params] || {}
21363
+
21364
+ # header parameters
21365
+ header_params = opts[:header_params] || {}
21366
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
21367
+ # HTTP header 'Accept' (if needed)
21368
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
21369
+ # HTTP header 'Content-Type'
21370
+ content_type = @api_client.select_header_content_type(['application/json'])
21371
+ if !content_type.nil?
21372
+ header_params['Content-Type'] = content_type
21373
+ end
21374
+
21375
+ # form parameters
21376
+ form_params = opts[:form_params] || {}
21377
+
21378
+ # http body (model)
21379
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(ruler_validate_request)
21380
+
21381
+ # return_type
21382
+ return_type = opts[:debug_return_type] || 'SfvbCommsRulerValidateResponse'
21383
+
21384
+ # auth_names
21385
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
21386
+
21387
+ new_options = opts.merge(
21388
+ :operation => :"SfvbApi.validate_sfvb_comms_ruler",
21389
+ :header_params => header_params,
21390
+ :query_params => query_params,
21391
+ :form_params => form_params,
21392
+ :body => post_body,
21393
+ :auth_names => auth_names,
21394
+ :return_type => return_type
21395
+ )
21396
+
21397
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
21398
+ if @api_client.config.debugging
21399
+ @api_client.config.logger.debug "API called: SfvbApi#validate_sfvb_comms_ruler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
21400
+ end
21401
+ return data, status_code, headers
21402
+ end
21403
+
20368
21404
  # Validate a Velocity template against a theme
20369
21405
  # Theme scoped rather than stateless. Validation builds a theme template context and evaluates against it. Also applies the template sandbox, so an agent learns the rule before a write fails.
20370
21406
  # @param storefront_oid [Integer]