Class: GetStream::Generated::Models::DeleteUserRequestPayload

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

Overview

Configuration for user deletion action

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

Initialize with attributes



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/getstream_ruby/generated/models/delete_user_request_payload.rb', line 35

def initialize(attributes = {})
  super(attributes)
  @delete_conversation_channels = attributes[:delete_conversation_channels] || attributes['delete_conversation_channels'] || nil
  @delete_feeds_content = attributes[:delete_feeds_content] || attributes['delete_feeds_content'] || nil
  @entity_id = attributes[:entity_id] || attributes['entity_id'] || nil
  @entity_type = attributes[:entity_type] || attributes['entity_type'] || nil
  @hard_delete = attributes[:hard_delete] || attributes['hard_delete'] || nil
  @mark_messages_deleted = attributes[:mark_messages_deleted] || attributes['mark_messages_deleted'] || nil
  @reason = attributes[:reason] || attributes['reason'] || nil
end

Instance Attribute Details

#delete_conversation_channels ⇒ Boolean

Returns Also delete all user conversations.

Returns:

  • (Boolean) —

    Also delete all user conversations



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

def delete_conversation_channels
  @delete_conversation_channels
end

#delete_feeds_content ⇒ Boolean

Returns Delete flagged feeds content.

Returns:

  • (Boolean) —

    Delete flagged feeds content



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

def delete_feeds_content
  @delete_feeds_content
end

#entity_id ⇒ String

Returns ID of the user to delete (alternative to item_id).

Returns:

  • (String) —

    ID of the user to delete (alternative to item_id)



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

def entity_id
  @entity_id
end

#entity_type ⇒ String

Returns Type of the entity.

Returns:

  • (String) —

    Type of the entity



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

def entity_type
  @entity_type
end

#hard_delete ⇒ Boolean

Returns Whether to permanently delete the user.

Returns:

  • (Boolean) —

    Whether to permanently delete the user



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

def hard_delete
  @hard_delete
end

#mark_messages_deleted ⇒ Boolean

Returns Also delete all user messages.

Returns:

  • (Boolean) —

    Also delete all user messages



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

def mark_messages_deleted
  @mark_messages_deleted
end

#reason ⇒ String

Returns Reason for deletion.

Returns:

  • (String) —

    Reason for deletion



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

def reason
  @reason
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



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

def self.json_field_mappings
  {
    delete_conversation_channels: 'delete_conversation_channels',
    delete_feeds_content: 'delete_feeds_content',
    entity_id: 'entity_id',
    entity_type: 'entity_type',
    hard_delete: 'hard_delete',
    mark_messages_deleted: 'mark_messages_deleted',
    reason: 'reason'
  }
end