Class: OCI::Oda::Models::CreateSlackChannelDetails

Inherits:
CreateChannelDetails show all
Defined in:
lib/oci/oda/models/create_slack_channel_details.rb

Overview

Properties required to create a Slack channel.

Constant Summary

Constants inherited from CreateChannelDetails

OCI::Oda::Models::CreateChannelDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateChannelDetails

#defined_tags, #description, #freeform_tags, #name, #session_expiry_duration_in_milliseconds, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateChannelDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateSlackChannelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :session_expiry_duration_in_milliseconds (Integer) —

    The value to assign to the #session_expiry_duration_in_milliseconds proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :client_id (String) —

    The value to assign to the #client_id property

  • :auth_success_url (String) —

    The value to assign to the #auth_success_url property

  • :auth_error_url (String) —

    The value to assign to the #auth_error_url property

  • :signing_secret (String) —

    The value to assign to the #signing_secret property

  • :client_secret (String) —

    The value to assign to the #client_secret property

  • :bot_id (String) —

    The value to assign to the #bot_id property



93
94
95
96
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
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 93

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'SLACK'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.client_id = attributes[:'clientId'] if attributes[:'clientId']

  raise 'You cannot provide both :clientId and :client_id' if attributes.key?(:'clientId') && attributes.key?(:'client_id')

  self.client_id = attributes[:'client_id'] if attributes[:'client_id']

  self.auth_success_url = attributes[:'authSuccessUrl'] if attributes[:'authSuccessUrl']

  raise 'You cannot provide both :authSuccessUrl and :auth_success_url' if attributes.key?(:'authSuccessUrl') && attributes.key?(:'auth_success_url')

  self.auth_success_url = attributes[:'auth_success_url'] if attributes[:'auth_success_url']

  self.auth_error_url = attributes[:'authErrorUrl'] if attributes[:'authErrorUrl']

  raise 'You cannot provide both :authErrorUrl and :auth_error_url' if attributes.key?(:'authErrorUrl') && attributes.key?(:'auth_error_url')

  self.auth_error_url = attributes[:'auth_error_url'] if attributes[:'auth_error_url']

  self.signing_secret = attributes[:'signingSecret'] if attributes[:'signingSecret']

  raise 'You cannot provide both :signingSecret and :signing_secret' if attributes.key?(:'signingSecret') && attributes.key?(:'signing_secret')

  self.signing_secret = attributes[:'signing_secret'] if attributes[:'signing_secret']

  self.client_secret = attributes[:'clientSecret'] if attributes[:'clientSecret']

  raise 'You cannot provide both :clientSecret and :client_secret' if attributes.key?(:'clientSecret') && attributes.key?(:'client_secret')

  self.client_secret = attributes[:'client_secret'] if attributes[:'client_secret']

  self.bot_id = attributes[:'botId'] if attributes[:'botId']

  raise 'You cannot provide both :botId and :bot_id' if attributes.key?(:'botId') && attributes.key?(:'bot_id')

  self.bot_id = attributes[:'bot_id'] if attributes[:'bot_id']
end

Instance Attribute Details

#auth_error_url ⇒ String

The URL to redirect to when authentication is unsuccessful.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 22

def auth_error_url
  @auth_error_url
end

#auth_success_url ⇒ String

The URL to redirect to when authentication is successful.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 18

def auth_success_url
  @auth_success_url
end

#bot_id ⇒ String

The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 34

def bot_id
  @bot_id
end

#client_id ⇒ String

[Required] The Slack Client Id for the Slack app.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 14

def client_id
  @client_id
end

#client_secret ⇒ String

[Required] The Client Secret for the Slack App.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 30

def client_secret
  @client_secret
end

#signing_secret ⇒ String

[Required] The Signing Secret for the Slack App.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 26

def signing_secret
  @signing_secret
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'type': :'type',
    'session_expiry_duration_in_milliseconds': :'sessionExpiryDurationInMilliseconds',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'client_id': :'clientId',
    'auth_success_url': :'authSuccessUrl',
    'auth_error_url': :'authErrorUrl',
    'signing_secret': :'signingSecret',
    'client_secret': :'clientSecret',
    'bot_id': :'botId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'type': :'String',
    'session_expiry_duration_in_milliseconds': :'Integer',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'client_id': :'String',
    'auth_success_url': :'String',
    'auth_error_url': :'String',
    'signing_secret': :'String',
    'client_secret': :'String',
    'bot_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 147

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    type == other.type &&
    session_expiry_duration_in_milliseconds == other.session_expiry_duration_in_milliseconds &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    client_id == other.client_id &&
    auth_success_url == other.auth_success_url &&
    auth_error_url == other.auth_error_url &&
    signing_secret == other.signing_secret &&
    client_secret == other.client_secret &&
    bot_id == other.bot_id
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 177

def hash
  [name, description, type, session_expiry_duration_in_milliseconds, freeform_tags, defined_tags, client_id, auth_success_url, auth_error_url, signing_secret, client_secret, bot_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 221

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



215
216
217
 
# File 'lib/oci/oda/models/create_slack_channel_details.rb', line 215

def to_s
  to_hash.to_s
end