Class: Zernio::InboxWebhookMessageSender

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/inbox_webhook_message_sender.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 = {}) ⇒ InboxWebhookMessageSender

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 95

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#business_scoped_user_id ⇒ Object

WhatsApp only. Business-scoped user ID (BSUID) — Meta's canonical identifier for a WhatsApp user within your business. Present when Meta includes it in the inbound payload (rollout in progress since early April 2026). Recommended primary identity anchor going forward; fall back to phoneNumber only when this field is absent.



34
35
36
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 34

def business_scoped_user_id
  @business_scoped_user_id
end

#contact_id ⇒ Object

Zernio CRM Contact id for this sender, when one exists (joined via the ContactChannel mapping). Lets integrators link a message straight to a Contact without a follow-up Contacts API call. Omitted when the sender isn't a tracked contact (e.g. outgoing messages where the sender is the business, or first-touch messages before the contact is created).



22
23
24
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 22

def contact_id
  @contact_id
end

#id ⇒ Object

Sender's platform identifier. For WhatsApp this is the phone number (without leading +) when available, otherwise the businessScopedUserId. For other platforms, the platform's own user ID.



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

def id
  @id
end

#instagram_profile ⇒ Object

Returns the value of attribute instagram_profile.



42
43
44
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 42

def instagram_profile
  @instagram_profile
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#parent_business_scoped_user_id ⇒ Object

WhatsApp only. Parent BSUID for businesses with linked business portfolios. Omitted for standalone portfolios.



37
38
39
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 37

def parent_business_scoped_user_id
  @parent_business_scoped_user_id
end

#phone_number ⇒ Object

WhatsApp only. Sender's phone number in E.164 format (with leading +). Nullable during the BSUID rollout (April 2026+). WhatsApp users who adopt a username can message businesses without exposing a phone number — this field is omitted for them. Match by businessScopedUserId instead. See docs/whatsapp-bsuid-migration.md.



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

def phone_number
  @phone_number
end

#picture ⇒ Object

Returns the value of attribute picture.



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

def picture
  @picture
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

#whatsapp_username ⇒ Object

WhatsApp only. User's WhatsApp username (e.g. @jane). Not a stable identifier — users can change it. Useful for display, not recommended as an identity anchor.



40
41
42
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 40

def whatsapp_username
  @whatsapp_username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 45

def self.attribute_map
  {
    :'id' => :'id',
    :'contact_id' => :'contactId',
    :'name' => :'name',
    :'username' => :'username',
    :'picture' => :'picture',
    :'phone_number' => :'phoneNumber',
    :'business_scoped_user_id' => :'businessScopedUserId',
    :'parent_business_scoped_user_id' => :'parentBusinessScopedUserId',
    :'whatsapp_username' => :'whatsappUsername',
    :'instagram_profile' => :'instagramProfile'
  }
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



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

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



87
88
89
90
91
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 71

def self.openapi_types
  {
    :'id' => :'String',
    :'contact_id' => :'String',
    :'name' => :'String',
    :'username' => :'String',
    :'picture' => :'String',
    :'phone_number' => :'String',
    :'business_scoped_user_id' => :'String',
    :'parent_business_scoped_user_id' => :'String',
    :'whatsapp_username' => :'String',
    :'instagram_profile' => :'InboxWebhookMessageSenderInstagramProfile'
  }
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
196
197
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      contact_id == o.contact_id &&
      name == o.name &&
      username == o.username &&
      picture == o.picture &&
      phone_number == o.phone_number &&
      business_scoped_user_id == o.business_scoped_user_id &&
      parent_business_scoped_user_id == o.parent_business_scoped_user_id &&
      whatsapp_username == o.whatsapp_username &&
      instagram_profile == o.instagram_profile
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


201
202
203
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 207

def hash
  [id, contact_id, name, username, picture, phone_number, business_scoped_user_id, parent_business_scoped_user_id, whatsapp_username, instagram_profile].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



154
155
156
157
158
159
160
161
162
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", 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



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

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



166
167
168
169
170
 
# File 'lib/zernio-sdk/models/inbox_webhook_message_sender.rb', line 166

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