Class: Courier::Profiles::SendToMsTeamsChannelName

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel_name:, team_id:, tenant_id:, service_url:, additional_properties: nil) ⇒ Profiles::SendToMsTeamsChannelName

Parameters:

  • channel_name (String)
  • team_id (String)
  • tenant_id (String)
  • service_url (String)
  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb', line 16

def initialize(channel_name:, team_id:, tenant_id:, service_url:, additional_properties: nil)
  # @type [String]
  @channel_name = channel_name
  # @type [String]
  @team_id = team_id
  # @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_propertiesObject (readonly)

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#channel_nameObject (readonly)

Returns the value of attribute channel_name.



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

def channel_name
  @channel_name
end

#service_urlObject (readonly)

Returns the value of attribute service_url.



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

def service_url
  @service_url
end

#team_idObject (readonly)

Returns the value of attribute team_id.



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

def team_id
  @team_id
end

#tenant_idObject (readonly)

Returns the value of attribute tenant_id.



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

def tenant_id
  @tenant_id
end

Class Method Details

.from_json(json_object:) ⇒ Profiles::SendToMsTeamsChannelName

Deserialize a JSON object to an instance of SendToMsTeamsChannelName

Parameters:

  • json_object (JSON)

Returns:



33
34
35
36
37
38
39
40
41
42
# File 'lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb', line 33

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


60
61
62
63
64
65
# File 'lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb', line 60

def self.validate_raw(obj:)
  obj.channel_name.is_a?(String) != false || raise("Passed value for field obj.channel_name is not the expected type, validation failed.")
  obj.team_id.is_a?(String) != false || raise("Passed value for field obj.team_id 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 SendToMsTeamsChannelName to a JSON object

Returns:

  • (JSON)


47
48
49
50
51
52
53
54
# File 'lib/trycourier/profiles/types/send_to_ms_teams_channel_name.rb', line 47

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