postboost 1.56.0 → 1.57.1

data/lib/postboost/models/free_tool_summarize_report_request_rows_inner.rb

@@ -0,0 +1,513 @@
+=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.57.1
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolSummarizeReportRequestRowsInner
+    # Publish date; only a leading YYYY-MM-DD is read.
+    attr_accessor :date
+
+    attr_accessor :network
+
+    # The post text, a full caption is fine; the top posts show its first 80 characters.
+    attr_accessor :text
+
+    attr_accessor :views
+
+    attr_accessor :likes
+
+    attr_accessor :comments
+
+    attr_accessor :shares
+
+    attr_accessor :clicks
+
+    attr_accessor :engagements
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'date' => :'date',
+        :'network' => :'network',
+        :'text' => :'text',
+        :'views' => :'views',
+        :'likes' => :'likes',
+        :'comments' => :'comments',
+        :'shares' => :'shares',
+        :'clicks' => :'clicks',
+        :'engagements' => :'engagements'
+      }
+    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
+      {
+        :'date' => :'String',
+        :'network' => :'String',
+        :'text' => :'String',
+        :'views' => :'Integer',
+        :'likes' => :'Integer',
+        :'comments' => :'Integer',
+        :'shares' => :'Integer',
+        :'clicks' => :'Integer',
+        :'engagements' => :'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::FreeToolSummarizeReportRequestRowsInner` 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::FreeToolSummarizeReportRequestRowsInner`. 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?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'network')
+        self.network = attributes[:'network']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'views')
+        self.views = attributes[:'views']
+      end
+
+      if attributes.key?(:'likes')
+        self.likes = attributes[:'likes']
+      end
+
+      if attributes.key?(:'comments')
+        self.comments = attributes[:'comments']
+      end
+
+      if attributes.key?(:'shares')
+        self.shares = attributes[:'shares']
+      end
+
+      if attributes.key?(:'clicks')
+        self.clicks = attributes[:'clicks']
+      end
+
+      if attributes.key?(:'engagements')
+        self.engagements = attributes[:'engagements']
+      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 !@date.nil? && @date.to_s.length > 40
+        invalid_properties.push('invalid value for "date", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@network.nil? && @network.to_s.length > 60
+        invalid_properties.push('invalid value for "network", the character length must be smaller than or equal to 60.')
+      end
+
+      if !@text.nil? && @text.to_s.length > 5000
+        invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 5000.')
+      end
+
+      if !@views.nil? && @views > 100000000000
+        invalid_properties.push('invalid value for "views", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@views.nil? && @views < 0
+        invalid_properties.push('invalid value for "views", must be greater than or equal to 0.')
+      end
+
+      if !@likes.nil? && @likes > 100000000000
+        invalid_properties.push('invalid value for "likes", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@likes.nil? && @likes < 0
+        invalid_properties.push('invalid value for "likes", must be greater than or equal to 0.')
+      end
+
+      if !@comments.nil? && @comments > 100000000000
+        invalid_properties.push('invalid value for "comments", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@comments.nil? && @comments < 0
+        invalid_properties.push('invalid value for "comments", must be greater than or equal to 0.')
+      end
+
+      if !@shares.nil? && @shares > 100000000000
+        invalid_properties.push('invalid value for "shares", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@shares.nil? && @shares < 0
+        invalid_properties.push('invalid value for "shares", must be greater than or equal to 0.')
+      end
+
+      if !@clicks.nil? && @clicks > 100000000000
+        invalid_properties.push('invalid value for "clicks", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@clicks.nil? && @clicks < 0
+        invalid_properties.push('invalid value for "clicks", must be greater than or equal to 0.')
+      end
+
+      if !@engagements.nil? && @engagements > 100000000000
+        invalid_properties.push('invalid value for "engagements", must be smaller than or equal to 100000000000.')
+      end
+
+      if !@engagements.nil? && @engagements < 0
+        invalid_properties.push('invalid value for "engagements", 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 !@date.nil? && @date.to_s.length > 40
+      return false if !@network.nil? && @network.to_s.length > 60
+      return false if !@text.nil? && @text.to_s.length > 5000
+      return false if !@views.nil? && @views > 100000000000
+      return false if !@views.nil? && @views < 0
+      return false if !@likes.nil? && @likes > 100000000000
+      return false if !@likes.nil? && @likes < 0
+      return false if !@comments.nil? && @comments > 100000000000
+      return false if !@comments.nil? && @comments < 0
+      return false if !@shares.nil? && @shares > 100000000000
+      return false if !@shares.nil? && @shares < 0
+      return false if !@clicks.nil? && @clicks > 100000000000
+      return false if !@clicks.nil? && @clicks < 0
+      return false if !@engagements.nil? && @engagements > 100000000000
+      return false if !@engagements.nil? && @engagements < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date Value to be assigned
+    def date=(date)
+      if date.nil?
+        fail ArgumentError, 'date cannot be nil'
+      end
+
+      if date.to_s.length > 40
+        fail ArgumentError, 'invalid value for "date", the character length must be smaller than or equal to 40.'
+      end
+
+      @date = date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] network Value to be assigned
+    def network=(network)
+      if network.nil?
+        fail ArgumentError, 'network cannot be nil'
+      end
+
+      if network.to_s.length > 60
+        fail ArgumentError, 'invalid value for "network", the character length must be smaller than or equal to 60.'
+      end
+
+      @network = network
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text Value to be assigned
+    def text=(text)
+      if text.nil?
+        fail ArgumentError, 'text cannot be nil'
+      end
+
+      if text.to_s.length > 5000
+        fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 5000.'
+      end
+
+      @text = text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] views Value to be assigned
+    def views=(views)
+      if views.nil?
+        fail ArgumentError, 'views cannot be nil'
+      end
+
+      if views > 100000000000
+        fail ArgumentError, 'invalid value for "views", must be smaller than or equal to 100000000000.'
+      end
+
+      if views < 0
+        fail ArgumentError, 'invalid value for "views", must be greater than or equal to 0.'
+      end
+
+      @views = views
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] likes Value to be assigned
+    def likes=(likes)
+      if likes.nil?
+        fail ArgumentError, 'likes cannot be nil'
+      end
+
+      if likes > 100000000000
+        fail ArgumentError, 'invalid value for "likes", must be smaller than or equal to 100000000000.'
+      end
+
+      if likes < 0
+        fail ArgumentError, 'invalid value for "likes", must be greater than or equal to 0.'
+      end
+
+      @likes = likes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comments Value to be assigned
+    def comments=(comments)
+      if comments.nil?
+        fail ArgumentError, 'comments cannot be nil'
+      end
+
+      if comments > 100000000000
+        fail ArgumentError, 'invalid value for "comments", must be smaller than or equal to 100000000000.'
+      end
+
+      if comments < 0
+        fail ArgumentError, 'invalid value for "comments", must be greater than or equal to 0.'
+      end
+
+      @comments = comments
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shares Value to be assigned
+    def shares=(shares)
+      if shares.nil?
+        fail ArgumentError, 'shares cannot be nil'
+      end
+
+      if shares > 100000000000
+        fail ArgumentError, 'invalid value for "shares", must be smaller than or equal to 100000000000.'
+      end
+
+      if shares < 0
+        fail ArgumentError, 'invalid value for "shares", must be greater than or equal to 0.'
+      end
+
+      @shares = shares
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] clicks Value to be assigned
+    def clicks=(clicks)
+      if clicks.nil?
+        fail ArgumentError, 'clicks cannot be nil'
+      end
+
+      if clicks > 100000000000
+        fail ArgumentError, 'invalid value for "clicks", must be smaller than or equal to 100000000000.'
+      end
+
+      if clicks < 0
+        fail ArgumentError, 'invalid value for "clicks", must be greater than or equal to 0.'
+      end
+
+      @clicks = clicks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] engagements Value to be assigned
+    def engagements=(engagements)
+      if engagements.nil?
+        fail ArgumentError, 'engagements cannot be nil'
+      end
+
+      if engagements > 100000000000
+        fail ArgumentError, 'invalid value for "engagements", must be smaller than or equal to 100000000000.'
+      end
+
+      if engagements < 0
+        fail ArgumentError, 'invalid value for "engagements", must be greater than or equal to 0.'
+      end
+
+      @engagements = engagements
+    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 &&
+          date == o.date &&
+          network == o.network &&
+          text == o.text &&
+          views == o.views &&
+          likes == o.likes &&
+          comments == o.comments &&
+          shares == o.shares &&
+          clicks == o.clicks &&
+          engagements == o.engagements
+    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
+      [date, network, text, views, likes, comments, shares, clicks, engagements].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