postboost 1.61.1 → 1.64.1

data/lib/postboost/models/free_tool_build_agent_skill_request.rb

@@ -0,0 +1,483 @@
+=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.64.1
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolBuildAgentSkillRequest
+    # skill_md (an Agent Skills SKILL.md), agents_md (AGENTS.md) or system_prompt.
+    attr_accessor :format
+
+    # The skill name, normalised to lowercase letters, digits and hyphens and cut to 64 characters.
+    attr_accessor :name
+
+    # The brand the agent works for; omitted when empty.
+    attr_accessor :brand
+
+    # What the agent does; the output keeps this enum's order.
+    attr_accessor :tasks
+
+    # Networks to add character-limit rules for; none leaves the section out.
+    attr_accessor :networks
+
+    # How much the agent may do without asking.
+    attr_accessor :autonomy
+
+    # Posts per day the agent may create; 0 adds no cap line.
+    attr_accessor :daily_cap
+
+    # Read the workspace brand voice before writing captions.
+    attr_accessor :brand_voice
+
+    # connector (the OAuth MCP connector) or api_token (the advanced MCP server with an API key).
+    attr_accessor :connection
+
+    # Your own do's and don'ts, one per item.
+    attr_accessor :rules
+
+    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
+      {
+        :'format' => :'format',
+        :'name' => :'name',
+        :'brand' => :'brand',
+        :'tasks' => :'tasks',
+        :'networks' => :'networks',
+        :'autonomy' => :'autonomy',
+        :'daily_cap' => :'daily_cap',
+        :'brand_voice' => :'brand_voice',
+        :'connection' => :'connection',
+        :'rules' => :'rules'
+      }
+    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
+      {
+        :'format' => :'String',
+        :'name' => :'String',
+        :'brand' => :'String',
+        :'tasks' => :'Array<String>',
+        :'networks' => :'Array<String>',
+        :'autonomy' => :'String',
+        :'daily_cap' => :'Integer',
+        :'brand_voice' => :'Boolean',
+        :'connection' => :'String',
+        :'rules' => :'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::FreeToolBuildAgentSkillRequest` 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::FreeToolBuildAgentSkillRequest`. 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?(:'format')
+        self.format = attributes[:'format']
+      else
+        self.format = 'skill_md'
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = 'postboost-social-media'
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      else
+        self.brand = ''
+      end
+
+      if attributes.key?(:'tasks')
+        if (value = attributes[:'tasks']).is_a?(Array)
+          self.tasks = value
+        end
+      end
+
+      if attributes.key?(:'networks')
+        if (value = attributes[:'networks']).is_a?(Array)
+          self.networks = value
+        end
+      end
+
+      if attributes.key?(:'autonomy')
+        self.autonomy = attributes[:'autonomy']
+      else
+        self.autonomy = 'drafts_only'
+      end
+
+      if attributes.key?(:'daily_cap')
+        self.daily_cap = attributes[:'daily_cap']
+      else
+        self.daily_cap = 5
+      end
+
+      if attributes.key?(:'brand_voice')
+        self.brand_voice = attributes[:'brand_voice']
+      else
+        self.brand_voice = true
+      end
+
+      if attributes.key?(:'connection')
+        self.connection = attributes[:'connection']
+      else
+        self.connection = 'connector'
+      end
+
+      if attributes.key?(:'rules')
+        if (value = attributes[:'rules']).is_a?(Array)
+          self.rules = 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 !@name.nil? && @name.to_s.length > 128
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
+      end
+
+      if !@brand.nil? && @brand.to_s.length > 80
+        invalid_properties.push('invalid value for "brand", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@tasks.nil? && @tasks.length > 7
+        invalid_properties.push('invalid value for "tasks", number of items must be less than or equal to 7.')
+      end
+
+      if !@tasks.nil? && @tasks.length < 1
+        invalid_properties.push('invalid value for "tasks", number of items must be greater than or equal to 1.')
+      end
+
+      if !@networks.nil? && @networks.length > 11
+        invalid_properties.push('invalid value for "networks", number of items must be less than or equal to 11.')
+      end
+
+      if !@daily_cap.nil? && @daily_cap > 50
+        invalid_properties.push('invalid value for "daily_cap", must be smaller than or equal to 50.')
+      end
+
+      if !@daily_cap.nil? && @daily_cap < 0
+        invalid_properties.push('invalid value for "daily_cap", must be greater than or equal to 0.')
+      end
+
+      if !@rules.nil? && @rules.length > 10
+        invalid_properties.push('invalid value for "rules", number of items must be less than or equal to 10.')
+      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'
+      format_validator = EnumAttributeValidator.new('String', ["skill_md", "agents_md", "system_prompt"])
+      return false unless format_validator.valid?(@format)
+      return false if !@name.nil? && @name.to_s.length > 128
+      return false if !@brand.nil? && @brand.to_s.length > 80
+      return false if !@tasks.nil? && @tasks.length > 7
+      return false if !@tasks.nil? && @tasks.length < 1
+      return false if !@networks.nil? && @networks.length > 11
+      autonomy_validator = EnumAttributeValidator.new('String', ["drafts_only", "approve_then_schedule", "queue_without_asking"])
+      return false unless autonomy_validator.valid?(@autonomy)
+      return false if !@daily_cap.nil? && @daily_cap > 50
+      return false if !@daily_cap.nil? && @daily_cap < 0
+      connection_validator = EnumAttributeValidator.new('String', ["connector", "api_token"])
+      return false unless connection_validator.valid?(@connection)
+      return false if !@rules.nil? && @rules.length > 10
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] format Object to be assigned
+    def format=(format)
+      validator = EnumAttributeValidator.new('String', ["skill_md", "agents_md", "system_prompt"])
+      unless validator.valid?(format)
+        fail ArgumentError, "invalid value for \"format\", must be one of #{validator.allowable_values}."
+      end
+      @format = format
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 128
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand Value to be assigned
+    def brand=(brand)
+      if brand.nil?
+        fail ArgumentError, 'brand cannot be nil'
+      end
+
+      if brand.to_s.length > 80
+        fail ArgumentError, 'invalid value for "brand", the character length must be smaller than or equal to 80.'
+      end
+
+      @brand = brand
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] autonomy Object to be assigned
+    def autonomy=(autonomy)
+      validator = EnumAttributeValidator.new('String', ["drafts_only", "approve_then_schedule", "queue_without_asking"])
+      unless validator.valid?(autonomy)
+        fail ArgumentError, "invalid value for \"autonomy\", must be one of #{validator.allowable_values}."
+      end
+      @autonomy = autonomy
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] daily_cap Value to be assigned
+    def daily_cap=(daily_cap)
+      if daily_cap.nil?
+        fail ArgumentError, 'daily_cap cannot be nil'
+      end
+
+      if daily_cap > 50
+        fail ArgumentError, 'invalid value for "daily_cap", must be smaller than or equal to 50.'
+      end
+
+      if daily_cap < 0
+        fail ArgumentError, 'invalid value for "daily_cap", must be greater than or equal to 0.'
+      end
+
+      @daily_cap = daily_cap
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] connection Object to be assigned
+    def connection=(connection)
+      validator = EnumAttributeValidator.new('String', ["connector", "api_token"])
+      unless validator.valid?(connection)
+        fail ArgumentError, "invalid value for \"connection\", must be one of #{validator.allowable_values}."
+      end
+      @connection = connection
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rules Value to be assigned
+    def rules=(rules)
+      if rules.nil?
+        fail ArgumentError, 'rules cannot be nil'
+      end
+
+      if rules.length > 10
+        fail ArgumentError, 'invalid value for "rules", number of items must be less than or equal to 10.'
+      end
+
+      @rules = rules
+    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 &&
+          format == o.format &&
+          name == o.name &&
+          brand == o.brand &&
+          tasks == o.tasks &&
+          networks == o.networks &&
+          autonomy == o.autonomy &&
+          daily_cap == o.daily_cap &&
+          brand_voice == o.brand_voice &&
+          connection == o.connection &&
+          rules == o.rules
+    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
+      [format, name, brand, tasks, networks, autonomy, daily_cap, brand_voice, connection, rules].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