Class: GetStream::Generated::Models::CheckRequest

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

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 = {}) ⇒ CheckRequest

Initialize with attributes



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 47

def initialize(attributes = {})
  super(attributes)
  @entity_creator_id = attributes[:entity_creator_id] || attributes['entity_creator_id']
  @entity_id = attributes[:entity_id] || attributes['entity_id']
  @entity_type = attributes[:entity_type] || attributes['entity_type']
  @config_key = attributes[:config_key] || attributes['config_key'] || nil
  @config_team = attributes[:config_team] || attributes['config_team'] || nil
  @test_mode = attributes[:test_mode] || attributes['test_mode'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @config = attributes[:config] || attributes['config'] || nil
  @moderation_payload = attributes[:moderation_payload] || attributes['moderation_payload'] || nil
  @options = attributes[:options] || attributes['options'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#config ⇒ ModerationConfig

Returns:



35
36
37
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 35

def config
  @config
end

#config_key ⇒ String

Returns Key of the moderation configuration to use.

Returns:

  • (String) —

    Key of the moderation configuration to use



23
24
25
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 23

def config_key
  @config_key
end

#config_team ⇒ String

Returns Team associated with the configuration.

Returns:

  • (String) —

    Team associated with the configuration



26
27
28
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 26

def config_team
  @config_team
end

#entity_creator_id ⇒ String

Returns ID of the user who created the entity.

Returns:

  • (String) —

    ID of the user who created the entity



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

def entity_creator_id
  @entity_creator_id
end

#entity_id ⇒ String

Returns Unique identifier of the entity to moderate.

Returns:

  • (String) —

    Unique identifier of the entity to moderate



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

def entity_id
  @entity_id
end

#entity_type ⇒ String

Returns Type of entity to moderate.

Returns:

  • (String) —

    Type of entity to moderate



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

def entity_type
  @entity_type
end

#moderation_payload ⇒ ModerationPayload

Returns:



38
39
40
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 38

def moderation_payload
  @moderation_payload
end

#options ⇒ Object

Returns Additional moderation configuration options.

Returns:

  • (Object) —

    Additional moderation configuration options



41
42
43
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 41

def options
  @options
end

#test_mode ⇒ Boolean

Returns Whether to run moderation in test mode.

Returns:

  • (Boolean) —

    Whether to run moderation in test mode



29
30
31
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 29

def test_mode
  @test_mode
end

#user ⇒ UserRequest

Returns:



44
45
46
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 44

def user
  @user
end

#user_id ⇒ String

Returns:

  • (String) 


32
33
34
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 32

def user_id
  @user_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/getstream_ruby/generated/models/check_request.rb', line 63

def self.json_field_mappings
  {
    entity_creator_id: 'entity_creator_id',
    entity_id: 'entity_id',
    entity_type: 'entity_type',
    config_key: 'config_key',
    config_team: 'config_team',
    test_mode: 'test_mode',
    user_id: 'user_id',
    config: 'config',
    moderation_payload: 'moderation_payload',
    options: 'options',
    user: 'user'
  }
end