moonbase-sdk 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +58 -0
  3. data/README.md +10 -1
  4. data/lib/moonbase/client.rb +8 -0
  5. data/lib/moonbase/internal/transport/pooled_net_requester.rb +13 -11
  6. data/lib/moonbase/internal/type/union.rb +5 -5
  7. data/lib/moonbase/internal/util.rb +8 -3
  8. data/lib/moonbase/models/activity.rb +53 -1
  9. data/lib/moonbase/models/activity_list_params.rb +102 -1
  10. data/lib/moonbase/models/agent_setting_retrieve_params.rb +14 -0
  11. data/lib/moonbase/models/agent_setting_retrieve_response.rb +70 -0
  12. data/lib/moonbase/models/boolean_field.rb +9 -1
  13. data/lib/moonbase/models/choice_field.rb +9 -1
  14. data/lib/moonbase/models/collection.rb +10 -1
  15. data/lib/moonbase/models/date_field.rb +9 -1
  16. data/lib/moonbase/models/datetime_field.rb +9 -1
  17. data/lib/moonbase/models/domain_field.rb +9 -1
  18. data/lib/moonbase/models/email_field.rb +9 -1
  19. data/lib/moonbase/models/email_message.rb +10 -2
  20. data/lib/moonbase/models/error.rb +8 -1
  21. data/lib/moonbase/models/float_field.rb +9 -1
  22. data/lib/moonbase/models/geo_field.rb +9 -1
  23. data/lib/moonbase/models/inbox.rb +8 -1
  24. data/lib/moonbase/models/inbox_list_params.rb +3 -3
  25. data/lib/moonbase/models/inbox_message_create_params.rb +127 -0
  26. data/lib/moonbase/models/inbox_message_delete_params.rb +14 -0
  27. data/lib/moonbase/models/inbox_message_update_params.rb +119 -0
  28. data/lib/moonbase/models/inbox_retrieve_params.rb +3 -5
  29. data/lib/moonbase/models/integer_field.rb +9 -1
  30. data/lib/moonbase/models/item.rb +10 -1
  31. data/lib/moonbase/models/item_search_params.rb +53 -0
  32. data/lib/moonbase/models/item_search_response.rb +22 -0
  33. data/lib/moonbase/models/meeting.rb +18 -13
  34. data/lib/moonbase/models/meeting_retrieve_params.rb +3 -1
  35. data/lib/moonbase/models/meeting_update_params.rb +52 -12
  36. data/lib/moonbase/models/monetary_field.rb +9 -1
  37. data/lib/moonbase/models/multi_line_text_field.rb +9 -1
  38. data/lib/moonbase/models/note.rb +30 -2
  39. data/lib/moonbase/models/note_create_params.rb +34 -0
  40. data/lib/moonbase/models/note_update_params.rb +30 -0
  41. data/lib/moonbase/models/percentage_field.rb +9 -1
  42. data/lib/moonbase/models/relation_field.rb +17 -1
  43. data/lib/moonbase/models/single_line_text_field.rb +9 -1
  44. data/lib/moonbase/models/social_linked_in_field.rb +9 -1
  45. data/lib/moonbase/models/social_x_field.rb +9 -1
  46. data/lib/moonbase/models/stage_field.rb +9 -1
  47. data/lib/moonbase/models/subscription.rb +1 -0
  48. data/lib/moonbase/models/telephone_number_field.rb +9 -1
  49. data/lib/moonbase/models/url_field.rb +9 -1
  50. data/lib/moonbase/models/webhook_endpoint_create_params.rb +1 -0
  51. data/lib/moonbase/models/webhook_endpoint_update_params.rb +1 -0
  52. data/lib/moonbase/models.rb +14 -0
  53. data/lib/moonbase/resources/activities.rb +5 -3
  54. data/lib/moonbase/resources/agent_settings.rb +30 -0
  55. data/lib/moonbase/resources/collections/items.rb +2 -2
  56. data/lib/moonbase/resources/inbox_messages.rb +88 -0
  57. data/lib/moonbase/resources/inboxes.rb +4 -4
  58. data/lib/moonbase/resources/items.rb +38 -0
  59. data/lib/moonbase/resources/meetings.rb +8 -3
  60. data/lib/moonbase/resources/notes.rb +47 -0
  61. data/lib/moonbase/version.rb +1 -1
  62. data/lib/moonbase.rb +12 -0
  63. data/manifest.yaml +1 -0
  64. data/rbi/moonbase/client.rbi +6 -0
  65. data/rbi/moonbase/internal/util.rbi +1 -1
  66. data/rbi/moonbase/models/activity.rbi +79 -0
  67. data/rbi/moonbase/models/activity_list_params.rbi +296 -0
  68. data/rbi/moonbase/models/agent_setting_retrieve_params.rbi +30 -0
  69. data/rbi/moonbase/models/agent_setting_retrieve_response.rbi +113 -0
  70. data/rbi/moonbase/models/boolean_field.rbi +8 -0
  71. data/rbi/moonbase/models/choice_field.rbi +8 -0
  72. data/rbi/moonbase/models/collection.rbi +10 -0
  73. data/rbi/moonbase/models/date_field.rbi +8 -0
  74. data/rbi/moonbase/models/datetime_field.rbi +8 -0
  75. data/rbi/moonbase/models/domain_field.rbi +8 -0
  76. data/rbi/moonbase/models/email_field.rbi +8 -0
  77. data/rbi/moonbase/models/email_message.rbi +8 -0
  78. data/rbi/moonbase/models/error.rbi +9 -0
  79. data/rbi/moonbase/models/float_field.rbi +8 -0
  80. data/rbi/moonbase/models/geo_field.rbi +8 -0
  81. data/rbi/moonbase/models/inbox.rbi +9 -0
  82. data/rbi/moonbase/models/inbox_list_params.rbi +12 -4
  83. data/rbi/moonbase/models/inbox_message_create_params.rbi +229 -0
  84. data/rbi/moonbase/models/inbox_message_delete_params.rbi +27 -0
  85. data/rbi/moonbase/models/inbox_message_update_params.rbi +218 -0
  86. data/rbi/moonbase/models/inbox_retrieve_params.rbi +8 -6
  87. data/rbi/moonbase/models/integer_field.rbi +8 -0
  88. data/rbi/moonbase/models/item.rbi +13 -0
  89. data/rbi/moonbase/models/item_search_params.rbi +119 -0
  90. data/rbi/moonbase/models/item_search_response.rbi +33 -0
  91. data/rbi/moonbase/models/meeting.rbi +30 -20
  92. data/rbi/moonbase/models/meeting_retrieve_params.rbi +9 -2
  93. data/rbi/moonbase/models/meeting_update_params.rbi +55 -4
  94. data/rbi/moonbase/models/monetary_field.rbi +8 -0
  95. data/rbi/moonbase/models/multi_line_text_field.rbi +8 -0
  96. data/rbi/moonbase/models/note.rbi +29 -0
  97. data/rbi/moonbase/models/note_create_params.rbi +59 -0
  98. data/rbi/moonbase/models/note_update_params.rbi +54 -0
  99. data/rbi/moonbase/models/percentage_field.rbi +8 -0
  100. data/rbi/moonbase/models/relation_field.rbi +16 -0
  101. data/rbi/moonbase/models/single_line_text_field.rbi +8 -0
  102. data/rbi/moonbase/models/social_linked_in_field.rbi +8 -0
  103. data/rbi/moonbase/models/social_x_field.rbi +8 -0
  104. data/rbi/moonbase/models/stage_field.rbi +8 -0
  105. data/rbi/moonbase/models/subscription.rbi +5 -0
  106. data/rbi/moonbase/models/telephone_number_field.rbi +8 -0
  107. data/rbi/moonbase/models/url_field.rbi +8 -0
  108. data/rbi/moonbase/models/webhook_endpoint_create_params.rbi +5 -0
  109. data/rbi/moonbase/models/webhook_endpoint_update_params.rbi +5 -0
  110. data/rbi/moonbase/models.rbi +14 -0
  111. data/rbi/moonbase/resources/activities.rbi +3 -0
  112. data/rbi/moonbase/resources/agent_settings.rbi +20 -0
  113. data/rbi/moonbase/resources/collections/items.rbi +2 -2
  114. data/rbi/moonbase/resources/inbox_messages.rbi +78 -0
  115. data/rbi/moonbase/resources/inboxes.rbi +2 -2
  116. data/rbi/moonbase/resources/items.rbi +29 -0
  117. data/rbi/moonbase/resources/meetings.rbi +11 -2
  118. data/rbi/moonbase/resources/notes.rbi +38 -0
  119. data/sig/moonbase/client.rbs +4 -0
  120. data/sig/moonbase/models/activity.rbs +38 -0
  121. data/sig/moonbase/models/activity_list_params.rbs +147 -1
  122. data/sig/moonbase/models/agent_setting_retrieve_params.rbs +15 -0
  123. data/sig/moonbase/models/agent_setting_retrieve_response.rbs +79 -0
  124. data/sig/moonbase/models/boolean_field.rbs +5 -0
  125. data/sig/moonbase/models/choice_field.rbs +5 -0
  126. data/sig/moonbase/models/collection.rbs +5 -0
  127. data/sig/moonbase/models/date_field.rbs +5 -0
  128. data/sig/moonbase/models/datetime_field.rbs +5 -0
  129. data/sig/moonbase/models/domain_field.rbs +5 -0
  130. data/sig/moonbase/models/email_field.rbs +5 -0
  131. data/sig/moonbase/models/email_message.rbs +5 -0
  132. data/sig/moonbase/models/error.rbs +7 -0
  133. data/sig/moonbase/models/float_field.rbs +5 -0
  134. data/sig/moonbase/models/geo_field.rbs +5 -0
  135. data/sig/moonbase/models/inbox.rbs +7 -0
  136. data/sig/moonbase/models/inbox_list_params.rbs +6 -6
  137. data/sig/moonbase/models/inbox_message_create_params.rbs +114 -0
  138. data/sig/moonbase/models/inbox_message_delete_params.rbs +15 -0
  139. data/sig/moonbase/models/inbox_message_update_params.rbs +109 -0
  140. data/sig/moonbase/models/inbox_retrieve_params.rbs +6 -6
  141. data/sig/moonbase/models/integer_field.rbs +5 -0
  142. data/sig/moonbase/models/item.rbs +5 -0
  143. data/sig/moonbase/models/item_search_params.rbs +63 -0
  144. data/sig/moonbase/models/item_search_response.rbs +15 -0
  145. data/sig/moonbase/models/meeting.rbs +12 -12
  146. data/sig/moonbase/models/meeting_retrieve_params.rbs +3 -1
  147. data/sig/moonbase/models/monetary_field.rbs +5 -0
  148. data/sig/moonbase/models/multi_line_text_field.rbs +5 -0
  149. data/sig/moonbase/models/note.rbs +15 -0
  150. data/sig/moonbase/models/note_create_params.rbs +35 -0
  151. data/sig/moonbase/models/note_update_params.rbs +28 -0
  152. data/sig/moonbase/models/percentage_field.rbs +5 -0
  153. data/sig/moonbase/models/relation_field.rbs +10 -0
  154. data/sig/moonbase/models/single_line_text_field.rbs +5 -0
  155. data/sig/moonbase/models/social_linked_in_field.rbs +5 -0
  156. data/sig/moonbase/models/social_x_field.rbs +5 -0
  157. data/sig/moonbase/models/stage_field.rbs +5 -0
  158. data/sig/moonbase/models/subscription.rbs +2 -0
  159. data/sig/moonbase/models/telephone_number_field.rbs +5 -0
  160. data/sig/moonbase/models/url_field.rbs +5 -0
  161. data/sig/moonbase/models/webhook_endpoint_create_params.rbs +2 -0
  162. data/sig/moonbase/models/webhook_endpoint_update_params.rbs +2 -0
  163. data/sig/moonbase/models.rbs +14 -0
  164. data/sig/moonbase/resources/activities.rbs +1 -0
  165. data/sig/moonbase/resources/agent_settings.rbs +11 -0
  166. data/sig/moonbase/resources/inbox_messages.rbs +24 -0
  167. data/sig/moonbase/resources/inboxes.rbs +2 -2
  168. data/sig/moonbase/resources/items.rbs +13 -0
  169. data/sig/moonbase/resources/notes.rbs +13 -0
  170. metadata +49 -2
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::Items#search
6
+ class ItemSearchParams < Moonbase::Internal::Type::BaseModel
7
+ extend Moonbase::Internal::Type::RequestParameters::Converter
8
+ include Moonbase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute query
11
+ # The search text to match against items.
12
+ #
13
+ # @return [String]
14
+ required :query, String
15
+
16
+ # @!attribute filter
17
+ # Filter results by one or more collection IDs or `ref` values.
18
+ #
19
+ # @return [Moonbase::Models::ItemSearchParams::Filter, nil]
20
+ optional :filter, -> { Moonbase::ItemSearchParams::Filter }
21
+
22
+ # @!method initialize(query:, filter: nil, request_options: {})
23
+ # @param query [String] The search text to match against items.
24
+ #
25
+ # @param filter [Moonbase::Models::ItemSearchParams::Filter] Filter results by one or more collection IDs or `ref` values.
26
+ #
27
+ # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
28
+
29
+ class Filter < Moonbase::Internal::Type::BaseModel
30
+ # @!attribute collection_id
31
+ #
32
+ # @return [Moonbase::Models::ItemSearchParams::Filter::CollectionID, nil]
33
+ optional :collection_id, -> { Moonbase::ItemSearchParams::Filter::CollectionID }
34
+
35
+ # @!method initialize(collection_id: nil)
36
+ # Filter results by one or more collection IDs or `ref` values.
37
+ #
38
+ # @param collection_id [Moonbase::Models::ItemSearchParams::Filter::CollectionID]
39
+
40
+ # @see Moonbase::Models::ItemSearchParams::Filter#collection_id
41
+ class CollectionID < Moonbase::Internal::Type::BaseModel
42
+ # @!attribute in_
43
+ #
44
+ # @return [Array<String>, nil]
45
+ optional :in_, Moonbase::Internal::Type::ArrayOf[String], api_name: :in
46
+
47
+ # @!method initialize(in_: nil)
48
+ # @param in_ [Array<String>]
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::Items#search
6
+ class ItemSearchResponse < Moonbase::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Array<Moonbase::Models::Item>]
10
+ required :data, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Item] }
11
+
12
+ # @!attribute type
13
+ #
14
+ # @return [Symbol, :list]
15
+ required :type, const: :list
16
+
17
+ # @!method initialize(data:, type: :list)
18
+ # @param data [Array<Moonbase::Models::Item>]
19
+ # @param type [Symbol, :list]
20
+ end
21
+ end
22
+ end
@@ -86,6 +86,15 @@ module Moonbase
86
86
  # @return [String, nil]
87
87
  optional :location, String
88
88
 
89
+ # @!attribute note
90
+ # Any personal notes taken during the meeting. It also includes the AI-generated
91
+ # pre-meeting briefing.
92
+ #
93
+ # **Note:** Only present when requested using the `include` query parameter.
94
+ #
95
+ # @return [Moonbase::Models::Note, nil]
96
+ optional :note, -> { Moonbase::Note }
97
+
89
98
  # @!attribute organizer
90
99
  # The `Organizer` of the meeting.
91
100
  #
@@ -107,17 +116,13 @@ module Moonbase
107
116
  # @return [String, nil]
108
117
  optional :recording_url, String
109
118
 
110
- # @!attribute summary_ante
111
- # A summary or notes generated before the meeting.
119
+ # @!attribute summary
120
+ # A summary of the meeting.
112
121
  #
113
- # @return [String, nil]
114
- optional :summary_ante, String
115
-
116
- # @!attribute summary_post
117
- # A summary or notes generated after the meeting.
122
+ # **Note:** Only present when requested using the `include` query parameter.
118
123
  #
119
- # @return [String, nil]
120
- optional :summary_post, String
124
+ # @return [Moonbase::Models::Note, nil]
125
+ optional :summary, -> { Moonbase::Note }
121
126
 
122
127
  # @!attribute title
123
128
  # The title or subject of the meeting.
@@ -130,7 +135,7 @@ module Moonbase
130
135
  # @return [Moonbase::Models::Meeting::Transcript, nil]
131
136
  optional :transcript, -> { Moonbase::Meeting::Transcript }, nil?: true
132
137
 
133
- # @!method initialize(id:, created_at:, end_at:, i_cal_uid:, provider_id:, start_at:, time_zone:, updated_at:, attendees: nil, description: nil, duration: nil, location: nil, organizer: nil, provider_uri: nil, recording_url: nil, summary_ante: nil, summary_post: nil, title: nil, transcript: nil, type: :meeting)
138
+ # @!method initialize(id:, created_at:, end_at:, i_cal_uid:, provider_id:, start_at:, time_zone:, updated_at:, attendees: nil, description: nil, duration: nil, location: nil, note: nil, organizer: nil, provider_uri: nil, recording_url: nil, summary: nil, title: nil, transcript: nil, type: :meeting)
134
139
  # Some parameter documentations has been truncated, see
135
140
  # {Moonbase::Models::Meeting} for more details.
136
141
  #
@@ -161,15 +166,15 @@ module Moonbase
161
166
  #
162
167
  # @param location [String] The physical or virtual location of the meeting.
163
168
  #
169
+ # @param note [Moonbase::Models::Note] Any personal notes taken during the meeting. It also includes the AI-generated p
170
+ #
164
171
  # @param organizer [Moonbase::Models::Organizer] The `Organizer` of the meeting.
165
172
  #
166
173
  # @param provider_uri [String] A URL to access the meeting in the external provider's system.
167
174
  #
168
175
  # @param recording_url [String] A temporary, signed URL to download the meeting recording. The URL expires after
169
176
  #
170
- # @param summary_ante [String] A summary or notes generated before the meeting.
171
- #
172
- # @param summary_post [String] A summary or notes generated after the meeting.
177
+ # @param summary [Moonbase::Models::Note] A summary of the meeting.
173
178
  #
174
179
  # @param title [String] The title or subject of the meeting.
175
180
  #
@@ -9,7 +9,7 @@ module Moonbase
9
9
 
10
10
  # @!attribute include
11
11
  # Specifies which related objects to include in the response. Valid options are
12
- # `organizer` and `attendees`.
12
+ # `organizer`, `attendees`, `transcript`, `note`, and `summary`.
13
13
  #
14
14
  # @return [Array<Symbol, Moonbase::Models::MeetingRetrieveParams::Include>, nil]
15
15
  optional :include,
@@ -29,6 +29,8 @@ module Moonbase
29
29
  ORGANIZER = :organizer
30
30
  ATTENDEES = :attendees
31
31
  TRANSCRIPT = :transcript
32
+ NOTE = :note
33
+ SUMMARY = :summary
32
34
 
33
35
  # @!method self.values
34
36
  # @return [Array<Symbol>]
@@ -8,89 +8,129 @@ module Moonbase
8
8
  include Moonbase::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute recording
11
+ # A video recording of the meeting.
11
12
  #
12
13
  # @return [Moonbase::Models::MeetingUpdateParams::Recording, nil]
13
14
  optional :recording, -> { Moonbase::MeetingUpdateParams::Recording }
14
15
 
15
16
  # @!attribute transcript
17
+ # The meeting transcript.
16
18
  #
17
19
  # @return [Moonbase::Models::MeetingUpdateParams::Transcript, nil]
18
20
  optional :transcript, -> { Moonbase::MeetingUpdateParams::Transcript }
19
21
 
20
22
  # @!method initialize(recording: nil, transcript: nil, request_options: {})
21
- # @param recording [Moonbase::Models::MeetingUpdateParams::Recording]
22
- # @param transcript [Moonbase::Models::MeetingUpdateParams::Transcript]
23
+ # @param recording [Moonbase::Models::MeetingUpdateParams::Recording] A video recording of the meeting.
24
+ #
25
+ # @param transcript [Moonbase::Models::MeetingUpdateParams::Transcript] The meeting transcript.
26
+ #
23
27
  # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
24
28
 
25
29
  class Recording < Moonbase::Internal::Type::BaseModel
26
30
  # @!attribute content_type
31
+ # The content type of the recording. Note that only `video/mp4` is supported at
32
+ # this time.
27
33
  #
28
34
  # @return [String]
29
35
  required :content_type, String
30
36
 
31
37
  # @!attribute provider_id
38
+ # The unique identifier for the recording from the provider's system.
32
39
  #
33
40
  # @return [String]
34
41
  required :provider_id, String
35
42
 
36
43
  # @!attribute url
44
+ # The URL pointing to the recording.
37
45
  #
38
46
  # @return [String]
39
47
  required :url, String
40
48
 
41
49
  # @!method initialize(content_type:, provider_id:, url:)
42
- # @param content_type [String]
43
- # @param provider_id [String]
44
- # @param url [String]
50
+ # Some parameter documentations has been truncated, see
51
+ # {Moonbase::Models::MeetingUpdateParams::Recording} for more details.
52
+ #
53
+ # A video recording of the meeting.
54
+ #
55
+ # @param content_type [String] The content type of the recording. Note that only `video/mp4` is supported at th
56
+ #
57
+ # @param provider_id [String] The unique identifier for the recording from the provider's system.
58
+ #
59
+ # @param url [String] The URL pointing to the recording.
45
60
  end
46
61
 
47
62
  class Transcript < Moonbase::Internal::Type::BaseModel
48
63
  # @!attribute cues
64
+ # A list of cues that identify the text spoken in specific time slices of the
65
+ # meeting.
49
66
  #
50
67
  # @return [Array<Moonbase::Models::MeetingUpdateParams::Transcript::Cue>]
51
68
  required :cues, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::MeetingUpdateParams::Transcript::Cue] }
52
69
 
53
70
  # @!attribute provider
71
+ # Identifies the source of the transcript.
54
72
  #
55
73
  # @return [String]
56
74
  required :provider, String
57
75
 
58
76
  # @!attribute provider_id
77
+ # The unique identifier for the transcript from the provider's system.
59
78
  #
60
79
  # @return [String]
61
80
  required :provider_id, String
62
81
 
63
82
  # @!method initialize(cues:, provider:, provider_id:)
64
- # @param cues [Array<Moonbase::Models::MeetingUpdateParams::Transcript::Cue>]
65
- # @param provider [String]
66
- # @param provider_id [String]
83
+ # Some parameter documentations has been truncated, see
84
+ # {Moonbase::Models::MeetingUpdateParams::Transcript} for more details.
85
+ #
86
+ # The meeting transcript.
87
+ #
88
+ # @param cues [Array<Moonbase::Models::MeetingUpdateParams::Transcript::Cue>] A list of cues that identify the text spoken in specific time slices of the meet
89
+ #
90
+ # @param provider [String] Identifies the source of the transcript.
91
+ #
92
+ # @param provider_id [String] The unique identifier for the transcript from the provider's system.
67
93
 
68
94
  class Cue < Moonbase::Internal::Type::BaseModel
69
95
  # @!attribute from
96
+ # The start time of the slice, in fractional seconds from the start of the
97
+ # meeting.
70
98
  #
71
99
  # @return [Float]
72
100
  required :from, Float
73
101
 
74
102
  # @!attribute speaker
103
+ # The name of the person speaking.
75
104
  #
76
105
  # @return [String]
77
106
  required :speaker, String
78
107
 
79
108
  # @!attribute text
109
+ # The text spoken during the slice.
80
110
  #
81
111
  # @return [String]
82
112
  required :text, String
83
113
 
84
114
  # @!attribute to
115
+ # The end time of the slice, in fractional seconds from the start of the meeting.
85
116
  #
86
117
  # @return [Float]
87
118
  required :to, Float
88
119
 
89
120
  # @!method initialize(from:, speaker:, text:, to:)
90
- # @param from [Float]
91
- # @param speaker [String]
92
- # @param text [String]
93
- # @param to [Float]
121
+ # Some parameter documentations has been truncated, see
122
+ # {Moonbase::Models::MeetingUpdateParams::Transcript::Cue} for more details.
123
+ #
124
+ # Parameters for creating a `MeetingTranscriptCue` object to capture the text
125
+ # spoken in a specific time slice.
126
+ #
127
+ # @param from [Float] The start time of the slice, in fractional seconds from the start of the meeting
128
+ #
129
+ # @param speaker [String] The name of the person speaking.
130
+ #
131
+ # @param text [String] The text spoken during the slice.
132
+ #
133
+ # @param to [Float] The end time of the slice, in fractional seconds from the start of the meeting.
94
134
  end
95
135
  end
96
136
  end
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::MonetaryField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::MonetaryField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/monetary")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/monetary")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::MonetaryField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::MonetaryField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Deal Value").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::MultiLineTextField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::MultiLineTextField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/text/multi_line")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/text/multi_line")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::MultiLineTextField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::MultiLineTextField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Description").
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Moonbase
4
4
  module Models
5
- # @see Moonbase::Resources::Notes#retrieve
5
+ # @see Moonbase::Resources::Notes#create
6
6
  class Note < Moonbase::Internal::Type::BaseModel
7
7
  # @!attribute id
8
8
  # Unique identifier for the object.
@@ -10,6 +10,12 @@ module Moonbase
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute associations
14
+ # A list of items, meetings or calls this note is associated with.
15
+ #
16
+ # @return [Array<Moonbase::Models::Pointer>]
17
+ required :associations, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Pointer] }
18
+
13
19
  # @!attribute body
14
20
  # The main content of the note.
15
21
  #
@@ -22,6 +28,12 @@ module Moonbase
22
28
  # @return [Time]
23
29
  required :created_at, Time
24
30
 
31
+ # @!attribute lock_version
32
+ # The current lock version of the note for optimistic concurrency control.
33
+ #
34
+ # @return [Integer]
35
+ required :lock_version, Integer
36
+
25
37
  # @!attribute type
26
38
  # String representing the object’s type. Always `note` for this object.
27
39
  #
@@ -34,6 +46,13 @@ module Moonbase
34
46
  # @return [Time]
35
47
  required :updated_at, Time
36
48
 
49
+ # @!attribute creator
50
+ # A reference to an `Item` within a specific `Collection`, providing the context
51
+ # needed to locate the item.
52
+ #
53
+ # @return [Moonbase::Models::ItemPointer, nil]
54
+ optional :creator, -> { Moonbase::ItemPointer }, nil?: true
55
+
37
56
  # @!attribute summary
38
57
  # A short, system-generated summary of the note's content.
39
58
  #
@@ -46,18 +65,27 @@ module Moonbase
46
65
  # @return [String, nil]
47
66
  optional :title, String
48
67
 
49
- # @!method initialize(id:, body:, created_at:, updated_at:, summary: nil, title: nil, type: :note)
68
+ # @!method initialize(id:, associations:, body:, created_at:, lock_version:, updated_at:, creator: nil, summary: nil, title: nil, type: :note)
69
+ # Some parameter documentations has been truncated, see {Moonbase::Models::Note}
70
+ # for more details.
71
+ #
50
72
  # The Note object represents a block of text content, often used for meeting notes
51
73
  # or summaries.
52
74
  #
53
75
  # @param id [String] Unique identifier for the object.
54
76
  #
77
+ # @param associations [Array<Moonbase::Models::Pointer>] A list of items, meetings or calls this note is associated with.
78
+ #
55
79
  # @param body [Moonbase::Models::FormattedText] The main content of the note.
56
80
  #
57
81
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
58
82
  #
83
+ # @param lock_version [Integer] The current lock version of the note for optimistic concurrency control.
84
+ #
59
85
  # @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
60
86
  #
87
+ # @param creator [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
88
+ #
61
89
  # @param summary [String] A short, system-generated summary of the note's content.
62
90
  #
63
91
  # @param title [String] An optional title for the note.
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::Notes#create
6
+ class NoteCreateParams < Moonbase::Internal::Type::BaseModel
7
+ extend Moonbase::Internal::Type::RequestParameters::Converter
8
+ include Moonbase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute body
11
+ # The main content of the note.
12
+ #
13
+ # @return [Moonbase::Models::FormattedText]
14
+ required :body, -> { Moonbase::FormattedText }
15
+
16
+ # @!attribute associations
17
+ # Link the Note to Moonbase items (person, organization, deal, task, or an item in
18
+ # a custom collection), meetings, or calls.
19
+ #
20
+ # @return [Array<Moonbase::Models::Pointer>, nil]
21
+ optional :associations, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Pointer] }
22
+
23
+ # @!method initialize(body:, associations: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Moonbase::Models::NoteCreateParams} for more details.
26
+ #
27
+ # @param body [Moonbase::Models::FormattedText] The main content of the note.
28
+ #
29
+ # @param associations [Array<Moonbase::Models::Pointer>] Link the Note to Moonbase items (person, organization, deal, task, or an item in
30
+ #
31
+ # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::Notes#update
6
+ class NoteUpdateParams < Moonbase::Internal::Type::BaseModel
7
+ extend Moonbase::Internal::Type::RequestParameters::Converter
8
+ include Moonbase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute body
11
+ # The main content of the note.
12
+ #
13
+ # @return [Moonbase::Models::FormattedText]
14
+ required :body, -> { Moonbase::FormattedText }
15
+
16
+ # @!attribute lock_version
17
+ # The current lock version of the note for optimistic concurrency control.
18
+ #
19
+ # @return [Integer]
20
+ required :lock_version, Integer
21
+
22
+ # @!method initialize(body:, lock_version:, request_options: {})
23
+ # @param body [Moonbase::Models::FormattedText] The main content of the note.
24
+ #
25
+ # @param lock_version [Integer] The current lock version of the note for optimistic concurrency control.
26
+ #
27
+ # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::PercentageField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::PercentageField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/percentage")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/percentage")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::PercentageField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::PercentageField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Win Probability").
@@ -9,6 +9,12 @@ module Moonbase
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute allowed_collections
13
+ # The set of collections that are valid targets for this relation.
14
+ #
15
+ # @return [Array<Moonbase::Models::CollectionPointer>]
16
+ required :allowed_collections, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::CollectionPointer] }
17
+
12
18
  # @!attribute cardinality
13
19
  # Specifies whether the field can hold a single value (`one`) or multiple values
14
20
  # (`many`).
@@ -16,6 +22,12 @@ module Moonbase
16
22
  # @return [Symbol, Moonbase::Models::RelationField::Cardinality]
17
23
  required :cardinality, enum: -> { Moonbase::RelationField::Cardinality }
18
24
 
25
+ # @!attribute core
26
+ # If `true`, this is a built-in field included by default.
27
+ #
28
+ # @return [Boolean]
29
+ required :core, Moonbase::Internal::Type::Boolean
30
+
19
31
  # @!attribute created_at
20
32
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
33
  #
@@ -80,7 +92,7 @@ module Moonbase
80
92
  # @return [String, nil]
81
93
  optional :description, String
82
94
 
83
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, relation_type:, required:, unique:, updated_at:, description: nil, type: :"field/relation")
95
+ # @!method initialize(id:, allowed_collections:, cardinality:, core:, created_at:, name:, readonly:, ref:, relation_type:, required:, unique:, updated_at:, description: nil, type: :"field/relation")
84
96
  # Some parameter documentations has been truncated, see
85
97
  # {Moonbase::Models::RelationField} for more details.
86
98
  #
@@ -89,8 +101,12 @@ module Moonbase
89
101
  #
90
102
  # @param id [String] Unique identifier for the object.
91
103
  #
104
+ # @param allowed_collections [Array<Moonbase::Models::CollectionPointer>] The set of collections that are valid targets for this relation.
105
+ #
92
106
  # @param cardinality [Symbol, Moonbase::Models::RelationField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
93
107
  #
108
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
109
+ #
94
110
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
95
111
  #
96
112
  # @param name [String] The human-readable name of the field (e.g., "Account").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::SingleLineTextField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::SingleLineTextField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/text/single_line")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/text/single_line")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::SingleLineTextField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::SingleLineTextField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Company Name").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::SocialLinkedInField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::SocialLinkedInField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/uri/social_linked_in")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/uri/social_linked_in")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::SocialLinkedInField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::SocialLinkedInField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "LinkedIn Profile").