postboost 1.34.0 → 1.35.0

data/lib/postboost/models/free_tool_generate_qr_code_request.rb

@@ -0,0 +1,411 @@
+=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.35.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class FreeToolGenerateQrCodeRequest
+    # The link or text to encode.
+    attr_accessor :data
+
+    attr_accessor :utm
+
+    # How much of the code can be damaged and still scan: L 7%, M 15%, Q 25%, H 30%.
+    attr_accessor :error_correction
+
+    # Width and height of the SVG in pixels.
+    attr_accessor :size
+
+    # Colour of the modules, #RRGGBB.
+    attr_accessor :foreground
+
+    # Background colour, #RRGGBB.
+    attr_accessor :background
+
+    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
+      {
+        :'data' => :'data',
+        :'utm' => :'utm',
+        :'error_correction' => :'error_correction',
+        :'size' => :'size',
+        :'foreground' => :'foreground',
+        :'background' => :'background'
+      }
+    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
+      {
+        :'data' => :'String',
+        :'utm' => :'FreeToolGenerateQrCodeRequestUtm',
+        :'error_correction' => :'String',
+        :'size' => :'Integer',
+        :'foreground' => :'String',
+        :'background' => :'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::FreeToolGenerateQrCodeRequest` 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::FreeToolGenerateQrCodeRequest`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'utm')
+        self.utm = attributes[:'utm']
+      end
+
+      if attributes.key?(:'error_correction')
+        self.error_correction = attributes[:'error_correction']
+      else
+        self.error_correction = 'M'
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      else
+        self.size = 512
+      end
+
+      if attributes.key?(:'foreground')
+        self.foreground = attributes[:'foreground']
+      else
+        self.foreground = '#000000'
+      end
+
+      if attributes.key?(:'background')
+        self.background = attributes[:'background']
+      else
+        self.background = '#FFFFFF'
+      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 @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @data.to_s.length > 1000
+        invalid_properties.push('invalid value for "data", the character length must be smaller than or equal to 1000.')
+      end
+
+      if @data.to_s.length < 1
+        invalid_properties.push('invalid value for "data", the character length must be great than or equal to 1.')
+      end
+
+      if !@size.nil? && @size > 2048
+        invalid_properties.push('invalid value for "size", must be smaller than or equal to 2048.')
+      end
+
+      if !@size.nil? && @size < 128
+        invalid_properties.push('invalid value for "size", must be greater than or equal to 128.')
+      end
+
+      pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      if !@foreground.nil? && @foreground !~ pattern
+        invalid_properties.push("invalid value for \"foreground\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      if !@background.nil? && @background !~ pattern
+        invalid_properties.push("invalid value for \"background\", must conform to the pattern #{pattern}.")
+      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 @data.nil?
+      return false if @data.to_s.length > 1000
+      return false if @data.to_s.length < 1
+      error_correction_validator = EnumAttributeValidator.new('String', ["L", "M", "Q", "H"])
+      return false unless error_correction_validator.valid?(@error_correction)
+      return false if !@size.nil? && @size > 2048
+      return false if !@size.nil? && @size < 128
+      return false if !@foreground.nil? && @foreground !~ Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      return false if !@background.nil? && @background !~ Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      if data.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "data", the character length must be smaller than or equal to 1000.'
+      end
+
+      if data.to_s.length < 1
+        fail ArgumentError, 'invalid value for "data", the character length must be great than or equal to 1.'
+      end
+
+      @data = data
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] error_correction Object to be assigned
+    def error_correction=(error_correction)
+      validator = EnumAttributeValidator.new('String', ["L", "M", "Q", "H"])
+      unless validator.valid?(error_correction)
+        fail ArgumentError, "invalid value for \"error_correction\", must be one of #{validator.allowable_values}."
+      end
+      @error_correction = error_correction
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] size Value to be assigned
+    def size=(size)
+      if size.nil?
+        fail ArgumentError, 'size cannot be nil'
+      end
+
+      if size > 2048
+        fail ArgumentError, 'invalid value for "size", must be smaller than or equal to 2048.'
+      end
+
+      if size < 128
+        fail ArgumentError, 'invalid value for "size", must be greater than or equal to 128.'
+      end
+
+      @size = size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] foreground Value to be assigned
+    def foreground=(foreground)
+      if foreground.nil?
+        fail ArgumentError, 'foreground cannot be nil'
+      end
+
+      pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      if foreground !~ pattern
+        fail ArgumentError, "invalid value for \"foreground\", must conform to the pattern #{pattern}."
+      end
+
+      @foreground = foreground
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] background Value to be assigned
+    def background=(background)
+      if background.nil?
+        fail ArgumentError, 'background cannot be nil'
+      end
+
+      pattern = Regexp.new(/^#[0-9a-fA-F]{6}$/)
+      if background !~ pattern
+        fail ArgumentError, "invalid value for \"background\", must conform to the pattern #{pattern}."
+      end
+
+      @background = background
+    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 &&
+          data == o.data &&
+          utm == o.utm &&
+          error_correction == o.error_correction &&
+          size == o.size &&
+          foreground == o.foreground &&
+          background == o.background
+    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
+      [data, utm, error_correction, size, foreground, background].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