Class: SunshineConversationsClient::Line

Inherits:
Integration show all
Defined in:
lib/sunshine-conversations-client/models/line.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from Integration

#display_name, #id, #status

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Integration

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ Line

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 117

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Line` 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::Line`. 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
  }

  # call parent's initialize
  super(attributes)

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'line'
  end

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

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

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

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

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

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

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

Instance Attribute Details

#channel_access_token ⇒ Object

LINE Channel Access Token.



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

def channel_access_token
  @channel_access_token
end

#channel_id ⇒ Object

LINE Channel ID. Can be omitted along with ‘channelSecret` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE.



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

def channel_id
  @channel_id
end

#channel_secret ⇒ Object

LINE Channel Secret. Can be omitted along with ‘channelId` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE.



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

def channel_secret
  @channel_secret
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



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

def default_responder
  @default_responder
end

#default_responder_id ⇒ Object

The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to the <a href="developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment">Switchboard guide</a>.



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

def default_responder_id
  @default_responder_id
end

#line_id ⇒ Object

LINE Basic ID. Is automatically set when qrCodeUrl is updated.



42
43
44
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 42

def line_id
  @line_id
end

#qr_code_url ⇒ Object

URL provided by LINE in the [Developer Console](developers.line.biz/console/).



39
40
41
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 39

def qr_code_url
  @qr_code_url
end

#service_code ⇒ Object

LINE Service Code.



33
34
35
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 33

def service_code
  @service_code
end

#switcher_secret ⇒ Object

LINE Switcher Secret.



36
37
38
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 36

def switcher_secret
  @switcher_secret
end

#type ⇒ Object

For LINE, each of your customers will need to manually configure a webhook in their LINE configuration page that will point to Sunshine Conversations servers. You must instruct your customers how to configure this manually on their LINE bot page. Once you’ve acquired all the required information, call the Create Integration endpoint. Then, using the returned integration _id, your customer must set the Callback URL field in their LINE Business Center page. The URL should look like the following: ‘app.smooch.io:443/api/line/webhooks/appId/integrationId`.



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

def type
  @type
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 261

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.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 67

def self.attribute_map
  {
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder',
    :'type' => :'type',
    :'channel_id' => :'channelId',
    :'channel_secret' => :'channelSecret',
    :'channel_access_token' => :'channelAccessToken',
    :'service_code' => :'serviceCode',
    :'switcher_secret' => :'switcherSecret',
    :'qr_code_url' => :'qrCodeUrl',
    :'line_id' => :'lineId'
  }
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



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/line.rb', line 236

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



107
108
109
110
111
112
113
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 107

def self.openapi_all_of
  [
  :'DefaultResponder',
  :'DefaultResponderId',
  :'Integration'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 99

def self.openapi_nullable
  Set.new([
    :'default_responder_id',
    :'default_responder',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 83

def self.openapi_types
  {
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder',
    :'type' => :'String',
    :'channel_id' => :'String',
    :'channel_secret' => :'String',
    :'channel_access_token' => :'String',
    :'service_code' => :'String',
    :'switcher_secret' => :'String',
    :'qr_code_url' => :'String',
    :'line_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_responder_id == o.default_responder_id &&
      default_responder == o.default_responder &&
      type == o.type &&
      channel_id == o.channel_id &&
      channel_secret == o.channel_secret &&
      channel_access_token == o.channel_access_token &&
      service_code == o.service_code &&
      switcher_secret == o.switcher_secret &&
      qr_code_url == o.qr_code_url &&
      line_id == o.line_id && super(o)
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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 332

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


223
224
225
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 229

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



178
179
180
181
182
183
184
185
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 178

def list_invalid_properties
  invalid_properties = super
  if !@switcher_secret.nil? && @switcher_secret.to_s.length < 1
    invalid_properties.push('invalid value for "switcher_secret", the character length must be great 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



308
309
310
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 308

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 314

def to_hash
  hash = super
  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



302
303
304
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 302

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



189
190
191
192
 
# File 'lib/sunshine-conversations-client/models/line.rb', line 189

def valid?
  return false if !@switcher_secret.nil? && @switcher_secret.to_s.length < 1
  true && super
end