Class: Zernio::ConnectWhatsAppEmbeddedSignupRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ConnectWhatsAppEmbeddedSignupRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 86

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

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

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  else
    self.code = nil
  end

  if attributes.key?(:'profile_id')
    self.profile_id = attributes[:'profile_id']
  else
    self.profile_id = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Authorization code from the WA_EMBEDDED_SIGNUP postMessage



19
20
21
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 19

def code
  @code
end

#echo_connect_token ⇒ Object

Hosted signup page only. Append the connect token to the success redirect, as the redirect flow does for API-key callers.



38
39
40
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 38

def echo_connect_token
  @echo_connect_token
end

#expected_phone_number ⇒ Object

Rejects the connect when Meta returns a different number



32
33
34
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 32

def expected_phone_number
  @expected_phone_number
end

#is_coexistence ⇒ Object

Number is also live in the WhatsApp Business app



29
30
31
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 29

def is_coexistence
  @is_coexistence
end

#phone_number_id ⇒ Object

Returns the value of attribute phone_number_id.



26
27
28
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 26

def phone_number_id
  @phone_number_id
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



21
22
23
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 21

def profile_id
  @profile_id
end

#redirect_url ⇒ Object

Hosted signup page only. When present, the response also carries redirectUrl, the URL the user should land on, with the outcome mapped exactly like the redirect flow (success params, or error and platform with the same values). Must be an absolute http(s) URL or a custom app scheme.



35
36
37
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 35

def redirect_url
  @redirect_url
end

#waba_id ⇒ Object

WhatsApp Business Account id, when the SDK reported one



24
25
26
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 24

def waba_id
  @waba_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 55

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 60

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 41

def self.attribute_map
  {
    :'code' => :'code',
    :'profile_id' => :'profileId',
    :'waba_id' => :'wabaId',
    :'phone_number_id' => :'phoneNumberId',
    :'is_coexistence' => :'isCoexistence',
    :'expected_phone_number' => :'expectedPhoneNumber',
    :'redirect_url' => :'redirectUrl',
    :'echo_connect_token' => :'echoConnectToken'
  }
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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 212

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



79
80
81
82
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 79

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 65

def self.openapi_types
  {
    :'code' => :'String',
    :'profile_id' => :'String',
    :'waba_id' => :'String',
    :'phone_number_id' => :'String',
    :'is_coexistence' => :'Boolean',
    :'expected_phone_number' => :'String',
    :'redirect_url' => :'String',
    :'echo_connect_token' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      profile_id == o.profile_id &&
      waba_id == o.waba_id &&
      phone_number_id == o.phone_number_id &&
      is_coexistence == o.is_coexistence &&
      expected_phone_number == o.expected_phone_number &&
      redirect_url == o.redirect_url &&
      echo_connect_token == o.echo_connect_token
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 205

def hash
  [code, profile_id, waba_id, phone_number_id, is_coexistence, expected_phone_number, redirect_url, echo_connect_token].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



139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 139

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @code.nil?
    invalid_properties.push('invalid value for "code", code cannot be nil.')
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 234

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



155
156
157
158
159
160
 
# File 'lib/zernio-sdk/models/connect_whats_app_embedded_signup_request.rb', line 155

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @code.nil?
  return false if @profile_id.nil?
  true
end