ultracart_api 4.1.231 → 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 (69) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +45 -2
  3. data/docs/ItemContentMultimedia.md +2 -0
  4. data/docs/SfvbApi.md +763 -39
  5. data/docs/SfvbApprovalCreateRequest.md +6 -0
  6. data/docs/SfvbCommsBranchStat.md +20 -0
  7. data/docs/SfvbCommsChange.md +22 -0
  8. data/docs/SfvbCommsClick.md +20 -0
  9. data/docs/SfvbCommsClicksResponse.md +26 -0
  10. data/docs/SfvbCommsDailyStat.md +30 -0
  11. data/docs/SfvbCommsDashboardResponse.md +24 -0
  12. data/docs/SfvbCommsDashboardRow.md +28 -0
  13. data/docs/SfvbCommsPlan.md +66 -0
  14. data/docs/SfvbCommsPlanResponse.md +20 -0
  15. data/docs/SfvbCommsProvider.md +28 -0
  16. data/docs/SfvbCommsProviderImportRequest.md +22 -0
  17. data/docs/SfvbCommsProviderImportResponse.md +26 -0
  18. data/docs/SfvbCommsProviderList.md +20 -0
  19. data/docs/SfvbCommsProvidersResponse.md +22 -0
  20. data/docs/SfvbCommsSender.md +24 -0
  21. data/docs/SfvbCommsSenderUpdate.md +22 -0
  22. data/docs/SfvbCommsSequenceStatsResponse.md +26 -0
  23. data/docs/SfvbCommsSettings.md +34 -0
  24. data/docs/SfvbCommsSettingsResponse.md +24 -0
  25. data/docs/SfvbCommsSettingsUpdateRequest.md +26 -0
  26. data/docs/SfvbCommsStat.md +54 -0
  27. data/docs/SfvbCommsStepStat.md +34 -0
  28. data/docs/SfvbCommsTemplate.md +30 -0
  29. data/docs/SfvbCommsTemplateResponse.md +24 -0
  30. data/docs/SfvbCommsTemplatesResponse.md +20 -0
  31. data/docs/SfvbCommsTestEmailRequest.md +24 -0
  32. data/docs/SfvbCommsTestPostcardRequest.md +36 -0
  33. data/docs/SfvbCommsTestSendResponse.md +32 -0
  34. data/docs/SfvbCommsTestSmsRequest.md +18 -0
  35. data/lib/ultracart_api/api/sfvb_api.rb +982 -10
  36. data/lib/ultracart_api/models/item_content_multimedia.rb +11 -1
  37. data/lib/ultracart_api/models/sfvb_approval_create_request.rb +30 -3
  38. data/lib/ultracart_api/models/sfvb_comms_branch_stat.rb +229 -0
  39. data/lib/ultracart_api/models/sfvb_comms_change.rb +240 -0
  40. data/lib/ultracart_api/models/sfvb_comms_click.rb +230 -0
  41. data/lib/ultracart_api/models/sfvb_comms_clicks_response.rb +264 -0
  42. data/lib/ultracart_api/models/sfvb_comms_daily_stat.rb +280 -0
  43. data/lib/ultracart_api/models/sfvb_comms_dashboard_response.rb +256 -0
  44. data/lib/ultracart_api/models/sfvb_comms_dashboard_row.rb +269 -0
  45. data/lib/ultracart_api/models/sfvb_comms_plan.rb +460 -0
  46. data/lib/ultracart_api/models/sfvb_comms_plan_response.rb +231 -0
  47. data/lib/ultracart_api/models/sfvb_comms_provider.rb +272 -0
  48. data/lib/ultracart_api/models/sfvb_comms_provider_import_request.rb +242 -0
  49. data/lib/ultracart_api/models/sfvb_comms_provider_import_response.rb +264 -0
  50. data/lib/ultracart_api/models/sfvb_comms_provider_list.rb +230 -0
  51. data/lib/ultracart_api/models/sfvb_comms_providers_response.rb +244 -0
  52. data/lib/ultracart_api/models/sfvb_comms_sender.rb +250 -0
  53. data/lib/ultracart_api/models/sfvb_comms_sender_update.rb +240 -0
  54. data/lib/ultracart_api/models/sfvb_comms_sequence_stats_response.rb +263 -0
  55. data/lib/ultracart_api/models/sfvb_comms_settings.rb +297 -0
  56. data/lib/ultracart_api/models/sfvb_comms_settings_response.rb +253 -0
  57. data/lib/ultracart_api/models/sfvb_comms_settings_update_request.rb +257 -0
  58. data/lib/ultracart_api/models/sfvb_comms_stat.rb +402 -0
  59. data/lib/ultracart_api/models/sfvb_comms_step_stat.rb +301 -0
  60. data/lib/ultracart_api/models/sfvb_comms_template.rb +280 -0
  61. data/lib/ultracart_api/models/sfvb_comms_template_response.rb +251 -0
  62. data/lib/ultracart_api/models/sfvb_comms_templates_response.rb +234 -0
  63. data/lib/ultracart_api/models/sfvb_comms_test_email_request.rb +252 -0
  64. data/lib/ultracart_api/models/sfvb_comms_test_postcard_request.rb +312 -0
  65. data/lib/ultracart_api/models/sfvb_comms_test_send_response.rb +292 -0
  66. data/lib/ultracart_api/models/sfvb_comms_test_sms_request.rb +220 -0
  67. data/lib/ultracart_api/version.rb +1 -1
  68. data/lib/ultracart_api.rb +29 -0
  69. metadata +59 -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]
@@ -5181,6 +5327,134 @@ module UltracartClient
5181
5327
  return data, status_code, headers
5182
5328
  end
5183
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
+
5184
5458
  # Read one segment, with its rule
5185
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.
5186
5460
  # @param storefront_oid [Integer]
@@ -5452,6 +5726,277 @@ module UltracartClient
5452
5726
  return data, status_code, headers
5453
5727
  end
5454
5728
 
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.
5731
+ # @param storefront_oid [Integer]
5732
+ # @param commseq_uuid [String]
5733
+ # @param [Hash] opts the optional parameters
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)
5738
+ data
5739
+ end
5740
+
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.
5743
+ # @param storefront_oid [Integer]
5744
+ # @param commseq_uuid [String]
5745
+ # @param [Hash] opts the optional parameters
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 = {})
5749
+ if @api_client.config.debugging
5750
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sequence_stats ...'
5751
+ end
5752
+ # verify the required parameter 'storefront_oid' is set
5753
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5754
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_sequence_stats"
5755
+ end
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"
5759
+ end
5760
+ # resource path
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))
5762
+
5763
+ # query parameters
5764
+ query_params = opts[:query_params] || {}
5765
+ query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?
5766
+
5767
+ # header parameters
5768
+ header_params = opts[:header_params] || {}
5769
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5770
+ # HTTP header 'Accept' (if needed)
5771
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5772
+
5773
+ # form parameters
5774
+ form_params = opts[:form_params] || {}
5775
+
5776
+ # http body (model)
5777
+ post_body = opts[:debug_body]
5778
+
5779
+ # return_type
5780
+ return_type = opts[:debug_return_type] || 'SfvbCommsSequenceStatsResponse'
5781
+
5782
+ # auth_names
5783
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5784
+
5785
+ new_options = opts.merge(
5786
+ :operation => :"SfvbApi.get_sfvb_comms_sequence_stats",
5787
+ :header_params => header_params,
5788
+ :query_params => query_params,
5789
+ :form_params => form_params,
5790
+ :body => post_body,
5791
+ :auth_names => auth_names,
5792
+ :return_type => return_type
5793
+ )
5794
+
5795
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5796
+ if @api_client.config.debugging
5797
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sequence_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5798
+ end
5799
+ return data, status_code, headers
5800
+ end
5801
+
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.
5804
+ # @param storefront_oid [Integer]
5805
+ # @param [Hash] opts the optional parameters
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)
5809
+ data
5810
+ end
5811
+
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.
5814
+ # @param storefront_oid [Integer]
5815
+ # @param [Hash] opts the optional parameters
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 = {})
5818
+ if @api_client.config.debugging
5819
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_settings ...'
5820
+ end
5821
+ # verify the required parameter 'storefront_oid' is set
5822
+ if @api_client.config.client_side_validation && storefront_oid.nil?
5823
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_settings"
5824
+ end
5825
+ # resource path
5826
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5827
+
5828
+ # query parameters
5829
+ query_params = opts[:query_params] || {}
5830
+
5831
+ # header parameters
5832
+ header_params = opts[:header_params] || {}
5833
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5834
+ # HTTP header 'Accept' (if needed)
5835
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5836
+
5837
+ # form parameters
5838
+ form_params = opts[:form_params] || {}
5839
+
5840
+ # http body (model)
5841
+ post_body = opts[:debug_body]
5842
+
5843
+ # return_type
5844
+ return_type = opts[:debug_return_type] || 'SfvbCommsSettingsResponse'
5845
+
5846
+ # auth_names
5847
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5848
+
5849
+ new_options = opts.merge(
5850
+ :operation => :"SfvbApi.get_sfvb_comms_settings",
5851
+ :header_params => header_params,
5852
+ :query_params => query_params,
5853
+ :form_params => form_params,
5854
+ :body => post_body,
5855
+ :auth_names => auth_names,
5856
+ :return_type => return_type
5857
+ )
5858
+
5859
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5860
+ if @api_client.config.debugging
5861
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5862
+ end
5863
+ return data, status_code, headers
5864
+ end
5865
+
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]
5870
+ # @param [Hash] opts the optional parameters
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)
5874
+ data
5875
+ end
5876
+
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]
5881
+ # @param [Hash] opts the optional parameters
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 = {})
5884
+ if @api_client.config.debugging
5885
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_template ...'
5886
+ end
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"
5894
+ end
5895
+ # resource path
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))
5897
+
5898
+ # query parameters
5899
+ query_params = opts[:query_params] || {}
5900
+
5901
+ # header parameters
5902
+ header_params = opts[:header_params] || {}
5903
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5904
+ # HTTP header 'Accept' (if needed)
5905
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5906
+
5907
+ # form parameters
5908
+ form_params = opts[:form_params] || {}
5909
+
5910
+ # http body (model)
5911
+ post_body = opts[:debug_body]
5912
+
5913
+ # return_type
5914
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplateResponse'
5915
+
5916
+ # auth_names
5917
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5918
+
5919
+ new_options = opts.merge(
5920
+ :operation => :"SfvbApi.get_sfvb_comms_template",
5921
+ :header_params => header_params,
5922
+ :query_params => query_params,
5923
+ :form_params => form_params,
5924
+ :body => post_body,
5925
+ :auth_names => auth_names,
5926
+ :return_type => return_type
5927
+ )
5928
+
5929
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5930
+ if @api_client.config.debugging
5931
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5932
+ end
5933
+ return data, status_code, headers
5934
+ end
5935
+
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]
5939
+ # @param [Hash] opts the optional parameters
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)
5943
+ data
5944
+ end
5945
+
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]
5949
+ # @param [Hash] opts the optional parameters
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 = {})
5952
+ if @api_client.config.debugging
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"
5958
+ end
5959
+ # resource path
5960
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/comms/templates'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
5961
+
5962
+ # query parameters
5963
+ query_params = opts[:query_params] || {}
5964
+
5965
+ # header parameters
5966
+ header_params = opts[:header_params] || {}
5967
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5968
+ # HTTP header 'Accept' (if needed)
5969
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5970
+
5971
+ # form parameters
5972
+ form_params = opts[:form_params] || {}
5973
+
5974
+ # http body (model)
5975
+ post_body = opts[:debug_body]
5976
+
5977
+ # return_type
5978
+ return_type = opts[:debug_return_type] || 'SfvbCommsTemplatesResponse'
5979
+
5980
+ # auth_names
5981
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5982
+
5983
+ new_options = opts.merge(
5984
+ :operation => :"SfvbApi.get_sfvb_comms_templates",
5985
+ :header_params => header_params,
5986
+ :query_params => query_params,
5987
+ :form_params => form_params,
5988
+ :body => post_body,
5989
+ :auth_names => auth_names,
5990
+ :return_type => return_type
5991
+ )
5992
+
5993
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5994
+ if @api_client.config.debugging
5995
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5996
+ end
5997
+ return data, status_code, headers
5998
+ end
5999
+
5455
6000
  # Read the Twilio account
5456
6001
  # The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
5457
6002
  # @param [Hash] opts the optional parameters
@@ -10171,18 +10716,90 @@ module UltracartClient
10171
10716
  # @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
10172
10717
  def ignore_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
10173
10718
  if @api_client.config.debugging
10174
- @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 ...'
10175
10792
  end
10176
10793
  # verify the required parameter 'storefront_oid' is set
10177
10794
  if @api_client.config.client_side_validation && storefront_oid.nil?
10178
- 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"
10179
10796
  end
10180
- # verify the required parameter 'not_found_id' is set
10181
- if @api_client.config.client_side_validation && not_found_id.nil?
10182
- 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"
10183
10800
  end
10184
10801
  # resource path
10185
- 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))
10186
10803
 
10187
10804
  # query parameters
10188
10805
  query_params = opts[:query_params] || {}
@@ -10192,21 +10809,27 @@ module UltracartClient
10192
10809
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10193
10810
  # HTTP header 'Accept' (if needed)
10194
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?
10195
10818
 
10196
10819
  # form parameters
10197
10820
  form_params = opts[:form_params] || {}
10198
10821
 
10199
10822
  # http body (model)
10200
- post_body = opts[:debug_body]
10823
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(provider_import_request)
10201
10824
 
10202
10825
  # return_type
10203
- return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
10826
+ return_type = opts[:debug_return_type] || 'SfvbCommsProviderImportResponse'
10204
10827
 
10205
10828
  # auth_names
10206
10829
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10207
10830
 
10208
10831
  new_options = opts.merge(
10209
- :operation => :"SfvbApi.ignore_sfvb_not_found_entry",
10832
+ :operation => :"SfvbApi.import_sfvb_comms_provider_lists",
10210
10833
  :header_params => header_params,
10211
10834
  :query_params => query_params,
10212
10835
  :form_params => form_params,
@@ -10217,7 +10840,7 @@ module UltracartClient
10217
10840
 
10218
10841
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10219
10842
  if @api_client.config.debugging
10220
- @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}"
10221
10844
  end
10222
10845
  return data, status_code, headers
10223
10846
  end
@@ -16722,6 +17345,270 @@ module UltracartClient
16722
17345
  return data, status_code, headers
16723
17346
  end
16724
17347
 
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.
17350
+ # @param storefront_oid [Integer]
17351
+ # @param commseq_uuid [String]
17352
+ # @param step_uuid [String]
17353
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
17354
+ # @param [Hash] opts the optional parameters
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)
17358
+ data
17359
+ end
17360
+
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.
17363
+ # @param storefront_oid [Integer]
17364
+ # @param commseq_uuid [String]
17365
+ # @param step_uuid [String]
17366
+ # @param test_email_request [SfvbCommsTestEmailRequest] The email and the recipient
17367
+ # @param [Hash] opts the optional parameters
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 = {})
17370
+ if @api_client.config.debugging
17371
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_email ...'
17372
+ end
17373
+ # verify the required parameter 'storefront_oid' is set
17374
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17375
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_email"
17376
+ end
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"
17380
+ end
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"
17384
+ end
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"
17388
+ end
17389
+ # resource path
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))
17391
+
17392
+ # query parameters
17393
+ query_params = opts[:query_params] || {}
17394
+
17395
+ # header parameters
17396
+ header_params = opts[:header_params] || {}
17397
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17398
+ # HTTP header 'Accept' (if needed)
17399
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17400
+ # HTTP header 'Content-Type'
17401
+ content_type = @api_client.select_header_content_type(['application/json'])
17402
+ if !content_type.nil?
17403
+ header_params['Content-Type'] = content_type
17404
+ end
17405
+
17406
+ # form parameters
17407
+ form_params = opts[:form_params] || {}
17408
+
17409
+ # http body (model)
17410
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_email_request)
17411
+
17412
+ # return_type
17413
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
17414
+
17415
+ # auth_names
17416
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17417
+
17418
+ new_options = opts.merge(
17419
+ :operation => :"SfvbApi.test_sfvb_comms_email",
17420
+ :header_params => header_params,
17421
+ :query_params => query_params,
17422
+ :form_params => form_params,
17423
+ :body => post_body,
17424
+ :auth_names => auth_names,
17425
+ :return_type => return_type
17426
+ )
17427
+
17428
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17429
+ if @api_client.config.debugging
17430
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17431
+ end
17432
+ return data, status_code, headers
17433
+ end
17434
+
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.
17437
+ # @param storefront_oid [Integer]
17438
+ # @param commseq_uuid [String]
17439
+ # @param step_uuid [String]
17440
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
17441
+ # @param [Hash] opts the optional parameters
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)
17446
+ data
17447
+ end
17448
+
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.
17451
+ # @param storefront_oid [Integer]
17452
+ # @param commseq_uuid [String]
17453
+ # @param step_uuid [String]
17454
+ # @param test_postcard_request [SfvbCommsTestPostcardRequest] The address and mail_card
17455
+ # @param [Hash] opts the optional parameters
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 = {})
17459
+ if @api_client.config.debugging
17460
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_postcard ...'
17461
+ end
17462
+ # verify the required parameter 'storefront_oid' is set
17463
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17464
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_postcard"
17465
+ end
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"
17469
+ end
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"
17477
+ end
17478
+ # resource path
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))
17480
+
17481
+ # query parameters
17482
+ query_params = opts[:query_params] || {}
17483
+
17484
+ # header parameters
17485
+ header_params = opts[:header_params] || {}
17486
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17487
+ # HTTP header 'Accept' (if needed)
17488
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17489
+ # HTTP header 'Content-Type'
17490
+ content_type = @api_client.select_header_content_type(['application/json'])
17491
+ if !content_type.nil?
17492
+ header_params['Content-Type'] = content_type
17493
+ end
17494
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
17495
+
17496
+ # form parameters
17497
+ form_params = opts[:form_params] || {}
17498
+
17499
+ # http body (model)
17500
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_postcard_request)
17501
+
17502
+ # return_type
17503
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
17504
+
17505
+ # auth_names
17506
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17507
+
17508
+ new_options = opts.merge(
17509
+ :operation => :"SfvbApi.test_sfvb_comms_postcard",
17510
+ :header_params => header_params,
17511
+ :query_params => query_params,
17512
+ :form_params => form_params,
17513
+ :body => post_body,
17514
+ :auth_names => auth_names,
17515
+ :return_type => return_type
17516
+ )
17517
+
17518
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17519
+ if @api_client.config.debugging
17520
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17521
+ end
17522
+ return data, status_code, headers
17523
+ end
17524
+
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.
17527
+ # @param storefront_oid [Integer]
17528
+ # @param commseq_uuid [String]
17529
+ # @param step_uuid [String]
17530
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
17531
+ # @param [Hash] opts the optional parameters
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)
17535
+ data
17536
+ end
17537
+
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.
17540
+ # @param storefront_oid [Integer]
17541
+ # @param commseq_uuid [String]
17542
+ # @param step_uuid [String]
17543
+ # @param test_sms_request [SfvbCommsTestSmsRequest] The recipient
17544
+ # @param [Hash] opts the optional parameters
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 = {})
17547
+ if @api_client.config.debugging
17548
+ @api_client.config.logger.debug 'Calling API: SfvbApi.test_sfvb_comms_sms ...'
17549
+ end
17550
+ # verify the required parameter 'storefront_oid' is set
17551
+ if @api_client.config.client_side_validation && storefront_oid.nil?
17552
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.test_sfvb_comms_sms"
17553
+ end
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"
17565
+ end
17566
+ # resource path
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))
17568
+
17569
+ # query parameters
17570
+ query_params = opts[:query_params] || {}
17571
+
17572
+ # header parameters
17573
+ header_params = opts[:header_params] || {}
17574
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
17575
+ # HTTP header 'Accept' (if needed)
17576
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17577
+ # HTTP header 'Content-Type'
17578
+ content_type = @api_client.select_header_content_type(['application/json'])
17579
+ if !content_type.nil?
17580
+ header_params['Content-Type'] = content_type
17581
+ end
17582
+
17583
+ # form parameters
17584
+ form_params = opts[:form_params] || {}
17585
+
17586
+ # http body (model)
17587
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_sms_request)
17588
+
17589
+ # return_type
17590
+ return_type = opts[:debug_return_type] || 'SfvbCommsTestSendResponse'
17591
+
17592
+ # auth_names
17593
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
17594
+
17595
+ new_options = opts.merge(
17596
+ :operation => :"SfvbApi.test_sfvb_comms_sms",
17597
+ :header_params => header_params,
17598
+ :query_params => query_params,
17599
+ :form_params => form_params,
17600
+ :body => post_body,
17601
+ :auth_names => auth_names,
17602
+ :return_type => return_type
17603
+ )
17604
+
17605
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17606
+ if @api_client.config.debugging
17607
+ @api_client.config.logger.debug "API called: SfvbApi#test_sfvb_comms_sms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17608
+ end
17609
+ return data, status_code, headers
17610
+ end
17611
+
16725
17612
  # Unarchive an upsell path
16726
17613
  # Brings the path back into the default list. A path that is switched on is refused, because unarchiving it would start it without approval - disable it, unarchive it, then enable it.
16727
17614
  # @param storefront_oid [Integer]
@@ -17691,6 +18578,91 @@ module UltracartClient
17691
18578
  return data, status_code, headers
17692
18579
  end
17693
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
+
17694
18666
  # Update the Twilio account
17695
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.
17696
18668
  # @param twilio_account [SfvbCommsTwilioAccount] The changes