ultracart_api 4.1.229 → 4.1.231
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 +38 -2
- data/docs/ItemAutoOrder.md +6 -0
- data/docs/SfvbApi.md +846 -3
- data/docs/SfvbApprovalCreateRequest.md +3 -1
- data/docs/SfvbCampaign.md +2 -0
- 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/SfvbCommsMember.md +22 -0
- data/docs/SfvbCommsMembersResponse.md +36 -0
- data/docs/SfvbFlow.md +2 -0
- data/docs/SfvbFlowWriteRequest.md +2 -2
- data/docs/SfvbPostcardAddress.md +28 -0
- data/docs/SfvbPostcardCard.md +40 -0
- data/docs/SfvbPostcardTrackingResponse.md +34 -0
- data/docs/SfvbSequenceStep.md +1 -1
- data/docs/SfvbStepCounts.md +1 -1
- data/docs/SfvbTransactionalChange.md +24 -0
- data/docs/SfvbTransactionalDeliveryOption.md +22 -0
- data/docs/SfvbTransactionalEmailDetail.md +30 -0
- data/docs/SfvbTransactionalEmailResponse.md +24 -0
- data/docs/SfvbTransactionalEmailUpdateRequest.md +28 -0
- data/docs/SfvbTransactionalSender.md +24 -0
- data/lib/ultracart_api/api/sfvb_api.rb +1220 -61
- data/lib/ultracart_api/models/item_auto_order.rb +35 -1
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +15 -6
- data/lib/ultracart_api/models/sfvb_campaign.rb +11 -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_comms_member.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_members_response.rb +314 -0
- data/lib/ultracart_api/models/sfvb_flow.rb +11 -1
- data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
- data/lib/ultracart_api/models/sfvb_postcard_address.rb +270 -0
- data/lib/ultracart_api/models/sfvb_postcard_card.rb +328 -0
- data/lib/ultracart_api/models/sfvb_postcard_tracking_response.rb +304 -0
- 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/models/sfvb_transactional_change.rb +250 -0
- data/lib/ultracart_api/models/sfvb_transactional_delivery_option.rb +240 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_detail.rb +283 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_response.rb +253 -0
- data/lib/ultracart_api/models/sfvb_transactional_email_update_request.rb +272 -0
- data/lib/ultracart_api/models/sfvb_transactional_sender.rb +250 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +19 -0
- metadata +40 -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]
|
|
@@ -4667,6 +4898,289 @@ module UltracartClient
|
|
|
4667
4898
|
return data, status_code, headers
|
|
4668
4899
|
end
|
|
4669
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)
|
|
5043
|
+
data
|
|
5044
|
+
end
|
|
5045
|
+
|
|
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]
|
|
5050
|
+
# @param [Hash] opts the optional parameters
|
|
5051
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
5052
|
+
def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
|
|
5053
|
+
if @api_client.config.debugging
|
|
5054
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
|
|
5055
|
+
end
|
|
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"
|
|
5063
|
+
end
|
|
5064
|
+
# resource path
|
|
5065
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
5066
|
+
|
|
5067
|
+
# query parameters
|
|
5068
|
+
query_params = opts[:query_params] || {}
|
|
5069
|
+
|
|
5070
|
+
# header parameters
|
|
5071
|
+
header_params = opts[:header_params] || {}
|
|
5072
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5073
|
+
# HTTP header 'Accept' (if needed)
|
|
5074
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5075
|
+
|
|
5076
|
+
# form parameters
|
|
5077
|
+
form_params = opts[:form_params] || {}
|
|
5078
|
+
|
|
5079
|
+
# http body (model)
|
|
5080
|
+
post_body = opts[:debug_body]
|
|
5081
|
+
|
|
5082
|
+
# return_type
|
|
5083
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
5084
|
+
|
|
5085
|
+
# auth_names
|
|
5086
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5087
|
+
|
|
5088
|
+
new_options = opts.merge(
|
|
5089
|
+
:operation => :"SfvbApi.get_sfvb_comms_list",
|
|
5090
|
+
:header_params => header_params,
|
|
5091
|
+
:query_params => query_params,
|
|
5092
|
+
:form_params => form_params,
|
|
5093
|
+
:body => post_body,
|
|
5094
|
+
:auth_names => auth_names,
|
|
5095
|
+
:return_type => return_type
|
|
5096
|
+
)
|
|
5097
|
+
|
|
5098
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5099
|
+
if @api_client.config.debugging
|
|
5100
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5101
|
+
end
|
|
5102
|
+
return data, status_code, headers
|
|
5103
|
+
end
|
|
5104
|
+
|
|
5105
|
+
# Read one page of a list's members
|
|
5106
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5107
|
+
# @param storefront_oid [Integer]
|
|
5108
|
+
# @param list_uuid [String]
|
|
5109
|
+
# @param [Hash] opts the optional parameters
|
|
5110
|
+
# @option opts [Integer] :page The page, from 1
|
|
5111
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5112
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5113
|
+
# @return [SfvbCommsMembersResponse]
|
|
5114
|
+
def get_sfvb_comms_list_members(storefront_oid, list_uuid, opts = {})
|
|
5115
|
+
data, _status_code, _headers = get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts)
|
|
5116
|
+
data
|
|
5117
|
+
end
|
|
5118
|
+
|
|
5119
|
+
# Read one page of a list's members
|
|
5120
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5121
|
+
# @param storefront_oid [Integer]
|
|
5122
|
+
# @param list_uuid [String]
|
|
5123
|
+
# @param [Hash] opts the optional parameters
|
|
5124
|
+
# @option opts [Integer] :page The page, from 1
|
|
5125
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5126
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5127
|
+
# @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
|
|
5128
|
+
def get_sfvb_comms_list_members_with_http_info(storefront_oid, list_uuid, opts = {})
|
|
5129
|
+
if @api_client.config.debugging
|
|
5130
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list_members ...'
|
|
5131
|
+
end
|
|
5132
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5133
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5134
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list_members"
|
|
5135
|
+
end
|
|
5136
|
+
# verify the required parameter 'list_uuid' is set
|
|
5137
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
5138
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list_members"
|
|
5139
|
+
end
|
|
5140
|
+
# resource path
|
|
5141
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
5142
|
+
|
|
5143
|
+
# query parameters
|
|
5144
|
+
query_params = opts[:query_params] || {}
|
|
5145
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
5146
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
5147
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
5148
|
+
|
|
5149
|
+
# header parameters
|
|
5150
|
+
header_params = opts[:header_params] || {}
|
|
5151
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5152
|
+
# HTTP header 'Accept' (if needed)
|
|
5153
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5154
|
+
|
|
5155
|
+
# form parameters
|
|
5156
|
+
form_params = opts[:form_params] || {}
|
|
5157
|
+
|
|
5158
|
+
# http body (model)
|
|
5159
|
+
post_body = opts[:debug_body]
|
|
5160
|
+
|
|
5161
|
+
# return_type
|
|
5162
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
|
|
5163
|
+
|
|
5164
|
+
# auth_names
|
|
5165
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5166
|
+
|
|
5167
|
+
new_options = opts.merge(
|
|
5168
|
+
:operation => :"SfvbApi.get_sfvb_comms_list_members",
|
|
5169
|
+
:header_params => header_params,
|
|
5170
|
+
:query_params => query_params,
|
|
5171
|
+
:form_params => form_params,
|
|
5172
|
+
:body => post_body,
|
|
5173
|
+
:auth_names => auth_names,
|
|
5174
|
+
:return_type => return_type
|
|
5175
|
+
)
|
|
5176
|
+
|
|
5177
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5178
|
+
if @api_client.config.debugging
|
|
5179
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5180
|
+
end
|
|
5181
|
+
return data, status_code, headers
|
|
5182
|
+
end
|
|
5183
|
+
|
|
4670
5184
|
# Read one segment, with its rule
|
|
4671
5185
|
# The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
4672
5186
|
# @param storefront_oid [Integer]
|
|
@@ -4715,13 +5229,92 @@ module UltracartClient
|
|
|
4715
5229
|
post_body = opts[:debug_body]
|
|
4716
5230
|
|
|
4717
5231
|
# return_type
|
|
4718
|
-
return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
|
|
5232
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
|
|
5233
|
+
|
|
5234
|
+
# auth_names
|
|
5235
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5236
|
+
|
|
5237
|
+
new_options = opts.merge(
|
|
5238
|
+
:operation => :"SfvbApi.get_sfvb_comms_segment",
|
|
5239
|
+
:header_params => header_params,
|
|
5240
|
+
:query_params => query_params,
|
|
5241
|
+
:form_params => form_params,
|
|
5242
|
+
:body => post_body,
|
|
5243
|
+
:auth_names => auth_names,
|
|
5244
|
+
:return_type => return_type
|
|
5245
|
+
)
|
|
5246
|
+
|
|
5247
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5248
|
+
if @api_client.config.debugging
|
|
5249
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5250
|
+
end
|
|
5251
|
+
return data, status_code, headers
|
|
5252
|
+
end
|
|
5253
|
+
|
|
5254
|
+
# Read one page of a segment's members
|
|
5255
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5256
|
+
# @param storefront_oid [Integer]
|
|
5257
|
+
# @param segment_uuid [String]
|
|
5258
|
+
# @param [Hash] opts the optional parameters
|
|
5259
|
+
# @option opts [Integer] :page The page, from 1
|
|
5260
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5261
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5262
|
+
# @return [SfvbCommsMembersResponse]
|
|
5263
|
+
def get_sfvb_comms_segment_members(storefront_oid, segment_uuid, opts = {})
|
|
5264
|
+
data, _status_code, _headers = get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts)
|
|
5265
|
+
data
|
|
5266
|
+
end
|
|
5267
|
+
|
|
5268
|
+
# Read one page of a segment's members
|
|
5269
|
+
# Each member's customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person's address. Read only.
|
|
5270
|
+
# @param storefront_oid [Integer]
|
|
5271
|
+
# @param segment_uuid [String]
|
|
5272
|
+
# @param [Hash] opts the optional parameters
|
|
5273
|
+
# @option opts [Integer] :page The page, from 1
|
|
5274
|
+
# @option opts [Integer] :page_size Members per page, 1 to 100 (default 50)
|
|
5275
|
+
# @option opts [Boolean] :show_customer_data True to return the real email addresses instead of masked ones
|
|
5276
|
+
# @return [Array<(SfvbCommsMembersResponse, Integer, Hash)>] SfvbCommsMembersResponse data, response status code and response headers
|
|
5277
|
+
def get_sfvb_comms_segment_members_with_http_info(storefront_oid, segment_uuid, opts = {})
|
|
5278
|
+
if @api_client.config.debugging
|
|
5279
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment_members ...'
|
|
5280
|
+
end
|
|
5281
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5282
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5283
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment_members"
|
|
5284
|
+
end
|
|
5285
|
+
# verify the required parameter 'segment_uuid' is set
|
|
5286
|
+
if @api_client.config.client_side_validation && segment_uuid.nil?
|
|
5287
|
+
fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment_members"
|
|
5288
|
+
end
|
|
5289
|
+
# resource path
|
|
5290
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}/members'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
|
|
5291
|
+
|
|
5292
|
+
# query parameters
|
|
5293
|
+
query_params = opts[:query_params] || {}
|
|
5294
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
5295
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
5296
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
5297
|
+
|
|
5298
|
+
# header parameters
|
|
5299
|
+
header_params = opts[:header_params] || {}
|
|
5300
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5301
|
+
# HTTP header 'Accept' (if needed)
|
|
5302
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5303
|
+
|
|
5304
|
+
# form parameters
|
|
5305
|
+
form_params = opts[:form_params] || {}
|
|
5306
|
+
|
|
5307
|
+
# http body (model)
|
|
5308
|
+
post_body = opts[:debug_body]
|
|
5309
|
+
|
|
5310
|
+
# return_type
|
|
5311
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsMembersResponse'
|
|
4719
5312
|
|
|
4720
5313
|
# auth_names
|
|
4721
5314
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4722
5315
|
|
|
4723
5316
|
new_options = opts.merge(
|
|
4724
|
-
:operation => :"SfvbApi.
|
|
5317
|
+
:operation => :"SfvbApi.get_sfvb_comms_segment_members",
|
|
4725
5318
|
:header_params => header_params,
|
|
4726
5319
|
:query_params => query_params,
|
|
4727
5320
|
:form_params => form_params,
|
|
@@ -4732,7 +5325,7 @@ module UltracartClient
|
|
|
4732
5325
|
|
|
4733
5326
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4734
5327
|
if @api_client.config.debugging
|
|
4735
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
5328
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4736
5329
|
end
|
|
4737
5330
|
return data, status_code, headers
|
|
4738
5331
|
end
|
|
@@ -7220,6 +7813,85 @@ module UltracartClient
|
|
|
7220
7813
|
return data, status_code, headers
|
|
7221
7814
|
end
|
|
7222
7815
|
|
|
7816
|
+
# Read one page of the cards mailed for a postcard
|
|
7817
|
+
# Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
|
|
7818
|
+
# @param storefront_oid [Integer]
|
|
7819
|
+
# @param postcard_uuid [String]
|
|
7820
|
+
# @param [Hash] opts the optional parameters
|
|
7821
|
+
# @option opts [Integer] :page The page, from 1
|
|
7822
|
+
# @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
|
|
7823
|
+
# @option opts [Boolean] :show_customer_data True to return the recipients' real names and street addresses
|
|
7824
|
+
# @return [SfvbPostcardTrackingResponse]
|
|
7825
|
+
def get_sfvb_postcard_tracking(storefront_oid, postcard_uuid, opts = {})
|
|
7826
|
+
data, _status_code, _headers = get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts)
|
|
7827
|
+
data
|
|
7828
|
+
end
|
|
7829
|
+
|
|
7830
|
+
# Read one page of the cards mailed for a postcard
|
|
7831
|
+
# Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor's status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant's own. Read only.
|
|
7832
|
+
# @param storefront_oid [Integer]
|
|
7833
|
+
# @param postcard_uuid [String]
|
|
7834
|
+
# @param [Hash] opts the optional parameters
|
|
7835
|
+
# @option opts [Integer] :page The page, from 1
|
|
7836
|
+
# @option opts [Integer] :page_size Cards per page, 1 to 100 (default 50)
|
|
7837
|
+
# @option opts [Boolean] :show_customer_data True to return the recipients' real names and street addresses
|
|
7838
|
+
# @return [Array<(SfvbPostcardTrackingResponse, Integer, Hash)>] SfvbPostcardTrackingResponse data, response status code and response headers
|
|
7839
|
+
def get_sfvb_postcard_tracking_with_http_info(storefront_oid, postcard_uuid, opts = {})
|
|
7840
|
+
if @api_client.config.debugging
|
|
7841
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_postcard_tracking ...'
|
|
7842
|
+
end
|
|
7843
|
+
# verify the required parameter 'storefront_oid' is set
|
|
7844
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
7845
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_postcard_tracking"
|
|
7846
|
+
end
|
|
7847
|
+
# verify the required parameter 'postcard_uuid' is set
|
|
7848
|
+
if @api_client.config.client_side_validation && postcard_uuid.nil?
|
|
7849
|
+
fail ArgumentError, "Missing the required parameter 'postcard_uuid' when calling SfvbApi.get_sfvb_postcard_tracking"
|
|
7850
|
+
end
|
|
7851
|
+
# resource path
|
|
7852
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/postcards/{postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'postcard_uuid' + '}', CGI.escape(postcard_uuid.to_s))
|
|
7853
|
+
|
|
7854
|
+
# query parameters
|
|
7855
|
+
query_params = opts[:query_params] || {}
|
|
7856
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
7857
|
+
query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
|
7858
|
+
query_params[:'show_customer_data'] = opts[:'show_customer_data'] if !opts[:'show_customer_data'].nil?
|
|
7859
|
+
|
|
7860
|
+
# header parameters
|
|
7861
|
+
header_params = opts[:header_params] || {}
|
|
7862
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7863
|
+
# HTTP header 'Accept' (if needed)
|
|
7864
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7865
|
+
|
|
7866
|
+
# form parameters
|
|
7867
|
+
form_params = opts[:form_params] || {}
|
|
7868
|
+
|
|
7869
|
+
# http body (model)
|
|
7870
|
+
post_body = opts[:debug_body]
|
|
7871
|
+
|
|
7872
|
+
# return_type
|
|
7873
|
+
return_type = opts[:debug_return_type] || 'SfvbPostcardTrackingResponse'
|
|
7874
|
+
|
|
7875
|
+
# auth_names
|
|
7876
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7877
|
+
|
|
7878
|
+
new_options = opts.merge(
|
|
7879
|
+
:operation => :"SfvbApi.get_sfvb_postcard_tracking",
|
|
7880
|
+
:header_params => header_params,
|
|
7881
|
+
:query_params => query_params,
|
|
7882
|
+
:form_params => form_params,
|
|
7883
|
+
:body => post_body,
|
|
7884
|
+
:auth_names => auth_names,
|
|
7885
|
+
:return_type => return_type
|
|
7886
|
+
)
|
|
7887
|
+
|
|
7888
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
7889
|
+
if @api_client.config.debugging
|
|
7890
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7891
|
+
end
|
|
7892
|
+
return data, status_code, headers
|
|
7893
|
+
end
|
|
7894
|
+
|
|
7223
7895
|
# URL that renders a preview session
|
|
7224
7896
|
# Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
7225
7897
|
# @param storefront_oid [Integer]
|
|
@@ -8929,6 +9601,76 @@ module UltracartClient
|
|
|
8929
9601
|
return data, status_code, headers
|
|
8930
9602
|
end
|
|
8931
9603
|
|
|
9604
|
+
# Read a transactional email's subject, delivery options and sender
|
|
9605
|
+
# file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
9606
|
+
# @param storefront_oid [Integer]
|
|
9607
|
+
# @param file_name [String]
|
|
9608
|
+
# @param [Hash] opts the optional parameters
|
|
9609
|
+
# @return [SfvbTransactionalEmailResponse]
|
|
9610
|
+
def get_sfvb_transactional_email(storefront_oid, file_name, opts = {})
|
|
9611
|
+
data, _status_code, _headers = get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts)
|
|
9612
|
+
data
|
|
9613
|
+
end
|
|
9614
|
+
|
|
9615
|
+
# Read a transactional email's subject, delivery options and sender
|
|
9616
|
+
# file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant's own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
9617
|
+
# @param storefront_oid [Integer]
|
|
9618
|
+
# @param file_name [String]
|
|
9619
|
+
# @param [Hash] opts the optional parameters
|
|
9620
|
+
# @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
|
|
9621
|
+
def get_sfvb_transactional_email_with_http_info(storefront_oid, file_name, opts = {})
|
|
9622
|
+
if @api_client.config.debugging
|
|
9623
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_transactional_email ...'
|
|
9624
|
+
end
|
|
9625
|
+
# verify the required parameter 'storefront_oid' is set
|
|
9626
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9627
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_transactional_email"
|
|
9628
|
+
end
|
|
9629
|
+
# verify the required parameter 'file_name' is set
|
|
9630
|
+
if @api_client.config.client_side_validation && file_name.nil?
|
|
9631
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.get_sfvb_transactional_email"
|
|
9632
|
+
end
|
|
9633
|
+
# resource path
|
|
9634
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
|
|
9635
|
+
|
|
9636
|
+
# query parameters
|
|
9637
|
+
query_params = opts[:query_params] || {}
|
|
9638
|
+
|
|
9639
|
+
# header parameters
|
|
9640
|
+
header_params = opts[:header_params] || {}
|
|
9641
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
9642
|
+
# HTTP header 'Accept' (if needed)
|
|
9643
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9644
|
+
|
|
9645
|
+
# form parameters
|
|
9646
|
+
form_params = opts[:form_params] || {}
|
|
9647
|
+
|
|
9648
|
+
# http body (model)
|
|
9649
|
+
post_body = opts[:debug_body]
|
|
9650
|
+
|
|
9651
|
+
# return_type
|
|
9652
|
+
return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
|
|
9653
|
+
|
|
9654
|
+
# auth_names
|
|
9655
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9656
|
+
|
|
9657
|
+
new_options = opts.merge(
|
|
9658
|
+
:operation => :"SfvbApi.get_sfvb_transactional_email",
|
|
9659
|
+
:header_params => header_params,
|
|
9660
|
+
:query_params => query_params,
|
|
9661
|
+
:form_params => form_params,
|
|
9662
|
+
:body => post_body,
|
|
9663
|
+
:auth_names => auth_names,
|
|
9664
|
+
:return_type => return_type
|
|
9665
|
+
)
|
|
9666
|
+
|
|
9667
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
9668
|
+
if @api_client.config.debugging
|
|
9669
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9670
|
+
end
|
|
9671
|
+
return data, status_code, headers
|
|
9672
|
+
end
|
|
9673
|
+
|
|
8932
9674
|
# List the transactional emails a storefront sends
|
|
8933
9675
|
# The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
8934
9676
|
# @param storefront_oid [Integer]
|
|
@@ -9580,14 +10322,162 @@ module UltracartClient
|
|
|
9580
10322
|
end
|
|
9581
10323
|
# verify the required parameter 'storefront_oid' is set
|
|
9582
10324
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9583
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_affiliate_network"
|
|
10325
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_affiliate_network"
|
|
10326
|
+
end
|
|
10327
|
+
# verify the required parameter 'affiliate_network_request' is set
|
|
10328
|
+
if @api_client.config.client_side_validation && affiliate_network_request.nil?
|
|
10329
|
+
fail ArgumentError, "Missing the required parameter 'affiliate_network_request' when calling SfvbApi.insert_sfvb_affiliate_network"
|
|
10330
|
+
end
|
|
10331
|
+
# resource path
|
|
10332
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/tracking/affiliate_networks'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
10333
|
+
|
|
10334
|
+
# query parameters
|
|
10335
|
+
query_params = opts[:query_params] || {}
|
|
10336
|
+
|
|
10337
|
+
# header parameters
|
|
10338
|
+
header_params = opts[:header_params] || {}
|
|
10339
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10340
|
+
# HTTP header 'Accept' (if needed)
|
|
10341
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10342
|
+
# HTTP header 'Content-Type'
|
|
10343
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
10344
|
+
if !content_type.nil?
|
|
10345
|
+
header_params['Content-Type'] = content_type
|
|
10346
|
+
end
|
|
10347
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
10348
|
+
|
|
10349
|
+
# form parameters
|
|
10350
|
+
form_params = opts[:form_params] || {}
|
|
10351
|
+
|
|
10352
|
+
# http body (model)
|
|
10353
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate_network_request)
|
|
10354
|
+
|
|
10355
|
+
# return_type
|
|
10356
|
+
return_type = opts[:debug_return_type] || 'SfvbAffiliateNetwork'
|
|
10357
|
+
|
|
10358
|
+
# auth_names
|
|
10359
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10360
|
+
|
|
10361
|
+
new_options = opts.merge(
|
|
10362
|
+
:operation => :"SfvbApi.insert_sfvb_affiliate_network",
|
|
10363
|
+
:header_params => header_params,
|
|
10364
|
+
:query_params => query_params,
|
|
10365
|
+
:form_params => form_params,
|
|
10366
|
+
:body => post_body,
|
|
10367
|
+
:auth_names => auth_names,
|
|
10368
|
+
:return_type => return_type
|
|
10369
|
+
)
|
|
10370
|
+
|
|
10371
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10372
|
+
if @api_client.config.debugging
|
|
10373
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_affiliate_network\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10374
|
+
end
|
|
10375
|
+
return data, status_code, headers
|
|
10376
|
+
end
|
|
10377
|
+
|
|
10378
|
+
# Request a human approval
|
|
10379
|
+
# Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
|
|
10380
|
+
# @param approval_request [SfvbApprovalCreateRequest] The request
|
|
10381
|
+
# @param [Hash] opts the optional parameters
|
|
10382
|
+
# @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
|
|
10383
|
+
# @return [SfvbApproval]
|
|
10384
|
+
def insert_sfvb_approval(approval_request, opts = {})
|
|
10385
|
+
data, _status_code, _headers = insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
10386
|
+
data
|
|
10387
|
+
end
|
|
10388
|
+
|
|
10389
|
+
# Request a human approval
|
|
10390
|
+
# Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow. For file.put_script send the script as content, or params.version for a revert; for tracking_html.put send the HTML as content and params.slot; for affiliate_network.change send affiliate_network. These three start as reviewing while UltraCart's scanner and two AI models read the content, then become pending with the review attached, or refused. Keep polling, and show approval_url only once it is pending. Only the hash is kept, so the write must send the same content.
|
|
10391
|
+
# @param approval_request [SfvbApprovalCreateRequest] The request
|
|
10392
|
+
# @param [Hash] opts the optional parameters
|
|
10393
|
+
# @option opts [Integer] :storefront_oid The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
|
|
10394
|
+
# @return [Array<(SfvbApproval, Integer, Hash)>] SfvbApproval data, response status code and response headers
|
|
10395
|
+
def insert_sfvb_approval_with_http_info(approval_request, opts = {})
|
|
10396
|
+
if @api_client.config.debugging
|
|
10397
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_approval ...'
|
|
10398
|
+
end
|
|
10399
|
+
# verify the required parameter 'approval_request' is set
|
|
10400
|
+
if @api_client.config.client_side_validation && approval_request.nil?
|
|
10401
|
+
fail ArgumentError, "Missing the required parameter 'approval_request' when calling SfvbApi.insert_sfvb_approval"
|
|
10402
|
+
end
|
|
10403
|
+
# resource path
|
|
10404
|
+
local_var_path = '/sfvb/approvals'
|
|
10405
|
+
|
|
10406
|
+
# query parameters
|
|
10407
|
+
query_params = opts[:query_params] || {}
|
|
10408
|
+
query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
|
|
10409
|
+
|
|
10410
|
+
# header parameters
|
|
10411
|
+
header_params = opts[:header_params] || {}
|
|
10412
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10413
|
+
# HTTP header 'Accept' (if needed)
|
|
10414
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10415
|
+
# HTTP header 'Content-Type'
|
|
10416
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
10417
|
+
if !content_type.nil?
|
|
10418
|
+
header_params['Content-Type'] = content_type
|
|
10419
|
+
end
|
|
10420
|
+
|
|
10421
|
+
# form parameters
|
|
10422
|
+
form_params = opts[:form_params] || {}
|
|
10423
|
+
|
|
10424
|
+
# http body (model)
|
|
10425
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(approval_request)
|
|
10426
|
+
|
|
10427
|
+
# return_type
|
|
10428
|
+
return_type = opts[:debug_return_type] || 'SfvbApproval'
|
|
10429
|
+
|
|
10430
|
+
# auth_names
|
|
10431
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10432
|
+
|
|
10433
|
+
new_options = opts.merge(
|
|
10434
|
+
:operation => :"SfvbApi.insert_sfvb_approval",
|
|
10435
|
+
:header_params => header_params,
|
|
10436
|
+
:query_params => query_params,
|
|
10437
|
+
:form_params => form_params,
|
|
10438
|
+
:body => post_body,
|
|
10439
|
+
:auth_names => auth_names,
|
|
10440
|
+
:return_type => return_type
|
|
10441
|
+
)
|
|
10442
|
+
|
|
10443
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10444
|
+
if @api_client.config.debugging
|
|
10445
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10446
|
+
end
|
|
10447
|
+
return data, status_code, headers
|
|
10448
|
+
end
|
|
10449
|
+
|
|
10450
|
+
# Create a blog post
|
|
10451
|
+
# title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page's selectors choose it.
|
|
10452
|
+
# @param storefront_oid [Integer]
|
|
10453
|
+
# @param blog_post_request [SfvbBlogPostRequest] The blog post to create
|
|
10454
|
+
# @param [Hash] opts the optional parameters
|
|
10455
|
+
# @return [SfvbBlogPostDetail]
|
|
10456
|
+
def insert_sfvb_blog_post(storefront_oid, blog_post_request, opts = {})
|
|
10457
|
+
data, _status_code, _headers = insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts)
|
|
10458
|
+
data
|
|
10459
|
+
end
|
|
10460
|
+
|
|
10461
|
+
# Create a blog post
|
|
10462
|
+
# title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page's selectors choose it.
|
|
10463
|
+
# @param storefront_oid [Integer]
|
|
10464
|
+
# @param blog_post_request [SfvbBlogPostRequest] The blog post to create
|
|
10465
|
+
# @param [Hash] opts the optional parameters
|
|
10466
|
+
# @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
|
|
10467
|
+
def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
|
|
10468
|
+
if @api_client.config.debugging
|
|
10469
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
|
|
10470
|
+
end
|
|
10471
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10472
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10473
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
|
|
9584
10474
|
end
|
|
9585
|
-
# verify the required parameter '
|
|
9586
|
-
if @api_client.config.client_side_validation &&
|
|
9587
|
-
fail ArgumentError, "Missing the required parameter '
|
|
10475
|
+
# verify the required parameter 'blog_post_request' is set
|
|
10476
|
+
if @api_client.config.client_side_validation && blog_post_request.nil?
|
|
10477
|
+
fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
|
|
9588
10478
|
end
|
|
9589
10479
|
# resource path
|
|
9590
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
10480
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
9591
10481
|
|
|
9592
10482
|
# query parameters
|
|
9593
10483
|
query_params = opts[:query_params] || {}
|
|
@@ -9602,22 +10492,21 @@ module UltracartClient
|
|
|
9602
10492
|
if !content_type.nil?
|
|
9603
10493
|
header_params['Content-Type'] = content_type
|
|
9604
10494
|
end
|
|
9605
|
-
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
9606
10495
|
|
|
9607
10496
|
# form parameters
|
|
9608
10497
|
form_params = opts[:form_params] || {}
|
|
9609
10498
|
|
|
9610
10499
|
# http body (model)
|
|
9611
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
10500
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
|
|
9612
10501
|
|
|
9613
10502
|
# return_type
|
|
9614
|
-
return_type = opts[:debug_return_type] || '
|
|
10503
|
+
return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
|
|
9615
10504
|
|
|
9616
10505
|
# auth_names
|
|
9617
10506
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9618
10507
|
|
|
9619
10508
|
new_options = opts.merge(
|
|
9620
|
-
:operation => :"SfvbApi.
|
|
10509
|
+
:operation => :"SfvbApi.insert_sfvb_blog_post",
|
|
9621
10510
|
:header_params => header_params,
|
|
9622
10511
|
:query_params => query_params,
|
|
9623
10512
|
:form_params => form_params,
|
|
@@ -9628,42 +10517,45 @@ module UltracartClient
|
|
|
9628
10517
|
|
|
9629
10518
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9630
10519
|
if @api_client.config.debugging
|
|
9631
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
10520
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9632
10521
|
end
|
|
9633
10522
|
return data, status_code, headers
|
|
9634
10523
|
end
|
|
9635
10524
|
|
|
9636
|
-
#
|
|
9637
|
-
#
|
|
9638
|
-
# @param
|
|
10525
|
+
# Create a list and segment folder
|
|
10526
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10527
|
+
# @param storefront_oid [Integer]
|
|
10528
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
9639
10529
|
# @param [Hash] opts the optional parameters
|
|
9640
|
-
# @
|
|
9641
|
-
|
|
9642
|
-
|
|
9643
|
-
data, _status_code, _headers = insert_sfvb_approval_with_http_info(approval_request, opts)
|
|
10530
|
+
# @return [SfvbCommsFolderResponse]
|
|
10531
|
+
def insert_sfvb_comms_folder(storefront_oid, folder_write_request, opts = {})
|
|
10532
|
+
data, _status_code, _headers = insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts)
|
|
9644
10533
|
data
|
|
9645
10534
|
end
|
|
9646
10535
|
|
|
9647
|
-
#
|
|
9648
|
-
#
|
|
9649
|
-
# @param
|
|
10536
|
+
# Create a list and segment folder
|
|
10537
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10538
|
+
# @param storefront_oid [Integer]
|
|
10539
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
9650
10540
|
# @param [Hash] opts the optional parameters
|
|
9651
|
-
# @
|
|
9652
|
-
|
|
9653
|
-
def insert_sfvb_approval_with_http_info(approval_request, opts = {})
|
|
10541
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
10542
|
+
def insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts = {})
|
|
9654
10543
|
if @api_client.config.debugging
|
|
9655
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
10544
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_folder ...'
|
|
9656
10545
|
end
|
|
9657
|
-
# verify the required parameter '
|
|
9658
|
-
if @api_client.config.client_side_validation &&
|
|
9659
|
-
fail ArgumentError, "Missing the required parameter '
|
|
10546
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10547
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10548
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
10549
|
+
end
|
|
10550
|
+
# verify the required parameter 'folder_write_request' is set
|
|
10551
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
10552
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
9660
10553
|
end
|
|
9661
10554
|
# resource path
|
|
9662
|
-
local_var_path = '/sfvb/
|
|
10555
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
9663
10556
|
|
|
9664
10557
|
# query parameters
|
|
9665
10558
|
query_params = opts[:query_params] || {}
|
|
9666
|
-
query_params[:'storefront_oid'] = opts[:'storefront_oid'] if !opts[:'storefront_oid'].nil?
|
|
9667
10559
|
|
|
9668
10560
|
# header parameters
|
|
9669
10561
|
header_params = opts[:header_params] || {}
|
|
@@ -9671,7 +10563,7 @@ module UltracartClient
|
|
|
9671
10563
|
# HTTP header 'Accept' (if needed)
|
|
9672
10564
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9673
10565
|
# HTTP header 'Content-Type'
|
|
9674
|
-
content_type = @api_client.select_header_content_type(['application/json
|
|
10566
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
9675
10567
|
if !content_type.nil?
|
|
9676
10568
|
header_params['Content-Type'] = content_type
|
|
9677
10569
|
end
|
|
@@ -9680,16 +10572,16 @@ module UltracartClient
|
|
|
9680
10572
|
form_params = opts[:form_params] || {}
|
|
9681
10573
|
|
|
9682
10574
|
# http body (model)
|
|
9683
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
10575
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
9684
10576
|
|
|
9685
10577
|
# return_type
|
|
9686
|
-
return_type = opts[:debug_return_type] || '
|
|
10578
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
9687
10579
|
|
|
9688
10580
|
# auth_names
|
|
9689
10581
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9690
10582
|
|
|
9691
10583
|
new_options = opts.merge(
|
|
9692
|
-
:operation => :"SfvbApi.
|
|
10584
|
+
:operation => :"SfvbApi.insert_sfvb_comms_folder",
|
|
9693
10585
|
:header_params => header_params,
|
|
9694
10586
|
:query_params => query_params,
|
|
9695
10587
|
:form_params => form_params,
|
|
@@ -9700,42 +10592,42 @@ module UltracartClient
|
|
|
9700
10592
|
|
|
9701
10593
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9702
10594
|
if @api_client.config.debugging
|
|
9703
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
10595
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9704
10596
|
end
|
|
9705
10597
|
return data, status_code, headers
|
|
9706
10598
|
end
|
|
9707
10599
|
|
|
9708
|
-
# Create
|
|
9709
|
-
#
|
|
10600
|
+
# Create an email list
|
|
10601
|
+
# 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.
|
|
9710
10602
|
# @param storefront_oid [Integer]
|
|
9711
|
-
# @param
|
|
10603
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
9712
10604
|
# @param [Hash] opts the optional parameters
|
|
9713
|
-
# @return [
|
|
9714
|
-
def
|
|
9715
|
-
data, _status_code, _headers =
|
|
10605
|
+
# @return [SfvbCommsListResponse]
|
|
10606
|
+
def insert_sfvb_comms_list(storefront_oid, list_write_request, opts = {})
|
|
10607
|
+
data, _status_code, _headers = insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts)
|
|
9716
10608
|
data
|
|
9717
10609
|
end
|
|
9718
10610
|
|
|
9719
|
-
# Create
|
|
9720
|
-
#
|
|
10611
|
+
# Create an email list
|
|
10612
|
+
# 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.
|
|
9721
10613
|
# @param storefront_oid [Integer]
|
|
9722
|
-
# @param
|
|
10614
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
9723
10615
|
# @param [Hash] opts the optional parameters
|
|
9724
|
-
# @return [Array<(
|
|
9725
|
-
def
|
|
10616
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
10617
|
+
def insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts = {})
|
|
9726
10618
|
if @api_client.config.debugging
|
|
9727
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
10619
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_list ...'
|
|
9728
10620
|
end
|
|
9729
10621
|
# verify the required parameter 'storefront_oid' is set
|
|
9730
10622
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9731
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
10623
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_list"
|
|
9732
10624
|
end
|
|
9733
|
-
# verify the required parameter '
|
|
9734
|
-
if @api_client.config.client_side_validation &&
|
|
9735
|
-
fail ArgumentError, "Missing the required parameter '
|
|
10625
|
+
# verify the required parameter 'list_write_request' is set
|
|
10626
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
10627
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.insert_sfvb_comms_list"
|
|
9736
10628
|
end
|
|
9737
10629
|
# resource path
|
|
9738
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
10630
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
9739
10631
|
|
|
9740
10632
|
# query parameters
|
|
9741
10633
|
query_params = opts[:query_params] || {}
|
|
@@ -9746,7 +10638,7 @@ module UltracartClient
|
|
|
9746
10638
|
# HTTP header 'Accept' (if needed)
|
|
9747
10639
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9748
10640
|
# HTTP header 'Content-Type'
|
|
9749
|
-
content_type = @api_client.select_header_content_type(['application/json
|
|
10641
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
9750
10642
|
if !content_type.nil?
|
|
9751
10643
|
header_params['Content-Type'] = content_type
|
|
9752
10644
|
end
|
|
@@ -9755,16 +10647,16 @@ module UltracartClient
|
|
|
9755
10647
|
form_params = opts[:form_params] || {}
|
|
9756
10648
|
|
|
9757
10649
|
# http body (model)
|
|
9758
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
10650
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
9759
10651
|
|
|
9760
10652
|
# return_type
|
|
9761
|
-
return_type = opts[:debug_return_type] || '
|
|
10653
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
9762
10654
|
|
|
9763
10655
|
# auth_names
|
|
9764
10656
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9765
10657
|
|
|
9766
10658
|
new_options = opts.merge(
|
|
9767
|
-
:operation => :"SfvbApi.
|
|
10659
|
+
:operation => :"SfvbApi.insert_sfvb_comms_list",
|
|
9768
10660
|
:header_params => header_params,
|
|
9769
10661
|
:query_params => query_params,
|
|
9770
10662
|
:form_params => form_params,
|
|
@@ -9775,7 +10667,7 @@ module UltracartClient
|
|
|
9775
10667
|
|
|
9776
10668
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9777
10669
|
if @api_client.config.debugging
|
|
9778
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
10670
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9779
10671
|
end
|
|
9780
10672
|
return data, status_code, headers
|
|
9781
10673
|
end
|
|
@@ -16457,6 +17349,182 @@ module UltracartClient
|
|
|
16457
17349
|
return data, status_code, headers
|
|
16458
17350
|
end
|
|
16459
17351
|
|
|
17352
|
+
# Rename a list and segment folder
|
|
17353
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17354
|
+
# @param storefront_oid [Integer]
|
|
17355
|
+
# @param folder_uuid [String]
|
|
17356
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17357
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17358
|
+
# @param [Hash] opts the optional parameters
|
|
17359
|
+
# @return [SfvbCommsFolderResponse]
|
|
17360
|
+
def update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17361
|
+
data, _status_code, _headers = update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts)
|
|
17362
|
+
data
|
|
17363
|
+
end
|
|
17364
|
+
|
|
17365
|
+
# Rename a list and segment folder
|
|
17366
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17367
|
+
# @param storefront_oid [Integer]
|
|
17368
|
+
# @param folder_uuid [String]
|
|
17369
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17370
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17371
|
+
# @param [Hash] opts the optional parameters
|
|
17372
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
17373
|
+
def update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17374
|
+
if @api_client.config.debugging
|
|
17375
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_folder ...'
|
|
17376
|
+
end
|
|
17377
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17378
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17379
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17380
|
+
end
|
|
17381
|
+
# verify the required parameter 'folder_uuid' is set
|
|
17382
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
17383
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17384
|
+
end
|
|
17385
|
+
# verify the required parameter 'if_match' is set
|
|
17386
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17387
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17388
|
+
end
|
|
17389
|
+
# verify the required parameter 'folder_write_request' is set
|
|
17390
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
17391
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17392
|
+
end
|
|
17393
|
+
# resource path
|
|
17394
|
+
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))
|
|
17395
|
+
|
|
17396
|
+
# query parameters
|
|
17397
|
+
query_params = opts[:query_params] || {}
|
|
17398
|
+
|
|
17399
|
+
# header parameters
|
|
17400
|
+
header_params = opts[:header_params] || {}
|
|
17401
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17402
|
+
# HTTP header 'Accept' (if needed)
|
|
17403
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17404
|
+
# HTTP header 'Content-Type'
|
|
17405
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17406
|
+
if !content_type.nil?
|
|
17407
|
+
header_params['Content-Type'] = content_type
|
|
17408
|
+
end
|
|
17409
|
+
header_params[:'If-Match'] = if_match
|
|
17410
|
+
|
|
17411
|
+
# form parameters
|
|
17412
|
+
form_params = opts[:form_params] || {}
|
|
17413
|
+
|
|
17414
|
+
# http body (model)
|
|
17415
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
17416
|
+
|
|
17417
|
+
# return_type
|
|
17418
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
17419
|
+
|
|
17420
|
+
# auth_names
|
|
17421
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17422
|
+
|
|
17423
|
+
new_options = opts.merge(
|
|
17424
|
+
:operation => :"SfvbApi.update_sfvb_comms_folder",
|
|
17425
|
+
:header_params => header_params,
|
|
17426
|
+
:query_params => query_params,
|
|
17427
|
+
:form_params => form_params,
|
|
17428
|
+
:body => post_body,
|
|
17429
|
+
:auth_names => auth_names,
|
|
17430
|
+
:return_type => return_type
|
|
17431
|
+
)
|
|
17432
|
+
|
|
17433
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17434
|
+
if @api_client.config.debugging
|
|
17435
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17436
|
+
end
|
|
17437
|
+
return data, status_code, headers
|
|
17438
|
+
end
|
|
17439
|
+
|
|
17440
|
+
# Change an email list's name, folder or public settings
|
|
17441
|
+
# 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.
|
|
17442
|
+
# @param storefront_oid [Integer]
|
|
17443
|
+
# @param list_uuid [String]
|
|
17444
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17445
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17446
|
+
# @param [Hash] opts the optional parameters
|
|
17447
|
+
# @return [SfvbCommsListResponse]
|
|
17448
|
+
def update_sfvb_comms_list(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17449
|
+
data, _status_code, _headers = update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts)
|
|
17450
|
+
data
|
|
17451
|
+
end
|
|
17452
|
+
|
|
17453
|
+
# Change an email list's name, folder or public settings
|
|
17454
|
+
# 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.
|
|
17455
|
+
# @param storefront_oid [Integer]
|
|
17456
|
+
# @param list_uuid [String]
|
|
17457
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17458
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17459
|
+
# @param [Hash] opts the optional parameters
|
|
17460
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
17461
|
+
def update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17462
|
+
if @api_client.config.debugging
|
|
17463
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_list ...'
|
|
17464
|
+
end
|
|
17465
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17466
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17467
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17468
|
+
end
|
|
17469
|
+
# verify the required parameter 'list_uuid' is set
|
|
17470
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
17471
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17472
|
+
end
|
|
17473
|
+
# verify the required parameter 'if_match' is set
|
|
17474
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17475
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_list"
|
|
17476
|
+
end
|
|
17477
|
+
# verify the required parameter 'list_write_request' is set
|
|
17478
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
17479
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.update_sfvb_comms_list"
|
|
17480
|
+
end
|
|
17481
|
+
# resource path
|
|
17482
|
+
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))
|
|
17483
|
+
|
|
17484
|
+
# query parameters
|
|
17485
|
+
query_params = opts[:query_params] || {}
|
|
17486
|
+
|
|
17487
|
+
# header parameters
|
|
17488
|
+
header_params = opts[:header_params] || {}
|
|
17489
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17490
|
+
# HTTP header 'Accept' (if needed)
|
|
17491
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17492
|
+
# HTTP header 'Content-Type'
|
|
17493
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17494
|
+
if !content_type.nil?
|
|
17495
|
+
header_params['Content-Type'] = content_type
|
|
17496
|
+
end
|
|
17497
|
+
header_params[:'If-Match'] = if_match
|
|
17498
|
+
|
|
17499
|
+
# form parameters
|
|
17500
|
+
form_params = opts[:form_params] || {}
|
|
17501
|
+
|
|
17502
|
+
# http body (model)
|
|
17503
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
17504
|
+
|
|
17505
|
+
# return_type
|
|
17506
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
17507
|
+
|
|
17508
|
+
# auth_names
|
|
17509
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17510
|
+
|
|
17511
|
+
new_options = opts.merge(
|
|
17512
|
+
:operation => :"SfvbApi.update_sfvb_comms_list",
|
|
17513
|
+
:header_params => header_params,
|
|
17514
|
+
:query_params => query_params,
|
|
17515
|
+
:form_params => form_params,
|
|
17516
|
+
:body => post_body,
|
|
17517
|
+
:auth_names => auth_names,
|
|
17518
|
+
:return_type => return_type
|
|
17519
|
+
)
|
|
17520
|
+
|
|
17521
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17522
|
+
if @api_client.config.debugging
|
|
17523
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17524
|
+
end
|
|
17525
|
+
return data, status_code, headers
|
|
17526
|
+
end
|
|
17527
|
+
|
|
16460
17528
|
# Change a segment's name, rule or folder
|
|
16461
17529
|
# 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
17530
|
# @param storefront_oid [Integer]
|
|
@@ -16781,7 +17849,7 @@ module UltracartClient
|
|
|
16781
17849
|
end
|
|
16782
17850
|
|
|
16783
17851
|
# Change a flow
|
|
16784
|
-
# A field left out keeps its value. The trigger and the status
|
|
17852
|
+
# 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
17853
|
# @param storefront_oid [Integer]
|
|
16786
17854
|
# @param flow_uuid [String]
|
|
16787
17855
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
@@ -16794,7 +17862,7 @@ module UltracartClient
|
|
|
16794
17862
|
end
|
|
16795
17863
|
|
|
16796
17864
|
# Change a flow
|
|
16797
|
-
# A field left out keeps its value. The trigger and the status
|
|
17865
|
+
# 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
17866
|
# @param storefront_oid [Integer]
|
|
16799
17867
|
# @param flow_uuid [String]
|
|
16800
17868
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
@@ -17823,6 +18891,97 @@ module UltracartClient
|
|
|
17823
18891
|
return data, status_code, headers
|
|
17824
18892
|
end
|
|
17825
18893
|
|
|
18894
|
+
# Change a transactional email's subject, delivery options or sender
|
|
18895
|
+
# A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
|
|
18896
|
+
# @param storefront_oid [Integer]
|
|
18897
|
+
# @param file_name [String]
|
|
18898
|
+
# @param if_match [String] The email's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
18899
|
+
# @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
|
|
18900
|
+
# @param [Hash] opts the optional parameters
|
|
18901
|
+
# @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
|
|
18902
|
+
# @return [SfvbTransactionalEmailResponse]
|
|
18903
|
+
def update_sfvb_transactional_email(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
|
|
18904
|
+
data, _status_code, _headers = update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts)
|
|
18905
|
+
data
|
|
18906
|
+
end
|
|
18907
|
+
|
|
18908
|
+
# Change a transactional email's subject, delivery options or sender
|
|
18909
|
+
# A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email's hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant's own mail server.
|
|
18910
|
+
# @param storefront_oid [Integer]
|
|
18911
|
+
# @param file_name [String]
|
|
18912
|
+
# @param if_match [String] The email's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
18913
|
+
# @param transactional_email_update_request [SfvbTransactionalEmailUpdateRequest] The fields to change
|
|
18914
|
+
# @param [Hash] opts the optional parameters
|
|
18915
|
+
# @option opts [String] :approval_id The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
|
|
18916
|
+
# @return [Array<(SfvbTransactionalEmailResponse, Integer, Hash)>] SfvbTransactionalEmailResponse data, response status code and response headers
|
|
18917
|
+
def update_sfvb_transactional_email_with_http_info(storefront_oid, file_name, if_match, transactional_email_update_request, opts = {})
|
|
18918
|
+
if @api_client.config.debugging
|
|
18919
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_transactional_email ...'
|
|
18920
|
+
end
|
|
18921
|
+
# verify the required parameter 'storefront_oid' is set
|
|
18922
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
18923
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18924
|
+
end
|
|
18925
|
+
# verify the required parameter 'file_name' is set
|
|
18926
|
+
if @api_client.config.client_side_validation && file_name.nil?
|
|
18927
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18928
|
+
end
|
|
18929
|
+
# verify the required parameter 'if_match' is set
|
|
18930
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
18931
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18932
|
+
end
|
|
18933
|
+
# verify the required parameter 'transactional_email_update_request' is set
|
|
18934
|
+
if @api_client.config.client_side_validation && transactional_email_update_request.nil?
|
|
18935
|
+
fail ArgumentError, "Missing the required parameter 'transactional_email_update_request' when calling SfvbApi.update_sfvb_transactional_email"
|
|
18936
|
+
end
|
|
18937
|
+
# resource path
|
|
18938
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/transactional_emails/{file_name}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'file_name' + '}', CGI.escape(file_name.to_s))
|
|
18939
|
+
|
|
18940
|
+
# query parameters
|
|
18941
|
+
query_params = opts[:query_params] || {}
|
|
18942
|
+
|
|
18943
|
+
# header parameters
|
|
18944
|
+
header_params = opts[:header_params] || {}
|
|
18945
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
18946
|
+
# HTTP header 'Accept' (if needed)
|
|
18947
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
18948
|
+
# HTTP header 'Content-Type'
|
|
18949
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
18950
|
+
if !content_type.nil?
|
|
18951
|
+
header_params['Content-Type'] = content_type
|
|
18952
|
+
end
|
|
18953
|
+
header_params[:'If-Match'] = if_match
|
|
18954
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
18955
|
+
|
|
18956
|
+
# form parameters
|
|
18957
|
+
form_params = opts[:form_params] || {}
|
|
18958
|
+
|
|
18959
|
+
# http body (model)
|
|
18960
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactional_email_update_request)
|
|
18961
|
+
|
|
18962
|
+
# return_type
|
|
18963
|
+
return_type = opts[:debug_return_type] || 'SfvbTransactionalEmailResponse'
|
|
18964
|
+
|
|
18965
|
+
# auth_names
|
|
18966
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
18967
|
+
|
|
18968
|
+
new_options = opts.merge(
|
|
18969
|
+
:operation => :"SfvbApi.update_sfvb_transactional_email",
|
|
18970
|
+
:header_params => header_params,
|
|
18971
|
+
:query_params => query_params,
|
|
18972
|
+
:form_params => form_params,
|
|
18973
|
+
:body => post_body,
|
|
18974
|
+
:auth_names => auth_names,
|
|
18975
|
+
:return_type => return_type
|
|
18976
|
+
)
|
|
18977
|
+
|
|
18978
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
18979
|
+
if @api_client.config.debugging
|
|
18980
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_transactional_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
18981
|
+
end
|
|
18982
|
+
return data, status_code, headers
|
|
18983
|
+
end
|
|
18984
|
+
|
|
17826
18985
|
# Update an upsell offer
|
|
17827
18986
|
# A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer's screenshots, are kept.
|
|
17828
18987
|
# @param storefront_oid [Integer]
|