postboost 1.49.0 → 1.56.0

data/lib/postboost/models/free_tool_calculate_influencer_rate_request.rb

@@ -0,0 +1,451 @@
+=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 FreeToolCalculateInfluencerRateRequest
+    # LinkedIn is not offered: no primary source for its rates.
+    attr_accessor :network
+
+    # Followers (subscribers on YouTube). Sets the tier.
+    attr_accessor :followers
+
+    # Instagram: post (default), reel, carousel. TikTok: video. X and Facebook: post. YouTube: integration (default), dedicated, short.
+    attr_accessor :deliverable
+
+    # Expected views of the deliverable. Required on YouTube, which is priced per 1,000 views; with cpm_usd it gives your own CPM estimate on any network.
+    attr_accessor :avg_views
+
+    # Your own price per 1,000 views, in whole USD, for the CPM estimate.
+    attr_accessor :cpm_usd
+
+    # Months the brand may reuse the content.
+    attr_accessor :usage_rights_months
+
+    # The creator agrees not to work with competitors for the campaign.
+    attr_accessor :exclusivity
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'network' => :'network',
+        :'followers' => :'followers',
+        :'deliverable' => :'deliverable',
+        :'avg_views' => :'avg_views',
+        :'cpm_usd' => :'cpm_usd',
+        :'usage_rights_months' => :'usage_rights_months',
+        :'exclusivity' => :'exclusivity'
+      }
+    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
+      {
+        :'network' => :'String',
+        :'followers' => :'Integer',
+        :'deliverable' => :'String',
+        :'avg_views' => :'Integer',
+        :'cpm_usd' => :'Integer',
+        :'usage_rights_months' => :'Integer',
+        :'exclusivity' => :'Boolean'
+      }
+    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::FreeToolCalculateInfluencerRateRequest` 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::FreeToolCalculateInfluencerRateRequest`. 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?(:'network')
+        self.network = attributes[:'network']
+      else
+        self.network = nil
+      end
+
+      if attributes.key?(:'followers')
+        self.followers = attributes[:'followers']
+      else
+        self.followers = nil
+      end
+
+      if attributes.key?(:'deliverable')
+        self.deliverable = attributes[:'deliverable']
+      end
+
+      if attributes.key?(:'avg_views')
+        self.avg_views = attributes[:'avg_views']
+      end
+
+      if attributes.key?(:'cpm_usd')
+        self.cpm_usd = attributes[:'cpm_usd']
+      end
+
+      if attributes.key?(:'usage_rights_months')
+        self.usage_rights_months = attributes[:'usage_rights_months']
+      else
+        self.usage_rights_months = 0
+      end
+
+      if attributes.key?(:'exclusivity')
+        self.exclusivity = attributes[:'exclusivity']
+      else
+        self.exclusivity = false
+      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 @network.nil?
+        invalid_properties.push('invalid value for "network", network cannot be nil.')
+      end
+
+      if @followers.nil?
+        invalid_properties.push('invalid value for "followers", followers cannot be nil.')
+      end
+
+      if @followers > 1000000000
+        invalid_properties.push('invalid value for "followers", must be smaller than or equal to 1000000000.')
+      end
+
+      if @followers < 1
+        invalid_properties.push('invalid value for "followers", must be greater than or equal to 1.')
+      end
+
+      if !@avg_views.nil? && @avg_views > 1000000000
+        invalid_properties.push('invalid value for "avg_views", must be smaller than or equal to 1000000000.')
+      end
+
+      if !@avg_views.nil? && @avg_views < 1
+        invalid_properties.push('invalid value for "avg_views", must be greater than or equal to 1.')
+      end
+
+      if !@cpm_usd.nil? && @cpm_usd > 1000
+        invalid_properties.push('invalid value for "cpm_usd", must be smaller than or equal to 1000.')
+      end
+
+      if !@cpm_usd.nil? && @cpm_usd < 1
+        invalid_properties.push('invalid value for "cpm_usd", must be greater than or equal to 1.')
+      end
+
+      if !@usage_rights_months.nil? && @usage_rights_months > 24
+        invalid_properties.push('invalid value for "usage_rights_months", must be smaller than or equal to 24.')
+      end
+
+      if !@usage_rights_months.nil? && @usage_rights_months < 0
+        invalid_properties.push('invalid value for "usage_rights_months", 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 @network.nil?
+      network_validator = EnumAttributeValidator.new('String', ["instagram", "tiktok", "youtube", "x", "facebook"])
+      return false unless network_validator.valid?(@network)
+      return false if @followers.nil?
+      return false if @followers > 1000000000
+      return false if @followers < 1
+      deliverable_validator = EnumAttributeValidator.new('String', ["post", "reel", "carousel", "video", "integration", "dedicated", "short"])
+      return false unless deliverable_validator.valid?(@deliverable)
+      return false if !@avg_views.nil? && @avg_views > 1000000000
+      return false if !@avg_views.nil? && @avg_views < 1
+      return false if !@cpm_usd.nil? && @cpm_usd > 1000
+      return false if !@cpm_usd.nil? && @cpm_usd < 1
+      return false if !@usage_rights_months.nil? && @usage_rights_months > 24
+      return false if !@usage_rights_months.nil? && @usage_rights_months < 0
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] network Object to be assigned
+    def network=(network)
+      validator = EnumAttributeValidator.new('String', ["instagram", "tiktok", "youtube", "x", "facebook"])
+      unless validator.valid?(network)
+        fail ArgumentError, "invalid value for \"network\", must be one of #{validator.allowable_values}."
+      end
+      @network = network
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] followers Value to be assigned
+    def followers=(followers)
+      if followers.nil?
+        fail ArgumentError, 'followers cannot be nil'
+      end
+
+      if followers > 1000000000
+        fail ArgumentError, 'invalid value for "followers", must be smaller than or equal to 1000000000.'
+      end
+
+      if followers < 1
+        fail ArgumentError, 'invalid value for "followers", must be greater than or equal to 1.'
+      end
+
+      @followers = followers
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deliverable Object to be assigned
+    def deliverable=(deliverable)
+      validator = EnumAttributeValidator.new('String', ["post", "reel", "carousel", "video", "integration", "dedicated", "short"])
+      unless validator.valid?(deliverable)
+        fail ArgumentError, "invalid value for \"deliverable\", must be one of #{validator.allowable_values}."
+      end
+      @deliverable = deliverable
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] avg_views Value to be assigned
+    def avg_views=(avg_views)
+      if avg_views.nil?
+        fail ArgumentError, 'avg_views cannot be nil'
+      end
+
+      if avg_views > 1000000000
+        fail ArgumentError, 'invalid value for "avg_views", must be smaller than or equal to 1000000000.'
+      end
+
+      if avg_views < 1
+        fail ArgumentError, 'invalid value for "avg_views", must be greater than or equal to 1.'
+      end
+
+      @avg_views = avg_views
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cpm_usd Value to be assigned
+    def cpm_usd=(cpm_usd)
+      if cpm_usd.nil?
+        fail ArgumentError, 'cpm_usd cannot be nil'
+      end
+
+      if cpm_usd > 1000
+        fail ArgumentError, 'invalid value for "cpm_usd", must be smaller than or equal to 1000.'
+      end
+
+      if cpm_usd < 1
+        fail ArgumentError, 'invalid value for "cpm_usd", must be greater than or equal to 1.'
+      end
+
+      @cpm_usd = cpm_usd
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] usage_rights_months Value to be assigned
+    def usage_rights_months=(usage_rights_months)
+      if usage_rights_months.nil?
+        fail ArgumentError, 'usage_rights_months cannot be nil'
+      end
+
+      if usage_rights_months > 24
+        fail ArgumentError, 'invalid value for "usage_rights_months", must be smaller than or equal to 24.'
+      end
+
+      if usage_rights_months < 0
+        fail ArgumentError, 'invalid value for "usage_rights_months", must be greater than or equal to 0.'
+      end
+
+      @usage_rights_months = usage_rights_months
+    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 &&
+          network == o.network &&
+          followers == o.followers &&
+          deliverable == o.deliverable &&
+          avg_views == o.avg_views &&
+          cpm_usd == o.cpm_usd &&
+          usage_rights_months == o.usage_rights_months &&
+          exclusivity == o.exclusivity
+    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
+      [network, followers, deliverable, avg_views, cpm_usd, usage_rights_months, exclusivity].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