Class: Openlayer::Models::Workspaces::InviteCreateResponse::Item

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openlayer/models/workspaces/invite_create_response.rb

Defined Under Namespace

Modules: Role, Status Classes: Creator, Workspace

Instance Attribute Summary collapse

Class Method 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: nil, name: nil, username: nil) ⇒ Object

Parameters:

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

    The invite creator id.

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

    The invite creator name.

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

    The invite creator username.



17
18
19
20
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 17

class Item < Openlayer::Internal::Type::BaseModel
  # @!attribute creator
  #
  #   @return [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator]
  required :creator, -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator }

  # @!attribute email
  #   The invite email.
  #
  #   @return [String]
  required :email, String

  # @!attribute role
  #   The invite role.
  #
  #   @return [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role]
  required :role, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role }

  # @!attribute status
  #   The invite status.
  #
  #   @return [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status]
  required :status, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status }

  response_only do
    # @!attribute id
    #   The invite id.
    #
    #   @return [String]
    required :id, String

    # @!attribute date_created
    #   The invite creation date.
    #
    #   @return [Time]
    required :date_created, Time, api_name: :dateCreated

    # @!attribute workspace
    #
    #   @return [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Workspace]
    required :workspace, -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Workspace }
  end

  # @!method initialize(id:, creator:, date_created:, email:, role:, status:, workspace:)
  #   @param id [String] The invite id.
  #
  #   @param creator [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator]
  #
  #   @param date_created [Time] The invite creation date.
  #
  #   @param email [String] The invite email.
  #
  #   @param role [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role] The invite role.
  #
  #   @param status [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status] The invite status.
  #
  #   @param workspace [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Workspace]

  # @see Openlayer::Models::Workspaces::InviteCreateResponse::Item#creator
  class Creator < Openlayer::Internal::Type::BaseModel
    # @!attribute name
    #   The invite creator name.
    #
    #   @return [String, nil]
    optional :name, String, nil?: true

    # @!attribute username
    #   The invite creator username.
    #
    #   @return [String, nil]
    optional :username, String, nil?: true

    response_only do
      # @!attribute id
      #   The invite creator id.
      #
      #   @return [String, nil]
      optional :id, String
    end

    # @!method initialize(id: nil, name: nil, username: nil)
    #   @param id [String] The invite creator id.
    #
    #   @param name [String, nil] The invite creator name.
    #
    #   @param username [String, nil] The invite creator username.
  end

  # The invite role.
  #
  # @see Openlayer::Models::Workspaces::InviteCreateResponse::Item#role
  module Role
    extend Openlayer::Internal::Type::Enum

    ADMIN = :ADMIN
    MEMBER = :MEMBER
    VIEWER = :VIEWER

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # The invite status.
  #
  # @see Openlayer::Models::Workspaces::InviteCreateResponse::Item#status
  module Status
    extend Openlayer::Internal::Type::Enum

    ACCEPTED = :accepted
    PENDING = :pending

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see Openlayer::Models::Workspaces::InviteCreateResponse::Item#workspace
  class Workspace < Openlayer::Internal::Type::BaseModel
    # @!attribute name
    #
    #   @return [String]
    required :name, String

    # @!attribute slug
    #
    #   @return [String]
    required :slug, String

    response_only do
      # @!attribute id
      #
      #   @return [String]
      required :id, String

      # @!attribute date_created
      #
      #   @return [Time]
      required :date_created, Time, api_name: :dateCreated

      # @!attribute member_count
      #
      #   @return [Integer]
      required :member_count, Integer, api_name: :memberCount
    end

    # @!method initialize(id:, date_created:, member_count:, name:, slug:)
    #   @param id [String]
    #   @param date_created [Time]
    #   @param member_count [Integer]
    #   @param name [String]
    #   @param slug [String]
  end
end

Instance Attribute Details

#creator ⇒ Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator

Returns:



21
 
# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 21

required :creator, -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator }

#email ⇒ String

The invite email.

Returns:

  • (String) 


27
 
# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 27

required :email, String

#role ⇒ Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role

The invite role.

Returns:



33
 
# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 33

required :role, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role }

#status ⇒ Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status

The invite status.

Returns:



39
 
# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 39

required :status, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openlayer/models/workspaces/invite_create_response.rb', line 115