ultracart_api 4.1.217 → 4.1.218

data/lib/ultracart_api/api/sfvb_api.rb

@@ -3947,6 +3947,76 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Read one segment, with its rule
+    # The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live.  hash_sha256 is the If-Match for an update.  Never its members, its Facebook audience, its ranking or its third party sync settings. 
+    # @param storefront_oid [Integer] 
+    # @param segment_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbCommsSegmentResponse]
+    def get_sfvb_comms_segment(storefront_oid, segment_uuid, opts = {})
+      data, _status_code, _headers = get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts)
+      data
+    end
+
+    # Read one segment, with its rule
+    # The segment's name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live.  hash_sha256 is the If-Match for an update.  Never its members, its Facebook audience, its ranking or its third party sync settings. 
+    # @param storefront_oid [Integer] 
+    # @param segment_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
+    def get_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.get_sfvb_comms_segment ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.get_sfvb_comms_segment"
+      end
+      # verify the required parameter 'segment_uuid' is set
+      if @api_client.config.client_side_validation && segment_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.get_sfvb_comms_segment"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.get_sfvb_comms_segment",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#get_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read a sending domain
     # One sending domain as stored.  To check an amazon domain's DNS again, use the status call. 
     # @param domain [String] 
@@ -8099,6 +8169,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Create a segment
+    # A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false. 
+    # @param storefront_oid [Integer] 
+    # @param segment_write_request [SfvbCommsSegmentWriteRequest] The new segment&#39;s name, rule and folder
+    # @param [Hash] opts the optional parameters
+    # @return [SfvbCommsSegmentResponse]
+    def insert_sfvb_comms_segment(storefront_oid, segment_write_request, opts = {})
+      data, _status_code, _headers = insert_sfvb_comms_segment_with_http_info(storefront_oid, segment_write_request, opts)
+      data
+    end
+
+    # Create a segment
+    # A new segment with the name, rule and folder given.  The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront.  The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false. 
+    # @param storefront_oid [Integer] 
+    # @param segment_write_request [SfvbCommsSegmentWriteRequest] The new segment&#39;s name, rule and folder
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
+    def insert_sfvb_comms_segment_with_http_info(storefront_oid, segment_write_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.insert_sfvb_comms_segment ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.insert_sfvb_comms_segment"
+      end
+      # verify the required parameter 'segment_write_request' is set
+      if @api_client.config.client_side_validation && segment_write_request.nil?
+        fail ArgumentError, "Missing the required parameter 'segment_write_request' when calling SfvbApi.insert_sfvb_comms_segment"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/segments'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_write_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.insert_sfvb_comms_segment",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#insert_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add a sending domain
     # 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. 
     # @param sending_domain [SfvbCommsSendingDomain] The sending domain
@@ -14209,6 +14354,97 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Change a segment's name, rule or folder
+    # A field left out stays as it is.  Send the segment's hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither. 
+    # @param storefront_oid [Integer] 
+    # @param segment_uuid [String] 
+    # @param if_match [String] The segment&#39;s hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param segment_write_request [SfvbCommsSegmentWriteRequest] The fields to change
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :approval_id When the rule changes and a live campaign or flow uses the segment, the approval_id of an approved segment.update request for this change.  See POST /sfvb/approvals.
+    # @return [SfvbCommsSegmentResponse]
+    def update_sfvb_comms_segment(storefront_oid, segment_uuid, if_match, segment_write_request, opts = {})
+      data, _status_code, _headers = update_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, segment_write_request, opts)
+      data
+    end
+
+    # Change a segment&#39;s name, rule or folder
+    # A field left out stays as it is.  Send the segment&#39;s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read.  A changed rule is checked as on a create and starts a rebuild.  Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither. 
+    # @param storefront_oid [Integer] 
+    # @param segment_uuid [String] 
+    # @param if_match [String] The segment&#39;s hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+    # @param segment_write_request [SfvbCommsSegmentWriteRequest] The fields to change
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :approval_id When the rule changes and a live campaign or flow uses the segment, the approval_id of an approved segment.update request for this change.  See POST /sfvb/approvals.
+    # @return [Array<(SfvbCommsSegmentResponse, Integer, Hash)>] SfvbCommsSegmentResponse data, response status code and response headers
+    def update_sfvb_comms_segment_with_http_info(storefront_oid, segment_uuid, if_match, segment_write_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SfvbApi.update_sfvb_comms_segment ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling SfvbApi.update_sfvb_comms_segment"
+      end
+      # verify the required parameter 'segment_uuid' is set
+      if @api_client.config.client_side_validation && segment_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'segment_uuid' when calling SfvbApi.update_sfvb_comms_segment"
+      end
+      # verify the required parameter 'if_match' is set
+      if @api_client.config.client_side_validation && if_match.nil?
+        fail ArgumentError, "Missing the required parameter 'if_match' when calling SfvbApi.update_sfvb_comms_segment"
+      end
+      # verify the required parameter 'segment_write_request' is set
+      if @api_client.config.client_side_validation && segment_write_request.nil?
+        fail ArgumentError, "Missing the required parameter 'segment_write_request' when calling SfvbApi.update_sfvb_comms_segment"
+      end
+      # resource path
+      local_var_path = '/sfvb/storefronts/{storefront_oid}/segments/{segment_uuid}'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'segment_uuid' + '}', CGI.escape(segment_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'If-Match'] = if_match
+      header_params[:'Approval-Id'] = opts[:'approval_id'] if !opts[:'approval_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_write_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SfvbCommsSegmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"SfvbApi.update_sfvb_comms_segment",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SfvbApi#update_sfvb_comms_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a sending domain
     # 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. 
     # @param domain [String] 

data/lib/ultracart_api/models/sfvb_approval_create_request.rb

@@ -36,6 +36,8 @@ module UltracartClient
     # For redirect.delete_batch, exactly the rows the batch delete will send, up to 5,000, each with its hash_sha256.  UltraCart keeps only their hash.
     attr_accessor :redirect_rows
 
+    attr_accessor :segment_update
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -68,7 +70,8 @@ module UltracartClient
         :'item_pricing' => :'item_pricing',
         :'params' => :'params',
         :'reason' => :'reason',
-        :'redirect_rows' => :'redirect_rows'
+        :'redirect_rows' => :'redirect_rows',
+        :'segment_update' => :'segment_update'
       }
     end
 
@@ -87,7 +90,8 @@ module UltracartClient
         :'item_pricing' => :'SfvbItemPricingRequest',
         :'params' => :'SfvbApprovalParams',
         :'reason' => :'String',
-        :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>'
+        :'redirect_rows' => :'Array<SfvbRedirectDeleteRow>',
+        :'segment_update' => :'SfvbCommsSegmentWriteRequest'
       }
     end
 
@@ -147,6 +151,10 @@ module UltracartClient
           self.redirect_rows = value
         end
       end
+
+      if attributes.key?(:'segment_update')
+        self.segment_update = attributes[:'segment_update']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -159,7 +167,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete"])
+      action_validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "segment.update"])
       return false unless action_validator.valid?(@action)
       true
     end
@@ -167,7 +175,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] action Object to be assigned
     def action=(action)
-      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete"])
+      validator = EnumAttributeValidator.new('String', ["file.delete", "blog_post.delete", "file.put_script", "redirect.delete_batch", "experiment.start", "experiment.end", "upsell.enable", "item.attribute_batch", "item.pricing", "twilio_account.delete", "sending_domain.delete", "sequence_step.delete", "segment.update"])
       unless validator.valid?(action)
         fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
       end
@@ -186,7 +194,8 @@ module UltracartClient
           item_pricing == o.item_pricing &&
           params == o.params &&
           reason == o.reason &&
-          redirect_rows == o.redirect_rows
+          redirect_rows == o.redirect_rows &&
+          segment_update == o.segment_update
     end
 
     # @see the `==` method
@@ -198,7 +207,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows].hash
+      [action, content, experiment_start, item_attribute_rows, item_pricing, params, reason, redirect_rows, segment_update].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/sfvb_approval_params.rb

@@ -51,6 +51,9 @@ module UltracartClient
     # For redirect.delete_batch, how many rules the batch would delete when it was requested.  Set by the server.
     attr_accessor :rule_count
 
+    # The segment whose rule changes, for segment.update.
+    attr_accessor :segment_uuid
+
     # The communication sequence, for sequence_step.delete.
     attr_accessor :sequence_uuid
 
@@ -112,6 +115,7 @@ module UltracartClient
         :'request_sha256' => :'request_sha256',
         :'rows_sha256' => :'rows_sha256',
         :'rule_count' => :'rule_count',
+        :'segment_uuid' => :'segment_uuid',
         :'sequence_uuid' => :'sequence_uuid',
         :'slot' => :'slot',
         :'step_uuid' => :'step_uuid',
@@ -143,6 +147,7 @@ module UltracartClient
         :'request_sha256' => :'String',
         :'rows_sha256' => :'String',
         :'rule_count' => :'Integer',
+        :'segment_uuid' => :'String',
         :'sequence_uuid' => :'String',
         :'slot' => :'String',
         :'step_uuid' => :'String',
@@ -225,6 +230,10 @@ module UltracartClient
         self.rule_count = attributes[:'rule_count']
       end
 
+      if attributes.key?(:'segment_uuid')
+        self.segment_uuid = attributes[:'segment_uuid']
+      end
+
       if attributes.key?(:'sequence_uuid')
         self.sequence_uuid = attributes[:'sequence_uuid']
       end
@@ -300,6 +309,7 @@ module UltracartClient
           request_sha256 == o.request_sha256 &&
           rows_sha256 == o.rows_sha256 &&
           rule_count == o.rule_count &&
+          segment_uuid == o.segment_uuid &&
           sequence_uuid == o.sequence_uuid &&
           slot == o.slot &&
           step_uuid == o.step_uuid &&
@@ -319,7 +329,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [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, sequence_uuid, slot, step_uuid, upsell_kind, upsell_oid, version, widget_id, winner_variation_number].hash
+      [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
     end
 
     # Builds the object from hash