ultracart_api 4.1.202 → 4.1.204

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +32 -2
  3. data/docs/SfvbApi.md +897 -39
  4. data/docs/SfvbApprovalParams.md +4 -0
  5. data/docs/SfvbCommsDnsRecord.md +24 -0
  6. data/docs/SfvbCommsSendingDomain.md +38 -0
  7. data/docs/SfvbCommsSendingDomainsResponse.md +18 -0
  8. data/docs/SfvbCommsTwilioAccount.md +38 -0
  9. data/docs/SfvbCommsTwilioAccountResponse.md +20 -0
  10. data/docs/SfvbEvent.md +2 -2
  11. data/docs/SfvbSecretHandle.md +32 -0
  12. data/docs/SfvbSecretKind.md +30 -0
  13. data/docs/SfvbSecretKindsResponse.md +20 -0
  14. data/docs/SfvbSecretRequest.md +54 -0
  15. data/docs/SfvbSecretRequestCreate.md +30 -0
  16. data/docs/SfvbSecretRequestsResponse.md +18 -0
  17. data/docs/SfvbSecretSink.md +24 -0
  18. data/lib/ultracart_api/api/sfvb_api.rb +1059 -28
  19. data/lib/ultracart_api/models/sfvb_approval_params.rb +21 -1
  20. data/lib/ultracart_api/models/sfvb_comms_dns_record.rb +296 -0
  21. data/lib/ultracart_api/models/sfvb_comms_sending_domain.rb +356 -0
  22. data/lib/ultracart_api/models/sfvb_comms_sending_domains_response.rb +222 -0
  23. data/lib/ultracart_api/models/sfvb_comms_twilio_account.rb +322 -0
  24. data/lib/ultracart_api/models/sfvb_comms_twilio_account_response.rb +231 -0
  25. data/lib/ultracart_api/models/sfvb_event.rb +2 -2
  26. data/lib/ultracart_api/models/sfvb_secret_handle.rb +324 -0
  27. data/lib/ultracart_api/models/sfvb_secret_kind.rb +280 -0
  28. data/lib/ultracart_api/models/sfvb_secret_kinds_response.rb +234 -0
  29. data/lib/ultracart_api/models/sfvb_secret_request.rb +440 -0
  30. data/lib/ultracart_api/models/sfvb_secret_request_create.rb +284 -0
  31. data/lib/ultracart_api/models/sfvb_secret_requests_response.rb +222 -0
  32. data/lib/ultracart_api/models/sfvb_secret_sink.rb +250 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +12 -0
  35. metadata +26 -2
@@ -644,7 +644,7 @@ module UltracartClient
644
644
  end
645
645
 
646
646
  # One time link that opens a preview in a browser with no UltraCart login
647
- # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Requires a token that resolves to a user, so use the device authorization flow.
647
+ # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
648
648
  # @param storefront_oid [Integer]
649
649
  # @param [Hash] opts the optional parameters
650
650
  # @option opts [SfvbPreviewAccessRequest] :preview_access What the browser should see
@@ -655,7 +655,7 @@ module UltracartClient
655
655
  end
656
656
 
657
657
  # One time link that opens a preview in a browser with no UltraCart login
658
- # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Requires a token that resolves to a user, so use the device authorization flow.
658
+ # The preview URL only works in a browser already signed in to UltraCart on the storefront's own host, and an agent's built in browser never is. This returns a single use access_url on the storefront host instead. Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path. It expires two minutes after issue or on first use. With a preview session, pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied. Without one, the pages are the live content and carry no X-UltraCart-Preview header. Requires a token that resolves to a user, so use the device authorization flow.
659
659
  # @param storefront_oid [Integer]
660
660
  # @param [Hash] opts the optional parameters
661
661
  # @option opts [SfvbPreviewAccessRequest] :preview_access What the browser should see
@@ -915,6 +915,134 @@ module UltracartClient
915
915
  return data, status_code, headers
916
916
  end
917
917
 
918
+ # Remove a sending domain
919
+ # Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
920
+ # @param domain [String]
921
+ # @param [Hash] opts the optional parameters
922
+ # @option opts [String] :approval_id The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
923
+ # @return [nil]
924
+ def delete_sfvb_comms_sending_domain(domain, opts = {})
925
+ delete_sfvb_comms_sending_domain_with_http_info(domain, opts)
926
+ nil
927
+ end
928
+
929
+ # Remove a sending domain
930
+ # Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
931
+ # @param domain [String]
932
+ # @param [Hash] opts the optional parameters
933
+ # @option opts [String] :approval_id The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
934
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
935
+ def delete_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
936
+ if @api_client.config.debugging
937
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_sending_domain ...'
938
+ end
939
+ # verify the required parameter 'domain' is set
940
+ if @api_client.config.client_side_validation && domain.nil?
941
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.delete_sfvb_comms_sending_domain"
942
+ end
943
+ # resource path
944
+ local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
945
+
946
+ # query parameters
947
+ query_params = opts[:query_params] || {}
948
+
949
+ # header parameters
950
+ header_params = opts[:header_params] || {}
951
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
952
+ # HTTP header 'Accept' (if needed)
953
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
954
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
955
+
956
+ # form parameters
957
+ form_params = opts[:form_params] || {}
958
+
959
+ # http body (model)
960
+ post_body = opts[:debug_body]
961
+
962
+ # return_type
963
+ return_type = opts[:debug_return_type]
964
+
965
+ # auth_names
966
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
967
+
968
+ new_options = opts.merge(
969
+ :operation => :"SfvbApi.delete_sfvb_comms_sending_domain",
970
+ :header_params => header_params,
971
+ :query_params => query_params,
972
+ :form_params => form_params,
973
+ :body => post_body,
974
+ :auth_names => auth_names,
975
+ :return_type => return_type
976
+ )
977
+
978
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
979
+ if @api_client.config.debugging
980
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
981
+ end
982
+ return data, status_code, headers
983
+ end
984
+
985
+ # Remove the Twilio account
986
+ # Removes the account's Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
987
+ # @param [Hash] opts the optional parameters
988
+ # @option opts [String] :approval_id The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
989
+ # @return [nil]
990
+ def delete_sfvb_comms_twilio_account(opts = {})
991
+ delete_sfvb_comms_twilio_account_with_http_info(opts)
992
+ nil
993
+ end
994
+
995
+ # Remove the Twilio account
996
+ # Removes the account&#39;s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
997
+ # @param [Hash] opts the optional parameters
998
+ # @option opts [String] :approval_id The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
999
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1000
+ def delete_sfvb_comms_twilio_account_with_http_info(opts = {})
1001
+ if @api_client.config.debugging
1002
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_comms_twilio_account ...'
1003
+ end
1004
+ # resource path
1005
+ local_var_path = '/sfvb/comms/twilio_account'
1006
+
1007
+ # query parameters
1008
+ query_params = opts[:query_params] || {}
1009
+
1010
+ # header parameters
1011
+ header_params = opts[:header_params] || {}
1012
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1013
+ # HTTP header 'Accept' (if needed)
1014
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1015
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
1016
+
1017
+ # form parameters
1018
+ form_params = opts[:form_params] || {}
1019
+
1020
+ # http body (model)
1021
+ post_body = opts[:debug_body]
1022
+
1023
+ # return_type
1024
+ return_type = opts[:debug_return_type]
1025
+
1026
+ # auth_names
1027
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1028
+
1029
+ new_options = opts.merge(
1030
+ :operation => :"SfvbApi.delete_sfvb_comms_twilio_account",
1031
+ :header_params => header_params,
1032
+ :query_params => query_params,
1033
+ :form_params => form_params,
1034
+ :body => post_body,
1035
+ :auth_names => auth_names,
1036
+ :return_type => return_type
1037
+ )
1038
+
1039
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1040
+ if @api_client.config.debugging
1041
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1042
+ end
1043
+ return data, status_code, headers
1044
+ end
1045
+
918
1046
  # Delete a storefront file
919
1047
  # Recoverable from the recycle bin.
920
1048
  # @param storefront_oid [Integer]
@@ -1524,6 +1652,70 @@ module UltracartClient
1524
1652
  return data, status_code, headers
1525
1653
  end
1526
1654
 
1655
+ # Cancel a pending secret request
1656
+ # Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
1657
+ # @param request_id [String]
1658
+ # @param [Hash] opts the optional parameters
1659
+ # @return [SfvbSecretRequest]
1660
+ def delete_sfvb_secret_request(request_id, opts = {})
1661
+ data, _status_code, _headers = delete_sfvb_secret_request_with_http_info(request_id, opts)
1662
+ data
1663
+ end
1664
+
1665
+ # Cancel a pending secret request
1666
+ # Withdraws a request nobody has filled in yet, with its handles, which frees one of the five pending slots a sign-in has. A fulfilled request cannot be cancelled; revoke its handles instead.
1667
+ # @param request_id [String]
1668
+ # @param [Hash] opts the optional parameters
1669
+ # @return [Array<(SfvbSecretRequest, Integer, Hash)>] SfvbSecretRequest data, response status code and response headers
1670
+ def delete_sfvb_secret_request_with_http_info(request_id, opts = {})
1671
+ if @api_client.config.debugging
1672
+ @api_client.config.logger.debug 'Calling API: SfvbApi.delete_sfvb_secret_request ...'
1673
+ end
1674
+ # verify the required parameter 'request_id' is set
1675
+ if @api_client.config.client_side_validation && request_id.nil?
1676
+ fail ArgumentError, "Missing the required parameter 'request_id' when calling SfvbApi.delete_sfvb_secret_request"
1677
+ end
1678
+ # resource path
1679
+ local_var_path = '/sfvb/secrets/{request_id}'.sub('{' + 'request_id' + '}', CGI.escape(request_id.to_s))
1680
+
1681
+ # query parameters
1682
+ query_params = opts[:query_params] || {}
1683
+
1684
+ # header parameters
1685
+ header_params = opts[:header_params] || {}
1686
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1687
+ # HTTP header 'Accept' (if needed)
1688
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1689
+
1690
+ # form parameters
1691
+ form_params = opts[:form_params] || {}
1692
+
1693
+ # http body (model)
1694
+ post_body = opts[:debug_body]
1695
+
1696
+ # return_type
1697
+ return_type = opts[:debug_return_type] || 'SfvbSecretRequest'
1698
+
1699
+ # auth_names
1700
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1701
+
1702
+ new_options = opts.merge(
1703
+ :operation => :"SfvbApi.delete_sfvb_secret_request",
1704
+ :header_params => header_params,
1705
+ :query_params => query_params,
1706
+ :form_params => form_params,
1707
+ :body => post_body,
1708
+ :auth_names => auth_names,
1709
+ :return_type => return_type
1710
+ )
1711
+
1712
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1713
+ if @api_client.config.debugging
1714
+ @api_client.config.logger.debug "API called: SfvbApi#delete_sfvb_secret_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1715
+ end
1716
+ return data, status_code, headers
1717
+ end
1718
+
1527
1719
  # Detach an image from a blog post
1528
1720
  # Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
1529
1721
  # @param storefront_oid [Integer]
@@ -3088,7 +3280,192 @@ module UltracartClient
3088
3280
  fail ArgumentError, "Missing the required parameter 'compile_request' when calling SfvbApi.get_sfvb_cjson_used_elements"
3089
3281
  end
3090
3282
  # resource path
3091
- local_var_path = '/sfvb/cjson/elements'
3283
+ local_var_path = '/sfvb/cjson/elements'
3284
+
3285
+ # query parameters
3286
+ query_params = opts[:query_params] || {}
3287
+
3288
+ # header parameters
3289
+ header_params = opts[:header_params] || {}
3290
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3291
+ # HTTP header 'Accept' (if needed)
3292
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3293
+ # HTTP header 'Content-Type'
3294
+ content_type = @api_client.select_header_content_type(['application/json'])
3295
+ if !content_type.nil?
3296
+ header_params['Content-Type'] = content_type
3297
+ end
3298
+
3299
+ # form parameters
3300
+ form_params = opts[:form_params] || {}
3301
+
3302
+ # http body (model)
3303
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(compile_request)
3304
+
3305
+ # return_type
3306
+ return_type = opts[:debug_return_type] || 'SfvbElementsResponse'
3307
+
3308
+ # auth_names
3309
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3310
+
3311
+ new_options = opts.merge(
3312
+ :operation => :"SfvbApi.get_sfvb_cjson_used_elements",
3313
+ :header_params => header_params,
3314
+ :query_params => query_params,
3315
+ :form_params => form_params,
3316
+ :body => post_body,
3317
+ :auth_names => auth_names,
3318
+ :return_type => return_type
3319
+ )
3320
+
3321
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3322
+ if @api_client.config.debugging
3323
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_cjson_used_elements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3324
+ end
3325
+ return data, status_code, headers
3326
+ end
3327
+
3328
+ # Read a sending domain
3329
+ # One sending domain as stored. To check an amazon domain's DNS again, use the status call.
3330
+ # @param domain [String]
3331
+ # @param [Hash] opts the optional parameters
3332
+ # @return [SfvbCommsSendingDomain]
3333
+ def get_sfvb_comms_sending_domain(domain, opts = {})
3334
+ data, _status_code, _headers = get_sfvb_comms_sending_domain_with_http_info(domain, opts)
3335
+ data
3336
+ end
3337
+
3338
+ # Read a sending domain
3339
+ # One sending domain as stored. To check an amazon domain&#39;s DNS again, use the status call.
3340
+ # @param domain [String]
3341
+ # @param [Hash] opts the optional parameters
3342
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
3343
+ def get_sfvb_comms_sending_domain_with_http_info(domain, opts = {})
3344
+ if @api_client.config.debugging
3345
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domain ...'
3346
+ end
3347
+ # verify the required parameter 'domain' is set
3348
+ if @api_client.config.client_side_validation && domain.nil?
3349
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.get_sfvb_comms_sending_domain"
3350
+ end
3351
+ # resource path
3352
+ local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
3353
+
3354
+ # query parameters
3355
+ query_params = opts[:query_params] || {}
3356
+
3357
+ # header parameters
3358
+ header_params = opts[:header_params] || {}
3359
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3360
+ # HTTP header 'Accept' (if needed)
3361
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3362
+
3363
+ # form parameters
3364
+ form_params = opts[:form_params] || {}
3365
+
3366
+ # http body (model)
3367
+ post_body = opts[:debug_body]
3368
+
3369
+ # return_type
3370
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
3371
+
3372
+ # auth_names
3373
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3374
+
3375
+ new_options = opts.merge(
3376
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domain",
3377
+ :header_params => header_params,
3378
+ :query_params => query_params,
3379
+ :form_params => form_params,
3380
+ :body => post_body,
3381
+ :auth_names => auth_names,
3382
+ :return_type => return_type
3383
+ )
3384
+
3385
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3386
+ if @api_client.config.debugging
3387
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3388
+ end
3389
+ return data, status_code, headers
3390
+ end
3391
+
3392
+ # List the sending domains
3393
+ # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
3394
+ # @param [Hash] opts the optional parameters
3395
+ # @return [SfvbCommsSendingDomainsResponse]
3396
+ def get_sfvb_comms_sending_domains(opts = {})
3397
+ data, _status_code, _headers = get_sfvb_comms_sending_domains_with_http_info(opts)
3398
+ data
3399
+ end
3400
+
3401
+ # List the sending domains
3402
+ # Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
3403
+ # @param [Hash] opts the optional parameters
3404
+ # @return [Array<(SfvbCommsSendingDomainsResponse, Integer, Hash)>] SfvbCommsSendingDomainsResponse data, response status code and response headers
3405
+ def get_sfvb_comms_sending_domains_with_http_info(opts = {})
3406
+ if @api_client.config.debugging
3407
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_sending_domains ...'
3408
+ end
3409
+ # resource path
3410
+ local_var_path = '/sfvb/comms/sending_domains'
3411
+
3412
+ # query parameters
3413
+ query_params = opts[:query_params] || {}
3414
+
3415
+ # header parameters
3416
+ header_params = opts[:header_params] || {}
3417
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3418
+ # HTTP header 'Accept' (if needed)
3419
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3420
+
3421
+ # form parameters
3422
+ form_params = opts[:form_params] || {}
3423
+
3424
+ # http body (model)
3425
+ post_body = opts[:debug_body]
3426
+
3427
+ # return_type
3428
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomainsResponse'
3429
+
3430
+ # auth_names
3431
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3432
+
3433
+ new_options = opts.merge(
3434
+ :operation => :"SfvbApi.get_sfvb_comms_sending_domains",
3435
+ :header_params => header_params,
3436
+ :query_params => query_params,
3437
+ :form_params => form_params,
3438
+ :body => post_body,
3439
+ :auth_names => auth_names,
3440
+ :return_type => return_type
3441
+ )
3442
+
3443
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3444
+ if @api_client.config.debugging
3445
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_sending_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3446
+ end
3447
+ return data, status_code, headers
3448
+ end
3449
+
3450
+ # Read the Twilio account
3451
+ # The account's Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
3452
+ # @param [Hash] opts the optional parameters
3453
+ # @return [SfvbCommsTwilioAccountResponse]
3454
+ def get_sfvb_comms_twilio_account(opts = {})
3455
+ data, _status_code, _headers = get_sfvb_comms_twilio_account_with_http_info(opts)
3456
+ data
3457
+ end
3458
+
3459
+ # Read the Twilio account
3460
+ # The account&#39;s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
3461
+ # @param [Hash] opts the optional parameters
3462
+ # @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
3463
+ def get_sfvb_comms_twilio_account_with_http_info(opts = {})
3464
+ if @api_client.config.debugging
3465
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_twilio_account ...'
3466
+ end
3467
+ # resource path
3468
+ local_var_path = '/sfvb/comms/twilio_account'
3092
3469
 
3093
3470
  # query parameters
3094
3471
  query_params = opts[:query_params] || {}
@@ -3098,26 +3475,21 @@ module UltracartClient
3098
3475
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3099
3476
  # HTTP header 'Accept' (if needed)
3100
3477
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3101
- # HTTP header 'Content-Type'
3102
- content_type = @api_client.select_header_content_type(['application/json'])
3103
- if !content_type.nil?
3104
- header_params['Content-Type'] = content_type
3105
- end
3106
3478
 
3107
3479
  # form parameters
3108
3480
  form_params = opts[:form_params] || {}
3109
3481
 
3110
3482
  # http body (model)
3111
- post_body = opts[:debug_body] || @api_client.object_to_http_body(compile_request)
3483
+ post_body = opts[:debug_body]
3112
3484
 
3113
3485
  # return_type
3114
- return_type = opts[:debug_return_type] || 'SfvbElementsResponse'
3486
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
3115
3487
 
3116
3488
  # auth_names
3117
3489
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3118
3490
 
3119
3491
  new_options = opts.merge(
3120
- :operation => :"SfvbApi.get_sfvb_cjson_used_elements",
3492
+ :operation => :"SfvbApi.get_sfvb_comms_twilio_account",
3121
3493
  :header_params => header_params,
3122
3494
  :query_params => query_params,
3123
3495
  :form_params => form_params,
@@ -3126,9 +3498,9 @@ module UltracartClient
3126
3498
  :return_type => return_type
3127
3499
  )
3128
3500
 
3129
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3501
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3130
3502
  if @api_client.config.debugging
3131
- @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_cjson_used_elements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3503
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3132
3504
  end
3133
3505
  return data, status_code, headers
3134
3506
  end
@@ -5658,6 +6030,186 @@ module UltracartClient
5658
6030
  return data, status_code, headers
5659
6031
  end
5660
6032
 
6033
+ # List the secrets this server collects
6034
+ # The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
6035
+ # @param [Hash] opts the optional parameters
6036
+ # @return [SfvbSecretKindsResponse]
6037
+ def get_sfvb_secret_kinds(opts = {})
6038
+ data, _status_code, _headers = get_sfvb_secret_kinds_with_http_info(opts)
6039
+ data
6040
+ end
6041
+
6042
+ # List the secrets this server collects
6043
+ # The kinds of secret value, with what each looks like, and the secret fields (sinks) a handle can be written to. Request a handle for a sink with POST secrets.
6044
+ # @param [Hash] opts the optional parameters
6045
+ # @return [Array<(SfvbSecretKindsResponse, Integer, Hash)>] SfvbSecretKindsResponse data, response status code and response headers
6046
+ def get_sfvb_secret_kinds_with_http_info(opts = {})
6047
+ if @api_client.config.debugging
6048
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_secret_kinds ...'
6049
+ end
6050
+ # resource path
6051
+ local_var_path = '/sfvb/secrets/kinds'
6052
+
6053
+ # query parameters
6054
+ query_params = opts[:query_params] || {}
6055
+
6056
+ # header parameters
6057
+ header_params = opts[:header_params] || {}
6058
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6059
+ # HTTP header 'Accept' (if needed)
6060
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6061
+
6062
+ # form parameters
6063
+ form_params = opts[:form_params] || {}
6064
+
6065
+ # http body (model)
6066
+ post_body = opts[:debug_body]
6067
+
6068
+ # return_type
6069
+ return_type = opts[:debug_return_type] || 'SfvbSecretKindsResponse'
6070
+
6071
+ # auth_names
6072
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6073
+
6074
+ new_options = opts.merge(
6075
+ :operation => :"SfvbApi.get_sfvb_secret_kinds",
6076
+ :header_params => header_params,
6077
+ :query_params => query_params,
6078
+ :form_params => form_params,
6079
+ :body => post_body,
6080
+ :auth_names => auth_names,
6081
+ :return_type => return_type
6082
+ )
6083
+
6084
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6085
+ if @api_client.config.debugging
6086
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_secret_kinds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6087
+ end
6088
+ return data, status_code, headers
6089
+ end
6090
+
6091
+ # Read one secret request
6092
+ # Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
6093
+ # @param request_id [String]
6094
+ # @param [Hash] opts the optional parameters
6095
+ # @return [SfvbSecretRequest]
6096
+ def get_sfvb_secret_request(request_id, opts = {})
6097
+ data, _status_code, _headers = get_sfvb_secret_request_with_http_info(request_id, opts)
6098
+ data
6099
+ end
6100
+
6101
+ # Read one secret request
6102
+ # Poll this every interval_seconds after making a request. status is pending until a person enters the values, then fulfilled, and expired if nobody does within 24 hours. handles lists each handle with its own status, and a fingerprint (the last few characters as a mask shows them) once its value is entered. Never a value.
6103
+ # @param request_id [String]
6104
+ # @param [Hash] opts the optional parameters
6105
+ # @return [Array<(SfvbSecretRequest, Integer, Hash)>] SfvbSecretRequest data, response status code and response headers
6106
+ def get_sfvb_secret_request_with_http_info(request_id, opts = {})
6107
+ if @api_client.config.debugging
6108
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_secret_request ...'
6109
+ end
6110
+ # verify the required parameter 'request_id' is set
6111
+ if @api_client.config.client_side_validation && request_id.nil?
6112
+ fail ArgumentError, "Missing the required parameter 'request_id' when calling SfvbApi.get_sfvb_secret_request"
6113
+ end
6114
+ # resource path
6115
+ local_var_path = '/sfvb/secrets/{request_id}'.sub('{' + 'request_id' + '}', CGI.escape(request_id.to_s))
6116
+
6117
+ # query parameters
6118
+ query_params = opts[:query_params] || {}
6119
+
6120
+ # header parameters
6121
+ header_params = opts[:header_params] || {}
6122
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6123
+ # HTTP header 'Accept' (if needed)
6124
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6125
+
6126
+ # form parameters
6127
+ form_params = opts[:form_params] || {}
6128
+
6129
+ # http body (model)
6130
+ post_body = opts[:debug_body]
6131
+
6132
+ # return_type
6133
+ return_type = opts[:debug_return_type] || 'SfvbSecretRequest'
6134
+
6135
+ # auth_names
6136
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6137
+
6138
+ new_options = opts.merge(
6139
+ :operation => :"SfvbApi.get_sfvb_secret_request",
6140
+ :header_params => header_params,
6141
+ :query_params => query_params,
6142
+ :form_params => form_params,
6143
+ :body => post_body,
6144
+ :auth_names => auth_names,
6145
+ :return_type => return_type
6146
+ )
6147
+
6148
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6149
+ if @api_client.config.debugging
6150
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_secret_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6151
+ end
6152
+ return data, status_code, headers
6153
+ end
6154
+
6155
+ # List this sign-in's secret requests
6156
+ # Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
6157
+ # @param [Hash] opts the optional parameters
6158
+ # @return [SfvbSecretRequestsResponse]
6159
+ def get_sfvb_secret_requests(opts = {})
6160
+ data, _status_code, _headers = get_sfvb_secret_requests_with_http_info(opts)
6161
+ data
6162
+ end
6163
+
6164
+ # List this sign-in&#39;s secret requests
6165
+ # Requests made with this sign-in in the last 24 hours, newest first, at most 50, without their handles. Read one request for its handles.
6166
+ # @param [Hash] opts the optional parameters
6167
+ # @return [Array<(SfvbSecretRequestsResponse, Integer, Hash)>] SfvbSecretRequestsResponse data, response status code and response headers
6168
+ def get_sfvb_secret_requests_with_http_info(opts = {})
6169
+ if @api_client.config.debugging
6170
+ @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_secret_requests ...'
6171
+ end
6172
+ # resource path
6173
+ local_var_path = '/sfvb/secrets'
6174
+
6175
+ # query parameters
6176
+ query_params = opts[:query_params] || {}
6177
+
6178
+ # header parameters
6179
+ header_params = opts[:header_params] || {}
6180
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6181
+ # HTTP header 'Accept' (if needed)
6182
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6183
+
6184
+ # form parameters
6185
+ form_params = opts[:form_params] || {}
6186
+
6187
+ # http body (model)
6188
+ post_body = opts[:debug_body]
6189
+
6190
+ # return_type
6191
+ return_type = opts[:debug_return_type] || 'SfvbSecretRequestsResponse'
6192
+
6193
+ # auth_names
6194
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6195
+
6196
+ new_options = opts.merge(
6197
+ :operation => :"SfvbApi.get_sfvb_secret_requests",
6198
+ :header_params => header_params,
6199
+ :query_params => query_params,
6200
+ :form_params => form_params,
6201
+ :body => post_body,
6202
+ :auth_names => auth_names,
6203
+ :return_type => return_type
6204
+ )
6205
+
6206
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6207
+ if @api_client.config.debugging
6208
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_secret_requests\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6209
+ end
6210
+ return data, status_code, headers
6211
+ end
6212
+
5661
6213
  # Get one storefront render log
5662
6214
  # One render's server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
5663
6215
  # @param storefront_oid [Integer]
@@ -6589,21 +7141,159 @@ module UltracartClient
6589
7141
  # @param storefront_oid [Integer]
6590
7142
  # @param blog_post_request [SfvbBlogPostRequest] The blog post to create
6591
7143
  # @param [Hash] opts the optional parameters
6592
- # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
6593
- def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
7144
+ # @return [Array<(SfvbBlogPostDetail, Integer, Hash)>] SfvbBlogPostDetail data, response status code and response headers
7145
+ def insert_sfvb_blog_post_with_http_info(storefront_oid, blog_post_request, opts = {})
7146
+ if @api_client.config.debugging
7147
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
7148
+ end
7149
+ # verify the required parameter 'storefront_oid' is set
7150
+ if @api_client.config.client_side_validation && storefront_oid.nil?
7151
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
7152
+ end
7153
+ # verify the required parameter 'blog_post_request' is set
7154
+ if @api_client.config.client_side_validation && blog_post_request.nil?
7155
+ fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
7156
+ end
7157
+ # resource path
7158
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
7159
+
7160
+ # query parameters
7161
+ query_params = opts[:query_params] || {}
7162
+
7163
+ # header parameters
7164
+ header_params = opts[:header_params] || {}
7165
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7166
+ # HTTP header 'Accept' (if needed)
7167
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7168
+ # HTTP header 'Content-Type'
7169
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
7170
+ if !content_type.nil?
7171
+ header_params['Content-Type'] = content_type
7172
+ end
7173
+
7174
+ # form parameters
7175
+ form_params = opts[:form_params] || {}
7176
+
7177
+ # http body (model)
7178
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
7179
+
7180
+ # return_type
7181
+ return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
7182
+
7183
+ # auth_names
7184
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7185
+
7186
+ new_options = opts.merge(
7187
+ :operation => :"SfvbApi.insert_sfvb_blog_post",
7188
+ :header_params => header_params,
7189
+ :query_params => query_params,
7190
+ :form_params => form_params,
7191
+ :body => post_body,
7192
+ :auth_names => auth_names,
7193
+ :return_type => return_type
7194
+ )
7195
+
7196
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7197
+ if @api_client.config.debugging
7198
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7199
+ end
7200
+ return data, status_code, headers
7201
+ end
7202
+
7203
+ # Add a sending domain
7204
+ # Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
7205
+ # @param sending_domain [SfvbCommsSendingDomain] The sending domain
7206
+ # @param [Hash] opts the optional parameters
7207
+ # @return [SfvbCommsSendingDomain]
7208
+ def insert_sfvb_comms_sending_domain(sending_domain, opts = {})
7209
+ data, _status_code, _headers = insert_sfvb_comms_sending_domain_with_http_info(sending_domain, opts)
7210
+ data
7211
+ end
7212
+
7213
+ # Add a sending domain
7214
+ # Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
7215
+ # @param sending_domain [SfvbCommsSendingDomain] The sending domain
7216
+ # @param [Hash] opts the optional parameters
7217
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
7218
+ def insert_sfvb_comms_sending_domain_with_http_info(sending_domain, opts = {})
7219
+ if @api_client.config.debugging
7220
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_sending_domain ...'
7221
+ end
7222
+ # verify the required parameter 'sending_domain' is set
7223
+ if @api_client.config.client_side_validation && sending_domain.nil?
7224
+ fail ArgumentError, "Missing the required parameter 'sending_domain' when calling SfvbApi.insert_sfvb_comms_sending_domain"
7225
+ end
7226
+ # resource path
7227
+ local_var_path = '/sfvb/comms/sending_domains'
7228
+
7229
+ # query parameters
7230
+ query_params = opts[:query_params] || {}
7231
+
7232
+ # header parameters
7233
+ header_params = opts[:header_params] || {}
7234
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7235
+ # HTTP header 'Accept' (if needed)
7236
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7237
+ # HTTP header 'Content-Type'
7238
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
7239
+ if !content_type.nil?
7240
+ header_params['Content-Type'] = content_type
7241
+ end
7242
+
7243
+ # form parameters
7244
+ form_params = opts[:form_params] || {}
7245
+
7246
+ # http body (model)
7247
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sending_domain)
7248
+
7249
+ # return_type
7250
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
7251
+
7252
+ # auth_names
7253
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7254
+
7255
+ new_options = opts.merge(
7256
+ :operation => :"SfvbApi.insert_sfvb_comms_sending_domain",
7257
+ :header_params => header_params,
7258
+ :query_params => query_params,
7259
+ :form_params => form_params,
7260
+ :body => post_body,
7261
+ :auth_names => auth_names,
7262
+ :return_type => return_type
7263
+ )
7264
+
7265
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7266
+ if @api_client.config.debugging
7267
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7268
+ end
7269
+ return data, status_code, headers
7270
+ end
7271
+
7272
+ # Connect the Twilio account
7273
+ # Connects the account's Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
7274
+ # @param twilio_account [SfvbCommsTwilioAccount] The Twilio account
7275
+ # @param [Hash] opts the optional parameters
7276
+ # @return [SfvbCommsTwilioAccountResponse]
7277
+ def insert_sfvb_comms_twilio_account(twilio_account, opts = {})
7278
+ data, _status_code, _headers = insert_sfvb_comms_twilio_account_with_http_info(twilio_account, opts)
7279
+ data
7280
+ end
7281
+
7282
+ # Connect the Twilio account
7283
+ # Connects the account&#39;s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
7284
+ # @param twilio_account [SfvbCommsTwilioAccount] The Twilio account
7285
+ # @param [Hash] opts the optional parameters
7286
+ # @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
7287
+ def insert_sfvb_comms_twilio_account_with_http_info(twilio_account, opts = {})
6594
7288
  if @api_client.config.debugging
6595
- @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_blog_post ...'
6596
- end
6597
- # verify the required parameter 'storefront_oid' is set
6598
- if @api_client.config.client_side_validation && storefront_oid.nil?
6599
- fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_blog_post"
7289
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_twilio_account ...'
6600
7290
  end
6601
- # verify the required parameter 'blog_post_request' is set
6602
- if @api_client.config.client_side_validation && blog_post_request.nil?
6603
- fail ArgumentError, "Missing the required parameter 'blog_post_request' when calling SfvbApi.insert_sfvb_blog_post"
7291
+ # verify the required parameter 'twilio_account' is set
7292
+ if @api_client.config.client_side_validation && twilio_account.nil?
7293
+ fail ArgumentError, "Missing the required parameter 'twilio_account' when calling SfvbApi.insert_sfvb_comms_twilio_account"
6604
7294
  end
6605
7295
  # resource path
6606
- local_var_path = '/sfvb/storefronts/{storefront_oid}/blog_posts'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
7296
+ local_var_path = '/sfvb/comms/twilio_account'
6607
7297
 
6608
7298
  # query parameters
6609
7299
  query_params = opts[:query_params] || {}
@@ -6623,16 +7313,16 @@ module UltracartClient
6623
7313
  form_params = opts[:form_params] || {}
6624
7314
 
6625
7315
  # http body (model)
6626
- post_body = opts[:debug_body] || @api_client.object_to_http_body(blog_post_request)
7316
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio_account)
6627
7317
 
6628
7318
  # return_type
6629
- return_type = opts[:debug_return_type] || 'SfvbBlogPostDetail'
7319
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
6630
7320
 
6631
7321
  # auth_names
6632
7322
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6633
7323
 
6634
7324
  new_options = opts.merge(
6635
- :operation => :"SfvbApi.insert_sfvb_blog_post",
7325
+ :operation => :"SfvbApi.insert_sfvb_comms_twilio_account",
6636
7326
  :header_params => header_params,
6637
7327
  :query_params => query_params,
6638
7328
  :form_params => form_params,
@@ -6643,7 +7333,7 @@ module UltracartClient
6643
7333
 
6644
7334
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6645
7335
  if @api_client.config.debugging
6646
- @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_blog_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7336
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6647
7337
  end
6648
7338
  return data, status_code, headers
6649
7339
  end
@@ -6798,6 +7488,75 @@ module UltracartClient
6798
7488
  return data, status_code, headers
6799
7489
  end
6800
7490
 
7491
+ # Ask a person to enter secret values
7492
+ # Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
7493
+ # @param secret_request [SfvbSecretRequestCreate] The request
7494
+ # @param [Hash] opts the optional parameters
7495
+ # @return [SfvbSecretRequest]
7496
+ def insert_sfvb_secret_request(secret_request, opts = {})
7497
+ data, _status_code, _headers = insert_sfvb_secret_request_with_http_info(secret_request, opts)
7498
+ data
7499
+ end
7500
+
7501
+ # Ask a person to enter secret values
7502
+ # Never ask for a credential in the conversation. This makes a handle for each sink (and each key, for a bulk request) at once, pending until a person enters the values on request_url. Show the person request_url and user_code and never open or fill in the page yourself. Poll GET secrets/{request_id} every interval_seconds until status is fulfilled, then send each handle in its secret field. The server writes the value in its place. A handle works only for this sign-in, its sink and its target, for ttl_seconds and uses writes. A request lapses after 24 hours, and shares the five pending requests a sign-in has with approvals. Asking again for the same thing returns the pending request (200) rather than a new one (201). Requires a token that resolves to a user, so use the device authorization flow. A secret request is never an approval.
7503
+ # @param secret_request [SfvbSecretRequestCreate] The request
7504
+ # @param [Hash] opts the optional parameters
7505
+ # @return [Array<(SfvbSecretRequest, Integer, Hash)>] SfvbSecretRequest data, response status code and response headers
7506
+ def insert_sfvb_secret_request_with_http_info(secret_request, opts = {})
7507
+ if @api_client.config.debugging
7508
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_secret_request ...'
7509
+ end
7510
+ # verify the required parameter 'secret_request' is set
7511
+ if @api_client.config.client_side_validation && secret_request.nil?
7512
+ fail ArgumentError, "Missing the required parameter 'secret_request' when calling SfvbApi.insert_sfvb_secret_request"
7513
+ end
7514
+ # resource path
7515
+ local_var_path = '/sfvb/secrets'
7516
+
7517
+ # query parameters
7518
+ query_params = opts[:query_params] || {}
7519
+
7520
+ # header parameters
7521
+ header_params = opts[:header_params] || {}
7522
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7523
+ # HTTP header 'Accept' (if needed)
7524
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7525
+ # HTTP header 'Content-Type'
7526
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
7527
+ if !content_type.nil?
7528
+ header_params['Content-Type'] = content_type
7529
+ end
7530
+
7531
+ # form parameters
7532
+ form_params = opts[:form_params] || {}
7533
+
7534
+ # http body (model)
7535
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(secret_request)
7536
+
7537
+ # return_type
7538
+ return_type = opts[:debug_return_type] || 'SfvbSecretRequest'
7539
+
7540
+ # auth_names
7541
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7542
+
7543
+ new_options = opts.merge(
7544
+ :operation => :"SfvbApi.insert_sfvb_secret_request",
7545
+ :header_params => header_params,
7546
+ :query_params => query_params,
7547
+ :form_params => form_params,
7548
+ :body => post_body,
7549
+ :auth_names => auth_names,
7550
+ :return_type => return_type
7551
+ )
7552
+
7553
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7554
+ if @api_client.config.debugging
7555
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_secret_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7556
+ end
7557
+ return data, status_code, headers
7558
+ end
7559
+
6801
7560
  # Create an upsell offer
6802
7561
  # Every item it names must exist, and every shipping method, payment method and loyalty tier must be one the merchant has. Put it on a path with a path update to have it shown. It must be created with active false, and switched on with the enable call, which needs approval. upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Its page content is its container, written with the container endpoints and owner type upsell.
6803
7562
  # @param storefront_oid [Integer]
@@ -10088,6 +10847,70 @@ module UltracartClient
10088
10847
  return data, status_code, headers
10089
10848
  end
10090
10849
 
10850
+ # Check a sending domain's verification
10851
+ # Asks Amazon SES again whether an amazon domain's DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
10852
+ # @param domain [String]
10853
+ # @param [Hash] opts the optional parameters
10854
+ # @return [SfvbCommsSendingDomain]
10855
+ def refresh_sfvb_comms_sending_domain_status(domain, opts = {})
10856
+ data, _status_code, _headers = refresh_sfvb_comms_sending_domain_status_with_http_info(domain, opts)
10857
+ data
10858
+ end
10859
+
10860
+ # Check a sending domain&#39;s verification
10861
+ # Asks Amazon SES again whether an amazon domain&#39;s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
10862
+ # @param domain [String]
10863
+ # @param [Hash] opts the optional parameters
10864
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
10865
+ def refresh_sfvb_comms_sending_domain_status_with_http_info(domain, opts = {})
10866
+ if @api_client.config.debugging
10867
+ @api_client.config.logger.debug 'Calling API: SfvbApi.refresh_sfvb_comms_sending_domain_status ...'
10868
+ end
10869
+ # verify the required parameter 'domain' is set
10870
+ if @api_client.config.client_side_validation && domain.nil?
10871
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.refresh_sfvb_comms_sending_domain_status"
10872
+ end
10873
+ # resource path
10874
+ local_var_path = '/sfvb/comms/sending_domains/{domain}/status'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
10875
+
10876
+ # query parameters
10877
+ query_params = opts[:query_params] || {}
10878
+
10879
+ # header parameters
10880
+ header_params = opts[:header_params] || {}
10881
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10882
+ # HTTP header 'Accept' (if needed)
10883
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10884
+
10885
+ # form parameters
10886
+ form_params = opts[:form_params] || {}
10887
+
10888
+ # http body (model)
10889
+ post_body = opts[:debug_body]
10890
+
10891
+ # return_type
10892
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
10893
+
10894
+ # auth_names
10895
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10896
+
10897
+ new_options = opts.merge(
10898
+ :operation => :"SfvbApi.refresh_sfvb_comms_sending_domain_status",
10899
+ :header_params => header_params,
10900
+ :query_params => query_params,
10901
+ :form_params => form_params,
10902
+ :body => post_body,
10903
+ :auth_names => auth_names,
10904
+ :return_type => return_type
10905
+ )
10906
+
10907
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10908
+ if @api_client.config.debugging
10909
+ @api_client.config.logger.debug "API called: SfvbApi#refresh_sfvb_comms_sending_domain_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10910
+ end
10911
+ return data, status_code, headers
10912
+ end
10913
+
10091
10914
  # Drop one page's cached copy
10092
10915
  # The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
10093
10916
  # @param storefront_oid [Integer]
@@ -10878,6 +11701,70 @@ module UltracartClient
10878
11701
  return data, status_code, headers
10879
11702
  end
10880
11703
 
11704
+ # Revoke a fulfilled request's unused handles
11705
+ # Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
11706
+ # @param request_id [String]
11707
+ # @param [Hash] opts the optional parameters
11708
+ # @return [SfvbSecretRequest]
11709
+ def revoke_sfvb_secret_request(request_id, opts = {})
11710
+ data, _status_code, _headers = revoke_sfvb_secret_request_with_http_info(request_id, opts)
11711
+ data
11712
+ end
11713
+
11714
+ # Revoke a fulfilled request&#39;s unused handles
11715
+ # Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
11716
+ # @param request_id [String]
11717
+ # @param [Hash] opts the optional parameters
11718
+ # @return [Array<(SfvbSecretRequest, Integer, Hash)>] SfvbSecretRequest data, response status code and response headers
11719
+ def revoke_sfvb_secret_request_with_http_info(request_id, opts = {})
11720
+ if @api_client.config.debugging
11721
+ @api_client.config.logger.debug 'Calling API: SfvbApi.revoke_sfvb_secret_request ...'
11722
+ end
11723
+ # verify the required parameter 'request_id' is set
11724
+ if @api_client.config.client_side_validation && request_id.nil?
11725
+ fail ArgumentError, "Missing the required parameter 'request_id' when calling SfvbApi.revoke_sfvb_secret_request"
11726
+ end
11727
+ # resource path
11728
+ local_var_path = '/sfvb/secrets/{request_id}/revoke'.sub('{' + 'request_id' + '}', CGI.escape(request_id.to_s))
11729
+
11730
+ # query parameters
11731
+ query_params = opts[:query_params] || {}
11732
+
11733
+ # header parameters
11734
+ header_params = opts[:header_params] || {}
11735
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
11736
+ # HTTP header 'Accept' (if needed)
11737
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11738
+
11739
+ # form parameters
11740
+ form_params = opts[:form_params] || {}
11741
+
11742
+ # http body (model)
11743
+ post_body = opts[:debug_body]
11744
+
11745
+ # return_type
11746
+ return_type = opts[:debug_return_type] || 'SfvbSecretRequest'
11747
+
11748
+ # auth_names
11749
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
11750
+
11751
+ new_options = opts.merge(
11752
+ :operation => :"SfvbApi.revoke_sfvb_secret_request",
11753
+ :header_params => header_params,
11754
+ :query_params => query_params,
11755
+ :form_params => form_params,
11756
+ :body => post_body,
11757
+ :auth_names => auth_names,
11758
+ :return_type => return_type
11759
+ )
11760
+
11761
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11762
+ if @api_client.config.debugging
11763
+ @api_client.config.logger.debug "API called: SfvbApi#revoke_sfvb_secret_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11764
+ end
11765
+ return data, status_code, headers
11766
+ end
11767
+
10881
11768
  # Search storefront files
10882
11769
  # Searches names and, when text is supplied, file contents. For a CLI with no local copy this is the only way to answer where something is defined without walking the whole tree. Results are capped and truncation is always reported.
10883
11770
  # @param storefront_oid [Integer]
@@ -11724,6 +12611,150 @@ module UltracartClient
11724
12611
  return data, status_code, headers
11725
12612
  end
11726
12613
 
12614
+ # Update a sending domain
12615
+ # Only a mailgun domain's mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart's webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
12616
+ # @param domain [String]
12617
+ # @param sending_domain [SfvbCommsSendingDomain] The changes
12618
+ # @param [Hash] opts the optional parameters
12619
+ # @return [SfvbCommsSendingDomain]
12620
+ def update_sfvb_comms_sending_domain(domain, sending_domain, opts = {})
12621
+ data, _status_code, _headers = update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain, opts)
12622
+ data
12623
+ end
12624
+
12625
+ # Update a sending domain
12626
+ # Only a mailgun domain&#39;s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart&#39;s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
12627
+ # @param domain [String]
12628
+ # @param sending_domain [SfvbCommsSendingDomain] The changes
12629
+ # @param [Hash] opts the optional parameters
12630
+ # @return [Array<(SfvbCommsSendingDomain, Integer, Hash)>] SfvbCommsSendingDomain data, response status code and response headers
12631
+ def update_sfvb_comms_sending_domain_with_http_info(domain, sending_domain, opts = {})
12632
+ if @api_client.config.debugging
12633
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_sending_domain ...'
12634
+ end
12635
+ # verify the required parameter 'domain' is set
12636
+ if @api_client.config.client_side_validation && domain.nil?
12637
+ fail ArgumentError, "Missing the required parameter 'domain' when calling SfvbApi.update_sfvb_comms_sending_domain"
12638
+ end
12639
+ # verify the required parameter 'sending_domain' is set
12640
+ if @api_client.config.client_side_validation && sending_domain.nil?
12641
+ fail ArgumentError, "Missing the required parameter 'sending_domain' when calling SfvbApi.update_sfvb_comms_sending_domain"
12642
+ end
12643
+ # resource path
12644
+ local_var_path = '/sfvb/comms/sending_domains/{domain}'.sub('{' + 'domain' + '}', CGI.escape(domain.to_s))
12645
+
12646
+ # query parameters
12647
+ query_params = opts[:query_params] || {}
12648
+
12649
+ # header parameters
12650
+ header_params = opts[:header_params] || {}
12651
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
12652
+ # HTTP header 'Accept' (if needed)
12653
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12654
+ # HTTP header 'Content-Type'
12655
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
12656
+ if !content_type.nil?
12657
+ header_params['Content-Type'] = content_type
12658
+ end
12659
+
12660
+ # form parameters
12661
+ form_params = opts[:form_params] || {}
12662
+
12663
+ # http body (model)
12664
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sending_domain)
12665
+
12666
+ # return_type
12667
+ return_type = opts[:debug_return_type] || 'SfvbCommsSendingDomain'
12668
+
12669
+ # auth_names
12670
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
12671
+
12672
+ new_options = opts.merge(
12673
+ :operation => :"SfvbApi.update_sfvb_comms_sending_domain",
12674
+ :header_params => header_params,
12675
+ :query_params => query_params,
12676
+ :form_params => form_params,
12677
+ :body => post_body,
12678
+ :auth_names => auth_names,
12679
+ :return_type => return_type
12680
+ )
12681
+
12682
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
12683
+ if @api_client.config.debugging
12684
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_sending_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12685
+ end
12686
+ return data, status_code, headers
12687
+ end
12688
+
12689
+ # Update the Twilio account
12690
+ # Changes the account's Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart's API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
12691
+ # @param twilio_account [SfvbCommsTwilioAccount] The changes
12692
+ # @param [Hash] opts the optional parameters
12693
+ # @return [SfvbCommsTwilioAccountResponse]
12694
+ def update_sfvb_comms_twilio_account(twilio_account, opts = {})
12695
+ data, _status_code, _headers = update_sfvb_comms_twilio_account_with_http_info(twilio_account, opts)
12696
+ data
12697
+ end
12698
+
12699
+ # Update the Twilio account
12700
+ # Changes the account&#39;s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart&#39;s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
12701
+ # @param twilio_account [SfvbCommsTwilioAccount] The changes
12702
+ # @param [Hash] opts the optional parameters
12703
+ # @return [Array<(SfvbCommsTwilioAccountResponse, Integer, Hash)>] SfvbCommsTwilioAccountResponse data, response status code and response headers
12704
+ def update_sfvb_comms_twilio_account_with_http_info(twilio_account, opts = {})
12705
+ if @api_client.config.debugging
12706
+ @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_twilio_account ...'
12707
+ end
12708
+ # verify the required parameter 'twilio_account' is set
12709
+ if @api_client.config.client_side_validation && twilio_account.nil?
12710
+ fail ArgumentError, "Missing the required parameter 'twilio_account' when calling SfvbApi.update_sfvb_comms_twilio_account"
12711
+ end
12712
+ # resource path
12713
+ local_var_path = '/sfvb/comms/twilio_account'
12714
+
12715
+ # query parameters
12716
+ query_params = opts[:query_params] || {}
12717
+
12718
+ # header parameters
12719
+ header_params = opts[:header_params] || {}
12720
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
12721
+ # HTTP header 'Accept' (if needed)
12722
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12723
+ # HTTP header 'Content-Type'
12724
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
12725
+ if !content_type.nil?
12726
+ header_params['Content-Type'] = content_type
12727
+ end
12728
+
12729
+ # form parameters
12730
+ form_params = opts[:form_params] || {}
12731
+
12732
+ # http body (model)
12733
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio_account)
12734
+
12735
+ # return_type
12736
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
12737
+
12738
+ # auth_names
12739
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
12740
+
12741
+ new_options = opts.merge(
12742
+ :operation => :"SfvbApi.update_sfvb_comms_twilio_account",
12743
+ :header_params => header_params,
12744
+ :query_params => query_params,
12745
+ :form_params => form_params,
12746
+ :body => post_body,
12747
+ :auth_names => auth_names,
12748
+ :return_type => return_type
12749
+ )
12750
+
12751
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
12752
+ if @api_client.config.debugging
12753
+ @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12754
+ end
12755
+ return data, status_code, headers
12756
+ end
12757
+
11727
12758
  # Change attributes across many items in one call
11728
12759
  # Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
11729
12760
  # @param storefront_oid [Integer]