postboost 1.57.7 → 1.61.0

data/lib/postboost/models/free_tool_pick_giveaway_winners_request.rb

@@ -0,0 +1,467 @@
+=begin
+#PostBoost API
+
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts on every supported network from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+
+The version of the OpenAPI document: 1.61.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolPickGiveawayWinnersRequest
+    # The comments, one item each. The request body is capped at 128 KB.
+    attr_accessor :entrants
+
+    # The secret seed, 64 hex characters (32 bytes), whose fingerprint you published before the entries closed. Without it, a seed is generated and pre_committed is false. The steps of the draw (pb-draw-v1) and a test vector are on the web tool page.
+    attr_accessor :seed
+
+    # Count each username once. Off: every comment is an entry, so one person can win more than once.
+    attr_accessor :one_per_person
+
+    # Keep only comments that contain at least one of these, case-insensitive.
+    attr_accessor :keywords
+
+    # Keep only comments that tag at least this many other @handles.
+    attr_accessor :min_mentions
+
+    # Usernames to leave out of the draw, such as the host account.
+    attr_accessor :exclude
+
+    attr_accessor :winners
+
+    # Runners-up drawn after the winners, in order.
+    attr_accessor :alternates
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'entrants' => :'entrants',
+        :'seed' => :'seed',
+        :'one_per_person' => :'one_per_person',
+        :'keywords' => :'keywords',
+        :'min_mentions' => :'min_mentions',
+        :'exclude' => :'exclude',
+        :'winners' => :'winners',
+        :'alternates' => :'alternates'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'entrants' => :'Array<FreeToolPickGiveawayWinnersRequestEntrantsInner>',
+        :'seed' => :'String',
+        :'one_per_person' => :'Boolean',
+        :'keywords' => :'Array<String>',
+        :'min_mentions' => :'Integer',
+        :'exclude' => :'Array<String>',
+        :'winners' => :'Integer',
+        :'alternates' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PostBoost::FreeToolPickGiveawayWinnersRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PostBoost::FreeToolPickGiveawayWinnersRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'entrants')
+        if (value = attributes[:'entrants']).is_a?(Array)
+          self.entrants = value
+        end
+      else
+        self.entrants = nil
+      end
+
+      if attributes.key?(:'seed')
+        self.seed = attributes[:'seed']
+      end
+
+      if attributes.key?(:'one_per_person')
+        self.one_per_person = attributes[:'one_per_person']
+      else
+        self.one_per_person = true
+      end
+
+      if attributes.key?(:'keywords')
+        if (value = attributes[:'keywords']).is_a?(Array)
+          self.keywords = value
+        end
+      end
+
+      if attributes.key?(:'min_mentions')
+        self.min_mentions = attributes[:'min_mentions']
+      else
+        self.min_mentions = 0
+      end
+
+      if attributes.key?(:'exclude')
+        if (value = attributes[:'exclude']).is_a?(Array)
+          self.exclude = value
+        end
+      end
+
+      if attributes.key?(:'winners')
+        self.winners = attributes[:'winners']
+      else
+        self.winners = 1
+      end
+
+      if attributes.key?(:'alternates')
+        self.alternates = attributes[:'alternates']
+      else
+        self.alternates = 0
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @entrants.nil?
+        invalid_properties.push('invalid value for "entrants", entrants cannot be nil.')
+      end
+
+      if @entrants.length > 50000
+        invalid_properties.push('invalid value for "entrants", number of items must be less than or equal to 50000.')
+      end
+
+      pattern = Regexp.new(/^[0-9a-fA-F]{64}$/)
+      if !@seed.nil? && @seed !~ pattern
+        invalid_properties.push("invalid value for \"seed\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@keywords.nil? && @keywords.length > 20
+        invalid_properties.push('invalid value for "keywords", number of items must be less than or equal to 20.')
+      end
+
+      if !@min_mentions.nil? && @min_mentions > 10
+        invalid_properties.push('invalid value for "min_mentions", must be smaller than or equal to 10.')
+      end
+
+      if !@min_mentions.nil? && @min_mentions < 0
+        invalid_properties.push('invalid value for "min_mentions", must be greater than or equal to 0.')
+      end
+
+      if !@exclude.nil? && @exclude.length > 100
+        invalid_properties.push('invalid value for "exclude", number of items must be less than or equal to 100.')
+      end
+
+      if !@winners.nil? && @winners > 100
+        invalid_properties.push('invalid value for "winners", must be smaller than or equal to 100.')
+      end
+
+      if !@winners.nil? && @winners < 1
+        invalid_properties.push('invalid value for "winners", must be greater than or equal to 1.')
+      end
+
+      if !@alternates.nil? && @alternates > 20
+        invalid_properties.push('invalid value for "alternates", must be smaller than or equal to 20.')
+      end
+
+      if !@alternates.nil? && @alternates < 0
+        invalid_properties.push('invalid value for "alternates", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @entrants.nil?
+      return false if @entrants.length > 50000
+      return false if !@seed.nil? && @seed !~ Regexp.new(/^[0-9a-fA-F]{64}$/)
+      return false if !@keywords.nil? && @keywords.length > 20
+      return false if !@min_mentions.nil? && @min_mentions > 10
+      return false if !@min_mentions.nil? && @min_mentions < 0
+      return false if !@exclude.nil? && @exclude.length > 100
+      return false if !@winners.nil? && @winners > 100
+      return false if !@winners.nil? && @winners < 1
+      return false if !@alternates.nil? && @alternates > 20
+      return false if !@alternates.nil? && @alternates < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] entrants Value to be assigned
+    def entrants=(entrants)
+      if entrants.nil?
+        fail ArgumentError, 'entrants cannot be nil'
+      end
+
+      if entrants.length > 50000
+        fail ArgumentError, 'invalid value for "entrants", number of items must be less than or equal to 50000.'
+      end
+
+      @entrants = entrants
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] seed Value to be assigned
+    def seed=(seed)
+      if seed.nil?
+        fail ArgumentError, 'seed cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[0-9a-fA-F]{64}$/)
+      if seed !~ pattern
+        fail ArgumentError, "invalid value for \"seed\", must conform to the pattern #{pattern}."
+      end
+
+      @seed = seed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keywords Value to be assigned
+    def keywords=(keywords)
+      if keywords.nil?
+        fail ArgumentError, 'keywords cannot be nil'
+      end
+
+      if keywords.length > 20
+        fail ArgumentError, 'invalid value for "keywords", number of items must be less than or equal to 20.'
+      end
+
+      @keywords = keywords
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_mentions Value to be assigned
+    def min_mentions=(min_mentions)
+      if min_mentions.nil?
+        fail ArgumentError, 'min_mentions cannot be nil'
+      end
+
+      if min_mentions > 10
+        fail ArgumentError, 'invalid value for "min_mentions", must be smaller than or equal to 10.'
+      end
+
+      if min_mentions < 0
+        fail ArgumentError, 'invalid value for "min_mentions", must be greater than or equal to 0.'
+      end
+
+      @min_mentions = min_mentions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] exclude Value to be assigned
+    def exclude=(exclude)
+      if exclude.nil?
+        fail ArgumentError, 'exclude cannot be nil'
+      end
+
+      if exclude.length > 100
+        fail ArgumentError, 'invalid value for "exclude", number of items must be less than or equal to 100.'
+      end
+
+      @exclude = exclude
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] winners Value to be assigned
+    def winners=(winners)
+      if winners.nil?
+        fail ArgumentError, 'winners cannot be nil'
+      end
+
+      if winners > 100
+        fail ArgumentError, 'invalid value for "winners", must be smaller than or equal to 100.'
+      end
+
+      if winners < 1
+        fail ArgumentError, 'invalid value for "winners", must be greater than or equal to 1.'
+      end
+
+      @winners = winners
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] alternates Value to be assigned
+    def alternates=(alternates)
+      if alternates.nil?
+        fail ArgumentError, 'alternates cannot be nil'
+      end
+
+      if alternates > 20
+        fail ArgumentError, 'invalid value for "alternates", must be smaller than or equal to 20.'
+      end
+
+      if alternates < 0
+        fail ArgumentError, 'invalid value for "alternates", must be greater than or equal to 0.'
+      end
+
+      @alternates = alternates
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          entrants == o.entrants &&
+          seed == o.seed &&
+          one_per_person == o.one_per_person &&
+          keywords == o.keywords &&
+          min_mentions == o.min_mentions &&
+          exclude == o.exclude &&
+          winners == o.winners &&
+          alternates == o.alternates
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [entrants, seed, one_per_person, keywords, min_mentions, exclude, winners, alternates].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PostBoost.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end