ultracart_api 4.1.228 → 4.1.230
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +35 -2
- data/docs/ItemAutoOrder.md +6 -0
- data/docs/SfvbApi.md +946 -4
- data/docs/SfvbApprovalCreateRequest.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/SfvbFlowWriteRequest.md +2 -2
- data/docs/SfvbNotFoundEntry.md +2 -0
- data/docs/SfvbNotFoundSummary.md +28 -0
- data/docs/SfvbRedirectImportRow.md +2 -0
- data/docs/SfvbRedirectRequest.md +2 -0
- data/docs/SfvbRedirectResolveBatchRequest.md +18 -0
- data/docs/SfvbRedirectResolveBatchResponse.md +24 -0
- data/docs/SfvbSequenceStep.md +1 -1
- data/docs/SfvbSiteSeo.md +40 -0
- data/docs/SfvbSiteSeoChange.md +26 -0
- data/docs/SfvbSiteSeoRequest.md +24 -0
- data/docs/SfvbStepCounts.md +1 -1
- data/lib/ultracart_api/api/sfvb_api.rb +1306 -47
- data/lib/ultracart_api/models/item_auto_order.rb +35 -1
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +12 -3
- data/lib/ultracart_api/models/sfvb_comms_folder.rb +270 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_item.rb +240 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_response.rb +243 -0
- data/lib/ultracart_api/models/sfvb_comms_folder_write_request.rb +220 -0
- data/lib/ultracart_api/models/sfvb_comms_folders_response.rb +222 -0
- data/lib/ultracart_api/models/sfvb_comms_list_detail.rb +302 -0
- data/lib/ultracart_api/models/sfvb_comms_list_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_comms_list_write_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_flow_write_request.rb +2 -2
- data/lib/ultracart_api/models/sfvb_not_found_entry.rb +11 -1
- data/lib/ultracart_api/models/sfvb_not_found_summary.rb +280 -0
- data/lib/ultracart_api/models/sfvb_redirect_import_row.rb +11 -1
- data/lib/ultracart_api/models/sfvb_redirect_request.rb +11 -1
- data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_redirect_resolve_batch_response.rb +252 -0
- data/lib/ultracart_api/models/sfvb_sequence_step.rb +1 -1
- data/lib/ultracart_api/models/sfvb_site_seo.rb +334 -0
- data/lib/ultracart_api/models/sfvb_site_seo_change.rb +260 -0
- data/lib/ultracart_api/models/sfvb_site_seo_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_step_counts.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +14 -0
- metadata +30 -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]
|
|
@@ -1900,6 +2131,76 @@ module UltracartClient
|
|
|
1900
2131
|
return data, status_code, headers
|
|
1901
2132
|
end
|
|
1902
2133
|
|
|
2134
|
+
# Remove a 404 path from the log
|
|
2135
|
+
# The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
2136
|
+
# @param storefront_oid [Integer]
|
|
2137
|
+
# @param not_found_id [String]
|
|
2138
|
+
# @param [Hash] opts the optional parameters
|
|
2139
|
+
# @return [nil]
|
|
2140
|
+
def delete_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
|
|
2141
|
+
delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
2142
|
+
nil
|
|
2143
|
+
end
|
|
2144
|
+
|
|
2145
|
+
# Remove a 404 path from the log
|
|
2146
|
+
# The admin's Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
2147
|
+
# @param storefront_oid [Integer]
|
|
2148
|
+
# @param not_found_id [String]
|
|
2149
|
+
# @param [Hash] opts the optional parameters
|
|
2150
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2151
|
+
def delete_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
|
|
2152
|
+
if @api_client.config.debugging
|
|
2153
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_not_found_entry ...'
|
|
2154
|
+
end
|
|
2155
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2156
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2157
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.delete_sfvb_not_found_entry"
|
|
2158
|
+
end
|
|
2159
|
+
# verify the required parameter 'not_found_id' is set
|
|
2160
|
+
if @api_client.config.client_side_validation && not_found_id.nil?
|
|
2161
|
+
fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.delete_sfvb_not_found_entry"
|
|
2162
|
+
end
|
|
2163
|
+
# resource path
|
|
2164
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
|
|
2165
|
+
|
|
2166
|
+
# query parameters
|
|
2167
|
+
query_params = opts[:query_params] || {}
|
|
2168
|
+
|
|
2169
|
+
# header parameters
|
|
2170
|
+
header_params = opts[:header_params] || {}
|
|
2171
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2172
|
+
# HTTP header 'Accept' (if needed)
|
|
2173
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2174
|
+
|
|
2175
|
+
# form parameters
|
|
2176
|
+
form_params = opts[:form_params] || {}
|
|
2177
|
+
|
|
2178
|
+
# http body (model)
|
|
2179
|
+
post_body = opts[:debug_body]
|
|
2180
|
+
|
|
2181
|
+
# return_type
|
|
2182
|
+
return_type = opts[:debug_return_type]
|
|
2183
|
+
|
|
2184
|
+
# auth_names
|
|
2185
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2186
|
+
|
|
2187
|
+
new_options = opts.merge(
|
|
2188
|
+
:operation => :"SfvbApi.delete_sfvb_not_found_entry",
|
|
2189
|
+
:header_params => header_params,
|
|
2190
|
+
:query_params => query_params,
|
|
2191
|
+
:form_params => form_params,
|
|
2192
|
+
:body => post_body,
|
|
2193
|
+
:auth_names => auth_names,
|
|
2194
|
+
:return_type => return_type
|
|
2195
|
+
)
|
|
2196
|
+
|
|
2197
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2198
|
+
if @api_client.config.debugging
|
|
2199
|
+
@api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2200
|
+
end
|
|
2201
|
+
return data, status_code, headers
|
|
2202
|
+
end
|
|
2203
|
+
|
|
1903
2204
|
# Detach an image from a page
|
|
1904
2205
|
# Name exactly one of code or default. Removes the page's copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
|
|
1905
2206
|
# @param storefront_oid [Integer]
|
|
@@ -3924,6 +4225,76 @@ module UltracartClient
|
|
|
3924
4225
|
return data, status_code, headers
|
|
3925
4226
|
end
|
|
3926
4227
|
|
|
4228
|
+
# Export the open 404 paths
|
|
4229
|
+
# Up to 5,000 open paths, most hits first, as the admin's mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
4230
|
+
# @param storefront_oid [Integer]
|
|
4231
|
+
# @param [Hash] opts the optional parameters
|
|
4232
|
+
# @option opts [Boolean] :include_bots
|
|
4233
|
+
# @option opts [Boolean] :include_tokens
|
|
4234
|
+
# @return [SfvbNotFoundResponse]
|
|
4235
|
+
def export_sfvb_not_found(storefront_oid, opts = {})
|
|
4236
|
+
data, _status_code, _headers = export_sfvb_not_found_with_http_info(storefront_oid, opts)
|
|
4237
|
+
data
|
|
4238
|
+
end
|
|
4239
|
+
|
|
4240
|
+
# Export the open 404 paths
|
|
4241
|
+
# Up to 5,000 open paths, most hits first, as the admin's mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
4242
|
+
# @param storefront_oid [Integer]
|
|
4243
|
+
# @param [Hash] opts the optional parameters
|
|
4244
|
+
# @option opts [Boolean] :include_bots
|
|
4245
|
+
# @option opts [Boolean] :include_tokens
|
|
4246
|
+
# @return [Array<(SfvbNotFoundResponse, Integer, Hash)>] SfvbNotFoundResponse data, response status code and response headers
|
|
4247
|
+
def export_sfvb_not_found_with_http_info(storefront_oid, opts = {})
|
|
4248
|
+
if @api_client.config.debugging
|
|
4249
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.export_sfvb_not_found ...'
|
|
4250
|
+
end
|
|
4251
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4252
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4253
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.export_sfvb_not_found"
|
|
4254
|
+
end
|
|
4255
|
+
# resource path
|
|
4256
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/export'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4257
|
+
|
|
4258
|
+
# query parameters
|
|
4259
|
+
query_params = opts[:query_params] || {}
|
|
4260
|
+
query_params[:'include_bots'] = opts[:'include_bots'] if !opts[:'include_bots'].nil?
|
|
4261
|
+
query_params[:'include_tokens'] = opts[:'include_tokens'] if !opts[:'include_tokens'].nil?
|
|
4262
|
+
|
|
4263
|
+
# header parameters
|
|
4264
|
+
header_params = opts[:header_params] || {}
|
|
4265
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4266
|
+
# HTTP header 'Accept' (if needed)
|
|
4267
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4268
|
+
|
|
4269
|
+
# form parameters
|
|
4270
|
+
form_params = opts[:form_params] || {}
|
|
4271
|
+
|
|
4272
|
+
# http body (model)
|
|
4273
|
+
post_body = opts[:debug_body]
|
|
4274
|
+
|
|
4275
|
+
# return_type
|
|
4276
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundResponse'
|
|
4277
|
+
|
|
4278
|
+
# auth_names
|
|
4279
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4280
|
+
|
|
4281
|
+
new_options = opts.merge(
|
|
4282
|
+
:operation => :"SfvbApi.export_sfvb_not_found",
|
|
4283
|
+
:header_params => header_params,
|
|
4284
|
+
:query_params => query_params,
|
|
4285
|
+
:form_params => form_params,
|
|
4286
|
+
:body => post_body,
|
|
4287
|
+
:auth_names => auth_names,
|
|
4288
|
+
:return_type => return_type
|
|
4289
|
+
)
|
|
4290
|
+
|
|
4291
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4292
|
+
if @api_client.config.debugging
|
|
4293
|
+
@api_client.config.logger.debug "API called: SfvbApi#export_sfvb_not_found\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4294
|
+
end
|
|
4295
|
+
return data, status_code, headers
|
|
4296
|
+
end
|
|
4297
|
+
|
|
3927
4298
|
# Favorite a library entry
|
|
3928
4299
|
# Bookmarks the entry for the calling user. Idempotent. Owner or anyone the entry is shared with.
|
|
3929
4300
|
# @param storefront_oid [Integer]
|
|
@@ -3994,6 +4365,76 @@ module UltracartClient
|
|
|
3994
4365
|
return data, status_code, headers
|
|
3995
4366
|
end
|
|
3996
4367
|
|
|
4368
|
+
# Mark a 404 path fixed
|
|
4369
|
+
# For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin's Mark Fixed.
|
|
4370
|
+
# @param storefront_oid [Integer]
|
|
4371
|
+
# @param not_found_id [String]
|
|
4372
|
+
# @param [Hash] opts the optional parameters
|
|
4373
|
+
# @return [SfvbNotFoundEntry]
|
|
4374
|
+
def fix_sfvb_not_found_entry(storefront_oid, not_found_id, opts = {})
|
|
4375
|
+
data, _status_code, _headers = fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts)
|
|
4376
|
+
data
|
|
4377
|
+
end
|
|
4378
|
+
|
|
4379
|
+
# Mark a 404 path fixed
|
|
4380
|
+
# For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin's Mark Fixed.
|
|
4381
|
+
# @param storefront_oid [Integer]
|
|
4382
|
+
# @param not_found_id [String]
|
|
4383
|
+
# @param [Hash] opts the optional parameters
|
|
4384
|
+
# @return [Array<(SfvbNotFoundEntry, Integer, Hash)>] SfvbNotFoundEntry data, response status code and response headers
|
|
4385
|
+
def fix_sfvb_not_found_entry_with_http_info(storefront_oid, not_found_id, opts = {})
|
|
4386
|
+
if @api_client.config.debugging
|
|
4387
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.fix_sfvb_not_found_entry ...'
|
|
4388
|
+
end
|
|
4389
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4390
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4391
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.fix_sfvb_not_found_entry"
|
|
4392
|
+
end
|
|
4393
|
+
# verify the required parameter 'not_found_id' is set
|
|
4394
|
+
if @api_client.config.client_side_validation && not_found_id.nil?
|
|
4395
|
+
fail ArgumentError, "Missing the required parameter 'not_found_id' when calling SfvbApi.fix_sfvb_not_found_entry"
|
|
4396
|
+
end
|
|
4397
|
+
# resource path
|
|
4398
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/{not_found_id}/fixed'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'not_found_id' + '}', CGI.escape(not_found_id.to_s))
|
|
4399
|
+
|
|
4400
|
+
# query parameters
|
|
4401
|
+
query_params = opts[:query_params] || {}
|
|
4402
|
+
|
|
4403
|
+
# header parameters
|
|
4404
|
+
header_params = opts[:header_params] || {}
|
|
4405
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4406
|
+
# HTTP header 'Accept' (if needed)
|
|
4407
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4408
|
+
|
|
4409
|
+
# form parameters
|
|
4410
|
+
form_params = opts[:form_params] || {}
|
|
4411
|
+
|
|
4412
|
+
# http body (model)
|
|
4413
|
+
post_body = opts[:debug_body]
|
|
4414
|
+
|
|
4415
|
+
# return_type
|
|
4416
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundEntry'
|
|
4417
|
+
|
|
4418
|
+
# auth_names
|
|
4419
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4420
|
+
|
|
4421
|
+
new_options = opts.merge(
|
|
4422
|
+
:operation => :"SfvbApi.fix_sfvb_not_found_entry",
|
|
4423
|
+
:header_params => header_params,
|
|
4424
|
+
:query_params => query_params,
|
|
4425
|
+
:form_params => form_params,
|
|
4426
|
+
:body => post_body,
|
|
4427
|
+
:auth_names => auth_names,
|
|
4428
|
+
:return_type => return_type
|
|
4429
|
+
)
|
|
4430
|
+
|
|
4431
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4432
|
+
if @api_client.config.debugging
|
|
4433
|
+
@api_client.config.logger.debug "API called: SfvbApi#fix_sfvb_not_found_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4434
|
+
end
|
|
4435
|
+
return data, status_code, headers
|
|
4436
|
+
end
|
|
4437
|
+
|
|
3997
4438
|
# Read one affiliate network
|
|
3998
4439
|
# The network with its conversion_pixel, and the hash_sha256 an update or delete sends back as If-Match.
|
|
3999
4440
|
# @param storefront_oid [Integer]
|
|
@@ -4393,26 +4834,235 @@ module UltracartClient
|
|
|
4393
4834
|
# Element types used by a container
|
|
4394
4835
|
# @param compile_request [SfvbCompileRequest] CJSON to inspect
|
|
4395
4836
|
# @param [Hash] opts the optional parameters
|
|
4396
|
-
# @return [SfvbElementsResponse]
|
|
4397
|
-
def get_sfvb_cjson_used_elements(compile_request, opts = {})
|
|
4398
|
-
data, _status_code, _headers = get_sfvb_cjson_used_elements_with_http_info(compile_request, opts)
|
|
4837
|
+
# @return [SfvbElementsResponse]
|
|
4838
|
+
def get_sfvb_cjson_used_elements(compile_request, opts = {})
|
|
4839
|
+
data, _status_code, _headers = get_sfvb_cjson_used_elements_with_http_info(compile_request, opts)
|
|
4840
|
+
data
|
|
4841
|
+
end
|
|
4842
|
+
|
|
4843
|
+
# Element types used by a container
|
|
4844
|
+
# @param compile_request [SfvbCompileRequest] CJSON to inspect
|
|
4845
|
+
# @param [Hash] opts the optional parameters
|
|
4846
|
+
# @return [Array<(SfvbElementsResponse, Integer, Hash)>] SfvbElementsResponse data, response status code and response headers
|
|
4847
|
+
def get_sfvb_cjson_used_elements_with_http_info(compile_request, opts = {})
|
|
4848
|
+
if @api_client.config.debugging
|
|
4849
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_cjson_used_elements ...'
|
|
4850
|
+
end
|
|
4851
|
+
# verify the required parameter 'compile_request' is set
|
|
4852
|
+
if @api_client.config.client_side_validation && compile_request.nil?
|
|
4853
|
+
fail ArgumentError, "Missing the required parameter 'compile_request' when calling SfvbApi.get_sfvb_cjson_used_elements"
|
|
4854
|
+
end
|
|
4855
|
+
# resource path
|
|
4856
|
+
local_var_path = '/sfvb/cjson/elements'
|
|
4857
|
+
|
|
4858
|
+
# query parameters
|
|
4859
|
+
query_params = opts[:query_params] || {}
|
|
4860
|
+
|
|
4861
|
+
# header parameters
|
|
4862
|
+
header_params = opts[:header_params] || {}
|
|
4863
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4864
|
+
# HTTP header 'Accept' (if needed)
|
|
4865
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4866
|
+
# HTTP header 'Content-Type'
|
|
4867
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4868
|
+
if !content_type.nil?
|
|
4869
|
+
header_params['Content-Type'] = content_type
|
|
4870
|
+
end
|
|
4871
|
+
|
|
4872
|
+
# form parameters
|
|
4873
|
+
form_params = opts[:form_params] || {}
|
|
4874
|
+
|
|
4875
|
+
# http body (model)
|
|
4876
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(compile_request)
|
|
4877
|
+
|
|
4878
|
+
# return_type
|
|
4879
|
+
return_type = opts[:debug_return_type] || 'SfvbElementsResponse'
|
|
4880
|
+
|
|
4881
|
+
# auth_names
|
|
4882
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4883
|
+
|
|
4884
|
+
new_options = opts.merge(
|
|
4885
|
+
:operation => :"SfvbApi.get_sfvb_cjson_used_elements",
|
|
4886
|
+
:header_params => header_params,
|
|
4887
|
+
:query_params => query_params,
|
|
4888
|
+
:form_params => form_params,
|
|
4889
|
+
:body => post_body,
|
|
4890
|
+
:auth_names => auth_names,
|
|
4891
|
+
:return_type => return_type
|
|
4892
|
+
)
|
|
4893
|
+
|
|
4894
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4895
|
+
if @api_client.config.debugging
|
|
4896
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_cjson_used_elements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4897
|
+
end
|
|
4898
|
+
return data, status_code, headers
|
|
4899
|
+
end
|
|
4900
|
+
|
|
4901
|
+
# Read one list and segment folder
|
|
4902
|
+
# The folder, with the name and uuid of each list and segment filed in it.
|
|
4903
|
+
# @param storefront_oid [Integer]
|
|
4904
|
+
# @param folder_uuid [String]
|
|
4905
|
+
# @param [Hash] opts the optional parameters
|
|
4906
|
+
# @return [SfvbCommsFolderResponse]
|
|
4907
|
+
def get_sfvb_comms_folder(storefront_oid, folder_uuid, opts = {})
|
|
4908
|
+
data, _status_code, _headers = get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts)
|
|
4909
|
+
data
|
|
4910
|
+
end
|
|
4911
|
+
|
|
4912
|
+
# Read one list and segment folder
|
|
4913
|
+
# The folder, with the name and uuid of each list and segment filed in it.
|
|
4914
|
+
# @param storefront_oid [Integer]
|
|
4915
|
+
# @param folder_uuid [String]
|
|
4916
|
+
# @param [Hash] opts the optional parameters
|
|
4917
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
4918
|
+
def get_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, opts = {})
|
|
4919
|
+
if @api_client.config.debugging
|
|
4920
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folder ...'
|
|
4921
|
+
end
|
|
4922
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4923
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4924
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folder"
|
|
4925
|
+
end
|
|
4926
|
+
# verify the required parameter 'folder_uuid' is set
|
|
4927
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
4928
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.get_sfvb_comms_folder"
|
|
4929
|
+
end
|
|
4930
|
+
# resource path
|
|
4931
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
|
|
4932
|
+
|
|
4933
|
+
# query parameters
|
|
4934
|
+
query_params = opts[:query_params] || {}
|
|
4935
|
+
|
|
4936
|
+
# header parameters
|
|
4937
|
+
header_params = opts[:header_params] || {}
|
|
4938
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4939
|
+
# HTTP header 'Accept' (if needed)
|
|
4940
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4941
|
+
|
|
4942
|
+
# form parameters
|
|
4943
|
+
form_params = opts[:form_params] || {}
|
|
4944
|
+
|
|
4945
|
+
# http body (model)
|
|
4946
|
+
post_body = opts[:debug_body]
|
|
4947
|
+
|
|
4948
|
+
# return_type
|
|
4949
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
4950
|
+
|
|
4951
|
+
# auth_names
|
|
4952
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4953
|
+
|
|
4954
|
+
new_options = opts.merge(
|
|
4955
|
+
:operation => :"SfvbApi.get_sfvb_comms_folder",
|
|
4956
|
+
:header_params => header_params,
|
|
4957
|
+
:query_params => query_params,
|
|
4958
|
+
:form_params => form_params,
|
|
4959
|
+
:body => post_body,
|
|
4960
|
+
:auth_names => auth_names,
|
|
4961
|
+
:return_type => return_type
|
|
4962
|
+
)
|
|
4963
|
+
|
|
4964
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4965
|
+
if @api_client.config.debugging
|
|
4966
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4967
|
+
end
|
|
4968
|
+
return data, status_code, headers
|
|
4969
|
+
end
|
|
4970
|
+
|
|
4971
|
+
# List the list and segment folders
|
|
4972
|
+
# Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
4973
|
+
# @param storefront_oid [Integer]
|
|
4974
|
+
# @param [Hash] opts the optional parameters
|
|
4975
|
+
# @return [SfvbCommsFoldersResponse]
|
|
4976
|
+
def get_sfvb_comms_folders(storefront_oid, opts = {})
|
|
4977
|
+
data, _status_code, _headers = get_sfvb_comms_folders_with_http_info(storefront_oid, opts)
|
|
4978
|
+
data
|
|
4979
|
+
end
|
|
4980
|
+
|
|
4981
|
+
# List the list and segment folders
|
|
4982
|
+
# Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
4983
|
+
# @param storefront_oid [Integer]
|
|
4984
|
+
# @param [Hash] opts the optional parameters
|
|
4985
|
+
# @return [Array<(SfvbCommsFoldersResponse, Integer, Hash)>] SfvbCommsFoldersResponse data, response status code and response headers
|
|
4986
|
+
def get_sfvb_comms_folders_with_http_info(storefront_oid, opts = {})
|
|
4987
|
+
if @api_client.config.debugging
|
|
4988
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_folders ...'
|
|
4989
|
+
end
|
|
4990
|
+
# verify the required parameter 'storefront_oid' is set
|
|
4991
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
4992
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_folders"
|
|
4993
|
+
end
|
|
4994
|
+
# resource path
|
|
4995
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
4996
|
+
|
|
4997
|
+
# query parameters
|
|
4998
|
+
query_params = opts[:query_params] || {}
|
|
4999
|
+
|
|
5000
|
+
# header parameters
|
|
5001
|
+
header_params = opts[:header_params] || {}
|
|
5002
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
5003
|
+
# HTTP header 'Accept' (if needed)
|
|
5004
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
5005
|
+
|
|
5006
|
+
# form parameters
|
|
5007
|
+
form_params = opts[:form_params] || {}
|
|
5008
|
+
|
|
5009
|
+
# http body (model)
|
|
5010
|
+
post_body = opts[:debug_body]
|
|
5011
|
+
|
|
5012
|
+
# return_type
|
|
5013
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFoldersResponse'
|
|
5014
|
+
|
|
5015
|
+
# auth_names
|
|
5016
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
5017
|
+
|
|
5018
|
+
new_options = opts.merge(
|
|
5019
|
+
:operation => :"SfvbApi.get_sfvb_comms_folders",
|
|
5020
|
+
:header_params => header_params,
|
|
5021
|
+
:query_params => query_params,
|
|
5022
|
+
:form_params => form_params,
|
|
5023
|
+
:body => post_body,
|
|
5024
|
+
:auth_names => auth_names,
|
|
5025
|
+
:return_type => return_type
|
|
5026
|
+
)
|
|
5027
|
+
|
|
5028
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
5029
|
+
if @api_client.config.debugging
|
|
5030
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5031
|
+
end
|
|
5032
|
+
return data, status_code, headers
|
|
5033
|
+
end
|
|
5034
|
+
|
|
5035
|
+
# Read one email list
|
|
5036
|
+
# The list's name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
5037
|
+
# @param storefront_oid [Integer]
|
|
5038
|
+
# @param list_uuid [String]
|
|
5039
|
+
# @param [Hash] opts the optional parameters
|
|
5040
|
+
# @return [SfvbCommsListResponse]
|
|
5041
|
+
def get_sfvb_comms_list(storefront_oid, list_uuid, opts = {})
|
|
5042
|
+
data, _status_code, _headers = get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts)
|
|
4399
5043
|
data
|
|
4400
5044
|
end
|
|
4401
5045
|
|
|
4402
|
-
#
|
|
4403
|
-
#
|
|
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]
|
|
4404
5050
|
# @param [Hash] opts the optional parameters
|
|
4405
|
-
# @return [Array<(
|
|
4406
|
-
def
|
|
5051
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
5052
|
+
def get_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, opts = {})
|
|
4407
5053
|
if @api_client.config.debugging
|
|
4408
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
5054
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_list ...'
|
|
4409
5055
|
end
|
|
4410
|
-
# verify the required parameter '
|
|
4411
|
-
if @api_client.config.client_side_validation &&
|
|
4412
|
-
fail ArgumentError, "Missing the required parameter '
|
|
5056
|
+
# verify the required parameter 'storefront_oid' is set
|
|
5057
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
5058
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_list"
|
|
5059
|
+
end
|
|
5060
|
+
# verify the required parameter 'list_uuid' is set
|
|
5061
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
5062
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.get_sfvb_comms_list"
|
|
4413
5063
|
end
|
|
4414
5064
|
# resource path
|
|
4415
|
-
local_var_path = '/sfvb/
|
|
5065
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
4416
5066
|
|
|
4417
5067
|
# query parameters
|
|
4418
5068
|
query_params = opts[:query_params] || {}
|
|
@@ -4422,26 +5072,21 @@ module UltracartClient
|
|
|
4422
5072
|
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
4423
5073
|
# HTTP header 'Accept' (if needed)
|
|
4424
5074
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4425
|
-
# HTTP header 'Content-Type'
|
|
4426
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4427
|
-
if !content_type.nil?
|
|
4428
|
-
header_params['Content-Type'] = content_type
|
|
4429
|
-
end
|
|
4430
5075
|
|
|
4431
5076
|
# form parameters
|
|
4432
5077
|
form_params = opts[:form_params] || {}
|
|
4433
5078
|
|
|
4434
5079
|
# http body (model)
|
|
4435
|
-
post_body = opts[:debug_body]
|
|
5080
|
+
post_body = opts[:debug_body]
|
|
4436
5081
|
|
|
4437
5082
|
# return_type
|
|
4438
|
-
return_type = opts[:debug_return_type] || '
|
|
5083
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
4439
5084
|
|
|
4440
5085
|
# auth_names
|
|
4441
5086
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
4442
5087
|
|
|
4443
5088
|
new_options = opts.merge(
|
|
4444
|
-
:operation => :"SfvbApi.
|
|
5089
|
+
:operation => :"SfvbApi.get_sfvb_comms_list",
|
|
4445
5090
|
:header_params => header_params,
|
|
4446
5091
|
:query_params => query_params,
|
|
4447
5092
|
:form_params => form_params,
|
|
@@ -4450,9 +5095,9 @@ module UltracartClient
|
|
|
4450
5095
|
:return_type => return_type
|
|
4451
5096
|
)
|
|
4452
5097
|
|
|
4453
|
-
data, status_code, headers = @api_client.call_api(:
|
|
5098
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
4454
5099
|
if @api_client.config.debugging
|
|
4455
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
5100
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4456
5101
|
end
|
|
4457
5102
|
return data, status_code, headers
|
|
4458
5103
|
end
|
|
@@ -6662,6 +7307,70 @@ module UltracartClient
|
|
|
6662
7307
|
return data, status_code, headers
|
|
6663
7308
|
end
|
|
6664
7309
|
|
|
7310
|
+
# The 404 log's trend
|
|
7311
|
+
# The admin's 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
7312
|
+
# @param storefront_oid [Integer]
|
|
7313
|
+
# @param [Hash] opts the optional parameters
|
|
7314
|
+
# @return [SfvbNotFoundSummary]
|
|
7315
|
+
def get_sfvb_not_found_summary(storefront_oid, opts = {})
|
|
7316
|
+
data, _status_code, _headers = get_sfvb_not_found_summary_with_http_info(storefront_oid, opts)
|
|
7317
|
+
data
|
|
7318
|
+
end
|
|
7319
|
+
|
|
7320
|
+
# The 404 log's trend
|
|
7321
|
+
# The admin's 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
7322
|
+
# @param storefront_oid [Integer]
|
|
7323
|
+
# @param [Hash] opts the optional parameters
|
|
7324
|
+
# @return [Array<(SfvbNotFoundSummary, Integer, Hash)>] SfvbNotFoundSummary data, response status code and response headers
|
|
7325
|
+
def get_sfvb_not_found_summary_with_http_info(storefront_oid, opts = {})
|
|
7326
|
+
if @api_client.config.debugging
|
|
7327
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_not_found_summary ...'
|
|
7328
|
+
end
|
|
7329
|
+
# verify the required parameter 'storefront_oid' is set
|
|
7330
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
7331
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_not_found_summary"
|
|
7332
|
+
end
|
|
7333
|
+
# resource path
|
|
7334
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/not_found/summary'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
7335
|
+
|
|
7336
|
+
# query parameters
|
|
7337
|
+
query_params = opts[:query_params] || {}
|
|
7338
|
+
|
|
7339
|
+
# header parameters
|
|
7340
|
+
header_params = opts[:header_params] || {}
|
|
7341
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
7342
|
+
# HTTP header 'Accept' (if needed)
|
|
7343
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
7344
|
+
|
|
7345
|
+
# form parameters
|
|
7346
|
+
form_params = opts[:form_params] || {}
|
|
7347
|
+
|
|
7348
|
+
# http body (model)
|
|
7349
|
+
post_body = opts[:debug_body]
|
|
7350
|
+
|
|
7351
|
+
# return_type
|
|
7352
|
+
return_type = opts[:debug_return_type] || 'SfvbNotFoundSummary'
|
|
7353
|
+
|
|
7354
|
+
# auth_names
|
|
7355
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
7356
|
+
|
|
7357
|
+
new_options = opts.merge(
|
|
7358
|
+
:operation => :"SfvbApi.get_sfvb_not_found_summary",
|
|
7359
|
+
:header_params => header_params,
|
|
7360
|
+
:query_params => query_params,
|
|
7361
|
+
:form_params => form_params,
|
|
7362
|
+
:body => post_body,
|
|
7363
|
+
:auth_names => auth_names,
|
|
7364
|
+
:return_type => return_type
|
|
7365
|
+
)
|
|
7366
|
+
|
|
7367
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
7368
|
+
if @api_client.config.debugging
|
|
7369
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_not_found_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
7370
|
+
end
|
|
7371
|
+
return data, status_code, headers
|
|
7372
|
+
end
|
|
7373
|
+
|
|
6665
7374
|
# Read a page's attributes and images
|
|
6666
7375
|
# What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
|
|
6667
7376
|
# @param storefront_oid [Integer]
|
|
@@ -7847,6 +8556,70 @@ module UltracartClient
|
|
|
7847
8556
|
return data, status_code, headers
|
|
7848
8557
|
end
|
|
7849
8558
|
|
|
8559
|
+
# Read a storefront's search engine settings
|
|
8560
|
+
# Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
8561
|
+
# @param storefront_oid [Integer]
|
|
8562
|
+
# @param [Hash] opts the optional parameters
|
|
8563
|
+
# @return [SfvbSiteSeo]
|
|
8564
|
+
def get_sfvb_site_seo(storefront_oid, opts = {})
|
|
8565
|
+
data, _status_code, _headers = get_sfvb_site_seo_with_http_info(storefront_oid, opts)
|
|
8566
|
+
data
|
|
8567
|
+
end
|
|
8568
|
+
|
|
8569
|
+
# Read a storefront's search engine settings
|
|
8570
|
+
# Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
8571
|
+
# @param storefront_oid [Integer]
|
|
8572
|
+
# @param [Hash] opts the optional parameters
|
|
8573
|
+
# @return [Array<(SfvbSiteSeo, Integer, Hash)>] SfvbSiteSeo data, response status code and response headers
|
|
8574
|
+
def get_sfvb_site_seo_with_http_info(storefront_oid, opts = {})
|
|
8575
|
+
if @api_client.config.debugging
|
|
8576
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_site_seo ...'
|
|
8577
|
+
end
|
|
8578
|
+
# verify the required parameter 'storefront_oid' is set
|
|
8579
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
8580
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_site_seo"
|
|
8581
|
+
end
|
|
8582
|
+
# resource path
|
|
8583
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/seo'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
8584
|
+
|
|
8585
|
+
# query parameters
|
|
8586
|
+
query_params = opts[:query_params] || {}
|
|
8587
|
+
|
|
8588
|
+
# header parameters
|
|
8589
|
+
header_params = opts[:header_params] || {}
|
|
8590
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
8591
|
+
# HTTP header 'Accept' (if needed)
|
|
8592
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
8593
|
+
|
|
8594
|
+
# form parameters
|
|
8595
|
+
form_params = opts[:form_params] || {}
|
|
8596
|
+
|
|
8597
|
+
# http body (model)
|
|
8598
|
+
post_body = opts[:debug_body]
|
|
8599
|
+
|
|
8600
|
+
# return_type
|
|
8601
|
+
return_type = opts[:debug_return_type] || 'SfvbSiteSeo'
|
|
8602
|
+
|
|
8603
|
+
# auth_names
|
|
8604
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
8605
|
+
|
|
8606
|
+
new_options = opts.merge(
|
|
8607
|
+
:operation => :"SfvbApi.get_sfvb_site_seo",
|
|
8608
|
+
:header_params => header_params,
|
|
8609
|
+
:query_params => query_params,
|
|
8610
|
+
:form_params => form_params,
|
|
8611
|
+
:body => post_body,
|
|
8612
|
+
:auth_names => auth_names,
|
|
8613
|
+
:return_type => return_type
|
|
8614
|
+
)
|
|
8615
|
+
|
|
8616
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
8617
|
+
if @api_client.config.debugging
|
|
8618
|
+
@api_client.config.logger.debug "API called: SfvbApi#get_sfvb_site_seo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
8619
|
+
end
|
|
8620
|
+
return data, status_code, headers
|
|
8621
|
+
end
|
|
8622
|
+
|
|
7850
8623
|
# Read a storefront's sitemaps and robots.txt
|
|
7851
8624
|
# The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
|
|
7852
8625
|
# @param storefront_oid [Integer]
|
|
@@ -9362,42 +10135,192 @@ module UltracartClient
|
|
|
9362
10135
|
|
|
9363
10136
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9364
10137
|
if @api_client.config.debugging
|
|
9365
|
-
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10138
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_approval\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10139
|
+
end
|
|
10140
|
+
return data, status_code, headers
|
|
10141
|
+
end
|
|
10142
|
+
|
|
10143
|
+
# Create a blog post
|
|
10144
|
+
# 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.
|
|
10145
|
+
# @param storefront_oid [Integer]
|
|
10146
|
+
# @param blog_post_request [SfvbBlogPostRequest] The blog post to create
|
|
10147
|
+
# @param [Hash] opts the optional parameters
|
|
10148
|
+
# @return [SfvbBlogPostDetail]
|
|
10149
|
+
def insert_sfvb_blog_post(storefront_oid, blog_post_request, opts = {})
|
|
10150
|
+
data, _status_code, _headers = insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts)
|
|
10151
|
+
data
|
|
10152
|
+
end
|
|
10153
|
+
|
|
10154
|
+
# Create a blog post
|
|
10155
|
+
# 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.
|
|
10156
|
+
# @param storefront_oid [Integer]
|
|
10157
|
+
# @param blog_post_request [SfvbBlogPostRequest] The blog post to create
|
|
10158
|
+
# @param [Hash] opts the optional parameters
|
|
10159
|
+
# @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
|
|
10160
|
+
def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
|
|
10161
|
+
if @api_client.config.debugging
|
|
10162
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
|
|
10163
|
+
end
|
|
10164
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10165
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10166
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
|
|
10167
|
+
end
|
|
10168
|
+
# verify the required parameter 'blog_post_request' is set
|
|
10169
|
+
if @api_client.config.client_side_validation && blog_post_request.nil?
|
|
10170
|
+
fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
|
|
10171
|
+
end
|
|
10172
|
+
# resource path
|
|
10173
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
10174
|
+
|
|
10175
|
+
# query parameters
|
|
10176
|
+
query_params = opts[:query_params] || {}
|
|
10177
|
+
|
|
10178
|
+
# header parameters
|
|
10179
|
+
header_params = opts[:header_params] || {}
|
|
10180
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10181
|
+
# HTTP header 'Accept' (if needed)
|
|
10182
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10183
|
+
# HTTP header 'Content-Type'
|
|
10184
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
10185
|
+
if !content_type.nil?
|
|
10186
|
+
header_params['Content-Type'] = content_type
|
|
10187
|
+
end
|
|
10188
|
+
|
|
10189
|
+
# form parameters
|
|
10190
|
+
form_params = opts[:form_params] || {}
|
|
10191
|
+
|
|
10192
|
+
# http body (model)
|
|
10193
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
|
|
10194
|
+
|
|
10195
|
+
# return_type
|
|
10196
|
+
return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
|
|
10197
|
+
|
|
10198
|
+
# auth_names
|
|
10199
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10200
|
+
|
|
10201
|
+
new_options = opts.merge(
|
|
10202
|
+
:operation => :"SfvbApi.insert_sfvb_blog_post",
|
|
10203
|
+
:header_params => header_params,
|
|
10204
|
+
:query_params => query_params,
|
|
10205
|
+
:form_params => form_params,
|
|
10206
|
+
:body => post_body,
|
|
10207
|
+
:auth_names => auth_names,
|
|
10208
|
+
:return_type => return_type
|
|
10209
|
+
)
|
|
10210
|
+
|
|
10211
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10212
|
+
if @api_client.config.debugging
|
|
10213
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
10214
|
+
end
|
|
10215
|
+
return data, status_code, headers
|
|
10216
|
+
end
|
|
10217
|
+
|
|
10218
|
+
# Create a list and segment folder
|
|
10219
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10220
|
+
# @param storefront_oid [Integer]
|
|
10221
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
10222
|
+
# @param [Hash] opts the optional parameters
|
|
10223
|
+
# @return [SfvbCommsFolderResponse]
|
|
10224
|
+
def insert_sfvb_comms_folder(storefront_oid, folder_write_request, opts = {})
|
|
10225
|
+
data, _status_code, _headers = insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts)
|
|
10226
|
+
data
|
|
10227
|
+
end
|
|
10228
|
+
|
|
10229
|
+
# Create a list and segment folder
|
|
10230
|
+
# A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
10231
|
+
# @param storefront_oid [Integer]
|
|
10232
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new folder's name
|
|
10233
|
+
# @param [Hash] opts the optional parameters
|
|
10234
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
10235
|
+
def insert_sfvb_comms_folder_with_http_info(storefront_oid, folder_write_request, opts = {})
|
|
10236
|
+
if @api_client.config.debugging
|
|
10237
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_folder ...'
|
|
10238
|
+
end
|
|
10239
|
+
# verify the required parameter 'storefront_oid' is set
|
|
10240
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
10241
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
10242
|
+
end
|
|
10243
|
+
# verify the required parameter 'folder_write_request' is set
|
|
10244
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
10245
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.insert_sfvb_comms_folder"
|
|
10246
|
+
end
|
|
10247
|
+
# resource path
|
|
10248
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
10249
|
+
|
|
10250
|
+
# query parameters
|
|
10251
|
+
query_params = opts[:query_params] || {}
|
|
10252
|
+
|
|
10253
|
+
# header parameters
|
|
10254
|
+
header_params = opts[:header_params] || {}
|
|
10255
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
10256
|
+
# HTTP header 'Accept' (if needed)
|
|
10257
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
10258
|
+
# HTTP header 'Content-Type'
|
|
10259
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
10260
|
+
if !content_type.nil?
|
|
10261
|
+
header_params['Content-Type'] = content_type
|
|
10262
|
+
end
|
|
10263
|
+
|
|
10264
|
+
# form parameters
|
|
10265
|
+
form_params = opts[:form_params] || {}
|
|
10266
|
+
|
|
10267
|
+
# http body (model)
|
|
10268
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
10269
|
+
|
|
10270
|
+
# return_type
|
|
10271
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
10272
|
+
|
|
10273
|
+
# auth_names
|
|
10274
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
10275
|
+
|
|
10276
|
+
new_options = opts.merge(
|
|
10277
|
+
:operation => :"SfvbApi.insert_sfvb_comms_folder",
|
|
10278
|
+
:header_params => header_params,
|
|
10279
|
+
:query_params => query_params,
|
|
10280
|
+
:form_params => form_params,
|
|
10281
|
+
:body => post_body,
|
|
10282
|
+
:auth_names => auth_names,
|
|
10283
|
+
:return_type => return_type
|
|
10284
|
+
)
|
|
10285
|
+
|
|
10286
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
10287
|
+
if @api_client.config.debugging
|
|
10288
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9366
10289
|
end
|
|
9367
10290
|
return data, status_code, headers
|
|
9368
10291
|
end
|
|
9369
10292
|
|
|
9370
|
-
# Create
|
|
9371
|
-
#
|
|
10293
|
+
# Create an email list
|
|
10294
|
+
# A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
9372
10295
|
# @param storefront_oid [Integer]
|
|
9373
|
-
# @param
|
|
10296
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
9374
10297
|
# @param [Hash] opts the optional parameters
|
|
9375
|
-
# @return [
|
|
9376
|
-
def
|
|
9377
|
-
data, _status_code, _headers =
|
|
10298
|
+
# @return [SfvbCommsListResponse]
|
|
10299
|
+
def insert_sfvb_comms_list(storefront_oid, list_write_request, opts = {})
|
|
10300
|
+
data, _status_code, _headers = insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts)
|
|
9378
10301
|
data
|
|
9379
10302
|
end
|
|
9380
10303
|
|
|
9381
|
-
# Create
|
|
9382
|
-
#
|
|
10304
|
+
# Create an email list
|
|
10305
|
+
# A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
9383
10306
|
# @param storefront_oid [Integer]
|
|
9384
|
-
# @param
|
|
10307
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The new list's name, folder and public settings
|
|
9385
10308
|
# @param [Hash] opts the optional parameters
|
|
9386
|
-
# @return [Array<(
|
|
9387
|
-
def
|
|
10309
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
10310
|
+
def insert_sfvb_comms_list_with_http_info(storefront_oid, list_write_request, opts = {})
|
|
9388
10311
|
if @api_client.config.debugging
|
|
9389
|
-
@api_client.config.logger.debug 'Calling API: SfvbApi.
|
|
10312
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_list ...'
|
|
9390
10313
|
end
|
|
9391
10314
|
# verify the required parameter 'storefront_oid' is set
|
|
9392
10315
|
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
9393
|
-
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.
|
|
10316
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_list"
|
|
9394
10317
|
end
|
|
9395
|
-
# verify the required parameter '
|
|
9396
|
-
if @api_client.config.client_side_validation &&
|
|
9397
|
-
fail ArgumentError, "Missing the required parameter '
|
|
10318
|
+
# verify the required parameter 'list_write_request' is set
|
|
10319
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
10320
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.insert_sfvb_comms_list"
|
|
9398
10321
|
end
|
|
9399
10322
|
# resource path
|
|
9400
|
-
local_var_path = '/sfvb/storefronts/{storefront_oid}/
|
|
10323
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
9401
10324
|
|
|
9402
10325
|
# query parameters
|
|
9403
10326
|
query_params = opts[:query_params] || {}
|
|
@@ -9408,7 +10331,7 @@ module UltracartClient
|
|
|
9408
10331
|
# HTTP header 'Accept' (if needed)
|
|
9409
10332
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9410
10333
|
# HTTP header 'Content-Type'
|
|
9411
|
-
content_type = @api_client.select_header_content_type(['application/json
|
|
10334
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
9412
10335
|
if !content_type.nil?
|
|
9413
10336
|
header_params['Content-Type'] = content_type
|
|
9414
10337
|
end
|
|
@@ -9417,16 +10340,16 @@ module UltracartClient
|
|
|
9417
10340
|
form_params = opts[:form_params] || {}
|
|
9418
10341
|
|
|
9419
10342
|
# http body (model)
|
|
9420
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
10343
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
9421
10344
|
|
|
9422
10345
|
# return_type
|
|
9423
|
-
return_type = opts[:debug_return_type] || '
|
|
10346
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
9424
10347
|
|
|
9425
10348
|
# auth_names
|
|
9426
10349
|
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
9427
10350
|
|
|
9428
10351
|
new_options = opts.merge(
|
|
9429
|
-
:operation => :"SfvbApi.
|
|
10352
|
+
:operation => :"SfvbApi.insert_sfvb_comms_list",
|
|
9430
10353
|
:header_params => header_params,
|
|
9431
10354
|
:query_params => query_params,
|
|
9432
10355
|
:form_params => form_params,
|
|
@@ -9437,7 +10360,7 @@ module UltracartClient
|
|
|
9437
10360
|
|
|
9438
10361
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9439
10362
|
if @api_client.config.debugging
|
|
9440
|
-
@api_client.config.logger.debug "API called: SfvbApi#
|
|
10363
|
+
@api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9441
10364
|
end
|
|
9442
10365
|
return data, status_code, headers
|
|
9443
10366
|
end
|
|
@@ -14618,6 +15541,81 @@ module UltracartClient
|
|
|
14618
15541
|
return data, status_code, headers
|
|
14619
15542
|
end
|
|
14620
15543
|
|
|
15544
|
+
# What a shopper gets for each of many paths
|
|
15545
|
+
# Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
15546
|
+
# @param storefront_oid [Integer]
|
|
15547
|
+
# @param redirect_resolve_batch_request [SfvbRedirectResolveBatchRequest] The paths
|
|
15548
|
+
# @param [Hash] opts the optional parameters
|
|
15549
|
+
# @return [SfvbRedirectResolveBatchResponse]
|
|
15550
|
+
def resolve_sfvb_redirect_batch(storefront_oid, redirect_resolve_batch_request, opts = {})
|
|
15551
|
+
data, _status_code, _headers = resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request, opts)
|
|
15552
|
+
data
|
|
15553
|
+
end
|
|
15554
|
+
|
|
15555
|
+
# What a shopper gets for each of many paths
|
|
15556
|
+
# Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
15557
|
+
# @param storefront_oid [Integer]
|
|
15558
|
+
# @param redirect_resolve_batch_request [SfvbRedirectResolveBatchRequest] The paths
|
|
15559
|
+
# @param [Hash] opts the optional parameters
|
|
15560
|
+
# @return [Array<(SfvbRedirectResolveBatchResponse, Integer, Hash)>] SfvbRedirectResolveBatchResponse data, response status code and response headers
|
|
15561
|
+
def resolve_sfvb_redirect_batch_with_http_info(storefront_oid, redirect_resolve_batch_request, opts = {})
|
|
15562
|
+
if @api_client.config.debugging
|
|
15563
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.resolve_sfvb_redirect_batch ...'
|
|
15564
|
+
end
|
|
15565
|
+
# verify the required parameter 'storefront_oid' is set
|
|
15566
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
15567
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.resolve_sfvb_redirect_batch"
|
|
15568
|
+
end
|
|
15569
|
+
# verify the required parameter 'redirect_resolve_batch_request' is set
|
|
15570
|
+
if @api_client.config.client_side_validation && redirect_resolve_batch_request.nil?
|
|
15571
|
+
fail ArgumentError, "Missing the required parameter 'redirect_resolve_batch_request' when calling SfvbApi.resolve_sfvb_redirect_batch"
|
|
15572
|
+
end
|
|
15573
|
+
# resource path
|
|
15574
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/redirects/resolve_batch'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
15575
|
+
|
|
15576
|
+
# query parameters
|
|
15577
|
+
query_params = opts[:query_params] || {}
|
|
15578
|
+
|
|
15579
|
+
# header parameters
|
|
15580
|
+
header_params = opts[:header_params] || {}
|
|
15581
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
15582
|
+
# HTTP header 'Accept' (if needed)
|
|
15583
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
15584
|
+
# HTTP header 'Content-Type'
|
|
15585
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
15586
|
+
if !content_type.nil?
|
|
15587
|
+
header_params['Content-Type'] = content_type
|
|
15588
|
+
end
|
|
15589
|
+
|
|
15590
|
+
# form parameters
|
|
15591
|
+
form_params = opts[:form_params] || {}
|
|
15592
|
+
|
|
15593
|
+
# http body (model)
|
|
15594
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(redirect_resolve_batch_request)
|
|
15595
|
+
|
|
15596
|
+
# return_type
|
|
15597
|
+
return_type = opts[:debug_return_type] || 'SfvbRedirectResolveBatchResponse'
|
|
15598
|
+
|
|
15599
|
+
# auth_names
|
|
15600
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
15601
|
+
|
|
15602
|
+
new_options = opts.merge(
|
|
15603
|
+
:operation => :"SfvbApi.resolve_sfvb_redirect_batch",
|
|
15604
|
+
:header_params => header_params,
|
|
15605
|
+
:query_params => query_params,
|
|
15606
|
+
:form_params => form_params,
|
|
15607
|
+
:body => post_body,
|
|
15608
|
+
:auth_names => auth_names,
|
|
15609
|
+
:return_type => return_type
|
|
15610
|
+
)
|
|
15611
|
+
|
|
15612
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
15613
|
+
if @api_client.config.debugging
|
|
15614
|
+
@api_client.config.logger.debug "API called: SfvbApi#resolve_sfvb_redirect_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
15615
|
+
end
|
|
15616
|
+
return data, status_code, headers
|
|
15617
|
+
end
|
|
15618
|
+
|
|
14621
15619
|
# Resolve a template name to the file a page renders
|
|
14622
15620
|
# A page stores only its template's file name. This runs the storefront's own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme's resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
14623
15621
|
# @param storefront_oid [Integer]
|
|
@@ -16044,6 +17042,182 @@ module UltracartClient
|
|
|
16044
17042
|
return data, status_code, headers
|
|
16045
17043
|
end
|
|
16046
17044
|
|
|
17045
|
+
# Rename a list and segment folder
|
|
17046
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17047
|
+
# @param storefront_oid [Integer]
|
|
17048
|
+
# @param folder_uuid [String]
|
|
17049
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17050
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17051
|
+
# @param [Hash] opts the optional parameters
|
|
17052
|
+
# @return [SfvbCommsFolderResponse]
|
|
17053
|
+
def update_sfvb_comms_folder(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17054
|
+
data, _status_code, _headers = update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts)
|
|
17055
|
+
data
|
|
17056
|
+
end
|
|
17057
|
+
|
|
17058
|
+
# Rename a list and segment folder
|
|
17059
|
+
# Send the folder's hash_sha256 as If-Match. A folder the admin made itself (system_generated) can't be renamed here.
|
|
17060
|
+
# @param storefront_oid [Integer]
|
|
17061
|
+
# @param folder_uuid [String]
|
|
17062
|
+
# @param if_match [String] The folder's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17063
|
+
# @param folder_write_request [SfvbCommsFolderWriteRequest] The new name
|
|
17064
|
+
# @param [Hash] opts the optional parameters
|
|
17065
|
+
# @return [Array<(SfvbCommsFolderResponse, Integer, Hash)>] SfvbCommsFolderResponse data, response status code and response headers
|
|
17066
|
+
def update_sfvb_comms_folder_with_http_info(storefront_oid, folder_uuid, if_match, folder_write_request, opts = {})
|
|
17067
|
+
if @api_client.config.debugging
|
|
17068
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_folder ...'
|
|
17069
|
+
end
|
|
17070
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17071
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17072
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17073
|
+
end
|
|
17074
|
+
# verify the required parameter 'folder_uuid' is set
|
|
17075
|
+
if @api_client.config.client_side_validation && folder_uuid.nil?
|
|
17076
|
+
fail ArgumentError, "Missing the required parameter 'folder_uuid' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17077
|
+
end
|
|
17078
|
+
# verify the required parameter 'if_match' is set
|
|
17079
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17080
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17081
|
+
end
|
|
17082
|
+
# verify the required parameter 'folder_write_request' is set
|
|
17083
|
+
if @api_client.config.client_side_validation && folder_write_request.nil?
|
|
17084
|
+
fail ArgumentError, "Missing the required parameter 'folder_write_request' when calling SfvbApi.update_sfvb_comms_folder"
|
|
17085
|
+
end
|
|
17086
|
+
# resource path
|
|
17087
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/list_segment_folders/{folder_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'folder_uuid' + '}', CGI.escape(folder_uuid.to_s))
|
|
17088
|
+
|
|
17089
|
+
# query parameters
|
|
17090
|
+
query_params = opts[:query_params] || {}
|
|
17091
|
+
|
|
17092
|
+
# header parameters
|
|
17093
|
+
header_params = opts[:header_params] || {}
|
|
17094
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17095
|
+
# HTTP header 'Accept' (if needed)
|
|
17096
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17097
|
+
# HTTP header 'Content-Type'
|
|
17098
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17099
|
+
if !content_type.nil?
|
|
17100
|
+
header_params['Content-Type'] = content_type
|
|
17101
|
+
end
|
|
17102
|
+
header_params[:'If-Match'] = if_match
|
|
17103
|
+
|
|
17104
|
+
# form parameters
|
|
17105
|
+
form_params = opts[:form_params] || {}
|
|
17106
|
+
|
|
17107
|
+
# http body (model)
|
|
17108
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(folder_write_request)
|
|
17109
|
+
|
|
17110
|
+
# return_type
|
|
17111
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsFolderResponse'
|
|
17112
|
+
|
|
17113
|
+
# auth_names
|
|
17114
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17115
|
+
|
|
17116
|
+
new_options = opts.merge(
|
|
17117
|
+
:operation => :"SfvbApi.update_sfvb_comms_folder",
|
|
17118
|
+
:header_params => header_params,
|
|
17119
|
+
:query_params => query_params,
|
|
17120
|
+
:form_params => form_params,
|
|
17121
|
+
:body => post_body,
|
|
17122
|
+
:auth_names => auth_names,
|
|
17123
|
+
:return_type => return_type
|
|
17124
|
+
)
|
|
17125
|
+
|
|
17126
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17127
|
+
if @api_client.config.debugging
|
|
17128
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17129
|
+
end
|
|
17130
|
+
return data, status_code, headers
|
|
17131
|
+
end
|
|
17132
|
+
|
|
17133
|
+
# Change an email list's name, folder or public settings
|
|
17134
|
+
# A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list's hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
17135
|
+
# @param storefront_oid [Integer]
|
|
17136
|
+
# @param list_uuid [String]
|
|
17137
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17138
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17139
|
+
# @param [Hash] opts the optional parameters
|
|
17140
|
+
# @return [SfvbCommsListResponse]
|
|
17141
|
+
def update_sfvb_comms_list(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17142
|
+
data, _status_code, _headers = update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts)
|
|
17143
|
+
data
|
|
17144
|
+
end
|
|
17145
|
+
|
|
17146
|
+
# Change an email list's name, folder or public settings
|
|
17147
|
+
# A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list's hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
17148
|
+
# @param storefront_oid [Integer]
|
|
17149
|
+
# @param list_uuid [String]
|
|
17150
|
+
# @param if_match [String] The list's hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
17151
|
+
# @param list_write_request [SfvbCommsListWriteRequest] The fields to change
|
|
17152
|
+
# @param [Hash] opts the optional parameters
|
|
17153
|
+
# @return [Array<(SfvbCommsListResponse, Integer, Hash)>] SfvbCommsListResponse data, response status code and response headers
|
|
17154
|
+
def update_sfvb_comms_list_with_http_info(storefront_oid, list_uuid, if_match, list_write_request, opts = {})
|
|
17155
|
+
if @api_client.config.debugging
|
|
17156
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_list ...'
|
|
17157
|
+
end
|
|
17158
|
+
# verify the required parameter 'storefront_oid' is set
|
|
17159
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
17160
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17161
|
+
end
|
|
17162
|
+
# verify the required parameter 'list_uuid' is set
|
|
17163
|
+
if @api_client.config.client_side_validation && list_uuid.nil?
|
|
17164
|
+
fail ArgumentError, "Missing the required parameter 'list_uuid' when calling SfvbApi.update_sfvb_comms_list"
|
|
17165
|
+
end
|
|
17166
|
+
# verify the required parameter 'if_match' is set
|
|
17167
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
17168
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_list"
|
|
17169
|
+
end
|
|
17170
|
+
# verify the required parameter 'list_write_request' is set
|
|
17171
|
+
if @api_client.config.client_side_validation && list_write_request.nil?
|
|
17172
|
+
fail ArgumentError, "Missing the required parameter 'list_write_request' when calling SfvbApi.update_sfvb_comms_list"
|
|
17173
|
+
end
|
|
17174
|
+
# resource path
|
|
17175
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/lists/{list_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'list_uuid' + '}', CGI.escape(list_uuid.to_s))
|
|
17176
|
+
|
|
17177
|
+
# query parameters
|
|
17178
|
+
query_params = opts[:query_params] || {}
|
|
17179
|
+
|
|
17180
|
+
# header parameters
|
|
17181
|
+
header_params = opts[:header_params] || {}
|
|
17182
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
17183
|
+
# HTTP header 'Accept' (if needed)
|
|
17184
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
17185
|
+
# HTTP header 'Content-Type'
|
|
17186
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
17187
|
+
if !content_type.nil?
|
|
17188
|
+
header_params['Content-Type'] = content_type
|
|
17189
|
+
end
|
|
17190
|
+
header_params[:'If-Match'] = if_match
|
|
17191
|
+
|
|
17192
|
+
# form parameters
|
|
17193
|
+
form_params = opts[:form_params] || {}
|
|
17194
|
+
|
|
17195
|
+
# http body (model)
|
|
17196
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_write_request)
|
|
17197
|
+
|
|
17198
|
+
# return_type
|
|
17199
|
+
return_type = opts[:debug_return_type] || 'SfvbCommsListResponse'
|
|
17200
|
+
|
|
17201
|
+
# auth_names
|
|
17202
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
17203
|
+
|
|
17204
|
+
new_options = opts.merge(
|
|
17205
|
+
:operation => :"SfvbApi.update_sfvb_comms_list",
|
|
17206
|
+
:header_params => header_params,
|
|
17207
|
+
:query_params => query_params,
|
|
17208
|
+
:form_params => form_params,
|
|
17209
|
+
:body => post_body,
|
|
17210
|
+
:auth_names => auth_names,
|
|
17211
|
+
:return_type => return_type
|
|
17212
|
+
)
|
|
17213
|
+
|
|
17214
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
17215
|
+
if @api_client.config.debugging
|
|
17216
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
17217
|
+
end
|
|
17218
|
+
return data, status_code, headers
|
|
17219
|
+
end
|
|
17220
|
+
|
|
16047
17221
|
# Change a segment's name, rule or folder
|
|
16048
17222
|
# A field left out stays as it is. Send the segment's hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read. A changed rule is checked as on a create and starts a rebuild. Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
|
|
16049
17223
|
# @param storefront_oid [Integer]
|
|
@@ -16368,7 +17542,7 @@ module UltracartClient
|
|
|
16368
17542
|
end
|
|
16369
17543
|
|
|
16370
17544
|
# Change a flow
|
|
16371
|
-
# A field left out keeps its value. The trigger and the status
|
|
17545
|
+
# A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
16372
17546
|
# @param storefront_oid [Integer]
|
|
16373
17547
|
# @param flow_uuid [String]
|
|
16374
17548
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
@@ -16381,7 +17555,7 @@ module UltracartClient
|
|
|
16381
17555
|
end
|
|
16382
17556
|
|
|
16383
17557
|
# Change a flow
|
|
16384
|
-
# A field left out keeps its value. The trigger and the status
|
|
17558
|
+
# A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
16385
17559
|
# @param storefront_oid [Integer]
|
|
16386
17560
|
# @param flow_uuid [String]
|
|
16387
17561
|
# @param if_match [String] hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
@@ -16894,6 +18068,91 @@ module UltracartClient
|
|
|
16894
18068
|
return data, status_code, headers
|
|
16895
18069
|
end
|
|
16896
18070
|
|
|
18071
|
+
# Change a storefront's search engine settings
|
|
18072
|
+
# A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
18073
|
+
# @param storefront_oid [Integer]
|
|
18074
|
+
# @param if_match [String] The hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
18075
|
+
# @param site_seo_request [SfvbSiteSeoRequest] The switches to change
|
|
18076
|
+
# @param [Hash] opts the optional parameters
|
|
18077
|
+
# @option opts [String] :approval_id When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals.
|
|
18078
|
+
# @return [SfvbSiteSeo]
|
|
18079
|
+
def update_sfvb_site_seo(storefront_oid, if_match, site_seo_request, opts = {})
|
|
18080
|
+
data, _status_code, _headers = update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts)
|
|
18081
|
+
data
|
|
18082
|
+
end
|
|
18083
|
+
|
|
18084
|
+
# Change a storefront's search engine settings
|
|
18085
|
+
# A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
18086
|
+
# @param storefront_oid [Integer]
|
|
18087
|
+
# @param if_match [String] The hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
18088
|
+
# @param site_seo_request [SfvbSiteSeoRequest] The switches to change
|
|
18089
|
+
# @param [Hash] opts the optional parameters
|
|
18090
|
+
# @option opts [String] :approval_id When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals.
|
|
18091
|
+
# @return [Array<(SfvbSiteSeo, Integer, Hash)>] SfvbSiteSeo data, response status code and response headers
|
|
18092
|
+
def update_sfvb_site_seo_with_http_info(storefront_oid, if_match, site_seo_request, opts = {})
|
|
18093
|
+
if @api_client.config.debugging
|
|
18094
|
+
@api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_site_seo ...'
|
|
18095
|
+
end
|
|
18096
|
+
# verify the required parameter 'storefront_oid' is set
|
|
18097
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
18098
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_site_seo"
|
|
18099
|
+
end
|
|
18100
|
+
# verify the required parameter 'if_match' is set
|
|
18101
|
+
if @api_client.config.client_side_validation && if_match.nil?
|
|
18102
|
+
fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_site_seo"
|
|
18103
|
+
end
|
|
18104
|
+
# verify the required parameter 'site_seo_request' is set
|
|
18105
|
+
if @api_client.config.client_side_validation && site_seo_request.nil?
|
|
18106
|
+
fail ArgumentError, "Missing the required parameter 'site_seo_request' when calling SfvbApi.update_sfvb_site_seo"
|
|
18107
|
+
end
|
|
18108
|
+
# resource path
|
|
18109
|
+
local_var_path = '/sfvb/storefronts/{storefront_oid}/seo'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
|
|
18110
|
+
|
|
18111
|
+
# query parameters
|
|
18112
|
+
query_params = opts[:query_params] || {}
|
|
18113
|
+
|
|
18114
|
+
# header parameters
|
|
18115
|
+
header_params = opts[:header_params] || {}
|
|
18116
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
18117
|
+
# HTTP header 'Accept' (if needed)
|
|
18118
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
18119
|
+
# HTTP header 'Content-Type'
|
|
18120
|
+
content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
18121
|
+
if !content_type.nil?
|
|
18122
|
+
header_params['Content-Type'] = content_type
|
|
18123
|
+
end
|
|
18124
|
+
header_params[:'If-Match'] = if_match
|
|
18125
|
+
header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
|
|
18126
|
+
|
|
18127
|
+
# form parameters
|
|
18128
|
+
form_params = opts[:form_params] || {}
|
|
18129
|
+
|
|
18130
|
+
# http body (model)
|
|
18131
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(site_seo_request)
|
|
18132
|
+
|
|
18133
|
+
# return_type
|
|
18134
|
+
return_type = opts[:debug_return_type] || 'SfvbSiteSeo'
|
|
18135
|
+
|
|
18136
|
+
# auth_names
|
|
18137
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
18138
|
+
|
|
18139
|
+
new_options = opts.merge(
|
|
18140
|
+
:operation => :"SfvbApi.update_sfvb_site_seo",
|
|
18141
|
+
:header_params => header_params,
|
|
18142
|
+
:query_params => query_params,
|
|
18143
|
+
:form_params => form_params,
|
|
18144
|
+
:body => post_body,
|
|
18145
|
+
:auth_names => auth_names,
|
|
18146
|
+
:return_type => return_type
|
|
18147
|
+
)
|
|
18148
|
+
|
|
18149
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
18150
|
+
if @api_client.config.debugging
|
|
18151
|
+
@api_client.config.logger.debug "API called: SfvbApi#update_sfvb_site_seo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
18152
|
+
end
|
|
18153
|
+
return data, status_code, headers
|
|
18154
|
+
end
|
|
18155
|
+
|
|
16897
18156
|
# Change a storefront's Smart Attribution configuration
|
|
16898
18157
|
# A partial update of the mode, model, global split and lookback. platforms, when sent, replaces the whole list. The global split must total exactly 1 and the lookback is 7 to 365. On an unconfigured storefront it creates the configuration. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, and when the mode is active or the change makes it active, an approved smart_attribution.change request for exactly this change (Approval-Id), because active mode decides which conversions each platform is sent. A change that stores what is already stored returns the configuration unchanged and uses no approval.
|
|
16899
18158
|
# @param storefront_oid [Integer]
|