ultracart_api 4.1.229 → 4.1.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +21 -2
- data/docs/ItemAutoOrder.md +6 -0
- data/docs/SfvbApi.md +557 -1
- data/docs/SfvbCommsFolder.md +28 -0
- data/docs/SfvbCommsFolderItem.md +22 -0
- data/docs/SfvbCommsFolderResponse.md +22 -0
- data/docs/SfvbCommsFolderWriteRequest.md +18 -0
- data/docs/SfvbCommsFoldersResponse.md +18 -0
- data/docs/SfvbCommsListDetail.md +34 -0
- data/docs/SfvbCommsListResponse.md +20 -0
- data/docs/SfvbCommsListWriteRequest.md +24 -0
- data/docs/SfvbFlowWriteRequest.md +2 -2
- data/docs/SfvbSequenceStep.md +1 -1
- data/docs/SfvbStepCounts.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +785 -24
- data/lib/ultracart_api/models/item_auto_order.rb +35 -1
- data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
- data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
- data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
- data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
|
@@ -284,6 +284,160 @@ module UltracartClient
|
|
|
284
284
|
return data, status_code, headers
|
|
285
285
|
end
|
|
286
286
|
|
|
287
|
+
# Archive an email list
|
|
288
|
+
# Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the list's hash_sha256 as If-Match.
|
|
289
|
+
# @param storefront_oid [Integer]
|
|
290
|
+
# @param list_uuid [String]
|
|
291
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @return [SfvbCommsListResponse]
|
|
294
|
+
def archive_sfvb_comms_list(storefront_oid, list_uuid, if_match, opts = {})
|
|
295
|
+
data, _status_code, _headers = archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, opts)
|
|
296
|
+
data
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
# Archive an email list
|
|
300
|
+
# Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the list's hash_sha256 as If-Match.
|
|
301
|
+
# @param storefront_oid [Integer]
|
|
302
|
+
# @param list_uuid [String]
|
|
303
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
304
|
+
# @param [Hash] opts the optional parameters
|
|
305
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
306
|
+
def archive_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, opts = {})
|
|
307
|
+
if @api_client.config.debugging
|
|
308
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.archive_sfvb_comms_list ...'
|
|
309
|
+
end
|
|
310
|
+
# verify the required parameter 'storefront_oid' is set
|
|
311
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
312
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.archive_sfvb_comms_list"
|
|
313
|
+
end
|
|
314
|
+
# verify the required parameter 'list_uuid' is set
|
|
315
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
316
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.archive_sfvb_comms_list"
|
|
317
|
+
end
|
|
318
|
+
# verify the required parameter 'if_match' is set
|
|
319
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
320
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.archive_sfvb_comms_list"
|
|
321
|
+
end
|
|
322
|
+
# resource path
|
|
323
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/archive'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
324
|
+
|
|
325
|
+
# query parameters
|
|
326
|
+
query_params = opts[:query_params] || {}
|
|
327
|
+
|
|
328
|
+
# header parameters
|
|
329
|
+
header_params = opts[:header_params] || {}
|
|
330
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
331
|
+
# HTTP header 'Accept' (if needed)
|
|
332
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
333
|
+
header_params[:'If-Match'] = if_match
|
|
334
|
+
|
|
335
|
+
# form parameters
|
|
336
|
+
form_params = opts[:form_params] || {}
|
|
337
|
+
|
|
338
|
+
# http body (model)
|
|
339
|
+
post_body = opts[:debug_body]
|
|
340
|
+
|
|
341
|
+
# return_type
|
|
342
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
343
|
+
|
|
344
|
+
# auth_names
|
|
345
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
346
|
+
|
|
347
|
+
new_options = opts.merge(
|
|
348
|
+
:operation => :"SfvbApi.archive_sfvb_comms_list",
|
|
349
|
+
:header_params => header_params,
|
|
350
|
+
:query_params => query_params,
|
|
351
|
+
:form_params => form_params,
|
|
352
|
+
:body => post_body,
|
|
353
|
+
:auth_names => auth_names,
|
|
354
|
+
:return_type => return_type
|
|
355
|
+
)
|
|
356
|
+
|
|
357
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
358
|
+
if @api_client.config.debugging
|
|
359
|
+
@api_client.config.logger.debug "API called: SfvbApi#archive_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
360
|
+
end
|
|
361
|
+
return data, status_code, headers
|
|
362
|
+
end
|
|
363
|
+
|
|
364
|
+
# Archive a segment
|
|
365
|
+
# Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the segment's hash_sha256 as If-Match.
|
|
366
|
+
# @param storefront_oid [Integer]
|
|
367
|
+
# @param segment_uuid [String]
|
|
368
|
+
# @param if_match [String] The segment's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
369
|
+
# @param [Hash] opts the optional parameters
|
|
370
|
+
# @return [SfvbCommsSegmentResponse]
|
|
371
|
+
def archive_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, opts = {})
|
|
372
|
+
data, _status_code, _headers = archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, opts)
|
|
373
|
+
data
|
|
374
|
+
end
|
|
375
|
+
|
|
376
|
+
# Archive a segment
|
|
377
|
+
# Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren't live, which can no longer use it. Send the segment's hash_sha256 as If-Match.
|
|
378
|
+
# @param storefront_oid [Integer]
|
|
379
|
+
# @param segment_uuid [String]
|
|
380
|
+
# @param if_match [String] The segment's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
381
|
+
# @param [Hash] opts the optional parameters
|
|
382
|
+
# @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
|
|
383
|
+
def archive_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, opts = {})
|
|
384
|
+
if @api_client.config.debugging
|
|
385
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.archive_sfvb_comms_segment ...'
|
|
386
|
+
end
|
|
387
|
+
# verify the required parameter 'storefront_oid' is set
|
|
388
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
389
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.archive_sfvb_comms_segment"
|
|
390
|
+
end
|
|
391
|
+
# verify the required parameter 'segment_uuid' is set
|
|
392
|
+
if @api_client.config.client_side_validation && segment_uuid.nil?
|
|
393
|
+
fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.archive_sfvb_comms_segment"
|
|
394
|
+
end
|
|
395
|
+
# verify the required parameter 'if_match' is set
|
|
396
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
397
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.archive_sfvb_comms_segment"
|
|
398
|
+
end
|
|
399
|
+
# resource path
|
|
400
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/archive'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
|
|
401
|
+
|
|
402
|
+
# query parameters
|
|
403
|
+
query_params = opts[:query_params] || {}
|
|
404
|
+
|
|
405
|
+
# header parameters
|
|
406
|
+
header_params = opts[:header_params] || {}
|
|
407
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
408
|
+
# HTTP header 'Accept' (if needed)
|
|
409
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
410
|
+
header_params[:'If-Match'] = if_match
|
|
411
|
+
|
|
412
|
+
# form parameters
|
|
413
|
+
form_params = opts[:form_params] || {}
|
|
414
|
+
|
|
415
|
+
# http body (model)
|
|
416
|
+
post_body = opts[:debug_body]
|
|
417
|
+
|
|
418
|
+
# return_type
|
|
419
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
|
|
420
|
+
|
|
421
|
+
# auth_names
|
|
422
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
423
|
+
|
|
424
|
+
new_options = opts.merge(
|
|
425
|
+
:operation => :"SfvbApi.archive_sfvb_comms_segment",
|
|
426
|
+
:header_params => header_params,
|
|
427
|
+
:query_params => query_params,
|
|
428
|
+
:form_params => form_params,
|
|
429
|
+
:body => post_body,
|
|
430
|
+
:auth_names => auth_names,
|
|
431
|
+
:return_type => return_type
|
|
432
|
+
)
|
|
433
|
+
|
|
434
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
435
|
+
if @api_client.config.debugging
|
|
436
|
+
@api_client.config.logger.debug "API called: SfvbApi#archive_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
437
|
+
end
|
|
438
|
+
return data, status_code, headers
|
|
439
|
+
end
|
|
440
|
+
|
|
287
441
|
# Archive or unarchive a flow
|
|
288
442
|
# A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
|
|
289
443
|
# @param storefront_oid [Integer]
|
|
@@ -1465,6 +1619,83 @@ module UltracartClient
|
|
|
1465
1619
|
return data, status_code, headers
|
|
1466
1620
|
end
|
|
1467
1621
|
|
|
1622
|
+
# Delete a list and segment folder
|
|
1623
|
+
# Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
|
|
1624
|
+
# @param storefront_oid [Integer]
|
|
1625
|
+
# @param folder_uuid [String]
|
|
1626
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1627
|
+
# @param [Hash] opts the optional parameters
|
|
1628
|
+
# @return [SfvbCommsFolderResponse]
|
|
1629
|
+
def delete_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, opts = {})
|
|
1630
|
+
data, _status_code, _headers = delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts)
|
|
1631
|
+
data
|
|
1632
|
+
end
|
|
1633
|
+
|
|
1634
|
+
# Delete a list and segment folder
|
|
1635
|
+
# Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be deleted here.
|
|
1636
|
+
# @param storefront_oid [Integer]
|
|
1637
|
+
# @param folder_uuid [String]
|
|
1638
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1639
|
+
# @param [Hash] opts the optional parameters
|
|
1640
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
1641
|
+
def delete_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, opts = {})
|
|
1642
|
+
if @api_client.config.debugging
|
|
1643
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_folder ...'
|
|
1644
|
+
end
|
|
1645
|
+
# verify the required parameter 'storefront_oid' is set
|
|
1646
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
1647
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_comms_folder"
|
|
1648
|
+
end
|
|
1649
|
+
# verify the required parameter 'folder_uuid' is set
|
|
1650
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
1651
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.delete_sfvb_comms_folder"
|
|
1652
|
+
end
|
|
1653
|
+
# verify the required parameter 'if_match' is set
|
|
1654
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
1655
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.delete_sfvb_comms_folder"
|
|
1656
|
+
end
|
|
1657
|
+
# resource path
|
|
1658
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
|
|
1659
|
+
|
|
1660
|
+
# query parameters
|
|
1661
|
+
query_params = opts[:query_params] || {}
|
|
1662
|
+
|
|
1663
|
+
# header parameters
|
|
1664
|
+
header_params = opts[:header_params] || {}
|
|
1665
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1666
|
+
# HTTP header 'Accept' (if needed)
|
|
1667
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1668
|
+
header_params[:'If-Match'] = if_match
|
|
1669
|
+
|
|
1670
|
+
# form parameters
|
|
1671
|
+
form_params = opts[:form_params] || {}
|
|
1672
|
+
|
|
1673
|
+
# http body (model)
|
|
1674
|
+
post_body = opts[:debug_body]
|
|
1675
|
+
|
|
1676
|
+
# return_type
|
|
1677
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
1678
|
+
|
|
1679
|
+
# auth_names
|
|
1680
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1681
|
+
|
|
1682
|
+
new_options = opts.merge(
|
|
1683
|
+
:operation => :"SfvbApi.delete_sfvb_comms_folder",
|
|
1684
|
+
:header_params => header_params,
|
|
1685
|
+
:query_params => query_params,
|
|
1686
|
+
:form_params => form_params,
|
|
1687
|
+
:body => post_body,
|
|
1688
|
+
:auth_names => auth_names,
|
|
1689
|
+
:return_type => return_type
|
|
1690
|
+
)
|
|
1691
|
+
|
|
1692
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1693
|
+
if @api_client.config.debugging
|
|
1694
|
+
@api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1695
|
+
end
|
|
1696
|
+
return data, status_code, headers
|
|
1697
|
+
end
|
|
1698
|
+
|
|
1468
1699
|
# Remove a sending domain
|
|
1469
1700
|
# Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
1470
1701
|
# @param domain [String]
|
|
@@ -4603,26 +4834,235 @@ module UltracartClient
|
|
|
4603
4834
|
# Element types used by a container
|
|
4604
4835
|
# @param compile_request [SfvbCompileRequest] CJSON to inspect
|
|
4605
4836
|
# @param [Hash] opts the optional parameters
|
|
4606
|
-
# @return [SfvbElementsResponse]
|
|
4607
|
-
def get_sfvb_cjson_used_elements(compile_request, opts = {})
|
|
4608
|
-
data, _status_code, _headers = get_sfvb_cjson_used_elements_with_http_info(compile_request, opts)
|
|
4837
|
+
# @return [SfvbElementsResponse]
|
|
4838
|
+
def get_sfvb_cjson_used_elements(compile_request, opts = {})
|
|
4839
|
+
data, _status_code, _headers = get_sfvb_cjson_used_elements_with_http_info(compile_request, opts)
|
|
4840
|
+
data
|
|
4841
|
+
end
|
|
4842
|
+
|
|
4843
|
+
# Element types used by a container
|
|
4844
|
+
# @param compile_request [SfvbCompileRequest] CJSON to inspect
|
|
4845
|
+
# @param [Hash] opts the optional parameters
|
|
4846
|
+
# @return [Array<(SfvbElementsResponse, Integer, Hash)>] SfvbElementsResponse data, response status code and response headers
|
|
4847
|
+
def get_sfvb_cjson_used_elements_with_http_info(compile_request, opts = {})
|
|
4848
|
+
if @api_client.config.debugging
|
|
4849
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_cjson_used_elements ...'
|
|
4850
|
+
end
|
|
4851
|
+
# verify the required parameter 'compile_request' is set
|
|
4852
|
+
if @api_client.config.client_side_validation && compile_request.nil?
|
|
4853
|
+
fail ArgumentError, "Missing the required parameter 'compile_request' when calling SfvbApi.get_sfvb_cjson_used_elements"
|
|
4854
|
+
end
|
|
4855
|
+
# resource path
|
|
4856
|
+
local_var_path = '/sfvb/cjson/elements'
|
|
4857
|
+
|
|
4858
|
+
# query parameters
|
|
4859
|
+
query_params = opts[:query_params] || {}
|
|
4860
|
+
|
|
4861
|
+
# header parameters
|
|
4862
|
+
header_params = opts[:header_params] || {}
|
|
4863
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4864
|
+
# HTTP header 'Accept' (if needed)
|
|
4865
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4866
|
+
# HTTP header 'Content-Type'
|
|
4867
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4868
|
+
if !content_type.nil?
|
|
4869
|
+
header_params['Content-Type'] = content_type
|
|
4870
|
+
end
|
|
4871
|
+
|
|
4872
|
+
# form parameters
|
|
4873
|
+
form_params = opts[:form_params] || {}
|
|
4874
|
+
|
|
4875
|
+
# http body (model)
|
|
4876
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(compile_request)
|
|
4877
|
+
|
|
4878
|
+
# return_type
|
|
4879
|
+
return_type = opts[:debug_return_type] || 'SfvbElementsResponse'
|
|
4880
|
+
|
|
4881
|
+
# auth_names
|
|
4882
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4883
|
+
|
|
4884
|
+
new_options = opts.merge(
|
|
4885
|
+
:operation => :"SfvbApi.get_sfvb_cjson_used_elements",
|
|
4886
|
+
:header_params => header_params,
|
|
4887
|
+
:query_params => query_params,
|
|
4888
|
+
:form_params => form_params,
|
|
4889
|
+
:body => post_body,
|
|
4890
|
+
:auth_names => auth_names,
|
|
4891
|
+
:return_type => return_type
|
|
4892
|
+
)
|
|
4893
|
+
|
|
4894
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4895
|
+
if @api_client.config.debugging
|
|
4896
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_cjson_used_elements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4897
|
+
end
|
|
4898
|
+
return data, status_code, headers
|
|
4899
|
+
end
|
|
4900
|
+
|
|
4901
|
+
# Read one list and segment folder
|
|
4902
|
+
# The folder, with the name and uuid of each list and segment filed in it.
|
|
4903
|
+
# @param storefront_oid [Integer]
|
|
4904
|
+
# @param folder_uuid [String]
|
|
4905
|
+
# @param [Hash] opts the optional parameters
|
|
4906
|
+
# @return [SfvbCommsFolderResponse]
|
|
4907
|
+
def get_sfvb_comms_folder(storefront_oid, folder_uuid, opts = {})
|
|
4908
|
+
data, _status_code, _headers = get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts)
|
|
4909
|
+
data
|
|
4910
|
+
end
|
|
4911
|
+
|
|
4912
|
+
# Read one list and segment folder
|
|
4913
|
+
# The folder, with the name and uuid of each list and segment filed in it.
|
|
4914
|
+
# @param storefront_oid [Integer]
|
|
4915
|
+
# @param folder_uuid [String]
|
|
4916
|
+
# @param [Hash] opts the optional parameters
|
|
4917
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
4918
|
+
def get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
|
|
4919
|
+
if @api_client.config.debugging
|
|
4920
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folder ...'
|
|
4921
|
+
end
|
|
4922
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4923
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4924
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folder"
|
|
4925
|
+
end
|
|
4926
|
+
# verify the required parameter 'folder_uuid' is set
|
|
4927
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
4928
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_folder"
|
|
4929
|
+
end
|
|
4930
|
+
# resource path
|
|
4931
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
|
|
4932
|
+
|
|
4933
|
+
# query parameters
|
|
4934
|
+
query_params = opts[:query_params] || {}
|
|
4935
|
+
|
|
4936
|
+
# header parameters
|
|
4937
|
+
header_params = opts[:header_params] || {}
|
|
4938
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4939
|
+
# HTTP header 'Accept' (if needed)
|
|
4940
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4941
|
+
|
|
4942
|
+
# form parameters
|
|
4943
|
+
form_params = opts[:form_params] || {}
|
|
4944
|
+
|
|
4945
|
+
# http body (model)
|
|
4946
|
+
post_body = opts[:debug_body]
|
|
4947
|
+
|
|
4948
|
+
# return_type
|
|
4949
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
4950
|
+
|
|
4951
|
+
# auth_names
|
|
4952
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4953
|
+
|
|
4954
|
+
new_options = opts.merge(
|
|
4955
|
+
:operation => :"SfvbApi.get_sfvb_comms_folder",
|
|
4956
|
+
:header_params => header_params,
|
|
4957
|
+
:query_params => query_params,
|
|
4958
|
+
:form_params => form_params,
|
|
4959
|
+
:body => post_body,
|
|
4960
|
+
:auth_names => auth_names,
|
|
4961
|
+
:return_type => return_type
|
|
4962
|
+
)
|
|
4963
|
+
|
|
4964
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4965
|
+
if @api_client.config.debugging
|
|
4966
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4967
|
+
end
|
|
4968
|
+
return data, status_code, headers
|
|
4969
|
+
end
|
|
4970
|
+
|
|
4971
|
+
# List the list and segment folders
|
|
4972
|
+
# Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
4973
|
+
# @param storefront_oid [Integer]
|
|
4974
|
+
# @param [Hash] opts the optional parameters
|
|
4975
|
+
# @return [SfvbCommsFoldersResponse]
|
|
4976
|
+
def get_sfvb_comms_folders(storefront_oid, opts = {})
|
|
4977
|
+
data, _status_code, _headers = get_sfvb_comms_folders_with_http_info(storefront_oid, opts)
|
|
4978
|
+
data
|
|
4979
|
+
end
|
|
4980
|
+
|
|
4981
|
+
# List the list and segment folders
|
|
4982
|
+
# Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
4983
|
+
# @param storefront_oid [Integer]
|
|
4984
|
+
# @param [Hash] opts the optional parameters
|
|
4985
|
+
# @return [Array<(SfvbCommsFoldersResponse, Integer, Hash)>] SfvbCommsFoldersResponse data, response status code and response headers
|
|
4986
|
+
def get_sfvb_comms_folders_with_http_info(storefront_oid, opts = {})
|
|
4987
|
+
if @api_client.config.debugging
|
|
4988
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folders ...'
|
|
4989
|
+
end
|
|
4990
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4991
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4992
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folders"
|
|
4993
|
+
end
|
|
4994
|
+
# resource path
|
|
4995
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4996
|
+
|
|
4997
|
+
# query parameters
|
|
4998
|
+
query_params = opts[:query_params] || {}
|
|
4999
|
+
|
|
5000
|
+
# header parameters
|
|
5001
|
+
header_params = opts[:header_params] || {}
|
|
5002
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5003
|
+
# HTTP header 'Accept' (if needed)
|
|
5004
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5005
|
+
|
|
5006
|
+
# form parameters
|
|
5007
|
+
form_params = opts[:form_params] || {}
|
|
5008
|
+
|
|
5009
|
+
# http body (model)
|
|
5010
|
+
post_body = opts[:debug_body]
|
|
5011
|
+
|
|
5012
|
+
# return_type
|
|
5013
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
|
|
5014
|
+
|
|
5015
|
+
# auth_names
|
|
5016
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5017
|
+
|
|
5018
|
+
new_options = opts.merge(
|
|
5019
|
+
:operation => :"SfvbApi.get_sfvb_comms_folders",
|
|
5020
|
+
:header_params => header_params,
|
|
5021
|
+
:query_params => query_params,
|
|
5022
|
+
:form_params => form_params,
|
|
5023
|
+
:body => post_body,
|
|
5024
|
+
:auth_names => auth_names,
|
|
5025
|
+
:return_type => return_type
|
|
5026
|
+
)
|
|
5027
|
+
|
|
5028
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5029
|
+
if @api_client.config.debugging
|
|
5030
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5031
|
+
end
|
|
5032
|
+
return data, status_code, headers
|
|
5033
|
+
end
|
|
5034
|
+
|
|
5035
|
+
# Read one email list
|
|
5036
|
+
# The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
5037
|
+
# @param storefront_oid [Integer]
|
|
5038
|
+
# @param list_uuid [String]
|
|
5039
|
+
# @param [Hash] opts the optional parameters
|
|
5040
|
+
# @return [SfvbCommsListResponse]
|
|
5041
|
+
def get_sfvb_comms_list(storefront_oid, list_uuid, opts = {})
|
|
5042
|
+
data, _status_code, _headers = get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts)
|
|
4609
5043
|
data
|
|
4610
5044
|
end
|
|
4611
5045
|
|
|
4612
|
-
#
|
|
4613
|
-
#
|
|
5046
|
+
# Read one email list
|
|
5047
|
+
# The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
5048
|
+
# @param storefront_oid [Integer]
|
|
5049
|
+
# @param list_uuid [String]
|
|
4614
5050
|
# @param [Hash] opts the optional parameters
|
|
4615
|
-
# @return [Array<(
|
|
4616
|
-
def
|
|
5051
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
5052
|
+
def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
|
|
4617
5053
|
if @api_client.config.debugging
|
|
4618
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
5054
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
|
|
4619
5055
|
end
|
|
4620
|
-
# verify the required parameter '
|
|
4621
|
-
if @api_client.config.client_side_validation &&
|
|
4622
|
-
fail ArgumentError, "Missing the required parameter '
|
|
5056
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5057
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5058
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list"
|
|
5059
|
+
end
|
|
5060
|
+
# verify the required parameter 'list_uuid' is set
|
|
5061
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
5062
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list"
|
|
4623
5063
|
end
|
|
4624
5064
|
# resource path
|
|
4625
|
-
local_var_path = '/sfvb/
|
|
5065
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
4626
5066
|
|
|
4627
5067
|
# query parameters
|
|
4628
5068
|
query_params = opts[:query_params] || {}
|
|
@@ -4632,26 +5072,21 @@ module UltracartClient
|
|
|
4632
5072
|
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4633
5073
|
# HTTP header 'Accept' (if needed)
|
|
4634
5074
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4635
|
-
# HTTP header 'Content-Type'
|
|
4636
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4637
|
-
if !content_type.nil?
|
|
4638
|
-
header_params['Content-Type'] = content_type
|
|
4639
|
-
end
|
|
4640
5075
|
|
|
4641
5076
|
# form parameters
|
|
4642
5077
|
form_params = opts[:form_params] || {}
|
|
4643
5078
|
|
|
4644
5079
|
# http body (model)
|
|
4645
|
-
post_body = opts[:debug_body]
|
|
5080
|
+
post_body = opts[:debug_body]
|
|
4646
5081
|
|
|
4647
5082
|
# return_type
|
|
4648
|
-
return_type = opts[:debug_return_type] || '
|
|
5083
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
4649
5084
|
|
|
4650
5085
|
# auth_names
|
|
4651
5086
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4652
5087
|
|
|
4653
5088
|
new_options = opts.merge(
|
|
4654
|
-
:operation => :"SfvbApi.
|
|
5089
|
+
:operation => :"SfvbApi.get_sfvb_comms_list",
|
|
4655
5090
|
:header_params => header_params,
|
|
4656
5091
|
:query_params => query_params,
|
|
4657
5092
|
:form_params => form_params,
|
|
@@ -4660,9 +5095,9 @@ module UltracartClient
|
|
|
4660
5095
|
:return_type => return_type
|
|
4661
5096
|
)
|
|
4662
5097
|
|
|
4663
|
-
data, status_code, headers = @api_client.call_api(:
|
|
5098
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4664
5099
|
if @api_client.config.debugging
|
|
4665
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
5100
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4666
5101
|
end
|
|
4667
5102
|
return data, status_code, headers
|
|
4668
5103
|
end
|
|
@@ -9780,6 +10215,156 @@ module UltracartClient
|
|
|
9780
10215
|
return data, status_code, headers
|
|
9781
10216
|
end
|
|
9782
10217
|
|
|
10218
|
+
# Create a list and segment folder
|
|
10219
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10220
|
+
# @param storefront_oid [Integer]
|
|
10221
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
10222
|
+
# @param [Hash] opts the optional parameters
|
|
10223
|
+
# @return [SfvbCommsFolderResponse]
|
|
10224
|
+
def insert_sfvb_comms_folder(storefront_oid, folder_write_request, opts = {})
|
|
10225
|
+
data, _status_code, _headers = insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts)
|
|
10226
|
+
data
|
|
10227
|
+
end
|
|
10228
|
+
|
|
10229
|
+
# Create a list and segment folder
|
|
10230
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10231
|
+
# @param storefront_oid [Integer]
|
|
10232
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
10233
|
+
# @param [Hash] opts the optional parameters
|
|
10234
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
10235
|
+
def insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts = {})
|
|
10236
|
+
if @api_client.config.debugging
|
|
10237
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_folder ...'
|
|
10238
|
+
end
|
|
10239
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10240
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10241
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
10242
|
+
end
|
|
10243
|
+
# verify the required parameter 'folder_write_request' is set
|
|
10244
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
10245
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
10246
|
+
end
|
|
10247
|
+
# resource path
|
|
10248
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
10249
|
+
|
|
10250
|
+
# query parameters
|
|
10251
|
+
query_params = opts[:query_params] || {}
|
|
10252
|
+
|
|
10253
|
+
# header parameters
|
|
10254
|
+
header_params = opts[:header_params] || {}
|
|
10255
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10256
|
+
# HTTP header 'Accept' (if needed)
|
|
10257
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10258
|
+
# HTTP header 'Content-Type'
|
|
10259
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
10260
|
+
if !content_type.nil?
|
|
10261
|
+
header_params['Content-Type'] = content_type
|
|
10262
|
+
end
|
|
10263
|
+
|
|
10264
|
+
# form parameters
|
|
10265
|
+
form_params = opts[:form_params] || {}
|
|
10266
|
+
|
|
10267
|
+
# http body (model)
|
|
10268
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
10269
|
+
|
|
10270
|
+
# return_type
|
|
10271
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
10272
|
+
|
|
10273
|
+
# auth_names
|
|
10274
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10275
|
+
|
|
10276
|
+
new_options = opts.merge(
|
|
10277
|
+
:operation => :"SfvbApi.insert_sfvb_comms_folder",
|
|
10278
|
+
:header_params => header_params,
|
|
10279
|
+
:query_params => query_params,
|
|
10280
|
+
:form_params => form_params,
|
|
10281
|
+
:body => post_body,
|
|
10282
|
+
:auth_names => auth_names,
|
|
10283
|
+
:return_type => return_type
|
|
10284
|
+
)
|
|
10285
|
+
|
|
10286
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10287
|
+
if @api_client.config.debugging
|
|
10288
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10289
|
+
end
|
|
10290
|
+
return data, status_code, headers
|
|
10291
|
+
end
|
|
10292
|
+
|
|
10293
|
+
# Create an email list
|
|
10294
|
+
# A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
10295
|
+
# @param storefront_oid [Integer]
|
|
10296
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
10297
|
+
# @param [Hash] opts the optional parameters
|
|
10298
|
+
# @return [SfvbCommsListResponse]
|
|
10299
|
+
def insert_sfvb_comms_list(storefront_oid, list_write_request, opts = {})
|
|
10300
|
+
data, _status_code, _headers = insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts)
|
|
10301
|
+
data
|
|
10302
|
+
end
|
|
10303
|
+
|
|
10304
|
+
# Create an email list
|
|
10305
|
+
# A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
10306
|
+
# @param storefront_oid [Integer]
|
|
10307
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
10308
|
+
# @param [Hash] opts the optional parameters
|
|
10309
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
10310
|
+
def insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts = {})
|
|
10311
|
+
if @api_client.config.debugging
|
|
10312
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_list ...'
|
|
10313
|
+
end
|
|
10314
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10315
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10316
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_list"
|
|
10317
|
+
end
|
|
10318
|
+
# verify the required parameter 'list_write_request' is set
|
|
10319
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
10320
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.insert_sfvb_comms_list"
|
|
10321
|
+
end
|
|
10322
|
+
# resource path
|
|
10323
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
10324
|
+
|
|
10325
|
+
# query parameters
|
|
10326
|
+
query_params = opts[:query_params] || {}
|
|
10327
|
+
|
|
10328
|
+
# header parameters
|
|
10329
|
+
header_params = opts[:header_params] || {}
|
|
10330
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10331
|
+
# HTTP header 'Accept' (if needed)
|
|
10332
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10333
|
+
# HTTP header 'Content-Type'
|
|
10334
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
10335
|
+
if !content_type.nil?
|
|
10336
|
+
header_params['Content-Type'] = content_type
|
|
10337
|
+
end
|
|
10338
|
+
|
|
10339
|
+
# form parameters
|
|
10340
|
+
form_params = opts[:form_params] || {}
|
|
10341
|
+
|
|
10342
|
+
# http body (model)
|
|
10343
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
10344
|
+
|
|
10345
|
+
# return_type
|
|
10346
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
10347
|
+
|
|
10348
|
+
# auth_names
|
|
10349
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10350
|
+
|
|
10351
|
+
new_options = opts.merge(
|
|
10352
|
+
:operation => :"SfvbApi.insert_sfvb_comms_list",
|
|
10353
|
+
:header_params => header_params,
|
|
10354
|
+
:query_params => query_params,
|
|
10355
|
+
:form_params => form_params,
|
|
10356
|
+
:body => post_body,
|
|
10357
|
+
:auth_names => auth_names,
|
|
10358
|
+
:return_type => return_type
|
|
10359
|
+
)
|
|
10360
|
+
|
|
10361
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10362
|
+
if @api_client.config.debugging
|
|
10363
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10364
|
+
end
|
|
10365
|
+
return data, status_code, headers
|
|
10366
|
+
end
|
|
10367
|
+
|
|
9783
10368
|
# Create a segment
|
|
9784
10369
|
# A new segment with the name, rule and folder given. The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront. The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
|
|
9785
10370
|
# @param storefront_oid [Integer]
|
|
@@ -16457,6 +17042,182 @@ module UltracartClient
|
|
|
16457
17042
|
return data, status_code, headers
|
|
16458
17043
|
end
|
|
16459
17044
|
|
|
17045
|
+
# Rename a list and segment folder
|
|
17046
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17047
|
+
# @param storefront_oid [Integer]
|
|
17048
|
+
# @param folder_uuid [String]
|
|
17049
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17050
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17051
|
+
# @param [Hash] opts the optional parameters
|
|
17052
|
+
# @return [SfvbCommsFolderResponse]
|
|
17053
|
+
def update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17054
|
+
data, _status_code, _headers = update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts)
|
|
17055
|
+
data
|
|
17056
|
+
end
|
|
17057
|
+
|
|
17058
|
+
# Rename a list and segment folder
|
|
17059
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17060
|
+
# @param storefront_oid [Integer]
|
|
17061
|
+
# @param folder_uuid [String]
|
|
17062
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17063
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17064
|
+
# @param [Hash] opts the optional parameters
|
|
17065
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
17066
|
+
def update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17067
|
+
if @api_client.config.debugging
|
|
17068
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_folder ...'
|
|
17069
|
+
end
|
|
17070
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17071
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17072
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17073
|
+
end
|
|
17074
|
+
# verify the required parameter 'folder_uuid' is set
|
|
17075
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
17076
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17077
|
+
end
|
|
17078
|
+
# verify the required parameter 'if_match' is set
|
|
17079
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17080
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17081
|
+
end
|
|
17082
|
+
# verify the required parameter 'folder_write_request' is set
|
|
17083
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
17084
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17085
|
+
end
|
|
17086
|
+
# resource path
|
|
17087
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
|
|
17088
|
+
|
|
17089
|
+
# query parameters
|
|
17090
|
+
query_params = opts[:query_params] || {}
|
|
17091
|
+
|
|
17092
|
+
# header parameters
|
|
17093
|
+
header_params = opts[:header_params] || {}
|
|
17094
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17095
|
+
# HTTP header 'Accept' (if needed)
|
|
17096
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17097
|
+
# HTTP header 'Content-Type'
|
|
17098
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17099
|
+
if !content_type.nil?
|
|
17100
|
+
header_params['Content-Type'] = content_type
|
|
17101
|
+
end
|
|
17102
|
+
header_params[:'If-Match'] = if_match
|
|
17103
|
+
|
|
17104
|
+
# form parameters
|
|
17105
|
+
form_params = opts[:form_params] || {}
|
|
17106
|
+
|
|
17107
|
+
# http body (model)
|
|
17108
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
17109
|
+
|
|
17110
|
+
# return_type
|
|
17111
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
17112
|
+
|
|
17113
|
+
# auth_names
|
|
17114
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17115
|
+
|
|
17116
|
+
new_options = opts.merge(
|
|
17117
|
+
:operation => :"SfvbApi.update_sfvb_comms_folder",
|
|
17118
|
+
:header_params => header_params,
|
|
17119
|
+
:query_params => query_params,
|
|
17120
|
+
:form_params => form_params,
|
|
17121
|
+
:body => post_body,
|
|
17122
|
+
:auth_names => auth_names,
|
|
17123
|
+
:return_type => return_type
|
|
17124
|
+
)
|
|
17125
|
+
|
|
17126
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17127
|
+
if @api_client.config.debugging
|
|
17128
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17129
|
+
end
|
|
17130
|
+
return data, status_code, headers
|
|
17131
|
+
end
|
|
17132
|
+
|
|
17133
|
+
# Change an email list's name, folder or public settings
|
|
17134
|
+
# A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list's hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
17135
|
+
# @param storefront_oid [Integer]
|
|
17136
|
+
# @param list_uuid [String]
|
|
17137
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17138
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17139
|
+
# @param [Hash] opts the optional parameters
|
|
17140
|
+
# @return [SfvbCommsListResponse]
|
|
17141
|
+
def update_sfvb_comms_list(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17142
|
+
data, _status_code, _headers = update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts)
|
|
17143
|
+
data
|
|
17144
|
+
end
|
|
17145
|
+
|
|
17146
|
+
# Change an email list's name, folder or public settings
|
|
17147
|
+
# A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list's hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
17148
|
+
# @param storefront_oid [Integer]
|
|
17149
|
+
# @param list_uuid [String]
|
|
17150
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17151
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17152
|
+
# @param [Hash] opts the optional parameters
|
|
17153
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
17154
|
+
def update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17155
|
+
if @api_client.config.debugging
|
|
17156
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_list ...'
|
|
17157
|
+
end
|
|
17158
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17159
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17160
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17161
|
+
end
|
|
17162
|
+
# verify the required parameter 'list_uuid' is set
|
|
17163
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
17164
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17165
|
+
end
|
|
17166
|
+
# verify the required parameter 'if_match' is set
|
|
17167
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17168
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_list"
|
|
17169
|
+
end
|
|
17170
|
+
# verify the required parameter 'list_write_request' is set
|
|
17171
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
17172
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.update_sfvb_comms_list"
|
|
17173
|
+
end
|
|
17174
|
+
# resource path
|
|
17175
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
17176
|
+
|
|
17177
|
+
# query parameters
|
|
17178
|
+
query_params = opts[:query_params] || {}
|
|
17179
|
+
|
|
17180
|
+
# header parameters
|
|
17181
|
+
header_params = opts[:header_params] || {}
|
|
17182
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17183
|
+
# HTTP header 'Accept' (if needed)
|
|
17184
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17185
|
+
# HTTP header 'Content-Type'
|
|
17186
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17187
|
+
if !content_type.nil?
|
|
17188
|
+
header_params['Content-Type'] = content_type
|
|
17189
|
+
end
|
|
17190
|
+
header_params[:'If-Match'] = if_match
|
|
17191
|
+
|
|
17192
|
+
# form parameters
|
|
17193
|
+
form_params = opts[:form_params] || {}
|
|
17194
|
+
|
|
17195
|
+
# http body (model)
|
|
17196
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
17197
|
+
|
|
17198
|
+
# return_type
|
|
17199
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
17200
|
+
|
|
17201
|
+
# auth_names
|
|
17202
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17203
|
+
|
|
17204
|
+
new_options = opts.merge(
|
|
17205
|
+
:operation => :"SfvbApi.update_sfvb_comms_list",
|
|
17206
|
+
:header_params => header_params,
|
|
17207
|
+
:query_params => query_params,
|
|
17208
|
+
:form_params => form_params,
|
|
17209
|
+
:body => post_body,
|
|
17210
|
+
:auth_names => auth_names,
|
|
17211
|
+
:return_type => return_type
|
|
17212
|
+
)
|
|
17213
|
+
|
|
17214
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17215
|
+
if @api_client.config.debugging
|
|
17216
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17217
|
+
end
|
|
17218
|
+
return data, status_code, headers
|
|
17219
|
+
end
|
|
17220
|
+
|
|
16460
17221
|
# Change a segment's name, rule or folder
|
|
16461
17222
|
# A field left out stays as it is. Send the segment's hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read. A changed rule is checked as on a create and starts a rebuild. Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
|
|
16462
17223
|
# @param storefront_oid [Integer]
|
|
@@ -16781,7 +17542,7 @@ module UltracartClient
|
|
|
16781
17542
|
end
|
|
16782
17543
|
|
|
16783
17544
|
# Change a flow
|
|
16784
|
-
# A field left out keeps its value. The trigger and the status
|
|
17545
|
+
# A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
16785
17546
|
# @param storefront_oid [Integer]
|
|
16786
17547
|
# @param flow_uuid [String]
|
|
16787
17548
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
@@ -16794,7 +17555,7 @@ module UltracartClient
|
|
|
16794
17555
|
end
|
|
16795
17556
|
|
|
16796
17557
|
# Change a flow
|
|
16797
|
-
# A field left out keeps its value. The trigger and the status
|
|
17558
|
+
# A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
16798
17559
|
# @param storefront_oid [Integer]
|
|
16799
17560
|
# @param flow_uuid [String]
|
|
16800
17561
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|