Class: SunshineConversationsClient::SwitchboardIntegrationCreateBody

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SwitchboardIntegrationCreateBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 67

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

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

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

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

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

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

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

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

Instance Attribute Details

#deliver_standby_events ⇒ Object

Setting to determine if webhooks should be sent when the switchboard integration is not in control of a conversation (standby status)



25
26
27
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 25

def deliver_standby_events
  @deliver_standby_events
end

#integration_id ⇒ Object

The id of the integration to link to the switchboard integration. Must be used when linking a custom integration. One of ‘integrationId` or `integrationType` must be provided.



19
20
21
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 19

def integration_id
  @integration_id
end

#integration_type ⇒ Object

The type of the integration to link to the switchboard integration. Must be used when linking an OAuth integration. One of ‘integrationId` or `integrationType` must be provided.



22
23
24
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 22

def integration_type
  @integration_type
end

#message_history_count ⇒ Object

Number of messages to include in the message history context.



31
32
33
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 31

def message_history_count
  @message_history_count
end

#name ⇒ Object

Identifier for use in control transfer protocols. Restricted to alphanumeric characters, ‘-` and `_`.



16
17
18
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 16

def name
  @name
end

#next_switchboard_integration_id ⇒ Object

The switchboard integration id to which control of a conversation is passed / offered by default.



28
29
30
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 28

def next_switchboard_integration_id
  @next_switchboard_integration_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 218

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = SunshineConversationsClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 34

def self.attribute_map
  {
    :'name' => :'name',
    :'integration_id' => :'integrationId',
    :'integration_type' => :'integrationType',
    :'deliver_standby_events' => :'deliverStandbyEvents',
    :'next_switchboard_integration_id' => :'nextSwitchboardIntegrationId',
    :'message_history_count' => :'messageHistoryCount'
  }
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 194

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



58
59
60
61
62
63
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 58

def self.openapi_nullable
  Set.new([
    :'next_switchboard_integration_id',
    :'message_history_count'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 46

def self.openapi_types
  {
    :'name' => :'String',
    :'integration_id' => :'String',
    :'integration_type' => :'String',
    :'deliver_standby_events' => :'Boolean',
    :'next_switchboard_integration_id' => :'String',
    :'message_history_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      integration_id == o.integration_id &&
      integration_type == o.integration_type &&
      deliver_standby_events == o.deliver_standby_events &&
      next_switchboard_integration_id == o.next_switchboard_integration_id &&
      message_history_count == o.message_history_count
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 289

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 187

def hash
  [nameintegration_idintegration_typedeliver_standby_eventsnext_switchboard_integration_idmessage_history_count].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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 107

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  if !@message_history_count.nil? && @message_history_count > 10
    invalid_properties.push('invalid value for "message_history_count", must be smaller than or equal to 10.')
  end

  if !@message_history_count.nil? && @message_history_count < 1
    invalid_properties.push('invalid value for "message_history_count", must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 271

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



130
131
132
133
134
135
136
 
# File 'lib/sunshine-conversations-client/models/switchboard_integration_create_body.rb', line 130

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if !@message_history_count.nil? && @message_history_count > 10
  return false if !@message_history_count.nil? && @message_history_count < 1
  true
end