Class: Zernio::DiscordPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/discord_platform_data.rb

Overview

Discord message settings. Supports plain text (2,000 chars), rich embeds (up to 10), native polls, forum posts, threads, and announcement crossposts. Media attachments support images (JPEG, PNG, GIF, WebP), videos (MP4), and documents (up to 10 files, 25 MB each). Webhook identity (username + avatar) can be customized per-account via PATCH /v1/connect/discord or per-post via webhookUsername/webhookAvatarUrl.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ DiscordPlatformData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::DiscordPlatformData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::DiscordPlatformData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'channel_id')
    self.channel_id = attributes[:'channel_id']
  else
    self.channel_id = nil
  end

  if attributes.key?(:'embeds')
    if (value = attributes[:'embeds']).is_a?(Array)
      self.embeds = value
    end
  end

  if attributes.key?(:'poll')
    self.poll = attributes[:'poll']
  end

  if attributes.key?(:'crosspost')
    self.crosspost = attributes[:'crosspost']
  end

  if attributes.key?(:'forum_thread_name')
    self.forum_thread_name = attributes[:'forum_thread_name']
  end

  if attributes.key?(:'forum_applied_tags')
    if (value = attributes[:'forum_applied_tags']).is_a?(Array)
      self.forum_applied_tags = value
    end
  end

  if attributes.key?(:'thread_from_message')
    self.thread_from_message = attributes[:'thread_from_message']
  end

  if attributes.key?(:'tts')
    self.tts = attributes[:'tts']
  end

  if attributes.key?(:'webhook_username')
    self.webhook_username = attributes[:'webhook_username']
  end

  if attributes.key?(:'webhook_avatar_url')
    self.webhook_avatar_url = attributes[:'webhook_avatar_url']
  end
end

Instance Attribute Details

#channel_id ⇒ Object

Target channel snowflake ID. Determines which channel in the connected server receives the message.



20
21
22
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 20

def channel_id
  @channel_id
end

#crosspost ⇒ Object

Auto-crosspost to every server following this announcement channel (type 5). No-op for regular text channels.



28
29
30
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 28

def crosspost
  @crosspost
end

#embeds ⇒ Object

Up to 10 Discord embed objects (combined max 6,000 characters across all embeds). Sent alongside or instead of plain-text content.



23
24
25
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 23

def embeds
  @embeds
end

#forum_applied_tags ⇒ Object

Tag snowflake IDs to apply to forum posts. Max 5 tags.



34
35
36
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 34

def forum_applied_tags
  @forum_applied_tags
end

#forum_thread_name ⇒ Object

Thread title for forum channel posts (type 15). Required when posting to a forum channel.



31
32
33
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 31

def forum_thread_name
  @forum_thread_name
end

#poll ⇒ Object

Returns the value of attribute poll.



25
26
27
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 25

def poll
  @poll
end

#thread_from_message ⇒ Object

Returns the value of attribute thread_from_message.



36
37
38
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 36

def thread_from_message
  @thread_from_message
end

#tts ⇒ Object

Send as text-to-speech message. Discord reads the message aloud in the channel.



39
40
41
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 39

def tts
  @tts
end

#webhook_avatar_url ⇒ Object

Override the webhook avatar URL for this post only. Falls back to the account-level default.



45
46
47
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 45

def webhook_avatar_url
  @webhook_avatar_url
end

#webhook_username ⇒ Object

Override the webhook display name for this post only (1-80 chars). Falls back to the account-level default set via PATCH /v1/connect/discord.



42
43
44
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 42

def webhook_username
  @webhook_username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



64
65
66
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 64

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 48

def self.attribute_map
  {
    :'channel_id' => :'channelId',
    :'embeds' => :'embeds',
    :'poll' => :'poll',
    :'crosspost' => :'crosspost',
    :'forum_thread_name' => :'forumThreadName',
    :'forum_applied_tags' => :'forumAppliedTags',
    :'thread_from_message' => :'threadFromMessage',
    :'tts' => :'tts',
    :'webhook_username' => :'webhookUsername',
    :'webhook_avatar_url' => :'webhookAvatarUrl'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 90

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 74

def self.openapi_types
  {
    :'channel_id' => :'String',
    :'embeds' => :'Array<DiscordPlatformDataEmbedsInner>',
    :'poll' => :'DiscordPlatformDataPoll',
    :'crosspost' => :'Boolean',
    :'forum_thread_name' => :'String',
    :'forum_applied_tags' => :'Array<String>',
    :'thread_from_message' => :'DiscordPlatformDataThreadFromMessage',
    :'tts' => :'Boolean',
    :'webhook_username' => :'String',
    :'webhook_avatar_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel_id == o.channel_id &&
      embeds == o.embeds &&
      poll == o.poll &&
      crosspost == o.crosspost &&
      forum_thread_name == o.forum_thread_name &&
      forum_applied_tags == o.forum_applied_tags &&
      thread_from_message == o.thread_from_message &&
      tts == o.tts &&
      webhook_username == o.webhook_username &&
      webhook_avatar_url == o.webhook_avatar_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 251

def hash
  [channel_id, embeds, poll, crosspost, forum_thread_name, forum_applied_tags, thread_from_message, tts, webhook_username, webhook_avatar_url].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 160

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @channel_id.nil?
    invalid_properties.push('invalid value for "channel_id", channel_id cannot be nil.')
  end

  if !@embeds.nil? && @embeds.length > 10
    invalid_properties.push('invalid value for "embeds", number of items must be less than or equal to 10.')
  end

  if !@forum_applied_tags.nil? && @forum_applied_tags.length > 5
    invalid_properties.push('invalid value for "forum_applied_tags", number of items must be less than or equal to 5.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 280

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



180
181
182
183
184
185
186
 
# File 'lib/zernio-sdk/models/discord_platform_data.rb', line 180

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @channel_id.nil?
  return false if !@embeds.nil? && @embeds.length > 10
  return false if !@forum_applied_tags.nil? && @forum_applied_tags.length > 5
  true
end