postboost 1.0.0 → 1.14.0

data/lib/postboost/models/image_generate_input.rb

@@ -0,0 +1,479 @@
+=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 ImageGenerateInput
+    # Social media caption. Triggers standard mode. Takes priority over prompt.
+    attr_accessor :caption
+
+    # Required when caption is provided.
+    attr_accessor :platform
+
+    attr_accessor :template
+
+    attr_accessor :style
+
+    # Free-text tone for the image. When sent, it replaces the stored workspace brand voice for this call.
+    attr_accessor :brand_voice
+
+    # When `brand_voice` is not sent, derive the image tone from the workspace brand voice. Ignored in developer mode (`prompt`).
+    attr_accessor :use_brand_voice
+
+    attr_accessor :custom_instructions
+
+    # Developer escape hatch. Bypasses internal prompt builder. Ignored if caption is present.
+    attr_accessor :prompt
+
+    attr_accessor :aspect_ratio
+
+    attr_accessor :count
+
+    attr_accessor :quality
+
+    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
+      {
+        :'caption' => :'caption',
+        :'platform' => :'platform',
+        :'template' => :'template',
+        :'style' => :'style',
+        :'brand_voice' => :'brand_voice',
+        :'use_brand_voice' => :'use_brand_voice',
+        :'custom_instructions' => :'custom_instructions',
+        :'prompt' => :'prompt',
+        :'aspect_ratio' => :'aspect_ratio',
+        :'count' => :'count',
+        :'quality' => :'quality'
+      }
+    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
+      {
+        :'caption' => :'String',
+        :'platform' => :'String',
+        :'template' => :'String',
+        :'style' => :'String',
+        :'brand_voice' => :'String',
+        :'use_brand_voice' => :'Boolean',
+        :'custom_instructions' => :'String',
+        :'prompt' => :'String',
+        :'aspect_ratio' => :'String',
+        :'count' => :'Integer',
+        :'quality' => :'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::ImageGenerateInput` 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::ImageGenerateInput`. 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?(:'caption')
+        self.caption = attributes[:'caption']
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'template')
+        self.template = attributes[:'template']
+      end
+
+      if attributes.key?(:'style')
+        self.style = attributes[:'style']
+      end
+
+      if attributes.key?(:'brand_voice')
+        self.brand_voice = attributes[:'brand_voice']
+      end
+
+      if attributes.key?(:'use_brand_voice')
+        self.use_brand_voice = attributes[:'use_brand_voice']
+      else
+        self.use_brand_voice = true
+      end
+
+      if attributes.key?(:'custom_instructions')
+        self.custom_instructions = attributes[:'custom_instructions']
+      end
+
+      if attributes.key?(:'prompt')
+        self.prompt = attributes[:'prompt']
+      end
+
+      if attributes.key?(:'aspect_ratio')
+        self.aspect_ratio = attributes[:'aspect_ratio']
+      else
+        self.aspect_ratio = '1:1'
+      end
+
+      if attributes.key?(:'count')
+        self.count = attributes[:'count']
+      else
+        self.count = 1
+      end
+
+      if attributes.key?(:'quality')
+        self.quality = attributes[:'quality']
+      else
+        self.quality = 'standard'
+      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 !@caption.nil? && @caption.to_s.length > 2000
+        invalid_properties.push('invalid value for "caption", the character length must be smaller than or equal to 2000.')
+      end
+
+      if !@brand_voice.nil? && @brand_voice.to_s.length > 200
+        invalid_properties.push('invalid value for "brand_voice", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@custom_instructions.nil? && @custom_instructions.to_s.length > 1000
+        invalid_properties.push('invalid value for "custom_instructions", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@prompt.nil? && @prompt.to_s.length > 4000
+        invalid_properties.push('invalid value for "prompt", the character length must be smaller than or equal to 4000.')
+      end
+
+      if !@count.nil? && @count > 4
+        invalid_properties.push('invalid value for "count", must be smaller than or equal to 4.')
+      end
+
+      if !@count.nil? && @count < 1
+        invalid_properties.push('invalid value for "count", must be greater than or equal to 1.')
+      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 !@caption.nil? && @caption.to_s.length > 2000
+      template_validator = EnumAttributeValidator.new('String', ["blog_cover", "quote_card", "stat_card", "feature_announcement", "product_highlight", "event_promo", "carousel_slide", "ad_creative"])
+      return false unless template_validator.valid?(@template)
+      return false if !@brand_voice.nil? && @brand_voice.to_s.length > 200
+      return false if !@custom_instructions.nil? && @custom_instructions.to_s.length > 1000
+      return false if !@prompt.nil? && @prompt.to_s.length > 4000
+      aspect_ratio_validator = EnumAttributeValidator.new('String', ["1:1", "16:9", "9:16", "4:5"])
+      return false unless aspect_ratio_validator.valid?(@aspect_ratio)
+      return false if !@count.nil? && @count > 4
+      return false if !@count.nil? && @count < 1
+      quality_validator = EnumAttributeValidator.new('String', ["standard", "hd"])
+      return false unless quality_validator.valid?(@quality)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] caption Value to be assigned
+    def caption=(caption)
+      if caption.nil?
+        fail ArgumentError, 'caption cannot be nil'
+      end
+
+      if caption.to_s.length > 2000
+        fail ArgumentError, 'invalid value for "caption", the character length must be smaller than or equal to 2000.'
+      end
+
+      @caption = caption
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] template Object to be assigned
+    def template=(template)
+      validator = EnumAttributeValidator.new('String', ["blog_cover", "quote_card", "stat_card", "feature_announcement", "product_highlight", "event_promo", "carousel_slide", "ad_creative"])
+      unless validator.valid?(template)
+        fail ArgumentError, "invalid value for \"template\", must be one of #{validator.allowable_values}."
+      end
+      @template = template
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand_voice Value to be assigned
+    def brand_voice=(brand_voice)
+      if brand_voice.nil?
+        fail ArgumentError, 'brand_voice cannot be nil'
+      end
+
+      if brand_voice.to_s.length > 200
+        fail ArgumentError, 'invalid value for "brand_voice", the character length must be smaller than or equal to 200.'
+      end
+
+      @brand_voice = brand_voice
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] custom_instructions Value to be assigned
+    def custom_instructions=(custom_instructions)
+      if custom_instructions.nil?
+        fail ArgumentError, 'custom_instructions cannot be nil'
+      end
+
+      if custom_instructions.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "custom_instructions", the character length must be smaller than or equal to 1000.'
+      end
+
+      @custom_instructions = custom_instructions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] prompt Value to be assigned
+    def prompt=(prompt)
+      if prompt.nil?
+        fail ArgumentError, 'prompt cannot be nil'
+      end
+
+      if prompt.to_s.length > 4000
+        fail ArgumentError, 'invalid value for "prompt", the character length must be smaller than or equal to 4000.'
+      end
+
+      @prompt = prompt
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] aspect_ratio Object to be assigned
+    def aspect_ratio=(aspect_ratio)
+      validator = EnumAttributeValidator.new('String', ["1:1", "16:9", "9:16", "4:5"])
+      unless validator.valid?(aspect_ratio)
+        fail ArgumentError, "invalid value for \"aspect_ratio\", must be one of #{validator.allowable_values}."
+      end
+      @aspect_ratio = aspect_ratio
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] count Value to be assigned
+    def count=(count)
+      if count.nil?
+        fail ArgumentError, 'count cannot be nil'
+      end
+
+      if count > 4
+        fail ArgumentError, 'invalid value for "count", must be smaller than or equal to 4.'
+      end
+
+      if count < 1
+        fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.'
+      end
+
+      @count = count
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] quality Object to be assigned
+    def quality=(quality)
+      validator = EnumAttributeValidator.new('String', ["standard", "hd"])
+      unless validator.valid?(quality)
+        fail ArgumentError, "invalid value for \"quality\", must be one of #{validator.allowable_values}."
+      end
+      @quality = quality
+    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 &&
+          caption == o.caption &&
+          platform == o.platform &&
+          template == o.template &&
+          style == o.style &&
+          brand_voice == o.brand_voice &&
+          use_brand_voice == o.use_brand_voice &&
+          custom_instructions == o.custom_instructions &&
+          prompt == o.prompt &&
+          aspect_ratio == o.aspect_ratio &&
+          count == o.count &&
+          quality == o.quality
+    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
+      [caption, platform, template, style, brand_voice, use_brand_voice, custom_instructions, prompt, aspect_ratio, count, quality].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