postboost 1.49.0 → 1.56.0

data/lib/postboost/models/free_tool_score_social_audit_request.rb

@@ -0,0 +1,335 @@
+=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.56.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolScoreSocialAuditRequest
+    # Your own posting target per network and week, used in the frequency question.
+    attr_accessor :target_posts_per_week
+
+    attr_accessor :instagram
+
+    attr_accessor :facebook
+
+    attr_accessor :linkedin
+
+    attr_accessor :x
+
+    attr_accessor :tiktok
+
+    attr_accessor :youtube
+
+    attr_accessor :pinterest
+
+    attr_accessor :threads
+
+    attr_accessor :bluesky
+
+    attr_accessor :mastodon
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'target_posts_per_week' => :'target_posts_per_week',
+        :'instagram' => :'instagram',
+        :'facebook' => :'facebook',
+        :'linkedin' => :'linkedin',
+        :'x' => :'x',
+        :'tiktok' => :'tiktok',
+        :'youtube' => :'youtube',
+        :'pinterest' => :'pinterest',
+        :'threads' => :'threads',
+        :'bluesky' => :'bluesky',
+        :'mastodon' => :'mastodon'
+      }
+    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
+      {
+        :'target_posts_per_week' => :'Integer',
+        :'instagram' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'facebook' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'linkedin' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'x' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'tiktok' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'youtube' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'pinterest' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'threads' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'bluesky' => :'FreeToolScoreSocialAuditRequestInstagram',
+        :'mastodon' => :'FreeToolScoreSocialAuditRequestInstagram'
+      }
+    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::FreeToolScoreSocialAuditRequest` 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::FreeToolScoreSocialAuditRequest`. 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?(:'target_posts_per_week')
+        self.target_posts_per_week = attributes[:'target_posts_per_week']
+      else
+        self.target_posts_per_week = 3
+      end
+
+      if attributes.key?(:'instagram')
+        self.instagram = attributes[:'instagram']
+      end
+
+      if attributes.key?(:'facebook')
+        self.facebook = attributes[:'facebook']
+      end
+
+      if attributes.key?(:'linkedin')
+        self.linkedin = attributes[:'linkedin']
+      end
+
+      if attributes.key?(:'x')
+        self.x = attributes[:'x']
+      end
+
+      if attributes.key?(:'tiktok')
+        self.tiktok = attributes[:'tiktok']
+      end
+
+      if attributes.key?(:'youtube')
+        self.youtube = attributes[:'youtube']
+      end
+
+      if attributes.key?(:'pinterest')
+        self.pinterest = attributes[:'pinterest']
+      end
+
+      if attributes.key?(:'threads')
+        self.threads = attributes[:'threads']
+      end
+
+      if attributes.key?(:'bluesky')
+        self.bluesky = attributes[:'bluesky']
+      end
+
+      if attributes.key?(:'mastodon')
+        self.mastodon = attributes[:'mastodon']
+      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 !@target_posts_per_week.nil? && @target_posts_per_week > 50
+        invalid_properties.push('invalid value for "target_posts_per_week", must be smaller than or equal to 50.')
+      end
+
+      if !@target_posts_per_week.nil? && @target_posts_per_week < 1
+        invalid_properties.push('invalid value for "target_posts_per_week", must be greater than or equal to 1.')
+      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 !@target_posts_per_week.nil? && @target_posts_per_week > 50
+      return false if !@target_posts_per_week.nil? && @target_posts_per_week < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_posts_per_week Value to be assigned
+    def target_posts_per_week=(target_posts_per_week)
+      if target_posts_per_week.nil?
+        fail ArgumentError, 'target_posts_per_week cannot be nil'
+      end
+
+      if target_posts_per_week > 50
+        fail ArgumentError, 'invalid value for "target_posts_per_week", must be smaller than or equal to 50.'
+      end
+
+      if target_posts_per_week < 1
+        fail ArgumentError, 'invalid value for "target_posts_per_week", must be greater than or equal to 1.'
+      end
+
+      @target_posts_per_week = target_posts_per_week
+    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 &&
+          target_posts_per_week == o.target_posts_per_week &&
+          instagram == o.instagram &&
+          facebook == o.facebook &&
+          linkedin == o.linkedin &&
+          x == o.x &&
+          tiktok == o.tiktok &&
+          youtube == o.youtube &&
+          pinterest == o.pinterest &&
+          threads == o.threads &&
+          bluesky == o.bluesky &&
+          mastodon == o.mastodon
+    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
+      [target_posts_per_week, instagram, facebook, linkedin, x, tiktok, youtube, pinterest, threads, bluesky, mastodon].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