telegram-bot-openapi 7.2.1

data/lib/telegram-bot/models/chat_member_administrator.rb

@@ -0,0 +1,494 @@
+=begin
+#telegram-bot-api
+
+#Unofficial telegram-bot-api OpenAPI spec. Generated from the Bot API docs at https://core.telegram.org/bots/api
+
+The version of the OpenAPI document: Bot API 7.2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TelegramBot
+  # Represents a chat member that has some additional privileges.
+  class ChatMemberAdministrator
+    # The member's status in the chat, always \"administrator\"
+    attr_accessor :status
+
+    # Information about the user
+    attr_accessor :user
+
+    # True, if the bot is allowed to edit administrator privileges of that user
+    attr_accessor :can_be_edited
+
+    # True, if the user's presence in the chat is hidden
+    attr_accessor :is_anonymous
+
+    # True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.
+    attr_accessor :can_manage_chat
+
+    # True, if the administrator can delete messages of other users
+    attr_accessor :can_delete_messages
+
+    # True, if the administrator can manage video chats
+    attr_accessor :can_manage_video_chats
+
+    # True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
+    attr_accessor :can_restrict_members
+
+    # True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
+    attr_accessor :can_promote_members
+
+    # True, if the user is allowed to change the chat title, photo and other settings
+    attr_accessor :can_change_info
+
+    # True, if the user is allowed to invite new users to the chat
+    attr_accessor :can_invite_users
+
+    # True, if the administrator can post stories to the chat
+    attr_accessor :can_post_stories
+
+    # True, if the administrator can edit stories posted by other users
+    attr_accessor :can_edit_stories
+
+    # True, if the administrator can delete stories posted by other users
+    attr_accessor :can_delete_stories
+
+    # Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only
+    attr_accessor :can_post_messages
+
+    # Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
+    attr_accessor :can_edit_messages
+
+    # Optional. True, if the user is allowed to pin messages; for groups and supergroups only
+    attr_accessor :can_pin_messages
+
+    # Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
+    attr_accessor :can_manage_topics
+
+    # Optional. Custom title for this user
+    attr_accessor :custom_title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'user' => :'user',
+        :'can_be_edited' => :'can_be_edited',
+        :'is_anonymous' => :'is_anonymous',
+        :'can_manage_chat' => :'can_manage_chat',
+        :'can_delete_messages' => :'can_delete_messages',
+        :'can_manage_video_chats' => :'can_manage_video_chats',
+        :'can_restrict_members' => :'can_restrict_members',
+        :'can_promote_members' => :'can_promote_members',
+        :'can_change_info' => :'can_change_info',
+        :'can_invite_users' => :'can_invite_users',
+        :'can_post_stories' => :'can_post_stories',
+        :'can_edit_stories' => :'can_edit_stories',
+        :'can_delete_stories' => :'can_delete_stories',
+        :'can_post_messages' => :'can_post_messages',
+        :'can_edit_messages' => :'can_edit_messages',
+        :'can_pin_messages' => :'can_pin_messages',
+        :'can_manage_topics' => :'can_manage_topics',
+        :'custom_title' => :'custom_title'
+      }
+    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
+      {
+        :'status' => :'String',
+        :'user' => :'User',
+        :'can_be_edited' => :'Boolean',
+        :'is_anonymous' => :'Boolean',
+        :'can_manage_chat' => :'Boolean',
+        :'can_delete_messages' => :'Boolean',
+        :'can_manage_video_chats' => :'Boolean',
+        :'can_restrict_members' => :'Boolean',
+        :'can_promote_members' => :'Boolean',
+        :'can_change_info' => :'Boolean',
+        :'can_invite_users' => :'Boolean',
+        :'can_post_stories' => :'Boolean',
+        :'can_edit_stories' => :'Boolean',
+        :'can_delete_stories' => :'Boolean',
+        :'can_post_messages' => :'Boolean',
+        :'can_edit_messages' => :'Boolean',
+        :'can_pin_messages' => :'Boolean',
+        :'can_manage_topics' => :'Boolean',
+        :'custom_title' => :'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 `TelegramBot::ChatMemberAdministrator` 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 `TelegramBot::ChatMemberAdministrator`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'user')
+        self.user = attributes[:'user']
+      else
+        self.user = nil
+      end
+
+      if attributes.key?(:'can_be_edited')
+        self.can_be_edited = attributes[:'can_be_edited']
+      else
+        self.can_be_edited = nil
+      end
+
+      if attributes.key?(:'is_anonymous')
+        self.is_anonymous = attributes[:'is_anonymous']
+      else
+        self.is_anonymous = nil
+      end
+
+      if attributes.key?(:'can_manage_chat')
+        self.can_manage_chat = attributes[:'can_manage_chat']
+      else
+        self.can_manage_chat = nil
+      end
+
+      if attributes.key?(:'can_delete_messages')
+        self.can_delete_messages = attributes[:'can_delete_messages']
+      else
+        self.can_delete_messages = nil
+      end
+
+      if attributes.key?(:'can_manage_video_chats')
+        self.can_manage_video_chats = attributes[:'can_manage_video_chats']
+      else
+        self.can_manage_video_chats = nil
+      end
+
+      if attributes.key?(:'can_restrict_members')
+        self.can_restrict_members = attributes[:'can_restrict_members']
+      else
+        self.can_restrict_members = nil
+      end
+
+      if attributes.key?(:'can_promote_members')
+        self.can_promote_members = attributes[:'can_promote_members']
+      else
+        self.can_promote_members = nil
+      end
+
+      if attributes.key?(:'can_change_info')
+        self.can_change_info = attributes[:'can_change_info']
+      else
+        self.can_change_info = nil
+      end
+
+      if attributes.key?(:'can_invite_users')
+        self.can_invite_users = attributes[:'can_invite_users']
+      else
+        self.can_invite_users = nil
+      end
+
+      if attributes.key?(:'can_post_stories')
+        self.can_post_stories = attributes[:'can_post_stories']
+      else
+        self.can_post_stories = nil
+      end
+
+      if attributes.key?(:'can_edit_stories')
+        self.can_edit_stories = attributes[:'can_edit_stories']
+      else
+        self.can_edit_stories = nil
+      end
+
+      if attributes.key?(:'can_delete_stories')
+        self.can_delete_stories = attributes[:'can_delete_stories']
+      else
+        self.can_delete_stories = nil
+      end
+
+      if attributes.key?(:'can_post_messages')
+        self.can_post_messages = attributes[:'can_post_messages']
+      end
+
+      if attributes.key?(:'can_edit_messages')
+        self.can_edit_messages = attributes[:'can_edit_messages']
+      end
+
+      if attributes.key?(:'can_pin_messages')
+        self.can_pin_messages = attributes[:'can_pin_messages']
+      end
+
+      if attributes.key?(:'can_manage_topics')
+        self.can_manage_topics = attributes[:'can_manage_topics']
+      end
+
+      if attributes.key?(:'custom_title')
+        self.custom_title = attributes[:'custom_title']
+      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 @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @user.nil?
+        invalid_properties.push('invalid value for "user", user cannot be nil.')
+      end
+
+      if @can_be_edited.nil?
+        invalid_properties.push('invalid value for "can_be_edited", can_be_edited cannot be nil.')
+      end
+
+      if @is_anonymous.nil?
+        invalid_properties.push('invalid value for "is_anonymous", is_anonymous cannot be nil.')
+      end
+
+      if @can_manage_chat.nil?
+        invalid_properties.push('invalid value for "can_manage_chat", can_manage_chat cannot be nil.')
+      end
+
+      if @can_delete_messages.nil?
+        invalid_properties.push('invalid value for "can_delete_messages", can_delete_messages cannot be nil.')
+      end
+
+      if @can_manage_video_chats.nil?
+        invalid_properties.push('invalid value for "can_manage_video_chats", can_manage_video_chats cannot be nil.')
+      end
+
+      if @can_restrict_members.nil?
+        invalid_properties.push('invalid value for "can_restrict_members", can_restrict_members cannot be nil.')
+      end
+
+      if @can_promote_members.nil?
+        invalid_properties.push('invalid value for "can_promote_members", can_promote_members cannot be nil.')
+      end
+
+      if @can_change_info.nil?
+        invalid_properties.push('invalid value for "can_change_info", can_change_info cannot be nil.')
+      end
+
+      if @can_invite_users.nil?
+        invalid_properties.push('invalid value for "can_invite_users", can_invite_users cannot be nil.')
+      end
+
+      if @can_post_stories.nil?
+        invalid_properties.push('invalid value for "can_post_stories", can_post_stories cannot be nil.')
+      end
+
+      if @can_edit_stories.nil?
+        invalid_properties.push('invalid value for "can_edit_stories", can_edit_stories cannot be nil.')
+      end
+
+      if @can_delete_stories.nil?
+        invalid_properties.push('invalid value for "can_delete_stories", can_delete_stories cannot be nil.')
+      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 @status.nil?
+      return false if @user.nil?
+      return false if @can_be_edited.nil?
+      return false if @is_anonymous.nil?
+      return false if @can_manage_chat.nil?
+      return false if @can_delete_messages.nil?
+      return false if @can_manage_video_chats.nil?
+      return false if @can_restrict_members.nil?
+      return false if @can_promote_members.nil?
+      return false if @can_change_info.nil?
+      return false if @can_invite_users.nil?
+      return false if @can_post_stories.nil?
+      return false if @can_edit_stories.nil?
+      return false if @can_delete_stories.nil?
+      true
+    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 &&
+          status == o.status &&
+          user == o.user &&
+          can_be_edited == o.can_be_edited &&
+          is_anonymous == o.is_anonymous &&
+          can_manage_chat == o.can_manage_chat &&
+          can_delete_messages == o.can_delete_messages &&
+          can_manage_video_chats == o.can_manage_video_chats &&
+          can_restrict_members == o.can_restrict_members &&
+          can_promote_members == o.can_promote_members &&
+          can_change_info == o.can_change_info &&
+          can_invite_users == o.can_invite_users &&
+          can_post_stories == o.can_post_stories &&
+          can_edit_stories == o.can_edit_stories &&
+          can_delete_stories == o.can_delete_stories &&
+          can_post_messages == o.can_post_messages &&
+          can_edit_messages == o.can_edit_messages &&
+          can_pin_messages == o.can_pin_messages &&
+          can_manage_topics == o.can_manage_topics &&
+          custom_title == o.custom_title
+    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
+      [status, user, can_be_edited, is_anonymous, can_manage_chat, can_delete_messages, can_manage_video_chats, can_restrict_members, can_promote_members, can_change_info, can_invite_users, can_post_stories, can_edit_stories, can_delete_stories, can_post_messages, can_edit_messages, can_pin_messages, can_manage_topics, custom_title].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 = TelegramBot.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