Class: SunshineConversationsClient::Mailgun

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

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



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
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 73

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?(:'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.



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

def api_key
  @api_key
end

#domain ⇒ Object

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



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

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.



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

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.



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

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.



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

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.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'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



244
245
246
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 244

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



64
65
66
67
68
69
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 64

def self.openapi_all_of
  [
  :'Integration',
  :'MailgunAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
60
61
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 57

def self.openapi_nullable
  Set.new([
    :'from_address'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'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



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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

#_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



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
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 273

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    SunshineConversationsClient.const_get(type).build_from_hash(value)
  end
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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 342

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

#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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 237

def hash
  [type, api_key, domain, incoming_address, hide_unsubscribe_link, from_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



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

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

  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



318
319
320
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 324

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



312
313
314
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 312

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



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/sunshine-conversations-client/models/mailgun.rb', line 153

def valid?
  return false if @api_key.nil?
  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