ultracart_api 4.1.230 → 4.1.232

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 (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -2
  3. data/docs/ItemAutoOrder.md +1 -1
  4. data/docs/ItemContentMultimedia.md +2 -0
  5. data/docs/SfvbApi.md +1011 -0
  6. data/docs/SfvbApprovalCreateRequest.md +9 -1
  7. data/docs/SfvbCampaign.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/SfvbCommsMember.md +22 -0
  16. data/docs/SfvbCommsMembersResponse.md +36 -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/SfvbCommsSender.md +24 -0
  25. data/docs/SfvbCommsSenderUpdate.md +22 -0
  26. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  27. data/docs/SfvbCommsSettings.md +34 -0
  28. data/docs/SfvbCommsSettingsResponse.md +24 -0
  29. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  30. data/docs/SfvbCommsStat.md +54 -0
  31. data/docs/SfvbCommsStepStat.md +34 -0
  32. data/docs/SfvbCommsTemplate.md +30 -0
  33. data/docs/SfvbCommsTemplateResponse.md +24 -0
  34. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  35. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  36. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  37. data/docs/SfvbCommsTestSendResponse.md +32 -0
  38. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  39. data/docs/SfvbFlow.md +2 -0
  40. data/docs/SfvbPostcardAddress.md +28 -0
  41. data/docs/SfvbPostcardCard.md +40 -0
  42. data/docs/SfvbPostcardTrackingResponse.md +34 -0
  43. data/docs/SfvbTransactionalChange.md +24 -0
  44. data/docs/SfvbTransactionalDeliveryOption.md +22 -0
  45. data/docs/SfvbTransactionalEmailDetail.md +30 -0
  46. data/docs/SfvbTransactionalEmailResponse.md +24 -0
  47. data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
  48. data/docs/SfvbTransactionalSender.md +24 -0
  49. data/lib/ultracart_api/api/sfvb_api.rb +1553 -183
  50. data/lib/ultracart_api/models/item_auto_order.rb +1 -1
  51. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  52. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +42 -6
  53. data/lib/ultracart_api/models/sfvb_campaign.rb +11 -1
  54. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  55. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  56. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  57. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  58. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  59. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  60. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  61. data/lib/ultracart_api/models/sfvb_comms_member.rb +240 -0
  62. data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
  63. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  64. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  65. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  66. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  67. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  68. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  69. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  70. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  71. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  72. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  73. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  74. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  75. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  76. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  77. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  78. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  79. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +251 -0
  80. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  81. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  82. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  83. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  84. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  85. data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
  86. data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
  87. data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
  88. data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
  89. data/lib/ultracart_api/models/sfvb_transactional_change.rb +250 -0
  90. data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
  91. data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
  92. data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
  93. data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
  94. data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
  95. data/lib/ultracart_api/version.rb +1 -1
  96. data/lib/ultracart_api.rb +40 -0
  97. metadata +81 -1
@@ -4898,6 +4898,152 @@ module UltracartClient
4898
4898
  return data, status_code, headers
4899
4899
  end
4900
4900
 
4901
+ # Read every flow's and campaign's counts over a window, with the account's daily sending
4902
+ # rows cover each flow and campaign with activity in the last days (1 to 365, default 30); daily is the account's last 31 days of sending, whatever the window. Read only.
4903
+ # @param storefront_oid [Integer]
4904
+ # @param [Hash] opts the optional parameters
4905
+ # @option opts [Integer] :days The window for the rows, 1 to 365 days (default 30).
4906
+ # @return [SfvbCommsDashboardResponse]
4907
+ def get_sfvb_comms_dashboard_stats(storefront_oid, opts = {})
4908
+ data, _status_code, _headers = get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts)
4909
+ data
4910
+ end
4911
+
4912
+ # Read every flow's and campaign's counts over a window, with the account's daily sending
4913
+ # 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.
4914
+ # @param storefront_oid [Integer]
4915
+ # @param [Hash] opts the optional parameters
4916
+ # @option opts [Integer] :days The window for the rows, 1 to 365 days (default 30).
4917
+ # @return [Array<(SfvbCommsDashboardResponse, Integer, Hash)>] SfvbCommsDashboardResponse data, response status code and response headers
4918
+ def get_sfvb_comms_dashboard_stats_with_http_info(storefront_oid, opts = {})
4919
+ if @api_client.config.debugging
4920
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_dashboard_stats ...'
4921
+ end
4922
+ # verify the required parameter 'storefront_oid' is set
4923
+ 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_dashboard_stats"
4925
+ end
4926
+ # resource path
4927
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/stats/dashboard'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
4928
+
4929
+ # query parameters
4930
+ query_params = opts[:query_params] || {}
4931
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
4932
+
4933
+ # header parameters
4934
+ header_params = opts[:header_params] || {}
4935
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4936
+ # HTTP header 'Accept' (if needed)
4937
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4938
+
4939
+ # form parameters
4940
+ form_params = opts[:form_params] || {}
4941
+
4942
+ # http body (model)
4943
+ post_body = opts[:debug_body]
4944
+
4945
+ # return_type
4946
+ return_type = opts[:debug_return_type] || 'SfvbCommsDashboardResponse'
4947
+
4948
+ # auth_names
4949
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4950
+
4951
+ new_options = opts.merge(
4952
+ :operation => :"SfvbApi.get_sfvb_comms_dashboard_stats",
4953
+ :header_params => header_params,
4954
+ :query_params => query_params,
4955
+ :form_params => form_params,
4956
+ :body => post_body,
4957
+ :auth_names => auth_names,
4958
+ :return_type => return_type
4959
+ )
4960
+
4961
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4962
+ if @api_client.config.debugging
4963
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_dashboard_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4964
+ end
4965
+ return data, status_code, headers
4966
+ end
4967
+
4968
+ # Read each link in one email and how often it was clicked
4969
+ # 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.
4970
+ # @param storefront_oid [Integer]
4971
+ # @param commseq_uuid [String]
4972
+ # @param email_uuid [String]
4973
+ # @param [Hash] opts the optional parameters
4974
+ # @option opts [Integer] :days The window, 1 to 365 days (default 30).
4975
+ # @return [SfvbCommsClicksResponse]
4976
+ def get_sfvb_comms_email_clicks(storefront_oid, commseq_uuid, email_uuid, opts = {})
4977
+ data, _status_code, _headers = get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts)
4978
+ data
4979
+ end
4980
+
4981
+ # Read each link in one email and how often it was clicked
4982
+ # 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.
4983
+ # @param storefront_oid [Integer]
4984
+ # @param commseq_uuid [String]
4985
+ # @param email_uuid [String]
4986
+ # @param [Hash] opts the optional parameters
4987
+ # @option opts [Integer] :days The window, 1 to 365 days (default 30).
4988
+ # @return [Array<(SfvbCommsClicksResponse, Integer, Hash)>] SfvbCommsClicksResponse data, response status code and response headers
4989
+ def get_sfvb_comms_email_clicks_with_http_info(storefront_oid, commseq_uuid, email_uuid, opts = {})
4990
+ if @api_client.config.debugging
4991
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_email_clicks ...'
4992
+ end
4993
+ # verify the required parameter 'storefront_oid' is set
4994
+ if @api_client.config.client_side_validation && storefront_oid.nil?
4995
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_email_clicks"
4996
+ end
4997
+ # verify the required parameter 'commseq_uuid' is set
4998
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
4999
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5000
+ end
5001
+ # verify the required parameter 'email_uuid' is set
5002
+ if @api_client.config.client_side_validation && email_uuid.nil?
5003
+ fail ArgumentError, "Missing the required parameter 'email_uuid' when calling SfvbApi.get_sfvb_comms_email_clicks"
5004
+ end
5005
+ # resource path
5006
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/sequences/{commseq_uuid}/emails/{email_uuid}/clicks'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'email_uuid' + '}', CGI.escape(email_uuid.to_s))
5007
+
5008
+ # query parameters
5009
+ query_params = opts[:query_params] || {}
5010
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5011
+
5012
+ # header parameters
5013
+ header_params = opts[:header_params] || {}
5014
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5015
+ # HTTP header 'Accept' (if needed)
5016
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5017
+
5018
+ # form parameters
5019
+ form_params = opts[:form_params] || {}
5020
+
5021
+ # http body (model)
5022
+ post_body = opts[:debug_body]
5023
+
5024
+ # return_type
5025
+ return_type = opts[:debug_return_type] || 'SfvbCommsClicksResponse'
5026
+
5027
+ # auth_names
5028
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5029
+
5030
+ new_options = opts.merge(
5031
+ :operation => :"SfvbApi.get_sfvb_comms_email_clicks",
5032
+ :header_params => header_params,
5033
+ :query_params => query_params,
5034
+ :form_params => form_params,
5035
+ :body => post_body,
5036
+ :auth_names => auth_names,
5037
+ :return_type => return_type
5038
+ )
5039
+
5040
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5041
+ if @api_client.config.debugging
5042
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_email_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5043
+ end
5044
+ return data, status_code, headers
5045
+ end
5046
+
4901
5047
  # Read one list and segment folder
4902
5048
  # The folder, with the name and uuid of each list and segment filed in it.
4903
5049
  # @param storefront_oid [Integer]
@@ -5010,13 +5156,561 @@ module UltracartClient
5010
5156
  post_body = opts[:debug_body]
5011
5157
 
5012
5158
  # return_type
5013
- return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
5159
+ return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
5160
+
5161
+ # auth_names
5162
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5163
+
5164
+ new_options = opts.merge(
5165
+ :operation => :"SfvbApi.get_sfvb_comms_folders",
5166
+ :header_params => header_params,
5167
+ :query_params => query_params,
5168
+ :form_params => form_params,
5169
+ :body => post_body,
5170
+ :auth_names => auth_names,
5171
+ :return_type => return_type
5172
+ )
5173
+
5174
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5175
+ if @api_client.config.debugging
5176
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5177
+ end
5178
+ return data, status_code, headers
5179
+ end
5180
+
5181
+ # Read one email list
5182
+ # 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.
5183
+ # @param storefront_oid [Integer]
5184
+ # @param list_uuid [String]
5185
+ # @param [Hash] opts the optional parameters
5186
+ # @return [SfvbCommsListResponse]
5187
+ def get_sfvb_comms_list(storefront_oid, list_uuid, opts = {})
5188
+ data, _status_code, _headers = get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts)
5189
+ data
5190
+ end
5191
+
5192
+ # Read one email list
5193
+ # 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.
5194
+ # @param storefront_oid [Integer]
5195
+ # @param list_uuid [String]
5196
+ # @param [Hash] opts the optional parameters
5197
+ # @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
5198
+ def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
5199
+ if @api_client.config.debugging
5200
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
5201
+ end
5202
+ # verify the required parameter 'storefront_oid' is set
5203
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5204
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list"
5205
+ end
5206
+ # verify the required parameter 'list_uuid' is set
5207
+ if @api_client.config.client_side_validation && list_uuid.nil?
5208
+ fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list"
5209
+ end
5210
+ # resource path
5211
+ 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))
5212
+
5213
+ # query parameters
5214
+ query_params = opts[:query_params] || {}
5215
+
5216
+ # header parameters
5217
+ header_params = opts[:header_params] || {}
5218
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5219
+ # HTTP header 'Accept' (if needed)
5220
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5221
+
5222
+ # form parameters
5223
+ form_params = opts[:form_params] || {}
5224
+
5225
+ # http body (model)
5226
+ post_body = opts[:debug_body]
5227
+
5228
+ # return_type
5229
+ return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
5230
+
5231
+ # auth_names
5232
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5233
+
5234
+ new_options = opts.merge(
5235
+ :operation => :"SfvbApi.get_sfvb_comms_list",
5236
+ :header_params => header_params,
5237
+ :query_params => query_params,
5238
+ :form_params => form_params,
5239
+ :body => post_body,
5240
+ :auth_names => auth_names,
5241
+ :return_type => return_type
5242
+ )
5243
+
5244
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5245
+ if @api_client.config.debugging
5246
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5247
+ end
5248
+ return data, status_code, headers
5249
+ end
5250
+
5251
+ # Read one page of a list's members
5252
+ # 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.
5253
+ # @param storefront_oid [Integer]
5254
+ # @param list_uuid [String]
5255
+ # @param [Hash] opts the optional parameters
5256
+ # @option opts [Integer] :page The page, from 1
5257
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5258
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5259
+ # @return [SfvbCommsMembersResponse]
5260
+ def get_sfvb_comms_list_members(storefront_oid, list_uuid, opts = {})
5261
+ data, _status_code, _headers = get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
5262
+ data
5263
+ end
5264
+
5265
+ # Read one page of a list&#39;s members
5266
+ # 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.
5267
+ # @param storefront_oid [Integer]
5268
+ # @param list_uuid [String]
5269
+ # @param [Hash] opts the optional parameters
5270
+ # @option opts [Integer] :page The page, from 1
5271
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5272
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5273
+ # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
5274
+ def get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts = {})
5275
+ if @api_client.config.debugging
5276
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list_members ...'
5277
+ end
5278
+ # verify the required parameter 'storefront_oid' is set
5279
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5280
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list_members"
5281
+ end
5282
+ # verify the required parameter 'list_uuid' is set
5283
+ if @api_client.config.client_side_validation && list_uuid.nil?
5284
+ fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list_members"
5285
+ end
5286
+ # resource path
5287
+ 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))
5288
+
5289
+ # query parameters
5290
+ query_params = opts[:query_params] || {}
5291
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
5292
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
5293
+ query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
5294
+
5295
+ # header parameters
5296
+ header_params = opts[:header_params] || {}
5297
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5298
+ # HTTP header 'Accept' (if needed)
5299
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5300
+
5301
+ # form parameters
5302
+ form_params = opts[:form_params] || {}
5303
+
5304
+ # http body (model)
5305
+ post_body = opts[:debug_body]
5306
+
5307
+ # return_type
5308
+ return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
5309
+
5310
+ # auth_names
5311
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5312
+
5313
+ new_options = opts.merge(
5314
+ :operation => :"SfvbApi.get_sfvb_comms_list_members",
5315
+ :header_params => header_params,
5316
+ :query_params => query_params,
5317
+ :form_params => form_params,
5318
+ :body => post_body,
5319
+ :auth_names => auth_names,
5320
+ :return_type => return_type
5321
+ )
5322
+
5323
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5324
+ if @api_client.config.debugging
5325
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5326
+ end
5327
+ return data, status_code, headers
5328
+ end
5329
+
5330
+ # Read the account's communications plan and sending health
5331
+ # The plan, its customer and email caps, what has been sent against them, and the spam pause, with notes on anything that stops sends. Account-wide. Never a price, fee or upgrade option; the plan is changed in the admin. Read only.
5332
+ # @param storefront_oid [Integer]
5333
+ # @param [Hash] opts the optional parameters
5334
+ # @return [SfvbCommsPlanResponse]
5335
+ def get_sfvb_comms_plan(storefront_oid, opts = {})
5336
+ data, _status_code, _headers = get_sfvb_comms_plan_with_http_info(storefront_oid, opts)
5337
+ data
5338
+ end
5339
+
5340
+ # Read the account&#39;s communications plan and sending health
5341
+ # 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.
5342
+ # @param storefront_oid [Integer]
5343
+ # @param [Hash] opts the optional parameters
5344
+ # @return [Array<(SfvbCommsPlanResponse, Integer, Hash)>] SfvbCommsPlanResponse data, response status code and response headers
5345
+ def get_sfvb_comms_plan_with_http_info(storefront_oid, opts = {})
5346
+ if @api_client.config.debugging
5347
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_plan ...'
5348
+ end
5349
+ # verify the required parameter 'storefront_oid' is set
5350
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5351
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_plan"
5352
+ end
5353
+ # resource path
5354
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/plan'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5355
+
5356
+ # query parameters
5357
+ query_params = opts[:query_params] || {}
5358
+
5359
+ # header parameters
5360
+ header_params = opts[:header_params] || {}
5361
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5362
+ # HTTP header 'Accept' (if needed)
5363
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5364
+
5365
+ # form parameters
5366
+ form_params = opts[:form_params] || {}
5367
+
5368
+ # http body (model)
5369
+ post_body = opts[:debug_body]
5370
+
5371
+ # return_type
5372
+ return_type = opts[:debug_return_type] || 'SfvbCommsPlanResponse'
5373
+
5374
+ # auth_names
5375
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5376
+
5377
+ new_options = opts.merge(
5378
+ :operation => :"SfvbApi.get_sfvb_comms_plan",
5379
+ :header_params => header_params,
5380
+ :query_params => query_params,
5381
+ :form_params => form_params,
5382
+ :body => post_body,
5383
+ :auth_names => auth_names,
5384
+ :return_type => return_type
5385
+ )
5386
+
5387
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5388
+ if @api_client.config.debugging
5389
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5390
+ end
5391
+ return data, status_code, headers
5392
+ end
5393
+
5394
+ # List the email providers the account can import lists from
5395
+ # 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.
5396
+ # @param storefront_oid [Integer]
5397
+ # @param [Hash] opts the optional parameters
5398
+ # @return [SfvbCommsProvidersResponse]
5399
+ def get_sfvb_comms_providers(storefront_oid, opts = {})
5400
+ data, _status_code, _headers = get_sfvb_comms_providers_with_http_info(storefront_oid, opts)
5401
+ data
5402
+ end
5403
+
5404
+ # List the email providers the account can import lists from
5405
+ # 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.
5406
+ # @param storefront_oid [Integer]
5407
+ # @param [Hash] opts the optional parameters
5408
+ # @return [Array<(SfvbCommsProvidersResponse, Integer, Hash)>] SfvbCommsProvidersResponse data, response status code and response headers
5409
+ def get_sfvb_comms_providers_with_http_info(storefront_oid, opts = {})
5410
+ if @api_client.config.debugging
5411
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_providers ...'
5412
+ end
5413
+ # verify the required parameter 'storefront_oid' is set
5414
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5415
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_providers"
5416
+ end
5417
+ # resource path
5418
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/providers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5419
+
5420
+ # query parameters
5421
+ query_params = opts[:query_params] || {}
5422
+
5423
+ # header parameters
5424
+ header_params = opts[:header_params] || {}
5425
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5426
+ # HTTP header 'Accept' (if needed)
5427
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5428
+
5429
+ # form parameters
5430
+ form_params = opts[:form_params] || {}
5431
+
5432
+ # http body (model)
5433
+ post_body = opts[:debug_body]
5434
+
5435
+ # return_type
5436
+ return_type = opts[:debug_return_type] || 'SfvbCommsProvidersResponse'
5437
+
5438
+ # auth_names
5439
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5440
+
5441
+ new_options = opts.merge(
5442
+ :operation => :"SfvbApi.get_sfvb_comms_providers",
5443
+ :header_params => header_params,
5444
+ :query_params => query_params,
5445
+ :form_params => form_params,
5446
+ :body => post_body,
5447
+ :auth_names => auth_names,
5448
+ :return_type => return_type
5449
+ )
5450
+
5451
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5452
+ if @api_client.config.debugging
5453
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5454
+ end
5455
+ return data, status_code, headers
5456
+ end
5457
+
5458
+ # Read one segment, with its rule
5459
+ # 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.
5460
+ # @param storefront_oid [Integer]
5461
+ # @param segment_uuid [String]
5462
+ # @param [Hash] opts the optional parameters
5463
+ # @return [SfvbCommsSegmentResponse]
5464
+ def get_sfvb_comms_segment(storefront_oid, segment_uuid, opts = {})
5465
+ data, _status_code, _headers = get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts)
5466
+ data
5467
+ end
5468
+
5469
+ # Read one segment, with its rule
5470
+ # 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.
5471
+ # @param storefront_oid [Integer]
5472
+ # @param segment_uuid [String]
5473
+ # @param [Hash] opts the optional parameters
5474
+ # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
5475
+ def get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts = {})
5476
+ if @api_client.config.debugging
5477
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment ...'
5478
+ end
5479
+ # verify the required parameter 'storefront_oid' is set
5480
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5481
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment"
5482
+ end
5483
+ # verify the required parameter 'segment_uuid' is set
5484
+ if @api_client.config.client_side_validation && segment_uuid.nil?
5485
+ fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment"
5486
+ end
5487
+ # resource path
5488
+ 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))
5489
+
5490
+ # query parameters
5491
+ query_params = opts[:query_params] || {}
5492
+
5493
+ # header parameters
5494
+ header_params = opts[:header_params] || {}
5495
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5496
+ # HTTP header 'Accept' (if needed)
5497
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5498
+
5499
+ # form parameters
5500
+ form_params = opts[:form_params] || {}
5501
+
5502
+ # http body (model)
5503
+ post_body = opts[:debug_body]
5504
+
5505
+ # return_type
5506
+ return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
5507
+
5508
+ # auth_names
5509
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5510
+
5511
+ new_options = opts.merge(
5512
+ :operation => :"SfvbApi.get_sfvb_comms_segment",
5513
+ :header_params => header_params,
5514
+ :query_params => query_params,
5515
+ :form_params => form_params,
5516
+ :body => post_body,
5517
+ :auth_names => auth_names,
5518
+ :return_type => return_type
5519
+ )
5520
+
5521
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5522
+ if @api_client.config.debugging
5523
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5524
+ end
5525
+ return data, status_code, headers
5526
+ end
5527
+
5528
+ # Read one page of a segment's members
5529
+ # 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.
5530
+ # @param storefront_oid [Integer]
5531
+ # @param segment_uuid [String]
5532
+ # @param [Hash] opts the optional parameters
5533
+ # @option opts [Integer] :page The page, from 1
5534
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5535
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5536
+ # @return [SfvbCommsMembersResponse]
5537
+ def get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts = {})
5538
+ data, _status_code, _headers = get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
5539
+ data
5540
+ end
5541
+
5542
+ # Read one page of a segment&#39;s members
5543
+ # 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.
5544
+ # @param storefront_oid [Integer]
5545
+ # @param segment_uuid [String]
5546
+ # @param [Hash] opts the optional parameters
5547
+ # @option opts [Integer] :page The page, from 1
5548
+ # @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
5549
+ # @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
5550
+ # @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
5551
+ def get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts = {})
5552
+ if @api_client.config.debugging
5553
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment_members ...'
5554
+ end
5555
+ # verify the required parameter 'storefront_oid' is set
5556
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5557
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment_members"
5558
+ end
5559
+ # verify the required parameter 'segment_uuid' is set
5560
+ if @api_client.config.client_side_validation && segment_uuid.nil?
5561
+ fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment_members"
5562
+ end
5563
+ # resource path
5564
+ 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))
5565
+
5566
+ # query parameters
5567
+ query_params = opts[:query_params] || {}
5568
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
5569
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
5570
+ query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
5571
+
5572
+ # header parameters
5573
+ header_params = opts[:header_params] || {}
5574
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5575
+ # HTTP header 'Accept' (if needed)
5576
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5577
+
5578
+ # form parameters
5579
+ form_params = opts[:form_params] || {}
5580
+
5581
+ # http body (model)
5582
+ post_body = opts[:debug_body]
5583
+
5584
+ # return_type
5585
+ return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
5586
+
5587
+ # auth_names
5588
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5589
+
5590
+ new_options = opts.merge(
5591
+ :operation => :"SfvbApi.get_sfvb_comms_segment_members",
5592
+ :header_params => header_params,
5593
+ :query_params => query_params,
5594
+ :form_params => form_params,
5595
+ :body => post_body,
5596
+ :auth_names => auth_names,
5597
+ :return_type => return_type
5598
+ )
5599
+
5600
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5601
+ if @api_client.config.debugging
5602
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5603
+ end
5604
+ return data, status_code, headers
5605
+ end
5606
+
5607
+ # Read a sending domain
5608
+ # One sending domain as stored. To check an amazon domain's DNS again, use the status call.
5609
+ # @param domain [String]
5610
+ # @param [Hash] opts the optional parameters
5611
+ # @return [SfvbCommsSendingDomain]
5612
+ def get_sfvb_comms_sending_domain(domain, opts = {})
5613
+ data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
5614
+ data
5615
+ end
5616
+
5617
+ # Read a sending domain
5618
+ # One sending domain as stored. To check an amazon domain&#39;s DNS again, use the status call.
5619
+ # @param domain [String]
5620
+ # @param [Hash] opts the optional parameters
5621
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
5622
+ def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
5623
+ if @api_client.config.debugging
5624
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
5625
+ end
5626
+ # verify the required parameter 'domain' is set
5627
+ if @api_client.config.client_side_validation && domain.nil?
5628
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
5629
+ end
5630
+ # resource path
5631
+ local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
5632
+
5633
+ # query parameters
5634
+ query_params = opts[:query_params] || {}
5635
+
5636
+ # header parameters
5637
+ header_params = opts[:header_params] || {}
5638
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5639
+ # HTTP header 'Accept' (if needed)
5640
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5641
+
5642
+ # form parameters
5643
+ form_params = opts[:form_params] || {}
5644
+
5645
+ # http body (model)
5646
+ post_body = opts[:debug_body]
5647
+
5648
+ # return_type
5649
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
5650
+
5651
+ # auth_names
5652
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5653
+
5654
+ new_options = opts.merge(
5655
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domain",
5656
+ :header_params => header_params,
5657
+ :query_params => query_params,
5658
+ :form_params => form_params,
5659
+ :body => post_body,
5660
+ :auth_names => auth_names,
5661
+ :return_type => return_type
5662
+ )
5663
+
5664
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5665
+ if @api_client.config.debugging
5666
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5667
+ end
5668
+ return data, status_code, headers
5669
+ end
5670
+
5671
+ # List the sending domains
5672
+ # 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.
5673
+ # @param [Hash] opts the optional parameters
5674
+ # @return [SfvbCommsSendingDomainsResponse]
5675
+ def get_sfvb_comms_sending_domains(opts = {})
5676
+ data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
5677
+ data
5678
+ end
5679
+
5680
+ # List the sending domains
5681
+ # 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.
5682
+ # @param [Hash] opts the optional parameters
5683
+ # @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
5684
+ def get_sfvb_comms_sending_domains_with_http_info(opts = {})
5685
+ if @api_client.config.debugging
5686
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
5687
+ end
5688
+ # resource path
5689
+ local_var_path = '/sfvb/comms/sending_domains'
5690
+
5691
+ # query parameters
5692
+ query_params = opts[:query_params] || {}
5693
+
5694
+ # header parameters
5695
+ header_params = opts[:header_params] || {}
5696
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5697
+ # HTTP header 'Accept' (if needed)
5698
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5699
+
5700
+ # form parameters
5701
+ form_params = opts[:form_params] || {}
5702
+
5703
+ # http body (model)
5704
+ post_body = opts[:debug_body]
5705
+
5706
+ # return_type
5707
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
5014
5708
 
5015
5709
  # auth_names
5016
5710
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5017
5711
 
5018
5712
  new_options = opts.merge(
5019
- :operation => :"SfvbApi.get_sfvb_comms_folders",
5713
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domains",
5020
5714
  :header_params => header_params,
5021
5715
  :query_params => query_params,
5022
5716
  :form_params => form_params,
@@ -5027,45 +5721,48 @@ module UltracartClient
5027
5721
 
5028
5722
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5029
5723
  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}"
5724
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5031
5725
  end
5032
5726
  return data, status_code, headers
5033
5727
  end
5034
5728
 
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.
5729
+ # Read a flow's or campaign's counts, overall and step by step
5730
+ # 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.
5037
5731
  # @param storefront_oid [Integer]
5038
- # @param list_uuid [String]
5732
+ # @param commseq_uuid [String]
5039
5733
  # @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)
5734
+ # @option opts [Integer] :days The window for the step counts, 1 to 365 days (default 30).
5735
+ # @return [SfvbCommsSequenceStatsResponse]
5736
+ def get_sfvb_comms_sequence_stats(storefront_oid, commseq_uuid, opts = {})
5737
+ data, _status_code, _headers = get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts)
5043
5738
  data
5044
5739
  end
5045
5740
 
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.
5741
+ # Read a flow&#39;s or campaign&#39;s counts, overall and step by step
5742
+ # 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.
5048
5743
  # @param storefront_oid [Integer]
5049
- # @param list_uuid [String]
5744
+ # @param commseq_uuid [String]
5050
5745
  # @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 = {})
5746
+ # @option opts [Integer] :days The window for the step counts, 1 to 365 days (default 30).
5747
+ # @return [Array<(SfvbCommsSequenceStatsResponse, Integer, Hash)>] SfvbCommsSequenceStatsResponse data, response status code and response headers
5748
+ def get_sfvb_comms_sequence_stats_with_http_info(storefront_oid, commseq_uuid, opts = {})
5053
5749
  if @api_client.config.debugging
5054
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
5750
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sequence_stats ...'
5055
5751
  end
5056
5752
  # verify the required parameter 'storefront_oid' is set
5057
5753
  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"
5754
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_sequence_stats"
5059
5755
  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"
5756
+ # verify the required parameter 'commseq_uuid' is set
5757
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
5758
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.get_sfvb_comms_sequence_stats"
5063
5759
  end
5064
5760
  # 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))
5761
+ 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))
5066
5762
 
5067
5763
  # query parameters
5068
5764
  query_params = opts[:query_params] || {}
5765
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5069
5766
 
5070
5767
  # header parameters
5071
5768
  header_params = opts[:header_params] || {}
@@ -5080,13 +5777,13 @@ module UltracartClient
5080
5777
  post_body = opts[:debug_body]
5081
5778
 
5082
5779
  # return_type
5083
- return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
5780
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceStatsResponse'
5084
5781
 
5085
5782
  # auth_names
5086
5783
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5087
5784
 
5088
5785
  new_options = opts.merge(
5089
- :operation => :"SfvbApi.get_sfvb_comms_list",
5786
+ :operation => :"SfvbApi.get_sfvb_comms_sequence_stats",
5090
5787
  :header_params => header_params,
5091
5788
  :query_params => query_params,
5092
5789
  :form_params => form_params,
@@ -5097,42 +5794,36 @@ module UltracartClient
5097
5794
 
5098
5795
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5099
5796
  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}"
5797
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sequence_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5101
5798
  end
5102
5799
  return data, status_code, headers
5103
5800
  end
5104
5801
 
5105
- # Read one segment, with its rule
5106
- # 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.
5802
+ # Read a storefront's communications settings
5803
+ # 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.
5107
5804
  # @param storefront_oid [Integer]
5108
- # @param segment_uuid [String]
5109
5805
  # @param [Hash] opts the optional parameters
5110
- # @return [SfvbCommsSegmentResponse]
5111
- def get_sfvb_comms_segment(storefront_oid, segment_uuid, opts = {})
5112
- data, _status_code, _headers = get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts)
5806
+ # @return [SfvbCommsSettingsResponse]
5807
+ def get_sfvb_comms_settings(storefront_oid, opts = {})
5808
+ data, _status_code, _headers = get_sfvb_comms_settings_with_http_info(storefront_oid, opts)
5113
5809
  data
5114
5810
  end
5115
5811
 
5116
- # Read one segment, with its rule
5117
- # 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.
5812
+ # Read a storefront&#39;s communications settings
5813
+ # 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.
5118
5814
  # @param storefront_oid [Integer]
5119
- # @param segment_uuid [String]
5120
5815
  # @param [Hash] opts the optional parameters
5121
- # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
5122
- def get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts = {})
5816
+ # @return [Array<(SfvbCommsSettingsResponse, Integer, Hash)>] SfvbCommsSettingsResponse data, response status code and response headers
5817
+ def get_sfvb_comms_settings_with_http_info(storefront_oid, opts = {})
5123
5818
  if @api_client.config.debugging
5124
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment ...'
5819
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_settings ...'
5125
5820
  end
5126
5821
  # verify the required parameter 'storefront_oid' is set
5127
5822
  if @api_client.config.client_side_validation && storefront_oid.nil?
5128
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment"
5129
- end
5130
- # verify the required parameter 'segment_uuid' is set
5131
- if @api_client.config.client_side_validation && segment_uuid.nil?
5132
- fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment"
5823
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_settings"
5133
5824
  end
5134
5825
  # resource path
5135
- 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))
5826
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5136
5827
 
5137
5828
  # query parameters
5138
5829
  query_params = opts[:query_params] || {}
@@ -5150,13 +5841,13 @@ module UltracartClient
5150
5841
  post_body = opts[:debug_body]
5151
5842
 
5152
5843
  # return_type
5153
- return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
5844
+ return_type = opts[:debug_return_type] || 'SfvbCommsSettingsResponse'
5154
5845
 
5155
5846
  # auth_names
5156
5847
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5157
5848
 
5158
5849
  new_options = opts.merge(
5159
- :operation => :"SfvbApi.get_sfvb_comms_segment",
5850
+ :operation => :"SfvbApi.get_sfvb_comms_settings",
5160
5851
  :header_params => header_params,
5161
5852
  :query_params => query_params,
5162
5853
  :form_params => form_params,
@@ -5167,36 +5858,42 @@ module UltracartClient
5167
5858
 
5168
5859
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5169
5860
  if @api_client.config.debugging
5170
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5861
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5171
5862
  end
5172
5863
  return data, status_code, headers
5173
5864
  end
5174
5865
 
5175
- # Read a sending domain
5176
- # One sending domain as stored. To check an amazon domain's DNS again, use the status call.
5177
- # @param domain [String]
5866
+ # Read one saved email template's body
5867
+ # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
5868
+ # @param storefront_oid [Integer]
5869
+ # @param email_template_oid [Integer]
5178
5870
  # @param [Hash] opts the optional parameters
5179
- # @return [SfvbCommsSendingDomain]
5180
- def get_sfvb_comms_sending_domain(domain, opts = {})
5181
- data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
5871
+ # @return [SfvbCommsTemplateResponse]
5872
+ def get_sfvb_comms_template(storefront_oid, email_template_oid, opts = {})
5873
+ data, _status_code, _headers = get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid, opts)
5182
5874
  data
5183
5875
  end
5184
5876
 
5185
- # Read a sending domain
5186
- # One sending domain as stored. To check an amazon domain&#39;s DNS again, use the status call.
5187
- # @param domain [String]
5877
+ # Read one saved email template&#39;s body
5878
+ # A system template or one saved on this storefront; any other is 404. container_cjson is the body. The Velocity template it renders inside is named in email_template_vm_path, not shown. Read only.
5879
+ # @param storefront_oid [Integer]
5880
+ # @param email_template_oid [Integer]
5188
5881
  # @param [Hash] opts the optional parameters
5189
- # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
5190
- def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
5882
+ # @return [Array<(SfvbCommsTemplateResponse, Integer, Hash)>] SfvbCommsTemplateResponse data, response status code and response headers
5883
+ def get_sfvb_comms_template_with_http_info(storefront_oid, email_template_oid, opts = {})
5191
5884
  if @api_client.config.debugging
5192
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
5885
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_template ...'
5193
5886
  end
5194
- # verify the required parameter 'domain' is set
5195
- if @api_client.config.client_side_validation && domain.nil?
5196
- fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
5887
+ # verify the required parameter 'storefront_oid' is set
5888
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5889
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_template"
5890
+ end
5891
+ # verify the required parameter 'email_template_oid' is set
5892
+ if @api_client.config.client_side_validation && email_template_oid.nil?
5893
+ fail ArgumentError, "Missing the required parameter 'email_template_oid' when calling SfvbApi.get_sfvb_comms_template"
5197
5894
  end
5198
5895
  # resource path
5199
- local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
5896
+ 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))
5200
5897
 
5201
5898
  # query parameters
5202
5899
  query_params = opts[:query_params] || {}
@@ -5214,13 +5911,13 @@ module UltracartClient
5214
5911
  post_body = opts[:debug_body]
5215
5912
 
5216
5913
  # return_type
5217
- return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
5914
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplateResponse'
5218
5915
 
5219
5916
  # auth_names
5220
5917
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5221
5918
 
5222
5919
  new_options = opts.merge(
5223
- :operation => :"SfvbApi.get_sfvb_comms_sending_domain",
5920
+ :operation => :"SfvbApi.get_sfvb_comms_template",
5224
5921
  :header_params => header_params,
5225
5922
  :query_params => query_params,
5226
5923
  :form_params => form_params,
@@ -5231,30 +5928,36 @@ module UltracartClient
5231
5928
 
5232
5929
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5233
5930
  if @api_client.config.debugging
5234
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5931
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5235
5932
  end
5236
5933
  return data, status_code, headers
5237
5934
  end
5238
5935
 
5239
- # List the sending domains
5240
- # 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.
5936
+ # List the email templates a new email can start from
5937
+ # 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.
5938
+ # @param storefront_oid [Integer]
5241
5939
  # @param [Hash] opts the optional parameters
5242
- # @return [SfvbCommsSendingDomainsResponse]
5243
- def get_sfvb_comms_sending_domains(opts = {})
5244
- data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
5940
+ # @return [SfvbCommsTemplatesResponse]
5941
+ def get_sfvb_comms_templates(storefront_oid, opts = {})
5942
+ data, _status_code, _headers = get_sfvb_comms_templates_with_http_info(storefront_oid, opts)
5245
5943
  data
5246
5944
  end
5247
5945
 
5248
- # List the sending domains
5249
- # 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.
5946
+ # List the email templates a new email can start from
5947
+ # 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.
5948
+ # @param storefront_oid [Integer]
5250
5949
  # @param [Hash] opts the optional parameters
5251
- # @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
5252
- def get_sfvb_comms_sending_domains_with_http_info(opts = {})
5950
+ # @return [Array<(SfvbCommsTemplatesResponse, Integer, Hash)>] SfvbCommsTemplatesResponse data, response status code and response headers
5951
+ def get_sfvb_comms_templates_with_http_info(storefront_oid, opts = {})
5253
5952
  if @api_client.config.debugging
5254
- @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
5953
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_templates ...'
5954
+ end
5955
+ # verify the required parameter 'storefront_oid' is set
5956
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5957
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_templates"
5255
5958
  end
5256
5959
  # resource path
5257
- local_var_path = '/sfvb/comms/sending_domains'
5960
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/templates'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5258
5961
 
5259
5962
  # query parameters
5260
5963
  query_params = opts[:query_params] || {}
@@ -5272,13 +5975,13 @@ module UltracartClient
5272
5975
  post_body = opts[:debug_body]
5273
5976
 
5274
5977
  # return_type
5275
- return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
5978
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplatesResponse'
5276
5979
 
5277
5980
  # auth_names
5278
5981
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5279
5982
 
5280
5983
  new_options = opts.merge(
5281
- :operation => :"SfvbApi.get_sfvb_comms_sending_domains",
5984
+ :operation => :"SfvbApi.get_sfvb_comms_templates",
5282
5985
  :header_params => header_params,
5283
5986
  :query_params => query_params,
5284
5987
  :form_params => form_params,
@@ -5289,7 +5992,7 @@ module UltracartClient
5289
5992
 
5290
5993
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5291
5994
  if @api_client.config.debugging
5292
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5995
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5293
5996
  end
5294
5997
  return data, status_code, headers
5295
5998
  end
@@ -7655,6 +8358,85 @@ module UltracartClient
7655
8358
  return data, status_code, headers
7656
8359
  end
7657
8360
 
8361
+ # Read one page of the cards mailed for a postcard
8362
+ # Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
8363
+ # @param storefront_oid [Integer]
8364
+ # @param postcard_uuid [String]
8365
+ # @param [Hash] opts the optional parameters
8366
+ # @option opts [Integer] :page The page, from 1
8367
+ # @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
8368
+ # @option opts [Boolean] :show_customer_data True to return the recipients&#39; real names and street addresses
8369
+ # @return [SfvbPostcardTrackingResponse]
8370
+ def get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts = {})
8371
+ data, _status_code, _headers = get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
8372
+ data
8373
+ end
8374
+
8375
+ # Read one page of the cards mailed for a postcard
8376
+ # Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor&#39;s status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant&#39;s own. Read only.
8377
+ # @param storefront_oid [Integer]
8378
+ # @param postcard_uuid [String]
8379
+ # @param [Hash] opts the optional parameters
8380
+ # @option opts [Integer] :page The page, from 1
8381
+ # @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
8382
+ # @option opts [Boolean] :show_customer_data True to return the recipients&#39; real names and street addresses
8383
+ # @return [Array<(SfvbPostcardTrackingResponse, Integer, Hash)>] SfvbPostcardTrackingResponse data, response status code and response headers
8384
+ def get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts = {})
8385
+ if @api_client.config.debugging
8386
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_postcard_tracking ...'
8387
+ end
8388
+ # verify the required parameter 'storefront_oid' is set
8389
+ if @api_client.config.client_side_validation && storefront_oid.nil?
8390
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_postcard_tracking"
8391
+ end
8392
+ # verify the required parameter 'postcard_uuid' is set
8393
+ if @api_client.config.client_side_validation && postcard_uuid.nil?
8394
+ fail ArgumentError, "Missing the required parameter 'postcard_uuid' when calling SfvbApi.get_sfvb_postcard_tracking"
8395
+ end
8396
+ # resource path
8397
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'postcard_uuid' + '}', CGI.escape(postcard_uuid.to_s))
8398
+
8399
+ # query parameters
8400
+ query_params = opts[:query_params] || {}
8401
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
8402
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
8403
+ query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
8404
+
8405
+ # header parameters
8406
+ header_params = opts[:header_params] || {}
8407
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
8408
+ # HTTP header 'Accept' (if needed)
8409
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8410
+
8411
+ # form parameters
8412
+ form_params = opts[:form_params] || {}
8413
+
8414
+ # http body (model)
8415
+ post_body = opts[:debug_body]
8416
+
8417
+ # return_type
8418
+ return_type = opts[:debug_return_type] || 'SfvbPostcardTrackingResponse'
8419
+
8420
+ # auth_names
8421
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
8422
+
8423
+ new_options = opts.merge(
8424
+ :operation => :"SfvbApi.get_sfvb_postcard_tracking",
8425
+ :header_params => header_params,
8426
+ :query_params => query_params,
8427
+ :form_params => form_params,
8428
+ :body => post_body,
8429
+ :auth_names => auth_names,
8430
+ :return_type => return_type
8431
+ )
8432
+
8433
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
8434
+ if @api_client.config.debugging
8435
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8436
+ end
8437
+ return data, status_code, headers
8438
+ end
8439
+
7658
8440
  # URL that renders a preview session
7659
8441
  # Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
7660
8442
  # @param storefront_oid [Integer]
@@ -9364,6 +10146,76 @@ module UltracartClient
9364
10146
  return data, status_code, headers
9365
10147
  end
9366
10148
 
10149
+ # Read a transactional email's subject, delivery options and sender
10150
+ # file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
10151
+ # @param storefront_oid [Integer]
10152
+ # @param file_name [String]
10153
+ # @param [Hash] opts the optional parameters
10154
+ # @return [SfvbTransactionalEmailResponse]
10155
+ def get_sfvb_transactional_email(storefront_oid, file_name, opts = {})
10156
+ data, _status_code, _headers = get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts)
10157
+ data
10158
+ end
10159
+
10160
+ # Read a transactional email&#39;s subject, delivery options and sender
10161
+ # file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant&#39;s own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
10162
+ # @param storefront_oid [Integer]
10163
+ # @param file_name [String]
10164
+ # @param [Hash] opts the optional parameters
10165
+ # @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
10166
+ def get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts = {})
10167
+ if @api_client.config.debugging
10168
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_transactional_email ...'
10169
+ end
10170
+ # verify the required parameter 'storefront_oid' is set
10171
+ if @api_client.config.client_side_validation && storefront_oid.nil?
10172
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_transactional_email"
10173
+ end
10174
+ # verify the required parameter 'file_name' is set
10175
+ if @api_client.config.client_side_validation && file_name.nil?
10176
+ fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.get_sfvb_transactional_email"
10177
+ end
10178
+ # resource path
10179
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
10180
+
10181
+ # query parameters
10182
+ query_params = opts[:query_params] || {}
10183
+
10184
+ # header parameters
10185
+ header_params = opts[:header_params] || {}
10186
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10187
+ # HTTP header 'Accept' (if needed)
10188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10189
+
10190
+ # form parameters
10191
+ form_params = opts[:form_params] || {}
10192
+
10193
+ # http body (model)
10194
+ post_body = opts[:debug_body]
10195
+
10196
+ # return_type
10197
+ return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
10198
+
10199
+ # auth_names
10200
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10201
+
10202
+ new_options = opts.merge(
10203
+ :operation => :"SfvbApi.get_sfvb_transactional_email",
10204
+ :header_params => header_params,
10205
+ :query_params => query_params,
10206
+ :form_params => form_params,
10207
+ :body => post_body,
10208
+ :auth_names => auth_names,
10209
+ :return_type => return_type
10210
+ )
10211
+
10212
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
10213
+ if @api_client.config.debugging
10214
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10215
+ end
10216
+ return data, status_code, headers
10217
+ end
10218
+
9367
10219
  # List the transactional emails a storefront sends
9368
10220
  # The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
9369
10221
  # @param storefront_oid [Integer]
@@ -9864,18 +10716,90 @@ module UltracartClient
9864
10716
  # @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
9865
10717
  def ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
9866
10718
  if @api_client.config.debugging
9867
- @api_client.config.logger.debug 'Calling API: SfvbApi.ignore_sfvb_not_found_entry ...'
10719
+ @api_client.config.logger.debug 'Calling API: SfvbApi.ignore_sfvb_not_found_entry ...'
10720
+ end
10721
+ # verify the required parameter 'storefront_oid' is set
10722
+ if @api_client.config.client_side_validation && storefront_oid.nil?
10723
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.ignore_sfvb_not_found_entry"
10724
+ end
10725
+ # verify the required parameter 'not_found_id' is set
10726
+ if @api_client.config.client_side_validation && not_found_id.nil?
10727
+ fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.ignore_sfvb_not_found_entry"
10728
+ end
10729
+ # resource path
10730
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
10731
+
10732
+ # query parameters
10733
+ query_params = opts[:query_params] || {}
10734
+
10735
+ # header parameters
10736
+ header_params = opts[:header_params] || {}
10737
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10738
+ # HTTP header 'Accept' (if needed)
10739
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10740
+
10741
+ # form parameters
10742
+ form_params = opts[:form_params] || {}
10743
+
10744
+ # http body (model)
10745
+ post_body = opts[:debug_body]
10746
+
10747
+ # return_type
10748
+ return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
10749
+
10750
+ # auth_names
10751
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10752
+
10753
+ new_options = opts.merge(
10754
+ :operation => :"SfvbApi.ignore_sfvb_not_found_entry",
10755
+ :header_params => header_params,
10756
+ :query_params => query_params,
10757
+ :form_params => form_params,
10758
+ :body => post_body,
10759
+ :auth_names => auth_names,
10760
+ :return_type => return_type
10761
+ )
10762
+
10763
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10764
+ if @api_client.config.debugging
10765
+ @api_client.config.logger.debug "API called: SfvbApi#ignore_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10766
+ end
10767
+ return data, status_code, headers
10768
+ end
10769
+
10770
+ # Import lists from another email provider
10771
+ # 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.
10772
+ # @param storefront_oid [Integer]
10773
+ # @param provider_import_request [SfvbCommsProviderImportRequest] The provider and lists to import
10774
+ # @param [Hash] opts the optional parameters
10775
+ # @option opts [String] :approval_id The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals.
10776
+ # @return [SfvbCommsProviderImportResponse]
10777
+ def import_sfvb_comms_provider_lists(storefront_oid, provider_import_request, opts = {})
10778
+ data, _status_code, _headers = import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts)
10779
+ data
10780
+ end
10781
+
10782
+ # Import lists from another email provider
10783
+ # 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.
10784
+ # @param storefront_oid [Integer]
10785
+ # @param provider_import_request [SfvbCommsProviderImportRequest] The provider and lists to import
10786
+ # @param [Hash] opts the optional parameters
10787
+ # @option opts [String] :approval_id The approval_id of an approved comms_list.import request for exactly these lists. See POST /sfvb/approvals.
10788
+ # @return [Array<(SfvbCommsProviderImportResponse, Integer, Hash)>] SfvbCommsProviderImportResponse data, response status code and response headers
10789
+ def import_sfvb_comms_provider_lists_with_http_info(storefront_oid, provider_import_request, opts = {})
10790
+ if @api_client.config.debugging
10791
+ @api_client.config.logger.debug 'Calling API: SfvbApi.import_sfvb_comms_provider_lists ...'
9868
10792
  end
9869
10793
  # verify the required parameter 'storefront_oid' is set
9870
10794
  if @api_client.config.client_side_validation && storefront_oid.nil?
9871
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.ignore_sfvb_not_found_entry"
10795
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.import_sfvb_comms_provider_lists"
9872
10796
  end
9873
- # verify the required parameter 'not_found_id' is set
9874
- if @api_client.config.client_side_validation && not_found_id.nil?
9875
- fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.ignore_sfvb_not_found_entry"
10797
+ # verify the required parameter 'provider_import_request' is set
10798
+ if @api_client.config.client_side_validation && provider_import_request.nil?
10799
+ fail ArgumentError, "Missing the required parameter 'provider_import_request' when calling SfvbApi.import_sfvb_comms_provider_lists"
9876
10800
  end
9877
10801
  # resource path
9878
- local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/ignore'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
10802
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/providers/import'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
9879
10803
 
9880
10804
  # query parameters
9881
10805
  query_params = opts[:query_params] || {}
@@ -9885,21 +10809,27 @@ module UltracartClient
9885
10809
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
9886
10810
  # HTTP header 'Accept' (if needed)
9887
10811
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10812
+ # HTTP header 'Content-Type'
10813
+ content_type = @api_client.select_header_content_type(['application/json'])
10814
+ if !content_type.nil?
10815
+ header_params['Content-Type'] = content_type
10816
+ end
10817
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
9888
10818
 
9889
10819
  # form parameters
9890
10820
  form_params = opts[:form_params] || {}
9891
10821
 
9892
10822
  # http body (model)
9893
- post_body = opts[:debug_body]
10823
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(provider_import_request)
9894
10824
 
9895
10825
  # return_type
9896
- return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
10826
+ return_type = opts[:debug_return_type] || 'SfvbCommsProviderImportResponse'
9897
10827
 
9898
10828
  # auth_names
9899
10829
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
9900
10830
 
9901
10831
  new_options = opts.merge(
9902
- :operation => :"SfvbApi.ignore_sfvb_not_found_entry",
10832
+ :operation => :"SfvbApi.import_sfvb_comms_provider_lists",
9903
10833
  :header_params => header_params,
9904
10834
  :query_params => query_params,
9905
10835
  :form_params => form_params,
@@ -9910,7 +10840,7 @@ module UltracartClient
9910
10840
 
9911
10841
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9912
10842
  if @api_client.config.debugging
9913
- @api_client.config.logger.debug "API called: SfvbApi#ignore_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10843
+ @api_client.config.logger.debug "API called: SfvbApi#import_sfvb_comms_provider_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9914
10844
  end
9915
10845
  return data, status_code, headers
9916
10846
  end
@@ -16124,35 +17054,282 @@ module UltracartClient
16124
17054
  fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.search_sfvb_library"
16125
17055
  end
16126
17056
  # resource path
16127
- local_var_path = '/sfvb/storefronts/{storefront_oid}/library'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
17057
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/library'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
17058
+
17059
+ # query parameters
17060
+ query_params = opts[:query_params] || {}
17061
+ query_params[:'segment'] = opts[:'segment'] if !opts[:'segment'].nil?
17062
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
17063
+ query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?
17064
+ query_params[:'results_per_page'] = opts[:'results_per_page'] if !opts[:'results_per_page'].nil?
17065
+
17066
+ # header parameters
17067
+ header_params = opts[:header_params] || {}
17068
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17069
+ # HTTP header 'Accept' (if needed)
17070
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17071
+
17072
+ # form parameters
17073
+ form_params = opts[:form_params] || {}
17074
+
17075
+ # http body (model)
17076
+ post_body = opts[:debug_body]
17077
+
17078
+ # return_type
17079
+ return_type = opts[:debug_return_type] || 'SfvbLibraryResponse'
17080
+
17081
+ # auth_names
17082
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17083
+
17084
+ new_options = opts.merge(
17085
+ :operation => :"SfvbApi.search_sfvb_library",
17086
+ :header_params => header_params,
17087
+ :query_params => query_params,
17088
+ :form_params => form_params,
17089
+ :body => post_body,
17090
+ :auth_names => auth_names,
17091
+ :return_type => return_type
17092
+ )
17093
+
17094
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
17095
+ if @api_client.config.debugging
17096
+ @api_client.config.logger.debug "API called: SfvbApi#search_sfvb_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17097
+ end
17098
+ return data, status_code, headers
17099
+ end
17100
+
17101
+ # Set a library entry's screenshot
17102
+ # Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft's hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
17103
+ # @param storefront_oid [Integer]
17104
+ # @param library_oid [Integer]
17105
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
17106
+ # @param screenshot_request [SfvbLibraryScreenshotRequest] The staged PNG
17107
+ # @param [Hash] opts the optional parameters
17108
+ # @return [SfvbLibraryEntry]
17109
+ def set_sfvb_library_screenshot(storefront_oid, library_oid, if_match, screenshot_request, opts = {})
17110
+ data, _status_code, _headers = set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request, opts)
17111
+ data
17112
+ end
17113
+
17114
+ # Set a library entry&#39;s screenshot
17115
+ # Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft&#39;s hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
17116
+ # @param storefront_oid [Integer]
17117
+ # @param library_oid [Integer]
17118
+ # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
17119
+ # @param screenshot_request [SfvbLibraryScreenshotRequest] The staged PNG
17120
+ # @param [Hash] opts the optional parameters
17121
+ # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
17122
+ def set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request, opts = {})
17123
+ if @api_client.config.debugging
17124
+ @api_client.config.logger.debug 'Calling API: SfvbApi.set_sfvb_library_screenshot ...'
17125
+ end
17126
+ # verify the required parameter 'storefront_oid' is set
17127
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17128
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17129
+ end
17130
+ # verify the required parameter 'library_oid' is set
17131
+ if @api_client.config.client_side_validation && library_oid.nil?
17132
+ fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17133
+ end
17134
+ # verify the required parameter 'if_match' is set
17135
+ if @api_client.config.client_side_validation && if_match.nil?
17136
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.set_sfvb_library_screenshot"
17137
+ end
17138
+ # verify the required parameter 'screenshot_request' is set
17139
+ if @api_client.config.client_side_validation && screenshot_request.nil?
17140
+ fail ArgumentError, "Missing the required parameter 'screenshot_request' when calling SfvbApi.set_sfvb_library_screenshot"
17141
+ end
17142
+ # resource path
17143
+ 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))
17144
+
17145
+ # query parameters
17146
+ query_params = opts[:query_params] || {}
17147
+
17148
+ # header parameters
17149
+ header_params = opts[:header_params] || {}
17150
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17151
+ # HTTP header 'Accept' (if needed)
17152
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17153
+ # HTTP header 'Content-Type'
17154
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17155
+ if !content_type.nil?
17156
+ header_params['Content-Type'] = content_type
17157
+ end
17158
+ header_params[:'If-Match'] = if_match
17159
+
17160
+ # form parameters
17161
+ form_params = opts[:form_params] || {}
17162
+
17163
+ # http body (model)
17164
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(screenshot_request)
17165
+
17166
+ # return_type
17167
+ return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
17168
+
17169
+ # auth_names
17170
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17171
+
17172
+ new_options = opts.merge(
17173
+ :operation => :"SfvbApi.set_sfvb_library_screenshot",
17174
+ :header_params => header_params,
17175
+ :query_params => query_params,
17176
+ :form_params => form_params,
17177
+ :body => post_body,
17178
+ :auth_names => auth_names,
17179
+ :return_type => return_type
17180
+ )
17181
+
17182
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17183
+ if @api_client.config.debugging
17184
+ @api_client.config.logger.debug "API called: SfvbApi#set_sfvb_library_screenshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17185
+ end
17186
+ return data, status_code, headers
17187
+ end
17188
+
17189
+ # Share a published library entry with a linked account
17190
+ # 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.
17191
+ # @param storefront_oid [Integer]
17192
+ # @param library_oid [Integer]
17193
+ # @param share_request [SfvbLibraryShareRequest] The linked account
17194
+ # @param [Hash] opts the optional parameters
17195
+ # @return [SfvbLibraryEntry]
17196
+ def share_sfvb_library_entry(storefront_oid, library_oid, share_request, opts = {})
17197
+ data, _status_code, _headers = share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts)
17198
+ data
17199
+ end
17200
+
17201
+ # Share a published library entry with a linked account
17202
+ # 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.
17203
+ # @param storefront_oid [Integer]
17204
+ # @param library_oid [Integer]
17205
+ # @param share_request [SfvbLibraryShareRequest] The linked account
17206
+ # @param [Hash] opts the optional parameters
17207
+ # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
17208
+ def share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts = {})
17209
+ if @api_client.config.debugging
17210
+ @api_client.config.logger.debug 'Calling API: SfvbApi.share_sfvb_library_entry ...'
17211
+ end
17212
+ # verify the required parameter 'storefront_oid' is set
17213
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17214
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.share_sfvb_library_entry"
17215
+ end
17216
+ # verify the required parameter 'library_oid' is set
17217
+ if @api_client.config.client_side_validation && library_oid.nil?
17218
+ fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.share_sfvb_library_entry"
17219
+ end
17220
+ # verify the required parameter 'share_request' is set
17221
+ if @api_client.config.client_side_validation && share_request.nil?
17222
+ fail ArgumentError, "Missing the required parameter 'share_request' when calling SfvbApi.share_sfvb_library_entry"
17223
+ end
17224
+ # resource path
17225
+ 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))
17226
+
17227
+ # query parameters
17228
+ query_params = opts[:query_params] || {}
17229
+
17230
+ # header parameters
17231
+ header_params = opts[:header_params] || {}
17232
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17233
+ # HTTP header 'Accept' (if needed)
17234
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17235
+ # HTTP header 'Content-Type'
17236
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17237
+ if !content_type.nil?
17238
+ header_params['Content-Type'] = content_type
17239
+ end
17240
+
17241
+ # form parameters
17242
+ form_params = opts[:form_params] || {}
17243
+
17244
+ # http body (model)
17245
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(share_request)
17246
+
17247
+ # return_type
17248
+ return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
17249
+
17250
+ # auth_names
17251
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17252
+
17253
+ new_options = opts.merge(
17254
+ :operation => :"SfvbApi.share_sfvb_library_entry",
17255
+ :header_params => header_params,
17256
+ :query_params => query_params,
17257
+ :form_params => form_params,
17258
+ :body => post_body,
17259
+ :auth_names => auth_names,
17260
+ :return_type => return_type
17261
+ )
17262
+
17263
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17264
+ if @api_client.config.debugging
17265
+ @api_client.config.logger.debug "API called: SfvbApi#share_sfvb_library_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17266
+ end
17267
+ return data, status_code, headers
17268
+ end
17269
+
17270
+ # Start an experiment
17271
+ # 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).
17272
+ # @param storefront_oid [Integer]
17273
+ # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
17274
+ # @param [Hash] opts the optional parameters
17275
+ # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
17276
+ # @return [SfvbExperiment]
17277
+ def start_sfvb_experiment(storefront_oid, experiment_start_request, opts = {})
17278
+ data, _status_code, _headers = start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
17279
+ data
17280
+ end
17281
+
17282
+ # Start an experiment
17283
+ # 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).
17284
+ # @param storefront_oid [Integer]
17285
+ # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
17286
+ # @param [Hash] opts the optional parameters
17287
+ # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
17288
+ # @return [Array<(SfvbExperiment, Integer, Hash)>] SfvbExperiment data, response status code and response headers
17289
+ def start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts = {})
17290
+ if @api_client.config.debugging
17291
+ @api_client.config.logger.debug 'Calling API: SfvbApi.start_sfvb_experiment ...'
17292
+ end
17293
+ # verify the required parameter 'storefront_oid' is set
17294
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17295
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.start_sfvb_experiment"
17296
+ end
17297
+ # verify the required parameter 'experiment_start_request' is set
17298
+ if @api_client.config.client_side_validation && experiment_start_request.nil?
17299
+ fail ArgumentError, "Missing the required parameter 'experiment_start_request' when calling SfvbApi.start_sfvb_experiment"
17300
+ end
17301
+ # resource path
17302
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/experiments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
16128
17303
 
16129
17304
  # query parameters
16130
17305
  query_params = opts[:query_params] || {}
16131
- query_params[:'segment'] = opts[:'segment'] if !opts[:'segment'].nil?
16132
- query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
16133
- query_params[:'page_number'] = opts[:'page_number'] if !opts[:'page_number'].nil?
16134
- query_params[:'results_per_page'] = opts[:'results_per_page'] if !opts[:'results_per_page'].nil?
16135
17306
 
16136
17307
  # header parameters
16137
17308
  header_params = opts[:header_params] || {}
16138
17309
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
16139
17310
  # HTTP header 'Accept' (if needed)
16140
17311
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17312
+ # HTTP header 'Content-Type'
17313
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17314
+ if !content_type.nil?
17315
+ header_params['Content-Type'] = content_type
17316
+ end
17317
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16141
17318
 
16142
17319
  # form parameters
16143
17320
  form_params = opts[:form_params] || {}
16144
17321
 
16145
17322
  # http body (model)
16146
- post_body = opts[:debug_body]
17323
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(experiment_start_request)
16147
17324
 
16148
17325
  # return_type
16149
- return_type = opts[:debug_return_type] || 'SfvbLibraryResponse'
17326
+ return_type = opts[:debug_return_type] || 'SfvbExperiment'
16150
17327
 
16151
17328
  # auth_names
16152
17329
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16153
17330
 
16154
17331
  new_options = opts.merge(
16155
- :operation => :"SfvbApi.search_sfvb_library",
17332
+ :operation => :"SfvbApi.start_sfvb_experiment",
16156
17333
  :header_params => header_params,
16157
17334
  :query_params => query_params,
16158
17335
  :form_params => form_params,
@@ -16161,56 +17338,56 @@ module UltracartClient
16161
17338
  :return_type => return_type
16162
17339
  )
16163
17340
 
16164
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
17341
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16165
17342
  if @api_client.config.debugging
16166
- @api_client.config.logger.debug "API called: SfvbApi#search_sfvb_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17343
+ @api_client.config.logger.debug "API called: SfvbApi#start_sfvb_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16167
17344
  end
16168
17345
  return data, status_code, headers
16169
17346
  end
16170
17347
 
16171
- # Set a library entry's screenshot
16172
- # Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft's hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
17348
+ # Send one test of an email step's email to a user on this account
17349
+ # 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.
16173
17350
  # @param storefront_oid [Integer]
16174
- # @param library_oid [Integer]
16175
- # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
16176
- # @param screenshot_request [SfvbLibraryScreenshotRequest] The staged PNG
17351
+ # @param commseq_uuid [String]
17352
+ # @param step_uuid [String]
17353
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
16177
17354
  # @param [Hash] opts the optional parameters
16178
- # @return [SfvbLibraryEntry]
16179
- def set_sfvb_library_screenshot(storefront_oid, library_oid, if_match, screenshot_request, opts = {})
16180
- data, _status_code, _headers = set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request, opts)
17355
+ # @return [SfvbCommsTestSendResponse]
17356
+ def test_sfvb_comms_email(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts = {})
17357
+ data, _status_code, _headers = test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts)
16181
17358
  data
16182
17359
  end
16183
17360
 
16184
- # Set a library entry&#39;s screenshot
16185
- # Three calls, like the other uploads. Request an upload URL with files/upload_url/png, PUT the PNG bytes to it, then call this with the key, the sha256 of those bytes and where the image came from. Owner only, with the draft&#39;s hash_sha256 as If-Match. The PNG must be at most 5 MB and 4096 pixels a side; it is re-encoded, which drops any metadata, and a thumbnail is made from it before this returns. Capture it with test data only. A refused image leaves the previous screenshot in place. Other merchants see a new screenshot only after the next publish, whose review checks it.
17361
+ # Send one test of an email step&#39;s email to a user on this account
17362
+ # 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.
16186
17363
  # @param storefront_oid [Integer]
16187
- # @param library_oid [Integer]
16188
- # @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
16189
- # @param screenshot_request [SfvbLibraryScreenshotRequest] The staged PNG
17364
+ # @param commseq_uuid [String]
17365
+ # @param step_uuid [String]
17366
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
16190
17367
  # @param [Hash] opts the optional parameters
16191
- # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
16192
- def set_sfvb_library_screenshot_with_http_info(storefront_oid, library_oid, if_match, screenshot_request, opts = {})
17368
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
17369
+ def test_sfvb_comms_email_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_email_request, opts = {})
16193
17370
  if @api_client.config.debugging
16194
- @api_client.config.logger.debug 'Calling API: SfvbApi.set_sfvb_library_screenshot ...'
17371
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_email ...'
16195
17372
  end
16196
17373
  # verify the required parameter 'storefront_oid' is set
16197
17374
  if @api_client.config.client_side_validation && storefront_oid.nil?
16198
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17375
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_email"
16199
17376
  end
16200
- # verify the required parameter 'library_oid' is set
16201
- if @api_client.config.client_side_validation && library_oid.nil?
16202
- fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.set_sfvb_library_screenshot"
17377
+ # verify the required parameter 'commseq_uuid' is set
17378
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
17379
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_email"
16203
17380
  end
16204
- # verify the required parameter 'if_match' is set
16205
- if @api_client.config.client_side_validation && if_match.nil?
16206
- fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.set_sfvb_library_screenshot"
17381
+ # verify the required parameter 'step_uuid' is set
17382
+ if @api_client.config.client_side_validation && step_uuid.nil?
17383
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_email"
16207
17384
  end
16208
- # verify the required parameter 'screenshot_request' is set
16209
- if @api_client.config.client_side_validation && screenshot_request.nil?
16210
- fail ArgumentError, "Missing the required parameter 'screenshot_request' when calling SfvbApi.set_sfvb_library_screenshot"
17385
+ # verify the required parameter 'test_email_request' is set
17386
+ if @api_client.config.client_side_validation && test_email_request.nil?
17387
+ fail ArgumentError, "Missing the required parameter 'test_email_request' when calling SfvbApi.test_sfvb_comms_email"
16211
17388
  end
16212
17389
  # resource path
16213
- 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))
17390
+ 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))
16214
17391
 
16215
17392
  # query parameters
16216
17393
  query_params = opts[:query_params] || {}
@@ -16221,26 +17398,25 @@ module UltracartClient
16221
17398
  # HTTP header 'Accept' (if needed)
16222
17399
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16223
17400
  # HTTP header 'Content-Type'
16224
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17401
+ content_type = @api_client.select_header_content_type(['application/json'])
16225
17402
  if !content_type.nil?
16226
17403
  header_params['Content-Type'] = content_type
16227
17404
  end
16228
- header_params[:'If-Match'] = if_match
16229
17405
 
16230
17406
  # form parameters
16231
17407
  form_params = opts[:form_params] || {}
16232
17408
 
16233
17409
  # http body (model)
16234
- post_body = opts[:debug_body] || @api_client.object_to_http_body(screenshot_request)
17410
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_email_request)
16235
17411
 
16236
17412
  # return_type
16237
- return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
17413
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16238
17414
 
16239
17415
  # auth_names
16240
17416
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16241
17417
 
16242
17418
  new_options = opts.merge(
16243
- :operation => :"SfvbApi.set_sfvb_library_screenshot",
17419
+ :operation => :"SfvbApi.test_sfvb_comms_email",
16244
17420
  :header_params => header_params,
16245
17421
  :query_params => query_params,
16246
17422
  :form_params => form_params,
@@ -16249,50 +17425,58 @@ module UltracartClient
16249
17425
  :return_type => return_type
16250
17426
  )
16251
17427
 
16252
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
17428
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16253
17429
  if @api_client.config.debugging
16254
- @api_client.config.logger.debug "API called: SfvbApi#set_sfvb_library_screenshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17430
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16255
17431
  end
16256
17432
  return data, status_code, headers
16257
17433
  end
16258
17434
 
16259
- # Share a published library entry with a linked account
16260
- # 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.
17435
+ # Print and mail one real test postcard
17436
+ # 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.
16261
17437
  # @param storefront_oid [Integer]
16262
- # @param library_oid [Integer]
16263
- # @param share_request [SfvbLibraryShareRequest] The linked account
17438
+ # @param commseq_uuid [String]
17439
+ # @param step_uuid [String]
17440
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
16264
17441
  # @param [Hash] opts the optional parameters
16265
- # @return [SfvbLibraryEntry]
16266
- def share_sfvb_library_entry(storefront_oid, library_oid, share_request, opts = {})
16267
- data, _status_code, _headers = share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts)
17442
+ # @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.
17443
+ # @return [SfvbCommsTestSendResponse]
17444
+ def test_sfvb_comms_postcard(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts = {})
17445
+ data, _status_code, _headers = test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts)
16268
17446
  data
16269
17447
  end
16270
17448
 
16271
- # Share a published library entry with a linked account
16272
- # 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.
17449
+ # Print and mail one real test postcard
17450
+ # 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.
16273
17451
  # @param storefront_oid [Integer]
16274
- # @param library_oid [Integer]
16275
- # @param share_request [SfvbLibraryShareRequest] The linked account
17452
+ # @param commseq_uuid [String]
17453
+ # @param step_uuid [String]
17454
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
16276
17455
  # @param [Hash] opts the optional parameters
16277
- # @return [Array<(SfvbLibraryEntry, Integer, Hash)>] SfvbLibraryEntry data, response status code and response headers
16278
- def share_sfvb_library_entry_with_http_info(storefront_oid, library_oid, share_request, opts = {})
17456
+ # @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.
17457
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
17458
+ def test_sfvb_comms_postcard_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_postcard_request, opts = {})
16279
17459
  if @api_client.config.debugging
16280
- @api_client.config.logger.debug 'Calling API: SfvbApi.share_sfvb_library_entry ...'
17460
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_postcard ...'
16281
17461
  end
16282
17462
  # verify the required parameter 'storefront_oid' is set
16283
17463
  if @api_client.config.client_side_validation && storefront_oid.nil?
16284
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.share_sfvb_library_entry"
17464
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_postcard"
16285
17465
  end
16286
- # verify the required parameter 'library_oid' is set
16287
- if @api_client.config.client_side_validation && library_oid.nil?
16288
- fail ArgumentError, "Missing the required parameter 'library_oid' when calling SfvbApi.share_sfvb_library_entry"
17466
+ # verify the required parameter 'commseq_uuid' is set
17467
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
17468
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_postcard"
16289
17469
  end
16290
- # verify the required parameter 'share_request' is set
16291
- if @api_client.config.client_side_validation && share_request.nil?
16292
- fail ArgumentError, "Missing the required parameter 'share_request' when calling SfvbApi.share_sfvb_library_entry"
17470
+ # verify the required parameter 'step_uuid' is set
17471
+ if @api_client.config.client_side_validation && step_uuid.nil?
17472
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_postcard"
17473
+ end
17474
+ # verify the required parameter 'test_postcard_request' is set
17475
+ if @api_client.config.client_side_validation && test_postcard_request.nil?
17476
+ fail ArgumentError, "Missing the required parameter 'test_postcard_request' when calling SfvbApi.test_sfvb_comms_postcard"
16293
17477
  end
16294
17478
  # resource path
16295
- 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))
17479
+ 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))
16296
17480
 
16297
17481
  # query parameters
16298
17482
  query_params = opts[:query_params] || {}
@@ -16303,25 +17487,26 @@ module UltracartClient
16303
17487
  # HTTP header 'Accept' (if needed)
16304
17488
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16305
17489
  # HTTP header 'Content-Type'
16306
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17490
+ content_type = @api_client.select_header_content_type(['application/json'])
16307
17491
  if !content_type.nil?
16308
17492
  header_params['Content-Type'] = content_type
16309
17493
  end
17494
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16310
17495
 
16311
17496
  # form parameters
16312
17497
  form_params = opts[:form_params] || {}
16313
17498
 
16314
17499
  # http body (model)
16315
- post_body = opts[:debug_body] || @api_client.object_to_http_body(share_request)
17500
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_postcard_request)
16316
17501
 
16317
17502
  # return_type
16318
- return_type = opts[:debug_return_type] || 'SfvbLibraryEntry'
17503
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16319
17504
 
16320
17505
  # auth_names
16321
17506
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16322
17507
 
16323
17508
  new_options = opts.merge(
16324
- :operation => :"SfvbApi.share_sfvb_library_entry",
17509
+ :operation => :"SfvbApi.test_sfvb_comms_postcard",
16325
17510
  :header_params => header_params,
16326
17511
  :query_params => query_params,
16327
17512
  :form_params => form_params,
@@ -16332,44 +17517,54 @@ module UltracartClient
16332
17517
 
16333
17518
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16334
17519
  if @api_client.config.debugging
16335
- @api_client.config.logger.debug "API called: SfvbApi#share_sfvb_library_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17520
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16336
17521
  end
16337
17522
  return data, status_code, headers
16338
17523
  end
16339
17524
 
16340
- # Start an experiment
16341
- # 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).
17525
+ # Send one test of an SMS step to a user on this account
17526
+ # 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.
16342
17527
  # @param storefront_oid [Integer]
16343
- # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
17528
+ # @param commseq_uuid [String]
17529
+ # @param step_uuid [String]
17530
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
16344
17531
  # @param [Hash] opts the optional parameters
16345
- # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
16346
- # @return [SfvbExperiment]
16347
- def start_sfvb_experiment(storefront_oid, experiment_start_request, opts = {})
16348
- data, _status_code, _headers = start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts)
17532
+ # @return [SfvbCommsTestSendResponse]
17533
+ def test_sfvb_comms_sms(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts = {})
17534
+ data, _status_code, _headers = test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts)
16349
17535
  data
16350
17536
  end
16351
17537
 
16352
- # Start an experiment
16353
- # 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).
17538
+ # Send one test of an SMS step to a user on this account
17539
+ # 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.
16354
17540
  # @param storefront_oid [Integer]
16355
- # @param experiment_start_request [SfvbExperimentStartRequest] The experiment to start
17541
+ # @param commseq_uuid [String]
17542
+ # @param step_uuid [String]
17543
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
16356
17544
  # @param [Hash] opts the optional parameters
16357
- # @option opts [String] :approval_id The approval_id of an approved experiment.start request for exactly this start. Required. See POST /sfvb/approvals.
16358
- # @return [Array<(SfvbExperiment, Integer, Hash)>] SfvbExperiment data, response status code and response headers
16359
- def start_sfvb_experiment_with_http_info(storefront_oid, experiment_start_request, opts = {})
17545
+ # @return [Array<(SfvbCommsTestSendResponse, Integer, Hash)>] SfvbCommsTestSendResponse data, response status code and response headers
17546
+ def test_sfvb_comms_sms_with_http_info(storefront_oid, commseq_uuid, step_uuid, test_sms_request, opts = {})
16360
17547
  if @api_client.config.debugging
16361
- @api_client.config.logger.debug 'Calling API: SfvbApi.start_sfvb_experiment ...'
17548
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_sms ...'
16362
17549
  end
16363
17550
  # verify the required parameter 'storefront_oid' is set
16364
17551
  if @api_client.config.client_side_validation && storefront_oid.nil?
16365
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.start_sfvb_experiment"
17552
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_sms"
16366
17553
  end
16367
- # verify the required parameter 'experiment_start_request' is set
16368
- if @api_client.config.client_side_validation && experiment_start_request.nil?
16369
- fail ArgumentError, "Missing the required parameter 'experiment_start_request' when calling SfvbApi.start_sfvb_experiment"
17554
+ # verify the required parameter 'commseq_uuid' is set
17555
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
17556
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling SfvbApi.test_sfvb_comms_sms"
17557
+ end
17558
+ # verify the required parameter 'step_uuid' is set
17559
+ if @api_client.config.client_side_validation && step_uuid.nil?
17560
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.test_sfvb_comms_sms"
17561
+ end
17562
+ # verify the required parameter 'test_sms_request' is set
17563
+ if @api_client.config.client_side_validation && test_sms_request.nil?
17564
+ fail ArgumentError, "Missing the required parameter 'test_sms_request' when calling SfvbApi.test_sfvb_comms_sms"
16370
17565
  end
16371
17566
  # resource path
16372
- local_var_path = '/sfvb/storefronts/{storefront_oid}/experiments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
17567
+ 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))
16373
17568
 
16374
17569
  # query parameters
16375
17570
  query_params = opts[:query_params] || {}
@@ -16380,26 +17575,25 @@ module UltracartClient
16380
17575
  # HTTP header 'Accept' (if needed)
16381
17576
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16382
17577
  # HTTP header 'Content-Type'
16383
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
17578
+ content_type = @api_client.select_header_content_type(['application/json'])
16384
17579
  if !content_type.nil?
16385
17580
  header_params['Content-Type'] = content_type
16386
17581
  end
16387
- header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
16388
17582
 
16389
17583
  # form parameters
16390
17584
  form_params = opts[:form_params] || {}
16391
17585
 
16392
17586
  # http body (model)
16393
- post_body = opts[:debug_body] || @api_client.object_to_http_body(experiment_start_request)
17587
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_sms_request)
16394
17588
 
16395
17589
  # return_type
16396
- return_type = opts[:debug_return_type] || 'SfvbExperiment'
17590
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
16397
17591
 
16398
17592
  # auth_names
16399
17593
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
16400
17594
 
16401
17595
  new_options = opts.merge(
16402
- :operation => :"SfvbApi.start_sfvb_experiment",
17596
+ :operation => :"SfvbApi.test_sfvb_comms_sms",
16403
17597
  :header_params => header_params,
16404
17598
  :query_params => query_params,
16405
17599
  :form_params => form_params,
@@ -16410,7 +17604,7 @@ module UltracartClient
16410
17604
 
16411
17605
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16412
17606
  if @api_client.config.debugging
16413
- @api_client.config.logger.debug "API called: SfvbApi#start_sfvb_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17607
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16414
17608
  end
16415
17609
  return data, status_code, headers
16416
17610
  end
@@ -17384,6 +18578,91 @@ module UltracartClient
17384
18578
  return data, status_code, headers
17385
18579
  end
17386
18580
 
18581
+ # Change a storefront's communications settings
18582
+ # 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.
18583
+ # @param storefront_oid [Integer]
18584
+ # @param if_match [String] The settings&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
18585
+ # @param comms_settings_update_request [SfvbCommsSettingsUpdateRequest] The settings to change
18586
+ # @param [Hash] opts the optional parameters
18587
+ # @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.
18588
+ # @return [SfvbCommsSettingsResponse]
18589
+ def update_sfvb_comms_settings(storefront_oid, if_match, comms_settings_update_request, opts = {})
18590
+ data, _status_code, _headers = update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts)
18591
+ data
18592
+ end
18593
+
18594
+ # Change a storefront&#39;s communications settings
18595
+ # 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.
18596
+ # @param storefront_oid [Integer]
18597
+ # @param if_match [String] The settings&#39; hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
18598
+ # @param comms_settings_update_request [SfvbCommsSettingsUpdateRequest] The settings to change
18599
+ # @param [Hash] opts the optional parameters
18600
+ # @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.
18601
+ # @return [Array<(SfvbCommsSettingsResponse, Integer, Hash)>] SfvbCommsSettingsResponse data, response status code and response headers
18602
+ def update_sfvb_comms_settings_with_http_info(storefront_oid, if_match, comms_settings_update_request, opts = {})
18603
+ if @api_client.config.debugging
18604
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_settings ...'
18605
+ end
18606
+ # verify the required parameter 'storefront_oid' is set
18607
+ if @api_client.config.client_side_validation && storefront_oid.nil?
18608
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_settings"
18609
+ end
18610
+ # verify the required parameter 'if_match' is set
18611
+ if @api_client.config.client_side_validation && if_match.nil?
18612
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_settings"
18613
+ end
18614
+ # verify the required parameter 'comms_settings_update_request' is set
18615
+ if @api_client.config.client_side_validation && comms_settings_update_request.nil?
18616
+ fail ArgumentError, "Missing the required parameter 'comms_settings_update_request' when calling SfvbApi.update_sfvb_comms_settings"
18617
+ end
18618
+ # resource path
18619
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
18620
+
18621
+ # query parameters
18622
+ query_params = opts[:query_params] || {}
18623
+
18624
+ # header parameters
18625
+ header_params = opts[:header_params] || {}
18626
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
18627
+ # HTTP header 'Accept' (if needed)
18628
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
18629
+ # HTTP header 'Content-Type'
18630
+ content_type = @api_client.select_header_content_type(['application/json'])
18631
+ if !content_type.nil?
18632
+ header_params['Content-Type'] = content_type
18633
+ end
18634
+ header_params[:'If-Match'] = if_match
18635
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
18636
+
18637
+ # form parameters
18638
+ form_params = opts[:form_params] || {}
18639
+
18640
+ # http body (model)
18641
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(comms_settings_update_request)
18642
+
18643
+ # return_type
18644
+ return_type = opts[:debug_return_type] || 'SfvbCommsSettingsResponse'
18645
+
18646
+ # auth_names
18647
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
18648
+
18649
+ new_options = opts.merge(
18650
+ :operation => :"SfvbApi.update_sfvb_comms_settings",
18651
+ :header_params => header_params,
18652
+ :query_params => query_params,
18653
+ :form_params => form_params,
18654
+ :body => post_body,
18655
+ :auth_names => auth_names,
18656
+ :return_type => return_type
18657
+ )
18658
+
18659
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
18660
+ if @api_client.config.debugging
18661
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
18662
+ end
18663
+ return data, status_code, headers
18664
+ end
18665
+
17387
18666
  # Update the Twilio account
17388
18667
  # 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.
17389
18668
  # @param twilio_account [SfvbCommsTwilioAccount] The changes
@@ -18584,6 +19863,97 @@ module UltracartClient
18584
19863
  return data, status_code, headers
18585
19864
  end
18586
19865
 
19866
+ # Change a transactional email's subject, delivery options or sender
19867
+ # A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
19868
+ # @param storefront_oid [Integer]
19869
+ # @param file_name [String]
19870
+ # @param if_match [String] The email&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19871
+ # @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
19872
+ # @param [Hash] opts the optional parameters
19873
+ # @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
19874
+ # @return [SfvbTransactionalEmailResponse]
19875
+ def update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
19876
+ data, _status_code, _headers = update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
19877
+ data
19878
+ end
19879
+
19880
+ # Change a transactional email&#39;s subject, delivery options or sender
19881
+ # A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email&#39;s hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant&#39;s own mail server.
19882
+ # @param storefront_oid [Integer]
19883
+ # @param file_name [String]
19884
+ # @param if_match [String] The email&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
19885
+ # @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
19886
+ # @param [Hash] opts the optional parameters
19887
+ # @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
19888
+ # @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
19889
+ def update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
19890
+ if @api_client.config.debugging
19891
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_transactional_email ...'
19892
+ end
19893
+ # verify the required parameter 'storefront_oid' is set
19894
+ if @api_client.config.client_side_validation && storefront_oid.nil?
19895
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_transactional_email"
19896
+ end
19897
+ # verify the required parameter 'file_name' is set
19898
+ if @api_client.config.client_side_validation && file_name.nil?
19899
+ fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.update_sfvb_transactional_email"
19900
+ end
19901
+ # verify the required parameter 'if_match' is set
19902
+ if @api_client.config.client_side_validation && if_match.nil?
19903
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_transactional_email"
19904
+ end
19905
+ # verify the required parameter 'transactional_email_update_request' is set
19906
+ if @api_client.config.client_side_validation && transactional_email_update_request.nil?
19907
+ fail ArgumentError, "Missing the required parameter 'transactional_email_update_request' when calling SfvbApi.update_sfvb_transactional_email"
19908
+ end
19909
+ # resource path
19910
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
19911
+
19912
+ # query parameters
19913
+ query_params = opts[:query_params] || {}
19914
+
19915
+ # header parameters
19916
+ header_params = opts[:header_params] || {}
19917
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
19918
+ # HTTP header 'Accept' (if needed)
19919
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19920
+ # HTTP header 'Content-Type'
19921
+ content_type = @api_client.select_header_content_type(['application/json'])
19922
+ if !content_type.nil?
19923
+ header_params['Content-Type'] = content_type
19924
+ end
19925
+ header_params[:'If-Match'] = if_match
19926
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
19927
+
19928
+ # form parameters
19929
+ form_params = opts[:form_params] || {}
19930
+
19931
+ # http body (model)
19932
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactional_email_update_request)
19933
+
19934
+ # return_type
19935
+ return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
19936
+
19937
+ # auth_names
19938
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
19939
+
19940
+ new_options = opts.merge(
19941
+ :operation => :"SfvbApi.update_sfvb_transactional_email",
19942
+ :header_params => header_params,
19943
+ :query_params => query_params,
19944
+ :form_params => form_params,
19945
+ :body => post_body,
19946
+ :auth_names => auth_names,
19947
+ :return_type => return_type
19948
+ )
19949
+
19950
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
19951
+ if @api_client.config.debugging
19952
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19953
+ end
19954
+ return data, status_code, headers
19955
+ end
19956
+
18587
19957
  # Update an upsell offer
18588
19958
  # A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer's screenshots, are kept.
18589
19959
  # @param storefront_oid [Integer]