Class: Pinnacle::SmsMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/rcs/types/sms_message.rb

Overview

The content of the message

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body:, media_url: OMIT, additional_properties: nil) ⇒ Pinnacle::SmsMessage

Parameters:

  • body (String) —

    The body of the SMS message

  • media_url (String) (defaults to: OMIT) —

    Optional media URL for the SMS message

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/rcs/types/sms_message.rb', line 25

def initialize(body:, media_url: OMIT, additional_properties: nil)
  @body = body
  @media_url = media_url if media_url != OMIT
  @additional_properties = additional_properties
  @_field_set = { "body": body, "mediaUrl": media_url }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/rcs/types/sms_message.rb', line 14

def additional_properties
  @additional_properties
end

#body ⇒ String (readonly)

Returns The body of the SMS message.

Returns:

  • (String) —

    The body of the SMS message



10
11
12
 
# File 'lib/rcs/types/sms_message.rb', line 10

def body
  @body
end

#media_url ⇒ String (readonly)

Returns Optional media URL for the SMS message.

Returns:

  • (String) —

    Optional media URL for the SMS message



12
13
14
 
# File 'lib/rcs/types/sms_message.rb', line 12

def media_url
  @media_url
end

Class Method Details

.from_json(json_object:) ⇒ Pinnacle::SmsMessage

Deserialize a JSON object to an instance of SmsMessage

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rcs/types/sms_message.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  body = parsed_json["body"]
  media_url = parsed_json["mediaUrl"]
  new(
    body: body,
    media_url: media_url,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


63
64
65
66
 
# File 'lib/rcs/types/sms_message.rb', line 63

def self.validate_raw(obj:)
  obj.body.is_a?(String) != false || raise("Passed value for field obj.body is not the expected type, validation failed.")
  obj.media_url&.is_a?(String) != false || raise("Passed value for field obj.media_url is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of SmsMessage to a JSON object

Returns:

  • (String) 


53
54
55
 
# File 'lib/rcs/types/sms_message.rb', line 53

def to_json(*_args)
  @_field_set&.to_json
end