Class: UltracartClient::StorefrontApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/storefront_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StorefrontApi

Returns a new instance of StorefrontApi.



19
20
21
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::StorefrontApi.new(api_client)
end

Instance Method Details

#add_to_library(add_library_request, opts = {}) ⇒ LibraryItemResponse

Add to library

Parameters:

  • add_library_request (AddLibraryItemRequest) —

    New library item request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 39

def add_to_library(add_library_request, opts = {})
  data, _status_code, _headers = add_to_library_with_http_info(add_library_request, opts)
  data
end

#add_to_library_with_http_info(add_library_request, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Add to library

Parameters:

  • add_library_request (AddLibraryItemRequest) —

    New library item request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 48

def add_to_library_with_http_info(add_library_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.add_to_library ...'
  end
  # verify the required parameter 'add_library_request' is set
  if @api_client.config.client_side_validation && add_library_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_library_request' when calling StorefrontApi.add_to_library"
  end
  # resource path
  local_var_path = '/storefront/code_library'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(add_library_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.add_to_library",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#add_to_library\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apply_to_store_front(apply_library_request, opts = {}) ⇒ ApplyLibraryItemResponse

Apply library item to storefront.

Parameters:

  • apply_library_request (ApplyLibraryItemRequest) —

    New library item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



106
107
108
109
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 106

def apply_to_store_front(apply_library_request, opts = {})
  data, _status_code, _headers = apply_to_store_front_with_http_info(apply_library_request, opts)
  data
end

#apply_to_store_front_with_http_info(apply_library_request, opts = {}) ⇒ Array<(ApplyLibraryItemResponse, Integer, Hash)>

Apply library item to storefront.

Parameters:

  • apply_library_request (ApplyLibraryItemRequest) —

    New library item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplyLibraryItemResponse, Integer, Hash)>) —

    ApplyLibraryItemResponse data, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 115

def apply_to_store_front_with_http_info(apply_library_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.apply_to_store_front ...'
  end
  # verify the required parameter 'apply_library_request' is set
  if @api_client.config.client_side_validation && apply_library_request.nil?
    fail ArgumentError, "Missing the required parameter 'apply_library_request' when calling StorefrontApi.apply_to_store_front"
  end
  # resource path
  local_var_path = '/storefront/code_library/apply'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(apply_library_request)

  # return_type
  return_type = opts[:debug_return_type] || 'ApplyLibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.apply_to_store_front",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#apply_to_store_front\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archive_email_list(storefront_oid, email_list_uuid, opts = {}) ⇒ EmailListArchiveResponse

Archive email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



174
175
176
177
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 174

def archive_email_list(storefront_oid, email_list_uuid, opts = {})
  data, _status_code, _headers = archive_email_list_with_http_info(storefront_oid, email_list_uuid, opts)
  data
end

#archive_email_list_with_http_info(storefront_oid, email_list_uuid, opts = {}) ⇒ Array<(EmailListArchiveResponse, Integer, Hash)>

Archive email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListArchiveResponse, Integer, Hash)>) —

    EmailListArchiveResponse data, response status code and response headers



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 184

def archive_email_list_with_http_info(storefront_oid, email_list_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.archive_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.archive_email_list"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.archive_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListArchiveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.archive_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#archive_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#archive_email_segment(storefront_oid, email_segment_uuid, opts = {}) ⇒ EmailSegmentArchiveResponse

Archive email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 242

def archive_email_segment(storefront_oid, email_segment_uuid, opts = {})
  data, _status_code, _headers = archive_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
  data
end

#archive_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentArchiveResponse, Integer, Hash)>

Archive email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSegmentArchiveResponse, Integer, Hash)>) —

    EmailSegmentArchiveResponse data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 252

def archive_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.archive_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.archive_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.archive_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentArchiveResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.archive_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#archive_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#back_populate_email_flow(storefront_oid, email_flow_uuid, back_populate_request, opts = {}) ⇒ EmailFlowBackPopulateResponse

Back populate email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • back_populate_request (EmailFlowBackPopulateRequest) —

    The request to back populate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



311
312
313
314
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 311

def back_populate_email_flow(storefront_oid, email_flow_uuid, back_populate_request, opts = {})
  data, _status_code, _headers = back_populate_email_flow_with_http_info(storefront_oid, email_flow_uuid, back_populate_request, opts)
  data
end

#back_populate_email_flow_with_http_info(storefront_oid, email_flow_uuid, back_populate_request, opts = {}) ⇒ Array<(EmailFlowBackPopulateResponse, Integer, Hash)>

Back populate email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • back_populate_request (EmailFlowBackPopulateRequest) —

    The request to back populate

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 322

def back_populate_email_flow_with_http_info(storefront_oid, email_flow_uuid, back_populate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.back_populate_email_flow ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.back_populate_email_flow"
  end
  # verify the required parameter 'email_flow_uuid' is set
  if @api_client.config.client_side_validation && email_flow_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_uuid' when calling StorefrontApi.back_populate_email_flow"
  end
  # verify the required parameter 'back_populate_request' is set
  if @api_client.config.client_side_validation && back_populate_request.nil?
    fail ArgumentError, "Missing the required parameter 'back_populate_request' when calling StorefrontApi.back_populate_email_flow"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_uuid' + '}', CGI.escape(email_flow_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(back_populate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowBackPopulateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.back_populate_email_flow",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#back_populate_email_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_download_email_segment(storefront_oid, email_segment_uuid, email_segment_rebuild_uuid, opts = {}) ⇒ EmailSegmentDownloadPrepareResponse

Check download of email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_segment_rebuild_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



390
391
392
393
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 390

def check_download_email_segment(storefront_oid, email_segment_uuid, email_segment_rebuild_uuid, opts = {})
  data, _status_code, _headers = check_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment_rebuild_uuid, opts)
  data
end

#check_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment_rebuild_uuid, opts = {}) ⇒ Array<(EmailSegmentDownloadPrepareResponse, Integer, Hash)>

Check download of email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_segment_rebuild_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 401

def check_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment_rebuild_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.check_download_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.check_download_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.check_download_email_segment"
  end
  # verify the required parameter 'email_segment_rebuild_uuid' is set
  if @api_client.config.client_side_validation && email_segment_rebuild_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_rebuild_uuid' when calling StorefrontApi.check_download_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s)).sub('{' + 'email_segment_rebuild_uuid' + '}', CGI.escape(email_segment_rebuild_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentDownloadPrepareResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.check_download_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#check_download_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clone_email_campaign(storefront_oid, email_campaign_uuid, opts = {}) ⇒ EmailCampaignResponse

Clone email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:



464
465
466
467
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 464

def clone_email_campaign(storefront_oid, email_campaign_uuid, opts = {})
  data, _status_code, _headers = clone_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts)
  data
end

#clone_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {}) ⇒ Array<(EmailCampaignResponse, Integer, Hash)>

Clone email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:

  • (Array<(EmailCampaignResponse, Integer, Hash)>) —

    EmailCampaignResponse data, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 475

def clone_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.clone_email_campaign ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.clone_email_campaign"
  end
  # verify the required parameter 'email_campaign_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_uuid' when calling StorefrontApi.clone_email_campaign"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_uuid' + '}', CGI.escape(email_campaign_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'target_storefront_oid'] = opts[:'target_storefront_oid'] if !opts[:'target_storefront_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.clone_email_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#clone_email_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clone_email_flow(storefront_oid, email_flow_uuid, opts = {}) ⇒ EmailFlowResponse

Clone email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:



535
536
537
538
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 535

def clone_email_flow(storefront_oid, email_flow_uuid, opts = {})
  data, _status_code, _headers = clone_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts)
  data
end

#clone_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts = {}) ⇒ Array<(EmailFlowResponse, Integer, Hash)>

Clone email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:

  • (Array<(EmailFlowResponse, Integer, Hash)>) —

    EmailFlowResponse data, response status code and response headers



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 546

def clone_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.clone_email_flow ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.clone_email_flow"
  end
  # verify the required parameter 'email_flow_uuid' is set
  if @api_client.config.client_side_validation && email_flow_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_uuid' when calling StorefrontApi.clone_email_flow"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_uuid' + '}', CGI.escape(email_flow_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'target_storefront_oid'] = opts[:'target_storefront_oid'] if !opts[:'target_storefront_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.clone_email_flow",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#clone_email_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_email_sending_domain(domain, opts = {}) ⇒ EmailSendingDomainResponse

Create email campaign

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



604
605
606
607
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 604

def create_email_sending_domain(domain, opts = {})
  data, _status_code, _headers = create_email_sending_domain_with_http_info(domain, opts)
  data
end

#create_email_sending_domain2(email_domain, opts = {}) ⇒ EmailSendingDomainResponse

Create email sending domain for various providers

Parameters:

  • email_domain (EmailDomain) —

    EmailDomain

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



666
667
668
669
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 666

def create_email_sending_domain2(email_domain, opts = {})
  data, _status_code, _headers = create_email_sending_domain2_with_http_info(email_domain, opts)
  data
end

#create_email_sending_domain2_with_http_info(email_domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Integer, Hash)>

Create email sending domain for various providers

Parameters:

  • email_domain (EmailDomain) —

    EmailDomain

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainResponse, Integer, Hash)>) —

    EmailSendingDomainResponse data, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 675

def create_email_sending_domain2_with_http_info(email_domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.create_email_sending_domain2 ...'
  end
  # verify the required parameter 'email_domain' is set
  if @api_client.config.client_side_validation && email_domain.nil?
    fail ArgumentError, "Missing the required parameter 'email_domain' when calling StorefrontApi.create_email_sending_domain2"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_domain)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.create_email_sending_domain2",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#create_email_sending_domain2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_email_sending_domain_with_http_info(domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Integer, Hash)>

Create email campaign

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainResponse, Integer, Hash)>) —

    EmailSendingDomainResponse data, response status code and response headers



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 613

def create_email_sending_domain_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.create_email_sending_domain ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling StorefrontApi.create_email_sending_domain"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains/{domain}/create'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.create_email_sending_domain",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#create_email_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_fs_directory(id, opts = {}) ⇒ FileManagerPageResponse

Create file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :parent_storefront_fs_directory_oid (Integer)

Returns:



735
736
737
738
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 735

def create_fs_directory(id, opts = {})
  data, _status_code, _headers = create_fs_directory_with_http_info(id, opts)
  data
end

#create_fs_directory_with_http_info(id, opts = {}) ⇒ Array<(FileManagerPageResponse, Integer, Hash)>

Create file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :name (String)
  • :parent_storefront_fs_directory_oid (Integer)

Returns:

  • (Array<(FileManagerPageResponse, Integer, Hash)>) —

    FileManagerPageResponse data, response status code and response headers



746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 746

def create_fs_directory_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.create_fs_directory ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_fs_directory"
  end
  # resource path
  local_var_path = '/storefront/{id}/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FileManagerPageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.create_fs_directory",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#create_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_twilio_account(twilio, opts = {}) ⇒ TwilioResponse

Create Twilio account

Parameters:

  • twilio (Twilio) —

    Twilio

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



801
802
803
804
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 801

def (twilio, opts = {})
  data, _status_code, _headers = (twilio, opts)
  data
end

#create_twilio_account_with_http_info(twilio, opts = {}) ⇒ Array<(TwilioResponse, Integer, Hash)>

Create Twilio account

Parameters:

  • twilio (Twilio) —

    Twilio

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TwilioResponse, Integer, Hash)>) —

    TwilioResponse data, response status code and response headers



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 810

def (twilio, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.create_twilio_account ...'
  end
  # verify the required parameter 'twilio' is set
  if @api_client.config.client_side_validation && twilio.nil?
    fail ArgumentError, "Missing the required parameter 'twilio' when calling StorefrontApi.create_twilio_account"
  end
  # resource path
  local_var_path = '/storefront/twilio/accounts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio)

  # return_type
  return_type = opts[:debug_return_type] || 'TwilioResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.create_twilio_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#create_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, opts = {}) ⇒ BaseResponse

Delete email campaignFolder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



869
870
871
872
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 869

def delete_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, opts = {})
  data, _status_code, _headers = delete_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts)
  data
end

#delete_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email campaignFolder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 879

def delete_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_campaign_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_campaign_folder"
  end
  # verify the required parameter 'email_campaign_folder_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_folder_uuid' when calling StorefrontApi.delete_email_campaign_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_folder_uuid' + '}', CGI.escape(email_campaign_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_campaign_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_commseq_stat(storefront_oid, commseq_uuid, opts = {}) ⇒ nil

Delete communication sequence stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


937
938
939
940
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 937

def delete_email_commseq_stat(storefront_oid, commseq_uuid, opts = {})
  delete_email_commseq_stat_with_http_info(storefront_oid, commseq_uuid, opts)
  nil
end

#delete_email_commseq_stat_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete communication sequence stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 947

def delete_email_commseq_stat_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_commseq_stat ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_commseq_stat"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.delete_email_commseq_stat"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_commseq_stat",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_commseq_stat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_email(storefront_oid, commseq_email_uuid, opts = {}) ⇒ BaseResponse

Delete email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1005
1006
1007
1008
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1005

def delete_email_email(storefront_oid, commseq_email_uuid, opts = {})
  data, _status_code, _headers = delete_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts)
  data
end

#delete_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1015

def delete_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_email"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.delete_email_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_flow_folder(storefront_oid, email_flow_folder_uuid, opts = {}) ⇒ BaseResponse

Delete email flowFolder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1073
1074
1075
1076
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1073

def delete_email_flow_folder(storefront_oid, email_flow_folder_uuid, opts = {})
  data, _status_code, _headers = delete_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts)
  data
end

#delete_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email flowFolder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1083

def delete_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_flow_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_flow_folder"
  end
  # verify the required parameter 'email_flow_folder_uuid' is set
  if @api_client.config.client_side_validation && email_flow_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_folder_uuid' when calling StorefrontApi.delete_email_flow_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_folder_uuid' + '}', CGI.escape(email_flow_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_flow_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_list_customer(storefront_oid, email_list_uuid, email_customer_uuid, opts = {}) ⇒ BaseResponse

Delete email list customer

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1142
1143
1144
1145
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1142

def delete_email_list_customer(storefront_oid, email_list_uuid, email_customer_uuid, opts = {})
  data, _status_code, _headers = delete_email_list_customer_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts)
  data
end

#delete_email_list_customer_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email list customer

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1153

def delete_email_list_customer_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_list_customer ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_list_customer"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.delete_email_list_customer"
  end
  # verify the required parameter 'email_customer_uuid' is set
  if @api_client.config.client_side_validation && email_customer_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.delete_email_list_customer"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_list_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_list_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, opts = {}) ⇒ BaseResponse

Delete email ListSegmentFolder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1215
1216
1217
1218
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1215

def delete_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, opts = {})
  data, _status_code, _headers = delete_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts)
  data
end

#delete_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email ListSegmentFolder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1225

def delete_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_list_segment_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_list_segment_folder"
  end
  # verify the required parameter 'email_list_segment_folder_uuid' is set
  if @api_client.config.client_side_validation && email_list_segment_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_segment_folder_uuid' when calling StorefrontApi.delete_email_list_segment_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_segment_folder_uuid' + '}', CGI.escape(email_list_segment_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_list_segment_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_list_segment_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_postcard(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ BaseResponse

Delete email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1283
1284
1285
1286
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1283

def delete_email_postcard(storefront_oid, commseq_postcard_uuid, opts = {})
  data, _status_code, _headers = delete_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
  data
end

#delete_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Delete email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1293

def delete_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_postcard ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_email_postcard"
  end
  # verify the required parameter 'commseq_postcard_uuid' is set
  if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.delete_email_postcard"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_postcard",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_sending_domain(domain, opts = {}) ⇒ BaseResponse

delete email campaign

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1350
1351
1352
1353
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1350

def delete_email_sending_domain(domain, opts = {})
  data, _status_code, _headers = delete_email_sending_domain_with_http_info(domain, opts)
  data
end

#delete_email_sending_domain_with_http_info(domain, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

delete email campaign

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1359

def delete_email_sending_domain_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_email_sending_domain ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling StorefrontApi.delete_email_sending_domain"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_email_sending_domain",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_email_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_experiment(storefront_oid, storefront_experiment_oid, opts = {}) ⇒ nil

Delete experiment

Parameters:

  • storefront_oid (Integer)
  • storefront_experiment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1413
1414
1415
1416
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1413

def delete_experiment(storefront_oid, storefront_experiment_oid, opts = {})
  delete_experiment_with_http_info(storefront_oid, storefront_experiment_oid, opts)
  nil
end

#delete_experiment_with_http_info(storefront_oid, storefront_experiment_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete experiment

Parameters:

  • storefront_oid (Integer)
  • storefront_experiment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1423

def delete_experiment_with_http_info(storefront_oid, storefront_experiment_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_experiment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_experiment"
  end
  # verify the required parameter 'storefront_experiment_oid' is set
  if @api_client.config.client_side_validation && storefront_experiment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_experiment_oid' when calling StorefrontApi.delete_experiment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'storefront_experiment_oid' + '}', CGI.escape(storefront_experiment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_experiment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_fs_file(id, opts = {}) ⇒ FileManagerPageResponse

Delete file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent_storefront_fs_directory_oid (Integer)
  • :storefront_fs_file_oid (Integer)

Returns:



1482
1483
1484
1485
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1482

def delete_fs_file(id, opts = {})
  data, _status_code, _headers = delete_fs_file_with_http_info(id, opts)
  data
end

#delete_fs_file_with_http_info(id, opts = {}) ⇒ Array<(FileManagerPageResponse, Integer, Hash)>

Delete file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent_storefront_fs_directory_oid (Integer)
  • :storefront_fs_file_oid (Integer)

Returns:

  • (Array<(FileManagerPageResponse, Integer, Hash)>) —

    FileManagerPageResponse data, response status code and response headers



1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1493

def delete_fs_file_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_fs_file ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.delete_fs_file"
  end
  # resource path
  local_var_path = '/storefront/{id}/fs/file'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
  query_params[:'storefront_fs_file_oid'] = opts[:'storefront_fs_file_oid'] if !opts[:'storefront_fs_file_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FileManagerPageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_fs_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_heatmap(storefront_oid, query, opts = {}) ⇒ nil

Delete screen recording heatmap Delete screen recording heatmap

Parameters:

Returns:

  • (nil) 


1550
1551
1552
1553
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1550

def delete_heatmap(storefront_oid, query, opts = {})
  delete_heatmap_with_http_info(storefront_oid, query, opts)
  nil
end

#delete_heatmap_with_http_info(storefront_oid, query, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete screen recording heatmap Delete screen recording heatmap

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1561

def delete_heatmap_with_http_info(storefront_oid, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_heatmap ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_heatmap"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.delete_heatmap"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(query)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_heatmap",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_library_item(library_item_oid, opts = {}) ⇒ nil

Delete library item

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1623
1624
1625
1626
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1623

def delete_library_item(library_item_oid, opts = {})
  delete_library_item_with_http_info(library_item_oid, opts)
  nil
end

#delete_library_item_published_versions(library_item_oid, opts = {}) ⇒ nil

Delete all published versions for a library item, including anything in review.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1685
1686
1687
1688
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1685

def delete_library_item_published_versions(library_item_oid, opts = {})
  delete_library_item_published_versions_with_http_info(library_item_oid, opts)
  nil
end

#delete_library_item_published_versions_with_http_info(library_item_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete all published versions for a library item, including anything in review.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1694

def delete_library_item_published_versions_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_library_item_published_versions ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.delete_library_item_published_versions"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}/published_versions'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_library_item_published_versions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_library_item_published_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_library_item_with_http_info(library_item_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete library item

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1632

def delete_library_item_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.delete_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_screen_recording_segment(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ nil

Delete screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1748
1749
1750
1751
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1748

def delete_screen_recording_segment(storefront_oid, screen_recording_segment_oid, opts = {})
  delete_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts)
  nil
end

#delete_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1758

def delete_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_screen_recording_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.delete_screen_recording_segment"
  end
  # verify the required parameter 'screen_recording_segment_oid' is set
  if @api_client.config.client_side_validation && screen_recording_segment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_segment_oid' when calling StorefrontApi.delete_screen_recording_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_segment_oid' + '}', CGI.escape(screen_recording_segment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_screen_recording_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_screen_recording_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_twilio_account(esp_twilio_uuid, opts = {}) ⇒ BaseResponse

delete Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1815
1816
1817
1818
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1815

def (esp_twilio_uuid, opts = {})
  data, _status_code, _headers = (esp_twilio_uuid, opts)
  data
end

#delete_twilio_account_with_http_info(esp_twilio_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

delete Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1824

def (esp_twilio_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_twilio_account ...'
  end
  # verify the required parameter 'esp_twilio_uuid' is set
  if @api_client.config.client_side_validation && esp_twilio_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'esp_twilio_uuid' when calling StorefrontApi.delete_twilio_account"
  end
  # resource path
  local_var_path = '/storefront/twilio/accounts/{esp_twilio_uuid}'.sub('{' + 'esp_twilio_uuid' + '}', CGI.escape(esp_twilio_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.delete_twilio_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#delete_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#duplicate_library_item(library_item_oid, opts = {}) ⇒ LibraryItemResponse

Duplicate library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1877
1878
1879
1880
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1877

def duplicate_library_item(library_item_oid, opts = {})
  data, _status_code, _headers = duplicate_library_item_with_http_info(library_item_oid, opts)
  data
end

#duplicate_library_item_with_http_info(library_item_oid, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Duplicate library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1886

def duplicate_library_item_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.duplicate_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.duplicate_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}/duplicate'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.duplicate_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#duplicate_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#favorite_screen_recording(storefront_oid, screen_recording_uuid, opts = {}) ⇒ nil

Update favorite flag on screen recording Update favorite flag on screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1941
1942
1943
1944
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1941

def favorite_screen_recording(storefront_oid, screen_recording_uuid, opts = {})
  favorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
  nil
end

#favorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update favorite flag on screen recording Update favorite flag on screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1952

def favorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.favorite_screen_recording ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.favorite_screen_recording"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.favorite_screen_recording"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.favorite_screen_recording",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#favorite_screen_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#geocode_address(storefront_oid, geocode_request, opts = {}) ⇒ GeocodeResponse

Obtain lat/long for an address

Parameters:

  • storefront_oid (Integer)
  • geocode_request (GeocodeRequest) —

    geocode request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2010
2011
2012
2013
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2010

def geocode_address(storefront_oid, geocode_request, opts = {})
  data, _status_code, _headers = geocode_address_with_http_info(storefront_oid, geocode_request, opts)
  data
end

#geocode_address_with_http_info(storefront_oid, geocode_request, opts = {}) ⇒ Array<(GeocodeResponse, Integer, Hash)>

Obtain lat/long for an address

Parameters:

  • storefront_oid (Integer)
  • geocode_request (GeocodeRequest) —

    geocode request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GeocodeResponse, Integer, Hash)>) —

    GeocodeResponse data, response status code and response headers



2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2020

def geocode_address_with_http_info(storefront_oid, geocode_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.geocode_address ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.geocode_address"
  end
  # verify the required parameter 'geocode_request' is set
  if @api_client.config.client_side_validation && geocode_request.nil?
    fail ArgumentError, "Missing the required parameter 'geocode_request' when calling StorefrontApi.geocode_address"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/geocode'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(geocode_request)

  # return_type
  return_type = opts[:debug_return_type] || 'GeocodeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.geocode_address",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#geocode_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_countries(storefront_oid, opts = {}) ⇒ CountriesResponse

Get countries Obtain a list of all the countries

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2083
2084
2085
2086
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2083

def get_countries(storefront_oid, opts = {})
  data, _status_code, _headers = get_countries_with_http_info(storefront_oid, opts)
  data
end

#get_countries_with_http_info(storefront_oid, opts = {}) ⇒ Array<(CountriesResponse, Integer, Hash)>

Get countries Obtain a list of all the countries

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CountriesResponse, Integer, Hash)>) —

    CountriesResponse data, response status code and response headers



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2093

def get_countries_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_countries ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_countries"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/countries'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CountriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_countries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_editor_token(storefront_oid, opts = {}) ⇒ EmailEditorTokenResponse

Gets editor token Fetches a temporary authentication token for the editor

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2147
2148
2149
2150
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2147

def get_editor_token(storefront_oid, opts = {})
  data, _status_code, _headers = get_editor_token_with_http_info(storefront_oid, opts)
  data
end

#get_editor_token_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailEditorTokenResponse, Integer, Hash)>

Gets editor token Fetches a temporary authentication token for the editor

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailEditorTokenResponse, Integer, Hash)>) —

    EmailEditorTokenResponse data, response status code and response headers



2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2157

def get_editor_token_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_editor_token ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_editor_token"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/editor_token'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailEditorTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_editor_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_editor_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_base_templates(storefront_oid, opts = {}) ⇒ EmailBaseTemplateListResponse

Get email communication base templates

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2210
2211
2212
2213
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2210

def get_email_base_templates(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_base_templates_with_http_info(storefront_oid, opts)
  data
end

#get_email_base_templates_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailBaseTemplateListResponse, Integer, Hash)>

Get email communication base templates

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2219

def get_email_base_templates_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_base_templates ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_base_templates"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/baseTemplates'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailBaseTemplateListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_base_templates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_base_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaign(storefront_oid, email_campaign_uuid, opts = {}) ⇒ EmailCampaignResponse

Get email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2273
2274
2275
2276
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2273

def get_email_campaign(storefront_oid, email_campaign_uuid, opts = {})
  data, _status_code, _headers = get_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts)
  data
end

#get_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, opts = {}) ⇒ EmailCampaignFolderResponse

Get email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2341
2342
2343
2344
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2341

def get_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, opts = {})
  data, _status_code, _headers = get_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts)
  data
end

#get_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts = {}) ⇒ Array<(EmailCampaignFolderResponse, Integer, Hash)>

Get email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignFolderResponse, Integer, Hash)>) —

    EmailCampaignFolderResponse data, response status code and response headers



2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2351

def get_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaign_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaign_folder"
  end
  # verify the required parameter 'email_campaign_folder_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_folder_uuid' when calling StorefrontApi.get_email_campaign_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_folder_uuid' + '}', CGI.escape(email_campaign_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaign_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaign_folders(storefront_oid, opts = {}) ⇒ EmailCampaignFoldersResponse

Get email campaign folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2408
2409
2410
2411
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2408

def get_email_campaign_folders(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_campaign_folders_with_http_info(storefront_oid, opts)
  data
end

#get_email_campaign_folders_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCampaignFoldersResponse, Integer, Hash)>

Get email campaign folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2417

def get_email_campaign_folders_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaign_folders ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaign_folders"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignFoldersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaign_folders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaign_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaign_screenshots(storefront_oid, email_campaign_uuid, opts = {}) ⇒ ScreenshotsResponse

Get email campaign screenshots

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2471
2472
2473
2474
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2471

def get_email_campaign_screenshots(storefront_oid, email_campaign_uuid, opts = {})
  data, _status_code, _headers = get_email_campaign_screenshots_with_http_info(storefront_oid, email_campaign_uuid, opts)
  data
end

#get_email_campaign_screenshots_with_http_info(storefront_oid, email_campaign_uuid, opts = {}) ⇒ Array<(ScreenshotsResponse, Integer, Hash)>

Get email campaign screenshots

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScreenshotsResponse, Integer, Hash)>) —

    ScreenshotsResponse data, response status code and response headers



2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2481

def get_email_campaign_screenshots_with_http_info(storefront_oid, email_campaign_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaign_screenshots ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaign_screenshots"
  end
  # verify the required parameter 'email_campaign_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_uuid' when calling StorefrontApi.get_email_campaign_screenshots"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_uuid' + '}', CGI.escape(email_campaign_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenshotsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaign_screenshots",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaign_screenshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {}) ⇒ Array<(EmailCampaignResponse, Integer, Hash)>

Get email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignResponse, Integer, Hash)>) —

    EmailCampaignResponse data, response status code and response headers



2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2283

def get_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaign ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaign"
  end
  # verify the required parameter 'email_campaign_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_uuid' when calling StorefrontApi.get_email_campaign"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_uuid' + '}', CGI.escape(email_campaign_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaigns(storefront_oid, opts = {}) ⇒ EmailCampaignsResponse

Get email campaigns

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2538
2539
2540
2541
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2538

def get_email_campaigns(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_campaigns_with_http_info(storefront_oid, opts)
  data
end

#get_email_campaigns_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCampaignsResponse, Integer, Hash)>

Get email campaigns

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignsResponse, Integer, Hash)>) —

    EmailCampaignsResponse data, response status code and response headers



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2547

def get_email_campaigns_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaigns ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaigns"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaigns",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_campaigns_with_stats(storefront_oid, stat_days, opts = {}) ⇒ EmailCampaignsResponse

Get email campaigns with stats

Parameters:

  • storefront_oid (Integer)
  • stat_days (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2601
2602
2603
2604
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2601

def get_email_campaigns_with_stats(storefront_oid, stat_days, opts = {})
  data, _status_code, _headers = get_email_campaigns_with_stats_with_http_info(storefront_oid, stat_days, opts)
  data
end

#get_email_campaigns_with_stats_with_http_info(storefront_oid, stat_days, opts = {}) ⇒ Array<(EmailCampaignsResponse, Integer, Hash)>

Get email campaigns with stats

Parameters:

  • storefront_oid (Integer)
  • stat_days (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignsResponse, Integer, Hash)>) —

    EmailCampaignsResponse data, response status code and response headers



2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2611

def get_email_campaigns_with_stats_with_http_info(storefront_oid, stat_days, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_campaigns_with_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_campaigns_with_stats"
  end
  # verify the required parameter 'stat_days' is set
  if @api_client.config.client_side_validation && stat_days.nil?
    fail ArgumentError, "Missing the required parameter 'stat_days' when calling StorefrontApi.get_email_campaigns_with_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaignsWithStats/{stat_days}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'stat_days' + '}', CGI.escape(stat_days.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_campaigns_with_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_campaigns_with_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq(storefront_oid, commseq_uuid, opts = {}) ⇒ EmailCommseqResponse

Get email commseq

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2669
2670
2671
2672
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2669

def get_email_commseq(storefront_oid, commseq_uuid, opts = {})
  data, _status_code, _headers = get_email_commseq_with_http_info(storefront_oid, commseq_uuid, opts)
  data
end

#get_email_commseq_editor_values(storefront_oid, opts = {}) ⇒ EmailEditorValuesResponse

Get email merchant specific editor values

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2736
2737
2738
2739
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2736

def get_email_commseq_editor_values(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_commseq_editor_values_with_http_info(storefront_oid, opts)
  data
end

#get_email_commseq_editor_values_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailEditorValuesResponse, Integer, Hash)>

Get email merchant specific editor values

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailEditorValuesResponse, Integer, Hash)>) —

    EmailEditorValuesResponse data, response status code and response headers



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2745

def get_email_commseq_editor_values_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_editor_values ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_editor_values"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/editorValues'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailEditorValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_editor_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ EmailStatSummaryResponse

Get email communication sequence emails stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2800
2801
2802
2803
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2800

def get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
  data, _status_code, _headers = get_email_commseq_email_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
  data
end

#get_email_commseq_email_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ Array<(EmailStatSummaryResponse, Integer, Hash)>

Get email communication sequence emails stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailStatSummaryResponse, Integer, Hash)>) —

    EmailStatSummaryResponse data, response status code and response headers



2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2811

def get_email_commseq_email_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_email_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_email_stats"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_email_stats"
  end
  # verify the required parameter 'stats_request' is set
  if @api_client.config.client_side_validation && stats_request.nil?
    fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_email_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stats_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailStatSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_email_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_email_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_postcard_stats(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ EmailStatPostcardSummaryResponse

Get email communication sequence postcard stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatPostcardSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2879
2880
2881
2882
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2879

def get_email_commseq_postcard_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
  data, _status_code, _headers = get_email_commseq_postcard_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
  data
end

#get_email_commseq_postcard_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ Array<(EmailStatPostcardSummaryResponse, Integer, Hash)>

Get email communication sequence postcard stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatPostcardSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2890

def get_email_commseq_postcard_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_postcard_stats"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_postcard_stats"
  end
  # verify the required parameter 'stats_request' is set
  if @api_client.config.client_side_validation && stats_request.nil?
    fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_postcard_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stats_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailStatPostcardSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_postcard_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ EmailPostcardTrackingResponse

Get email communication postcard tracking

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2957
2958
2959
2960
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2957

def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
  data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
  data
end

#get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ Array<(EmailPostcardTrackingResponse, Integer, Hash)>

Get email communication postcard tracking

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2967

def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
  end
  # verify the required parameter 'commseq_postcard_uuid' is set
  if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailPostcardTrackingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_postcard_tracking",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {}) ⇒ EmailRateLimitersResponse

Get email commseq rate limiters

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3025
3026
3027
3028
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3025

def get_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
  data, _status_code, _headers = get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
  data
end

#get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(EmailRateLimitersResponse, Integer, Hash)>

Get email commseq rate limiters

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailRateLimitersResponse, Integer, Hash)>) —

    EmailRateLimitersResponse data, response status code and response headers



3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3035

def get_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_rate_limiters ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_rate_limiters"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_rate_limiters"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailRateLimitersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_rate_limiters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ EmailStatSmsSummaryResponse

Get email communication sequence sms stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatSmsSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3094
3095
3096
3097
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3094

def get_email_commseq_sms_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
  data, _status_code, _headers = get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
  data
end

#get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ Array<(EmailStatSmsSummaryResponse, Integer, Hash)>

Get email communication sequence sms stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStatSmsSummaryRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailStatSmsSummaryResponse, Integer, Hash)>) —

    EmailStatSmsSummaryResponse data, response status code and response headers



3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3105

def get_email_commseq_sms_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_sms_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_sms_stats"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_sms_stats"
  end
  # verify the required parameter 'stats_request' is set
  if @api_client.config.client_side_validation && stats_request.nil?
    fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_sms_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stats_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailStatSmsSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_sms_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_sms_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_stat_overall(storefront_oid, commseq_uuid, opts = {}) ⇒ EmailCommseqStatResponse

Get communication sequence stats overall

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3172
3173
3174
3175
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3172

def get_email_commseq_stat_overall(storefront_oid, commseq_uuid, opts = {})
  data, _status_code, _headers = get_email_commseq_stat_overall_with_http_info(storefront_oid, commseq_uuid, opts)
  data
end

#get_email_commseq_stat_overall_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(EmailCommseqStatResponse, Integer, Hash)>

Get communication sequence stats overall

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqStatResponse, Integer, Hash)>) —

    EmailCommseqStatResponse data, response status code and response headers



3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3182

def get_email_commseq_stat_overall_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_stat_overall ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_stat_overall"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_stat_overall"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqStatResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_stat_overall",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_stat_overall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_step_stats(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ EmailStepStatResponse

Get email communication sequence step stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStepStatRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3241
3242
3243
3244
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3241

def get_email_commseq_step_stats(storefront_oid, commseq_uuid, stats_request, opts = {})
  data, _status_code, _headers = get_email_commseq_step_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts)
  data
end

#get_email_commseq_step_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ Array<(EmailStepStatResponse, Integer, Hash)>

Get email communication sequence step stats

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • stats_request (EmailStepStatRequest) —

    StatsRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailStepStatResponse, Integer, Hash)>) —

    EmailStepStatResponse data, response status code and response headers



3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3252

def get_email_commseq_step_stats_with_http_info(storefront_oid, commseq_uuid, stats_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_step_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_step_stats"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_step_stats"
  end
  # verify the required parameter 'stats_request' is set
  if @api_client.config.client_side_validation && stats_request.nil?
    fail ArgumentError, "Missing the required parameter 'stats_request' when calling StorefrontApi.get_email_commseq_step_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stats_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailStepStatResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_step_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_step_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_step_waiting(storefront_oid, commseq_uuid, waiting_request, opts = {}) ⇒ EmailStepWaitingResponse

Get email communication sequence customers waiting at each requested step

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • waiting_request (EmailStepWaitingRequest) —

    WaitingRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3320
3321
3322
3323
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3320

def get_email_commseq_step_waiting(storefront_oid, commseq_uuid, waiting_request, opts = {})
  data, _status_code, _headers = get_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, waiting_request, opts)
  data
end

#get_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, waiting_request, opts = {}) ⇒ Array<(EmailStepWaitingResponse, Integer, Hash)>

Get email communication sequence customers waiting at each requested step

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • waiting_request (EmailStepWaitingRequest) —

    WaitingRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailStepWaitingResponse, Integer, Hash)>) —

    EmailStepWaitingResponse data, response status code and response headers



3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3331

def get_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, waiting_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_step_waiting ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_step_waiting"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_step_waiting"
  end
  # verify the required parameter 'waiting_request' is set
  if @api_client.config.client_side_validation && waiting_request.nil?
    fail ArgumentError, "Missing the required parameter 'waiting_request' when calling StorefrontApi.get_email_commseq_step_waiting"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(waiting_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailStepWaitingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_step_waiting",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_step_waiting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid, opts = {}) ⇒ EmailWebhookEditorValuesResponse

Get email webhook editor values

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3398
3399
3400
3401
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3398

def get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid, opts = {})
  data, _status_code, _headers = get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts)
  data
end

#get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(EmailWebhookEditorValuesResponse, Integer, Hash)>

Get email webhook editor values

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3408

def get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_webhook_editor_values ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailWebhookEditorValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq_webhook_editor_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_webhook_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseq_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(EmailCommseqResponse, Integer, Hash)>

Get email commseq

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Integer, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2679

def get_email_commseq_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseq",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_commseqs(storefront_oid, opts = {}) ⇒ EmailCommseqsResponse

Get email commseqs

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3465
3466
3467
3468
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3465

def get_email_commseqs(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_commseqs_with_http_info(storefront_oid, opts)
  data
end

#get_email_commseqs_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCommseqsResponse, Integer, Hash)>

Get email commseqs

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqsResponse, Integer, Hash)>) —

    EmailCommseqsResponse data, response status code and response headers



3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3474

def get_email_commseqs_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseqs ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseqs"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_commseqs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseqs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_customer_editor_url(storefront_oid, email_customer_uuid, opts = {}) ⇒ EmailCustomerEditorUrlResponse

Get customers editor URL

Parameters:

  • storefront_oid (Integer)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3528
3529
3530
3531
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3528

def get_email_customer_editor_url(storefront_oid, email_customer_uuid, opts = {})
  data, _status_code, _headers = get_email_customer_editor_url_with_http_info(storefront_oid, email_customer_uuid, opts)
  data
end

#get_email_customer_editor_url_with_http_info(storefront_oid, email_customer_uuid, opts = {}) ⇒ Array<(EmailCustomerEditorUrlResponse, Integer, Hash)>

Get customers editor URL

Parameters:

  • storefront_oid (Integer)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3538

def get_email_customer_editor_url_with_http_info(storefront_oid, email_customer_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_customer_editor_url ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_customer_editor_url"
  end
  # verify the required parameter 'email_customer_uuid' is set
  if @api_client.config.client_side_validation && email_customer_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.get_email_customer_editor_url"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCustomerEditorUrlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_customer_editor_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_customer_editor_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_customers(storefront_oid, opts = {}) ⇒ EmailCustomersResponse

Get email customers

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)
  • :search_email_prefix (String)

Returns:



3598
3599
3600
3601
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3598

def get_email_customers(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_customers_with_http_info(storefront_oid, opts)
  data
end

#get_email_customers_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCustomersResponse, Integer, Hash)>

Get email customers

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)
  • :search_email_prefix (String)

Returns:

  • (Array<(EmailCustomersResponse, Integer, Hash)>) —

    EmailCustomersResponse data, response status code and response headers



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3610

def get_email_customers_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_customers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_customers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/customers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'searchEmailPrefix'] = opts[:'search_email_prefix'] if !opts[:'search_email_prefix'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCustomersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_dashboard_activity(storefront_oid, opts = {}) ⇒ EmailDashboardActivityResponse

Get email dashboard activity

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :last_records (Integer)

Returns:



3667
3668
3669
3670
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3667

def get_email_dashboard_activity(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_dashboard_activity_with_http_info(storefront_oid, opts)
  data
end

#get_email_dashboard_activity_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailDashboardActivityResponse, Integer, Hash)>

Get email dashboard activity

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :last_records (Integer)

Returns:



3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3677

def get_email_dashboard_activity_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dashboard_activity ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dashboard_activity"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/dashboard_activity'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'last_records'] = opts[:'last_records'] if !opts[:'last_records'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailDashboardActivityResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_dashboard_activity",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_dashboard_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_dashboard_stats(storefront_oid, opts = {}) ⇒ EmailDashboardStatsResponse

Get dashboard stats

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



3732
3733
3734
3735
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3732

def get_email_dashboard_stats(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_dashboard_stats_with_http_info(storefront_oid, opts)
  data
end

#get_email_dashboard_stats_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailDashboardStatsResponse, Integer, Hash)>

Get dashboard stats

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailDashboardStatsResponse, Integer, Hash)>) —

    EmailDashboardStatsResponse data, response status code and response headers



3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3742

def get_email_dashboard_stats_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dashboard_stats ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dashboard_stats"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/dashboard_stats'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailDashboardStatsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_dashboard_stats",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_dashboard_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ EmailCommseqStepLogsResponse

Get email dispatch logs

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3798
3799
3800
3801
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3798

def get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  data, _status_code, _headers = get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
  data
end

#get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ Array<(EmailCommseqStepLogsResponse, Integer, Hash)>

Get email dispatch logs

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3809

def get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dispatch_logs ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dispatch_logs"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_dispatch_logs"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_dispatch_logs"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqStepLogsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_dispatch_logs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_email(storefront_oid, commseq_email_uuid, opts = {}) ⇒ EmailCommseqEmailResponse

Get email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3871
3872
3873
3874
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3871

def get_email_email(storefront_oid, commseq_email_uuid, opts = {})
  data, _status_code, _headers = get_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts)
  data
end

#get_email_email_clicks(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {}) ⇒ EmailClicksResponse

Get email email clicks

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



3942
3943
3944
3945
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3942

def get_email_email_clicks(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {})
  data, _status_code, _headers = get_email_email_clicks_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts)
  data
end

#get_email_email_clicks_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {}) ⇒ Array<(EmailClicksResponse, Integer, Hash)>

Get email email clicks

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailClicksResponse, Integer, Hash)>) —

    EmailClicksResponse data, response status code and response headers



3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3955

def get_email_email_clicks_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_email_clicks ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_email_clicks"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_email_clicks"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_email_clicks"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_email_clicks"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailClicksResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_email_clicks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_email_clicks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_email_customer_editor_url(storefront_oid, commseq_email_uuid, order_id, opts = {}) ⇒ EmailCustomerEditorUrlResponse

Get email order customer editor url

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • order_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4023
4024
4025
4026
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4023

def get_email_email_customer_editor_url(storefront_oid, commseq_email_uuid, order_id, opts = {})
  data, _status_code, _headers = get_email_email_customer_editor_url_with_http_info(storefront_oid, commseq_email_uuid, order_id, opts)
  data
end

#get_email_email_customer_editor_url_with_http_info(storefront_oid, commseq_email_uuid, order_id, opts = {}) ⇒ Array<(EmailCustomerEditorUrlResponse, Integer, Hash)>

Get email order customer editor url

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • order_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4034

def get_email_email_customer_editor_url_with_http_info(storefront_oid, commseq_email_uuid, order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_email_customer_editor_url ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_email_customer_editor_url"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_email_customer_editor_url"
  end
  # verify the required parameter 'order_id' is set
  if @api_client.config.client_side_validation && order_id.nil?
    fail ArgumentError, "Missing the required parameter 'order_id' when calling StorefrontApi.get_email_email_customer_editor_url"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s)).sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCustomerEditorUrlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_email_customer_editor_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_email_customer_editor_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_email_orders(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {}) ⇒ EmailOrdersResponse

Get email email orders

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



4099
4100
4101
4102
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4099

def get_email_email_orders(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {})
  data, _status_code, _headers = get_email_email_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts)
  data
end

#get_email_email_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {}) ⇒ Array<(EmailOrdersResponse, Integer, Hash)>

Get email email orders

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailOrdersResponse, Integer, Hash)>) —

    EmailOrdersResponse data, response status code and response headers



4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4112

def get_email_email_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, commseq_email_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_email_orders ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_email_orders"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_email_orders"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_email_orders"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_email_orders"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailOrdersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_email_orders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_email_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts = {}) ⇒ Array<(EmailCommseqEmailResponse, Integer, Hash)>

Get email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Integer, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3881

def get_email_email_with_http_info(storefront_oid, commseq_email_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_email"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_emails(storefront_oid, opts = {}) ⇒ EmailCommseqEmailsResponse

Get email emails

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4178
4179
4180
4181
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4178

def get_email_emails(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_emails_with_http_info(storefront_oid, opts)
  data
end

#get_email_emails_multiple(storefront_oid, email_commseq_emails_request, opts = {}) ⇒ EmailCommseqEmailsResponse

Get email emails multiple

Parameters:

  • storefront_oid (Integer)
  • email_commseq_emails_request (EmailCommseqEmailsRequest) —

    Request of email uuids

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4241
4242
4243
4244
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4241

def get_email_emails_multiple(storefront_oid, email_commseq_emails_request, opts = {})
  data, _status_code, _headers = get_email_emails_multiple_with_http_info(storefront_oid, email_commseq_emails_request, opts)
  data
end

#get_email_emails_multiple_with_http_info(storefront_oid, email_commseq_emails_request, opts = {}) ⇒ Array<(EmailCommseqEmailsResponse, Integer, Hash)>

Get email emails multiple

Parameters:

  • storefront_oid (Integer)
  • email_commseq_emails_request (EmailCommseqEmailsRequest) —

    Request of email uuids

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailsResponse, Integer, Hash)>) —

    EmailCommseqEmailsResponse data, response status code and response headers



4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4251

def get_email_emails_multiple_with_http_info(storefront_oid, email_commseq_emails_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_emails_multiple ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_emails_multiple"
  end
  # verify the required parameter 'email_commseq_emails_request' is set
  if @api_client.config.client_side_validation && email_commseq_emails_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_emails_request' when calling StorefrontApi.get_email_emails_multiple"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/multiple'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_emails_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_emails_multiple",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_emails_multiple\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_emails_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCommseqEmailsResponse, Integer, Hash)>

Get email emails

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailsResponse, Integer, Hash)>) —

    EmailCommseqEmailsResponse data, response status code and response headers



4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4187

def get_email_emails_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_emails ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_emails"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_emails",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_flow(storefront_oid, email_flow_uuid, opts = {}) ⇒ EmailFlowResponse

Get email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4314
4315
4316
4317
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4314

def get_email_flow(storefront_oid, email_flow_uuid, opts = {})
  data, _status_code, _headers = get_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts)
  data
end

#get_email_flow_folder(storefront_oid, email_flow_folder_uuid, opts = {}) ⇒ EmailFlowFolderResponse

Get email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4382
4383
4384
4385
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4382

def get_email_flow_folder(storefront_oid, email_flow_folder_uuid, opts = {})
  data, _status_code, _headers = get_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts)
  data
end

#get_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts = {}) ⇒ Array<(EmailFlowFolderResponse, Integer, Hash)>

Get email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Integer, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4392

def get_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_flow_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_flow_folder"
  end
  # verify the required parameter 'email_flow_folder_uuid' is set
  if @api_client.config.client_side_validation && email_flow_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_folder_uuid' when calling StorefrontApi.get_email_flow_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_folder_uuid' + '}', CGI.escape(email_flow_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_flow_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_flow_folders(storefront_oid, opts = {}) ⇒ EmailFlowFoldersResponse

Get email flow folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4449
4450
4451
4452
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4449

def get_email_flow_folders(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_flow_folders_with_http_info(storefront_oid, opts)
  data
end

#get_email_flow_folders_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailFlowFoldersResponse, Integer, Hash)>

Get email flow folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowFoldersResponse, Integer, Hash)>) —

    EmailFlowFoldersResponse data, response status code and response headers



4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4458

def get_email_flow_folders_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_flow_folders ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_flow_folders"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flow_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowFoldersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_flow_folders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_flow_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_flow_screenshots(storefront_oid, email_flow_uuid, opts = {}) ⇒ ScreenshotsResponse

Get email flow screenshots

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4512
4513
4514
4515
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4512

def get_email_flow_screenshots(storefront_oid, email_flow_uuid, opts = {})
  data, _status_code, _headers = get_email_flow_screenshots_with_http_info(storefront_oid, email_flow_uuid, opts)
  data
end

#get_email_flow_screenshots_with_http_info(storefront_oid, email_flow_uuid, opts = {}) ⇒ Array<(ScreenshotsResponse, Integer, Hash)>

Get email flow screenshots

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScreenshotsResponse, Integer, Hash)>) —

    ScreenshotsResponse data, response status code and response headers



4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4522

def get_email_flow_screenshots_with_http_info(storefront_oid, email_flow_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_flow_screenshots ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_flow_screenshots"
  end
  # verify the required parameter 'email_flow_uuid' is set
  if @api_client.config.client_side_validation && email_flow_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_uuid' when calling StorefrontApi.get_email_flow_screenshots"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_uuid' + '}', CGI.escape(email_flow_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenshotsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_flow_screenshots",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_flow_screenshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts = {}) ⇒ Array<(EmailFlowResponse, Integer, Hash)>

Get email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowResponse, Integer, Hash)>) —

    EmailFlowResponse data, response status code and response headers



4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4324

def get_email_flow_with_http_info(storefront_oid, email_flow_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_flow ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_flow"
  end
  # verify the required parameter 'email_flow_uuid' is set
  if @api_client.config.client_side_validation && email_flow_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_uuid' when calling StorefrontApi.get_email_flow"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows/{email_flow_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_uuid' + '}', CGI.escape(email_flow_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_flow",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_flows(storefront_oid, opts = {}) ⇒ EmailFlowsResponse

Get email flows

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4579
4580
4581
4582
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4579

def get_email_flows(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_flows_with_http_info(storefront_oid, opts)
  data
end

#get_email_flows_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailFlowsResponse, Integer, Hash)>

Get email flows

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowsResponse, Integer, Hash)>) —

    EmailFlowsResponse data, response status code and response headers



4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4588

def get_email_flows_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_flows ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_flows"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_flows",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_flows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_global_settings(opts = {}) ⇒ EmailGlobalSettingsResponse

Get email globalsettings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4640
4641
4642
4643
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4640

def get_email_global_settings(opts = {})
  data, _status_code, _headers = get_email_global_settings_with_http_info(opts)
  data
end

#get_email_global_settings_with_http_info(opts = {}) ⇒ Array<(EmailGlobalSettingsResponse, Integer, Hash)>

Get email globalsettings

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailGlobalSettingsResponse, Integer, Hash)>) —

    EmailGlobalSettingsResponse data, response status code and response headers



4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4648

def get_email_global_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_global_settings ...'
  end
  # resource path
  local_var_path = '/storefront/email/global_settings'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailGlobalSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_global_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_global_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_list(storefront_oid, email_list_uuid, opts = {}) ⇒ EmailListResponse

Get email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4698
4699
4700
4701
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4698

def get_email_list(storefront_oid, email_list_uuid, opts = {})
  data, _status_code, _headers = get_email_list_with_http_info(storefront_oid, email_list_uuid, opts)
  data
end

#get_email_list_customer_editor_url(storefront_oid, email_list_uuid, email_customer_uuid, opts = {}) ⇒ EmailCustomerEditorUrlResponse

Get email list customer editor url

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4767
4768
4769
4770
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4767

def get_email_list_customer_editor_url(storefront_oid, email_list_uuid, email_customer_uuid, opts = {})
  data, _status_code, _headers = get_email_list_customer_editor_url_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts)
  data
end

#get_email_list_customer_editor_url_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts = {}) ⇒ Array<(EmailCustomerEditorUrlResponse, Integer, Hash)>

Get email list customer editor url

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4778

def get_email_list_customer_editor_url_with_http_info(storefront_oid, email_list_uuid, email_customer_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_list_customer_editor_url ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_list_customer_editor_url"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.get_email_list_customer_editor_url"
  end
  # verify the required parameter 'email_customer_uuid' is set
  if @api_client.config.client_side_validation && email_customer_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.get_email_list_customer_editor_url"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCustomerEditorUrlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_list_customer_editor_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_list_customer_editor_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_list_customers(storefront_oid, email_list_uuid, opts = {}) ⇒ EmailListCustomersResponse

Get email list customers

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



4842
4843
4844
4845
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4842

def get_email_list_customers(storefront_oid, email_list_uuid, opts = {})
  data, _status_code, _headers = get_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts)
  data
end

#get_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts = {}) ⇒ Array<(EmailListCustomersResponse, Integer, Hash)>

Get email list customers

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(EmailListCustomersResponse, Integer, Hash)>) —

    EmailListCustomersResponse data, response status code and response headers



4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4854

def get_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_list_customers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_list_customers"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.get_email_list_customers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListCustomersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_list_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_list_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, opts = {}) ⇒ EmailListSegmentFolderResponse

Get email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4914
4915
4916
4917
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4914

def get_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, opts = {})
  data, _status_code, _headers = get_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts)
  data
end

#get_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts = {}) ⇒ Array<(EmailListSegmentFolderResponse, Integer, Hash)>

Get email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4924

def get_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_list_segment_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_list_segment_folder"
  end
  # verify the required parameter 'email_list_segment_folder_uuid' is set
  if @api_client.config.client_side_validation && email_list_segment_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_segment_folder_uuid' when calling StorefrontApi.get_email_list_segment_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_segment_folder_uuid' + '}', CGI.escape(email_list_segment_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListSegmentFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_list_segment_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_list_segment_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_list_segment_folders(storefront_oid, opts = {}) ⇒ EmailListSegmentFoldersResponse

Get email campaign folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4981
4982
4983
4984
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4981

def get_email_list_segment_folders(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_list_segment_folders_with_http_info(storefront_oid, opts)
  data
end

#get_email_list_segment_folders_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailListSegmentFoldersResponse, Integer, Hash)>

Get email campaign folders

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4990

def get_email_list_segment_folders_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_list_segment_folders ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_list_segment_folders"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListSegmentFoldersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_list_segment_folders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_list_segment_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_list_with_http_info(storefront_oid, email_list_uuid, opts = {}) ⇒ Array<(EmailListResponse, Integer, Hash)>

Get email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Integer, Hash)>) —

    EmailListResponse data, response status code and response headers



4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4708

def get_email_list_with_http_info(storefront_oid, email_list_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_list"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.get_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_lists(storefront_oid, opts = {}) ⇒ EmailListsResponse

Get email lists

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5043
5044
5045
5046
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5043

def get_email_lists(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_lists_with_http_info(storefront_oid, opts)
  data
end

#get_email_lists_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailListsResponse, Integer, Hash)>

Get email lists

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListsResponse, Integer, Hash)>) —

    EmailListsResponse data, response status code and response headers



5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5052

def get_email_lists_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_lists ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_lists"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_lists",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_performance(storefront_oid, opts = {}) ⇒ EmailPerformanceResponse

Get email performance

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5105
5106
5107
5108
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5105

def get_email_performance(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_performance_with_http_info(storefront_oid, opts)
  data
end

#get_email_performance_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailPerformanceResponse, Integer, Hash)>

Get email performance

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailPerformanceResponse, Integer, Hash)>) —

    EmailPerformanceResponse data, response status code and response headers



5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5114

def get_email_performance_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_performance ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_performance"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/performance'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailPerformanceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_performance",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_performance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_plan(storefront_oid, opts = {}) ⇒ EmailPlanResponse

Get email plan

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5167
5168
5169
5170
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5167

def get_email_plan(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_plan_with_http_info(storefront_oid, opts)
  data
end

#get_email_plan_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailPlanResponse, Integer, Hash)>

Get email plan

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailPlanResponse, Integer, Hash)>) —

    EmailPlanResponse data, response status code and response headers



5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5176

def get_email_plan_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_plan ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_plan"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/plan'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailPlanResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_plan",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_postcard(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ EmailCommseqPostcardResponse

Get email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5230
5231
5232
5233
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5230

def get_email_postcard(storefront_oid, commseq_postcard_uuid, opts = {})
  data, _status_code, _headers = get_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
  data
end

#get_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {}) ⇒ Array<(EmailCommseqPostcardResponse, Integer, Hash)>

Get email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5240

def get_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_postcard ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_postcard"
  end
  # verify the required parameter 'commseq_postcard_uuid' is set
  if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_postcard"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_postcard",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_postcards(storefront_oid, opts = {}) ⇒ EmailCommseqPostcardsResponse

Get email postcards

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5297
5298
5299
5300
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5297

def get_email_postcards(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_postcards_with_http_info(storefront_oid, opts)
  data
end

#get_email_postcards_multiple(storefront_oid, email_commseq_postcards_request, opts = {}) ⇒ EmailCommseqPostcardsResponse

Get email postcards multiple

Parameters:

  • storefront_oid (Integer)
  • email_commseq_postcards_request (EmailCommseqPostcardsRequest) —

    Request of postcard uuids

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5360
5361
5362
5363
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5360

def get_email_postcards_multiple(storefront_oid, email_commseq_postcards_request, opts = {})
  data, _status_code, _headers = get_email_postcards_multiple_with_http_info(storefront_oid, email_commseq_postcards_request, opts)
  data
end

#get_email_postcards_multiple_with_http_info(storefront_oid, email_commseq_postcards_request, opts = {}) ⇒ Array<(EmailCommseqPostcardsResponse, Integer, Hash)>

Get email postcards multiple

Parameters:

  • storefront_oid (Integer)
  • email_commseq_postcards_request (EmailCommseqPostcardsRequest) —

    Request of postcard uuids

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5370

def get_email_postcards_multiple_with_http_info(storefront_oid, email_commseq_postcards_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_postcards_multiple ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_postcards_multiple"
  end
  # verify the required parameter 'email_commseq_postcards_request' is set
  if @api_client.config.client_side_validation && email_commseq_postcards_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_postcards_request' when calling StorefrontApi.get_email_postcards_multiple"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/multiple'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_postcards_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_postcards_multiple",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_postcards_multiple\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_postcards_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailCommseqPostcardsResponse, Integer, Hash)>

Get email postcards

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5306

def get_email_postcards_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_postcards ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_postcards"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_postcards",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_postcards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_segment(storefront_oid, email_segment_uuid, opts = {}) ⇒ EmailSegmentResponse

Get email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5433
5434
5435
5436
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5433

def get_email_segment(storefront_oid, email_segment_uuid, opts = {})
  data, _status_code, _headers = get_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
  data
end

#get_email_segment_customer_editor_url(storefront_oid, email_segment_uuid, email_customer_uuid, opts = {}) ⇒ EmailCustomerEditorUrlResponse

Get email segment customers editor URL

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5502
5503
5504
5505
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5502

def get_email_segment_customer_editor_url(storefront_oid, email_segment_uuid, email_customer_uuid, opts = {})
  data, _status_code, _headers = get_email_segment_customer_editor_url_with_http_info(storefront_oid, email_segment_uuid, email_customer_uuid, opts)
  data
end

#get_email_segment_customer_editor_url_with_http_info(storefront_oid, email_segment_uuid, email_customer_uuid, opts = {}) ⇒ Array<(EmailCustomerEditorUrlResponse, Integer, Hash)>

Get email segment customers editor URL

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_customer_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5513

def get_email_segment_customer_editor_url_with_http_info(storefront_oid, email_segment_uuid, email_customer_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_segment_customer_editor_url ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_segment_customer_editor_url"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.get_email_segment_customer_editor_url"
  end
  # verify the required parameter 'email_customer_uuid' is set
  if @api_client.config.client_side_validation && email_customer_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.get_email_segment_customer_editor_url"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCustomerEditorUrlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_segment_customer_editor_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_segment_customer_editor_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_segment_customers(storefront_oid, email_segment_uuid, opts = {}) ⇒ EmailSegmentCustomersResponse

Get email segment customers

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



5577
5578
5579
5580
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5577

def get_email_segment_customers(storefront_oid, email_segment_uuid, opts = {})
  data, _status_code, _headers = get_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts)
  data
end

#get_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentCustomersResponse, Integer, Hash)>

Get email segment customers

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5589

def get_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_segment_customers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_segment_customers"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.get_email_segment_customers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentCustomersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_segment_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_segment_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentResponse, Integer, Hash)>

Get email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Integer, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5443

def get_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.get_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_segments(storefront_oid, opts = {}) ⇒ EmailSegmentsResponse

Get email segments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5648
5649
5650
5651
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5648

def get_email_segments(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_segments_with_http_info(storefront_oid, opts)
  data
end

#get_email_segments_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailSegmentsResponse, Integer, Hash)>

Get email segments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSegmentsResponse, Integer, Hash)>) —

    EmailSegmentsResponse data, response status code and response headers



5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5657

def get_email_segments_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_segments ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_segments"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_segments",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_sending_domain(domain, opts = {}) ⇒ EmailSendingDomainResponse

Get email sending domain

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5710
5711
5712
5713
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5710

def get_email_sending_domain(domain, opts = {})
  data, _status_code, _headers = get_email_sending_domain_with_http_info(domain, opts)
  data
end

#get_email_sending_domain_status(domain, opts = {}) ⇒ EmailSendingDomainResponse

Get email sending domain status

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5772
5773
5774
5775
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5772

def get_email_sending_domain_status(domain, opts = {})
  data, _status_code, _headers = get_email_sending_domain_status_with_http_info(domain, opts)
  data
end

#get_email_sending_domain_status_with_http_info(domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Integer, Hash)>

Get email sending domain status

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainResponse, Integer, Hash)>) —

    EmailSendingDomainResponse data, response status code and response headers



5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5781

def get_email_sending_domain_status_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sending_domain_status ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling StorefrontApi.get_email_sending_domain_status"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains/{domain}/status'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_sending_domain_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_sending_domain_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_sending_domain_with_http_info(domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Integer, Hash)>

Get email sending domain

Parameters:

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainResponse, Integer, Hash)>) —

    EmailSendingDomainResponse data, response status code and response headers



5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5719

def get_email_sending_domain_with_http_info(domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sending_domain ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling StorefrontApi.get_email_sending_domain"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domain/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_sending_domain",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_sending_domains(opts = {}) ⇒ EmailSendingDomainsResponse

Get email sending domains

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5833
5834
5835
5836
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5833

def get_email_sending_domains(opts = {})
  data, _status_code, _headers = get_email_sending_domains_with_http_info(opts)
  data
end

#get_email_sending_domains_with_http_info(opts = {}) ⇒ Array<(EmailSendingDomainsResponse, Integer, Hash)>

Get email sending domains

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainsResponse, Integer, Hash)>) —

    EmailSendingDomainsResponse data, response status code and response headers



5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5841

def get_email_sending_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sending_domains ...'
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_sending_domains",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_settings(storefront_oid, opts = {}) ⇒ EmailSettingsResponse

Get email settings

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5890
5891
5892
5893
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5890

def get_email_settings(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_settings_with_http_info(storefront_oid, opts)
  data
end

#get_email_settings_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailSettingsResponse, Integer, Hash)>

Get email settings

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSettingsResponse, Integer, Hash)>) —

    EmailSettingsResponse data, response status code and response headers



5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5899

def get_email_settings_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_settings ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_settings"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ EmailSmsOrdersResponse

Get email sms orders

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



5955
5956
5957
5958
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5955

def get_email_sms_orders(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  data, _status_code, _headers = get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
  data
end

#get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ Array<(EmailSmsOrdersResponse, Integer, Hash)>

Get email sms orders

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailSmsOrdersResponse, Integer, Hash)>) —

    EmailSmsOrdersResponse data, response status code and response headers



5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5967

def get_email_sms_orders_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_sms_orders ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_sms_orders"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_sms_orders"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_sms_orders"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSmsOrdersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_sms_orders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_sms_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_template(storefront_oid, email_template_oid, opts = {}) ⇒ EmailTemplate

Get email template

Parameters:

  • storefront_oid (Integer)
  • email_template_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6030
6031
6032
6033
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6030

def get_email_template(storefront_oid, email_template_oid, opts = {})
  data, _status_code, _headers = get_email_template_with_http_info(storefront_oid, email_template_oid, opts)
  data
end

#get_email_template_with_http_info(storefront_oid, email_template_oid, opts = {}) ⇒ Array<(EmailTemplate, Integer, Hash)>

Get email template

Parameters:

  • storefront_oid (Integer)
  • email_template_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailTemplate, Integer, Hash)>) —

    EmailTemplate data, response status code and response headers



6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6040

def get_email_template_with_http_info(storefront_oid, email_template_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_template ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_template"
  end
  # verify the required parameter 'email_template_oid' is set
  if @api_client.config.client_side_validation && email_template_oid.nil?
    fail ArgumentError, "Missing the required parameter 'email_template_oid' when calling StorefrontApi.get_email_template"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/templates/{email_template_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_template_oid' + '}', CGI.escape(email_template_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailTemplate'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_templates(storefront_oid, opts = {}) ⇒ EmailTemplatesResponse

Get email templates

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :trigger_type (String)

Returns:



6098
6099
6100
6101
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6098

def get_email_templates(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_templates_with_http_info(storefront_oid, opts)
  data
end

#get_email_templates_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailTemplatesResponse, Integer, Hash)>

Get email templates

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :trigger_type (String)

Returns:

  • (Array<(EmailTemplatesResponse, Integer, Hash)>) —

    EmailTemplatesResponse data, response status code and response headers



6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6108

def get_email_templates_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_templates ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_templates"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/templates'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'trigger_type'] = opts[:'trigger_type'] if !opts[:'trigger_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailTemplatesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_templates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_third_party_providers(storefront_oid, opts = {}) ⇒ EmailThirdPartyProvidersResponse

Get a list of third party email providers

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6162
6163
6164
6165
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6162

def get_email_third_party_providers(storefront_oid, opts = {})
  data, _status_code, _headers = get_email_third_party_providers_with_http_info(storefront_oid, opts)
  data
end

#get_email_third_party_providers_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailThirdPartyProvidersResponse, Integer, Hash)>

Get a list of third party email providers

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6171

def get_email_third_party_providers_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_third_party_providers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_third_party_providers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/third_party_providers'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailThirdPartyProvidersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_email_third_party_providers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_email_third_party_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_experiments(storefront_oid, opts = {}) ⇒ ExperimentsResponse

Get experiments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6224
6225
6226
6227
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6224

def get_experiments(storefront_oid, opts = {})
  data, _status_code, _headers = get_experiments_with_http_info(storefront_oid, opts)
  data
end

#get_experiments_with_http_info(storefront_oid, opts = {}) ⇒ Array<(ExperimentsResponse, Integer, Hash)>

Get experiments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExperimentsResponse, Integer, Hash)>) —

    ExperimentsResponse data, response status code and response headers



6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6233

def get_experiments_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_experiments ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_experiments"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/experiments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ExperimentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_experiments",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_experiments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fs_directory(id, opts = {}) ⇒ FileManagerPageResponse

Get file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String)
  • :storefront_fs_directory_oid (Integer)
  • :storefront_theme_oid (Integer)

Returns:



6289
6290
6291
6292
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6289

def get_fs_directory(id, opts = {})
  data, _status_code, _headers = get_fs_directory_with_http_info(id, opts)
  data
end

#get_fs_directory_with_http_info(id, opts = {}) ⇒ Array<(FileManagerPageResponse, Integer, Hash)>

Get file manager directory

Parameters:

  • id (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :path (String)
  • :storefront_fs_directory_oid (Integer)
  • :storefront_theme_oid (Integer)

Returns:

  • (Array<(FileManagerPageResponse, Integer, Hash)>) —

    FileManagerPageResponse data, response status code and response headers



6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6301

def get_fs_directory_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_fs_directory ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_fs_directory"
  end
  # resource path
  local_var_path = '/storefront/{id}/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
  query_params[:'storefront_fs_directory_oid'] = opts[:'storefront_fs_directory_oid'] if !opts[:'storefront_fs_directory_oid'].nil?
  query_params[:'storefront_theme_oid'] = opts[:'storefront_theme_oid'] if !opts[:'storefront_theme_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FileManagerPageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_fs_directory",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_heatmap(storefront_oid, query, opts = {}) ⇒ ScreenRecordingHeatmapResponse

Get screen recording heatmap Get screen recording heatmap

Parameters:

Returns:



6359
6360
6361
6362
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6359

def get_heatmap(storefront_oid, query, opts = {})
  data, _status_code, _headers = get_heatmap_with_http_info(storefront_oid, query, opts)
  data
end

#get_heatmap_index(storefront_oid, query, opts = {}) ⇒ ScreenRecordingHeatmapIndexResponse

Get screen recording heatmap index Get screen recording heatmap index

Parameters:

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



6437
6438
6439
6440
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6437

def get_heatmap_index(storefront_oid, query, opts = {})
  data, _status_code, _headers = get_heatmap_index_with_http_info(storefront_oid, query, opts)
  data
end

#get_heatmap_index_with_http_info(storefront_oid, query, opts = {}) ⇒ Array<(ScreenRecordingHeatmapIndexResponse, Integer, Hash)>

Get screen recording heatmap index Get screen recording heatmap index

Parameters:

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6451

def get_heatmap_index_with_http_info(storefront_oid, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap_index ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap_index"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_heatmap_index"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap/index'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(query)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingHeatmapIndexResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_heatmap_index",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_heatmap_with_http_info(storefront_oid, query, opts = {}) ⇒ Array<(ScreenRecordingHeatmapResponse, Integer, Hash)>

Get screen recording heatmap Get screen recording heatmap

Parameters:

Returns:



6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6370

def get_heatmap_with_http_info(storefront_oid, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_heatmap ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_heatmap"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_heatmap"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/heatmap'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(query)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingHeatmapResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_heatmap",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_heatmap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_histogram_property_names(storefront_oid, opts = {}) ⇒ EmailHistogramPropertyNamesResponse

Get histogram property names Obtain a list of property names for a given property type

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_type (String)

Returns:



6518
6519
6520
6521
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6518

def get_histogram_property_names(storefront_oid, opts = {})
  data, _status_code, _headers = get_histogram_property_names_with_http_info(storefront_oid, opts)
  data
end

#get_histogram_property_names_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailHistogramPropertyNamesResponse, Integer, Hash)>

Get histogram property names Obtain a list of property names for a given property type

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_type (String)

Returns:



6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6529

def get_histogram_property_names_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_histogram_property_names ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_histogram_property_names"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/histogram/property_names'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'property_type'] = opts[:'property_type'] if !opts[:'property_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailHistogramPropertyNamesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_histogram_property_names",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_histogram_property_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_histogram_property_values(storefront_oid, opts = {}) ⇒ EmailHistogramPropertyValuesResponse

Get histogram property values Obtain a list of property values for a given property name and type

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_name (String)
  • :property_type (String)
  • :limit (Integer)

Returns:



6587
6588
6589
6590
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6587

def get_histogram_property_values(storefront_oid, opts = {})
  data, _status_code, _headers = get_histogram_property_values_with_http_info(storefront_oid, opts)
  data
end

#get_histogram_property_values_with_http_info(storefront_oid, opts = {}) ⇒ Array<(EmailHistogramPropertyValuesResponse, Integer, Hash)>

Get histogram property values Obtain a list of property values for a given property name and type

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_name (String)
  • :property_type (String)
  • :limit (Integer)

Returns:



6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6600

def get_histogram_property_values_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_histogram_property_values ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_histogram_property_values"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/histogram/property_values'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'property_name'] = opts[:'property_name'] if !opts[:'property_name'].nil?
  query_params[:'property_type'] = opts[:'property_type'] if !opts[:'property_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailHistogramPropertyValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_histogram_property_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_histogram_property_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_library_filter_values(opts = {}) ⇒ LibraryFilterValuesResponse

Get library values used to populate drop down boxes for filtering.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6655
6656
6657
6658
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6655

def get_library_filter_values(opts = {})
  data, _status_code, _headers = get_library_filter_values_with_http_info(opts)
  data
end

#get_library_filter_values_with_http_info(opts = {}) ⇒ Array<(LibraryFilterValuesResponse, Integer, Hash)>

Get library values used to populate drop down boxes for filtering.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryFilterValuesResponse, Integer, Hash)>) —

    LibraryFilterValuesResponse data, response status code and response headers



6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6663

def get_library_filter_values_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_library_filter_values ...'
  end
  # resource path
  local_var_path = '/storefront/code_library/filter_values'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryFilterValuesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_library_filter_values",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_library_filter_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_library_item(library_item_oid, opts = {}) ⇒ LibraryItemResponse

Get library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6712
6713
6714
6715
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6712

def get_library_item(library_item_oid, opts = {})
  data, _status_code, _headers = get_library_item_with_http_info(library_item_oid, opts)
  data
end

#get_library_item_published_versions(library_item_oid, opts = {}) ⇒ LibraryItemsResponse

Get all published versions for a library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6774
6775
6776
6777
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6774

def get_library_item_published_versions(library_item_oid, opts = {})
  data, _status_code, _headers = get_library_item_published_versions_with_http_info(library_item_oid, opts)
  data
end

#get_library_item_published_versions_with_http_info(library_item_oid, opts = {}) ⇒ Array<(LibraryItemsResponse, Integer, Hash)>

Get all published versions for a library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemsResponse, Integer, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6783

def get_library_item_published_versions_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_library_item_published_versions ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.get_library_item_published_versions"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}/published_versions'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_library_item_published_versions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_library_item_published_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_library_item_with_http_info(library_item_oid, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Get library item.

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6721

def get_library_item_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.get_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording(storefront_oid, screen_recording_uuid, opts = {}) ⇒ ScreenRecordingResponse

Get screen recording Get screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6838
6839
6840
6841
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6838

def get_screen_recording(storefront_oid, screen_recording_uuid, opts = {})
  data, _status_code, _headers = get_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
  data
end

#get_screen_recording_page_view_data(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {}) ⇒ ScreenRecordingPageViewDataResponse

Get screen recording page view data Get screen recording page view data

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • screen_recording_page_view_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6909
6910
6911
6912
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6909

def get_screen_recording_page_view_data(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
  data, _status_code, _headers = get_screen_recording_page_view_data_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts)
  data
end

#get_screen_recording_page_view_data_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {}) ⇒ Array<(ScreenRecordingPageViewDataResponse, Integer, Hash)>

Get screen recording page view data Get screen recording page view data

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • screen_recording_page_view_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6921

def get_screen_recording_page_view_data_with_http_info(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording_page_view_data ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording_page_view_data"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.get_screen_recording_page_view_data"
  end
  # verify the required parameter 'screen_recording_page_view_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_page_view_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_page_view_uuid' when calling StorefrontApi.get_screen_recording_page_view_data"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s)).sub('{' + 'screen_recording_page_view_uuid' + '}', CGI.escape(screen_recording_page_view_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingPageViewDataResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording_page_view_data",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording_page_view_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording_segment(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ ScreenRecordingSegmentResponse

Get screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6983
6984
6985
6986
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6983

def get_screen_recording_segment(storefront_oid, screen_recording_segment_oid, opts = {})
  data, _status_code, _headers = get_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts)
  data
end

#get_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ Array<(ScreenRecordingSegmentResponse, Integer, Hash)>

Get screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6993

def get_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording_segment"
  end
  # verify the required parameter 'screen_recording_segment_oid' is set
  if @api_client.config.client_side_validation && screen_recording_segment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_segment_oid' when calling StorefrontApi.get_screen_recording_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_segment_oid' + '}', CGI.escape(screen_recording_segment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording_segments(storefront_oid, opts = {}) ⇒ ScreenRecordingSegmentsResponse

Get screen recording segments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7050
7051
7052
7053
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7050

def get_screen_recording_segments(storefront_oid, opts = {})
  data, _status_code, _headers = get_screen_recording_segments_with_http_info(storefront_oid, opts)
  data
end

#get_screen_recording_segments_with_http_info(storefront_oid, opts = {}) ⇒ Array<(ScreenRecordingSegmentsResponse, Integer, Hash)>

Get screen recording segments

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7059

def get_screen_recording_segments_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording_segments ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording_segments"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSegmentsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording_segments",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording_settings(storefront_oid, opts = {}) ⇒ ScreenRecordingSettingsResponse

Get screen recording settings

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7112
7113
7114
7115
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7112

def get_screen_recording_settings(storefront_oid, opts = {})
  data, _status_code, _headers = get_screen_recording_settings_with_http_info(storefront_oid, opts)
  data
end

#get_screen_recording_settings_with_http_info(storefront_oid, opts = {}) ⇒ Array<(ScreenRecordingSettingsResponse, Integer, Hash)>

Get screen recording settings

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7121

def get_screen_recording_settings_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording_settings ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording_settings"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording_tags(storefront_oid, opts = {}) ⇒ ScreenRecordingTagsResponse

Get tags used by screen recording Get tags used by screen recording

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7175
7176
7177
7178
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7175

def get_screen_recording_tags(storefront_oid, opts = {})
  data, _status_code, _headers = get_screen_recording_tags_with_http_info(storefront_oid, opts)
  data
end

#get_screen_recording_tags_with_http_info(storefront_oid, opts = {}) ⇒ Array<(ScreenRecordingTagsResponse, Integer, Hash)>

Get tags used by screen recording Get tags used by screen recording

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScreenRecordingTagsResponse, Integer, Hash)>) —

    ScreenRecordingTagsResponse data, response status code and response headers



7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7185

def get_screen_recording_tags_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording_tags ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording_tags"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/tags'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingTagsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording_tags",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {}) ⇒ Array<(ScreenRecordingResponse, Integer, Hash)>

Get screen recording Get screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScreenRecordingResponse, Integer, Hash)>) —

    ScreenRecordingResponse data, response status code and response headers



6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6849

def get_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recording ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recording"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.get_screen_recording"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recording",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recordings_by_query(storefront_oid, query, opts = {}) ⇒ ScreenRecordingQueryResponse

Query screen recordings Query screen recordings

Parameters:

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



7243
7244
7245
7246
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7243

def get_screen_recordings_by_query(storefront_oid, query, opts = {})
  data, _status_code, _headers = get_screen_recordings_by_query_with_http_info(storefront_oid, query, opts)
  data
end

#get_screen_recordings_by_query_with_http_info(storefront_oid, query, opts = {}) ⇒ Array<(ScreenRecordingQueryResponse, Integer, Hash)>

Query screen recordings Query screen recordings

Parameters:

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7257

def get_screen_recordings_by_query_with_http_info(storefront_oid, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recordings_by_query ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recordings_by_query"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling StorefrontApi.get_screen_recordings_by_query"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/query'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(query)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recordings_by_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recordings_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_screen_recordings_by_segment(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ ScreenRecordingQueryResponse

Get screen recordings by segment Get screen recordings by segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



7327
7328
7329
7330
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7327

def get_screen_recordings_by_segment(storefront_oid, screen_recording_segment_oid, opts = {})
  data, _status_code, _headers = get_screen_recordings_by_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts)
  data
end

#get_screen_recordings_by_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {}) ⇒ Array<(ScreenRecordingQueryResponse, Integer, Hash)>

Get screen recordings by segment Get screen recordings by segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7341

def get_screen_recordings_by_segment_with_http_info(storefront_oid, screen_recording_segment_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_screen_recordings_by_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_screen_recordings_by_segment"
  end
  # verify the required parameter 'screen_recording_segment_oid' is set
  if @api_client.config.client_side_validation && screen_recording_segment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_segment_oid' when calling StorefrontApi.get_screen_recordings_by_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_segment_oid' + '}', CGI.escape(screen_recording_segment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_screen_recordings_by_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_screen_recordings_by_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_store_front_pricing_tiers(opts = {}) ⇒ PricingTiersResponse

Retrieve pricing tiers Retrieves the pricing tiers

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:



7402
7403
7404
7405
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7402

def get_store_front_pricing_tiers(opts = {})
  data, _status_code, _headers = get_store_front_pricing_tiers_with_http_info(opts)
  data
end

#get_store_front_pricing_tiers_with_http_info(opts = {}) ⇒ Array<(PricingTiersResponse, Integer, Hash)>

Retrieve pricing tiers Retrieves the pricing tiers

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_expand (String) —

    The object expansion to perform on the result. See documentation for examples

Returns:

  • (Array<(PricingTiersResponse, Integer, Hash)>) —

    PricingTiersResponse data, response status code and response headers



7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7412

def get_store_front_pricing_tiers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_front_pricing_tiers ...'
  end
  # resource path
  local_var_path = '/storefront/pricing_tiers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PricingTiersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_store_front_pricing_tiers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_store_front_pricing_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_store_fronts(opts = {}) ⇒ StoreFrontsResponse

Get storefronts (internal use only for security reasons)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7461
7462
7463
7464
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7461

def get_store_fronts(opts = {})
  data, _status_code, _headers = get_store_fronts_with_http_info(opts)
  data
end

#get_store_fronts_with_http_info(opts = {}) ⇒ Array<(StoreFrontsResponse, Integer, Hash)>

Get storefronts (internal use only for security reasons)

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StoreFrontsResponse, Integer, Hash)>) —

    StoreFrontsResponse data, response status code and response headers



7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7469

def get_store_fronts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
  end
  # resource path
  local_var_path = '/storefront'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StoreFrontsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_store_fronts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_store_fronts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_thumbnail_parameters(thumbnail_parameters, opts = {}) ⇒ ThumbnailParametersResponse

Get thumbnail parameters

Parameters:

  • thumbnail_parameters (ThumbnailParametersRequest) —

    Thumbnail Parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7518
7519
7520
7521
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7518

def get_thumbnail_parameters(thumbnail_parameters, opts = {})
  data, _status_code, _headers = get_thumbnail_parameters_with_http_info(thumbnail_parameters, opts)
  data
end

#get_thumbnail_parameters_with_http_info(thumbnail_parameters, opts = {}) ⇒ Array<(ThumbnailParametersResponse, Integer, Hash)>

Get thumbnail parameters

Parameters:

  • thumbnail_parameters (ThumbnailParametersRequest) —

    Thumbnail Parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ThumbnailParametersResponse, Integer, Hash)>) —

    ThumbnailParametersResponse data, response status code and response headers



7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7527

def get_thumbnail_parameters_with_http_info(thumbnail_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_thumbnail_parameters ...'
  end
  # verify the required parameter 'thumbnail_parameters' is set
  if @api_client.config.client_side_validation && thumbnail_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'thumbnail_parameters' when calling StorefrontApi.get_thumbnail_parameters"
  end
  # resource path
  local_var_path = '/storefront/thumbnailParameters'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(thumbnail_parameters)

  # return_type
  return_type = opts[:debug_return_type] || 'ThumbnailParametersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_thumbnail_parameters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_thumbnail_parameters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_email(storefront_oid, email_id, opts = {}) ⇒ TransactionEmailResponse

Gets a transaction email object Fetch a transactional email

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7587
7588
7589
7590
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7587

def get_transaction_email(storefront_oid, email_id, opts = {})
  data, _status_code, _headers = get_transaction_email_with_http_info(storefront_oid, email_id, opts)
  data
end

#get_transaction_email_list(storefront_oid, opts = {}) ⇒ TransactionEmailListResponse

Gets a list of transaction email names Obtain a list of all transactional emails and return back just their names

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7656
7657
7658
7659
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7656

def get_transaction_email_list(storefront_oid, opts = {})
  data, _status_code, _headers = get_transaction_email_list_with_http_info(storefront_oid, opts)
  data
end

#get_transaction_email_list_with_http_info(storefront_oid, opts = {}) ⇒ Array<(TransactionEmailListResponse, Integer, Hash)>

Gets a list of transaction email names Obtain a list of all transactional emails and return back just their names

Parameters:

  • storefront_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7666

def get_transaction_email_list_with_http_info(storefront_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_transaction_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_transaction_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/transaction_email/list'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionEmailListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_transaction_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_transaction_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_email_screenshots(storefront_oid, email_id, opts = {}) ⇒ ScreenshotsResponse

Get transactional email screenshots

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7720
7721
7722
7723
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7720

def get_transaction_email_screenshots(storefront_oid, email_id, opts = {})
  data, _status_code, _headers = get_transaction_email_screenshots_with_http_info(storefront_oid, email_id, opts)
  data
end

#get_transaction_email_screenshots_with_http_info(storefront_oid, email_id, opts = {}) ⇒ Array<(ScreenshotsResponse, Integer, Hash)>

Get transactional email screenshots

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScreenshotsResponse, Integer, Hash)>) —

    ScreenshotsResponse data, response status code and response headers



7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7730

def get_transaction_email_screenshots_with_http_info(storefront_oid, email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_transaction_email_screenshots ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_transaction_email_screenshots"
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling StorefrontApi.get_transaction_email_screenshots"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_id' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenshotsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_transaction_email_screenshots",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_transaction_email_screenshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_email_with_http_info(storefront_oid, email_id, opts = {}) ⇒ Array<(TransactionEmailResponse, Integer, Hash)>

Gets a transaction email object Fetch a transactional email

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransactionEmailResponse, Integer, Hash)>) —

    TransactionEmailResponse data, response status code and response headers



7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7598

def get_transaction_email_with_http_info(storefront_oid, email_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_transaction_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_transaction_email"
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling StorefrontApi.get_transaction_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/transaction_email/list/{email_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_id' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionEmailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_transaction_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_transaction_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_twilio_account(esp_twilio_uuid, opts = {}) ⇒ TwilioResponse

Get Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7787
7788
7789
7790
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7787

def (esp_twilio_uuid, opts = {})
  data, _status_code, _headers = (esp_twilio_uuid, opts)
  data
end

#get_twilio_account_with_http_info(esp_twilio_uuid, opts = {}) ⇒ Array<(TwilioResponse, Integer, Hash)>

Get Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TwilioResponse, Integer, Hash)>) —

    TwilioResponse data, response status code and response headers



7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7796

def (esp_twilio_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_twilio_account ...'
  end
  # verify the required parameter 'esp_twilio_uuid' is set
  if @api_client.config.client_side_validation && esp_twilio_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'esp_twilio_uuid' when calling StorefrontApi.get_twilio_account"
  end
  # resource path
  local_var_path = '/storefront/twilio/accounts/{esp_twilio_uuid}'.sub('{' + 'esp_twilio_uuid' + '}', CGI.escape(esp_twilio_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TwilioResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_twilio_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_twilio_accounts(opts = {}) ⇒ TwiliosResponse

Get all Twilio accounts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7848
7849
7850
7851
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7848

def get_twilio_accounts(opts = {})
  data, _status_code, _headers = get_twilio_accounts_with_http_info(opts)
  data
end

#get_twilio_accounts_with_http_info(opts = {}) ⇒ Array<(TwiliosResponse, Integer, Hash)>

Get all Twilio accounts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TwiliosResponse, Integer, Hash)>) —

    TwiliosResponse data, response status code and response headers



7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7856

def get_twilio_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_twilio_accounts ...'
  end
  # resource path
  local_var_path = '/storefront/twilio/accounts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TwiliosResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_twilio_accounts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_twilio_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_upload_fs_file_url(id, extension, opts = {}) ⇒ FileManagerUploadUrlResponse

Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.

Parameters:

  • id (Integer)
  • extension (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7906
7907
7908
7909
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7906

def get_upload_fs_file_url(id, extension, opts = {})
  data, _status_code, _headers = get_upload_fs_file_url_with_http_info(id, extension, opts)
  data
end

#get_upload_fs_file_url_with_http_info(id, extension, opts = {}) ⇒ Array<(FileManagerUploadUrlResponse, Integer, Hash)>

Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.

Parameters:

  • id (Integer)
  • extension (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7916

def get_upload_fs_file_url_with_http_info(id, extension, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.get_upload_fs_file_url ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_upload_fs_file_url"
  end
  # verify the required parameter 'extension' is set
  if @api_client.config.client_side_validation && extension.nil?
    fail ArgumentError, "Missing the required parameter 'extension' when calling StorefrontApi.get_upload_fs_file_url"
  end
  # resource path
  local_var_path = '/storefront/{id}/fs/upload_url/{extension}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'extension' + '}', CGI.escape(extension.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FileManagerUploadUrlResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.get_upload_fs_file_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#get_upload_fs_file_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#global_unsubscribe(storefront_oid, unsubscribe, opts = {}) ⇒ EmailGlobalUnsubscribeResponse

Globally unsubscribe a customer

Parameters:

Returns:



7974
7975
7976
7977
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7974

def global_unsubscribe(storefront_oid, unsubscribe, opts = {})
  data, _status_code, _headers = global_unsubscribe_with_http_info(storefront_oid, unsubscribe, opts)
  data
end

#global_unsubscribe_with_http_info(storefront_oid, unsubscribe, opts = {}) ⇒ Array<(EmailGlobalUnsubscribeResponse, Integer, Hash)>

Globally unsubscribe a customer

Parameters:

Returns:



7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7984

def global_unsubscribe_with_http_info(storefront_oid, unsubscribe, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.global_unsubscribe ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.global_unsubscribe"
  end
  # verify the required parameter 'unsubscribe' is set
  if @api_client.config.client_side_validation && unsubscribe.nil?
    fail ArgumentError, "Missing the required parameter 'unsubscribe' when calling StorefrontApi.global_unsubscribe"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/globalUnsubscribe'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(unsubscribe)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailGlobalUnsubscribeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.global_unsubscribe",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#global_unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_email_third_party_provider_list(storefront_oid, import_request, opts = {}) ⇒ nil

Import a third party provider list

Parameters:

Returns:

  • (nil) 


8047
8048
8049
8050
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8047

def import_email_third_party_provider_list(storefront_oid, import_request, opts = {})
  import_email_third_party_provider_list_with_http_info(storefront_oid, import_request, opts)
  nil
end

#import_email_third_party_provider_list_with_http_info(storefront_oid, import_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Import a third party provider list

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8057

def import_email_third_party_provider_list_with_http_info(storefront_oid, import_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.import_email_third_party_provider_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.import_email_third_party_provider_list"
  end
  # verify the required parameter 'import_request' is set
  if @api_client.config.client_side_validation && import_request.nil?
    fail ArgumentError, "Missing the required parameter 'import_request' when calling StorefrontApi.import_email_third_party_provider_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/third_party_providers/import'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(import_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.import_email_third_party_provider_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#import_email_third_party_provider_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_campaign(storefront_oid, email_campaign, opts = {}) ⇒ EmailCampaignResponse

Insert email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign (EmailCampaign) —

    Email campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8120
8121
8122
8123
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8120

def insert_email_campaign(storefront_oid, email_campaign, opts = {})
  data, _status_code, _headers = insert_email_campaign_with_http_info(storefront_oid, email_campaign, opts)
  data
end

#insert_email_campaign_folder(storefront_oid, email_campaign_folder, opts = {}) ⇒ EmailCampaignFolderResponse

Insert email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder (EmailCampaignFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8193
8194
8195
8196
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8193

def insert_email_campaign_folder(storefront_oid, email_campaign_folder, opts = {})
  data, _status_code, _headers = insert_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder, opts)
  data
end

#insert_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder, opts = {}) ⇒ Array<(EmailCampaignFolderResponse, Integer, Hash)>

Insert email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder (EmailCampaignFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignFolderResponse, Integer, Hash)>) —

    EmailCampaignFolderResponse data, response status code and response headers



8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8203

def insert_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_campaign_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_campaign_folder"
  end
  # verify the required parameter 'email_campaign_folder' is set
  if @api_client.config.client_side_validation && email_campaign_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_folder' when calling StorefrontApi.insert_email_campaign_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaign_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_campaign_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_campaign_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_campaign_with_http_info(storefront_oid, email_campaign, opts = {}) ⇒ Array<(EmailCampaignResponse, Integer, Hash)>

Insert email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign (EmailCampaign) —

    Email campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignResponse, Integer, Hash)>) —

    EmailCampaignResponse data, response status code and response headers



8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8130

def insert_email_campaign_with_http_info(storefront_oid, email_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_campaign ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_campaign"
  end
  # verify the required parameter 'email_campaign' is set
  if @api_client.config.client_side_validation && email_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign' when calling StorefrontApi.insert_email_campaign"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_campaign)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_commseq(storefront_oid, email_commseq, opts = {}) ⇒ EmailCommseqResponse

Insert email commseq

Parameters:

  • storefront_oid (Integer)
  • email_commseq (EmailCommseq) —

    Email commseq

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8266
8267
8268
8269
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8266

def insert_email_commseq(storefront_oid, email_commseq, opts = {})
  data, _status_code, _headers = insert_email_commseq_with_http_info(storefront_oid, email_commseq, opts)
  data
end

#insert_email_commseq_with_http_info(storefront_oid, email_commseq, opts = {}) ⇒ Array<(EmailCommseqResponse, Integer, Hash)>

Insert email commseq

Parameters:

  • storefront_oid (Integer)
  • email_commseq (EmailCommseq) —

    Email commseq

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Integer, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8276

def insert_email_commseq_with_http_info(storefront_oid, email_commseq, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_commseq ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_commseq"
  end
  # verify the required parameter 'email_commseq' is set
  if @api_client.config.client_side_validation && email_commseq.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq' when calling StorefrontApi.insert_email_commseq"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_commseq",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_commseq\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_email(storefront_oid, email_commseq_email, opts = {}) ⇒ EmailCommseqEmailResponse

Insert email email

Parameters:

  • storefront_oid (Integer)
  • email_commseq_email (EmailCommseqEmail) —

    Email email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8339
8340
8341
8342
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8339

def insert_email_email(storefront_oid, email_commseq_email, opts = {})
  data, _status_code, _headers = insert_email_email_with_http_info(storefront_oid, email_commseq_email, opts)
  data
end

#insert_email_email_with_http_info(storefront_oid, email_commseq_email, opts = {}) ⇒ Array<(EmailCommseqEmailResponse, Integer, Hash)>

Insert email email

Parameters:

  • storefront_oid (Integer)
  • email_commseq_email (EmailCommseqEmail) —

    Email email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Integer, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8349

def insert_email_email_with_http_info(storefront_oid, email_commseq_email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_email"
  end
  # verify the required parameter 'email_commseq_email' is set
  if @api_client.config.client_side_validation && email_commseq_email.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_email' when calling StorefrontApi.insert_email_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_email)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_flow(storefront_oid, email_flow, opts = {}) ⇒ EmailFlowResponse

Insert email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow (EmailFlow) —

    Email flow

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8412
8413
8414
8415
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8412

def insert_email_flow(storefront_oid, email_flow, opts = {})
  data, _status_code, _headers = insert_email_flow_with_http_info(storefront_oid, email_flow, opts)
  data
end

#insert_email_flow_folder(storefront_oid, email_flow_folder, opts = {}) ⇒ EmailFlowFolderResponse

Insert email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder (EmailFlowFolder) —

    Email flow folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8485
8486
8487
8488
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8485

def insert_email_flow_folder(storefront_oid, email_flow_folder, opts = {})
  data, _status_code, _headers = insert_email_flow_folder_with_http_info(storefront_oid, email_flow_folder, opts)
  data
end

#insert_email_flow_folder_with_http_info(storefront_oid, email_flow_folder, opts = {}) ⇒ Array<(EmailFlowFolderResponse, Integer, Hash)>

Insert email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder (EmailFlowFolder) —

    Email flow folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Integer, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8495

def insert_email_flow_folder_with_http_info(storefront_oid, email_flow_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_flow_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_flow_folder"
  end
  # verify the required parameter 'email_flow_folder' is set
  if @api_client.config.client_side_validation && email_flow_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_folder' when calling StorefrontApi.insert_email_flow_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flow_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_flow_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_flow_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_flow_with_http_info(storefront_oid, email_flow, opts = {}) ⇒ Array<(EmailFlowResponse, Integer, Hash)>

Insert email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow (EmailFlow) —

    Email flow

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowResponse, Integer, Hash)>) —

    EmailFlowResponse data, response status code and response headers



8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8422

def insert_email_flow_with_http_info(storefront_oid, email_flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_flow ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_flow"
  end
  # verify the required parameter 'email_flow' is set
  if @api_client.config.client_side_validation && email_flow.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow' when calling StorefrontApi.insert_email_flow"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_flow)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_flow",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_list(storefront_oid, email_list, opts = {}) ⇒ EmailListResponse

Insert email list

Parameters:

  • storefront_oid (Integer)
  • email_list (EmailList) —

    Email list

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8558
8559
8560
8561
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8558

def insert_email_list(storefront_oid, email_list, opts = {})
  data, _status_code, _headers = insert_email_list_with_http_info(storefront_oid, email_list, opts)
  data
end

#insert_email_list_segment_folder(storefront_oid, email_list_segment_folder, opts = {}) ⇒ EmailListSegmentFolderResponse

Insert email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder (EmailListSegmentFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8631
8632
8633
8634
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8631

def insert_email_list_segment_folder(storefront_oid, email_list_segment_folder, opts = {})
  data, _status_code, _headers = insert_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder, opts)
  data
end

#insert_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder, opts = {}) ⇒ Array<(EmailListSegmentFolderResponse, Integer, Hash)>

Insert email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder (EmailListSegmentFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8641

def insert_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_list_segment_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_list_segment_folder"
  end
  # verify the required parameter 'email_list_segment_folder' is set
  if @api_client.config.client_side_validation && email_list_segment_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_segment_folder' when calling StorefrontApi.insert_email_list_segment_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_list_segment_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListSegmentFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_list_segment_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_list_segment_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_list_with_http_info(storefront_oid, email_list, opts = {}) ⇒ Array<(EmailListResponse, Integer, Hash)>

Insert email list

Parameters:

  • storefront_oid (Integer)
  • email_list (EmailList) —

    Email list

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Integer, Hash)>) —

    EmailListResponse data, response status code and response headers



8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8568

def insert_email_list_with_http_info(storefront_oid, email_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_list"
  end
  # verify the required parameter 'email_list' is set
  if @api_client.config.client_side_validation && email_list.nil?
    fail ArgumentError, "Missing the required parameter 'email_list' when calling StorefrontApi.insert_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_list)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_postcard(storefront_oid, email_commseq_postcard, opts = {}) ⇒ EmailCommseqPostcardResponse

Insert email postcard

Parameters:

  • storefront_oid (Integer)
  • email_commseq_postcard (EmailCommseqPostcard) —

    Email postcard

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8704
8705
8706
8707
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8704

def insert_email_postcard(storefront_oid, email_commseq_postcard, opts = {})
  data, _status_code, _headers = insert_email_postcard_with_http_info(storefront_oid, email_commseq_postcard, opts)
  data
end

#insert_email_postcard_with_http_info(storefront_oid, email_commseq_postcard, opts = {}) ⇒ Array<(EmailCommseqPostcardResponse, Integer, Hash)>

Insert email postcard

Parameters:

  • storefront_oid (Integer)
  • email_commseq_postcard (EmailCommseqPostcard) —

    Email postcard

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8714

def insert_email_postcard_with_http_info(storefront_oid, email_commseq_postcard, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_postcard ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_postcard"
  end
  # verify the required parameter 'email_commseq_postcard' is set
  if @api_client.config.client_side_validation && email_commseq_postcard.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_postcard' when calling StorefrontApi.insert_email_postcard"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_postcard)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_postcard",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_email_segment(storefront_oid, email_segment, opts = {}) ⇒ EmailSegmentResponse

Insert email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment (EmailSegment) —

    Email segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8777
8778
8779
8780
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8777

def insert_email_segment(storefront_oid, email_segment, opts = {})
  data, _status_code, _headers = insert_email_segment_with_http_info(storefront_oid, email_segment, opts)
  data
end

#insert_email_segment_with_http_info(storefront_oid, email_segment, opts = {}) ⇒ Array<(EmailSegmentResponse, Integer, Hash)>

Insert email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment (EmailSegment) —

    Email segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Integer, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8787

def insert_email_segment_with_http_info(storefront_oid, email_segment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_email_segment"
  end
  # verify the required parameter 'email_segment' is set
  if @api_client.config.client_side_validation && email_segment.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment' when calling StorefrontApi.insert_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_segment)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_screen_recording_segment(storefront_oid, segment, opts = {}) ⇒ ScreenRecordingSegmentResponse

Insert screen recording segment

Parameters:

  • storefront_oid (Integer)
  • segment (ScreenRecordingSegment) —

    Segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8850
8851
8852
8853
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8850

def insert_screen_recording_segment(storefront_oid, segment, opts = {})
  data, _status_code, _headers = insert_screen_recording_segment_with_http_info(storefront_oid, segment, opts)
  data
end

#insert_screen_recording_segment_with_http_info(storefront_oid, segment, opts = {}) ⇒ Array<(ScreenRecordingSegmentResponse, Integer, Hash)>

Insert screen recording segment

Parameters:

  • storefront_oid (Integer)
  • segment (ScreenRecordingSegment) —

    Segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8860

def insert_screen_recording_segment_with_http_info(storefront_oid, segment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_screen_recording_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_screen_recording_segment"
  end
  # verify the required parameter 'segment' is set
  if @api_client.config.client_side_validation && segment.nil?
    fail ArgumentError, "Missing the required parameter 'segment' when calling StorefrontApi.insert_screen_recording_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(segment)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_screen_recording_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_screen_recording_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_update_page_content_attribute(storefront_oid, page_oid, page_attribute, opts = {}) ⇒ nil

Upsert a page content attribute Update a page content attribute, creating it new if it does not yet exist.

Parameters:

  • storefront_oid (Integer)
  • page_oid (Integer) —

    The page oid to modify.

  • page_attribute (StoreFrontPageContentAttribute) —

    Page content attribute to upsert

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


8925
8926
8927
8928
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8925

def insert_update_page_content_attribute(storefront_oid, page_oid, page_attribute, opts = {})
  insert_update_page_content_attribute_with_http_info(storefront_oid, page_oid, page_attribute, opts)
  nil
end

#insert_update_page_content_attribute_with_http_info(storefront_oid, page_oid, page_attribute, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upsert a page content attribute Update a page content attribute, creating it new if it does not yet exist.

Parameters:

  • storefront_oid (Integer)
  • page_oid (Integer) —

    The page oid to modify.

  • page_attribute (StoreFrontPageContentAttribute) —

    Page content attribute to upsert

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8937

def insert_update_page_content_attribute_with_http_info(storefront_oid, page_oid, page_attribute, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.insert_update_page_content_attribute ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.insert_update_page_content_attribute"
  end
  # verify the required parameter 'page_oid' is set
  if @api_client.config.client_side_validation && page_oid.nil?
    fail ArgumentError, "Missing the required parameter 'page_oid' when calling StorefrontApi.insert_update_page_content_attribute"
  end
  # verify the required parameter 'page_attribute' is set
  if @api_client.config.client_side_validation && page_attribute.nil?
    fail ArgumentError, "Missing the required parameter 'page_attribute' when calling StorefrontApi.insert_update_page_content_attribute"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/pages/{page_oid}/content/attributes'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'page_oid' + '}', CGI.escape(page_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(page_attribute)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.insert_update_page_content_attribute",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#insert_update_page_content_attribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#prepare_download_email_segment(storefront_oid, email_segment_uuid, opts = {}) ⇒ EmailSegmentDownloadPrepareResponse

Prepare download of email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9004
9005
9006
9007
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9004

def prepare_download_email_segment(storefront_oid, email_segment_uuid, opts = {})
  data, _status_code, _headers = prepare_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
  data
end

#prepare_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentDownloadPrepareResponse, Integer, Hash)>

Prepare download of email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9014

def prepare_download_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.prepare_download_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.prepare_download_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.prepare_download_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentDownloadPrepareResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.prepare_download_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#prepare_download_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#publish_library_item(library_item_oid, publish_library_request, opts = {}) ⇒ LibraryItemResponse

Publish library item.

Parameters:

  • library_item_oid (Integer)
  • publish_library_request (PublishLibraryItemRequest) —

    Publish library item request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9072
9073
9074
9075
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9072

def publish_library_item(library_item_oid, publish_library_request, opts = {})
  data, _status_code, _headers = publish_library_item_with_http_info(library_item_oid, publish_library_request, opts)
  data
end

#publish_library_item_with_http_info(library_item_oid, publish_library_request, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Publish library item.

Parameters:

  • library_item_oid (Integer)
  • publish_library_request (PublishLibraryItemRequest) —

    Publish library item request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9082

def publish_library_item_with_http_info(library_item_oid, publish_library_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.publish_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.publish_library_item"
  end
  # verify the required parameter 'publish_library_request' is set
  if @api_client.config.client_side_validation && publish_library_request.nil?
    fail ArgumentError, "Missing the required parameter 'publish_library_request' when calling StorefrontApi.publish_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}/publish'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(publish_library_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.publish_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#publish_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#purchase_library_item(library_item_oid, opts = {}) ⇒ LibraryItemResponse

Purchase public library item, which creates a copy of the item in your personal code library

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storefront_oid (Integer)

Returns:



9145
9146
9147
9148
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9145

def purchase_library_item(library_item_oid, opts = {})
  data, _status_code, _headers = purchase_library_item_with_http_info(library_item_oid, opts)
  data
end

#purchase_library_item_with_http_info(library_item_oid, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Purchase public library item, which creates a copy of the item in your personal code library

Parameters:

  • library_item_oid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storefront_oid (Integer)

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9155

def purchase_library_item_with_http_info(library_item_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.purchase_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.purchase_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}/purchase'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.purchase_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#purchase_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#release_email_commseq_step_waiting(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ nil

Release email communication sequence customers waiting at the specified step

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


9211
9212
9213
9214
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9211

def release_email_commseq_step_waiting(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  release_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
  nil
end

#release_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Release email communication sequence customers waiting at the specified step

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9222

def release_email_commseq_step_waiting_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.release_email_commseq_step_waiting ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.release_email_commseq_step_waiting"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.release_email_commseq_step_waiting"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.release_email_commseq_step_waiting"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.release_email_commseq_step_waiting",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#release_email_commseq_step_waiting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {}) ⇒ nil

Reset email commseq rate limiters (only callable by UltraCart Support)

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


9284
9285
9286
9287
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9284

def reset_email_commseq_rate_limiters(storefront_oid, commseq_uuid, opts = {})
  reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts)
  nil
end

#reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Reset email commseq rate limiters (only callable by UltraCart Support)

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9294

def reset_email_commseq_rate_limiters_with_http_info(storefront_oid, commseq_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.reset_email_commseq_rate_limiters ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.reset_email_commseq_rate_limiters"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.reset_email_commseq_rate_limiters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#reset_email_commseq_rate_limiters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts = {}) ⇒ EmailCommseqEmailSendTestResponse

Request a review of an email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email_review_request (EmailCommseqEmailSendTestRequest) —

    Email commseq email review request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9353
9354
9355
9356
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9353

def review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts = {})
  data, _status_code, _headers = review_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts)
  data
end

#review_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts = {}) ⇒ Array<(EmailCommseqEmailSendTestResponse, Integer, Hash)>

Request a review of an email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email_review_request (EmailCommseqEmailSendTestRequest) —

    Email commseq email review request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9364

def review_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.review ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.review"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.review"
  end
  # verify the required parameter 'email_commseq_email_review_request' is set
  if @api_client.config.client_side_validation && email_commseq_email_review_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_email_review_request' when calling StorefrontApi.review"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_email_review_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailSendTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.review",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ LookupResponse

Searches for all matching values

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :matches (String)
  • :storefront_oid (String)
  • :max_hits (Integer)
  • :subcategory (String)

Returns:



9434
9435
9436
9437
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9434

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search2(lookup_request, opts = {}) ⇒ LookupResponse

Searches for all matching values (using POST)

Parameters:

  • lookup_request (LookupRequest) —

    LookupRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



9501
9502
9503
9504
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9501

def search2(lookup_request, opts = {})
  data, _status_code, _headers = search2_with_http_info(lookup_request, opts)
  data
end

#search2_with_http_info(lookup_request, opts = {}) ⇒ Array<(LookupResponse, Integer, Hash)>

Searches for all matching values (using POST)

Parameters:

  • lookup_request (LookupRequest) —

    LookupRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LookupResponse, Integer, Hash)>) —

    LookupResponse data, response status code and response headers



9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9510

def search2_with_http_info(lookup_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search2 ...'
  end
  # verify the required parameter 'lookup_request' is set
  if @api_client.config.client_side_validation && lookup_request.nil?
    fail ArgumentError, "Missing the required parameter 'lookup_request' when calling StorefrontApi.search2"
  end
  # resource path
  local_var_path = '/storefront/search'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(lookup_request)

  # return_type
  return_type = opts[:debug_return_type] || 'LookupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search2",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_email_list_customers(storefront_oid, email_list_uuid, opts = {}) ⇒ EmailListCustomersResponse

Search email list customers

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



9570
9571
9572
9573
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9570

def search_email_list_customers(storefront_oid, email_list_uuid, opts = {})
  data, _status_code, _headers = search_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts)
  data
end

#search_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts = {}) ⇒ Array<(EmailListCustomersResponse, Integer, Hash)>

Search email list customers

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:

  • (Array<(EmailListCustomersResponse, Integer, Hash)>) —

    EmailListCustomersResponse data, response status code and response headers



9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9581

def search_email_list_customers_with_http_info(storefront_oid, email_list_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_email_list_customers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.search_email_list_customers"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.search_email_list_customers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/search'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startsWith'] = opts[:'starts_with'] if !opts[:'starts_with'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListCustomersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_email_list_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_email_list_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_email_segment_customers(storefront_oid, email_segment_uuid, opts = {}) ⇒ EmailSegmentCustomersResponse

Search email segment customers

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



9641
9642
9643
9644
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9641

def search_email_segment_customers(storefront_oid, email_segment_uuid, opts = {})
  data, _status_code, _headers = search_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts)
  data
end

#search_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(EmailSegmentCustomersResponse, Integer, Hash)>

Search email segment customers

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9652

def search_email_segment_customers_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_email_segment_customers ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.search_email_segment_customers"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.search_email_segment_customers"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'startsWith'] = opts[:'starts_with'] if !opts[:'starts_with'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentCustomersResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_email_segment_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_email_segment_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_library_items(item_query, opts = {}) ⇒ LibraryItemsResponse

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



9714
9715
9716
9717
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9714

def search_library_items(item_query, opts = {})
  data, _status_code, _headers = search_library_items_with_http_info(item_query, opts)
  data
end

#search_library_items_with_http_info(item_query, opts = {}) ⇒ Array<(LibraryItemsResponse, Integer, Hash)>

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(LibraryItemsResponse, Integer, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9727

def search_library_items_with_http_info(item_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_library_items ...'
  end
  # verify the required parameter 'item_query' is set
  if @api_client.config.client_side_validation && item_query.nil?
    fail ArgumentError, "Missing the required parameter 'item_query' when calling StorefrontApi.search_library_items"
  end
  # resource path
  local_var_path = '/storefront/code_library/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_query)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_library_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_library_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_published_items(item_query, opts = {}) ⇒ LibraryItemsResponse

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



9792
9793
9794
9795
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9792

def search_published_items(item_query, opts = {})
  data, _status_code, _headers = search_published_items_with_http_info(item_query, opts)
  data
end

#search_published_items_with_http_info(item_query, opts = {}) ⇒ Array<(LibraryItemsResponse, Integer, Hash)>

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(LibraryItemsResponse, Integer, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9805

def search_published_items_with_http_info(item_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_published_items ...'
  end
  # verify the required parameter 'item_query' is set
  if @api_client.config.client_side_validation && item_query.nil?
    fail ArgumentError, "Missing the required parameter 'item_query' when calling StorefrontApi.search_published_items"
  end
  # resource path
  local_var_path = '/storefront/code_library/search_published'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_query)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_published_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_published_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_review_items(item_query, opts = {}) ⇒ LibraryItemsResponse

Retrieve library items needing review or rejected Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



9870
9871
9872
9873
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9870

def search_review_items(item_query, opts = {})
  data, _status_code, _headers = search_review_items_with_http_info(item_query, opts)
  data
end

#search_review_items_with_http_info(item_query, opts = {}) ⇒ Array<(LibraryItemsResponse, Integer, Hash)>

Retrieve library items needing review or rejected Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(LibraryItemsResponse, Integer, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9883

def search_review_items_with_http_info(item_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_review_items ...'
  end
  # verify the required parameter 'item_query' is set
  if @api_client.config.client_side_validation && item_query.nil?
    fail ArgumentError, "Missing the required parameter 'item_query' when calling StorefrontApi.search_review_items"
  end
  # resource path
  local_var_path = '/storefront/code_library/search_review'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_query)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_review_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_review_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_shared_items(item_query, opts = {}) ⇒ LibraryItemsResponse

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



9948
9949
9950
9951
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9948

def search_shared_items(item_query, opts = {})
  data, _status_code, _headers = search_shared_items_with_http_info(item_query, opts)
  data
end

#search_shared_items_with_http_info(item_query, opts = {}) ⇒ Array<(LibraryItemsResponse, Integer, Hash)>

Retrieve library items Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.

Parameters:

  • item_query (LibraryItemQuery) —

    Item query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Maximum 10000) (default to 10000)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(LibraryItemsResponse, Integer, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9961

def search_shared_items_with_http_info(item_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search_shared_items ...'
  end
  # verify the required parameter 'item_query' is set
  if @api_client.config.client_side_validation && item_query.nil?
    fail ArgumentError, "Missing the required parameter 'item_query' when calling StorefrontApi.search_shared_items"
  end
  # resource path
  local_var_path = '/storefront/code_library/search_shared'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(item_query)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search_shared_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search_shared_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_with_http_info(opts = {}) ⇒ Array<(LookupResponse, Integer, Hash)>

Searches for all matching values

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :matches (String)
  • :storefront_oid (String)
  • :max_hits (Integer)
  • :subcategory (String)

Returns:

  • (Array<(LookupResponse, Integer, Hash)>) —

    LookupResponse data, response status code and response headers



9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9447

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.search ...'
  end
  # resource path
  local_var_path = '/storefront/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'matches'] = opts[:'matches'] if !opts[:'matches'].nil?
  query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
  query_params[:'max_hits'] = opts[:'max_hits'] if !opts[:'max_hits'].nil?
  query_params[:'subcategory'] = opts[:'subcategory'] if !opts[:'subcategory'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LookupResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_email_test(storefront_oid, commseq_email_uuid, email_commseq_email_test_request, opts = {}) ⇒ EmailCommseqEmailSendTestResponse

Send email test

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email_test_request (EmailCommseqEmailSendTestRequest) —

    Email commseq email test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10024
10025
10026
10027
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10024

def send_email_test(storefront_oid, commseq_email_uuid, email_commseq_email_test_request, opts = {})
  data, _status_code, _headers = send_email_test_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_test_request, opts)
  data
end

#send_email_test_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_test_request, opts = {}) ⇒ Array<(EmailCommseqEmailSendTestResponse, Integer, Hash)>

Send email test

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email_test_request (EmailCommseqEmailSendTestRequest) —

    Email commseq email test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10035

def send_email_test_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.send_email_test ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_email_test"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.send_email_test"
  end
  # verify the required parameter 'email_commseq_email_test_request' is set
  if @api_client.config.client_side_validation && email_commseq_email_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_email_test_request' when calling StorefrontApi.send_email_test"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_email_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailSendTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.send_email_test",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#send_email_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_postcard_test(storefront_oid, commseq_postcard_uuid, email_commseq_postcard_test_request, opts = {}) ⇒ EmailCommseqPostcardSendTestResponse

Send postcard test

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • email_commseq_postcard_test_request (EmailCommseqPostcardSendTestRequest) —

    Email commseq email test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10103
10104
10105
10106
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10103

def send_postcard_test(storefront_oid, commseq_postcard_uuid, email_commseq_postcard_test_request, opts = {})
  data, _status_code, _headers = send_postcard_test_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard_test_request, opts)
  data
end

#send_postcard_test_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard_test_request, opts = {}) ⇒ Array<(EmailCommseqPostcardSendTestResponse, Integer, Hash)>

Send postcard test

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • email_commseq_postcard_test_request (EmailCommseqPostcardSendTestRequest) —

    Email commseq email test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10114

def send_postcard_test_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.send_postcard_test ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_postcard_test"
  end
  # verify the required parameter 'commseq_postcard_uuid' is set
  if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.send_postcard_test"
  end
  # verify the required parameter 'email_commseq_postcard_test_request' is set
  if @api_client.config.client_side_validation && email_commseq_postcard_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_postcard_test_request' when calling StorefrontApi.send_postcard_test"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_postcard_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardSendTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.send_postcard_test",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#send_postcard_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_sms_test(storefront_oid, commseq_uuid, commseq_step_uuid, email_commseq_sms_test_request, opts = {}) ⇒ EmailCommseqSmsSendTestResponse

Send SMS test

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • email_commseq_sms_test_request (EmailCommseqSmsSendTestRequest) —

    Email commseq sms test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10183
10184
10185
10186
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10183

def send_sms_test(storefront_oid, commseq_uuid, commseq_step_uuid, email_commseq_sms_test_request, opts = {})
  data, _status_code, _headers = send_sms_test_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, email_commseq_sms_test_request, opts)
  data
end

#send_sms_test_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, email_commseq_sms_test_request, opts = {}) ⇒ Array<(EmailCommseqSmsSendTestResponse, Integer, Hash)>

Send SMS test

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • commseq_step_uuid (String)
  • email_commseq_sms_test_request (EmailCommseqSmsSendTestRequest) —

    Email commseq sms test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10195

def send_sms_test_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, email_commseq_sms_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.send_sms_test ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_sms_test"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.send_sms_test"
  end
  # verify the required parameter 'commseq_step_uuid' is set
  if @api_client.config.client_side_validation && commseq_step_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.send_sms_test"
  end
  # verify the required parameter 'email_commseq_sms_test_request' is set
  if @api_client.config.client_side_validation && email_commseq_sms_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_sms_test_request' when calling StorefrontApi.send_sms_test"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/sms/{commseq_uuid}/{commseq_step_uuid}/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s)).sub('{' + 'commseq_step_uuid' + '}', CGI.escape(commseq_step_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_sms_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqSmsSendTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.send_sms_test",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#send_sms_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {}) ⇒ EmailCommseqWebhookSendTestResponse

Send webhook test

Parameters:

  • storefront_oid (Integer)
  • email_commseq_webhook_test_request (EmailCommseqWebhookSendTestRequest) —

    Email commseq webhook test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10266
10267
10268
10269
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10266

def send_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {})
  data, _status_code, _headers = send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts)
  data
end

#send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts = {}) ⇒ Array<(EmailCommseqWebhookSendTestResponse, Integer, Hash)>

Send webhook test

Parameters:

  • storefront_oid (Integer)
  • email_commseq_webhook_test_request (EmailCommseqWebhookSendTestRequest) —

    Email commseq webhook test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10276

def send_webhook_test_with_http_info(storefront_oid, email_commseq_webhook_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.send_webhook_test ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.send_webhook_test"
  end
  # verify the required parameter 'email_commseq_webhook_test_request' is set
  if @api_client.config.client_side_validation && email_commseq_webhook_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_webhook_test_request' when calling StorefrontApi.send_webhook_test"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/webhooks/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_webhook_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqWebhookSendTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.send_webhook_test",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#send_webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sequence_test(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {}) ⇒ EmailCommseqSequenceTestResponse

Sequence test

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • email_commseq_sequence_test_request (EmailCommseqSequenceTestRequest) —

    Commseq test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10340
10341
10342
10343
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10340

def sequence_test(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {})
  data, _status_code, _headers = sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts)
  data
end

#sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {}) ⇒ Array<(EmailCommseqSequenceTestResponse, Integer, Hash)>

Sequence test

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • email_commseq_sequence_test_request (EmailCommseqSequenceTestRequest) —

    Commseq test request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10351

def sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.sequence_test ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.sequence_test"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.sequence_test"
  end
  # verify the required parameter 'email_commseq_sequence_test_request' is set
  if @api_client.config.client_side_validation && email_commseq_sequence_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_sequence_test_request' when calling StorefrontApi.sequence_test"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_sequence_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqSequenceTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.sequence_test",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#sequence_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#start_email_campaign(storefront_oid, email_campaign_uuid, opts = {}) ⇒ BaseResponse

Start email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10418
10419
10420
10421
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10418

def start_email_campaign(storefront_oid, email_campaign_uuid, opts = {})
  data, _status_code, _headers = start_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts)
  data
end

#start_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {}) ⇒ Array<(BaseResponse, Integer, Hash)>

Start email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(BaseResponse, Integer, Hash)>) —

    BaseResponse data, response status code and response headers



10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10428

def start_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.start_email_campaign ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.start_email_campaign"
  end
  # verify the required parameter 'email_campaign_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_uuid' when calling StorefrontApi.start_email_campaign"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_uuid' + '}', CGI.escape(email_campaign_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BaseResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.start_email_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#start_email_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#subscribe_to_email_list(storefront_oid, email_list_uuid, customers, opts = {}) ⇒ EmailListSubscribeResponse

Subscribe customers to email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • customers (Array<EmailCustomer>) —

    Customers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10487
10488
10489
10490
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10487

def subscribe_to_email_list(storefront_oid, email_list_uuid, customers, opts = {})
  data, _status_code, _headers = subscribe_to_email_list_with_http_info(storefront_oid, email_list_uuid, customers, opts)
  data
end

#subscribe_to_email_list_with_http_info(storefront_oid, email_list_uuid, customers, opts = {}) ⇒ Array<(EmailListSubscribeResponse, Integer, Hash)>

Subscribe customers to email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • customers (Array<EmailCustomer>) —

    Customers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListSubscribeResponse, Integer, Hash)>) —

    EmailListSubscribeResponse data, response status code and response headers



10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10498

def subscribe_to_email_list_with_http_info(storefront_oid, email_list_uuid, customers, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.subscribe_to_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.subscribe_to_email_list"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.subscribe_to_email_list"
  end
  # verify the required parameter 'customers' is set
  if @api_client.config.client_side_validation && customers.nil?
    fail ArgumentError, "Missing the required parameter 'customers' when calling StorefrontApi.subscribe_to_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(customers)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListSubscribeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.subscribe_to_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#subscribe_to_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sunset_email_segment(storefront_oid, email_segment_uuid, opts = {}) ⇒ nil

Sunset email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


10565
10566
10567
10568
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10565

def sunset_email_segment(storefront_oid, email_segment_uuid, opts = {})
  sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts)
  nil
end

#sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Sunset email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10575

def sunset_email_segment_with_http_info(storefront_oid, email_segment_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.sunset_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.sunset_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.sunset_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.sunset_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#sunset_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unfavorite_screen_recording(storefront_oid, screen_recording_uuid, opts = {}) ⇒ nil

Remove favorite flag on screen recording Remove favorite flag on screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


10634
10635
10636
10637
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10634

def unfavorite_screen_recording(storefront_oid, screen_recording_uuid, opts = {})
  unfavorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts)
  nil
end

#unfavorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove favorite flag on screen recording Remove favorite flag on screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10645

def unfavorite_screen_recording_with_http_info(storefront_oid, screen_recording_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.unfavorite_screen_recording ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.unfavorite_screen_recording"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.unfavorite_screen_recording"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.unfavorite_screen_recording",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#unfavorite_screen_recording\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_campaign(storefront_oid, email_campaign_uuid, email_campaign, opts = {}) ⇒ EmailCampaignResponse

Update email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • email_campaign (EmailCampaign) —

    Email campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10704
10705
10706
10707
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10704

def update_email_campaign(storefront_oid, email_campaign_uuid, email_campaign, opts = {})
  data, _status_code, _headers = update_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, email_campaign, opts)
  data
end

#update_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, email_campaign_folder, opts = {}) ⇒ EmailCampaignFolderResponse

Update email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • email_campaign_folder (EmailCampaignFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10783
10784
10785
10786
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10783

def update_email_campaign_folder(storefront_oid, email_campaign_folder_uuid, email_campaign_folder, opts = {})
  data, _status_code, _headers = update_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, email_campaign_folder, opts)
  data
end

#update_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, email_campaign_folder, opts = {}) ⇒ Array<(EmailCampaignFolderResponse, Integer, Hash)>

Update email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_campaign_folder_uuid (String)
  • email_campaign_folder (EmailCampaignFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignFolderResponse, Integer, Hash)>) —

    EmailCampaignFolderResponse data, response status code and response headers



10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10794

def update_email_campaign_folder_with_http_info(storefront_oid, email_campaign_folder_uuid, email_campaign_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_campaign_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_campaign_folder"
  end
  # verify the required parameter 'email_campaign_folder_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_folder_uuid' when calling StorefrontApi.update_email_campaign_folder"
  end
  # verify the required parameter 'email_campaign_folder' is set
  if @api_client.config.client_side_validation && email_campaign_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_folder' when calling StorefrontApi.update_email_campaign_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_folder_uuid' + '}', CGI.escape(email_campaign_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_campaign_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_campaign_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_campaign_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, email_campaign, opts = {}) ⇒ Array<(EmailCampaignResponse, Integer, Hash)>

Update email campaign

Parameters:

  • storefront_oid (Integer)
  • email_campaign_uuid (String)
  • email_campaign (EmailCampaign) —

    Email campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCampaignResponse, Integer, Hash)>) —

    EmailCampaignResponse data, response status code and response headers



10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10715

def update_email_campaign_with_http_info(storefront_oid, email_campaign_uuid, email_campaign, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_campaign ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_campaign"
  end
  # verify the required parameter 'email_campaign_uuid' is set
  if @api_client.config.client_side_validation && email_campaign_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign_uuid' when calling StorefrontApi.update_email_campaign"
  end
  # verify the required parameter 'email_campaign' is set
  if @api_client.config.client_side_validation && email_campaign.nil?
    fail ArgumentError, "Missing the required parameter 'email_campaign' when calling StorefrontApi.update_email_campaign"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_campaign_uuid' + '}', CGI.escape(email_campaign_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_campaign)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCampaignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_commseq(storefront_oid, commseq_uuid, email_commseq, opts = {}) ⇒ EmailCommseqResponse

Update email commseq

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • email_commseq (EmailCommseq) —

    Email commseq

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



10862
10863
10864
10865
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10862

def update_email_commseq(storefront_oid, commseq_uuid, email_commseq, opts = {})
  data, _status_code, _headers = update_email_commseq_with_http_info(storefront_oid, commseq_uuid, email_commseq, opts)
  data
end

#update_email_commseq_with_http_info(storefront_oid, commseq_uuid, email_commseq, opts = {}) ⇒ Array<(EmailCommseqResponse, Integer, Hash)>

Update email commseq

Parameters:

  • storefront_oid (Integer)
  • commseq_uuid (String)
  • email_commseq (EmailCommseq) —

    Email commseq

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Integer, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10873

def update_email_commseq_with_http_info(storefront_oid, commseq_uuid, email_commseq, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_commseq ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_commseq"
  end
  # verify the required parameter 'commseq_uuid' is set
  if @api_client.config.client_side_validation && commseq_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.update_email_commseq"
  end
  # verify the required parameter 'email_commseq' is set
  if @api_client.config.client_side_validation && email_commseq.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq' when calling StorefrontApi.update_email_commseq"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_commseq",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_commseq\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_customer(storefront_oid, email_customer_uuid, email_customer, opts = {}) ⇒ nil

Update email customer

Parameters:

  • storefront_oid (Integer)
  • email_customer_uuid (String)
  • email_customer (EmailCustomer) —

    Email customer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


10941
10942
10943
10944
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10941

def update_email_customer(storefront_oid, email_customer_uuid, email_customer, opts = {})
  update_email_customer_with_http_info(storefront_oid, email_customer_uuid, email_customer, opts)
  nil
end

#update_email_customer_with_http_info(storefront_oid, email_customer_uuid, email_customer, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update email customer

Parameters:

  • storefront_oid (Integer)
  • email_customer_uuid (String)
  • email_customer (EmailCustomer) —

    Email customer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 10952

def update_email_customer_with_http_info(storefront_oid, email_customer_uuid, email_customer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_customer ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_customer"
  end
  # verify the required parameter 'email_customer_uuid' is set
  if @api_client.config.client_side_validation && email_customer_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer_uuid' when calling StorefrontApi.update_email_customer"
  end
  # verify the required parameter 'email_customer' is set
  if @api_client.config.client_side_validation && email_customer.nil?
    fail ArgumentError, "Missing the required parameter 'email_customer' when calling StorefrontApi.update_email_customer"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/customers/{email_customer_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_customer_uuid' + '}', CGI.escape(email_customer_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_customer)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_email(storefront_oid, commseq_email_uuid, email_commseq_email, opts = {}) ⇒ EmailCommseqEmailResponse

Update email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email (EmailCommseqEmail) —

    Email commseq email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11020
11021
11022
11023
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11020

def update_email_email(storefront_oid, commseq_email_uuid, email_commseq_email, opts = {})
  data, _status_code, _headers = update_email_email_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email, opts)
  data
end

#update_email_email_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email, opts = {}) ⇒ Array<(EmailCommseqEmailResponse, Integer, Hash)>

Update email email

Parameters:

  • storefront_oid (Integer)
  • commseq_email_uuid (String)
  • email_commseq_email (EmailCommseqEmail) —

    Email commseq email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Integer, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11031

def update_email_email_with_http_info(storefront_oid, commseq_email_uuid, email_commseq_email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_email"
  end
  # verify the required parameter 'commseq_email_uuid' is set
  if @api_client.config.client_side_validation && commseq_email_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.update_email_email"
  end
  # verify the required parameter 'email_commseq_email' is set
  if @api_client.config.client_side_validation && email_commseq_email.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_email' when calling StorefrontApi.update_email_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_email)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqEmailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_flow(storefront_oid, email_flow_uuid, email_flow, opts = {}) ⇒ EmailFlowResponse

Update email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • email_flow (EmailFlow) —

    Email flow

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11099
11100
11101
11102
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11099

def update_email_flow(storefront_oid, email_flow_uuid, email_flow, opts = {})
  data, _status_code, _headers = update_email_flow_with_http_info(storefront_oid, email_flow_uuid, email_flow, opts)
  data
end

#update_email_flow_folder(storefront_oid, email_flow_folder_uuid, email_flow_folder, opts = {}) ⇒ EmailFlowFolderResponse

Update email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • email_flow_folder (EmailFlowFolder) —

    Email flow folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11178
11179
11180
11181
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11178

def update_email_flow_folder(storefront_oid, email_flow_folder_uuid, email_flow_folder, opts = {})
  data, _status_code, _headers = update_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, email_flow_folder, opts)
  data
end

#update_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, email_flow_folder, opts = {}) ⇒ Array<(EmailFlowFolderResponse, Integer, Hash)>

Update email flow folder

Parameters:

  • storefront_oid (Integer)
  • email_flow_folder_uuid (String)
  • email_flow_folder (EmailFlowFolder) —

    Email flow folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Integer, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11189

def update_email_flow_folder_with_http_info(storefront_oid, email_flow_folder_uuid, email_flow_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_flow_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_flow_folder"
  end
  # verify the required parameter 'email_flow_folder_uuid' is set
  if @api_client.config.client_side_validation && email_flow_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_folder_uuid' when calling StorefrontApi.update_email_flow_folder"
  end
  # verify the required parameter 'email_flow_folder' is set
  if @api_client.config.client_side_validation && email_flow_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_folder' when calling StorefrontApi.update_email_flow_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_folder_uuid' + '}', CGI.escape(email_flow_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_flow_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_flow_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_flow_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_flow_with_http_info(storefront_oid, email_flow_uuid, email_flow, opts = {}) ⇒ Array<(EmailFlowResponse, Integer, Hash)>

Update email flow

Parameters:

  • storefront_oid (Integer)
  • email_flow_uuid (String)
  • email_flow (EmailFlow) —

    Email flow

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailFlowResponse, Integer, Hash)>) —

    EmailFlowResponse data, response status code and response headers



11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11110

def update_email_flow_with_http_info(storefront_oid, email_flow_uuid, email_flow, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_flow ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_flow"
  end
  # verify the required parameter 'email_flow_uuid' is set
  if @api_client.config.client_side_validation && email_flow_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow_uuid' when calling StorefrontApi.update_email_flow"
  end
  # verify the required parameter 'email_flow' is set
  if @api_client.config.client_side_validation && email_flow.nil?
    fail ArgumentError, "Missing the required parameter 'email_flow' when calling StorefrontApi.update_email_flow"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/flows/{email_flow_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_flow_uuid' + '}', CGI.escape(email_flow_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_flow)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailFlowResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_flow",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_global_settings(global_settings, opts = {}) ⇒ EmailGlobalSettingsResponse

Update email global settings

Parameters:

  • global_settings (EmailGlobalSettings) —

    global settings request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11255
11256
11257
11258
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11255

def update_email_global_settings(global_settings, opts = {})
  data, _status_code, _headers = update_email_global_settings_with_http_info(global_settings, opts)
  data
end

#update_email_global_settings_with_http_info(global_settings, opts = {}) ⇒ Array<(EmailGlobalSettingsResponse, Integer, Hash)>

Update email global settings

Parameters:

  • global_settings (EmailGlobalSettings) —

    global settings request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailGlobalSettingsResponse, Integer, Hash)>) —

    EmailGlobalSettingsResponse data, response status code and response headers



11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11264

def update_email_global_settings_with_http_info(global_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_global_settings ...'
  end
  # verify the required parameter 'global_settings' is set
  if @api_client.config.client_side_validation && global_settings.nil?
    fail ArgumentError, "Missing the required parameter 'global_settings' when calling StorefrontApi.update_email_global_settings"
  end
  # resource path
  local_var_path = '/storefront/email/global_settings'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(global_settings)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailGlobalSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_global_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_global_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_list(storefront_oid, email_list_uuid, email_list, opts = {}) ⇒ EmailListResponse

Update email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_list (EmailList) —

    Email list

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11324
11325
11326
11327
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11324

def update_email_list(storefront_oid, email_list_uuid, email_list, opts = {})
  data, _status_code, _headers = update_email_list_with_http_info(storefront_oid, email_list_uuid, email_list, opts)
  data
end

#update_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder, opts = {}) ⇒ EmailListSegmentFolderResponse

Update email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • email_list_segment_folder (EmailListSegmentFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11403
11404
11405
11406
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11403

def update_email_list_segment_folder(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder, opts = {})
  data, _status_code, _headers = update_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder, opts)
  data
end

#update_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder, opts = {}) ⇒ Array<(EmailListSegmentFolderResponse, Integer, Hash)>

Update email campaign folder

Parameters:

  • storefront_oid (Integer)
  • email_list_segment_folder_uuid (String)
  • email_list_segment_folder (EmailListSegmentFolder) —

    Email campaign folder

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11414

def update_email_list_segment_folder_with_http_info(storefront_oid, email_list_segment_folder_uuid, email_list_segment_folder, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_list_segment_folder ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_list_segment_folder"
  end
  # verify the required parameter 'email_list_segment_folder_uuid' is set
  if @api_client.config.client_side_validation && email_list_segment_folder_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_segment_folder_uuid' when calling StorefrontApi.update_email_list_segment_folder"
  end
  # verify the required parameter 'email_list_segment_folder' is set
  if @api_client.config.client_side_validation && email_list_segment_folder.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_segment_folder' when calling StorefrontApi.update_email_list_segment_folder"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_segment_folder_uuid' + '}', CGI.escape(email_list_segment_folder_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_list_segment_folder)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListSegmentFolderResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_list_segment_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_list_segment_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_list_with_http_info(storefront_oid, email_list_uuid, email_list, opts = {}) ⇒ Array<(EmailListResponse, Integer, Hash)>

Update email list

Parameters:

  • storefront_oid (Integer)
  • email_list_uuid (String)
  • email_list (EmailList) —

    Email list

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Integer, Hash)>) —

    EmailListResponse data, response status code and response headers



11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11335

def update_email_list_with_http_info(storefront_oid, email_list_uuid, email_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_list ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_list"
  end
  # verify the required parameter 'email_list_uuid' is set
  if @api_client.config.client_side_validation && email_list_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_list_uuid' when calling StorefrontApi.update_email_list"
  end
  # verify the required parameter 'email_list' is set
  if @api_client.config.client_side_validation && email_list.nil?
    fail ArgumentError, "Missing the required parameter 'email_list' when calling StorefrontApi.update_email_list"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/lists/{email_list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_list_uuid' + '}', CGI.escape(email_list_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_list)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_plan(storefront_oid, settings, opts = {}) ⇒ EmailPlanResponse

Update email plan

Parameters:

  • storefront_oid (Integer)
  • settings (EmailPlan) —

    plan request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11481
11482
11483
11484
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11481

def update_email_plan(storefront_oid, settings, opts = {})
  data, _status_code, _headers = update_email_plan_with_http_info(storefront_oid, settings, opts)
  data
end

#update_email_plan_with_http_info(storefront_oid, settings, opts = {}) ⇒ Array<(EmailPlanResponse, Integer, Hash)>

Update email plan

Parameters:

  • storefront_oid (Integer)
  • settings (EmailPlan) —

    plan request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailPlanResponse, Integer, Hash)>) —

    EmailPlanResponse data, response status code and response headers



11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11491

def update_email_plan_with_http_info(storefront_oid, settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_plan ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_plan"
  end
  # verify the required parameter 'settings' is set
  if @api_client.config.client_side_validation && settings.nil?
    fail ArgumentError, "Missing the required parameter 'settings' when calling StorefrontApi.update_email_plan"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/plan'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(settings)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailPlanResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_plan",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_postcard(storefront_oid, commseq_postcard_uuid, email_commseq_postcard, opts = {}) ⇒ EmailCommseqPostcardResponse

Update email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • email_commseq_postcard (EmailCommseqPostcard) —

    Email commseq postcard

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11555
11556
11557
11558
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11555

def update_email_postcard(storefront_oid, commseq_postcard_uuid, email_commseq_postcard, opts = {})
  data, _status_code, _headers = update_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard, opts)
  data
end

#update_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard, opts = {}) ⇒ Array<(EmailCommseqPostcardResponse, Integer, Hash)>

Update email postcard

Parameters:

  • storefront_oid (Integer)
  • commseq_postcard_uuid (String)
  • email_commseq_postcard (EmailCommseqPostcard) —

    Email commseq postcard

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11566

def update_email_postcard_with_http_info(storefront_oid, commseq_postcard_uuid, email_commseq_postcard, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_postcard ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_postcard"
  end
  # verify the required parameter 'commseq_postcard_uuid' is set
  if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.update_email_postcard"
  end
  # verify the required parameter 'email_commseq_postcard' is set
  if @api_client.config.client_side_validation && email_commseq_postcard.nil?
    fail ArgumentError, "Missing the required parameter 'email_commseq_postcard' when calling StorefrontApi.update_email_postcard"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_postcard)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailCommseqPostcardResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_postcard",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_postcard\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_segment(storefront_oid, email_segment_uuid, email_segment, opts = {}) ⇒ EmailSegmentResponse

Update email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_segment (EmailSegment) —

    Email segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11634
11635
11636
11637
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11634

def update_email_segment(storefront_oid, email_segment_uuid, email_segment, opts = {})
  data, _status_code, _headers = update_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment, opts)
  data
end

#update_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment, opts = {}) ⇒ Array<(EmailSegmentResponse, Integer, Hash)>

Update email segment

Parameters:

  • storefront_oid (Integer)
  • email_segment_uuid (String)
  • email_segment (EmailSegment) —

    Email segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Integer, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11645

def update_email_segment_with_http_info(storefront_oid, email_segment_uuid, email_segment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_segment"
  end
  # verify the required parameter 'email_segment_uuid' is set
  if @api_client.config.client_side_validation && email_segment_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment_uuid' when calling StorefrontApi.update_email_segment"
  end
  # verify the required parameter 'email_segment' is set
  if @api_client.config.client_side_validation && email_segment.nil?
    fail ArgumentError, "Missing the required parameter 'email_segment' when calling StorefrontApi.update_email_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/segments/{email_segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_segment_uuid' + '}', CGI.escape(email_segment_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_segment)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_sending_domain(domain, email_domain, opts = {}) ⇒ EmailSendingDomainResponse

Update email sending domain

Parameters:

  • domain (String)
  • email_domain (EmailDomain) —

    EmailDomain

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11712
11713
11714
11715
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11712

def update_email_sending_domain(domain, email_domain, opts = {})
  data, _status_code, _headers = update_email_sending_domain_with_http_info(domain, email_domain, opts)
  data
end

#update_email_sending_domain_with_http_info(domain, email_domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Integer, Hash)>

Update email sending domain

Parameters:

  • domain (String)
  • email_domain (EmailDomain) —

    EmailDomain

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSendingDomainResponse, Integer, Hash)>) —

    EmailSendingDomainResponse data, response status code and response headers



11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11722

def update_email_sending_domain_with_http_info(domain, email_domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_sending_domain ...'
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling StorefrontApi.update_email_sending_domain"
  end
  # verify the required parameter 'email_domain' is set
  if @api_client.config.client_side_validation && email_domain.nil?
    fail ArgumentError, "Missing the required parameter 'email_domain' when calling StorefrontApi.update_email_sending_domain"
  end
  # resource path
  local_var_path = '/storefront/email/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(email_domain)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSendingDomainResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_sending_domain",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_settings(storefront_oid, settings, opts = {}) ⇒ EmailSettingsResponse

Update email settings

Parameters:

  • storefront_oid (Integer)
  • settings (EmailSettings) —

    settings request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11785
11786
11787
11788
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11785

def update_email_settings(storefront_oid, settings, opts = {})
  data, _status_code, _headers = update_email_settings_with_http_info(storefront_oid, settings, opts)
  data
end

#update_email_settings_with_http_info(storefront_oid, settings, opts = {}) ⇒ Array<(EmailSettingsResponse, Integer, Hash)>

Update email settings

Parameters:

  • storefront_oid (Integer)
  • settings (EmailSettings) —

    settings request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EmailSettingsResponse, Integer, Hash)>) —

    EmailSettingsResponse data, response status code and response headers



11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11795

def update_email_settings_with_http_info(storefront_oid, settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_email_settings ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_email_settings"
  end
  # verify the required parameter 'settings' is set
  if @api_client.config.client_side_validation && settings.nil?
    fail ArgumentError, "Missing the required parameter 'settings' when calling StorefrontApi.update_email_settings"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/email/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(settings)

  # return_type
  return_type = opts[:debug_return_type] || 'EmailSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_email_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_email_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_experiment(storefront_oid, storefront_experiment_oid, experiment, opts = {}) ⇒ ExperimentResponse

Update experiment

Parameters:

  • storefront_oid (Integer)
  • storefront_experiment_oid (Integer)
  • experiment (Experiment) —

    Experiment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11859
11860
11861
11862
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11859

def update_experiment(storefront_oid, storefront_experiment_oid, experiment, opts = {})
  data, _status_code, _headers = update_experiment_with_http_info(storefront_oid, storefront_experiment_oid, experiment, opts)
  data
end

#update_experiment_with_http_info(storefront_oid, storefront_experiment_oid, experiment, opts = {}) ⇒ Array<(ExperimentResponse, Integer, Hash)>

Update experiment

Parameters:

  • storefront_oid (Integer)
  • storefront_experiment_oid (Integer)
  • experiment (Experiment) —

    Experiment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ExperimentResponse, Integer, Hash)>) —

    ExperimentResponse data, response status code and response headers



11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11870

def update_experiment_with_http_info(storefront_oid, storefront_experiment_oid, experiment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_experiment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_experiment"
  end
  # verify the required parameter 'storefront_experiment_oid' is set
  if @api_client.config.client_side_validation && storefront_experiment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_experiment_oid' when calling StorefrontApi.update_experiment"
  end
  # verify the required parameter 'experiment' is set
  if @api_client.config.client_side_validation && experiment.nil?
    fail ArgumentError, "Missing the required parameter 'experiment' when calling StorefrontApi.update_experiment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'storefront_experiment_oid' + '}', CGI.escape(storefront_experiment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(experiment)

  # return_type
  return_type = opts[:debug_return_type] || 'ExperimentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_experiment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_experiment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_library_item(library_item_oid, library_item, opts = {}) ⇒ LibraryItemResponse

Update library item. Note that only certain fields may be updated via this method.

Parameters:

  • library_item_oid (Integer)
  • library_item (LibraryItem) —

    Library item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



11937
11938
11939
11940
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11937

def update_library_item(library_item_oid, library_item, opts = {})
  data, _status_code, _headers = update_library_item_with_http_info(library_item_oid, library_item, opts)
  data
end

#update_library_item_with_http_info(library_item_oid, library_item, opts = {}) ⇒ Array<(LibraryItemResponse, Integer, Hash)>

Update library item. Note that only certain fields may be updated via this method.

Parameters:

  • library_item_oid (Integer)
  • library_item (LibraryItem) —

    Library item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Integer, Hash)>) —

    LibraryItemResponse data, response status code and response headers



11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 11947

def update_library_item_with_http_info(library_item_oid, library_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_library_item ...'
  end
  # verify the required parameter 'library_item_oid' is set
  if @api_client.config.client_side_validation && library_item_oid.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_oid' when calling StorefrontApi.update_library_item"
  end
  # verify the required parameter 'library_item' is set
  if @api_client.config.client_side_validation && library_item.nil?
    fail ArgumentError, "Missing the required parameter 'library_item' when calling StorefrontApi.update_library_item"
  end
  # resource path
  local_var_path = '/storefront/code_library/{library_item_oid}'.sub('{' + 'library_item_oid' + '}', CGI.escape(library_item_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(library_item)

  # return_type
  return_type = opts[:debug_return_type] || 'LibraryItemResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_library_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_library_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {}) ⇒ nil

Update merchant notes on a screen recording Update merchant notes on a screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • merchant_notes_request (ScreenRecordingMerchantNotesRequest) —

    Merchant Notes

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


12012
12013
12014
12015
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12012

def update_screen_recording_merchant_notes(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
  update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts)
  nil
end

#update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update merchant notes on a screen recording Update merchant notes on a screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • merchant_notes_request (ScreenRecordingMerchantNotesRequest) —

    Merchant Notes

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12024

def update_screen_recording_merchant_notes_with_http_info(storefront_oid, screen_recording_uuid, merchant_notes_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_merchant_notes ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_screen_recording_merchant_notes"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.update_screen_recording_merchant_notes"
  end
  # verify the required parameter 'merchant_notes_request' is set
  if @api_client.config.client_side_validation && merchant_notes_request.nil?
    fail ArgumentError, "Missing the required parameter 'merchant_notes_request' when calling StorefrontApi.update_screen_recording_merchant_notes"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(merchant_notes_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_screen_recording_merchant_notes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_merchant_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_screen_recording_segment(storefront_oid, screen_recording_segment_oid, segment, opts = {}) ⇒ ScreenRecordingSegmentResponse

Update screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • segment (ScreenRecordingSegment) —

    Segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12092
12093
12094
12095
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12092

def update_screen_recording_segment(storefront_oid, screen_recording_segment_oid, segment, opts = {})
  data, _status_code, _headers = update_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, segment, opts)
  data
end

#update_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, segment, opts = {}) ⇒ Array<(ScreenRecordingSegmentResponse, Integer, Hash)>

Update screen recording segment

Parameters:

  • storefront_oid (Integer)
  • screen_recording_segment_oid (Integer)
  • segment (ScreenRecordingSegment) —

    Segment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12103

def update_screen_recording_segment_with_http_info(storefront_oid, screen_recording_segment_oid, segment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_segment ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_screen_recording_segment"
  end
  # verify the required parameter 'screen_recording_segment_oid' is set
  if @api_client.config.client_side_validation && screen_recording_segment_oid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_segment_oid' when calling StorefrontApi.update_screen_recording_segment"
  end
  # verify the required parameter 'segment' is set
  if @api_client.config.client_side_validation && segment.nil?
    fail ArgumentError, "Missing the required parameter 'segment' when calling StorefrontApi.update_screen_recording_segment"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_segment_oid' + '}', CGI.escape(screen_recording_segment_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(segment)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSegmentResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_screen_recording_segment",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_screen_recording_settings(storefront_oid, settings, opts = {}) ⇒ ScreenRecordingSettingsResponse

Update screen recording settings

Parameters:

  • storefront_oid (Integer)
  • settings (ScreenRecordingSettings) —

    Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12170
12171
12172
12173
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12170

def update_screen_recording_settings(storefront_oid, settings, opts = {})
  data, _status_code, _headers = update_screen_recording_settings_with_http_info(storefront_oid, settings, opts)
  data
end

#update_screen_recording_settings_with_http_info(storefront_oid, settings, opts = {}) ⇒ Array<(ScreenRecordingSettingsResponse, Integer, Hash)>

Update screen recording settings

Parameters:

  • storefront_oid (Integer)
  • settings (ScreenRecordingSettings) —

    Settings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12180

def update_screen_recording_settings_with_http_info(storefront_oid, settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_settings ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_screen_recording_settings"
  end
  # verify the required parameter 'settings' is set
  if @api_client.config.client_side_validation && settings.nil?
    fail ArgumentError, "Missing the required parameter 'settings' when calling StorefrontApi.update_screen_recording_settings"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/settings'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(settings)

  # return_type
  return_type = opts[:debug_return_type] || 'ScreenRecordingSettingsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_screen_recording_settings",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_screen_recording_tags(storefront_oid, screen_recording_uuid, tags, opts = {}) ⇒ nil

Update tags on a screen recording Update tags on a screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • tags (ScreenRecordingTagsRequest) —

    Tags

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


12245
12246
12247
12248
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12245

def update_screen_recording_tags(storefront_oid, screen_recording_uuid, tags, opts = {})
  update_screen_recording_tags_with_http_info(storefront_oid, screen_recording_uuid, tags, opts)
  nil
end

#update_screen_recording_tags_with_http_info(storefront_oid, screen_recording_uuid, tags, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update tags on a screen recording Update tags on a screen recording

Parameters:

  • storefront_oid (Integer)
  • screen_recording_uuid (String)
  • tags (ScreenRecordingTagsRequest) —

    Tags

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12257

def update_screen_recording_tags_with_http_info(storefront_oid, screen_recording_uuid, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_screen_recording_tags ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_screen_recording_tags"
  end
  # verify the required parameter 'screen_recording_uuid' is set
  if @api_client.config.client_side_validation && screen_recording_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'screen_recording_uuid' when calling StorefrontApi.update_screen_recording_tags"
  end
  # verify the required parameter 'tags' is set
  if @api_client.config.client_side_validation && tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling StorefrontApi.update_screen_recording_tags"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'screen_recording_uuid' + '}', CGI.escape(screen_recording_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(tags)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_screen_recording_tags",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_screen_recording_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_transaction_email(storefront_oid, email_id, transaction_email, opts = {}) ⇒ TransactionEmailResponse

Updates a transaction email object Updates a transactional email

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • transaction_email (TransactionEmail) —

    TransactionEmail

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12326
12327
12328
12329
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12326

def update_transaction_email(storefront_oid, email_id, transaction_email, opts = {})
  data, _status_code, _headers = update_transaction_email_with_http_info(storefront_oid, email_id, transaction_email, opts)
  data
end

#update_transaction_email_with_http_info(storefront_oid, email_id, transaction_email, opts = {}) ⇒ Array<(TransactionEmailResponse, Integer, Hash)>

Updates a transaction email object Updates a transactional email

Parameters:

  • storefront_oid (Integer)
  • email_id (String)
  • transaction_email (TransactionEmail) —

    TransactionEmail

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransactionEmailResponse, Integer, Hash)>) —

    TransactionEmailResponse data, response status code and response headers



12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12338

def update_transaction_email_with_http_info(storefront_oid, email_id, transaction_email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_transaction_email ...'
  end
  # verify the required parameter 'storefront_oid' is set
  if @api_client.config.client_side_validation && storefront_oid.nil?
    fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.update_transaction_email"
  end
  # verify the required parameter 'email_id' is set
  if @api_client.config.client_side_validation && email_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_id' when calling StorefrontApi.update_transaction_email"
  end
  # verify the required parameter 'transaction_email' is set
  if @api_client.config.client_side_validation && transaction_email.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_email' when calling StorefrontApi.update_transaction_email"
  end
  # resource path
  local_var_path = '/storefront/{storefront_oid}/transaction_email/list/{email_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'email_id' + '}', CGI.escape(email_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(transaction_email)

  # return_type
  return_type = opts[:debug_return_type] || 'TransactionEmailResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_transaction_email",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_transaction_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_twilio_account(esp_twilio_uuid, twilio, opts = {}) ⇒ TwilioResponse

Update Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • twilio (Twilio) —

    Twilio

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12405
12406
12407
12408
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12405

def (esp_twilio_uuid, twilio, opts = {})
  data, _status_code, _headers = (esp_twilio_uuid, twilio, opts)
  data
end

#update_twilio_account_with_http_info(esp_twilio_uuid, twilio, opts = {}) ⇒ Array<(TwilioResponse, Integer, Hash)>

Update Twilio account

Parameters:

  • esp_twilio_uuid (String)
  • twilio (Twilio) —

    Twilio

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TwilioResponse, Integer, Hash)>) —

    TwilioResponse data, response status code and response headers



12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12415

def (esp_twilio_uuid, twilio, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.update_twilio_account ...'
  end
  # verify the required parameter 'esp_twilio_uuid' is set
  if @api_client.config.client_side_validation && esp_twilio_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'esp_twilio_uuid' when calling StorefrontApi.update_twilio_account"
  end
  # verify the required parameter 'twilio' is set
  if @api_client.config.client_side_validation && twilio.nil?
    fail ArgumentError, "Missing the required parameter 'twilio' when calling StorefrontApi.update_twilio_account"
  end
  # resource path
  local_var_path = '/storefront/twilio/accounts/{esp_twilio_uuid}'.sub('{' + 'esp_twilio_uuid' + '}', CGI.escape(esp_twilio_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio)

  # return_type
  return_type = opts[:debug_return_type] || 'TwilioResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.update_twilio_account",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#update_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_fs_file(id, upload_request, opts = {}) ⇒ nil

This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.

Parameters:

  • id (Integer)
  • upload_request (FileManagerUploadRequest) —

    UploadRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


12478
12479
12480
12481
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12478

def upload_fs_file(id, upload_request, opts = {})
  upload_fs_file_with_http_info(id, upload_request, opts)
  nil
end

#upload_fs_file_with_http_info(id, upload_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.

Parameters:

  • id (Integer)
  • upload_request (FileManagerUploadRequest) —

    UploadRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12488

def upload_fs_file_with_http_info(id, upload_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.upload_fs_file ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.upload_fs_file"
  end
  # verify the required parameter 'upload_request' is set
  if @api_client.config.client_side_validation && upload_request.nil?
    fail ArgumentError, "Missing the required parameter 'upload_request' when calling StorefrontApi.upload_fs_file"
  end
  # resource path
  local_var_path = '/storefront/{id}/fs/upload'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.upload_fs_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#upload_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#validate_ruler(ruler_validate_request, opts = {}) ⇒ RulerValidationResponse

Validate AWS Event Ruler

Parameters:

  • ruler_validate_request (RulerValidationRequest) —

    Ruler Validate Request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



12550
12551
12552
12553
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12550

def validate_ruler(ruler_validate_request, opts = {})
  data, _status_code, _headers = validate_ruler_with_http_info(ruler_validate_request, opts)
  data
end

#validate_ruler_with_http_info(ruler_validate_request, opts = {}) ⇒ Array<(RulerValidationResponse, Integer, Hash)>

Validate AWS Event Ruler

Parameters:

  • ruler_validate_request (RulerValidationRequest) —

    Ruler Validate Request

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RulerValidationResponse, Integer, Hash)>) —

    RulerValidationResponse data, response status code and response headers



12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 12559

def validate_ruler_with_http_info(ruler_validate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StorefrontApi.validate_ruler ...'
  end
  # verify the required parameter 'ruler_validate_request' is set
  if @api_client.config.client_side_validation && ruler_validate_request.nil?
    fail ArgumentError, "Missing the required parameter 'ruler_validate_request' when calling StorefrontApi.validate_ruler"
  end
  # resource path
  local_var_path = '/storefront/ruler/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ruler_validate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'RulerValidationResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"StorefrontApi.validate_ruler",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StorefrontApi#validate_ruler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end