Class: SunshineConversationsClient::Mailgun

Inherits:
Integration
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/mailgun.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 = {}) ⇒ Mailgun

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
157
158
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 109

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

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

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

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

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

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

Instance Attribute Details

#api_key ⇒ Object

The public API key of your Mailgun account.



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

def api_key
  @api_key
end

#default_responder ⇒ Object

Returns the value of attribute default_responder.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/mailgun.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/mailgun.rb', line 16

def default_responder_id
  @default_responder_id
end

#domain ⇒ Object

The domain used to relay email. This domain must be configured and verified in your Mailgun account.



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

def domain
  @domain
end

#from_address ⇒ Object

Email address to use as the From and Reply-To address if it must be different from incomingAddress. Only use this option if the address that you supply is configured to forward emails to the incomingAddress, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user’s email client. May be unset with null.



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

def from_address
  @from_address
end

#hide_unsubscribe_link ⇒ Object

A boolean value indicating whether the unsubscribe link should be omitted from outgoing emails. When enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. By default, the unsubscribe link will be included in all outgoing emails.



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

def hide_unsubscribe_link
  @hide_unsubscribe_link
end

#incoming_address ⇒ Object

Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address.



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

def incoming_address
  @incoming_address
end

#type ⇒ Object

To configure a Mailgun integration, visit the API Keys tab in the settings page of the Mailgun dashboard and copy your active API key. Call the Create Integration endpoint with your API Key, a domain you have configured in Mailgun, and the incoming address you would like to use. Must have the same domain as the one specified in the domain parameter.



21
22
23
 
# File 'lib/sunshine-conversations-client/models/mailgun.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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 306

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.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 61

def self.attribute_map
  {
    :'default_responder_id' => :'defaultResponderId',
    :'default_responder' => :'defaultResponder',
    :'type' => :'type',
    :'api_key' => :'apiKey',
    :'domain' => :'domain',
    :'incoming_address' => :'incomingAddress',
    :'hide_unsubscribe_link' => :'hideUnsubscribeLink',
    :'from_address' => :'fromAddress'
  }
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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 281

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)



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
95
96
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 75

def self.openapi_types
  {
    :'default_responder_id' => :'String',
    :'default_responder' => :'DefaultResponderDefaultResponder',
    :'type' => :'String',
    :'api_key' => :'String',
    :'domain' => :'String',
    :'incoming_address' => :'String',
    :'hide_unsubscribe_link' => :'Boolean',
    :'from_address' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 253

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 &&
      api_key == o.api_key &&
      domain == o.domain &&
      incoming_address == o.incoming_address &&
      hide_unsubscribe_link == o.hide_unsubscribe_link &&
      from_address == o.from_address && 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



377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 377

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


268
269
270
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 274

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 162

def list_invalid_properties
  invalid_properties = super
  if @api_key.to_s.length < 1
    invalid_properties.push('invalid value for "api_key", the character length must be great than or equal to 1.')
  end

  if @domain.nil?
    invalid_properties.push('invalid value for "domain", domain cannot be nil.')
  end

  if @domain.to_s.length < 1
    invalid_properties.push('invalid value for "domain", the character length must be great than or equal to 1.')
  end

  if @incoming_address.nil?
    invalid_properties.push('invalid value for "incoming_address", incoming_address cannot be nil.')
  end

  if @incoming_address.to_s.length < 1
    invalid_properties.push('invalid value for "incoming_address", the character length must be great than or equal to 1.')
  end

  if !@from_address.nil? && @from_address.to_s.length < 1
    invalid_properties.push('invalid value for "from_address", 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



353
354
355
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 353

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 359

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



347
348
349
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 347

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



193
194
195
196
197
198
199
200
201
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 193

def valid?
  return false if @api_key.to_s.length < 1
  return false if @domain.nil?
  return false if @domain.to_s.length < 1
  return false if @incoming_address.nil?
  return false if @incoming_address.to_s.length < 1
  return false if !@from_address.nil? && @from_address.to_s.length < 1
  true && super
end