Class: Courier::Profiles::SendToMsTeamsEmail

Inherits:
Object
  • Object
show all
Defined in:
lib/trycourier/profiles/types/send_to_ms_teams_email.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email:, tenant_id:, service_url:, additional_properties: nil) ⇒ Profiles::SendToMsTeamsEmail

Parameters:

  • email (String)
  • tenant_id (String)
  • service_url (String)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 15

def initialize(email:, tenant_id:, service_url:, additional_properties: nil)
  # @type [String]
  @email = email
  # @type [String]
  @tenant_id = tenant_id
  # @type [String]
  @service_url = service_url
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 8

def additional_properties
  @additional_properties
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



8
9
10
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 8

def email
  @email
end

#service_url ⇒ Object (readonly)

Returns the value of attribute service_url.



8
9
10
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 8

def service_url
  @service_url
end

#tenant_id ⇒ Object (readonly)

Returns the value of attribute tenant_id.



8
9
10
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 8

def tenant_id
  @tenant_id
end

Class Method Details

.from_json(json_object:) ⇒ Profiles::SendToMsTeamsEmail

Deserialize a JSON object to an instance of SendToMsTeamsEmail

Parameters:

  • json_object (JSON)

Returns:



30
31
32
33
34
35
36
37
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 30

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  email = struct.email
  tenant_id = struct.tenant_id
  service_url = struct.service_url
  new(email: email, tenant_id: tenant_id, service_url: service_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) 


50
51
52
53
54
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 50

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SendToMsTeamsEmail to a JSON object

Returns:

  • (JSON) 


42
43
44
 
# File 'lib/trycourier/profiles/types/send_to_ms_teams_email.rb', line 42

def to_json(*_args)
  { "email": @email, "tenant_id": @tenant_id, "service_url": @service_url }.to_json
end