postboost 1.8.0 → 1.14.0

data/lib/postboost/models/brand_voice_input.rb

@@ -0,0 +1,646 @@
+=begin
+#PostBoost API
+
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms 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.14.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class BrandVoiceInput
+    attr_accessor :business_name
+
+    attr_accessor :mission
+
+    attr_accessor :industry
+
+    # How the brand sounds. The first sentence also feeds image prompts.
+    attr_accessor :personality
+
+    attr_accessor :audience
+
+    attr_accessor :topics_preferred
+
+    attr_accessor :topics_avoided
+
+    # 1 very casual, 3 neutral, 5 very formal.
+    attr_accessor :tone_formal
+
+    # 1 strictly serious, 3 neutral, 5 very playful.
+    attr_accessor :tone_playful
+
+    # 1 very simple, 3 neutral, 5 highly technical.
+    attr_accessor :tone_technical
+
+    attr_accessor :emoji_style
+
+    attr_accessor :hashtag_strategy
+
+    attr_accessor :avoid_words
+
+    attr_accessor :preferred_cta
+
+    attr_accessor :example_posts
+
+    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
+      {
+        :'business_name' => :'business_name',
+        :'mission' => :'mission',
+        :'industry' => :'industry',
+        :'personality' => :'personality',
+        :'audience' => :'audience',
+        :'topics_preferred' => :'topics_preferred',
+        :'topics_avoided' => :'topics_avoided',
+        :'tone_formal' => :'tone_formal',
+        :'tone_playful' => :'tone_playful',
+        :'tone_technical' => :'tone_technical',
+        :'emoji_style' => :'emoji_style',
+        :'hashtag_strategy' => :'hashtag_strategy',
+        :'avoid_words' => :'avoid_words',
+        :'preferred_cta' => :'preferred_cta',
+        :'example_posts' => :'example_posts'
+      }
+    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
+      {
+        :'business_name' => :'String',
+        :'mission' => :'String',
+        :'industry' => :'String',
+        :'personality' => :'String',
+        :'audience' => :'Array<String>',
+        :'topics_preferred' => :'Array<String>',
+        :'topics_avoided' => :'Array<String>',
+        :'tone_formal' => :'Integer',
+        :'tone_playful' => :'Integer',
+        :'tone_technical' => :'Integer',
+        :'emoji_style' => :'String',
+        :'hashtag_strategy' => :'String',
+        :'avoid_words' => :'Array<String>',
+        :'preferred_cta' => :'Array<String>',
+        :'example_posts' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'business_name',
+        :'mission',
+        :'industry',
+        :'personality',
+        :'audience',
+        :'topics_preferred',
+        :'topics_avoided',
+        :'avoid_words',
+        :'preferred_cta',
+        :'example_posts'
+      ])
+    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::BrandVoiceInput` 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::BrandVoiceInput`. 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?(:'business_name')
+        self.business_name = attributes[:'business_name']
+      end
+
+      if attributes.key?(:'mission')
+        self.mission = attributes[:'mission']
+      end
+
+      if attributes.key?(:'industry')
+        self.industry = attributes[:'industry']
+      end
+
+      if attributes.key?(:'personality')
+        self.personality = attributes[:'personality']
+      end
+
+      if attributes.key?(:'audience')
+        if (value = attributes[:'audience']).is_a?(Array)
+          self.audience = value
+        end
+      end
+
+      if attributes.key?(:'topics_preferred')
+        if (value = attributes[:'topics_preferred']).is_a?(Array)
+          self.topics_preferred = value
+        end
+      end
+
+      if attributes.key?(:'topics_avoided')
+        if (value = attributes[:'topics_avoided']).is_a?(Array)
+          self.topics_avoided = value
+        end
+      end
+
+      if attributes.key?(:'tone_formal')
+        self.tone_formal = attributes[:'tone_formal']
+      end
+
+      if attributes.key?(:'tone_playful')
+        self.tone_playful = attributes[:'tone_playful']
+      end
+
+      if attributes.key?(:'tone_technical')
+        self.tone_technical = attributes[:'tone_technical']
+      end
+
+      if attributes.key?(:'emoji_style')
+        self.emoji_style = attributes[:'emoji_style']
+      end
+
+      if attributes.key?(:'hashtag_strategy')
+        self.hashtag_strategy = attributes[:'hashtag_strategy']
+      end
+
+      if attributes.key?(:'avoid_words')
+        if (value = attributes[:'avoid_words']).is_a?(Array)
+          self.avoid_words = value
+        end
+      end
+
+      if attributes.key?(:'preferred_cta')
+        if (value = attributes[:'preferred_cta']).is_a?(Array)
+          self.preferred_cta = value
+        end
+      end
+
+      if attributes.key?(:'example_posts')
+        if (value = attributes[:'example_posts']).is_a?(Array)
+          self.example_posts = 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 !@business_name.nil? && @business_name.to_s.length > 255
+        invalid_properties.push('invalid value for "business_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@mission.nil? && @mission.to_s.length > 1000
+        invalid_properties.push('invalid value for "mission", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@industry.nil? && @industry.to_s.length > 255
+        invalid_properties.push('invalid value for "industry", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@personality.nil? && @personality.to_s.length > 1000
+        invalid_properties.push('invalid value for "personality", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@audience.nil? && @audience.length > 20
+        invalid_properties.push('invalid value for "audience", number of items must be less than or equal to 20.')
+      end
+
+      if !@topics_preferred.nil? && @topics_preferred.length > 20
+        invalid_properties.push('invalid value for "topics_preferred", number of items must be less than or equal to 20.')
+      end
+
+      if !@topics_avoided.nil? && @topics_avoided.length > 20
+        invalid_properties.push('invalid value for "topics_avoided", number of items must be less than or equal to 20.')
+      end
+
+      if !@tone_formal.nil? && @tone_formal > 5
+        invalid_properties.push('invalid value for "tone_formal", must be smaller than or equal to 5.')
+      end
+
+      if !@tone_formal.nil? && @tone_formal < 1
+        invalid_properties.push('invalid value for "tone_formal", must be greater than or equal to 1.')
+      end
+
+      if !@tone_playful.nil? && @tone_playful > 5
+        invalid_properties.push('invalid value for "tone_playful", must be smaller than or equal to 5.')
+      end
+
+      if !@tone_playful.nil? && @tone_playful < 1
+        invalid_properties.push('invalid value for "tone_playful", must be greater than or equal to 1.')
+      end
+
+      if !@tone_technical.nil? && @tone_technical > 5
+        invalid_properties.push('invalid value for "tone_technical", must be smaller than or equal to 5.')
+      end
+
+      if !@tone_technical.nil? && @tone_technical < 1
+        invalid_properties.push('invalid value for "tone_technical", must be greater than or equal to 1.')
+      end
+
+      if !@avoid_words.nil? && @avoid_words.length > 20
+        invalid_properties.push('invalid value for "avoid_words", number of items must be less than or equal to 20.')
+      end
+
+      if !@preferred_cta.nil? && @preferred_cta.length > 20
+        invalid_properties.push('invalid value for "preferred_cta", number of items must be less than or equal to 20.')
+      end
+
+      if !@example_posts.nil? && @example_posts.length > 5
+        invalid_properties.push('invalid value for "example_posts", number of items must be less than or equal to 5.')
+      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 !@business_name.nil? && @business_name.to_s.length > 255
+      return false if !@mission.nil? && @mission.to_s.length > 1000
+      return false if !@industry.nil? && @industry.to_s.length > 255
+      return false if !@personality.nil? && @personality.to_s.length > 1000
+      return false if !@audience.nil? && @audience.length > 20
+      return false if !@topics_preferred.nil? && @topics_preferred.length > 20
+      return false if !@topics_avoided.nil? && @topics_avoided.length > 20
+      return false if !@tone_formal.nil? && @tone_formal > 5
+      return false if !@tone_formal.nil? && @tone_formal < 1
+      return false if !@tone_playful.nil? && @tone_playful > 5
+      return false if !@tone_playful.nil? && @tone_playful < 1
+      return false if !@tone_technical.nil? && @tone_technical > 5
+      return false if !@tone_technical.nil? && @tone_technical < 1
+      emoji_style_validator = EnumAttributeValidator.new('String', ["none", "rare", "moderate", "abundant"])
+      return false unless emoji_style_validator.valid?(@emoji_style)
+      hashtag_strategy_validator = EnumAttributeValidator.new('String', ["none", "generic", "niche", "branded", "mix"])
+      return false unless hashtag_strategy_validator.valid?(@hashtag_strategy)
+      return false if !@avoid_words.nil? && @avoid_words.length > 20
+      return false if !@preferred_cta.nil? && @preferred_cta.length > 20
+      return false if !@example_posts.nil? && @example_posts.length > 5
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] business_name Value to be assigned
+    def business_name=(business_name)
+      if !business_name.nil? && business_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "business_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @business_name = business_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mission Value to be assigned
+    def mission=(mission)
+      if !mission.nil? && mission.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "mission", the character length must be smaller than or equal to 1000.'
+      end
+
+      @mission = mission
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] industry Value to be assigned
+    def industry=(industry)
+      if !industry.nil? && industry.to_s.length > 255
+        fail ArgumentError, 'invalid value for "industry", the character length must be smaller than or equal to 255.'
+      end
+
+      @industry = industry
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] personality Value to be assigned
+    def personality=(personality)
+      if !personality.nil? && personality.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "personality", the character length must be smaller than or equal to 1000.'
+      end
+
+      @personality = personality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] audience Value to be assigned
+    def audience=(audience)
+      if !audience.nil? && audience.length > 20
+        fail ArgumentError, 'invalid value for "audience", number of items must be less than or equal to 20.'
+      end
+
+      @audience = audience
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] topics_preferred Value to be assigned
+    def topics_preferred=(topics_preferred)
+      if !topics_preferred.nil? && topics_preferred.length > 20
+        fail ArgumentError, 'invalid value for "topics_preferred", number of items must be less than or equal to 20.'
+      end
+
+      @topics_preferred = topics_preferred
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] topics_avoided Value to be assigned
+    def topics_avoided=(topics_avoided)
+      if !topics_avoided.nil? && topics_avoided.length > 20
+        fail ArgumentError, 'invalid value for "topics_avoided", number of items must be less than or equal to 20.'
+      end
+
+      @topics_avoided = topics_avoided
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tone_formal Value to be assigned
+    def tone_formal=(tone_formal)
+      if tone_formal.nil?
+        fail ArgumentError, 'tone_formal cannot be nil'
+      end
+
+      if tone_formal > 5
+        fail ArgumentError, 'invalid value for "tone_formal", must be smaller than or equal to 5.'
+      end
+
+      if tone_formal < 1
+        fail ArgumentError, 'invalid value for "tone_formal", must be greater than or equal to 1.'
+      end
+
+      @tone_formal = tone_formal
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tone_playful Value to be assigned
+    def tone_playful=(tone_playful)
+      if tone_playful.nil?
+        fail ArgumentError, 'tone_playful cannot be nil'
+      end
+
+      if tone_playful > 5
+        fail ArgumentError, 'invalid value for "tone_playful", must be smaller than or equal to 5.'
+      end
+
+      if tone_playful < 1
+        fail ArgumentError, 'invalid value for "tone_playful", must be greater than or equal to 1.'
+      end
+
+      @tone_playful = tone_playful
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tone_technical Value to be assigned
+    def tone_technical=(tone_technical)
+      if tone_technical.nil?
+        fail ArgumentError, 'tone_technical cannot be nil'
+      end
+
+      if tone_technical > 5
+        fail ArgumentError, 'invalid value for "tone_technical", must be smaller than or equal to 5.'
+      end
+
+      if tone_technical < 1
+        fail ArgumentError, 'invalid value for "tone_technical", must be greater than or equal to 1.'
+      end
+
+      @tone_technical = tone_technical
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] emoji_style Object to be assigned
+    def emoji_style=(emoji_style)
+      validator = EnumAttributeValidator.new('String', ["none", "rare", "moderate", "abundant"])
+      unless validator.valid?(emoji_style)
+        fail ArgumentError, "invalid value for \"emoji_style\", must be one of #{validator.allowable_values}."
+      end
+      @emoji_style = emoji_style
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] hashtag_strategy Object to be assigned
+    def hashtag_strategy=(hashtag_strategy)
+      validator = EnumAttributeValidator.new('String', ["none", "generic", "niche", "branded", "mix"])
+      unless validator.valid?(hashtag_strategy)
+        fail ArgumentError, "invalid value for \"hashtag_strategy\", must be one of #{validator.allowable_values}."
+      end
+      @hashtag_strategy = hashtag_strategy
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] avoid_words Value to be assigned
+    def avoid_words=(avoid_words)
+      if !avoid_words.nil? && avoid_words.length > 20
+        fail ArgumentError, 'invalid value for "avoid_words", number of items must be less than or equal to 20.'
+      end
+
+      @avoid_words = avoid_words
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] preferred_cta Value to be assigned
+    def preferred_cta=(preferred_cta)
+      if !preferred_cta.nil? && preferred_cta.length > 20
+        fail ArgumentError, 'invalid value for "preferred_cta", number of items must be less than or equal to 20.'
+      end
+
+      @preferred_cta = preferred_cta
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] example_posts Value to be assigned
+    def example_posts=(example_posts)
+      if !example_posts.nil? && example_posts.length > 5
+        fail ArgumentError, 'invalid value for "example_posts", number of items must be less than or equal to 5.'
+      end
+
+      @example_posts = example_posts
+    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 &&
+          business_name == o.business_name &&
+          mission == o.mission &&
+          industry == o.industry &&
+          personality == o.personality &&
+          audience == o.audience &&
+          topics_preferred == o.topics_preferred &&
+          topics_avoided == o.topics_avoided &&
+          tone_formal == o.tone_formal &&
+          tone_playful == o.tone_playful &&
+          tone_technical == o.tone_technical &&
+          emoji_style == o.emoji_style &&
+          hashtag_strategy == o.hashtag_strategy &&
+          avoid_words == o.avoid_words &&
+          preferred_cta == o.preferred_cta &&
+          example_posts == o.example_posts
+    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
+      [business_name, mission, industry, personality, audience, topics_preferred, topics_avoided, tone_formal, tone_playful, tone_technical, emoji_style, hashtag_strategy, avoid_words, preferred_cta, example_posts].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