Class: GetStream::Generated::Models::UpsertActionConfigRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/upsert_action_config_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 = {}) ⇒ UpsertActionConfigRequest

Initialize with attributes



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/getstream_ruby/generated/models/upsert_action_config_request.rb', line 44

def initialize(attributes = {})
  super(attributes)
  @action = attributes[:action] || attributes['action']
  @entity_type = attributes[:entity_type] || attributes['entity_type']
  @order = attributes[:order] || attributes['order']
  @description = attributes[:description] || attributes['description'] || nil
  @icon = attributes[:icon] || attributes['icon'] || nil
  @id = attributes[:id] || attributes['id'] || nil
  @queue_type = attributes[:queue_type] || attributes['queue_type'] || nil
  @user_id = attributes[:user_id] || attributes['user_id'] || nil
  @custom = attributes[:custom] || attributes['custom'] || nil
  @user = attributes[:user] || attributes['user'] || nil
end

Instance Attribute Details

#action ⇒ String

Returns The action to perform (e.g. ban, delete_message, custom).

Returns:

  • (String) —

    The action to perform (e.g. ban, delete_message, custom)



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

def action
  @action
end

#custom ⇒ Object

Returns Action-specific parameters passed to the action handler.

Returns:

  • (Object) —

    Action-specific parameters passed to the action handler



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

def custom
  @custom
end

#description ⇒ String

Returns Human-readable label for the dashboard button.

Returns:

  • (String) —

    Human-readable label for the dashboard button



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

def description
  @description
end

#entity_type ⇒ String

Returns Type of entity this action applies to (e.g. stream:chat:v1:message).

Returns:

  • (String) —

    Type of entity this action applies to (e.g. stream:chat:v1:message)



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

def entity_type
  @entity_type
end

#icon ⇒ String

Returns Icon identifier for the dashboard button.

Returns:

  • (String) —

    Icon identifier for the dashboard button



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

def icon
  @icon
end

#id ⇒ String

Returns UUID of an existing action config to update; omit to create a new record.

Returns:

  • (String) —

    UUID of an existing action config to update; omit to create a new record



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

def id
  @id
end

#order ⇒ Integer

Returns Display order in the dashboard (0–100, lower numbers shown first).

Returns:

  • (Integer) —

    Display order in the dashboard (0–100, lower numbers shown first)



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

def order
  @order
end

#queue_type ⇒ String

Returns Queue this config belongs to; null means the default queue.

Returns:

  • (String) —

    Queue this config belongs to; null means the default queue



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

def queue_type
  @queue_type
end

#user ⇒ UserRequest

Returns:



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

def user
  @user
end

#user_id ⇒ String

Returns Optional user ID to associate with the audit log entry.

Returns:

  • (String) —

    Optional user ID to associate with the audit log entry



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

def user_id
  @user_id
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/getstream_ruby/generated/models/upsert_action_config_request.rb', line 59

def self.json_field_mappings
  {
    action: 'action',
    entity_type: 'entity_type',
    order: 'order',
    description: 'description',
    icon: 'icon',
    id: 'id',
    queue_type: 'queue_type',
    user_id: 'user_id',
    custom: 'custom',
    user: 'user'
  }
end