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 —

    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, Fixnum, Hash)>

Add to library

Parameters:

  • add_library_request —

    New library item request

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

    the optional parameters

Returns:

  • (Array<(LibraryItemResponse, Fixnum, 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
 
# 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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(add_library_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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 —

    New library item

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 92

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, Fixnum, Hash)>

Apply library item to storefront.

Parameters:

  • apply_library_request —

    New library item

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

    the optional parameters

Returns:

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

    ApplyLibraryItemResponse data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 101

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(apply_library_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApplyLibraryItemResponse')
  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
  • email_list_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



146
147
148
149
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 146

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, Fixnum, Hash)>

Archive email list

Parameters:

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

    the optional parameters

Returns:

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

    EmailListArchiveResponse data, response status code and response headers



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 156

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListArchiveResponse')
  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
  • email_segment_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 205

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, Fixnum, Hash)>

Archive email segment

Parameters:

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

    the optional parameters

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 215

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentArchiveResponse')
  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
  • email_flow_uuid
  • back_populate_request —

    The request to back populate

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

    the optional parameters

Returns:



265
266
267
268
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 265

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, Fixnum, Hash)>

Back populate email flow

Parameters:

  • storefront_oid
  • email_flow_uuid
  • back_populate_request —

    The request to back populate

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

    the optional parameters

Returns:



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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 276

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_uuid' + '}', email_flow_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(back_populate_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowBackPopulateResponse')
  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
  • email_segment_uuid
  • email_segment_rebuild_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 330

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, Fixnum, Hash)>

Check download of email segment

Parameters:

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

    the optional parameters

Returns:



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
383
384
385
386
387
388
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 341

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s).sub('{' + 'email_segment_rebuild_uuid' + '}', email_segment_rebuild_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentDownloadPrepareResponse')
  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
  • email_campaign_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:



395
396
397
398
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 395

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, Fixnum, Hash)>

Clone email campaign

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:

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

    EmailCampaignResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 406

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_uuid' + '}', email_campaign_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignResponse')
  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
  • email_flow_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:



457
458
459
460
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 457

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, Fixnum, Hash)>

Clone email flow

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :target_storefront_oid (Integer)

Returns:

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

    EmailFlowResponse data, response status code and response headers



468
469
470
471
472
473
474
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 468

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_uuid' + '}', email_flow_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



517
518
519
520
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 517

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_domain_with_http_info(domain, opts = {}) ⇒ Array<(EmailSendingDomainResponse, Fixnum, Hash)>

Create email campaign

Parameters:

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

    the optional parameters

Returns:

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

    EmailSendingDomainResponse data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 526

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' + '}', domain.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSendingDomainResponse')
  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_twilio_account(twilio, opts = {}) ⇒ TwilioResponse

Create Twilio account

Parameters:

  • twilio —

    Twilio

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 570

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

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

Create Twilio account

Parameters:

  • twilio —

    Twilio

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

    the optional parameters

Returns:

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

    TwilioResponse data, response status code and response headers



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 579

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(twilio)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TwilioResponse')
  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
  • email_campaign_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



624
625
626
627
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 624

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, Fixnum, Hash)>

Delete email campaignFolder

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



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
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 634

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_folder_uuid' + '}', email_campaign_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • commseq_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


683
684
685
686
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 683

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, Fixnum, Hash)>

Delete communication sequence stats

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
728
729
730
731
732
733
734
735
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 693

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



741
742
743
744
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 741

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, Fixnum, Hash)>

Delete email email

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 751

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • email_flow_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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

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, Fixnum, Hash)>

Delete email flowFolder

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse 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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 810

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_folder_uuid' + '}', email_flow_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • email_list_uuid
  • email_customer_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



860
861
862
863
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 860

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, Fixnum, Hash)>

Delete email list customer

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



871
872
873
874
875
876
877
878
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 871

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s).sub('{' + 'email_customer_uuid' + '}', email_customer_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • email_list_segment_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



924
925
926
927
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 924

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, Fixnum, Hash)>

Delete email ListSegmentFolder

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



934
935
936
937
938
939
940
941
942
943
944
945
946
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 934

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_segment_folder_uuid' + '}', email_list_segment_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • commseq_postcard_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



983
984
985
986
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 983

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, Fixnum, Hash)>

Delete email postcard

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 993

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1041
1042
1043
1044
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1041

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, Fixnum, Hash)>

delete email campaign

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1050

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' + '}', domain.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • storefront_experiment_oid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1095
1096
1097
1098
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1095

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, Fixnum, Hash)>

Delete experiment

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1105

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' + '}', storefront_oid.to_s).sub('{' + 'storefront_experiment_oid' + '}', storefront_experiment_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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_heatmap(storefront_oid, query, opts = {}) ⇒ nil

Delete screen recording heatmap Delete screen recording heatmap

Parameters:

  • storefront_oid
  • query —

    Query

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

    the optional parameters

Returns:

  • (nil) 


1154
1155
1156
1157
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1154

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, Fixnum, Hash)>

Delete screen recording heatmap Delete screen recording heatmap

Parameters:

  • storefront_oid
  • query —

    Query

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1165

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1212
1213
1214
1215
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1212

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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1264
1265
1266
1267
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1264

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, Fixnum, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1273

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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, Fixnum, Hash)>

Delete library item

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1221
1222
1223
1224
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1221

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • screen_recording_segment_oid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1317
1318
1319
1320
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1317

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, Fixnum, Hash)>

Delete screen recording segment

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1327

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_segment_oid' + '}', screen_recording_segment_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1374
1375
1376
1377
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1374

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, Fixnum, Hash)>

delete Twilio account

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1383

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' + '}', esp_twilio_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1427
1428
1429
1430
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1427

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, Fixnum, Hash)>

Duplicate library item.

Parameters:

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

    the optional parameters

Returns:

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

    LibraryItemResponse data, response status code and response headers



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
1475
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1436

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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
  • screen_recording_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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

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, Fixnum, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1493

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • geocode_request —

    geocode request

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

    the optional parameters

Returns:



1541
1542
1543
1544
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1541

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, Fixnum, Hash)>

Obtain lat/long for an address

Parameters:

  • storefront_oid
  • geocode_request —

    geocode request

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

    the optional parameters

Returns:

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

    GeocodeResponse data, response status code and response headers



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1551

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(geocode_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GeocodeResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1600
1601
1602
1603
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1600

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, Fixnum, Hash)>

Get countries Obtain a list of all the countries

Parameters:

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

    the optional parameters

Returns:

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

    CountriesResponse data, response status code and response headers



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1610

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CountriesResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1655
1656
1657
1658
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1655

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, Fixnum, Hash)>

Gets editor token Fetches a temporary authentication token for the editor

Parameters:

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

    the optional parameters

Returns:

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

    EmailEditorTokenResponse data, response status code and response headers



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1665

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailEditorTokenResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1709
1710
1711
1712
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1709

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, Fixnum, Hash)>

Get email communication base templates

Parameters:

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

    the optional parameters

Returns:



1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1718

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailBaseTemplateListResponse')
  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
  • email_campaign_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1763
1764
1765
1766
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1763

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
  • email_campaign_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1822
1823
1824
1825
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1822

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, Fixnum, Hash)>

Get email campaign folder

Parameters:

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

    the optional parameters

Returns:



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
1872
1873
1874
1875
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1832

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_folder_uuid' + '}', email_campaign_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignFolderResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1880
1881
1882
1883
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1880

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, Fixnum, Hash)>

Get email campaign folders

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1889

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignFoldersResponse')
  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
  • email_campaign_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1934
1935
1936
1937
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1934

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, Fixnum, Hash)>

Get email campaign screenshots

Parameters:

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

    the optional parameters

Returns:

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

    ScreenshotsResponse data, response status code and response headers



1944
1945
1946
1947
1948
1949
1950
1951
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1944

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_uuid' + '}', email_campaign_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenshotsResponse')
  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, Fixnum, Hash)>

Get email campaign

Parameters:

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

    the optional parameters

Returns:

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

    EmailCampaignResponse data, response status code and response headers



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
1810
1811
1812
1813
1814
1815
1816
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1773

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_uuid' + '}', email_campaign_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1992
1993
1994
1995
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 1992

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, Fixnum, Hash)>

Get email campaigns

Parameters:

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

    the optional parameters

Returns:

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

    EmailCampaignsResponse data, response status code and response headers



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2001

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignsResponse')
  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
  • stat_days
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2046
2047
2048
2049
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2046

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, Fixnum, Hash)>

Get email campaigns with stats

Parameters:

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

    the optional parameters

Returns:

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

    EmailCampaignsResponse data, response status code and response headers



2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2056

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' + '}', storefront_oid.to_s).sub('{' + 'stat_days' + '}', stat_days.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignsResponse')
  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
  • commseq_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2105
2106
2107
2108
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2105

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_email_stats(storefront_oid, commseq_uuid, stats_request, opts = {}) ⇒ EmailStatSummaryResponse

Get email communication sequence emails stats

Parameters:

  • storefront_oid
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:



2165
2166
2167
2168
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2165

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, Fixnum, Hash)>

Get email communication sequence emails stats

Parameters:

  • storefront_oid
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:

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

    EmailStatSummaryResponse data, response status code and response headers



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
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2176

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stats_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailStatSummaryResponse')
  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
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:



2230
2231
2232
2233
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2230

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, Fixnum, Hash)>

Get email communication sequence postcard stats

Parameters:

  • storefront_oid
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:



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
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2241

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stats_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailStatPostcardSummaryResponse')
  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_stat_overall(storefront_oid, commseq_uuid, opts = {}) ⇒ EmailCommseqStatResponse

Get communication sequence stats overall

Parameters:

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

    the optional parameters

Returns:



2294
2295
2296
2297
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2294

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, Fixnum, Hash)>

Get communication sequence stats overall

Parameters:

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

    the optional parameters

Returns:

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

    EmailCommseqStatResponse data, response status code and response headers



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
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2304

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqStatResponse')
  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
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:



2354
2355
2356
2357
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2354

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, Fixnum, Hash)>

Get email communication sequence step stats

Parameters:

  • storefront_oid
  • commseq_uuid
  • stats_request —

    StatsRequest

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

    the optional parameters

Returns:

  • (Array<(EmailStepStatResponse, Fixnum, Hash)>) —

    EmailStepStatResponse data, response status code and response headers



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
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2365

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stats_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailStepStatResponse')
  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
  • commseq_uuid
  • waiting_request —

    WaitingRequest

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

    the optional parameters

Returns:



2419
2420
2421
2422
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2419

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, Fixnum, Hash)>

Get email communication sequence customers waiting at each requested step

Parameters:

  • storefront_oid
  • commseq_uuid
  • waiting_request —

    WaitingRequest

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

    the optional parameters

Returns:

  • (Array<(EmailStepWaitingResponse, Fixnum, Hash)>) —

    EmailStepWaitingResponse data, response status code and response headers



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
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2430

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(waiting_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailStepWaitingResponse')
  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
  • commseq_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2483
2484
2485
2486
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2483

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, Fixnum, Hash)>

Get email webhook editor values

Parameters:

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

    the optional parameters

Returns:



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
2533
2534
2535
2536
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2493

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailWebhookEditorValuesResponse')
  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, Fixnum, Hash)>

Get email commseq

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Fixnum, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



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
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2115

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2541
2542
2543
2544
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2541

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, Fixnum, Hash)>

Get email commseqs

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqsResponse, Fixnum, Hash)>) —

    EmailCommseqsResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2550

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqsResponse')
  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
  • email_customer_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2595
2596
2597
2598
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2595

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, Fixnum, Hash)>

Get customers editor URL

Parameters:

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

    the optional parameters

Returns:



2605
2606
2607
2608
2609
2610
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2605

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' + '}', storefront_oid.to_s).sub('{' + 'email_customer_uuid' + '}', email_customer_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCustomerEditorUrlResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)
  • :search_email_prefix (String)

Returns:



2656
2657
2658
2659
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2656

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, Fixnum, Hash)>

Get email customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)
  • :search_email_prefix (String)

Returns:

  • (Array<(EmailCustomersResponse, Fixnum, Hash)>) —

    EmailCustomersResponse data, response status code and response headers



2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2668

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' + '}', storefront_oid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCustomersResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :last_records (Integer)

Returns:



2716
2717
2718
2719
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2716

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, Fixnum, Hash)>

Get email dashboard activity

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :last_records (Integer)

Returns:



2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2726

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' + '}', storefront_oid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailDashboardActivityResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



2772
2773
2774
2775
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2772

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, Fixnum, Hash)>

Get dashboard stats

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2782

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' + '}', storefront_oid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailDashboardStatsResponse')
  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
  • commseq_uuid
  • commseq_step_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2829
2830
2831
2832
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2829

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, Fixnum, Hash)>

Get email dispatch logs

Parameters:

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

    the optional parameters

Returns:



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
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2840

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqStepLogsResponse')
  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
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2893
2894
2895
2896
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2893

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
  • commseq_uuid
  • commseq_step_uuid
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



2955
2956
2957
2958
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2955

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, Fixnum, Hash)>

Get email email clicks

Parameters:

  • storefront_oid
  • commseq_uuid
  • commseq_step_uuid
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailClicksResponse, Fixnum, Hash)>) —

    EmailClicksResponse data, response status code and response headers



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
3019
3020
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2968

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailClicksResponse')
  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
  • commseq_email_uuid
  • order_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3027
3028
3029
3030
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3027

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, Fixnum, Hash)>

Get email order customer editor url

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3038

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s).sub('{' + 'order_id' + '}', order_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCustomerEditorUrlResponse')
  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
  • commseq_uuid
  • commseq_step_uuid
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:



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

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, Fixnum, Hash)>

Get email email orders

Parameters:

  • storefront_oid
  • commseq_uuid
  • commseq_step_uuid
  • commseq_email_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :days (Integer)

Returns:

  • (Array<(EmailOrdersResponse, Fixnum, Hash)>) —

    EmailOrdersResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3107

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailOrdersResponse')
  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, Fixnum, Hash)>

Get email email

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Fixnum, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 2903

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3164
3165
3166
3167
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3164

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
  • email_commseq_emails_request —

    Request of email uuids

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

    the optional parameters

Returns:



3218
3219
3220
3221
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3218

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, Fixnum, Hash)>

Get email emails multiple

Parameters:

  • storefront_oid
  • email_commseq_emails_request —

    Request of email uuids

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailsResponse, Fixnum, Hash)>) —

    EmailCommseqEmailsResponse data, response status code and response headers



3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3228

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_emails_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailsResponse')
  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, Fixnum, Hash)>

Get email emails

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailsResponse, Fixnum, Hash)>) —

    EmailCommseqEmailsResponse data, response status code and response headers



3173
3174
3175
3176
3177
3178
3179
3180
3181
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3173

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailsResponse')
  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
  • email_flow_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3277
3278
3279
3280
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3277

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
  • email_flow_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3336
3337
3338
3339
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3336

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, Fixnum, Hash)>

Get email flow folder

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Fixnum, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3346

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_folder_uuid' + '}', email_flow_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowFolderResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3394
3395
3396
3397
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3394

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, Fixnum, Hash)>

Get email flow folders

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailFlowFoldersResponse, Fixnum, Hash)>) —

    EmailFlowFoldersResponse data, response status code and response headers



3403
3404
3405
3406
3407
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3403

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowFoldersResponse')
  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
  • email_flow_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3448
3449
3450
3451
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3448

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, Fixnum, Hash)>

Get email flow screenshots

Parameters:

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

    the optional parameters

Returns:

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

    ScreenshotsResponse data, response status code and response headers



3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3458

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_uuid' + '}', email_flow_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenshotsResponse')
  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, Fixnum, Hash)>

Get email flow

Parameters:

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

    the optional parameters

Returns:

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

    EmailFlowResponse data, response status code and response headers



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
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3287

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_uuid' + '}', email_flow_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3506
3507
3508
3509
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3506

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, Fixnum, Hash)>

Get email flows

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailFlowsResponse, Fixnum, Hash)>) —

    EmailFlowsResponse data, response status code and response headers



3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3515

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowsResponse')
  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:



3558
3559
3560
3561
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3558

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, Fixnum, Hash)>

Get email globalsettings

Parameters:

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

    the optional parameters

Returns:



3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3566

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailGlobalSettingsResponse')
  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
  • email_list_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3607
3608
3609
3610
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3607

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
  • email_list_uuid
  • email_customer_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3667
3668
3669
3670
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3667

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, Fixnum, Hash)>

Get email list customer editor url

Parameters:

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

    the optional parameters

Returns:



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 3678

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s).sub('{' + 'email_customer_uuid' + '}', email_customer_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCustomerEditorUrlResponse')
  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
  • email_list_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



3733
3734
3735
3736
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3733

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, Fixnum, Hash)>

Get email list customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:

  • (Array<(EmailListCustomersResponse, Fixnum, Hash)>) —

    EmailListCustomersResponse data, response status code and response headers



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 3745

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListCustomersResponse')
  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
  • email_list_segment_folder_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3796
3797
3798
3799
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3796

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, Fixnum, Hash)>

Get email campaign folder

Parameters:

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

    the optional parameters

Returns:



3806
3807
3808
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3806

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_segment_folder_uuid' + '}', email_list_segment_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListSegmentFolderResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3854
3855
3856
3857
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3854

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, Fixnum, Hash)>

Get email campaign folders

Parameters:

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

    the optional parameters

Returns:



3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3863

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListSegmentFoldersResponse')
  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, Fixnum, Hash)>

Get email list

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Fixnum, Hash)>) —

    EmailListResponse data, response status code and response headers



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 3617

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3907
3908
3909
3910
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3907

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, Fixnum, Hash)>

Get email lists

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailListsResponse, Fixnum, Hash)>) —

    EmailListsResponse data, response status code and response headers



3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3916

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListsResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3960
3961
3962
3963
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3960

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, Fixnum, Hash)>

Get email performance

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailPerformanceResponse, Fixnum, Hash)>) —

    EmailPerformanceResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 3969

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailPerformanceResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4013
4014
4015
4016
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4013

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, Fixnum, Hash)>

Get email plan

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailPlanResponse, Fixnum, Hash)>) —

    EmailPlanResponse data, response status code and response headers



4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4022

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailPlanResponse')
  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
  • commseq_postcard_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4067
4068
4069
4070
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4067

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, Fixnum, Hash)>

Get email postcard

Parameters:

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

    the optional parameters

Returns:



4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4077

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4125
4126
4127
4128
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4125

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
  • email_commseq_postcards_request —

    Request of postcard uuids

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

    the optional parameters

Returns:



4179
4180
4181
4182
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4179

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, Fixnum, Hash)>

Get email postcards multiple

Parameters:

  • storefront_oid
  • email_commseq_postcards_request —

    Request of postcard uuids

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4189

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_postcards_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardsResponse')
  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, Fixnum, Hash)>

Get email postcards

Parameters:

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

    the optional parameters

Returns:



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
4173
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4134

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardsResponse')
  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
  • email_segment_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4238
4239
4240
4241
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4238

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
  • email_segment_uuid
  • email_customer_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4298
4299
4300
4301
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4298

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, Fixnum, Hash)>

Get email segment customers editor URL

Parameters:

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

    the optional parameters

Returns:



4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4309

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s).sub('{' + 'email_customer_uuid' + '}', email_customer_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCustomerEditorUrlResponse')
  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
  • email_segment_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



4364
4365
4366
4367
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4364

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, Fixnum, Hash)>

Get email segment customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer)
  • :page_size (Integer)

Returns:



4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4376

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentCustomersResponse')
  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, Fixnum, Hash)>

Get email segment

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Fixnum, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



4248
4249
4250
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4248

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4426
4427
4428
4429
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4426

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, Fixnum, Hash)>

Get email segments

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailSegmentsResponse, Fixnum, Hash)>) —

    EmailSegmentsResponse data, response status code and response headers



4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4435

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentsResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4479
4480
4481
4482
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4479

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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4532
4533
4534
4535
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4532

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, Fixnum, Hash)>

Get email sending domain status

Parameters:

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

    the optional parameters

Returns:

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

    EmailSendingDomainResponse data, response status code and response headers



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
4574
4575
4576
4577
4578
4579
4580
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4541

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' + '}', domain.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSendingDomainResponse')
  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, Fixnum, Hash)>

Get email sending domain

Parameters:

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

    the optional parameters

Returns:

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

    EmailSendingDomainResponse data, response status code and response headers



4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4488

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' + '}', domain.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSendingDomainResponse')
  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:



4584
4585
4586
4587
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4584

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, Fixnum, Hash)>

Get email sending domains

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4592

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSendingDomainsResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4632
4633
4634
4635
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4632

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, Fixnum, Hash)>

Get email settings

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailSettingsResponse, Fixnum, Hash)>) —

    EmailSettingsResponse data, response status code and response headers



4641
4642
4643
4644
4645
4646
4647
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4641

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSettingsResponse')
  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_template(storefront_oid, email_template_oid, opts = {}) ⇒ EmailTemplate

Get email template

Parameters:

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

    the optional parameters

Returns:



4686
4687
4688
4689
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4686

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, Fixnum, Hash)>

Get email template

Parameters:

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

    the optional parameters

Returns:

  • (Array<(EmailTemplate, Fixnum, Hash)>) —

    EmailTemplate data, response status code and response headers



4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4696

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' + '}', storefront_oid.to_s).sub('{' + 'email_template_oid' + '}', email_template_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailTemplate')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :trigger_type (String)

Returns:



4745
4746
4747
4748
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4745

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, Fixnum, Hash)>

Get email templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :trigger_type (String)

Returns:

  • (Array<(EmailTemplatesResponse, Fixnum, Hash)>) —

    EmailTemplatesResponse data, response status code and response headers



4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4755

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' + '}', storefront_oid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailTemplatesResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4800
4801
4802
4803
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4800

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, Fixnum, Hash)>

Get a list of third party email providers

Parameters:

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

    the optional parameters

Returns:



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
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4809

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailThirdPartyProvidersResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4853
4854
4855
4856
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4853

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, Fixnum, Hash)>

Get experiments

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ExperimentsResponse, Fixnum, Hash)>) —

    ExperimentsResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4862

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExperimentsResponse')
  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_heatmap(storefront_oid, query, opts = {}) ⇒ ScreenRecordingHeatmapResponse

Get screen recording heatmap Get screen recording heatmap

Parameters:

  • storefront_oid
  • query —

    Query

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

    the optional parameters

Returns:



4908
4909
4910
4911
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4908

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:

  • storefront_oid
  • query —

    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. (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:



4972
4973
4974
4975
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4972

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, Fixnum, Hash)>

Get screen recording heatmap index Get screen recording heatmap index

Parameters:

  • storefront_oid
  • query —

    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. (Default 100, Max 500)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



4986
4987
4988
4989
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4986

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' + '}', storefront_oid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingHeatmapIndexResponse')
  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, Fixnum, Hash)>

Get screen recording heatmap Get screen recording heatmap

Parameters:

  • storefront_oid
  • query —

    Query

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

    the optional parameters

Returns:



4919
4920
4921
4922
4923
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 4919

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingHeatmapResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_type (String)

Returns:



5039
5040
5041
5042
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5039

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, Fixnum, Hash)>

Get histogram property names Obtain a list of property names for a given property type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :property_type (String)

Returns:



5050
5051
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5050

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' + '}', storefront_oid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailHistogramPropertyNamesResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :property_name (String)
  • :property_type (String)
  • :limit (Integer)

Returns:



5099
5100
5101
5102
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5099

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, Fixnum, Hash)>

Get histogram property values Obtain a list of property values for a given property name and type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :property_name (String)
  • :property_type (String)
  • :limit (Integer)

Returns:



5112
5113
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5112

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' + '}', storefront_oid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailHistogramPropertyValuesResponse')
  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:



5158
5159
5160
5161
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5158

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, Fixnum, Hash)>

Get library values used to populate drop down boxes for filtering.

Parameters:

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

    the optional parameters

Returns:



5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5166

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryFilterValuesResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5206
5207
5208
5209
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5206

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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5259
5260
5261
5262
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5259

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, Fixnum, Hash)>

Get all published versions for a library item.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(LibraryItemsResponse, Fixnum, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5268

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemsResponse')
  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, Fixnum, Hash)>

Get library item.

Parameters:

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

    the optional parameters

Returns:

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

    LibraryItemResponse data, response status code and response headers



5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5215

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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
  • screen_recording_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5314
5315
5316
5317
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5314

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
  • screen_recording_uuid
  • screen_recording_page_view_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5376
5377
5378
5379
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5376

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, Fixnum, Hash)>

Get screen recording page view data Get screen recording page view data

Parameters:

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

    the optional parameters

Returns:



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
5427
5428
5429
5430
5431
5432
5433
5434
5435
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5388

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s).sub('{' + 'screen_recording_page_view_uuid' + '}', screen_recording_page_view_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingPageViewDataResponse')
  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
  • screen_recording_segment_oid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5441
5442
5443
5444
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5441

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, Fixnum, Hash)>

Get screen recording segment

Parameters:

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

    the optional parameters

Returns:



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 5451

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_segment_oid' + '}', screen_recording_segment_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSegmentResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5499
5500
5501
5502
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5499

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, Fixnum, Hash)>

Get screen recording segments

Parameters:

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

    the optional parameters

Returns:



5508
5509
5510
5511
5512
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5508

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSegmentsResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5552
5553
5554
5555
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5552

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, Fixnum, Hash)>

Get screen recording settings

Parameters:

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

    the optional parameters

Returns:



5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5561

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSettingsResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5606
5607
5608
5609
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5606

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, Fixnum, Hash)>

Get tags used by screen recording Get tags used by screen recording

Parameters:

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

    the optional parameters

Returns:



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
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5616

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingTagsResponse')
  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, Fixnum, Hash)>

Get screen recording Get screen recording

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ScreenRecordingResponse, Fixnum, Hash)>) —

    ScreenRecordingResponse data, response status code and response headers



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
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5325

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingResponse')
  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:

  • storefront_oid
  • query —

    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. (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:



5665
5666
5667
5668
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5665

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, Fixnum, Hash)>

Query screen recordings Query screen recordings

Parameters:

  • storefront_oid
  • query —

    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. (Default 100, Max 500)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



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
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5679

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' + '}', storefront_oid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingQueryResponse')
  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
  • screen_recording_segment_oid
  • 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:



5735
5736
5737
5738
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5735

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, Fixnum, Hash)>

Get screen recordings by segment Get screen recordings by segment

Parameters:

  • storefront_oid
  • screen_recording_segment_oid
  • 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)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5749

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_segment_oid' + '}', screen_recording_segment_oid.to_s)

  # query parameters
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingQueryResponse')
  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:



5801
5802
5803
5804
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5801

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, Fixnum, 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, Fixnum, Hash)>) —

    PricingTiersResponse data, response status code and response headers



5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5811

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 = {}
  query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PricingTiersResponse')
  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_thumbnail_parameters(thumbnail_parameters, opts = {}) ⇒ ThumbnailParametersResponse

Get thumbnail parameters

Parameters:

  • thumbnail_parameters —

    Thumbnail Parameters

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

    the optional parameters

Returns:



5852
5853
5854
5855
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5852

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, Fixnum, Hash)>

Get thumbnail parameters

Parameters:

  • thumbnail_parameters —

    Thumbnail Parameters

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

    the optional parameters

Returns:



5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5861

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(thumbnail_parameters)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ThumbnailParametersResponse')
  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
  • email_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5907
5908
5909
5910
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5907

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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5967
5968
5969
5970
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5967

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, Fixnum, Hash)>

Gets a list of transaction email names Obtain a list of all transactional emails and return back just their names

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5977

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionEmailListResponse')
  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
  • email_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6022
6023
6024
6025
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6022

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, Fixnum, Hash)>

Get transactional email screenshots

Parameters:

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

    the optional parameters

Returns:

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

    ScreenshotsResponse data, response status code and response headers



6032
6033
6034
6035
6036
6037
6038
6039
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6032

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' + '}', storefront_oid.to_s).sub('{' + 'email_id' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenshotsResponse')
  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, Fixnum, Hash)>

Gets a transaction email object Fetch a transactional email

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TransactionEmailResponse, Fixnum, Hash)>) —

    TransactionEmailResponse data, response status code and response headers



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
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 5918

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' + '}', storefront_oid.to_s).sub('{' + 'email_id' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionEmailResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6080
6081
6082
6083
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6080

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, Fixnum, Hash)>

Get Twilio account

Parameters:

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

    the optional parameters

Returns:

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

    TwilioResponse data, response status code and response headers



6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6089

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' + '}', esp_twilio_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TwilioResponse')
  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:



6132
6133
6134
6135
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6132

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, Fixnum, Hash)>

Get all Twilio accounts

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TwiliosResponse, Fixnum, Hash)>) —

    TwiliosResponse data, response status code and response headers



6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6140

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TwiliosResponse')
  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

#global_unsubscribe(storefront_oid, unsubscribe, opts = {}) ⇒ EmailGlobalUnsubscribeResponse

Globally unsubscribe a customer

Parameters:

  • storefront_oid
  • unsubscribe —

    Unsubscribe

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

    the optional parameters

Returns:



6181
6182
6183
6184
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6181

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, Fixnum, Hash)>

Globally unsubscribe a customer

Parameters:

  • storefront_oid
  • unsubscribe —

    Unsubscribe

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

    the optional parameters

Returns:



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
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6191

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(unsubscribe)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailGlobalUnsubscribeResponse')
  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:

  • storefront_oid
  • import_request —

    lists to import

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

    the optional parameters

Returns:

  • (nil) 


6240
6241
6242
6243
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6240

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, Fixnum, Hash)>

Import a third party provider list

Parameters:

  • storefront_oid
  • import_request —

    lists to import

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6250

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(import_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • email_campaign —

    Email campaign

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

    the optional parameters

Returns:



6298
6299
6300
6301
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6298

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
  • email_campaign_folder —

    Email campaign folder

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

    the optional parameters

Returns:



6357
6358
6359
6360
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6357

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, Fixnum, Hash)>

Insert email campaign folder

Parameters:

  • storefront_oid
  • email_campaign_folder —

    Email campaign folder

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

    the optional parameters

Returns:



6367
6368
6369
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6367

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignFolderResponse')
  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, Fixnum, Hash)>

Insert email campaign

Parameters:

  • storefront_oid
  • email_campaign —

    Email campaign

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

    the optional parameters

Returns:

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

    EmailCampaignResponse data, response status code and response headers



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 6308

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignResponse')
  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
  • email_commseq —

    Email commseq

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

    the optional parameters

Returns:



6416
6417
6418
6419
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6416

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, Fixnum, Hash)>

Insert email commseq

Parameters:

  • storefront_oid
  • email_commseq —

    Email commseq

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Fixnum, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6426

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqResponse')
  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
  • email_commseq_email —

    Email email

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

    the optional parameters

Returns:



6475
6476
6477
6478
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6475

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, Fixnum, Hash)>

Insert email email

Parameters:

  • storefront_oid
  • email_commseq_email —

    Email email

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Fixnum, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



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
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6485

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_email)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailResponse')
  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
  • email_flow —

    Email flow

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

    the optional parameters

Returns:



6534
6535
6536
6537
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6534

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
  • email_flow_folder —

    Email flow folder

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

    the optional parameters

Returns:



6593
6594
6595
6596
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6593

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, Fixnum, Hash)>

Insert email flow folder

Parameters:

  • storefront_oid
  • email_flow_folder —

    Email flow folder

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

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Fixnum, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6603

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_flow_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowFolderResponse')
  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, Fixnum, Hash)>

Insert email flow

Parameters:

  • storefront_oid
  • email_flow —

    Email flow

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

    the optional parameters

Returns:

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

    EmailFlowResponse data, response status code and response headers



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
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6544

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_flow)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowResponse')
  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
  • email_list —

    Email list

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

    the optional parameters

Returns:



6652
6653
6654
6655
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6652

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
  • email_list_segment_folder —

    Email campaign folder

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

    the optional parameters

Returns:



6711
6712
6713
6714
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6711

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, Fixnum, Hash)>

Insert email campaign folder

Parameters:

  • storefront_oid
  • email_list_segment_folder —

    Email campaign folder

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6721

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_list_segment_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListSegmentFolderResponse')
  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, Fixnum, Hash)>

Insert email list

Parameters:

  • storefront_oid
  • email_list —

    Email list

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

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Fixnum, Hash)>) —

    EmailListResponse data, response status code and response headers



6662
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6662

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_list)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListResponse')
  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
  • email_commseq_postcard —

    Email postcard

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

    the optional parameters

Returns:



6770
6771
6772
6773
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6770

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, Fixnum, Hash)>

Insert email postcard

Parameters:

  • storefront_oid
  • email_commseq_postcard —

    Email postcard

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

    the optional parameters

Returns:



6780
6781
6782
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6780

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_postcard)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardResponse')
  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
  • email_segment —

    Email segment

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

    the optional parameters

Returns:



6829
6830
6831
6832
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6829

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, Fixnum, Hash)>

Insert email segment

Parameters:

  • storefront_oid
  • email_segment —

    Email segment

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

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Fixnum, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6839

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_segment)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentResponse')
  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
  • segment —

    Segment

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

    the optional parameters

Returns:



6888
6889
6890
6891
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6888

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, Fixnum, Hash)>

Insert screen recording segment

Parameters:

  • storefront_oid
  • segment —

    Segment

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

    the optional parameters

Returns:



6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6898

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(segment)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSegmentResponse')
  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

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

Prepare download of email segment

Parameters:

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

    the optional parameters

Returns:



6947
6948
6949
6950
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6947

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, Fixnum, Hash)>

Prepare download of email segment

Parameters:

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

    the optional parameters

Returns:



6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 6957

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentDownloadPrepareResponse')
  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
  • publish_library_request —

    Publish library item request

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

    the optional parameters

Returns:



7006
7007
7008
7009
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7006

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, Fixnum, Hash)>

Publish library item.

Parameters:

  • library_item_oid
  • publish_library_request —

    Publish library item request

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

    the optional parameters

Returns:

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

    LibraryItemResponse data, response status code and response headers



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
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7016

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(publish_library_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :storefront_oid (Integer)

Returns:



7065
7066
7067
7068
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7065

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, Fixnum, Hash)>

Purchase public library item, which creates a copy of the item in your personal code library

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :storefront_oid (Integer)

Returns:

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

    LibraryItemResponse data, response status code and response headers



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
7107
7108
7109
7110
7111
7112
7113
7114
7115
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7075

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' + '}', library_item_oid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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
  • commseq_uuid
  • commseq_step_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


7122
7123
7124
7125
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7122

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, Fixnum, Hash)>

Release email communication sequence customers waiting at the specified step

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7133

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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

#review(storefront_oid, commseq_email_uuid, email_commseq_email_review_request, opts = {}) ⇒ EmailCommseqEmailSendTestResponse

Request a review of an email

Parameters:

  • storefront_oid
  • commseq_email_uuid
  • email_commseq_email_review_request —

    Email commseq email review request

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

    the optional parameters

Returns:



7186
7187
7188
7189
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7186

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, Fixnum, Hash)>

Request a review of an email

Parameters:

  • storefront_oid
  • commseq_email_uuid
  • email_commseq_email_review_request —

    Email commseq email review request

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

    the optional parameters

Returns:



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
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7197

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_email_review_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailSendTestResponse')
  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:



7253
7254
7255
7256
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7253

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

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

    the optional parameters

Returns:



7311
7312
7313
7314
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7311

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, Fixnum, Hash)>

Searches for all matching values (using POST)

Parameters:

  • lookup_request —

    LookupRequest

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

    the optional parameters

Returns:

  • (Array<(LookupResponse, Fixnum, Hash)>) —

    LookupResponse data, response status code and response headers



7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7320

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(lookup_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LookupResponse')
  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
  • email_list_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



7366
7367
7368
7369
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7366

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, Fixnum, Hash)>

Search email list customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:

  • (Array<(EmailListCustomersResponse, Fixnum, Hash)>) —

    EmailListCustomersResponse data, response status code and response headers



7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7377

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListCustomersResponse')
  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
  • email_segment_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



7428
7429
7430
7431
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7428

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, Fixnum, Hash)>

Search email segment customers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :starts_with (String)

Returns:



7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7439

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

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

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentCustomersResponse')
  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 —

    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:



7492
7493
7494
7495
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7492

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, Fixnum, 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 —

    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)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_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, Fixnum, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7505

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 = {}
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemsResponse')
  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 —

    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:



7556
7557
7558
7559
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7556

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, Fixnum, 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 —

    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)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_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, Fixnum, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7569

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 = {}
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemsResponse')
  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 —

    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:



7620
7621
7622
7623
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7620

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, Fixnum, 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 —

    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)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_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, Fixnum, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7633

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 = {}
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemsResponse')
  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 —

    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:



7684
7685
7686
7687
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7684

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, Fixnum, 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 —

    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)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index.

  • :_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, Fixnum, Hash)>) —

    LibraryItemsResponse data, response status code and response headers



7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7697

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 = {}
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_query)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemsResponse')
  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, Fixnum, 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, Fixnum, Hash)>) —

    LookupResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7266

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 = {}
  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 = {}
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LookupResponse')
  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
  • commseq_email_uuid
  • email_commseq_email_test_request —

    Email commseq email test request

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

    the optional parameters

Returns:



7746
7747
7748
7749
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7746

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, Fixnum, Hash)>

Send email test

Parameters:

  • storefront_oid
  • commseq_email_uuid
  • email_commseq_email_test_request —

    Email commseq email test request

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

    the optional parameters

Returns:



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
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7757

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_email_test_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailSendTestResponse')
  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
  • commseq_postcard_uuid
  • email_commseq_postcard_test_request —

    Email commseq email test request

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

    the optional parameters

Returns:



7811
7812
7813
7814
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7811

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, Fixnum, Hash)>

Send postcard test

Parameters:

  • storefront_oid
  • commseq_postcard_uuid
  • email_commseq_postcard_test_request —

    Email commseq email test request

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

    the optional parameters

Returns:



7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7822

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_postcard_test_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardSendTestResponse')
  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_webhook_test(storefront_oid, email_commseq_webhook_test_request, opts = {}) ⇒ EmailCommseqEmailSendTestResponse

Send webhook test

Parameters:

  • storefront_oid
  • email_commseq_webhook_test_request —

    Email commseq webhook test request

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

    the optional parameters

Returns:



7875
7876
7877
7878
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7875

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<(EmailCommseqEmailSendTestResponse, Fixnum, Hash)>

Send webhook test

Parameters:

  • storefront_oid
  • email_commseq_webhook_test_request —

    Email commseq webhook test request

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

    the optional parameters

Returns:



7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7885

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_webhook_test_request)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailSendTestResponse')
  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

#start_email_campaign(storefront_oid, email_campaign_uuid, opts = {}) ⇒ BaseResponse

Start email campaign

Parameters:

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

    the optional parameters

Returns:



7934
7935
7936
7937
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7934

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, Fixnum, Hash)>

Start email campaign

Parameters:

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7944

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_uuid' + '}', email_campaign_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  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
  • email_list_uuid
  • customers —

    Customers

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

    the optional parameters

Returns:



7994
7995
7996
7997
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 7994

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, Fixnum, Hash)>

Subscribe customers to email list

Parameters:

  • storefront_oid
  • email_list_uuid
  • customers —

    Customers

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

    the optional parameters

Returns:

  • (Array<(EmailListSubscribeResponse, Fixnum, Hash)>) —

    EmailListSubscribeResponse data, response status code and response headers



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
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8005

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(customers)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListSubscribeResponse')
  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

#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
  • screen_recording_uuid
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


8059
8060
8061
8062
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8059

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, Fixnum, Hash)>

Remove favorite flag on screen recording Remove favorite flag on screen recording

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8070

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • email_campaign_uuid
  • email_campaign —

    Email campaign

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

    the optional parameters

Returns:



8119
8120
8121
8122
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8119

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
  • email_campaign_folder_uuid
  • email_campaign_folder —

    Email campaign folder

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

    the optional parameters

Returns:



8184
8185
8186
8187
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8184

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, Fixnum, Hash)>

Update email campaign folder

Parameters:

  • storefront_oid
  • email_campaign_folder_uuid
  • email_campaign_folder —

    Email campaign folder

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

    the optional parameters

Returns:



8195
8196
8197
8198
8199
8200
8201
8202
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8195

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_folder_uuid' + '}', email_campaign_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignFolderResponse')
  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, Fixnum, Hash)>

Update email campaign

Parameters:

  • storefront_oid
  • email_campaign_uuid
  • email_campaign —

    Email campaign

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

    the optional parameters

Returns:

  • (Array<(EmailCampaignResponse, Fixnum, 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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8130

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' + '}', storefront_oid.to_s).sub('{' + 'email_campaign_uuid' + '}', email_campaign_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_campaign)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCampaignResponse')
  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
  • commseq_uuid
  • email_commseq —

    Email commseq

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

    the optional parameters

Returns:



8249
8250
8251
8252
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8249

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, Fixnum, Hash)>

Update email commseq

Parameters:

  • storefront_oid
  • commseq_uuid
  • email_commseq —

    Email commseq

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqResponse, Fixnum, Hash)>) —

    EmailCommseqResponse data, response status code and response headers



8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8260

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqResponse')
  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
  • email_customer_uuid
  • email_customer —

    Email customer

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

    the optional parameters

Returns:

  • (nil) 


8314
8315
8316
8317
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8314

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, Fixnum, Hash)>

Update email customer

Parameters:

  • storefront_oid
  • email_customer_uuid
  • email_customer —

    Email customer

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8325

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' + '}', storefront_oid.to_s).sub('{' + 'email_customer_uuid' + '}', email_customer_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_customer)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • commseq_email_uuid
  • email_commseq_email —

    Email commseq email

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

    the optional parameters

Returns:



8378
8379
8380
8381
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8378

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, Fixnum, Hash)>

Update email email

Parameters:

  • storefront_oid
  • commseq_email_uuid
  • email_commseq_email —

    Email commseq email

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

    the optional parameters

Returns:

  • (Array<(EmailCommseqEmailResponse, Fixnum, Hash)>) —

    EmailCommseqEmailResponse data, response status code and response headers



8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8389

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_email_uuid' + '}', commseq_email_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_email)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqEmailResponse')
  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
  • email_flow_uuid
  • email_flow —

    Email flow

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

    the optional parameters

Returns:



8443
8444
8445
8446
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8443

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
  • email_flow_folder_uuid
  • email_flow_folder —

    Email flow folder

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

    the optional parameters

Returns:



8508
8509
8510
8511
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8508

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, Fixnum, Hash)>

Update email flow folder

Parameters:

  • storefront_oid
  • email_flow_folder_uuid
  • email_flow_folder —

    Email flow folder

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

    the optional parameters

Returns:

  • (Array<(EmailFlowFolderResponse, Fixnum, Hash)>) —

    EmailFlowFolderResponse data, response status code and response headers



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
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8519

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_folder_uuid' + '}', email_flow_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_flow_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowFolderResponse')
  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, Fixnum, Hash)>

Update email flow

Parameters:

  • storefront_oid
  • email_flow_uuid
  • email_flow —

    Email flow

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

    the optional parameters

Returns:

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

    EmailFlowResponse data, response status code and response headers



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
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8454

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' + '}', storefront_oid.to_s).sub('{' + 'email_flow_uuid' + '}', email_flow_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_flow)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailFlowResponse')
  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 —

    global settings request

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

    the optional parameters

Returns:



8571
8572
8573
8574
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8571

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, Fixnum, Hash)>

Update email global settings

Parameters:

  • global_settings —

    global settings request

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8580

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 = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(global_settings)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailGlobalSettingsResponse')
  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
  • email_list_uuid
  • email_list —

    Email list

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

    the optional parameters

Returns:



8626
8627
8628
8629
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8626

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
  • email_list_segment_folder_uuid
  • email_list_segment_folder —

    Email campaign folder

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

    the optional parameters

Returns:



8691
8692
8693
8694
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8691

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, Fixnum, Hash)>

Update email campaign folder

Parameters:

  • storefront_oid
  • email_list_segment_folder_uuid
  • email_list_segment_folder —

    Email campaign folder

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

    the optional parameters

Returns:



8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8702

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_segment_folder_uuid' + '}', email_list_segment_folder_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_list_segment_folder)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListSegmentFolderResponse')
  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, Fixnum, Hash)>

Update email list

Parameters:

  • storefront_oid
  • email_list_uuid
  • email_list —

    Email list

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

    the optional parameters

Returns:

  • (Array<(EmailListResponse, Fixnum, Hash)>) —

    EmailListResponse data, response status code and response headers



8637
8638
8639
8640
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8637

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' + '}', storefront_oid.to_s).sub('{' + 'email_list_uuid' + '}', email_list_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_list)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailListResponse')
  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
  • settings —

    plan request

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

    the optional parameters

Returns:



8755
8756
8757
8758
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8755

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, Fixnum, Hash)>

Update email plan

Parameters:

  • storefront_oid
  • settings —

    plan request

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

    the optional parameters

Returns:

  • (Array<(EmailPlanResponse, Fixnum, Hash)>) —

    EmailPlanResponse data, response status code and response headers



8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8765

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(settings)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailPlanResponse')
  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
  • commseq_postcard_uuid
  • email_commseq_postcard —

    Email commseq postcard

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

    the optional parameters

Returns:



8815
8816
8817
8818
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8815

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, Fixnum, Hash)>

Update email postcard

Parameters:

  • storefront_oid
  • commseq_postcard_uuid
  • email_commseq_postcard —

    Email commseq postcard

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

    the optional parameters

Returns:



8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8826

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' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_commseq_postcard)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailCommseqPostcardResponse')
  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
  • email_segment_uuid
  • email_segment —

    Email segment

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

    the optional parameters

Returns:



8880
8881
8882
8883
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8880

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, Fixnum, Hash)>

Update email segment

Parameters:

  • storefront_oid
  • email_segment_uuid
  • email_segment —

    Email segment

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

    the optional parameters

Returns:

  • (Array<(EmailSegmentResponse, Fixnum, Hash)>) —

    EmailSegmentResponse data, response status code and response headers



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
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8891

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' + '}', storefront_oid.to_s).sub('{' + 'email_segment_uuid' + '}', email_segment_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(email_segment)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSegmentResponse')
  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_settings(storefront_oid, settings, opts = {}) ⇒ EmailSettingsResponse

Update email settings

Parameters:

  • storefront_oid
  • settings —

    settings request

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

    the optional parameters

Returns:



8944
8945
8946
8947
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 8944

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, Fixnum, Hash)>

Update email settings

Parameters:

  • storefront_oid
  • settings —

    settings request

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

    the optional parameters

Returns:

  • (Array<(EmailSettingsResponse, Fixnum, Hash)>) —

    EmailSettingsResponse data, response status code and response headers



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 8954

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(settings)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EmailSettingsResponse')
  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
  • storefront_experiment_oid
  • experiment —

    Experiment

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

    the optional parameters

Returns:



9004
9005
9006
9007
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9004

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, Fixnum, Hash)>

Update experiment

Parameters:

  • storefront_oid
  • storefront_experiment_oid
  • experiment —

    Experiment

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

    the optional parameters

Returns:

  • (Array<(ExperimentResponse, Fixnum, Hash)>) —

    ExperimentResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9015

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' + '}', storefront_oid.to_s).sub('{' + 'storefront_experiment_oid' + '}', storefront_experiment_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(experiment)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExperimentResponse')
  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
  • library_item —

    Library item

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

    the optional parameters

Returns:



9068
9069
9070
9071
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9068

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, Fixnum, Hash)>

Update library item. Note that only certain fields may be updated via this method.

Parameters:

  • library_item_oid
  • library_item —

    Library item

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

    the optional parameters

Returns:

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

    LibraryItemResponse data, response status code and response headers



9078
9079
9080
9081
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9078

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' + '}', library_item_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(library_item)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'LibraryItemResponse')
  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
  • screen_recording_uuid
  • merchant_notes_request —

    Merchant Notes

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

    the optional parameters

Returns:

  • (nil) 


9129
9130
9131
9132
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9129

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, Fixnum, Hash)>

Update merchant notes on a screen recording Update merchant notes on a screen recording

Parameters:

  • storefront_oid
  • screen_recording_uuid
  • merchant_notes_request —

    Merchant Notes

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9141

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(merchant_notes_request)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • screen_recording_segment_oid
  • segment —

    Segment

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

    the optional parameters

Returns:



9194
9195
9196
9197
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9194

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, Fixnum, Hash)>

Update screen recording segment

Parameters:

  • storefront_oid
  • screen_recording_segment_oid
  • segment —

    Segment

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

    the optional parameters

Returns:



9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
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
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9205

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_segment_oid' + '}', screen_recording_segment_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(segment)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSegmentResponse')
  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
  • settings —

    Settings

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

    the optional parameters

Returns:



9258
9259
9260
9261
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9258

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, Fixnum, Hash)>

Update screen recording settings

Parameters:

  • storefront_oid
  • settings —

    Settings

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

    the optional parameters

Returns:



9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9268

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' + '}', storefront_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(settings)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScreenRecordingSettingsResponse')
  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
  • screen_recording_uuid
  • tags —

    Tags

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

    the optional parameters

Returns:

  • (nil) 


9319
9320
9321
9322
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9319

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, Fixnum, Hash)>

Update tags on a screen recording Update tags on a screen recording

Parameters:

  • storefront_oid
  • screen_recording_uuid
  • tags —

    Tags

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9331

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' + '}', storefront_oid.to_s).sub('{' + 'screen_recording_uuid' + '}', screen_recording_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(tags)
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  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
  • email_id
  • transaction_email —

    TransactionEmail

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

    the optional parameters

Returns:



9385
9386
9387
9388
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9385

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, Fixnum, Hash)>

Updates a transaction email object Updates a transactional email

Parameters:

  • storefront_oid
  • email_id
  • transaction_email —

    TransactionEmail

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

    the optional parameters

Returns:

  • (Array<(TransactionEmailResponse, Fixnum, Hash)>) —

    TransactionEmailResponse data, response status code and response headers



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
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9397

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' + '}', storefront_oid.to_s).sub('{' + 'email_id' + '}', email_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(transaction_email)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TransactionEmailResponse')
  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
  • twilio —

    Twilio

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

    the optional parameters

Returns:



9450
9451
9452
9453
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9450

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, Fixnum, Hash)>

Update Twilio account

Parameters:

  • esp_twilio_uuid
  • twilio —

    Twilio

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

    the optional parameters

Returns:

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

    TwilioResponse data, response status code and response headers



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
9496
9497
9498
9499
9500
9501
9502
9503
 
# File 'lib/ultracart_api/api/storefront_api.rb', line 9460

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' + '}', esp_twilio_uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(twilio)
  auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TwilioResponse')
  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