ultracart_api 4.1.218 → 4.1.220

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.
@@ -8601,12 +8601,12 @@ module UltracartClient
8601
8601
  return data, status_code, headers
8602
8602
  end
8603
8603
 
8604
- # Add an email step, with its new email
8605
- # Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin's editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
8604
+ # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
8605
+ # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
8606
8606
  # @param storefront_oid [Integer]
8607
8607
  # @param sequence_uuid [String]
8608
8608
  # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
8609
- # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email's subject and preview text
8609
+ # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email's subject and preview text or code library item, the wait's config_json, or the postcard step's name
8610
8610
  # @param [Hash] opts the optional parameters
8611
8611
  # @return [SfvbSequenceStepCreateResponse]
8612
8612
  def insert_sfvb_sequence_step(storefront_oid, sequence_uuid, if_match, sequence_step_create_request, opts = {})
@@ -8614,12 +8614,12 @@ module UltracartClient
8614
8614
  data
8615
8615
  end
8616
8616
 
8617
- # Add an email step, with its new email
8618
- # Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin's editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
8617
+ # Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
8618
+ # type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account's own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin's default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step's hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin's editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
8619
8619
  # @param storefront_oid [Integer]
8620
8620
  # @param sequence_uuid [String]
8621
8621
  # @param if_match [String] The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
8622
- # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email's subject and preview text
8622
+ # @param sequence_step_create_request [SfvbSequenceStepCreateRequest] Where the step goes, and the new email's subject and preview text or code library item, the wait's config_json, or the postcard step's name
8623
8623
  # @param [Hash] opts the optional parameters
8624
8624
  # @return [Array<(SfvbSequenceStepCreateResponse, Integer, Hash)>] SfvbSequenceStepCreateResponse data, response status code and response headers
8625
8625
  def insert_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, if_match, sequence_step_create_request, opts = {})
@@ -9065,6 +9065,73 @@ module UltracartClient
9065
9065
  return data, status_code, headers
9066
9066
  end
9067
9067
 
9068
+ # Email items from the code library that can start a new email step
9069
+ # The code library is the one the admin's \"start from library\" uses; it isn't the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item's library_item_oid on the step insert to start a new email from it.
9070
+ # @param storefront_oid [Integer]
9071
+ # @param [Hash] opts the optional parameters
9072
+ # @option opts [String] :search Part of the title to match, with case. Up to 100 characters.
9073
+ # @return [SfvbCodeLibraryEmailsResponse]
9074
+ def list_sfvb_code_library_emails(storefront_oid, opts = {})
9075
+ data, _status_code, _headers = list_sfvb_code_library_emails_with_http_info(storefront_oid, opts)
9076
+ data
9077
+ end
9078
+
9079
+ # Email items from the code library that can start a new email step
9080
+ # The code library is the one the admin&#39;s \&quot;start from library\&quot; uses; it isn&#39;t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item&#39;s library_item_oid on the step insert to start a new email from it.
9081
+ # @param storefront_oid [Integer]
9082
+ # @param [Hash] opts the optional parameters
9083
+ # @option opts [String] :search Part of the title to match, with case. Up to 100 characters.
9084
+ # @return [Array<(SfvbCodeLibraryEmailsResponse, Integer, Hash)>] SfvbCodeLibraryEmailsResponse data, response status code and response headers
9085
+ def list_sfvb_code_library_emails_with_http_info(storefront_oid, opts = {})
9086
+ if @api_client.config.debugging
9087
+ @api_client.config.logger.debug 'Calling API: SfvbApi.list_sfvb_code_library_emails ...'
9088
+ end
9089
+ # verify the required parameter 'storefront_oid' is set
9090
+ if @api_client.config.client_side_validation && storefront_oid.nil?
9091
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.list_sfvb_code_library_emails"
9092
+ end
9093
+ # resource path
9094
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/code_library/emails'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
9095
+
9096
+ # query parameters
9097
+ query_params = opts[:query_params] || {}
9098
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
9099
+
9100
+ # header parameters
9101
+ header_params = opts[:header_params] || {}
9102
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
9103
+ # HTTP header 'Accept' (if needed)
9104
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9105
+
9106
+ # form parameters
9107
+ form_params = opts[:form_params] || {}
9108
+
9109
+ # http body (model)
9110
+ post_body = opts[:debug_body]
9111
+
9112
+ # return_type
9113
+ return_type = opts[:debug_return_type] || 'SfvbCodeLibraryEmailsResponse'
9114
+
9115
+ # auth_names
9116
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
9117
+
9118
+ new_options = opts.merge(
9119
+ :operation => :"SfvbApi.list_sfvb_code_library_emails",
9120
+ :header_params => header_params,
9121
+ :query_params => query_params,
9122
+ :form_params => form_params,
9123
+ :body => post_body,
9124
+ :auth_names => auth_names,
9125
+ :return_type => return_type
9126
+ )
9127
+
9128
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
9129
+ if @api_client.config.debugging
9130
+ @api_client.config.logger.debug "API called: SfvbApi#list_sfvb_code_library_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9131
+ end
9132
+ return data, status_code, headers
9133
+ end
9134
+
9068
9135
  # List the storefront's email lists
9069
9136
  # Each list's uuid, name and member count, by name, for a campaign's memberships or a list trigger. Never its members. Archived lists are left out.
9070
9137
  # @param storefront_oid [Integer]
@@ -10338,6 +10405,103 @@ module UltracartClient
10338
10405
  return data, status_code, headers
10339
10406
  end
10340
10407
 
10408
+ # Move one step
10409
+ # Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step's hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
10410
+ # @param storefront_oid [Integer]
10411
+ # @param sequence_uuid [String]
10412
+ # @param step_uuid [String]
10413
+ # @param if_match [String] The moved step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
10414
+ # @param sequence_step_move_request [SfvbSequenceStepMoveRequest] Where the step moves, and the hash of the step it goes next to
10415
+ # @param [Hash] opts the optional parameters
10416
+ # @option opts [String] :approval_id When the sequence is live, the approval_id of an approved sequence_step.move request for exactly this move. See POST /sfvb/approvals.
10417
+ # @return [SfvbSequenceStepMoveResponse]
10418
+ def move_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts = {})
10419
+ data, _status_code, _headers = move_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts)
10420
+ data
10421
+ end
10422
+
10423
+ # Move one step
10424
+ # Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step&#39;s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
10425
+ # @param storefront_oid [Integer]
10426
+ # @param sequence_uuid [String]
10427
+ # @param step_uuid [String]
10428
+ # @param if_match [String] The moved step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
10429
+ # @param sequence_step_move_request [SfvbSequenceStepMoveRequest] Where the step moves, and the hash of the step it goes next to
10430
+ # @param [Hash] opts the optional parameters
10431
+ # @option opts [String] :approval_id When the sequence is live, the approval_id of an approved sequence_step.move request for exactly this move. See POST /sfvb/approvals.
10432
+ # @return [Array<(SfvbSequenceStepMoveResponse, Integer, Hash)>] SfvbSequenceStepMoveResponse data, response status code and response headers
10433
+ def move_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_move_request, opts = {})
10434
+ if @api_client.config.debugging
10435
+ @api_client.config.logger.debug 'Calling API: SfvbApi.move_sfvb_sequence_step ...'
10436
+ end
10437
+ # verify the required parameter 'storefront_oid' is set
10438
+ if @api_client.config.client_side_validation && storefront_oid.nil?
10439
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.move_sfvb_sequence_step"
10440
+ end
10441
+ # verify the required parameter 'sequence_uuid' is set
10442
+ if @api_client.config.client_side_validation && sequence_uuid.nil?
10443
+ fail ArgumentError, "Missing the required parameter 'sequence_uuid' when calling SfvbApi.move_sfvb_sequence_step"
10444
+ end
10445
+ # verify the required parameter 'step_uuid' is set
10446
+ if @api_client.config.client_side_validation && step_uuid.nil?
10447
+ fail ArgumentError, "Missing the required parameter 'step_uuid' when calling SfvbApi.move_sfvb_sequence_step"
10448
+ end
10449
+ # verify the required parameter 'if_match' is set
10450
+ if @api_client.config.client_side_validation && if_match.nil?
10451
+ fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.move_sfvb_sequence_step"
10452
+ end
10453
+ # verify the required parameter 'sequence_step_move_request' is set
10454
+ if @api_client.config.client_side_validation && sequence_step_move_request.nil?
10455
+ fail ArgumentError, "Missing the required parameter 'sequence_step_move_request' when calling SfvbApi.move_sfvb_sequence_step"
10456
+ end
10457
+ # resource path
10458
+ local_var_path = '/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'sequence_uuid' + '}', CGI.escape(sequence_uuid.to_s)).sub('{' + 'step_uuid' + '}', CGI.escape(step_uuid.to_s))
10459
+
10460
+ # query parameters
10461
+ query_params = opts[:query_params] || {}
10462
+
10463
+ # header parameters
10464
+ header_params = opts[:header_params] || {}
10465
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
10466
+ # HTTP header 'Accept' (if needed)
10467
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10468
+ # HTTP header 'Content-Type'
10469
+ content_type = @api_client.select_header_content_type(['application/json'])
10470
+ if !content_type.nil?
10471
+ header_params['Content-Type'] = content_type
10472
+ end
10473
+ header_params[:'If-Match'] = if_match
10474
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
10475
+
10476
+ # form parameters
10477
+ form_params = opts[:form_params] || {}
10478
+
10479
+ # http body (model)
10480
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sequence_step_move_request)
10481
+
10482
+ # return_type
10483
+ return_type = opts[:debug_return_type] || 'SfvbSequenceStepMoveResponse'
10484
+
10485
+ # auth_names
10486
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
10487
+
10488
+ new_options = opts.merge(
10489
+ :operation => :"SfvbApi.move_sfvb_sequence_step",
10490
+ :header_params => header_params,
10491
+ :query_params => query_params,
10492
+ :form_params => form_params,
10493
+ :body => post_body,
10494
+ :auth_names => auth_names,
10495
+ :return_type => return_type
10496
+ )
10497
+
10498
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10499
+ if @api_client.config.debugging
10500
+ @api_client.config.logger.debug "API called: SfvbApi#move_sfvb_sequence_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10501
+ end
10502
+ return data, status_code, headers
10503
+ end
10504
+
10341
10505
  # Move an upsell path
10342
10506
  # Up, down, to the top or to the bottom of the storefront's paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
10343
10507
  # @param storefront_oid [Integer]
@@ -15108,13 +15272,14 @@ module UltracartClient
15108
15272
  end
15109
15273
 
15110
15274
  # Change one step's settings or audience filter
15111
- # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
15275
+ # Replaces the step's settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step's hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
15112
15276
  # @param storefront_oid [Integer]
15113
15277
  # @param sequence_uuid [String]
15114
15278
  # @param step_uuid [String]
15115
15279
  # @param if_match [String] The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
15116
15280
  # @param sequence_step_update_request [SfvbSequenceStepUpdateRequest] The settings, the filter, or both
15117
15281
  # @param [Hash] opts the optional parameters
15282
+ # @option opts [String] :approval_id When the change turns a post_card step on, the approval_id of an approved sequence_step.enable_postcard request for this step. See POST /sfvb/approvals.
15118
15283
  # @return [SfvbSequenceStepUpdateResponse]
15119
15284
  def update_sfvb_sequence_step(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts = {})
15120
15285
  data, _status_code, _headers = update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts)
@@ -15122,13 +15287,14 @@ module UltracartClient
15122
15287
  end
15123
15288
 
15124
15289
  # Change one step&#39;s settings or audience filter
15125
- # Replaces the step&#39;s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step&#39;s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
15290
+ # Replaces the step&#39;s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step&#39;s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
15126
15291
  # @param storefront_oid [Integer]
15127
15292
  # @param sequence_uuid [String]
15128
15293
  # @param step_uuid [String]
15129
15294
  # @param if_match [String] The step&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
15130
15295
  # @param sequence_step_update_request [SfvbSequenceStepUpdateRequest] The settings, the filter, or both
15131
15296
  # @param [Hash] opts the optional parameters
15297
+ # @option opts [String] :approval_id When the change turns a post_card step on, the approval_id of an approved sequence_step.enable_postcard request for this step. See POST /sfvb/approvals.
15132
15298
  # @return [Array<(SfvbSequenceStepUpdateResponse, Integer, Hash)>] SfvbSequenceStepUpdateResponse data, response status code and response headers
15133
15299
  def update_sfvb_sequence_step_with_http_info(storefront_oid, sequence_uuid, step_uuid, if_match, sequence_step_update_request, opts = {})
15134
15300
  if @api_client.config.debugging
@@ -15171,6 +15337,7 @@ module UltracartClient
15171
15337
  header_params['Content-Type'] = content_type
15172
15338
  end
15173
15339
  header_params[:'If-Match'] = if_match
15340
+ header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
15174
15341
 
15175
15342
  # form parameters
15176
15343
  form_params = opts[:form_params] || {}
@@ -2675,6 +2675,7 @@ module UltracartClient
2675
2675
  end
2676
2676
 
2677
2677
  # Get email campaigns with stats
2678
+ # Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn't listed; getEmailCampaigns lists every campaign.
2678
2679
  # @param storefront_oid [Integer]
2679
2680
  # @param stat_days [String]
2680
2681
  # @param [Hash] opts the optional parameters
@@ -2685,6 +2686,7 @@ module UltracartClient
2685
2686
  end
2686
2687
 
2687
2688
  # Get email campaigns with stats
2689
+ # Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn&#39;t listed; getEmailCampaigns lists every campaign.
2688
2690
  # @param storefront_oid [Integer]
2689
2691
  # @param stat_days [String]
2690
2692
  # @param [Hash] opts the optional parameters
@@ -24,6 +24,9 @@ module UltracartClient
24
24
  # Credit card transaction type
25
25
  attr_accessor :credit_card_transaction_type
26
26
 
27
+ # HSA/FSA eligibility. eligible_with_lmn means the customer needs a Letter of Medical Necessity. Kept in sync automatically when Truemed is configured. Empty string clears it, null value will not update the field
28
+ attr_accessor :hsa_fsa_eligibility
29
+
27
30
  # True if no real-time charge should be performed on this item.
28
31
  attr_accessor :no_realtime_charge
29
32
 
@@ -39,6 +42,7 @@ module UltracartClient
39
42
  :'block_prepaid' => :'block_prepaid',
40
43
  :'block_refunds' => :'block_refunds',
41
44
  :'credit_card_transaction_type' => :'credit_card_transaction_type',
45
+ :'hsa_fsa_eligibility' => :'hsa_fsa_eligibility',
42
46
  :'no_realtime_charge' => :'no_realtime_charge',
43
47
  :'payment_method_validity' => :'payment_method_validity',
44
48
  :'rotating_transaction_gateway_codes' => :'rotating_transaction_gateway_codes'
@@ -56,6 +60,7 @@ module UltracartClient
56
60
  :'block_prepaid' => :'Boolean',
57
61
  :'block_refunds' => :'Boolean',
58
62
  :'credit_card_transaction_type' => :'String',
63
+ :'hsa_fsa_eligibility' => :'String',
59
64
  :'no_realtime_charge' => :'Boolean',
60
65
  :'payment_method_validity' => :'Array<String>',
61
66
  :'rotating_transaction_gateway_codes' => :'Array<String>'
@@ -95,6 +100,10 @@ module UltracartClient
95
100
  self.credit_card_transaction_type = attributes[:'credit_card_transaction_type']
96
101
  end
97
102
 
103
+ if attributes.key?(:'hsa_fsa_eligibility')
104
+ self.hsa_fsa_eligibility = attributes[:'hsa_fsa_eligibility']
105
+ end
106
+
98
107
  if attributes.key?(:'no_realtime_charge')
99
108
  self.no_realtime_charge = attributes[:'no_realtime_charge']
100
109
  end
@@ -133,6 +142,7 @@ module UltracartClient
133
142
  block_prepaid == o.block_prepaid &&
134
143
  block_refunds == o.block_refunds &&
135
144
  credit_card_transaction_type == o.credit_card_transaction_type &&
145
+ hsa_fsa_eligibility == o.hsa_fsa_eligibility &&
136
146
  no_realtime_charge == o.no_realtime_charge &&
137
147
  payment_method_validity == o.payment_method_validity &&
138
148
  rotating_transaction_gateway_codes == o.rotating_transaction_gateway_codes
@@ -147,7 +157,7 @@ module UltracartClient
147
157
  # Calculates hash code according to all attributes.
148
158
  # @return [Integer] Hash code
149
159
  def hash
150
- [block_prepaid, block_refunds, credit_card_transaction_type, no_realtime_charge, payment_method_validity, rotating_transaction_gateway_codes].hash
160
+ [block_prepaid, block_refunds, credit_card_transaction_type, hsa_fsa_eligibility, no_realtime_charge, payment_method_validity, rotating_transaction_gateway_codes].hash
151
161
  end
152
162
 
153
163
  # Builds the object from hash
@@ -15,12 +15,18 @@ require 'time'
15
15
 
16
16
  module UltracartClient
17
17
  class SfvbApprovalParams
18
+ # For sequence_step.move, the step it moves after. Or branch_step_uuid with side.
19
+ attr_accessor :after_step_uuid
20
+
18
21
  # For item.attribute_batch, the attributes the batch would change. Set by the server.
19
22
  attr_accessor :attribute_names
20
23
 
21
24
  # The blog post, for blog_post.delete.
22
25
  attr_accessor :blog_post_oid
23
26
 
27
+ # For sequence_step.move, the condition, split or inboxgeek step it moves to the start of a side of.
28
+ attr_accessor :branch_step_uuid
29
+
24
30
  # For file.put_script, the SHA-256 of the exact bytes approved. Set by the server, never by the caller. The write must send bytes with this hash.
25
31
  attr_accessor :content_sha256
26
32
 
@@ -54,13 +60,16 @@ module UltracartClient
54
60
  # The segment whose rule changes, for segment.update.
55
61
  attr_accessor :segment_uuid
56
62
 
57
- # The communication sequence, for sequence_step.delete.
63
+ # The communication sequence, for sequence_step.delete and sequence_step.move.
58
64
  attr_accessor :sequence_uuid
59
65
 
66
+ # For sequence_step.move with branch_step_uuid, the side's label from the sequence read.
67
+ attr_accessor :side
68
+
60
69
  # For experiment.start of a page experiment, the page body name. Defaults to body.
61
70
  attr_accessor :slot
62
71
 
63
- # The step to remove, for sequence_step.delete.
72
+ # The step to remove, for sequence_step.delete, or to move, for sequence_step.move.
64
73
  attr_accessor :step_uuid
65
74
 
66
75
  # For upsell.enable, what to switch on.
@@ -103,8 +112,10 @@ module UltracartClient
103
112
  # Attribute mapping from ruby-style variable name to JSON key.
104
113
  def self.attribute_map
105
114
  {
115
+ :'after_step_uuid' => :'after_step_uuid',
106
116
  :'attribute_names' => :'attribute_names',
107
117
  :'blog_post_oid' => :'blog_post_oid',
118
+ :'branch_step_uuid' => :'branch_step_uuid',
108
119
  :'content_sha256' => :'content_sha256',
109
120
  :'domain' => :'domain',
110
121
  :'esp_twilio_uuid' => :'esp_twilio_uuid',
@@ -117,6 +128,7 @@ module UltracartClient
117
128
  :'rule_count' => :'rule_count',
118
129
  :'segment_uuid' => :'segment_uuid',
119
130
  :'sequence_uuid' => :'sequence_uuid',
131
+ :'side' => :'side',
120
132
  :'slot' => :'slot',
121
133
  :'step_uuid' => :'step_uuid',
122
134
  :'upsell_kind' => :'upsell_kind',
@@ -135,8 +147,10 @@ module UltracartClient
135
147
  # Attribute type mapping.
136
148
  def self.openapi_types
137
149
  {
150
+ :'after_step_uuid' => :'String',
138
151
  :'attribute_names' => :'Array<String>',
139
152
  :'blog_post_oid' => :'Integer',
153
+ :'branch_step_uuid' => :'String',
140
154
  :'content_sha256' => :'String',
141
155
  :'domain' => :'String',
142
156
  :'esp_twilio_uuid' => :'String',
@@ -149,6 +163,7 @@ module UltracartClient
149
163
  :'rule_count' => :'Integer',
150
164
  :'segment_uuid' => :'String',
151
165
  :'sequence_uuid' => :'String',
166
+ :'side' => :'String',
152
167
  :'slot' => :'String',
153
168
  :'step_uuid' => :'String',
154
169
  :'upsell_kind' => :'String',
@@ -180,6 +195,10 @@ module UltracartClient
180
195
  h[k.to_sym] = v
181
196
  }
182
197
 
198
+ if attributes.key?(:'after_step_uuid')
199
+ self.after_step_uuid = attributes[:'after_step_uuid']
200
+ end
201
+
183
202
  if attributes.key?(:'attribute_names')
184
203
  if (value = attributes[:'attribute_names']).is_a?(Array)
185
204
  self.attribute_names = value
@@ -190,6 +209,10 @@ module UltracartClient
190
209
  self.blog_post_oid = attributes[:'blog_post_oid']
191
210
  end
192
211
 
212
+ if attributes.key?(:'branch_step_uuid')
213
+ self.branch_step_uuid = attributes[:'branch_step_uuid']
214
+ end
215
+
193
216
  if attributes.key?(:'content_sha256')
194
217
  self.content_sha256 = attributes[:'content_sha256']
195
218
  end
@@ -238,6 +261,10 @@ module UltracartClient
238
261
  self.sequence_uuid = attributes[:'sequence_uuid']
239
262
  end
240
263
 
264
+ if attributes.key?(:'side')
265
+ self.side = attributes[:'side']
266
+ end
267
+
241
268
  if attributes.key?(:'slot')
242
269
  self.slot = attributes[:'slot']
243
270
  end
@@ -297,8 +324,10 @@ module UltracartClient
297
324
  def ==(o)
298
325
  return true if self.equal?(o)
299
326
  self.class == o.class &&
327
+ after_step_uuid == o.after_step_uuid &&
300
328
  attribute_names == o.attribute_names &&
301
329
  blog_post_oid == o.blog_post_oid &&
330
+ branch_step_uuid == o.branch_step_uuid &&
302
331
  content_sha256 == o.content_sha256 &&
303
332
  domain == o.domain &&
304
333
  esp_twilio_uuid == o.esp_twilio_uuid &&
@@ -311,6 +340,7 @@ module UltracartClient
311
340
  rule_count == o.rule_count &&
312
341
  segment_uuid == o.segment_uuid &&
313
342
  sequence_uuid == o.sequence_uuid &&
343
+ side == o.side &&
314
344
  slot == o.slot &&
315
345
  step_uuid == o.step_uuid &&
316
346
  upsell_kind == o.upsell_kind &&
@@ -329,7 +359,7 @@ module UltracartClient
329
359
  # Calculates hash code according to all attributes.
330
360
  # @return [Integer] Hash code
331
361
  def hash
332
- [attribute_names, blog_post_oid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, slot, step_uuid, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
362
+ [after_step_uuid, attribute_names, blog_post_oid, branch_step_uuid, content_sha256, domain, esp_twilio_uuid, experiment_oid, item_count, merchant_item_oid, path, request_sha256, rows_sha256, rule_count, segment_uuid, sequence_uuid, side, slot, step_uuid, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
333
363
  end
334
364
 
335
365
  # Builds the object from hash