postboost 1.45.0 → 1.49.0

data/lib/postboost/models/free_tool_calculate_social_roi_request_costs.rb

@@ -0,0 +1,446 @@
+=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.49.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  # What social media cost in the period, in USD. Every field is optional.
+  class FreeToolCalculateSocialRoiRequestCosts
+    # Paid social ad spend.
+    attr_accessor :ad_spend
+
+    # Tools and software subscriptions.
+    attr_accessor :tools
+
+    # Hours spent on social media.
+    attr_accessor :labor_hours
+
+    # Cost of one hour of that work.
+    attr_accessor :hourly_rate
+
+    # Content production: design, video, photography, freelancers.
+    attr_accessor :content
+
+    # Anything else.
+    attr_accessor :other
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ad_spend' => :'ad_spend',
+        :'tools' => :'tools',
+        :'labor_hours' => :'labor_hours',
+        :'hourly_rate' => :'hourly_rate',
+        :'content' => :'content',
+        :'other' => :'other'
+      }
+    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
+      {
+        :'ad_spend' => :'Float',
+        :'tools' => :'Float',
+        :'labor_hours' => :'Float',
+        :'hourly_rate' => :'Float',
+        :'content' => :'Float',
+        :'other' => :'Float'
+      }
+    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::FreeToolCalculateSocialRoiRequestCosts` 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::FreeToolCalculateSocialRoiRequestCosts`. 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?(:'ad_spend')
+        self.ad_spend = attributes[:'ad_spend']
+      else
+        self.ad_spend = 0
+      end
+
+      if attributes.key?(:'tools')
+        self.tools = attributes[:'tools']
+      else
+        self.tools = 0
+      end
+
+      if attributes.key?(:'labor_hours')
+        self.labor_hours = attributes[:'labor_hours']
+      else
+        self.labor_hours = 0
+      end
+
+      if attributes.key?(:'hourly_rate')
+        self.hourly_rate = attributes[:'hourly_rate']
+      else
+        self.hourly_rate = 0
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      else
+        self.content = 0
+      end
+
+      if attributes.key?(:'other')
+        self.other = attributes[:'other']
+      else
+        self.other = 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 !@ad_spend.nil? && @ad_spend > 1000000000000
+        invalid_properties.push('invalid value for "ad_spend", must be smaller than or equal to 1000000000000.')
+      end
+
+      if !@ad_spend.nil? && @ad_spend < 0
+        invalid_properties.push('invalid value for "ad_spend", must be greater than or equal to 0.')
+      end
+
+      if !@tools.nil? && @tools > 1000000000000
+        invalid_properties.push('invalid value for "tools", must be smaller than or equal to 1000000000000.')
+      end
+
+      if !@tools.nil? && @tools < 0
+        invalid_properties.push('invalid value for "tools", must be greater than or equal to 0.')
+      end
+
+      if !@labor_hours.nil? && @labor_hours > 100000
+        invalid_properties.push('invalid value for "labor_hours", must be smaller than or equal to 100000.')
+      end
+
+      if !@labor_hours.nil? && @labor_hours < 0
+        invalid_properties.push('invalid value for "labor_hours", must be greater than or equal to 0.')
+      end
+
+      if !@hourly_rate.nil? && @hourly_rate > 1000000000000
+        invalid_properties.push('invalid value for "hourly_rate", must be smaller than or equal to 1000000000000.')
+      end
+
+      if !@hourly_rate.nil? && @hourly_rate < 0
+        invalid_properties.push('invalid value for "hourly_rate", must be greater than or equal to 0.')
+      end
+
+      if !@content.nil? && @content > 1000000000000
+        invalid_properties.push('invalid value for "content", must be smaller than or equal to 1000000000000.')
+      end
+
+      if !@content.nil? && @content < 0
+        invalid_properties.push('invalid value for "content", must be greater than or equal to 0.')
+      end
+
+      if !@other.nil? && @other > 1000000000000
+        invalid_properties.push('invalid value for "other", must be smaller than or equal to 1000000000000.')
+      end
+
+      if !@other.nil? && @other < 0
+        invalid_properties.push('invalid value for "other", 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 !@ad_spend.nil? && @ad_spend > 1000000000000
+      return false if !@ad_spend.nil? && @ad_spend < 0
+      return false if !@tools.nil? && @tools > 1000000000000
+      return false if !@tools.nil? && @tools < 0
+      return false if !@labor_hours.nil? && @labor_hours > 100000
+      return false if !@labor_hours.nil? && @labor_hours < 0
+      return false if !@hourly_rate.nil? && @hourly_rate > 1000000000000
+      return false if !@hourly_rate.nil? && @hourly_rate < 0
+      return false if !@content.nil? && @content > 1000000000000
+      return false if !@content.nil? && @content < 0
+      return false if !@other.nil? && @other > 1000000000000
+      return false if !@other.nil? && @other < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ad_spend Value to be assigned
+    def ad_spend=(ad_spend)
+      if ad_spend.nil?
+        fail ArgumentError, 'ad_spend cannot be nil'
+      end
+
+      if ad_spend > 1000000000000
+        fail ArgumentError, 'invalid value for "ad_spend", must be smaller than or equal to 1000000000000.'
+      end
+
+      if ad_spend < 0
+        fail ArgumentError, 'invalid value for "ad_spend", must be greater than or equal to 0.'
+      end
+
+      @ad_spend = ad_spend
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tools Value to be assigned
+    def tools=(tools)
+      if tools.nil?
+        fail ArgumentError, 'tools cannot be nil'
+      end
+
+      if tools > 1000000000000
+        fail ArgumentError, 'invalid value for "tools", must be smaller than or equal to 1000000000000.'
+      end
+
+      if tools < 0
+        fail ArgumentError, 'invalid value for "tools", must be greater than or equal to 0.'
+      end
+
+      @tools = tools
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] labor_hours Value to be assigned
+    def labor_hours=(labor_hours)
+      if labor_hours.nil?
+        fail ArgumentError, 'labor_hours cannot be nil'
+      end
+
+      if labor_hours > 100000
+        fail ArgumentError, 'invalid value for "labor_hours", must be smaller than or equal to 100000.'
+      end
+
+      if labor_hours < 0
+        fail ArgumentError, 'invalid value for "labor_hours", must be greater than or equal to 0.'
+      end
+
+      @labor_hours = labor_hours
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] hourly_rate Value to be assigned
+    def hourly_rate=(hourly_rate)
+      if hourly_rate.nil?
+        fail ArgumentError, 'hourly_rate cannot be nil'
+      end
+
+      if hourly_rate > 1000000000000
+        fail ArgumentError, 'invalid value for "hourly_rate", must be smaller than or equal to 1000000000000.'
+      end
+
+      if hourly_rate < 0
+        fail ArgumentError, 'invalid value for "hourly_rate", must be greater than or equal to 0.'
+      end
+
+      @hourly_rate = hourly_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] content Value to be assigned
+    def content=(content)
+      if content.nil?
+        fail ArgumentError, 'content cannot be nil'
+      end
+
+      if content > 1000000000000
+        fail ArgumentError, 'invalid value for "content", must be smaller than or equal to 1000000000000.'
+      end
+
+      if content < 0
+        fail ArgumentError, 'invalid value for "content", must be greater than or equal to 0.'
+      end
+
+      @content = content
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] other Value to be assigned
+    def other=(other)
+      if other.nil?
+        fail ArgumentError, 'other cannot be nil'
+      end
+
+      if other > 1000000000000
+        fail ArgumentError, 'invalid value for "other", must be smaller than or equal to 1000000000000.'
+      end
+
+      if other < 0
+        fail ArgumentError, 'invalid value for "other", must be greater than or equal to 0.'
+      end
+
+      @other = other
+    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 &&
+          ad_spend == o.ad_spend &&
+          tools == o.tools &&
+          labor_hours == o.labor_hours &&
+          hourly_rate == o.hourly_rate &&
+          content == o.content &&
+          other == o.other
+    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
+      [ad_spend, tools, labor_hours, hourly_rate, content, other].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