Class: Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/providers/ms_team_list_channels_response.rb,
sig/knockapi/models/providers/ms_team_list_channels_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, display_name:, created_date_time: nil, description: nil, is_archived: nil, membership_type: nil) ⇒ Object

Parameters:

  • id (String) —

    Microsoft Teams channel ID.

  • display_name (String) —

    Microsoft Teams channel name.

  • created_date_time (String) (defaults to: nil) —

    Microsoft Teams channel created date and time.

  • description (String, nil) (defaults to: nil) —

    Microsoft Teams channel description.

  • is_archived (Boolean) (defaults to: nil) —

    Whether the Microsoft Teams channel is archived.

  • membership_type (String) (defaults to: nil) —

    Microsoft Teams channel membership type.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 21

class MsTeamsChannel < Knockapi::Internal::Type::BaseModel
  # @!attribute id
  #   Microsoft Teams channel ID.
  #
  #   @return [String]
  required :id, String

  # @!attribute display_name
  #   Microsoft Teams channel name.
  #
  #   @return [String]
  required :display_name, String, api_name: :displayName

  # @!attribute created_date_time
  #   Microsoft Teams channel created date and time.
  #
  #   @return [String, nil]
  optional :created_date_time, String, api_name: :createdDateTime

  # @!attribute description
  #   Microsoft Teams channel description.
  #
  #   @return [String, nil]
  optional :description, String, nil?: true

  # @!attribute is_archived
  #   Whether the Microsoft Teams channel is archived.
  #
  #   @return [Boolean, nil]
  optional :is_archived, Knockapi::Internal::Type::Boolean, api_name: :isArchived

  # @!attribute membership_type
  #   Microsoft Teams channel membership type.
  #
  #   @return [String, nil]
  optional :membership_type, String, api_name: :membershipType

  # @!method initialize(id:, display_name:, created_date_time: nil, description: nil, is_archived: nil, membership_type: nil)
  #   @param id [String] Microsoft Teams channel ID.
  #
  #   @param display_name [String] Microsoft Teams channel name.
  #
  #   @param created_date_time [String] Microsoft Teams channel created date and time.
  #
  #   @param description [String, nil] Microsoft Teams channel description.
  #
  #   @param is_archived [Boolean] Whether the Microsoft Teams channel is archived.
  #
  #   @param membership_type [String] Microsoft Teams channel membership type.
end

Instance Attribute Details

#created_date_time ⇒ String?

Microsoft Teams channel created date and time.

Parameters:

  • (String)

Returns:

  • (String, nil) 


38
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 38

optional :created_date_time, String, api_name: :createdDateTime

#description ⇒ String?

Microsoft Teams channel description.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


44
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 44

optional :description, String, nil?: true

#display_name ⇒ String

Microsoft Teams channel name.

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 32

required :display_name, String, api_name: :displayName

#id ⇒ String

Microsoft Teams channel ID.

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 26

required :id, String

#is_archived ⇒ Boolean?

Whether the Microsoft Teams channel is archived.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


50
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 50

optional :is_archived, Knockapi::Internal::Type::Boolean, api_name: :isArchived

#membership_type ⇒ String?

Microsoft Teams channel membership type.

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/knockapi/models/providers/ms_team_list_channels_response.rb', line 56

optional :membership_type, String, api_name: :membershipType

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


58
 
# File 'sig/knockapi/models/providers/ms_team_list_channels_response.rbs', line 58

def to_hash: -> {