ultracart_api 4.1.231 → 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 (105) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +72 -2
  3. data/docs/ItemContentMultimedia.md +2 -0
  4. data/docs/SfvbApi.md +1660 -162
  5. data/docs/SfvbApprovalCreateRequest.md +8 -0
  6. data/docs/SfvbCampaign.md +4 -0
  7. data/docs/SfvbCampaignWriteRequest.md +2 -0
  8. data/docs/SfvbCommsBranchStat.md +20 -0
  9. data/docs/SfvbCommsChange.md +22 -0
  10. data/docs/SfvbCommsClick.md +20 -0
  11. data/docs/SfvbCommsClicksResponse.md +26 -0
  12. data/docs/SfvbCommsDailyStat.md +30 -0
  13. data/docs/SfvbCommsDashboardResponse.md +24 -0
  14. data/docs/SfvbCommsDashboardRow.md +28 -0
  15. data/docs/SfvbCommsLookupOwner.md +26 -0
  16. data/docs/SfvbCommsLookupResponse.md +34 -0
  17. data/docs/SfvbCommsPlan.md +66 -0
  18. data/docs/SfvbCommsPlanResponse.md +20 -0
  19. data/docs/SfvbCommsProvider.md +28 -0
  20. data/docs/SfvbCommsProviderImportRequest.md +22 -0
  21. data/docs/SfvbCommsProviderImportResponse.md +26 -0
  22. data/docs/SfvbCommsProviderList.md +20 -0
  23. data/docs/SfvbCommsProvidersResponse.md +22 -0
  24. data/docs/SfvbCommsRulerValidateRequest.md +18 -0
  25. data/docs/SfvbCommsRulerValidateResponse.md +22 -0
  26. data/docs/SfvbCommsSender.md +24 -0
  27. data/docs/SfvbCommsSenderUpdate.md +22 -0
  28. data/docs/SfvbCommsSequenceFolder.md +28 -0
  29. data/docs/SfvbCommsSequenceFolderResponse.md +22 -0
  30. data/docs/SfvbCommsSequenceFoldersResponse.md +18 -0
  31. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  32. data/docs/SfvbCommsSettings.md +34 -0
  33. data/docs/SfvbCommsSettingsResponse.md +24 -0
  34. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  35. data/docs/SfvbCommsStat.md +54 -0
  36. data/docs/SfvbCommsStepStat.md +34 -0
  37. data/docs/SfvbCommsTemplate.md +30 -0
  38. data/docs/SfvbCommsTemplateResponse.md +30 -0
  39. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  40. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  41. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  42. data/docs/SfvbCommsTestSendResponse.md +32 -0
  43. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  44. data/docs/SfvbCommsUnreferencedEmail.md +30 -0
  45. data/docs/SfvbCommsUnreferencedPostcard.md +24 -0
  46. data/docs/SfvbCommsUnreferencedResponse.md +32 -0
  47. data/docs/SfvbEmail.md +8 -0
  48. data/docs/SfvbFlow.md +4 -0
  49. data/docs/SfvbFlowBackfillRequest.md +24 -0
  50. data/docs/SfvbFlowBackfillResponse.md +38 -0
  51. data/docs/SfvbFlowWriteRequest.md +2 -0
  52. data/docs/SfvbStepCounts.md +1 -1
  53. data/lib/ultracart_api/api/sfvb_api.rb +2356 -348
  54. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  55. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +39 -3
  56. data/lib/ultracart_api/models/sfvb_campaign.rb +21 -1
  57. data/lib/ultracart_api/models/sfvb_campaign_write_request.rb +11 -1
  58. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  59. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  60. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  61. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  62. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  63. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  64. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  65. data/lib/ultracart_api/models/sfvb_comms_lookup_owner.rb +260 -0
  66. data/lib/ultracart_api/models/sfvb_comms_lookup_response.rb +301 -0
  67. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  68. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  69. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  70. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  71. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  72. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  73. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  74. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_request.rb +220 -0
  75. data/lib/ultracart_api/models/sfvb_comms_ruler_validate_response.rb +242 -0
  76. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  77. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  78. data/lib/ultracart_api/models/sfvb_comms_sequence_folder.rb +270 -0
  79. data/lib/ultracart_api/models/sfvb_comms_sequence_folder_response.rb +243 -0
  80. data/lib/ultracart_api/models/sfvb_comms_sequence_folders_response.rb +222 -0
  81. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  82. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  83. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  84. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  85. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  86. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  87. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  88. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +281 -0
  89. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  90. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  91. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  92. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  93. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  94. data/lib/ultracart_api/models/sfvb_comms_unreferenced_email.rb +280 -0
  95. data/lib/ultracart_api/models/sfvb_comms_unreferenced_postcard.rb +250 -0
  96. data/lib/ultracart_api/models/sfvb_comms_unreferenced_response.rb +296 -0
  97. data/lib/ultracart_api/models/sfvb_email.rb +41 -1
  98. data/lib/ultracart_api/models/sfvb_flow.rb +21 -1
  99. data/lib/ultracart_api/models/sfvb_flow_backfill_request.rb +250 -0
  100. data/lib/ultracart_api/models/sfvb_flow_backfill_response.rb +322 -0
  101. data/lib/ultracart_api/models/sfvb_flow_write_request.rb +11 -1
  102. data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
  103. data/lib/ultracart_api/version.rb +1 -1
  104. data/lib/ultracart_api.rb +41 -0
  105. metadata +84 -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,37 +5136,37 @@ module UltracartClient
4898
5136
  return data, status_code, headers
4899
5137
  end
4900
5138
 
4901
- # Read one list and segment folder
4902
- # The folder, with the name and uuid of each list and segment filed in it.
5139
+ # Read one campaign folder
5140
+ # The folder, with the name and uuid of each campaign filed in it.
4903
5141
  # @param storefront_oid [Integer]
4904
5142
  # @param folder_uuid [String]
4905
5143
  # @param [Hash] opts the optional parameters
4906
- # @return [SfvbCommsFolderResponse]
4907
- def get_sfvb_comms_folder(storefront_oid, folder_uuid, opts = {})
4908
- data, _status_code, _headers = get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts)
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)
4909
5147
  data
4910
5148
  end
4911
5149
 
4912
- # Read one list and segment folder
4913
- # The folder, with the name and uuid of each list and segment filed in it.
5150
+ # Read one campaign folder
5151
+ # The folder, with the name and uuid of each campaign filed in it.
4914
5152
  # @param storefront_oid [Integer]
4915
5153
  # @param folder_uuid [String]
4916
5154
  # @param [Hash] opts the optional parameters
4917
- # @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
4918
- def get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
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 = {})
4919
5157
  if @api_client.config.debugging
4920
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folder ...'
5158
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_campaign_folder ...'
4921
5159
  end
4922
5160
  # verify the required parameter 'storefront_oid' is set
4923
5161
  if @api_client.config.client_side_validation && storefront_oid.nil?
4924
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folder"
5162
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_campaign_folder"
4925
5163
  end
4926
5164
  # verify the required parameter 'folder_uuid' is set
4927
5165
  if @api_client.config.client_side_validation && folder_uuid.nil?
4928
- fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_folder"
5166
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_campaign_folder"
4929
5167
  end
4930
5168
  # resource path
4931
- local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
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))
4932
5170
 
4933
5171
  # query parameters
4934
5172
  query_params = opts[:query_params] || {}
@@ -4946,13 +5184,13 @@ module UltracartClient
4946
5184
  post_body = opts[:debug_body]
4947
5185
 
4948
5186
  # return_type
4949
- return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
5187
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
4950
5188
 
4951
5189
  # auth_names
4952
5190
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4953
5191
 
4954
5192
  new_options = opts.merge(
4955
- :operation => :"SfvbApi.get_sfvb_comms_folder",
5193
+ :operation => :"SfvbApi.get_sfvb_comms_campaign_folder",
4956
5194
  :header_params => header_params,
4957
5195
  :query_params => query_params,
4958
5196
  :form_params => form_params,
@@ -4963,36 +5201,36 @@ module UltracartClient
4963
5201
 
4964
5202
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4965
5203
  if @api_client.config.debugging
4966
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5204
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4967
5205
  end
4968
5206
  return data, status_code, headers
4969
5207
  end
4970
5208
 
4971
- # List the list and segment folders
4972
- # Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
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.
4973
5211
  # @param storefront_oid [Integer]
4974
5212
  # @param [Hash] opts the optional parameters
4975
- # @return [SfvbCommsFoldersResponse]
4976
- def get_sfvb_comms_folders(storefront_oid, opts = {})
4977
- data, _status_code, _headers = get_sfvb_comms_folders_with_http_info(storefront_oid, opts)
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)
4978
5216
  data
4979
5217
  end
4980
5218
 
4981
- # List the list and segment folders
4982
- # Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
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.
4983
5221
  # @param storefront_oid [Integer]
4984
5222
  # @param [Hash] opts the optional parameters
4985
- # @return [Array<(SfvbCommsFoldersResponse, Integer, Hash)>] SfvbCommsFoldersResponse data, response status code and response headers
4986
- def get_sfvb_comms_folders_with_http_info(storefront_oid, opts = {})
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 = {})
4987
5225
  if @api_client.config.debugging
4988
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folders ...'
5226
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_campaign_folders ...'
4989
5227
  end
4990
5228
  # verify the required parameter 'storefront_oid' is set
4991
5229
  if @api_client.config.client_side_validation && storefront_oid.nil?
4992
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folders"
5230
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_campaign_folders"
4993
5231
  end
4994
5232
  # resource path
4995
- local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5233
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
4996
5234
 
4997
5235
  # query parameters
4998
5236
  query_params = opts[:query_params] || {}
@@ -5010,13 +5248,13 @@ module UltracartClient
5010
5248
  post_body = opts[:debug_body]
5011
5249
 
5012
5250
  # return_type
5013
- return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
5251
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFoldersResponse'
5014
5252
 
5015
5253
  # auth_names
5016
5254
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5017
5255
 
5018
5256
  new_options = opts.merge(
5019
- :operation => :"SfvbApi.get_sfvb_comms_folders",
5257
+ :operation => :"SfvbApi.get_sfvb_comms_campaign_folders",
5020
5258
  :header_params => header_params,
5021
5259
  :query_params => query_params,
5022
5260
  :form_params => form_params,
@@ -5027,45 +5265,42 @@ module UltracartClient
5027
5265
 
5028
5266
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5029
5267
  if @api_client.config.debugging
5030
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5268
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_campaign_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5031
5269
  end
5032
5270
  return data, status_code, headers
5033
5271
  end
5034
5272
 
5035
- # Read one email list
5036
- # The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
5273
+ # Read every flow's and campaign's counts over a window, with the account's daily sending
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.
5037
5275
  # @param storefront_oid [Integer]
5038
- # @param list_uuid [String]
5039
5276
  # @param [Hash] opts the optional parameters
5040
- # @return [SfvbCommsListResponse]
5041
- def get_sfvb_comms_list(storefront_oid, list_uuid, opts = {})
5042
- data, _status_code, _headers = get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts)
5277
+ # @option opts [Integer] :days The window for the rows, 1 to 365 days (default 30).
5278
+ # @return [SfvbCommsDashboardResponse]
5279
+ def get_sfvb_comms_dashboard_stats(storefront_oid, opts = {})
5280
+ data, _status_code, _headers = get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
5043
5281
  data
5044
5282
  end
5045
5283
 
5046
- # Read one email list
5047
- # The list&#39;s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
5284
+ # Read every flow&#39;s and campaign&#39;s counts over a window, with the account&#39;s daily sending
5285
+ # rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account&#39;s last 31 days of sending, whatever the window. Read only.
5048
5286
  # @param storefront_oid [Integer]
5049
- # @param list_uuid [String]
5050
5287
  # @param [Hash] opts the optional parameters
5051
- # @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
5052
- def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
5288
+ # @option opts [Integer] :days The window for the rows, 1 to 365 days (default 30).
5289
+ # @return [Array<(SfvbCommsDashboardResponse, Integer, Hash)>] SfvbCommsDashboardResponse data, response status code and response headers
5290
+ def get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts = {})
5053
5291
  if @api_client.config.debugging
5054
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
5292
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_dashboard_stats ...'
5055
5293
  end
5056
5294
  # verify the required parameter 'storefront_oid' is set
5057
5295
  if @api_client.config.client_side_validation && storefront_oid.nil?
5058
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list"
5059
- end
5060
- # verify the required parameter 'list_uuid' is set
5061
- if @api_client.config.client_side_validation && list_uuid.nil?
5062
- fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list"
5296
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_dashboard_stats"
5063
5297
  end
5064
5298
  # resource path
5065
- local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
5299
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/stats/dashboard'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5066
5300
 
5067
5301
  # query parameters
5068
5302
  query_params = opts[:query_params] || {}
5303
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5069
5304
 
5070
5305
  # header parameters
5071
5306
  header_params = opts[:header_params] || {}
@@ -5080,13 +5315,13 @@ module UltracartClient
5080
5315
  post_body = opts[:debug_body]
5081
5316
 
5082
5317
  # return_type
5083
- return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
5318
+ return_type = opts[:debug_return_type] || 'SfvbCommsDashboardResponse'
5084
5319
 
5085
5320
  # auth_names
5086
5321
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5087
5322
 
5088
5323
  new_options = opts.merge(
5089
- :operation => :"SfvbApi.get_sfvb_comms_list",
5324
+ :operation => :"SfvbApi.get_sfvb_comms_dashboard_stats",
5090
5325
  :header_params => header_params,
5091
5326
  :query_params => query_params,
5092
5327
  :form_params => form_params,
@@ -5097,48 +5332,807 @@ module UltracartClient
5097
5332
 
5098
5333
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5099
5334
  if @api_client.config.debugging
5100
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5335
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_dashboard_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5101
5336
  end
5102
5337
  return data, status_code, headers
5103
5338
  end
5104
5339
 
5105
- # Read one page of a list's members
5106
- # Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
5340
+ # Read each link in one email and how often it was clicked
5341
+ # The email must be sent by an email or experiment step of this flow's or campaign's sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
5107
5342
  # @param storefront_oid [Integer]
5108
- # @param list_uuid [String]
5343
+ # @param commseq_uuid [String]
5344
+ # @param email_uuid [String]
5109
5345
  # @param [Hash] opts the optional parameters
5110
- # @option opts [Integer] :page The page, from 1
5111
- # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5112
- # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5113
- # @return [SfvbCommsMembersResponse]
5114
- def get_sfvb_comms_list_members(storefront_oid, list_uuid, opts = {})
5115
- data, _status_code, _headers = get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
5346
+ # @option opts [Integer] :days The window, 1 to 365 days (default 30).
5347
+ # @return [SfvbCommsClicksResponse]
5348
+ def get_sfvb_comms_email_clicks(storefront_oid, commseq_uuid, email_uuid, opts = {})
5349
+ data, _status_code, _headers = get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
5116
5350
  data
5117
5351
  end
5118
5352
 
5119
- # Read one page of a list&#39;s members
5120
- # Each member&#39;s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person&#39;s address. Read only.
5353
+ # Read each link in one email and how often it was clicked
5354
+ # The email must be sent by an email or experiment step of this flow&#39;s or campaign&#39;s sequence; any other is 404. Most clicked first, over the last days (1 to 365, default 30). Read only.
5121
5355
  # @param storefront_oid [Integer]
5122
- # @param list_uuid [String]
5356
+ # @param commseq_uuid [String]
5357
+ # @param email_uuid [String]
5123
5358
  # @param [Hash] opts the optional parameters
5124
- # @option opts [Integer] :page The page, from 1
5125
- # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5126
- # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5127
- # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
5128
- def get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts = {})
5359
+ # @option opts [Integer] :days The window, 1 to 365 days (default 30).
5360
+ # @return [Array<(SfvbCommsClicksResponse, Integer, Hash)>] SfvbCommsClicksResponse data, response status code and response headers
5361
+ def get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts = {})
5129
5362
  if @api_client.config.debugging
5130
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list_members ...'
5363
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_email_clicks ...'
5131
5364
  end
5132
5365
  # verify the required parameter 'storefront_oid' is set
5133
5366
  if @api_client.config.client_side_validation && storefront_oid.nil?
5134
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list_members"
5367
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5135
5368
  end
5136
- # verify the required parameter 'list_uuid' is set
5137
- if @api_client.config.client_side_validation && list_uuid.nil?
5138
- fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list_members"
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 ...'
5507
+ end
5508
+ # verify the required parameter 'storefront_oid' is set
5509
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5510
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_flow_folders"
5511
+ end
5512
+ # resource path
5513
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/flow_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5514
+
5515
+ # query parameters
5516
+ query_params = opts[:query_params] || {}
5517
+
5518
+ # header parameters
5519
+ header_params = opts[:header_params] || {}
5520
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5521
+ # HTTP header 'Accept' (if needed)
5522
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5523
+
5524
+ # form parameters
5525
+ form_params = opts[:form_params] || {}
5526
+
5527
+ # http body (model)
5528
+ post_body = opts[:debug_body]
5529
+
5530
+ # return_type
5531
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFoldersResponse'
5532
+
5533
+ # auth_names
5534
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5535
+
5536
+ new_options = opts.merge(
5537
+ :operation => :"SfvbApi.get_sfvb_comms_flow_folders",
5538
+ :header_params => header_params,
5539
+ :query_params => query_params,
5540
+ :form_params => form_params,
5541
+ :body => post_body,
5542
+ :auth_names => auth_names,
5543
+ :return_type => return_type
5544
+ )
5545
+
5546
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5547
+ if @api_client.config.debugging
5548
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_flow_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5549
+ end
5550
+ return data, status_code, headers
5551
+ end
5552
+
5553
+ # Read one list and segment folder
5554
+ # The folder, with the name and uuid of each list and segment filed in it.
5555
+ # @param storefront_oid [Integer]
5556
+ # @param folder_uuid [String]
5557
+ # @param [Hash] opts the optional parameters
5558
+ # @return [SfvbCommsFolderResponse]
5559
+ def get_sfvb_comms_folder(storefront_oid, folder_uuid, opts = {})
5560
+ data, _status_code, _headers = get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts)
5561
+ data
5562
+ end
5563
+
5564
+ # Read one list and segment folder
5565
+ # The folder, with the name and uuid of each list and segment filed in it.
5566
+ # @param storefront_oid [Integer]
5567
+ # @param folder_uuid [String]
5568
+ # @param [Hash] opts the optional parameters
5569
+ # @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
5570
+ def get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
5571
+ if @api_client.config.debugging
5572
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folder ...'
5573
+ end
5574
+ # verify the required parameter 'storefront_oid' is set
5575
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5576
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folder"
5577
+ end
5578
+ # verify the required parameter 'folder_uuid' is set
5579
+ if @api_client.config.client_side_validation && folder_uuid.nil?
5580
+ fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_folder"
5581
+ end
5582
+ # resource path
5583
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
5584
+
5585
+ # query parameters
5586
+ query_params = opts[:query_params] || {}
5587
+
5588
+ # header parameters
5589
+ header_params = opts[:header_params] || {}
5590
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5591
+ # HTTP header 'Accept' (if needed)
5592
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5593
+
5594
+ # form parameters
5595
+ form_params = opts[:form_params] || {}
5596
+
5597
+ # http body (model)
5598
+ post_body = opts[:debug_body]
5599
+
5600
+ # return_type
5601
+ return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
5602
+
5603
+ # auth_names
5604
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5605
+
5606
+ new_options = opts.merge(
5607
+ :operation => :"SfvbApi.get_sfvb_comms_folder",
5608
+ :header_params => header_params,
5609
+ :query_params => query_params,
5610
+ :form_params => form_params,
5611
+ :body => post_body,
5612
+ :auth_names => auth_names,
5613
+ :return_type => return_type
5614
+ )
5615
+
5616
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5617
+ if @api_client.config.debugging
5618
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5619
+ end
5620
+ return data, status_code, headers
5621
+ end
5622
+
5623
+ # List the list and segment folders
5624
+ # Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
5625
+ # @param storefront_oid [Integer]
5626
+ # @param [Hash] opts the optional parameters
5627
+ # @return [SfvbCommsFoldersResponse]
5628
+ def get_sfvb_comms_folders(storefront_oid, opts = {})
5629
+ data, _status_code, _headers = get_sfvb_comms_folders_with_http_info(storefront_oid, opts)
5630
+ data
5631
+ end
5632
+
5633
+ # List the list and segment folders
5634
+ # Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
5635
+ # @param storefront_oid [Integer]
5636
+ # @param [Hash] opts the optional parameters
5637
+ # @return [Array<(SfvbCommsFoldersResponse, Integer, Hash)>] SfvbCommsFoldersResponse data, response status code and response headers
5638
+ def get_sfvb_comms_folders_with_http_info(storefront_oid, opts = {})
5639
+ if @api_client.config.debugging
5640
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folders ...'
5641
+ end
5642
+ # verify the required parameter 'storefront_oid' is set
5643
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5644
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folders"
5645
+ end
5646
+ # resource path
5647
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5648
+
5649
+ # query parameters
5650
+ query_params = opts[:query_params] || {}
5651
+
5652
+ # header parameters
5653
+ header_params = opts[:header_params] || {}
5654
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5655
+ # HTTP header 'Accept' (if needed)
5656
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5657
+
5658
+ # form parameters
5659
+ form_params = opts[:form_params] || {}
5660
+
5661
+ # http body (model)
5662
+ post_body = opts[:debug_body]
5663
+
5664
+ # return_type
5665
+ return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
5666
+
5667
+ # auth_names
5668
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5669
+
5670
+ new_options = opts.merge(
5671
+ :operation => :"SfvbApi.get_sfvb_comms_folders",
5672
+ :header_params => header_params,
5673
+ :query_params => query_params,
5674
+ :form_params => form_params,
5675
+ :body => post_body,
5676
+ :auth_names => auth_names,
5677
+ :return_type => return_type
5678
+ )
5679
+
5680
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5681
+ if @api_client.config.debugging
5682
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5683
+ end
5684
+ return data, status_code, headers
5685
+ end
5686
+
5687
+ # Read one email list
5688
+ # The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
5689
+ # @param storefront_oid [Integer]
5690
+ # @param list_uuid [String]
5691
+ # @param [Hash] opts the optional parameters
5692
+ # @return [SfvbCommsListResponse]
5693
+ def get_sfvb_comms_list(storefront_oid, list_uuid, opts = {})
5694
+ data, _status_code, _headers = get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts)
5695
+ data
5696
+ end
5697
+
5698
+ # Read one email list
5699
+ # The list&#39;s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
5700
+ # @param storefront_oid [Integer]
5701
+ # @param list_uuid [String]
5702
+ # @param [Hash] opts the optional parameters
5703
+ # @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
5704
+ def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
5705
+ if @api_client.config.debugging
5706
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
5707
+ end
5708
+ # verify the required parameter 'storefront_oid' is set
5709
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5710
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list"
5711
+ end
5712
+ # verify the required parameter 'list_uuid' is set
5713
+ if @api_client.config.client_side_validation && list_uuid.nil?
5714
+ fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list"
5715
+ end
5716
+ # resource path
5717
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
5718
+
5719
+ # query parameters
5720
+ query_params = opts[:query_params] || {}
5721
+
5722
+ # header parameters
5723
+ header_params = opts[:header_params] || {}
5724
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5725
+ # HTTP header 'Accept' (if needed)
5726
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5727
+
5728
+ # form parameters
5729
+ form_params = opts[:form_params] || {}
5730
+
5731
+ # http body (model)
5732
+ post_body = opts[:debug_body]
5733
+
5734
+ # return_type
5735
+ return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
5736
+
5737
+ # auth_names
5738
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5739
+
5740
+ new_options = opts.merge(
5741
+ :operation => :"SfvbApi.get_sfvb_comms_list",
5742
+ :header_params => header_params,
5743
+ :query_params => query_params,
5744
+ :form_params => form_params,
5745
+ :body => post_body,
5746
+ :auth_names => auth_names,
5747
+ :return_type => return_type
5748
+ )
5749
+
5750
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5751
+ if @api_client.config.debugging
5752
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5753
+ end
5754
+ return data, status_code, headers
5755
+ end
5756
+
5757
+ # Read one page of a list's members
5758
+ # Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
5759
+ # @param storefront_oid [Integer]
5760
+ # @param list_uuid [String]
5761
+ # @param [Hash] opts the optional parameters
5762
+ # @option opts [Integer] :page The page, from 1
5763
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5764
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5765
+ # @return [SfvbCommsMembersResponse]
5766
+ def get_sfvb_comms_list_members(storefront_oid, list_uuid, opts = {})
5767
+ data, _status_code, _headers = get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
5768
+ data
5769
+ end
5770
+
5771
+ # Read one page of a list&#39;s members
5772
+ # Each member&#39;s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person&#39;s address. Read only.
5773
+ # @param storefront_oid [Integer]
5774
+ # @param list_uuid [String]
5775
+ # @param [Hash] opts the optional parameters
5776
+ # @option opts [Integer] :page The page, from 1
5777
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5778
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5779
+ # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
5780
+ def get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts = {})
5781
+ if @api_client.config.debugging
5782
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list_members ...'
5783
+ end
5784
+ # verify the required parameter 'storefront_oid' is set
5785
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5786
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list_members"
5787
+ end
5788
+ # verify the required parameter 'list_uuid' is set
5789
+ if @api_client.config.client_side_validation && list_uuid.nil?
5790
+ fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list_members"
5791
+ end
5792
+ # resource path
5793
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
5794
+
5795
+ # query parameters
5796
+ query_params = opts[:query_params] || {}
5797
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
5798
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
5799
+ query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
5800
+
5801
+ # header parameters
5802
+ header_params = opts[:header_params] || {}
5803
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5804
+ # HTTP header 'Accept' (if needed)
5805
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5806
+
5807
+ # form parameters
5808
+ form_params = opts[:form_params] || {}
5809
+
5810
+ # http body (model)
5811
+ post_body = opts[:debug_body]
5812
+
5813
+ # return_type
5814
+ return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
5815
+
5816
+ # auth_names
5817
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5818
+
5819
+ new_options = opts.merge(
5820
+ :operation => :"SfvbApi.get_sfvb_comms_list_members",
5821
+ :header_params => header_params,
5822
+ :query_params => query_params,
5823
+ :form_params => form_params,
5824
+ :body => post_body,
5825
+ :auth_names => auth_names,
5826
+ :return_type => return_type
5827
+ )
5828
+
5829
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5830
+ if @api_client.config.debugging
5831
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5832
+ end
5833
+ return data, status_code, headers
5834
+ end
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
+
5901
+ # Read the account's communications plan and sending health
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.
5903
+ # @param storefront_oid [Integer]
5904
+ # @param [Hash] opts the optional parameters
5905
+ # @return [SfvbCommsPlanResponse]
5906
+ def get_sfvb_comms_plan(storefront_oid, opts = {})
5907
+ data, _status_code, _headers = get_sfvb_comms_plan_with_http_info(storefront_oid, opts)
5908
+ data
5909
+ end
5910
+
5911
+ # Read the account&#39;s communications plan and sending health
5912
+ # 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.
5913
+ # @param storefront_oid [Integer]
5914
+ # @param [Hash] opts the optional parameters
5915
+ # @return [Array<(SfvbCommsPlanResponse, Integer, Hash)>] SfvbCommsPlanResponse data, response status code and response headers
5916
+ def get_sfvb_comms_plan_with_http_info(storefront_oid, opts = {})
5917
+ if @api_client.config.debugging
5918
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_plan ...'
5919
+ end
5920
+ # verify the required parameter 'storefront_oid' is set
5921
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5922
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_plan"
5923
+ end
5924
+ # resource path
5925
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/plan'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5926
+
5927
+ # query parameters
5928
+ query_params = opts[:query_params] || {}
5929
+
5930
+ # header parameters
5931
+ header_params = opts[:header_params] || {}
5932
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5933
+ # HTTP header 'Accept' (if needed)
5934
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5935
+
5936
+ # form parameters
5937
+ form_params = opts[:form_params] || {}
5938
+
5939
+ # http body (model)
5940
+ post_body = opts[:debug_body]
5941
+
5942
+ # return_type
5943
+ return_type = opts[:debug_return_type] || 'SfvbCommsPlanResponse'
5944
+
5945
+ # auth_names
5946
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5947
+
5948
+ new_options = opts.merge(
5949
+ :operation => :"SfvbApi.get_sfvb_comms_plan",
5950
+ :header_params => header_params,
5951
+ :query_params => query_params,
5952
+ :form_params => form_params,
5953
+ :body => post_body,
5954
+ :auth_names => auth_names,
5955
+ :return_type => return_type
5956
+ )
5957
+
5958
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5959
+ if @api_client.config.debugging
5960
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5961
+ end
5962
+ return data, status_code, headers
5963
+ end
5964
+
5965
+ # List the email providers the account can import lists from
5966
+ # Each provider that can share list members, connected or not, with a connected one's lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
5967
+ # @param storefront_oid [Integer]
5968
+ # @param [Hash] opts the optional parameters
5969
+ # @return [SfvbCommsProvidersResponse]
5970
+ def get_sfvb_comms_providers(storefront_oid, opts = {})
5971
+ data, _status_code, _headers = get_sfvb_comms_providers_with_http_info(storefront_oid, opts)
5972
+ data
5973
+ end
5974
+
5975
+ # List the email providers the account can import lists from
5976
+ # Each provider that can share list members, connected or not, with a connected one&#39;s lists. Each call asks the providers themselves, so it is rate limited. No credential or connect URL is returned. import_allowed says whether the account may import. Read only.
5977
+ # @param storefront_oid [Integer]
5978
+ # @param [Hash] opts the optional parameters
5979
+ # @return [Array<(SfvbCommsProvidersResponse, Integer, Hash)>] SfvbCommsProvidersResponse data, response status code and response headers
5980
+ def get_sfvb_comms_providers_with_http_info(storefront_oid, opts = {})
5981
+ if @api_client.config.debugging
5982
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_providers ...'
5983
+ end
5984
+ # verify the required parameter 'storefront_oid' is set
5985
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5986
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_providers"
5987
+ end
5988
+ # resource path
5989
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/providers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5990
+
5991
+ # query parameters
5992
+ query_params = opts[:query_params] || {}
5993
+
5994
+ # header parameters
5995
+ header_params = opts[:header_params] || {}
5996
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5997
+ # HTTP header 'Accept' (if needed)
5998
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5999
+
6000
+ # form parameters
6001
+ form_params = opts[:form_params] || {}
6002
+
6003
+ # http body (model)
6004
+ post_body = opts[:debug_body]
6005
+
6006
+ # return_type
6007
+ return_type = opts[:debug_return_type] || 'SfvbCommsProvidersResponse'
6008
+
6009
+ # auth_names
6010
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6011
+
6012
+ new_options = opts.merge(
6013
+ :operation => :"SfvbApi.get_sfvb_comms_providers",
6014
+ :header_params => header_params,
6015
+ :query_params => query_params,
6016
+ :form_params => form_params,
6017
+ :body => post_body,
6018
+ :auth_names => auth_names,
6019
+ :return_type => return_type
6020
+ )
6021
+
6022
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6023
+ if @api_client.config.debugging
6024
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6025
+ end
6026
+ return data, status_code, headers
6027
+ end
6028
+
6029
+ # Read one segment, with its rule
6030
+ # The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
6031
+ # @param storefront_oid [Integer]
6032
+ # @param segment_uuid [String]
6033
+ # @param [Hash] opts the optional parameters
6034
+ # @return [SfvbCommsSegmentResponse]
6035
+ def get_sfvb_comms_segment(storefront_oid, segment_uuid, opts = {})
6036
+ data, _status_code, _headers = get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts)
6037
+ data
6038
+ end
6039
+
6040
+ # Read one segment, with its rule
6041
+ # The segment&#39;s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
6042
+ # @param storefront_oid [Integer]
6043
+ # @param segment_uuid [String]
6044
+ # @param [Hash] opts the optional parameters
6045
+ # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
6046
+ def get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts = {})
6047
+ if @api_client.config.debugging
6048
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment ...'
6049
+ end
6050
+ # verify the required parameter 'storefront_oid' is set
6051
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6052
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment"
6053
+ end
6054
+ # verify the required parameter 'segment_uuid' is set
6055
+ if @api_client.config.client_side_validation && segment_uuid.nil?
6056
+ fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment"
6057
+ end
6058
+ # resource path
6059
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
6060
+
6061
+ # query parameters
6062
+ query_params = opts[:query_params] || {}
6063
+
6064
+ # header parameters
6065
+ header_params = opts[:header_params] || {}
6066
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6067
+ # HTTP header 'Accept' (if needed)
6068
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6069
+
6070
+ # form parameters
6071
+ form_params = opts[:form_params] || {}
6072
+
6073
+ # http body (model)
6074
+ post_body = opts[:debug_body]
6075
+
6076
+ # return_type
6077
+ return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
6078
+
6079
+ # auth_names
6080
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6081
+
6082
+ new_options = opts.merge(
6083
+ :operation => :"SfvbApi.get_sfvb_comms_segment",
6084
+ :header_params => header_params,
6085
+ :query_params => query_params,
6086
+ :form_params => form_params,
6087
+ :body => post_body,
6088
+ :auth_names => auth_names,
6089
+ :return_type => return_type
6090
+ )
6091
+
6092
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6093
+ if @api_client.config.debugging
6094
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6095
+ end
6096
+ return data, status_code, headers
6097
+ end
6098
+
6099
+ # Read one page of a segment's members
6100
+ # Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
6101
+ # @param storefront_oid [Integer]
6102
+ # @param segment_uuid [String]
6103
+ # @param [Hash] opts the optional parameters
6104
+ # @option opts [Integer] :page The page, from 1
6105
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
6106
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
6107
+ # @return [SfvbCommsMembersResponse]
6108
+ def get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts = {})
6109
+ data, _status_code, _headers = get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
6110
+ data
6111
+ end
6112
+
6113
+ # Read one page of a segment&#39;s members
6114
+ # Each member&#39;s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person&#39;s address. Read only.
6115
+ # @param storefront_oid [Integer]
6116
+ # @param segment_uuid [String]
6117
+ # @param [Hash] opts the optional parameters
6118
+ # @option opts [Integer] :page The page, from 1
6119
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
6120
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
6121
+ # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
6122
+ def get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts = {})
6123
+ if @api_client.config.debugging
6124
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment_members ...'
6125
+ end
6126
+ # verify the required parameter 'storefront_oid' is set
6127
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6128
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment_members"
6129
+ end
6130
+ # verify the required parameter 'segment_uuid' is set
6131
+ if @api_client.config.client_side_validation && segment_uuid.nil?
6132
+ fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment_members"
5139
6133
  end
5140
6134
  # resource path
5141
- local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
6135
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
5142
6136
 
5143
6137
  # query parameters
5144
6138
  query_params = opts[:query_params] || {}
@@ -5165,7 +6159,7 @@ module UltracartClient
5165
6159
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5166
6160
 
5167
6161
  new_options = opts.merge(
5168
- :operation => :"SfvbApi.get_sfvb_comms_list_members",
6162
+ :operation => :"SfvbApi.get_sfvb_comms_segment_members",
5169
6163
  :header_params => header_params,
5170
6164
  :query_params => query_params,
5171
6165
  :form_params => form_params,
@@ -5176,45 +6170,170 @@ module UltracartClient
5176
6170
 
5177
6171
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5178
6172
  if @api_client.config.debugging
5179
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6173
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5180
6174
  end
5181
6175
  return data, status_code, headers
5182
6176
  end
5183
6177
 
5184
- # Read one segment, with its rule
5185
- # The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
6178
+ # Read a sending domain
6179
+ # One sending domain as stored. To check an amazon domain's DNS again, use the status call.
6180
+ # @param domain [String]
6181
+ # @param [Hash] opts the optional parameters
6182
+ # @return [SfvbCommsSendingDomain]
6183
+ def get_sfvb_comms_sending_domain(domain, opts = {})
6184
+ data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
6185
+ data
6186
+ end
6187
+
6188
+ # Read a sending domain
6189
+ # One sending domain as stored. To check an amazon domain&#39;s DNS again, use the status call.
6190
+ # @param domain [String]
6191
+ # @param [Hash] opts the optional parameters
6192
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
6193
+ def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
6194
+ if @api_client.config.debugging
6195
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
6196
+ end
6197
+ # verify the required parameter 'domain' is set
6198
+ if @api_client.config.client_side_validation && domain.nil?
6199
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
6200
+ end
6201
+ # resource path
6202
+ local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
6203
+
6204
+ # query parameters
6205
+ query_params = opts[:query_params] || {}
6206
+
6207
+ # header parameters
6208
+ header_params = opts[:header_params] || {}
6209
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6210
+ # HTTP header 'Accept' (if needed)
6211
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6212
+
6213
+ # form parameters
6214
+ form_params = opts[:form_params] || {}
6215
+
6216
+ # http body (model)
6217
+ post_body = opts[:debug_body]
6218
+
6219
+ # return_type
6220
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
6221
+
6222
+ # auth_names
6223
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6224
+
6225
+ new_options = opts.merge(
6226
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domain",
6227
+ :header_params => header_params,
6228
+ :query_params => query_params,
6229
+ :form_params => form_params,
6230
+ :body => post_body,
6231
+ :auth_names => auth_names,
6232
+ :return_type => return_type
6233
+ )
6234
+
6235
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6236
+ if @api_client.config.debugging
6237
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6238
+ end
6239
+ return data, status_code, headers
6240
+ end
6241
+
6242
+ # List the sending domains
6243
+ # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
6244
+ # @param [Hash] opts the optional parameters
6245
+ # @return [SfvbCommsSendingDomainsResponse]
6246
+ def get_sfvb_comms_sending_domains(opts = {})
6247
+ data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
6248
+ data
6249
+ end
6250
+
6251
+ # List the sending domains
6252
+ # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
6253
+ # @param [Hash] opts the optional parameters
6254
+ # @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
6255
+ def get_sfvb_comms_sending_domains_with_http_info(opts = {})
6256
+ if @api_client.config.debugging
6257
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
6258
+ end
6259
+ # resource path
6260
+ local_var_path = '/sfvb/comms/sending_domains'
6261
+
6262
+ # query parameters
6263
+ query_params = opts[:query_params] || {}
6264
+
6265
+ # header parameters
6266
+ header_params = opts[:header_params] || {}
6267
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6268
+ # HTTP header 'Accept' (if needed)
6269
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6270
+
6271
+ # form parameters
6272
+ form_params = opts[:form_params] || {}
6273
+
6274
+ # http body (model)
6275
+ post_body = opts[:debug_body]
6276
+
6277
+ # return_type
6278
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
6279
+
6280
+ # auth_names
6281
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6282
+
6283
+ new_options = opts.merge(
6284
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domains",
6285
+ :header_params => header_params,
6286
+ :query_params => query_params,
6287
+ :form_params => form_params,
6288
+ :body => post_body,
6289
+ :auth_names => auth_names,
6290
+ :return_type => return_type
6291
+ )
6292
+
6293
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6294
+ if @api_client.config.debugging
6295
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6296
+ end
6297
+ return data, status_code, headers
6298
+ end
6299
+
6300
+ # Read a flow's or campaign's counts, overall and step by step
6301
+ # overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
5186
6302
  # @param storefront_oid [Integer]
5187
- # @param segment_uuid [String]
6303
+ # @param commseq_uuid [String]
5188
6304
  # @param [Hash] opts the optional parameters
5189
- # @return [SfvbCommsSegmentResponse]
5190
- def get_sfvb_comms_segment(storefront_oid, segment_uuid, opts = {})
5191
- data, _status_code, _headers = get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts)
6305
+ # @option opts [Integer] :days The window for the step counts, 1 to 365 days (default 30).
6306
+ # @return [SfvbCommsSequenceStatsResponse]
6307
+ def get_sfvb_comms_sequence_stats(storefront_oid, commseq_uuid, opts = {})
6308
+ data, _status_code, _headers = get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
5192
6309
  data
5193
6310
  end
5194
6311
 
5195
- # Read one segment, with its rule
5196
- # The segment&#39;s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
6312
+ # Read a flow&#39;s or campaign&#39;s counts, overall and step by step
6313
+ # overall covers all time; each email, SMS, postcard and branch step covers the last days (1 to 365, default 30). Each step reports only the counts its channel records and names the rest in not_measured, so a missing count is never zero. Bounces, opens and spam are counts here, not separate reports. Read only.
5197
6314
  # @param storefront_oid [Integer]
5198
- # @param segment_uuid [String]
6315
+ # @param commseq_uuid [String]
5199
6316
  # @param [Hash] opts the optional parameters
5200
- # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
5201
- def get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts = {})
6317
+ # @option opts [Integer] :days The window for the step counts, 1 to 365 days (default 30).
6318
+ # @return [Array<(SfvbCommsSequenceStatsResponse, Integer, Hash)>] SfvbCommsSequenceStatsResponse data, response status code and response headers
6319
+ def get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts = {})
5202
6320
  if @api_client.config.debugging
5203
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment ...'
6321
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sequence_stats ...'
5204
6322
  end
5205
6323
  # verify the required parameter 'storefront_oid' is set
5206
6324
  if @api_client.config.client_side_validation && storefront_oid.nil?
5207
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment"
6325
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_sequence_stats"
5208
6326
  end
5209
- # verify the required parameter 'segment_uuid' is set
5210
- if @api_client.config.client_side_validation && segment_uuid.nil?
5211
- fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment"
6327
+ # verify the required parameter 'commseq_uuid' is set
6328
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
6329
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.get_sfvb_comms_sequence_stats"
5212
6330
  end
5213
6331
  # resource path
5214
- local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
6332
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/stats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
5215
6333
 
5216
6334
  # query parameters
5217
6335
  query_params = opts[:query_params] || {}
6336
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5218
6337
 
5219
6338
  # header parameters
5220
6339
  header_params = opts[:header_params] || {}
@@ -5229,13 +6348,13 @@ module UltracartClient
5229
6348
  post_body = opts[:debug_body]
5230
6349
 
5231
6350
  # return_type
5232
- return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
6351
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceStatsResponse'
5233
6352
 
5234
6353
  # auth_names
5235
6354
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5236
6355
 
5237
6356
  new_options = opts.merge(
5238
- :operation => :"SfvbApi.get_sfvb_comms_segment",
6357
+ :operation => :"SfvbApi.get_sfvb_comms_sequence_stats",
5239
6358
  :header_params => header_params,
5240
6359
  :query_params => query_params,
5241
6360
  :form_params => form_params,
@@ -5246,54 +6365,39 @@ module UltracartClient
5246
6365
 
5247
6366
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5248
6367
  if @api_client.config.debugging
5249
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6368
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sequence_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5250
6369
  end
5251
6370
  return data, status_code, headers
5252
6371
  end
5253
6372
 
5254
- # Read one page of a segment's members
5255
- # Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
6373
+ # Read a storefront's communications settings
6374
+ # The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
5256
6375
  # @param storefront_oid [Integer]
5257
- # @param segment_uuid [String]
5258
6376
  # @param [Hash] opts the optional parameters
5259
- # @option opts [Integer] :page The page, from 1
5260
- # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5261
- # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5262
- # @return [SfvbCommsMembersResponse]
5263
- def get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts = {})
5264
- data, _status_code, _headers = get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
6377
+ # @return [SfvbCommsSettingsResponse]
6378
+ def get_sfvb_comms_settings(storefront_oid, opts = {})
6379
+ data, _status_code, _headers = get_sfvb_comms_settings_with_http_info(storefront_oid, opts)
5265
6380
  data
5266
6381
  end
5267
6382
 
5268
- # Read one page of a segment&#39;s members
5269
- # Each member&#39;s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person&#39;s address. Read only.
6383
+ # Read a storefront&#39;s communications settings
6384
+ # The postcard return address, the default marketing and transactional senders, and the default SMS number, with what each one drives in notes. Read only. hash_sha256 is the If-Match for an update.
5270
6385
  # @param storefront_oid [Integer]
5271
- # @param segment_uuid [String]
5272
6386
  # @param [Hash] opts the optional parameters
5273
- # @option opts [Integer] :page The page, from 1
5274
- # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5275
- # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5276
- # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
5277
- def get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts = {})
6387
+ # @return [Array<(SfvbCommsSettingsResponse, Integer, Hash)>] SfvbCommsSettingsResponse data, response status code and response headers
6388
+ def get_sfvb_comms_settings_with_http_info(storefront_oid, opts = {})
5278
6389
  if @api_client.config.debugging
5279
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment_members ...'
6390
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_settings ...'
5280
6391
  end
5281
6392
  # verify the required parameter 'storefront_oid' is set
5282
6393
  if @api_client.config.client_side_validation && storefront_oid.nil?
5283
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment_members"
5284
- end
5285
- # verify the required parameter 'segment_uuid' is set
5286
- if @api_client.config.client_side_validation && segment_uuid.nil?
5287
- fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment_members"
6394
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_settings"
5288
6395
  end
5289
6396
  # resource path
5290
- local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
6397
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5291
6398
 
5292
6399
  # query parameters
5293
6400
  query_params = opts[:query_params] || {}
5294
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
5295
- query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
5296
- query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
5297
6401
 
5298
6402
  # header parameters
5299
6403
  header_params = opts[:header_params] || {}
@@ -5308,13 +6412,13 @@ module UltracartClient
5308
6412
  post_body = opts[:debug_body]
5309
6413
 
5310
6414
  # return_type
5311
- return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
6415
+ return_type = opts[:debug_return_type] || 'SfvbCommsSettingsResponse'
5312
6416
 
5313
6417
  # auth_names
5314
6418
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5315
6419
 
5316
6420
  new_options = opts.merge(
5317
- :operation => :"SfvbApi.get_sfvb_comms_segment_members",
6421
+ :operation => :"SfvbApi.get_sfvb_comms_settings",
5318
6422
  :header_params => header_params,
5319
6423
  :query_params => query_params,
5320
6424
  :form_params => form_params,
@@ -5325,36 +6429,106 @@ module UltracartClient
5325
6429
 
5326
6430
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5327
6431
  if @api_client.config.debugging
5328
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6432
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5329
6433
  end
5330
6434
  return data, status_code, headers
5331
6435
  end
5332
6436
 
5333
- # Read a sending domain
5334
- # One sending domain as stored. To check an amazon domain's DNS again, use the status call.
5335
- # @param domain [String]
6437
+ # Read one saved email template's body
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.
6439
+ # @param storefront_oid [Integer]
6440
+ # @param email_template_oid [Integer]
6441
+ # @param [Hash] opts the optional parameters
6442
+ # @return [SfvbCommsTemplateResponse]
6443
+ def get_sfvb_comms_template(storefront_oid, email_template_oid, opts = {})
6444
+ data, _status_code, _headers = get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid, opts)
6445
+ data
6446
+ end
6447
+
6448
+ # Read one saved email template&#39;s body
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.
6450
+ # @param storefront_oid [Integer]
6451
+ # @param email_template_oid [Integer]
6452
+ # @param [Hash] opts the optional parameters
6453
+ # @return [Array<(SfvbCommsTemplateResponse, Integer, Hash)>] SfvbCommsTemplateResponse data, response status code and response headers
6454
+ def get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid, opts = {})
6455
+ if @api_client.config.debugging
6456
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_template ...'
6457
+ end
6458
+ # verify the required parameter 'storefront_oid' is set
6459
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6460
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_template"
6461
+ end
6462
+ # verify the required parameter 'email_template_oid' is set
6463
+ if @api_client.config.client_side_validation && email_template_oid.nil?
6464
+ fail ArgumentError, "Missing the required parameter 'email_template_oid' when calling SfvbApi.get_sfvb_comms_template"
6465
+ end
6466
+ # resource path
6467
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/templates/{email_template_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_template_oid' + '}', CGI.escape(email_template_oid.to_s))
6468
+
6469
+ # query parameters
6470
+ query_params = opts[:query_params] || {}
6471
+
6472
+ # header parameters
6473
+ header_params = opts[:header_params] || {}
6474
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6475
+ # HTTP header 'Accept' (if needed)
6476
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6477
+
6478
+ # form parameters
6479
+ form_params = opts[:form_params] || {}
6480
+
6481
+ # http body (model)
6482
+ post_body = opts[:debug_body]
6483
+
6484
+ # return_type
6485
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplateResponse'
6486
+
6487
+ # auth_names
6488
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6489
+
6490
+ new_options = opts.merge(
6491
+ :operation => :"SfvbApi.get_sfvb_comms_template",
6492
+ :header_params => header_params,
6493
+ :query_params => query_params,
6494
+ :form_params => form_params,
6495
+ :body => post_body,
6496
+ :auth_names => auth_names,
6497
+ :return_type => return_type
6498
+ )
6499
+
6500
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6501
+ if @api_client.config.debugging
6502
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6503
+ end
6504
+ return data, status_code, headers
6505
+ end
6506
+
6507
+ # List the email templates a new email can start from
6508
+ # One list: UltraCart's system templates and this storefront's saved ones (each with email_template_oid), then base templates, the active theme's files an email renders inside (each with path). Read only.
6509
+ # @param storefront_oid [Integer]
5336
6510
  # @param [Hash] opts the optional parameters
5337
- # @return [SfvbCommsSendingDomain]
5338
- def get_sfvb_comms_sending_domain(domain, opts = {})
5339
- data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
6511
+ # @return [SfvbCommsTemplatesResponse]
6512
+ def get_sfvb_comms_templates(storefront_oid, opts = {})
6513
+ data, _status_code, _headers = get_sfvb_comms_templates_with_http_info(storefront_oid, opts)
5340
6514
  data
5341
6515
  end
5342
6516
 
5343
- # Read a sending domain
5344
- # One sending domain as stored. To check an amazon domain&#39;s DNS again, use the status call.
5345
- # @param domain [String]
6517
+ # List the email templates a new email can start from
6518
+ # One list: UltraCart&#39;s system templates and this storefront&#39;s saved ones (each with email_template_oid), then base templates, the active theme&#39;s files an email renders inside (each with path). Read only.
6519
+ # @param storefront_oid [Integer]
5346
6520
  # @param [Hash] opts the optional parameters
5347
- # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
5348
- def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
6521
+ # @return [Array<(SfvbCommsTemplatesResponse, Integer, Hash)>] SfvbCommsTemplatesResponse data, response status code and response headers
6522
+ def get_sfvb_comms_templates_with_http_info(storefront_oid, opts = {})
5349
6523
  if @api_client.config.debugging
5350
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
6524
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_templates ...'
5351
6525
  end
5352
- # verify the required parameter 'domain' is set
5353
- if @api_client.config.client_side_validation && domain.nil?
5354
- fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
6526
+ # verify the required parameter 'storefront_oid' is set
6527
+ if @api_client.config.client_side_validation && storefront_oid.nil?
6528
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_templates"
5355
6529
  end
5356
6530
  # resource path
5357
- local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
6531
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/templates'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5358
6532
 
5359
6533
  # query parameters
5360
6534
  query_params = opts[:query_params] || {}
@@ -5372,13 +6546,13 @@ module UltracartClient
5372
6546
  post_body = opts[:debug_body]
5373
6547
 
5374
6548
  # return_type
5375
- return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
6549
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplatesResponse'
5376
6550
 
5377
6551
  # auth_names
5378
6552
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5379
6553
 
5380
6554
  new_options = opts.merge(
5381
- :operation => :"SfvbApi.get_sfvb_comms_sending_domain",
6555
+ :operation => :"SfvbApi.get_sfvb_comms_templates",
5382
6556
  :header_params => header_params,
5383
6557
  :query_params => query_params,
5384
6558
  :form_params => form_params,
@@ -5389,30 +6563,30 @@ module UltracartClient
5389
6563
 
5390
6564
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5391
6565
  if @api_client.config.debugging
5392
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6566
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5393
6567
  end
5394
6568
  return data, status_code, headers
5395
6569
  end
5396
6570
 
5397
- # List the sending domains
5398
- # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
6571
+ # Read the Twilio account
6572
+ # The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
5399
6573
  # @param [Hash] opts the optional parameters
5400
- # @return [SfvbCommsSendingDomainsResponse]
5401
- def get_sfvb_comms_sending_domains(opts = {})
5402
- data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
6574
+ # @return [SfvbCommsTwilioAccountResponse]
6575
+ def get_sfvb_comms_twilio_account(opts = {})
6576
+ data, _status_code, _headers = get_sfvb_comms_twilio_account_with_http_info(opts)
5403
6577
  data
5404
6578
  end
5405
6579
 
5406
- # List the sending domains
5407
- # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
6580
+ # Read the Twilio account
6581
+ # The account&#39;s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
5408
6582
  # @param [Hash] opts the optional parameters
5409
- # @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
5410
- def get_sfvb_comms_sending_domains_with_http_info(opts = {})
6583
+ # @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
6584
+ def get_sfvb_comms_twilio_account_with_http_info(opts = {})
5411
6585
  if @api_client.config.debugging
5412
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
6586
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_twilio_account ...'
5413
6587
  end
5414
6588
  # resource path
5415
- local_var_path = '/sfvb/comms/sending_domains'
6589
+ local_var_path = '/sfvb/comms/twilio_account'
5416
6590
 
5417
6591
  # query parameters
5418
6592
  query_params = opts[:query_params] || {}
@@ -5430,13 +6604,13 @@ module UltracartClient
5430
6604
  post_body = opts[:debug_body]
5431
6605
 
5432
6606
  # return_type
5433
- return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
6607
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
5434
6608
 
5435
6609
  # auth_names
5436
6610
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5437
6611
 
5438
6612
  new_options = opts.merge(
5439
- :operation => :"SfvbApi.get_sfvb_comms_sending_domains",
6613
+ :operation => :"SfvbApi.get_sfvb_comms_twilio_account",
5440
6614
  :header_params => header_params,
5441
6615
  :query_params => query_params,
5442
6616
  :form_params => form_params,
@@ -5447,30 +6621,36 @@ module UltracartClient
5447
6621
 
5448
6622
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5449
6623
  if @api_client.config.debugging
5450
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6624
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5451
6625
  end
5452
6626
  return data, status_code, headers
5453
6627
  end
5454
6628
 
5455
- # Read the Twilio account
5456
- # The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
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]
5457
6632
  # @param [Hash] opts the optional parameters
5458
- # @return [SfvbCommsTwilioAccountResponse]
5459
- def get_sfvb_comms_twilio_account(opts = {})
5460
- data, _status_code, _headers = get_sfvb_comms_twilio_account_with_http_info(opts)
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)
5461
6636
  data
5462
6637
  end
5463
6638
 
5464
- # Read the Twilio account
5465
- # The account&#39;s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
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]
5466
6642
  # @param [Hash] opts the optional parameters
5467
- # @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
5468
- def get_sfvb_comms_twilio_account_with_http_info(opts = {})
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 = {})
5469
6645
  if @api_client.config.debugging
5470
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_twilio_account ...'
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"
5471
6651
  end
5472
6652
  # resource path
5473
- local_var_path = '/sfvb/comms/twilio_account'
6653
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/unreferenced'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5474
6654
 
5475
6655
  # query parameters
5476
6656
  query_params = opts[:query_params] || {}
@@ -5488,13 +6668,13 @@ module UltracartClient
5488
6668
  post_body = opts[:debug_body]
5489
6669
 
5490
6670
  # return_type
5491
- return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
6671
+ return_type = opts[:debug_return_type] || 'SfvbCommsUnreferencedResponse'
5492
6672
 
5493
6673
  # auth_names
5494
6674
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5495
6675
 
5496
6676
  new_options = opts.merge(
5497
- :operation => :"SfvbApi.get_sfvb_comms_twilio_account",
6677
+ :operation => :"SfvbApi.get_sfvb_comms_unreferenced",
5498
6678
  :header_params => header_params,
5499
6679
  :query_params => query_params,
5500
6680
  :form_params => form_params,
@@ -5505,7 +6685,7 @@ module UltracartClient
5505
6685
 
5506
6686
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5507
6687
  if @api_client.config.debugging
5508
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6688
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_unreferenced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5509
6689
  end
5510
6690
  return data, status_code, headers
5511
6691
  end
@@ -5733,7 +6913,7 @@ module UltracartClient
5733
6913
  end
5734
6914
 
5735
6915
  # Get a flow or campaign email's subject and preview text
5736
- # 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.
5737
6917
  # @param storefront_oid [Integer]
5738
6918
  # @param email_uuid [String]
5739
6919
  # @param [Hash] opts the optional parameters
@@ -5744,7 +6924,7 @@ module UltracartClient
5744
6924
  end
5745
6925
 
5746
6926
  # Get a flow or campaign email&#39;s subject and preview text
5747
- # 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.
5748
6928
  # @param storefront_oid [Integer]
5749
6929
  # @param email_uuid [String]
5750
6930
  # @param [Hash] opts the optional parameters
@@ -10222,6 +11402,84 @@ module UltracartClient
10222
11402
  return data, status_code, headers
10223
11403
  end
10224
11404
 
11405
+ # Import lists from another email provider
11406
+ # Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
11407
+ # @param storefront_oid [Integer]
11408
+ # @param provider_import_request [SfvbCommsProviderImportRequest] The provider and lists to import
11409
+ # @param [Hash] opts the optional parameters
11410
+ # @option opts [String] :approval_id The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals.
11411
+ # @return [SfvbCommsProviderImportResponse]
11412
+ def import_sfvb_comms_provider_lists(storefront_oid, provider_import_request, opts = {})
11413
+ data, _status_code, _headers = import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
11414
+ data
11415
+ end
11416
+
11417
+ # Import lists from another email provider
11418
+ # Each list becomes a new list of the same name on this storefront and every member is subscribed, in the background; the signed-in user is emailed when it finishes. Needs the account to be allowed to import, sfvb_publish, and an approved comms_list.import request for exactly these lists. At most 20 lists. dry_run checks the provider and the list ids and names what would be created, without importing or using an approval.
11419
+ # @param storefront_oid [Integer]
11420
+ # @param provider_import_request [SfvbCommsProviderImportRequest] The provider and lists to import
11421
+ # @param [Hash] opts the optional parameters
11422
+ # @option opts [String] :approval_id The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals.
11423
+ # @return [Array<(SfvbCommsProviderImportResponse, Integer, Hash)>] SfvbCommsProviderImportResponse data, response status code and response headers
11424
+ def import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts = {})
11425
+ if @api_client.config.debugging
11426
+ @api_client.config.logger.debug 'Calling API: SfvbApi.import_sfvb_comms_provider_lists ...'
11427
+ end
11428
+ # verify the required parameter 'storefront_oid' is set
11429
+ if @api_client.config.client_side_validation && storefront_oid.nil?
11430
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.import_sfvb_comms_provider_lists"
11431
+ end
11432
+ # verify the required parameter 'provider_import_request' is set
11433
+ if @api_client.config.client_side_validation && provider_import_request.nil?
11434
+ fail ArgumentError, "Missing the required parameter 'provider_import_request' when calling SfvbApi.import_sfvb_comms_provider_lists"
11435
+ end
11436
+ # resource path
11437
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/providers/import'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11438
+
11439
+ # query parameters
11440
+ query_params = opts[:query_params] || {}
11441
+
11442
+ # header parameters
11443
+ header_params = opts[:header_params] || {}
11444
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11445
+ # HTTP header 'Accept' (if needed)
11446
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11447
+ # HTTP header 'Content-Type'
11448
+ content_type = @api_client.select_header_content_type(['application/json'])
11449
+ if !content_type.nil?
11450
+ header_params['Content-Type'] = content_type
11451
+ end
11452
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
11453
+
11454
+ # form parameters
11455
+ form_params = opts[:form_params] || {}
11456
+
11457
+ # http body (model)
11458
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(provider_import_request)
11459
+
11460
+ # return_type
11461
+ return_type = opts[:debug_return_type] || 'SfvbCommsProviderImportResponse'
11462
+
11463
+ # auth_names
11464
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11465
+
11466
+ new_options = opts.merge(
11467
+ :operation => :"SfvbApi.import_sfvb_comms_provider_lists",
11468
+ :header_params => header_params,
11469
+ :query_params => query_params,
11470
+ :form_params => form_params,
11471
+ :body => post_body,
11472
+ :auth_names => auth_names,
11473
+ :return_type => return_type
11474
+ )
11475
+
11476
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11477
+ if @api_client.config.debugging
11478
+ @api_client.config.logger.debug "API called: SfvbApi#import_sfvb_comms_provider_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11479
+ end
11480
+ return data, status_code, headers
11481
+ end
11482
+
10225
11483
  # Apply a reviewed redirect import
10226
11484
  # Applies exactly the rows of a dry run, given its plan_hash, in one transaction. Refused with 412 when the rows or the storefront's rules changed since the dry run, and refused when any row has a blocking finding. Always needs sfvb_publish.
10227
11485
  # @param storefront_oid [Integer]
@@ -10452,32 +11710,182 @@ module UltracartClient
10452
11710
  # @param storefront_oid [Integer]
10453
11711
  # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
10454
11712
  # @param [Hash] opts the optional parameters
10455
- # @return [SfvbBlogPostDetail]
10456
- def insert_sfvb_blog_post(storefront_oid, blog_post_request, opts = {})
10457
- data, _status_code, _headers = insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts)
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)
11791
+ data
11792
+ end
11793
+
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
11798
+ # @param [Hash] opts the optional parameters
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 = {})
11801
+ if @api_client.config.debugging
11802
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_campaign_folder ...'
11803
+ end
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"
11811
+ end
11812
+ # resource path
11813
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
11814
+
11815
+ # query parameters
11816
+ query_params = opts[:query_params] || {}
11817
+
11818
+ # header parameters
11819
+ header_params = opts[:header_params] || {}
11820
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11821
+ # HTTP header 'Accept' (if needed)
11822
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11823
+ # HTTP header 'Content-Type'
11824
+ content_type = @api_client.select_header_content_type(['application/json'])
11825
+ if !content_type.nil?
11826
+ header_params['Content-Type'] = content_type
11827
+ end
11828
+
11829
+ # form parameters
11830
+ form_params = opts[:form_params] || {}
11831
+
11832
+ # http body (model)
11833
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
11834
+
11835
+ # return_type
11836
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
11837
+
11838
+ # auth_names
11839
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11840
+
11841
+ new_options = opts.merge(
11842
+ :operation => :"SfvbApi.insert_sfvb_comms_campaign_folder",
11843
+ :header_params => header_params,
11844
+ :query_params => query_params,
11845
+ :form_params => form_params,
11846
+ :body => post_body,
11847
+ :auth_names => auth_names,
11848
+ :return_type => return_type
11849
+ )
11850
+
11851
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11852
+ if @api_client.config.debugging
11853
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11854
+ end
11855
+ return data, status_code, headers
11856
+ end
11857
+
11858
+ # Create a flow folder
11859
+ # A new, empty folder. File a flow in it by setting its folder_uuid.
11860
+ # @param storefront_oid [Integer]
11861
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
11862
+ # @param [Hash] opts the optional parameters
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)
10458
11866
  data
10459
11867
  end
10460
11868
 
10461
- # Create a blog post
10462
- # 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.
10463
11871
  # @param storefront_oid [Integer]
10464
- # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
11872
+ # @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder&#39;s name
10465
11873
  # @param [Hash] opts the optional parameters
10466
- # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
10467
- 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 = {})
10468
11876
  if @api_client.config.debugging
10469
- @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 ...'
10470
11878
  end
10471
11879
  # verify the required parameter 'storefront_oid' is set
10472
11880
  if @api_client.config.client_side_validation && storefront_oid.nil?
10473
- 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"
10474
11882
  end
10475
- # verify the required parameter 'blog_post_request' is set
10476
- if @api_client.config.client_side_validation && blog_post_request.nil?
10477
- 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"
10478
11886
  end
10479
11887
  # resource path
10480
- 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))
10481
11889
 
10482
11890
  # query parameters
10483
11891
  query_params = opts[:query_params] || {}
@@ -10488,7 +11896,7 @@ module UltracartClient
10488
11896
  # HTTP header 'Accept' (if needed)
10489
11897
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10490
11898
  # HTTP header 'Content-Type'
10491
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
11899
+ content_type = @api_client.select_header_content_type(['application/json'])
10492
11900
  if !content_type.nil?
10493
11901
  header_params['Content-Type'] = content_type
10494
11902
  end
@@ -10497,16 +11905,16 @@ module UltracartClient
10497
11905
  form_params = opts[:form_params] || {}
10498
11906
 
10499
11907
  # http body (model)
10500
- 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)
10501
11909
 
10502
11910
  # return_type
10503
- return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
11911
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
10504
11912
 
10505
11913
  # auth_names
10506
11914
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10507
11915
 
10508
11916
  new_options = opts.merge(
10509
- :operation => :"SfvbApi.insert_sfvb_blog_post",
11917
+ :operation => :"SfvbApi.insert_sfvb_comms_flow_folder",
10510
11918
  :header_params => header_params,
10511
11919
  :query_params => query_params,
10512
11920
  :form_params => form_params,
@@ -10517,7 +11925,7 @@ module UltracartClient
10517
11925
 
10518
11926
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10519
11927
  if @api_client.config.debugging
10520
- @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}"
10521
11929
  end
10522
11930
  return data, status_code, headers
10523
11931
  end
@@ -16504,20 +17912,267 @@ module UltracartClient
16504
17912
  if @api_client.config.client_side_validation && storefront_oid.nil?
16505
17913
  fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.set_sfvb_library_screenshot"
16506
17914
  end
16507
- # verify the required parameter 'library_oid' is set
16508
- if @api_client.config.client_side_validation && library_oid.nil?
16509
- fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17915
+ # verify the required parameter 'library_oid' is set
17916
+ if @api_client.config.client_side_validation && library_oid.nil?
17917
+ fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17918
+ end
17919
+ # verify the required parameter 'if_match' is set
17920
+ if @api_client.config.client_side_validation && if_match.nil?
17921
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.set_sfvb_library_screenshot"
17922
+ end
17923
+ # verify the required parameter 'screenshot_request' is set
17924
+ if @api_client.config.client_side_validation && screenshot_request.nil?
17925
+ fail ArgumentError, "Missing the required parameter 'screenshot_request' when calling SfvbApi.set_sfvb_library_screenshot"
17926
+ end
17927
+ # resource path
17928
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'library_oid' + '}', CGI.escape(library_oid.to_s))
17929
+
17930
+ # query parameters
17931
+ query_params = opts[:query_params] || {}
17932
+
17933
+ # header parameters
17934
+ header_params = opts[:header_params] || {}
17935
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17936
+ # HTTP header 'Accept' (if needed)
17937
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17938
+ # HTTP header 'Content-Type'
17939
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17940
+ if !content_type.nil?
17941
+ header_params['Content-Type'] = content_type
17942
+ end
17943
+ header_params[:'If-Match'] = if_match
17944
+
17945
+ # form parameters
17946
+ form_params = opts[:form_params] || {}
17947
+
17948
+ # http body (model)
17949
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(screenshot_request)
17950
+
17951
+ # return_type
17952
+ return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
17953
+
17954
+ # auth_names
17955
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17956
+
17957
+ new_options = opts.merge(
17958
+ :operation => :"SfvbApi.set_sfvb_library_screenshot",
17959
+ :header_params => header_params,
17960
+ :query_params => query_params,
17961
+ :form_params => form_params,
17962
+ :body => post_body,
17963
+ :auth_names => auth_names,
17964
+ :return_type => return_type
17965
+ )
17966
+
17967
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17968
+ if @api_client.config.debugging
17969
+ @api_client.config.logger.debug "API called: SfvbApi#set_sfvb_library_screenshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17970
+ end
17971
+ return data, status_code, headers
17972
+ end
17973
+
17974
+ # Share a published library entry with a linked account
17975
+ # Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
17976
+ # @param storefront_oid [Integer]
17977
+ # @param library_oid [Integer]
17978
+ # @param share_request [SfvbLibraryShareRequest] The linked account
17979
+ # @param [Hash] opts the optional parameters
17980
+ # @return [SfvbLibraryEntry]
17981
+ def share_sfvb_library_entry(storefront_oid, library_oid, share_request, opts = {})
17982
+ data, _status_code, _headers = share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts)
17983
+ data
17984
+ end
17985
+
17986
+ # Share a published library entry with a linked account
17987
+ # Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
17988
+ # @param storefront_oid [Integer]
17989
+ # @param library_oid [Integer]
17990
+ # @param share_request [SfvbLibraryShareRequest] The linked account
17991
+ # @param [Hash] opts the optional parameters
17992
+ # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
17993
+ def share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts = {})
17994
+ if @api_client.config.debugging
17995
+ @api_client.config.logger.debug 'Calling API: SfvbApi.share_sfvb_library_entry ...'
17996
+ end
17997
+ # verify the required parameter 'storefront_oid' is set
17998
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17999
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.share_sfvb_library_entry"
18000
+ end
18001
+ # verify the required parameter 'library_oid' is set
18002
+ if @api_client.config.client_side_validation && library_oid.nil?
18003
+ fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.share_sfvb_library_entry"
18004
+ end
18005
+ # verify the required parameter 'share_request' is set
18006
+ if @api_client.config.client_side_validation && share_request.nil?
18007
+ fail ArgumentError, "Missing the required parameter 'share_request' when calling SfvbApi.share_sfvb_library_entry"
18008
+ end
18009
+ # resource path
18010
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'library_oid' + '}', CGI.escape(library_oid.to_s))
18011
+
18012
+ # query parameters
18013
+ query_params = opts[:query_params] || {}
18014
+
18015
+ # header parameters
18016
+ header_params = opts[:header_params] || {}
18017
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
18018
+ # HTTP header 'Accept' (if needed)
18019
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
18020
+ # HTTP header 'Content-Type'
18021
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18022
+ if !content_type.nil?
18023
+ header_params['Content-Type'] = content_type
18024
+ end
18025
+
18026
+ # form parameters
18027
+ form_params = opts[:form_params] || {}
18028
+
18029
+ # http body (model)
18030
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(share_request)
18031
+
18032
+ # return_type
18033
+ return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
18034
+
18035
+ # auth_names
18036
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
18037
+
18038
+ new_options = opts.merge(
18039
+ :operation => :"SfvbApi.share_sfvb_library_entry",
18040
+ :header_params => header_params,
18041
+ :query_params => query_params,
18042
+ :form_params => form_params,
18043
+ :body => post_body,
18044
+ :auth_names => auth_names,
18045
+ :return_type => return_type
18046
+ )
18047
+
18048
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
18049
+ if @api_client.config.debugging
18050
+ @api_client.config.logger.debug "API called: SfvbApi#share_sfvb_library_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18051
+ end
18052
+ return data, status_code, headers
18053
+ end
18054
+
18055
+ # Start an experiment
18056
+ # type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder's rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts, and the approval of the person who signed in the CLI - an approved experiment.start request for exactly this start (see POST /sfvb/approvals).
18057
+ # @param storefront_oid [Integer]
18058
+ # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
18059
+ # @param [Hash] opts the optional parameters
18060
+ # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
18061
+ # @return [SfvbExperiment]
18062
+ def start_sfvb_experiment(storefront_oid, experiment_start_request, opts = {})
18063
+ data, _status_code, _headers = start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
18064
+ data
18065
+ end
18066
+
18067
+ # Start an experiment
18068
+ # type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder&#39;s rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts, and the approval of the person who signed in the CLI - an approved experiment.start request for exactly this start (see POST /sfvb/approvals).
18069
+ # @param storefront_oid [Integer]
18070
+ # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
18071
+ # @param [Hash] opts the optional parameters
18072
+ # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
18073
+ # @return [Array<(SfvbExperiment, Integer, Hash)>] SfvbExperiment data, response status code and response headers
18074
+ def start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts = {})
18075
+ if @api_client.config.debugging
18076
+ @api_client.config.logger.debug 'Calling API: SfvbApi.start_sfvb_experiment ...'
18077
+ end
18078
+ # verify the required parameter 'storefront_oid' is set
18079
+ if @api_client.config.client_side_validation && storefront_oid.nil?
18080
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.start_sfvb_experiment"
18081
+ end
18082
+ # verify the required parameter 'experiment_start_request' is set
18083
+ if @api_client.config.client_side_validation && experiment_start_request.nil?
18084
+ fail ArgumentError, "Missing the required parameter 'experiment_start_request' when calling SfvbApi.start_sfvb_experiment"
18085
+ end
18086
+ # resource path
18087
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/experiments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
18088
+
18089
+ # query parameters
18090
+ query_params = opts[:query_params] || {}
18091
+
18092
+ # header parameters
18093
+ header_params = opts[:header_params] || {}
18094
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
18095
+ # HTTP header 'Accept' (if needed)
18096
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
18097
+ # HTTP header 'Content-Type'
18098
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18099
+ if !content_type.nil?
18100
+ header_params['Content-Type'] = content_type
18101
+ end
18102
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
18103
+
18104
+ # form parameters
18105
+ form_params = opts[:form_params] || {}
18106
+
18107
+ # http body (model)
18108
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(experiment_start_request)
18109
+
18110
+ # return_type
18111
+ return_type = opts[:debug_return_type] || 'SfvbExperiment'
18112
+
18113
+ # auth_names
18114
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
18115
+
18116
+ new_options = opts.merge(
18117
+ :operation => :"SfvbApi.start_sfvb_experiment",
18118
+ :header_params => header_params,
18119
+ :query_params => query_params,
18120
+ :form_params => form_params,
18121
+ :body => post_body,
18122
+ :auth_names => auth_names,
18123
+ :return_type => return_type
18124
+ )
18125
+
18126
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
18127
+ if @api_client.config.debugging
18128
+ @api_client.config.logger.debug "API called: SfvbApi#start_sfvb_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18129
+ end
18130
+ return data, status_code, headers
18131
+ end
18132
+
18133
+ # Send one test of an email step's email to a user on this account
18134
+ # to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan's email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
18135
+ # @param storefront_oid [Integer]
18136
+ # @param commseq_uuid [String]
18137
+ # @param step_uuid [String]
18138
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
18139
+ # @param [Hash] opts the optional parameters
18140
+ # @return [SfvbCommsTestSendResponse]
18141
+ def test_sfvb_comms_email(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts = {})
18142
+ data, _status_code, _headers = test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts)
18143
+ data
18144
+ end
18145
+
18146
+ # Send one test of an email step&#39;s email to a user on this account
18147
+ # to_email must be the email address of a user on this account; a test is never sent to customers or anyone else. It reaches a real inbox and counts against the plan&#39;s email quota. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 10 an hour and 50 a day. The email render shows the same email without sending it.
18148
+ # @param storefront_oid [Integer]
18149
+ # @param commseq_uuid [String]
18150
+ # @param step_uuid [String]
18151
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
18152
+ # @param [Hash] opts the optional parameters
18153
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
18154
+ def test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts = {})
18155
+ if @api_client.config.debugging
18156
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_email ...'
18157
+ end
18158
+ # verify the required parameter 'storefront_oid' is set
18159
+ if @api_client.config.client_side_validation && storefront_oid.nil?
18160
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_email"
18161
+ end
18162
+ # verify the required parameter 'commseq_uuid' is set
18163
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
18164
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_email"
16510
18165
  end
16511
- # verify the required parameter 'if_match' is set
16512
- if @api_client.config.client_side_validation && if_match.nil?
16513
- fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.set_sfvb_library_screenshot"
18166
+ # verify the required parameter 'step_uuid' is set
18167
+ if @api_client.config.client_side_validation && step_uuid.nil?
18168
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_email"
16514
18169
  end
16515
- # verify the required parameter 'screenshot_request' is set
16516
- if @api_client.config.client_side_validation && screenshot_request.nil?
16517
- fail ArgumentError, "Missing the required parameter 'screenshot_request' when calling SfvbApi.set_sfvb_library_screenshot"
18170
+ # verify the required parameter 'test_email_request' is set
18171
+ if @api_client.config.client_side_validation && test_email_request.nil?
18172
+ fail ArgumentError, "Missing the required parameter 'test_email_request' when calling SfvbApi.test_sfvb_comms_email"
16518
18173
  end
16519
18174
  # resource path
16520
- local_var_path = '/sfvb/storefronts/{storefront_oid}/library/{library_oid}/screenshot'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'library_oid' + '}', CGI.escape(library_oid.to_s))
18175
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_email'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
16521
18176
 
16522
18177
  # query parameters
16523
18178
  query_params = opts[:query_params] || {}
@@ -16528,26 +18183,25 @@ module UltracartClient
16528
18183
  # HTTP header 'Accept' (if needed)
16529
18184
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16530
18185
  # HTTP header 'Content-Type'
16531
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18186
+ content_type = @api_client.select_header_content_type(['application/json'])
16532
18187
  if !content_type.nil?
16533
18188
  header_params['Content-Type'] = content_type
16534
18189
  end
16535
- header_params[:'If-Match'] = if_match
16536
18190
 
16537
18191
  # form parameters
16538
18192
  form_params = opts[:form_params] || {}
16539
18193
 
16540
18194
  # http body (model)
16541
- post_body = opts[:debug_body] || @api_client.object_to_http_body(screenshot_request)
18195
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_email_request)
16542
18196
 
16543
18197
  # return_type
16544
- return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
18198
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16545
18199
 
16546
18200
  # auth_names
16547
18201
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16548
18202
 
16549
18203
  new_options = opts.merge(
16550
- :operation => :"SfvbApi.set_sfvb_library_screenshot",
18204
+ :operation => :"SfvbApi.test_sfvb_comms_email",
16551
18205
  :header_params => header_params,
16552
18206
  :query_params => query_params,
16553
18207
  :form_params => form_params,
@@ -16556,50 +18210,58 @@ module UltracartClient
16556
18210
  :return_type => return_type
16557
18211
  )
16558
18212
 
16559
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
18213
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16560
18214
  if @api_client.config.debugging
16561
- @api_client.config.logger.debug "API called: SfvbApi#set_sfvb_library_screenshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18215
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16562
18216
  end
16563
18217
  return data, status_code, headers
16564
18218
  end
16565
18219
 
16566
- # Share a published library entry with a linked account
16567
- # Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
18220
+ # Print and mail one real test postcard
18221
+ # It is printed and mailed at the account's cost and can't be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
16568
18222
  # @param storefront_oid [Integer]
16569
- # @param library_oid [Integer]
16570
- # @param share_request [SfvbLibraryShareRequest] The linked account
18223
+ # @param commseq_uuid [String]
18224
+ # @param step_uuid [String]
18225
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
16571
18226
  # @param [Hash] opts the optional parameters
16572
- # @return [SfvbLibraryEntry]
16573
- def share_sfvb_library_entry(storefront_oid, library_oid, share_request, opts = {})
16574
- data, _status_code, _headers = share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts)
18227
+ # @option opts [String] :approval_id The approval_id of an approved postcard.test_mail request for exactly this card and address. See POST /sfvb/approvals.
18228
+ # @return [SfvbCommsTestSendResponse]
18229
+ def test_sfvb_comms_postcard(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts = {})
18230
+ data, _status_code, _headers = test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
16575
18231
  data
16576
18232
  end
16577
18233
 
16578
- # Share a published library entry with a linked account
16579
- # Owner only, and always needs sfvb_publish. The merchant must be one share_targets lists, and the entry must have a published revision, which is what the recipient sees. The published revision is checked again for absolute asset URLs and credentials. Idempotent.
18234
+ # Print and mail one real test postcard
18235
+ # It is printed and mailed at the account&#39;s cost and can&#39;t be recalled. mail_card must be true; the postcard proof shows the card without mailing it. Postcards must be turned on for the account by UltraCart. Needs sfvb_publish, the sign-in of a person, and an approved postcard.test_mail request for exactly this card and address, with a fresh code every time. dry_run checks everything and shows the cost. Rate limited per merchant to 3 an hour and 10 a day. The answer says whether a card was mailed.
16580
18236
  # @param storefront_oid [Integer]
16581
- # @param library_oid [Integer]
16582
- # @param share_request [SfvbLibraryShareRequest] The linked account
18237
+ # @param commseq_uuid [String]
18238
+ # @param step_uuid [String]
18239
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
16583
18240
  # @param [Hash] opts the optional parameters
16584
- # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
16585
- def share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts = {})
18241
+ # @option opts [String] :approval_id The approval_id of an approved postcard.test_mail request for exactly this card and address. See POST /sfvb/approvals.
18242
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
18243
+ def test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts = {})
16586
18244
  if @api_client.config.debugging
16587
- @api_client.config.logger.debug 'Calling API: SfvbApi.share_sfvb_library_entry ...'
18245
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_postcard ...'
16588
18246
  end
16589
18247
  # verify the required parameter 'storefront_oid' is set
16590
18248
  if @api_client.config.client_side_validation && storefront_oid.nil?
16591
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.share_sfvb_library_entry"
18249
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_postcard"
16592
18250
  end
16593
- # verify the required parameter 'library_oid' is set
16594
- if @api_client.config.client_side_validation && library_oid.nil?
16595
- fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.share_sfvb_library_entry"
18251
+ # verify the required parameter 'commseq_uuid' is set
18252
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
18253
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_postcard"
16596
18254
  end
16597
- # verify the required parameter 'share_request' is set
16598
- if @api_client.config.client_side_validation && share_request.nil?
16599
- fail ArgumentError, "Missing the required parameter 'share_request' when calling SfvbApi.share_sfvb_library_entry"
18255
+ # verify the required parameter 'step_uuid' is set
18256
+ if @api_client.config.client_side_validation && step_uuid.nil?
18257
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_postcard"
18258
+ end
18259
+ # verify the required parameter 'test_postcard_request' is set
18260
+ if @api_client.config.client_side_validation && test_postcard_request.nil?
18261
+ fail ArgumentError, "Missing the required parameter 'test_postcard_request' when calling SfvbApi.test_sfvb_comms_postcard"
16600
18262
  end
16601
18263
  # resource path
16602
- local_var_path = '/sfvb/storefronts/{storefront_oid}/library/{library_oid}/shares'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'library_oid' + '}', CGI.escape(library_oid.to_s))
18264
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_postcard'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
16603
18265
 
16604
18266
  # query parameters
16605
18267
  query_params = opts[:query_params] || {}
@@ -16610,25 +18272,26 @@ module UltracartClient
16610
18272
  # HTTP header 'Accept' (if needed)
16611
18273
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16612
18274
  # HTTP header 'Content-Type'
16613
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18275
+ content_type = @api_client.select_header_content_type(['application/json'])
16614
18276
  if !content_type.nil?
16615
18277
  header_params['Content-Type'] = content_type
16616
18278
  end
18279
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16617
18280
 
16618
18281
  # form parameters
16619
18282
  form_params = opts[:form_params] || {}
16620
18283
 
16621
18284
  # http body (model)
16622
- post_body = opts[:debug_body] || @api_client.object_to_http_body(share_request)
18285
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_postcard_request)
16623
18286
 
16624
18287
  # return_type
16625
- return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
18288
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16626
18289
 
16627
18290
  # auth_names
16628
18291
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16629
18292
 
16630
18293
  new_options = opts.merge(
16631
- :operation => :"SfvbApi.share_sfvb_library_entry",
18294
+ :operation => :"SfvbApi.test_sfvb_comms_postcard",
16632
18295
  :header_params => header_params,
16633
18296
  :query_params => query_params,
16634
18297
  :form_params => form_params,
@@ -16639,44 +18302,54 @@ module UltracartClient
16639
18302
 
16640
18303
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16641
18304
  if @api_client.config.debugging
16642
- @api_client.config.logger.debug "API called: SfvbApi#share_sfvb_library_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18305
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16643
18306
  end
16644
18307
  return data, status_code, headers
16645
18308
  end
16646
18309
 
16647
- # Start an experiment
16648
- # type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder's rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts, and the approval of the person who signed in the CLI - an approved experiment.start request for exactly this start (see POST /sfvb/approvals).
18310
+ # Send one test of an SMS step to a user on this account
18311
+ # to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account's Twilio account, from the flow's or campaign's SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
16649
18312
  # @param storefront_oid [Integer]
16650
- # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
18313
+ # @param commseq_uuid [String]
18314
+ # @param step_uuid [String]
18315
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
16651
18316
  # @param [Hash] opts the optional parameters
16652
- # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
16653
- # @return [SfvbExperiment]
16654
- def start_sfvb_experiment(storefront_oid, experiment_start_request, opts = {})
16655
- data, _status_code, _headers = start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
18317
+ # @return [SfvbCommsTestSendResponse]
18318
+ def test_sfvb_comms_sms(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts = {})
18319
+ data, _status_code, _headers = test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts)
16656
18320
  data
16657
18321
  end
16658
18322
 
16659
- # Start an experiment
16660
- # type page starts an experiment element already saved in a page body - send path, slot and widget_id, and its name, objective, duration and variations are read from the element with the builder&#39;s rules (2 to 5 variations numbered 0 up with no gaps, 3 to 90 days, traffic on all or none adding up to 100). The new id is written into the element and the body is saved, so pull it again before the next edit. type url splits visitors between existing pages at router_url, and always ends by itself after duration_days. Always needs sfvb_publish, because visitors are split as soon as it starts, and the approval of the person who signed in the CLI - an approved experiment.start request for exactly this start (see POST /sfvb/approvals).
18323
+ # Send one test of an SMS step to a user on this account
18324
+ # to_phone must be the cell phone of a user on this account, in E.164 form. It is billed per segment through the account&#39;s Twilio account, from the flow&#39;s or campaign&#39;s SMS number; with none it is refused. Needs sfvb_publish and the sign-in of a person. Rate limited per merchant to 5 an hour and 20 a day.
16661
18325
  # @param storefront_oid [Integer]
16662
- # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
18326
+ # @param commseq_uuid [String]
18327
+ # @param step_uuid [String]
18328
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
16663
18329
  # @param [Hash] opts the optional parameters
16664
- # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
16665
- # @return [Array<(SfvbExperiment, Integer, Hash)>] SfvbExperiment data, response status code and response headers
16666
- def start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts = {})
18330
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
18331
+ def test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts = {})
16667
18332
  if @api_client.config.debugging
16668
- @api_client.config.logger.debug 'Calling API: SfvbApi.start_sfvb_experiment ...'
18333
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_sms ...'
16669
18334
  end
16670
18335
  # verify the required parameter 'storefront_oid' is set
16671
18336
  if @api_client.config.client_side_validation && storefront_oid.nil?
16672
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.start_sfvb_experiment"
18337
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_sms"
16673
18338
  end
16674
- # verify the required parameter 'experiment_start_request' is set
16675
- if @api_client.config.client_side_validation && experiment_start_request.nil?
16676
- fail ArgumentError, "Missing the required parameter 'experiment_start_request' when calling SfvbApi.start_sfvb_experiment"
18339
+ # verify the required parameter 'commseq_uuid' is set
18340
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
18341
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_sms"
18342
+ end
18343
+ # verify the required parameter 'step_uuid' is set
18344
+ if @api_client.config.client_side_validation && step_uuid.nil?
18345
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_sms"
18346
+ end
18347
+ # verify the required parameter 'test_sms_request' is set
18348
+ if @api_client.config.client_side_validation && test_sms_request.nil?
18349
+ fail ArgumentError, "Missing the required parameter 'test_sms_request' when calling SfvbApi.test_sfvb_comms_sms"
16677
18350
  end
16678
18351
  # resource path
16679
- local_var_path = '/sfvb/storefronts/{storefront_oid}/experiments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
18352
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/steps/{step_uuid}/test_sms'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
16680
18353
 
16681
18354
  # query parameters
16682
18355
  query_params = opts[:query_params] || {}
@@ -16687,26 +18360,25 @@ module UltracartClient
16687
18360
  # HTTP header 'Accept' (if needed)
16688
18361
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16689
18362
  # HTTP header 'Content-Type'
16690
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18363
+ content_type = @api_client.select_header_content_type(['application/json'])
16691
18364
  if !content_type.nil?
16692
18365
  header_params['Content-Type'] = content_type
16693
18366
  end
16694
- header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16695
18367
 
16696
18368
  # form parameters
16697
18369
  form_params = opts[:form_params] || {}
16698
18370
 
16699
18371
  # http body (model)
16700
- post_body = opts[:debug_body] || @api_client.object_to_http_body(experiment_start_request)
18372
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_sms_request)
16701
18373
 
16702
18374
  # return_type
16703
- return_type = opts[:debug_return_type] || 'SfvbExperiment'
18375
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16704
18376
 
16705
18377
  # auth_names
16706
18378
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16707
18379
 
16708
18380
  new_options = opts.merge(
16709
- :operation => :"SfvbApi.start_sfvb_experiment",
18381
+ :operation => :"SfvbApi.test_sfvb_comms_sms",
16710
18382
  :header_params => header_params,
16711
18383
  :query_params => query_params,
16712
18384
  :form_params => form_params,
@@ -16717,7 +18389,7 @@ module UltracartClient
16717
18389
 
16718
18390
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16719
18391
  if @api_client.config.debugging
16720
- @api_client.config.logger.debug "API called: SfvbApi#start_sfvb_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18392
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16721
18393
  end
16722
18394
  return data, status_code, headers
16723
18395
  end
@@ -17096,44 +18768,214 @@ module UltracartClient
17096
18768
  # @param if_match [String] The network&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale.
17097
18769
  # @param affiliate_network_request [SfvbAffiliateNetworkRequest] The change
17098
18770
  # @param [Hash] opts the optional parameters
17099
- # @option opts [String] :approval_id When the change sets a conversion pixel the network will use, the approval_id of an approved affiliate_network.change request for exactly this change. See POST /sfvb/approvals.
17100
- # @return [SfvbAffiliateNetwork]
17101
- def update_sfvb_affiliate_network(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts = {})
17102
- data, _status_code, _headers = update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts)
18771
+ # @option opts [String] :approval_id When the change sets a conversion pixel the network will use, the approval_id of an approved affiliate_network.change request for exactly this change. See POST /sfvb/approvals.
18772
+ # @return [SfvbAffiliateNetwork]
18773
+ def update_sfvb_affiliate_network(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts = {})
18774
+ data, _status_code, _headers = update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts)
18775
+ data
18776
+ end
18777
+
18778
+ # Change an affiliate network
18779
+ # A partial update: only the fields sent change. Send the network&#39;s hash_sha256 as If-Match. Needs sfvb_publish. Changing the conversion_pixel, or the conversion_type, of a network whose pixel will be used needs an approved affiliate_network.change request for exactly this change (Approval-Id), which UltraCart reviews first. Other fields, and emptying the pixel, need none. dry_run says whether it needs one, without saving.
18780
+ # @param storefront_oid [Integer]
18781
+ # @param affiliate_network_oid [Integer]
18782
+ # @param if_match [String] The network&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale.
18783
+ # @param affiliate_network_request [SfvbAffiliateNetworkRequest] The change
18784
+ # @param [Hash] opts the optional parameters
18785
+ # @option opts [String] :approval_id When the change sets a conversion pixel the network will use, the approval_id of an approved affiliate_network.change request for exactly this change. See POST /sfvb/approvals.
18786
+ # @return [Array<(SfvbAffiliateNetwork, Integer, Hash)>] SfvbAffiliateNetwork data, response status code and response headers
18787
+ def update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts = {})
18788
+ if @api_client.config.debugging
18789
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_affiliate_network ...'
18790
+ end
18791
+ # verify the required parameter 'storefront_oid' is set
18792
+ if @api_client.config.client_side_validation && storefront_oid.nil?
18793
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_affiliate_network"
18794
+ end
18795
+ # verify the required parameter 'affiliate_network_oid' is set
18796
+ if @api_client.config.client_side_validation && affiliate_network_oid.nil?
18797
+ fail ArgumentError, "Missing the required parameter 'affiliate_network_oid' when calling SfvbApi.update_sfvb_affiliate_network"
18798
+ end
18799
+ # verify the required parameter 'if_match' is set
18800
+ if @api_client.config.client_side_validation && if_match.nil?
18801
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_affiliate_network"
18802
+ end
18803
+ # verify the required parameter 'affiliate_network_request' is set
18804
+ if @api_client.config.client_side_validation && affiliate_network_request.nil?
18805
+ fail ArgumentError, "Missing the required parameter 'affiliate_network_request' when calling SfvbApi.update_sfvb_affiliate_network"
18806
+ end
18807
+ # resource path
18808
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'affiliate_network_oid' + '}', CGI.escape(affiliate_network_oid.to_s))
18809
+
18810
+ # query parameters
18811
+ query_params = opts[:query_params] || {}
18812
+
18813
+ # header parameters
18814
+ header_params = opts[:header_params] || {}
18815
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
18816
+ # HTTP header 'Accept' (if needed)
18817
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
18818
+ # HTTP header 'Content-Type'
18819
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18820
+ if !content_type.nil?
18821
+ header_params['Content-Type'] = content_type
18822
+ end
18823
+ header_params[:'If-Match'] = if_match
18824
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
18825
+
18826
+ # form parameters
18827
+ form_params = opts[:form_params] || {}
18828
+
18829
+ # http body (model)
18830
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate_network_request)
18831
+
18832
+ # return_type
18833
+ return_type = opts[:debug_return_type] || 'SfvbAffiliateNetwork'
18834
+
18835
+ # auth_names
18836
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
18837
+
18838
+ new_options = opts.merge(
18839
+ :operation => :"SfvbApi.update_sfvb_affiliate_network",
18840
+ :header_params => header_params,
18841
+ :query_params => query_params,
18842
+ :form_params => form_params,
18843
+ :body => post_body,
18844
+ :auth_names => auth_names,
18845
+ :return_type => return_type
18846
+ )
18847
+
18848
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
18849
+ if @api_client.config.debugging
18850
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_affiliate_network\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18851
+ end
18852
+ return data, status_code, headers
18853
+ end
18854
+
18855
+ # Change a blog post
18856
+ # Only the fields sent change; tags, when sent, replaces every tag. The post's images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
18857
+ # @param storefront_oid [Integer]
18858
+ # @param blog_post_oid [Integer]
18859
+ # @param blog_post_request [SfvbBlogPostRequest] The fields to change
18860
+ # @param [Hash] opts the optional parameters
18861
+ # @return [SfvbBlogPostDetail]
18862
+ def update_sfvb_blog_post(storefront_oid, blog_post_oid, blog_post_request, opts = {})
18863
+ data, _status_code, _headers = update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request, opts)
18864
+ data
18865
+ end
18866
+
18867
+ # Change a blog post
18868
+ # Only the fields sent change; tags, when sent, replaces every tag. The post&#39;s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
18869
+ # @param storefront_oid [Integer]
18870
+ # @param blog_post_oid [Integer]
18871
+ # @param blog_post_request [SfvbBlogPostRequest] The fields to change
18872
+ # @param [Hash] opts the optional parameters
18873
+ # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
18874
+ def update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request, opts = {})
18875
+ if @api_client.config.debugging
18876
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_blog_post ...'
18877
+ end
18878
+ # verify the required parameter 'storefront_oid' is set
18879
+ if @api_client.config.client_side_validation && storefront_oid.nil?
18880
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_blog_post"
18881
+ end
18882
+ # verify the required parameter 'blog_post_oid' is set
18883
+ if @api_client.config.client_side_validation && blog_post_oid.nil?
18884
+ fail ArgumentError, "Missing the required parameter 'blog_post_oid' when calling SfvbApi.update_sfvb_blog_post"
18885
+ end
18886
+ # verify the required parameter 'blog_post_request' is set
18887
+ if @api_client.config.client_side_validation && blog_post_request.nil?
18888
+ fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.update_sfvb_blog_post"
18889
+ end
18890
+ # resource path
18891
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'blog_post_oid' + '}', CGI.escape(blog_post_oid.to_s))
18892
+
18893
+ # query parameters
18894
+ query_params = opts[:query_params] || {}
18895
+
18896
+ # header parameters
18897
+ header_params = opts[:header_params] || {}
18898
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
18899
+ # HTTP header 'Accept' (if needed)
18900
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
18901
+ # HTTP header 'Content-Type'
18902
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18903
+ if !content_type.nil?
18904
+ header_params['Content-Type'] = content_type
18905
+ end
18906
+
18907
+ # form parameters
18908
+ form_params = opts[:form_params] || {}
18909
+
18910
+ # http body (model)
18911
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
18912
+
18913
+ # return_type
18914
+ return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
18915
+
18916
+ # auth_names
18917
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
18918
+
18919
+ new_options = opts.merge(
18920
+ :operation => :"SfvbApi.update_sfvb_blog_post",
18921
+ :header_params => header_params,
18922
+ :query_params => query_params,
18923
+ :form_params => form_params,
18924
+ :body => post_body,
18925
+ :auth_names => auth_names,
18926
+ :return_type => return_type
18927
+ )
18928
+
18929
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
18930
+ if @api_client.config.debugging
18931
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18932
+ end
18933
+ return data, status_code, headers
18934
+ end
18935
+
18936
+ # Change a campaign
18937
+ # 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.
18938
+ # @param storefront_oid [Integer]
18939
+ # @param campaign_uuid [String]
18940
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
18941
+ # @param campaign_write_request [SfvbCampaignWriteRequest] The fields to change
18942
+ # @param [Hash] opts the optional parameters
18943
+ # @return [SfvbCampaign]
18944
+ def update_sfvb_campaign(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts = {})
18945
+ data, _status_code, _headers = update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts)
17103
18946
  data
17104
18947
  end
17105
18948
 
17106
- # Change an affiliate network
17107
- # A partial update: only the fields sent change. Send the network&#39;s hash_sha256 as If-Match. Needs sfvb_publish. Changing the conversion_pixel, or the conversion_type, of a network whose pixel will be used needs an approved affiliate_network.change request for exactly this change (Approval-Id), which UltraCart reviews first. Other fields, and emptying the pixel, need none. dry_run says whether it needs one, without saving.
18949
+ # Change a campaign
18950
+ # 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.
17108
18951
  # @param storefront_oid [Integer]
17109
- # @param affiliate_network_oid [Integer]
17110
- # @param if_match [String] The network&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale.
17111
- # @param affiliate_network_request [SfvbAffiliateNetworkRequest] The change
18952
+ # @param campaign_uuid [String]
18953
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
18954
+ # @param campaign_write_request [SfvbCampaignWriteRequest] The fields to change
17112
18955
  # @param [Hash] opts the optional parameters
17113
- # @option opts [String] :approval_id When the change sets a conversion pixel the network will use, the approval_id of an approved affiliate_network.change request for exactly this change. See POST /sfvb/approvals.
17114
- # @return [Array<(SfvbAffiliateNetwork, Integer, Hash)>] SfvbAffiliateNetwork data, response status code and response headers
17115
- def update_sfvb_affiliate_network_with_http_info(storefront_oid, affiliate_network_oid, if_match, affiliate_network_request, opts = {})
18956
+ # @return [Array<(SfvbCampaign, Integer, Hash)>] SfvbCampaign data, response status code and response headers
18957
+ def update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts = {})
17116
18958
  if @api_client.config.debugging
17117
- @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_affiliate_network ...'
18959
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_campaign ...'
17118
18960
  end
17119
18961
  # verify the required parameter 'storefront_oid' is set
17120
18962
  if @api_client.config.client_side_validation && storefront_oid.nil?
17121
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_affiliate_network"
18963
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_campaign"
17122
18964
  end
17123
- # verify the required parameter 'affiliate_network_oid' is set
17124
- if @api_client.config.client_side_validation && affiliate_network_oid.nil?
17125
- fail ArgumentError, "Missing the required parameter 'affiliate_network_oid' when calling SfvbApi.update_sfvb_affiliate_network"
18965
+ # verify the required parameter 'campaign_uuid' is set
18966
+ if @api_client.config.client_side_validation && campaign_uuid.nil?
18967
+ fail ArgumentError, "Missing the required parameter 'campaign_uuid' when calling SfvbApi.update_sfvb_campaign"
17126
18968
  end
17127
18969
  # verify the required parameter 'if_match' is set
17128
18970
  if @api_client.config.client_side_validation && if_match.nil?
17129
- fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_affiliate_network"
18971
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_campaign"
17130
18972
  end
17131
- # verify the required parameter 'affiliate_network_request' is set
17132
- if @api_client.config.client_side_validation && affiliate_network_request.nil?
17133
- fail ArgumentError, "Missing the required parameter 'affiliate_network_request' when calling SfvbApi.update_sfvb_affiliate_network"
18973
+ # verify the required parameter 'campaign_write_request' is set
18974
+ if @api_client.config.client_side_validation && campaign_write_request.nil?
18975
+ fail ArgumentError, "Missing the required parameter 'campaign_write_request' when calling SfvbApi.update_sfvb_campaign"
17134
18976
  end
17135
18977
  # resource path
17136
- local_var_path = '/sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks/{affiliate_network_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'affiliate_network_oid' + '}', CGI.escape(affiliate_network_oid.to_s))
18978
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'campaign_uuid' + '}', CGI.escape(campaign_uuid.to_s))
17137
18979
 
17138
18980
  # query parameters
17139
18981
  query_params = opts[:query_params] || {}
@@ -17144,27 +18986,26 @@ module UltracartClient
17144
18986
  # HTTP header 'Accept' (if needed)
17145
18987
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17146
18988
  # HTTP header 'Content-Type'
17147
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
18989
+ content_type = @api_client.select_header_content_type(['application/json'])
17148
18990
  if !content_type.nil?
17149
18991
  header_params['Content-Type'] = content_type
17150
18992
  end
17151
18993
  header_params[:'If-Match'] = if_match
17152
- header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
17153
18994
 
17154
18995
  # form parameters
17155
18996
  form_params = opts[:form_params] || {}
17156
18997
 
17157
18998
  # http body (model)
17158
- post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate_network_request)
18999
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_write_request)
17159
19000
 
17160
19001
  # return_type
17161
- return_type = opts[:debug_return_type] || 'SfvbAffiliateNetwork'
19002
+ return_type = opts[:debug_return_type] || 'SfvbCampaign'
17162
19003
 
17163
19004
  # auth_names
17164
19005
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17165
19006
 
17166
19007
  new_options = opts.merge(
17167
- :operation => :"SfvbApi.update_sfvb_affiliate_network",
19008
+ :operation => :"SfvbApi.update_sfvb_campaign",
17168
19009
  :header_params => header_params,
17169
19010
  :query_params => query_params,
17170
19011
  :form_params => form_params,
@@ -17175,48 +19016,54 @@ module UltracartClient
17175
19016
 
17176
19017
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17177
19018
  if @api_client.config.debugging
17178
- @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_affiliate_network\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19019
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17179
19020
  end
17180
19021
  return data, status_code, headers
17181
19022
  end
17182
19023
 
17183
- # Change a blog post
17184
- # Only the fields sent change; tags, when sent, replaces every tag. The post's images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
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.
17185
19026
  # @param storefront_oid [Integer]
17186
- # @param blog_post_oid [Integer]
17187
- # @param blog_post_request [SfvbBlogPostRequest] The fields to change
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
17188
19030
  # @param [Hash] opts the optional parameters
17189
- # @return [SfvbBlogPostDetail]
17190
- def update_sfvb_blog_post(storefront_oid, blog_post_oid, blog_post_request, opts = {})
17191
- data, _status_code, _headers = update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request, opts)
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)
17192
19034
  data
17193
19035
  end
17194
19036
 
17195
- # Change a blog post
17196
- # Only the fields sent change; tags, when sent, replaces every tag. The post&#39;s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
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.
17197
19039
  # @param storefront_oid [Integer]
17198
- # @param blog_post_oid [Integer]
17199
- # @param blog_post_request [SfvbBlogPostRequest] The fields to change
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
17200
19043
  # @param [Hash] opts the optional parameters
17201
- # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
17202
- def update_sfvb_blog_post_with_http_info(storefront_oid, blog_post_oid, blog_post_request, opts = {})
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 = {})
17203
19046
  if @api_client.config.debugging
17204
- @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_blog_post ...'
19047
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_campaign_folder ...'
17205
19048
  end
17206
19049
  # verify the required parameter 'storefront_oid' is set
17207
19050
  if @api_client.config.client_side_validation && storefront_oid.nil?
17208
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_blog_post"
19051
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_campaign_folder"
17209
19052
  end
17210
- # verify the required parameter 'blog_post_oid' is set
17211
- if @api_client.config.client_side_validation && blog_post_oid.nil?
17212
- fail ArgumentError, "Missing the required parameter 'blog_post_oid' when calling SfvbApi.update_sfvb_blog_post"
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"
17213
19056
  end
17214
- # verify the required parameter 'blog_post_request' is set
17215
- if @api_client.config.client_side_validation && blog_post_request.nil?
17216
- fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.update_sfvb_blog_post"
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"
17217
19064
  end
17218
19065
  # resource path
17219
- local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts/{blog_post_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'blog_post_oid' + '}', CGI.escape(blog_post_oid.to_s))
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))
17220
19067
 
17221
19068
  # query parameters
17222
19069
  query_params = opts[:query_params] || {}
@@ -17227,25 +19074,26 @@ module UltracartClient
17227
19074
  # HTTP header 'Accept' (if needed)
17228
19075
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17229
19076
  # HTTP header 'Content-Type'
17230
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
19077
+ content_type = @api_client.select_header_content_type(['application/json'])
17231
19078
  if !content_type.nil?
17232
19079
  header_params['Content-Type'] = content_type
17233
19080
  end
19081
+ header_params[:'If-Match'] = if_match
17234
19082
 
17235
19083
  # form parameters
17236
19084
  form_params = opts[:form_params] || {}
17237
19085
 
17238
19086
  # http body (model)
17239
- post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
19087
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
17240
19088
 
17241
19089
  # return_type
17242
- return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
19090
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
17243
19091
 
17244
19092
  # auth_names
17245
19093
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17246
19094
 
17247
19095
  new_options = opts.merge(
17248
- :operation => :"SfvbApi.update_sfvb_blog_post",
19096
+ :operation => :"SfvbApi.update_sfvb_comms_campaign_folder",
17249
19097
  :header_params => header_params,
17250
19098
  :query_params => query_params,
17251
19099
  :form_params => form_params,
@@ -17256,54 +19104,54 @@ module UltracartClient
17256
19104
 
17257
19105
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17258
19106
  if @api_client.config.debugging
17259
- @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19107
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17260
19108
  end
17261
19109
  return data, status_code, headers
17262
19110
  end
17263
19111
 
17264
- # Change a campaign
17265
- # 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.
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.
17266
19114
  # @param storefront_oid [Integer]
17267
- # @param campaign_uuid [String]
17268
- # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
17269
- # @param campaign_write_request [SfvbCampaignWriteRequest] The fields to change
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
17270
19118
  # @param [Hash] opts the optional parameters
17271
- # @return [SfvbCampaign]
17272
- def update_sfvb_campaign(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts = {})
17273
- data, _status_code, _headers = update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts)
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)
17274
19122
  data
17275
19123
  end
17276
19124
 
17277
- # Change a campaign
17278
- # 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.
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.
17279
19127
  # @param storefront_oid [Integer]
17280
- # @param campaign_uuid [String]
17281
- # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
17282
- # @param campaign_write_request [SfvbCampaignWriteRequest] The fields to change
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
17283
19131
  # @param [Hash] opts the optional parameters
17284
- # @return [Array<(SfvbCampaign, Integer, Hash)>] SfvbCampaign data, response status code and response headers
17285
- def update_sfvb_campaign_with_http_info(storefront_oid, campaign_uuid, if_match, campaign_write_request, opts = {})
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 = {})
17286
19134
  if @api_client.config.debugging
17287
- @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_campaign ...'
19135
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_flow_folder ...'
17288
19136
  end
17289
19137
  # verify the required parameter 'storefront_oid' is set
17290
19138
  if @api_client.config.client_side_validation && storefront_oid.nil?
17291
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_campaign"
19139
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_flow_folder"
17292
19140
  end
17293
- # verify the required parameter 'campaign_uuid' is set
17294
- if @api_client.config.client_side_validation && campaign_uuid.nil?
17295
- fail ArgumentError, "Missing the required parameter 'campaign_uuid' when calling SfvbApi.update_sfvb_campaign"
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"
17296
19144
  end
17297
19145
  # verify the required parameter 'if_match' is set
17298
19146
  if @api_client.config.client_side_validation && if_match.nil?
17299
- fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_campaign"
19147
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_flow_folder"
17300
19148
  end
17301
- # verify the required parameter 'campaign_write_request' is set
17302
- if @api_client.config.client_side_validation && campaign_write_request.nil?
17303
- fail ArgumentError, "Missing the required parameter 'campaign_write_request' when calling SfvbApi.update_sfvb_campaign"
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"
17304
19152
  end
17305
19153
  # resource path
17306
- local_var_path = '/sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'campaign_uuid' + '}', CGI.escape(campaign_uuid.to_s))
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))
17307
19155
 
17308
19156
  # query parameters
17309
19157
  query_params = opts[:query_params] || {}
@@ -17324,16 +19172,16 @@ module UltracartClient
17324
19172
  form_params = opts[:form_params] || {}
17325
19173
 
17326
19174
  # http body (model)
17327
- post_body = opts[:debug_body] || @api_client.object_to_http_body(campaign_write_request)
19175
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
17328
19176
 
17329
19177
  # return_type
17330
- return_type = opts[:debug_return_type] || 'SfvbCampaign'
19178
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceFolderResponse'
17331
19179
 
17332
19180
  # auth_names
17333
19181
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17334
19182
 
17335
19183
  new_options = opts.merge(
17336
- :operation => :"SfvbApi.update_sfvb_campaign",
19184
+ :operation => :"SfvbApi.update_sfvb_comms_flow_folder",
17337
19185
  :header_params => header_params,
17338
19186
  :query_params => query_params,
17339
19187
  :form_params => form_params,
@@ -17344,7 +19192,7 @@ module UltracartClient
17344
19192
 
17345
19193
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17346
19194
  if @api_client.config.debugging
17347
- @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19195
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17348
19196
  end
17349
19197
  return data, status_code, headers
17350
19198
  end
@@ -17691,6 +19539,91 @@ module UltracartClient
17691
19539
  return data, status_code, headers
17692
19540
  end
17693
19541
 
19542
+ # Change a storefront's communications settings
19543
+ # A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
19544
+ # @param storefront_oid [Integer]
19545
+ # @param if_match [String] The settings&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19546
+ # @param comms_settings_update_request [SfvbCommsSettingsUpdateRequest] The settings to change
19547
+ # @param [Hash] opts the optional parameters
19548
+ # @option opts [String] :approval_id The approval_id of an approved comms_settings.update request for exactly this change, when a sender or the SMS number changes. See POST /sfvb/approvals.
19549
+ # @return [SfvbCommsSettingsResponse]
19550
+ def update_sfvb_comms_settings(storefront_oid, if_match, comms_settings_update_request, opts = {})
19551
+ data, _status_code, _headers = update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
19552
+ data
19553
+ end
19554
+
19555
+ # Change a storefront&#39;s communications settings
19556
+ # A field left out stays as it is. A return address change needs sfvb_write and If-Match. A change to the default marketing or transactional sender, or the default SMS number, also needs sfvb_publish and an approved comms_settings.update request for exactly this change. A sending domain must be on this account and the SMS number on one of its Twilio accounts. dry_run checks and shows the change without writing or using an approval.
19557
+ # @param storefront_oid [Integer]
19558
+ # @param if_match [String] The settings&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19559
+ # @param comms_settings_update_request [SfvbCommsSettingsUpdateRequest] The settings to change
19560
+ # @param [Hash] opts the optional parameters
19561
+ # @option opts [String] :approval_id The approval_id of an approved comms_settings.update request for exactly this change, when a sender or the SMS number changes. See POST /sfvb/approvals.
19562
+ # @return [Array<(SfvbCommsSettingsResponse, Integer, Hash)>] SfvbCommsSettingsResponse data, response status code and response headers
19563
+ def update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts = {})
19564
+ if @api_client.config.debugging
19565
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_settings ...'
19566
+ end
19567
+ # verify the required parameter 'storefront_oid' is set
19568
+ if @api_client.config.client_side_validation && storefront_oid.nil?
19569
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_settings"
19570
+ end
19571
+ # verify the required parameter 'if_match' is set
19572
+ if @api_client.config.client_side_validation && if_match.nil?
19573
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_settings"
19574
+ end
19575
+ # verify the required parameter 'comms_settings_update_request' is set
19576
+ if @api_client.config.client_side_validation && comms_settings_update_request.nil?
19577
+ fail ArgumentError, "Missing the required parameter 'comms_settings_update_request' when calling SfvbApi.update_sfvb_comms_settings"
19578
+ end
19579
+ # resource path
19580
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
19581
+
19582
+ # query parameters
19583
+ query_params = opts[:query_params] || {}
19584
+
19585
+ # header parameters
19586
+ header_params = opts[:header_params] || {}
19587
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
19588
+ # HTTP header 'Accept' (if needed)
19589
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19590
+ # HTTP header 'Content-Type'
19591
+ content_type = @api_client.select_header_content_type(['application/json'])
19592
+ if !content_type.nil?
19593
+ header_params['Content-Type'] = content_type
19594
+ end
19595
+ header_params[:'If-Match'] = if_match
19596
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
19597
+
19598
+ # form parameters
19599
+ form_params = opts[:form_params] || {}
19600
+
19601
+ # http body (model)
19602
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(comms_settings_update_request)
19603
+
19604
+ # return_type
19605
+ return_type = opts[:debug_return_type] || 'SfvbCommsSettingsResponse'
19606
+
19607
+ # auth_names
19608
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
19609
+
19610
+ new_options = opts.merge(
19611
+ :operation => :"SfvbApi.update_sfvb_comms_settings",
19612
+ :header_params => header_params,
19613
+ :query_params => query_params,
19614
+ :form_params => form_params,
19615
+ :body => post_body,
19616
+ :auth_names => auth_names,
19617
+ :return_type => return_type
19618
+ )
19619
+
19620
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
19621
+ if @api_client.config.debugging
19622
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19623
+ end
19624
+ return data, status_code, headers
19625
+ end
19626
+
17694
19627
  # Update the Twilio account
17695
19628
  # Changes the account's Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart's API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
17696
19629
  # @param twilio_account [SfvbCommsTwilioAccount] The changes
@@ -19393,6 +21326,81 @@ module UltracartClient
19393
21326
  return data, status_code, headers
19394
21327
  end
19395
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
+
19396
21404
  # Validate a Velocity template against a theme
19397
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.
19398
21406
  # @param storefront_oid [Integer]