Class: Zernio::GetAccountHealth200ResponsePlatformConnection

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

Overview

WhatsApp accounts only. Live probe of the Meta link behind the channel, performed at request time (the same read as GET /v1/whatsapp/number-info).

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ GetAccountHealth200ResponsePlatformConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 97

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

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

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

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

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

Instance Attribute Details

#checked_at ⇒ Object

When this live probe ran (always the current request; never cached)



23
24
25
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 23

def checked_at
  @checked_at
end

#inbound_webhook_subscribed ⇒ Object

From the phone number's Meta health_status. false = Meta says Zernio is not subscribed to the message webhook for this number, so inbound messages are not delivered even though the number is CONNECTED and can still send. Fix by re-subscribing (reconnect the number); if it stays false, the number is routed to a different WhatsApp Business Account (typically after linking it to a Facebook Page). true = Meta reports no such problem. null = Meta did not report it (read failed or no health_status), not evidence either way.



31
32
33
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 31

def inbound_webhook_subscribed
  @inbound_webhook_subscribed
end

#meta_error ⇒ Object

Returns the value of attribute meta_error.



28
29
30
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 28

def meta_error
  @meta_error
end

#phone_status ⇒ Object

Meta's own status field from the phone-number node (for example CONNECTED), when the object was readable



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

def phone_status
  @phone_status
end

#status ⇒ Object

connected = Meta served the channel object. disconnected = Meta refused to serve it (Graph error 100, subcode 33), which is how a phone-side coexistence disconnect surfaces. unknown = the live read failed for another reason (timeout, transient Meta error), not evidence either way.



20
21
22
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 20

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 56

def self.attribute_map
  {
    :'status' => :'status',
    :'checked_at' => :'checkedAt',
    :'phone_status' => :'phoneStatus',
    :'meta_error' => :'metaError',
    :'inbound_webhook_subscribed' => :'inboundWebhookSubscribed'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 186

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



88
89
90
91
92
93
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 88

def self.openapi_nullable
  Set.new([
    :'phone_status',
    :'inbound_webhook_subscribed'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 77

def self.openapi_types
  {
    :'status' => :'String',
    :'checked_at' => :'Time',
    :'phone_status' => :'String',
    :'meta_error' => :'GetAccountHealth200ResponsePlatformConnectionMetaError',
    :'inbound_webhook_subscribed' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      checked_at == o.checked_at &&
      phone_status == o.phone_status &&
      meta_error == o.meta_error &&
      inbound_webhook_subscribed == o.inbound_webhook_subscribed
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 179

def hash
  [status, checked_at, phone_status, meta_error, inbound_webhook_subscribed].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



134
135
136
137
138
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 134

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 208

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



142
143
144
145
146
147
 
# File 'lib/zernio-sdk/models/get_account_health200_response_platform_connection.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["connected", "disconnected", "unknown"])
  return false unless status_validator.valid?(@status)
  true
end