Class: GetStream::Generated::Models::AddUserGroupMembersRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/add_user_group_members_request.rb

Overview

Request body for adding members to a user group

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ AddUserGroupMembersRequest

Initialize with attributes



23
24
25
26
27
28
 
# File 'lib/getstream_ruby/generated/models/add_user_group_members_request.rb', line 23

def initialize(attributes = {})
  super(attributes)
  @member_ids = attributes[:member_ids] || attributes['member_ids']
  @as_admin = attributes[:as_admin] || attributes['as_admin'] || nil
  @team_id = attributes[:team_id] || attributes['team_id'] || nil
end

Instance Attribute Details

#as_admin ⇒ Boolean

Returns Whether to add the members as group admins. Defaults to false.

Returns:

  • (Boolean) —

    Whether to add the members as group admins. Defaults to false



17
18
19
 
# File 'lib/getstream_ruby/generated/models/add_user_group_members_request.rb', line 17

def as_admin
  @as_admin
end

#member_ids ⇒ Array<String>

Returns List of user IDs to add as members.

Returns:

  • (Array<String>) —

    List of user IDs to add as members



14
15
16
 
# File 'lib/getstream_ruby/generated/models/add_user_group_members_request.rb', line 14

def member_ids
  @member_ids
end

#team_id ⇒ String

Returns:

  • (String) 


20
21
22
 
# File 'lib/getstream_ruby/generated/models/add_user_group_members_request.rb', line 20

def team_id
  @team_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



31
32
33
34
35
36
37
 
# File 'lib/getstream_ruby/generated/models/add_user_group_members_request.rb', line 31

def self.json_field_mappings
  {
    member_ids: 'member_ids',
    as_admin: 'as_admin',
    team_id: 'team_id'
  }
end