ultracart_api 4.1.203 → 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.
@@ -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]
@@ -3197,6 +3325,186 @@ module UltracartClient
3197
3325
  return data, status_code, headers
3198
3326
  end
3199
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'
3469
+
3470
+ # query parameters
3471
+ query_params = opts[:query_params] || {}
3472
+
3473
+ # header parameters
3474
+ header_params = opts[:header_params] || {}
3475
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
3476
+ # HTTP header 'Accept' (if needed)
3477
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3478
+
3479
+ # form parameters
3480
+ form_params = opts[:form_params] || {}
3481
+
3482
+ # http body (model)
3483
+ post_body = opts[:debug_body]
3484
+
3485
+ # return_type
3486
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
3487
+
3488
+ # auth_names
3489
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
3490
+
3491
+ new_options = opts.merge(
3492
+ :operation => :"SfvbApi.get_sfvb_comms_twilio_account",
3493
+ :header_params => header_params,
3494
+ :query_params => query_params,
3495
+ :form_params => form_params,
3496
+ :body => post_body,
3497
+ :auth_names => auth_names,
3498
+ :return_type => return_type
3499
+ )
3500
+
3501
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
3502
+ if @api_client.config.debugging
3503
+ @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3504
+ end
3505
+ return data, status_code, headers
3506
+ end
3507
+
3200
3508
  # Read a container stored outside the file system
3201
3509
  # owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
3202
3510
  # @param storefront_oid [Integer]
@@ -6892,6 +7200,144 @@ module UltracartClient
6892
7200
  return data, status_code, headers
6893
7201
  end
6894
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 = {})
7288
+ if @api_client.config.debugging
7289
+ @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_twilio_account ...'
7290
+ end
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"
7294
+ end
7295
+ # resource path
7296
+ local_var_path = '/sfvb/comms/twilio_account'
7297
+
7298
+ # query parameters
7299
+ query_params = opts[:query_params] || {}
7300
+
7301
+ # header parameters
7302
+ header_params = opts[:header_params] || {}
7303
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
7304
+ # HTTP header 'Accept' (if needed)
7305
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7306
+ # HTTP header 'Content-Type'
7307
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
7308
+ if !content_type.nil?
7309
+ header_params['Content-Type'] = content_type
7310
+ end
7311
+
7312
+ # form parameters
7313
+ form_params = opts[:form_params] || {}
7314
+
7315
+ # http body (model)
7316
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(twilio_account)
7317
+
7318
+ # return_type
7319
+ return_type = opts[:debug_return_type] || 'SfvbCommsTwilioAccountResponse'
7320
+
7321
+ # auth_names
7322
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
7323
+
7324
+ new_options = opts.merge(
7325
+ :operation => :"SfvbApi.insert_sfvb_comms_twilio_account",
7326
+ :header_params => header_params,
7327
+ :query_params => query_params,
7328
+ :form_params => form_params,
7329
+ :body => post_body,
7330
+ :auth_names => auth_names,
7331
+ :return_type => return_type
7332
+ )
7333
+
7334
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7335
+ if @api_client.config.debugging
7336
+ @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_twilio_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7337
+ end
7338
+ return data, status_code, headers
7339
+ end
7340
+
6895
7341
  # Create a page
6896
7342
  # Creates the page and its folder, the way the store admin's add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent's templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
6897
7343
  # @param storefront_oid [Integer]
@@ -10401,6 +10847,70 @@ module UltracartClient
10401
10847
  return data, status_code, headers
10402
10848
  end
10403
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
+
10404
10914
  # Drop one page's cached copy
10405
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.
10406
10916
  # @param storefront_oid [Integer]
@@ -12101,6 +12611,150 @@ module UltracartClient
12101
12611
  return data, status_code, headers
12102
12612
  end
12103
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
+
12104
12758
  # Change attributes across many items in one call
12105
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.
12106
12760
  # @param storefront_oid [Integer]