postboost 1.43.0 → 1.44.0

data/lib/postboost/models/free_tool_plan_content_calendar_request.rb

@@ -0,0 +1,338 @@
+=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.44.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolPlanContentCalendarRequest
+    # First day of the calendar (YYYY-MM-DD). Each week starts on this weekday.
+    attr_accessor :start_date
+
+    attr_accessor :weeks
+
+    attr_accessor :posts_per_week
+
+    attr_accessor :times
+
+    # Content themes, rotated over the posts in date order.
+    attr_accessor :pillars
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_date' => :'start_date',
+        :'weeks' => :'weeks',
+        :'posts_per_week' => :'posts_per_week',
+        :'times' => :'times',
+        :'pillars' => :'pillars'
+      }
+    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
+      {
+        :'start_date' => :'String',
+        :'weeks' => :'Integer',
+        :'posts_per_week' => :'FreeToolPlanContentCalendarRequestPostsPerWeek',
+        :'times' => :'FreeToolPlanContentCalendarRequestTimes',
+        :'pillars' => :'Array<String>'
+      }
+    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::FreeToolPlanContentCalendarRequest` 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::FreeToolPlanContentCalendarRequest`. 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?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      else
+        self.start_date = nil
+      end
+
+      if attributes.key?(:'weeks')
+        self.weeks = attributes[:'weeks']
+      else
+        self.weeks = 4
+      end
+
+      if attributes.key?(:'posts_per_week')
+        self.posts_per_week = attributes[:'posts_per_week']
+      else
+        self.posts_per_week = nil
+      end
+
+      if attributes.key?(:'times')
+        self.times = attributes[:'times']
+      end
+
+      if attributes.key?(:'pillars')
+        if (value = attributes[:'pillars']).is_a?(Array)
+          self.pillars = value
+        end
+      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 @start_date.nil?
+        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^\d{4}-\d{2}-\d{2}$/)
+      if @start_date !~ pattern
+        invalid_properties.push("invalid value for \"start_date\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@weeks.nil? && @weeks > 12
+        invalid_properties.push('invalid value for "weeks", must be smaller than or equal to 12.')
+      end
+
+      if !@weeks.nil? && @weeks < 1
+        invalid_properties.push('invalid value for "weeks", must be greater than or equal to 1.')
+      end
+
+      if @posts_per_week.nil?
+        invalid_properties.push('invalid value for "posts_per_week", posts_per_week cannot be nil.')
+      end
+
+      if !@pillars.nil? && @pillars.length > 6
+        invalid_properties.push('invalid value for "pillars", number of items must be less than or equal to 6.')
+      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 @start_date.nil?
+      return false if @start_date !~ Regexp.new(/^\d{4}-\d{2}-\d{2}$/)
+      return false if !@weeks.nil? && @weeks > 12
+      return false if !@weeks.nil? && @weeks < 1
+      return false if @posts_per_week.nil?
+      return false if !@pillars.nil? && @pillars.length > 6
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_date Value to be assigned
+    def start_date=(start_date)
+      if start_date.nil?
+        fail ArgumentError, 'start_date cannot be nil'
+      end
+
+      pattern = Regexp.new(/^\d{4}-\d{2}-\d{2}$/)
+      if start_date !~ pattern
+        fail ArgumentError, "invalid value for \"start_date\", must conform to the pattern #{pattern}."
+      end
+
+      @start_date = start_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weeks Value to be assigned
+    def weeks=(weeks)
+      if weeks.nil?
+        fail ArgumentError, 'weeks cannot be nil'
+      end
+
+      if weeks > 12
+        fail ArgumentError, 'invalid value for "weeks", must be smaller than or equal to 12.'
+      end
+
+      if weeks < 1
+        fail ArgumentError, 'invalid value for "weeks", must be greater than or equal to 1.'
+      end
+
+      @weeks = weeks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pillars Value to be assigned
+    def pillars=(pillars)
+      if pillars.nil?
+        fail ArgumentError, 'pillars cannot be nil'
+      end
+
+      if pillars.length > 6
+        fail ArgumentError, 'invalid value for "pillars", number of items must be less than or equal to 6.'
+      end
+
+      @pillars = pillars
+    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 &&
+          start_date == o.start_date &&
+          weeks == o.weeks &&
+          posts_per_week == o.posts_per_week &&
+          times == o.times &&
+          pillars == o.pillars
+    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
+      [start_date, weeks, posts_per_week, times, pillars].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