moonbase-sdk 0.1.0.pre.alpha.1
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.
- checksums.yaml +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +58 -0
- data/README.md +293 -0
- data/SECURITY.md +27 -0
- data/lib/moonbase/client.rb +135 -0
- data/lib/moonbase/errors.rb +214 -0
- data/lib/moonbase/file_part.rb +55 -0
- data/lib/moonbase/internal/cursor_page.rb +111 -0
- data/lib/moonbase/internal/transport/base_client.rb +563 -0
- data/lib/moonbase/internal/transport/pooled_net_requester.rb +209 -0
- data/lib/moonbase/internal/type/array_of.rb +167 -0
- data/lib/moonbase/internal/type/base_model.rb +536 -0
- data/lib/moonbase/internal/type/base_page.rb +55 -0
- data/lib/moonbase/internal/type/boolean.rb +77 -0
- data/lib/moonbase/internal/type/converter.rb +300 -0
- data/lib/moonbase/internal/type/enum.rb +131 -0
- data/lib/moonbase/internal/type/file_input.rb +108 -0
- data/lib/moonbase/internal/type/hash_of.rb +187 -0
- data/lib/moonbase/internal/type/request_parameters.rb +42 -0
- data/lib/moonbase/internal/type/union.rb +260 -0
- data/lib/moonbase/internal/type/unknown.rb +81 -0
- data/lib/moonbase/internal/util.rb +914 -0
- data/lib/moonbase/internal.rb +20 -0
- data/lib/moonbase/models/activity.rb +1166 -0
- data/lib/moonbase/models/activity_list_params.rb +46 -0
- data/lib/moonbase/models/activity_retrieve_params.rb +14 -0
- data/lib/moonbase/models/address.rb +111 -0
- data/lib/moonbase/models/attendee.rb +82 -0
- data/lib/moonbase/models/boolean_value.rb +23 -0
- data/lib/moonbase/models/call.rb +220 -0
- data/lib/moonbase/models/call_create_params.rb +157 -0
- data/lib/moonbase/models/choice.rb +46 -0
- data/lib/moonbase/models/collection.rb +111 -0
- data/lib/moonbase/models/collection_list_params.rb +46 -0
- data/lib/moonbase/models/collection_retrieve_params.rb +37 -0
- data/lib/moonbase/models/collections/field_retrieve_params.rb +22 -0
- data/lib/moonbase/models/date_value.rb +23 -0
- data/lib/moonbase/models/datetime_value.rb +23 -0
- data/lib/moonbase/models/domain_value.rb +23 -0
- data/lib/moonbase/models/email_message.rb +273 -0
- data/lib/moonbase/models/email_value.rb +23 -0
- data/lib/moonbase/models/error.rb +90 -0
- data/lib/moonbase/models/field.rb +305 -0
- data/lib/moonbase/models/field_value.rb +75 -0
- data/lib/moonbase/models/file_list_params.rb +46 -0
- data/lib/moonbase/models/file_retrieve_params.rb +14 -0
- data/lib/moonbase/models/float_value.rb +23 -0
- data/lib/moonbase/models/form.rb +111 -0
- data/lib/moonbase/models/form_list_params.rb +64 -0
- data/lib/moonbase/models/form_retrieve_params.rb +35 -0
- data/lib/moonbase/models/funnel_step.rb +46 -0
- data/lib/moonbase/models/geo_value.rb +23 -0
- data/lib/moonbase/models/inbox.rb +90 -0
- data/lib/moonbase/models/inbox_conversation.rb +225 -0
- data/lib/moonbase/models/inbox_conversation_list_params.rb +74 -0
- data/lib/moonbase/models/inbox_conversation_retrieve_params.rb +39 -0
- data/lib/moonbase/models/inbox_list_params.rb +46 -0
- data/lib/moonbase/models/inbox_message_list_params.rb +83 -0
- data/lib/moonbase/models/inbox_message_retrieve_params.rb +38 -0
- data/lib/moonbase/models/inbox_retrieve_params.rb +37 -0
- data/lib/moonbase/models/integer_value.rb +23 -0
- data/lib/moonbase/models/item.rb +67 -0
- data/lib/moonbase/models/item_create_params.rb +30 -0
- data/lib/moonbase/models/item_delete_params.rb +14 -0
- data/lib/moonbase/models/item_retrieve_params.rb +14 -0
- data/lib/moonbase/models/item_update_params.rb +61 -0
- data/lib/moonbase/models/item_upsert_params.rb +78 -0
- data/lib/moonbase/models/meeting.rb +217 -0
- data/lib/moonbase/models/meeting_list_params.rb +46 -0
- data/lib/moonbase/models/meeting_retrieve_params.rb +37 -0
- data/lib/moonbase/models/monetary_value.rb +46 -0
- data/lib/moonbase/models/moonbase_file.rb +98 -0
- data/lib/moonbase/models/multi_line_text_value.rb +23 -0
- data/lib/moonbase/models/note.rb +87 -0
- data/lib/moonbase/models/note_list_params.rb +46 -0
- data/lib/moonbase/models/note_retrieve_params.rb +14 -0
- data/lib/moonbase/models/organizer.rb +77 -0
- data/lib/moonbase/models/percentage_value.rb +23 -0
- data/lib/moonbase/models/program.rb +241 -0
- data/lib/moonbase/models/program_list_params.rb +46 -0
- data/lib/moonbase/models/program_message_create_params.rb +50 -0
- data/lib/moonbase/models/program_message_create_response.rb +74 -0
- data/lib/moonbase/models/program_retrieve_params.rb +37 -0
- data/lib/moonbase/models/program_template.rb +99 -0
- data/lib/moonbase/models/program_template_list_params.rb +65 -0
- data/lib/moonbase/models/program_template_retrieve_params.rb +38 -0
- data/lib/moonbase/models/relation_value.rb +29 -0
- data/lib/moonbase/models/single_line_text_value.rb +23 -0
- data/lib/moonbase/models/social_linked_in_value.rb +40 -0
- data/lib/moonbase/models/social_x_value.rb +40 -0
- data/lib/moonbase/models/tagset.rb +117 -0
- data/lib/moonbase/models/tagset_list_params.rb +46 -0
- data/lib/moonbase/models/tagset_retrieve_params.rb +14 -0
- data/lib/moonbase/models/telephone_number.rb +23 -0
- data/lib/moonbase/models/url_value.rb +23 -0
- data/lib/moonbase/models/value.rb +72 -0
- data/lib/moonbase/models/view.rb +100 -0
- data/lib/moonbase/models/view_retrieve_params.rb +35 -0
- data/lib/moonbase/models/views/item_list_params.rb +48 -0
- data/lib/moonbase/models.rb +191 -0
- data/lib/moonbase/request_options.rb +77 -0
- data/lib/moonbase/resources/activities.rb +64 -0
- data/lib/moonbase/resources/calls.rb +46 -0
- data/lib/moonbase/resources/collections/fields.rb +43 -0
- data/lib/moonbase/resources/collections.rb +75 -0
- data/lib/moonbase/resources/files.rb +64 -0
- data/lib/moonbase/resources/forms.rb +73 -0
- data/lib/moonbase/resources/inbox_conversations.rb +75 -0
- data/lib/moonbase/resources/inbox_messages.rb +77 -0
- data/lib/moonbase/resources/inboxes.rb +71 -0
- data/lib/moonbase/resources/items.rb +142 -0
- data/lib/moonbase/resources/meetings.rb +71 -0
- data/lib/moonbase/resources/notes.rb +64 -0
- data/lib/moonbase/resources/program_messages.rb +40 -0
- data/lib/moonbase/resources/program_templates.rb +73 -0
- data/lib/moonbase/resources/programs.rb +71 -0
- data/lib/moonbase/resources/tagsets.rb +64 -0
- data/lib/moonbase/resources/views/items.rb +48 -0
- data/lib/moonbase/resources/views.rb +45 -0
- data/lib/moonbase/version.rb +5 -0
- data/lib/moonbase.rb +148 -0
- data/manifest.yaml +15 -0
- data/rbi/moonbase/client.rbi +95 -0
- data/rbi/moonbase/errors.rbi +178 -0
- data/rbi/moonbase/file_part.rbi +37 -0
- data/rbi/moonbase/internal/cursor_page.rbi +59 -0
- data/rbi/moonbase/internal/transport/base_client.rbi +293 -0
- data/rbi/moonbase/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/moonbase/internal/type/array_of.rbi +104 -0
- data/rbi/moonbase/internal/type/base_model.rbi +302 -0
- data/rbi/moonbase/internal/type/base_page.rbi +42 -0
- data/rbi/moonbase/internal/type/boolean.rbi +58 -0
- data/rbi/moonbase/internal/type/converter.rbi +162 -0
- data/rbi/moonbase/internal/type/enum.rbi +82 -0
- data/rbi/moonbase/internal/type/file_input.rbi +59 -0
- data/rbi/moonbase/internal/type/hash_of.rbi +104 -0
- data/rbi/moonbase/internal/type/request_parameters.rbi +29 -0
- data/rbi/moonbase/internal/type/union.rbi +121 -0
- data/rbi/moonbase/internal/type/unknown.rbi +58 -0
- data/rbi/moonbase/internal/util.rbi +487 -0
- data/rbi/moonbase/internal.rbi +16 -0
- data/rbi/moonbase/models/activity.rbi +1976 -0
- data/rbi/moonbase/models/activity_list_params.rbi +78 -0
- data/rbi/moonbase/models/activity_retrieve_params.rbi +27 -0
- data/rbi/moonbase/models/address.rbi +158 -0
- data/rbi/moonbase/models/attendee.rbi +118 -0
- data/rbi/moonbase/models/boolean_value.rbi +29 -0
- data/rbi/moonbase/models/call.rbi +293 -0
- data/rbi/moonbase/models/call_create_params.rbi +263 -0
- data/rbi/moonbase/models/choice.rbi +65 -0
- data/rbi/moonbase/models/collection.rbi +155 -0
- data/rbi/moonbase/models/collection_list_params.rbi +78 -0
- data/rbi/moonbase/models/collection_retrieve_params.rbi +90 -0
- data/rbi/moonbase/models/collections/field_retrieve_params.rbi +40 -0
- data/rbi/moonbase/models/date_value.rbi +25 -0
- data/rbi/moonbase/models/datetime_value.rbi +27 -0
- data/rbi/moonbase/models/domain_value.rbi +27 -0
- data/rbi/moonbase/models/email_message.rbi +394 -0
- data/rbi/moonbase/models/email_value.rbi +27 -0
- data/rbi/moonbase/models/error.rbi +139 -0
- data/rbi/moonbase/models/field.rbi +471 -0
- data/rbi/moonbase/models/field_value.rbi +46 -0
- data/rbi/moonbase/models/file_list_params.rbi +78 -0
- data/rbi/moonbase/models/file_retrieve_params.rbi +27 -0
- data/rbi/moonbase/models/float_value.rbi +27 -0
- data/rbi/moonbase/models/form.rbi +161 -0
- data/rbi/moonbase/models/form_list_params.rbi +121 -0
- data/rbi/moonbase/models/form_retrieve_params.rbi +78 -0
- data/rbi/moonbase/models/funnel_step.rbi +67 -0
- data/rbi/moonbase/models/geo_value.rbi +25 -0
- data/rbi/moonbase/models/inbox.rbi +127 -0
- data/rbi/moonbase/models/inbox_conversation.rbi +323 -0
- data/rbi/moonbase/models/inbox_conversation_list_params.rbi +151 -0
- data/rbi/moonbase/models/inbox_conversation_retrieve_params.rbi +103 -0
- data/rbi/moonbase/models/inbox_list_params.rbi +78 -0
- data/rbi/moonbase/models/inbox_message_list_params.rbi +159 -0
- data/rbi/moonbase/models/inbox_message_retrieve_params.rbi +100 -0
- data/rbi/moonbase/models/inbox_retrieve_params.rbi +73 -0
- data/rbi/moonbase/models/integer_value.rbi +27 -0
- data/rbi/moonbase/models/item.rbi +107 -0
- data/rbi/moonbase/models/item_create_params.rbi +135 -0
- data/rbi/moonbase/models/item_delete_params.rbi +27 -0
- data/rbi/moonbase/models/item_retrieve_params.rbi +27 -0
- data/rbi/moonbase/models/item_update_params.rbi +236 -0
- data/rbi/moonbase/models/item_upsert_params.rbi +338 -0
- data/rbi/moonbase/models/meeting.rbi +299 -0
- data/rbi/moonbase/models/meeting_list_params.rbi +78 -0
- data/rbi/moonbase/models/meeting_retrieve_params.rbi +88 -0
- data/rbi/moonbase/models/monetary_value.rbi +73 -0
- data/rbi/moonbase/models/moonbase_file.rbi +133 -0
- data/rbi/moonbase/models/multi_line_text_value.rbi +27 -0
- data/rbi/moonbase/models/note.rbi +131 -0
- data/rbi/moonbase/models/note_list_params.rbi +78 -0
- data/rbi/moonbase/models/note_retrieve_params.rbi +27 -0
- data/rbi/moonbase/models/organizer.rbi +113 -0
- data/rbi/moonbase/models/percentage_value.rbi +27 -0
- data/rbi/moonbase/models/program.rbi +355 -0
- data/rbi/moonbase/models/program_list_params.rbi +78 -0
- data/rbi/moonbase/models/program_message_create_params.rbi +94 -0
- data/rbi/moonbase/models/program_message_create_response.rbi +116 -0
- data/rbi/moonbase/models/program_retrieve_params.rbi +88 -0
- data/rbi/moonbase/models/program_template.rbi +138 -0
- data/rbi/moonbase/models/program_template_list_params.rbi +131 -0
- data/rbi/moonbase/models/program_template_retrieve_params.rbi +94 -0
- data/rbi/moonbase/models/relation_value.rbi +39 -0
- data/rbi/moonbase/models/single_line_text_value.rbi +27 -0
- data/rbi/moonbase/models/social_linked_in_value.rbi +71 -0
- data/rbi/moonbase/models/social_x_value.rbi +66 -0
- data/rbi/moonbase/models/tagset.rbi +168 -0
- data/rbi/moonbase/models/tagset_list_params.rbi +78 -0
- data/rbi/moonbase/models/tagset_retrieve_params.rbi +27 -0
- data/rbi/moonbase/models/telephone_number.rbi +29 -0
- data/rbi/moonbase/models/url_value.rbi +25 -0
- data/rbi/moonbase/models/value.rbi +39 -0
- data/rbi/moonbase/models/view.rbi +141 -0
- data/rbi/moonbase/models/view_retrieve_params.rbi +78 -0
- data/rbi/moonbase/models/views/item_list_params.rbi +80 -0
- data/rbi/moonbase/models.rbi +155 -0
- data/rbi/moonbase/request_options.rbi +59 -0
- data/rbi/moonbase/resources/activities.rbi +51 -0
- data/rbi/moonbase/resources/calls.rbi +51 -0
- data/rbi/moonbase/resources/collections/fields.rbi +31 -0
- data/rbi/moonbase/resources/collections.rbi +59 -0
- data/rbi/moonbase/resources/files.rbi +51 -0
- data/rbi/moonbase/resources/forms.rbi +59 -0
- data/rbi/moonbase/resources/inbox_conversations.rbi +66 -0
- data/rbi/moonbase/resources/inbox_messages.rbi +67 -0
- data/rbi/moonbase/resources/inboxes.rbi +55 -0
- data/rbi/moonbase/resources/items.rbi +234 -0
- data/rbi/moonbase/resources/meetings.rbi +55 -0
- data/rbi/moonbase/resources/notes.rbi +51 -0
- data/rbi/moonbase/resources/program_messages.rbi +32 -0
- data/rbi/moonbase/resources/program_templates.rbi +63 -0
- data/rbi/moonbase/resources/programs.rbi +55 -0
- data/rbi/moonbase/resources/tagsets.rbi +51 -0
- data/rbi/moonbase/resources/views/items.rbi +42 -0
- data/rbi/moonbase/resources/views.rbi +33 -0
- data/rbi/moonbase/version.rbi +5 -0
- data/sig/moonbase/client.rbs +56 -0
- data/sig/moonbase/errors.rbs +110 -0
- data/sig/moonbase/file_part.rbs +21 -0
- data/sig/moonbase/internal/cursor_page.rbs +36 -0
- data/sig/moonbase/internal/transport/base_client.rbs +131 -0
- data/sig/moonbase/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/moonbase/internal/type/array_of.rbs +48 -0
- data/sig/moonbase/internal/type/base_model.rbs +102 -0
- data/sig/moonbase/internal/type/base_page.rbs +24 -0
- data/sig/moonbase/internal/type/boolean.rbs +26 -0
- data/sig/moonbase/internal/type/converter.rbs +62 -0
- data/sig/moonbase/internal/type/enum.rbs +32 -0
- data/sig/moonbase/internal/type/file_input.rbs +25 -0
- data/sig/moonbase/internal/type/hash_of.rbs +48 -0
- data/sig/moonbase/internal/type/request_parameters.rbs +17 -0
- data/sig/moonbase/internal/type/union.rbs +52 -0
- data/sig/moonbase/internal/type/unknown.rbs +26 -0
- data/sig/moonbase/internal/util.rbs +185 -0
- data/sig/moonbase/internal.rbs +9 -0
- data/sig/moonbase/models/activity.rbs +977 -0
- data/sig/moonbase/models/activity_list_params.rbs +38 -0
- data/sig/moonbase/models/activity_retrieve_params.rbs +15 -0
- data/sig/moonbase/models/address.rbs +90 -0
- data/sig/moonbase/models/attendee.rbs +61 -0
- data/sig/moonbase/models/boolean_value.rbs +15 -0
- data/sig/moonbase/models/call.rbs +194 -0
- data/sig/moonbase/models/call_create_params.rbs +152 -0
- data/sig/moonbase/models/choice.rbs +41 -0
- data/sig/moonbase/models/collection.rbs +85 -0
- data/sig/moonbase/models/collection_list_params.rbs +38 -0
- data/sig/moonbase/models/collection_retrieve_params.rbs +39 -0
- data/sig/moonbase/models/collections/field_retrieve_params.rbs +25 -0
- data/sig/moonbase/models/date_value.rbs +15 -0
- data/sig/moonbase/models/datetime_value.rbs +15 -0
- data/sig/moonbase/models/domain_value.rbs +15 -0
- data/sig/moonbase/models/email_message.rbs +221 -0
- data/sig/moonbase/models/email_value.rbs +15 -0
- data/sig/moonbase/models/error.rbs +78 -0
- data/sig/moonbase/models/field.rbs +266 -0
- data/sig/moonbase/models/field_value.rbs +33 -0
- data/sig/moonbase/models/file_list_params.rbs +38 -0
- data/sig/moonbase/models/file_retrieve_params.rbs +15 -0
- data/sig/moonbase/models/float_value.rbs +18 -0
- data/sig/moonbase/models/form.rbs +89 -0
- data/sig/moonbase/models/form_list_params.rbs +61 -0
- data/sig/moonbase/models/form_retrieve_params.rbs +38 -0
- data/sig/moonbase/models/funnel_step.rbs +38 -0
- data/sig/moonbase/models/geo_value.rbs +15 -0
- data/sig/moonbase/models/inbox.rbs +70 -0
- data/sig/moonbase/models/inbox_conversation.rbs +169 -0
- data/sig/moonbase/models/inbox_conversation_list_params.rbs +69 -0
- data/sig/moonbase/models/inbox_conversation_retrieve_params.rbs +41 -0
- data/sig/moonbase/models/inbox_list_params.rbs +38 -0
- data/sig/moonbase/models/inbox_message_list_params.rbs +77 -0
- data/sig/moonbase/models/inbox_message_retrieve_params.rbs +42 -0
- data/sig/moonbase/models/inbox_retrieve_params.rbs +38 -0
- data/sig/moonbase/models/integer_value.rbs +22 -0
- data/sig/moonbase/models/item.rbs +57 -0
- data/sig/moonbase/models/item_create_params.rbs +31 -0
- data/sig/moonbase/models/item_delete_params.rbs +15 -0
- data/sig/moonbase/models/item_retrieve_params.rbs +15 -0
- data/sig/moonbase/models/item_update_params.rbs +67 -0
- data/sig/moonbase/models/item_upsert_params.rbs +77 -0
- data/sig/moonbase/models/meeting.rbs +179 -0
- data/sig/moonbase/models/meeting_list_params.rbs +38 -0
- data/sig/moonbase/models/meeting_retrieve_params.rbs +39 -0
- data/sig/moonbase/models/monetary_value.rbs +48 -0
- data/sig/moonbase/models/moonbase_file.rbs +71 -0
- data/sig/moonbase/models/multi_line_text_value.rbs +16 -0
- data/sig/moonbase/models/note.rbs +75 -0
- data/sig/moonbase/models/note_list_params.rbs +38 -0
- data/sig/moonbase/models/note_retrieve_params.rbs +15 -0
- data/sig/moonbase/models/organizer.rbs +61 -0
- data/sig/moonbase/models/percentage_value.rbs +19 -0
- data/sig/moonbase/models/program.rbs +204 -0
- data/sig/moonbase/models/program_list_params.rbs +38 -0
- data/sig/moonbase/models/program_message_create_params.rbs +48 -0
- data/sig/moonbase/models/program_message_create_response.rbs +55 -0
- data/sig/moonbase/models/program_retrieve_params.rbs +39 -0
- data/sig/moonbase/models/program_template.rbs +75 -0
- data/sig/moonbase/models/program_template_list_params.rbs +61 -0
- data/sig/moonbase/models/program_template_retrieve_params.rbs +40 -0
- data/sig/moonbase/models/relation_value.rbs +15 -0
- data/sig/moonbase/models/single_line_text_value.rbs +16 -0
- data/sig/moonbase/models/social_linked_in_value.rbs +41 -0
- data/sig/moonbase/models/social_x_value.rbs +38 -0
- data/sig/moonbase/models/tagset.rbs +89 -0
- data/sig/moonbase/models/tagset_list_params.rbs +38 -0
- data/sig/moonbase/models/tagset_retrieve_params.rbs +15 -0
- data/sig/moonbase/models/telephone_number.rbs +22 -0
- data/sig/moonbase/models/url_value.rbs +15 -0
- data/sig/moonbase/models/value.rbs +30 -0
- data/sig/moonbase/models/view.rbs +80 -0
- data/sig/moonbase/models/view_retrieve_params.rbs +38 -0
- data/sig/moonbase/models/views/item_list_params.rbs +40 -0
- data/sig/moonbase/models.rbs +151 -0
- data/sig/moonbase/request_options.rbs +34 -0
- data/sig/moonbase/resources/activities.rbs +19 -0
- data/sig/moonbase/resources/calls.rbs +20 -0
- data/sig/moonbase/resources/collections/fields.rbs +15 -0
- data/sig/moonbase/resources/collections.rbs +22 -0
- data/sig/moonbase/resources/files.rbs +19 -0
- data/sig/moonbase/resources/forms.rbs +21 -0
- data/sig/moonbase/resources/inbox_conversations.rbs +22 -0
- data/sig/moonbase/resources/inbox_messages.rbs +23 -0
- data/sig/moonbase/resources/inboxes.rbs +20 -0
- data/sig/moonbase/resources/items.rbs +40 -0
- data/sig/moonbase/resources/meetings.rbs +20 -0
- data/sig/moonbase/resources/notes.rbs +19 -0
- data/sig/moonbase/resources/program_messages.rbs +14 -0
- data/sig/moonbase/resources/program_templates.rbs +21 -0
- data/sig/moonbase/resources/programs.rbs +20 -0
- data/sig/moonbase/resources/tagsets.rbs +19 -0
- data/sig/moonbase/resources/views/items.rbs +17 -0
- data/sig/moonbase/resources/views.rbs +15 -0
- data/sig/moonbase/version.rbs +3 -0
- metadata +413 -0
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Inboxes#retrieve
|
6
|
+
class InboxRetrieveParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute include
|
11
|
+
# Specifies which related objects to include in the response. Valid option is
|
12
|
+
# `tagset`.
|
13
|
+
#
|
14
|
+
# @return [Symbol, Moonbase::Models::InboxRetrieveParams::Include, nil]
|
15
|
+
optional :include, enum: -> { Moonbase::InboxRetrieveParams::Include }
|
16
|
+
|
17
|
+
# @!method initialize(include: nil, request_options: {})
|
18
|
+
# Some parameter documentations has been truncated, see
|
19
|
+
# {Moonbase::Models::InboxRetrieveParams} for more details.
|
20
|
+
#
|
21
|
+
# @param include [Symbol, Moonbase::Models::InboxRetrieveParams::Include] Specifies which related objects to include in the response. Valid option is `tag
|
22
|
+
#
|
23
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
24
|
+
|
25
|
+
# Specifies which related objects to include in the response. Valid option is
|
26
|
+
# `tagset`.
|
27
|
+
module Include
|
28
|
+
extend Moonbase::Internal::Type::Enum
|
29
|
+
|
30
|
+
TAGSET = :tagset
|
31
|
+
|
32
|
+
# @!method self.values
|
33
|
+
# @return [Array<Symbol>]
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
class IntegerValue < Moonbase::Internal::Type::BaseModel
|
6
|
+
# @!attribute number
|
7
|
+
#
|
8
|
+
# @return [Integer]
|
9
|
+
required :number, Integer
|
10
|
+
|
11
|
+
# @!attribute type
|
12
|
+
#
|
13
|
+
# @return [Symbol, :"value/number/unitless_integer"]
|
14
|
+
required :type, const: :"value/number/unitless_integer"
|
15
|
+
|
16
|
+
# @!method initialize(number:, type: :"value/number/unitless_integer")
|
17
|
+
# Integer value without units
|
18
|
+
#
|
19
|
+
# @param number [Integer]
|
20
|
+
# @param type [Symbol, :"value/number/unitless_integer"]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,67 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#create
|
6
|
+
class Item < Moonbase::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# Unique identifier for the object.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute type
|
14
|
+
# String representing the object’s type. Always `item` for this object.
|
15
|
+
#
|
16
|
+
# @return [Symbol, :item]
|
17
|
+
required :type, const: :item
|
18
|
+
|
19
|
+
# @!attribute links
|
20
|
+
#
|
21
|
+
# @return [Moonbase::Models::Item::Links, nil]
|
22
|
+
optional :links, -> { Moonbase::Item::Links }
|
23
|
+
|
24
|
+
# @!attribute values
|
25
|
+
# A hash where keys are the `ref` of a `Field` and values are the data stored for
|
26
|
+
# that field.
|
27
|
+
#
|
28
|
+
# @return [Hash{Symbol=>Moonbase::Models::FieldValue, nil}, nil]
|
29
|
+
optional :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue, nil?: true] }
|
30
|
+
|
31
|
+
# @!method initialize(id:, links: nil, values: nil, type: :item)
|
32
|
+
# Some parameter documentations has been truncated, see {Moonbase::Models::Item}
|
33
|
+
# for more details.
|
34
|
+
#
|
35
|
+
# An Item represents a single record or row within a Collection. It holds a set of
|
36
|
+
# `values` corresponding to the Collection's `fields`.
|
37
|
+
#
|
38
|
+
# @param id [String] Unique identifier for the object.
|
39
|
+
#
|
40
|
+
# @param links [Moonbase::Models::Item::Links]
|
41
|
+
#
|
42
|
+
# @param values [Hash{Symbol=>Moonbase::Models::FieldValue, nil}] A hash where keys are the `ref` of a `Field` and values are the data stored for
|
43
|
+
#
|
44
|
+
# @param type [Symbol, :item] String representing the object’s type. Always `item` for this object.
|
45
|
+
|
46
|
+
# @see Moonbase::Models::Item#links
|
47
|
+
class Links < Moonbase::Internal::Type::BaseModel
|
48
|
+
# @!attribute collection
|
49
|
+
# A link to the `Collection` the item belongs to.
|
50
|
+
#
|
51
|
+
# @return [String, nil]
|
52
|
+
optional :collection, String
|
53
|
+
|
54
|
+
# @!attribute self_
|
55
|
+
# The canonical URL for this object.
|
56
|
+
#
|
57
|
+
# @return [String, nil]
|
58
|
+
optional :self_, String, api_name: :self
|
59
|
+
|
60
|
+
# @!method initialize(collection: nil, self_: nil)
|
61
|
+
# @param collection [String] A link to the `Collection` the item belongs to.
|
62
|
+
#
|
63
|
+
# @param self_ [String] The canonical URL for this object.
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#create
|
6
|
+
class ItemCreateParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute collection_id
|
11
|
+
# The ID of the `Collection` to create the item in.
|
12
|
+
#
|
13
|
+
# @return [String]
|
14
|
+
required :collection_id, String
|
15
|
+
|
16
|
+
# @!attribute values
|
17
|
+
# A hash where keys are the `ref` of a `Field` and values are the data to be set.
|
18
|
+
#
|
19
|
+
# @return [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}]
|
20
|
+
required :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue, nil?: true] }
|
21
|
+
|
22
|
+
# @!method initialize(collection_id:, values:, request_options: {})
|
23
|
+
# @param collection_id [String] The ID of the `Collection` to create the item in.
|
24
|
+
#
|
25
|
+
# @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] A hash where keys are the `ref` of a `Field` and values are the data to be set.
|
26
|
+
#
|
27
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#delete
|
6
|
+
class ItemDeleteParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#retrieve
|
6
|
+
class ItemRetrieveParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,61 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#update
|
6
|
+
class ItemUpdateParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute values
|
11
|
+
# A hash where keys are the `ref` of a `Field` and values are the new data to be
|
12
|
+
# set.
|
13
|
+
#
|
14
|
+
# @return [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}]
|
15
|
+
required :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue, nil?: true] }
|
16
|
+
|
17
|
+
# @!attribute update_many_strategy
|
18
|
+
#
|
19
|
+
# @return [Symbol, Moonbase::Models::ItemUpdateParams::UpdateManyStrategy, nil]
|
20
|
+
optional :update_many_strategy, enum: -> { Moonbase::ItemUpdateParams::UpdateManyStrategy }
|
21
|
+
|
22
|
+
# @!attribute update_one_strategy
|
23
|
+
#
|
24
|
+
# @return [Symbol, Moonbase::Models::ItemUpdateParams::UpdateOneStrategy, nil]
|
25
|
+
optional :update_one_strategy, enum: -> { Moonbase::ItemUpdateParams::UpdateOneStrategy }
|
26
|
+
|
27
|
+
# @!method initialize(values:, update_many_strategy: nil, update_one_strategy: nil, request_options: {})
|
28
|
+
# Some parameter documentations has been truncated, see
|
29
|
+
# {Moonbase::Models::ItemUpdateParams} for more details.
|
30
|
+
#
|
31
|
+
# @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] A hash where keys are the `ref` of a `Field` and values are the new data to be s
|
32
|
+
#
|
33
|
+
# @param update_many_strategy [Symbol, Moonbase::Models::ItemUpdateParams::UpdateManyStrategy]
|
34
|
+
#
|
35
|
+
# @param update_one_strategy [Symbol, Moonbase::Models::ItemUpdateParams::UpdateOneStrategy]
|
36
|
+
#
|
37
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
38
|
+
|
39
|
+
module UpdateManyStrategy
|
40
|
+
extend Moonbase::Internal::Type::Enum
|
41
|
+
|
42
|
+
REPLACE = :replace
|
43
|
+
PRESERVE = :preserve
|
44
|
+
MERGE = :merge
|
45
|
+
|
46
|
+
# @!method self.values
|
47
|
+
# @return [Array<Symbol>]
|
48
|
+
end
|
49
|
+
|
50
|
+
module UpdateOneStrategy
|
51
|
+
extend Moonbase::Internal::Type::Enum
|
52
|
+
|
53
|
+
REPLACE = :replace
|
54
|
+
PRESERVE = :preserve
|
55
|
+
|
56
|
+
# @!method self.values
|
57
|
+
# @return [Array<Symbol>]
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
@@ -0,0 +1,78 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Items#upsert
|
6
|
+
class ItemUpsertParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute collection_id
|
11
|
+
# The ID of the `Collection` to create the item in.
|
12
|
+
#
|
13
|
+
# @return [String]
|
14
|
+
required :collection_id, String
|
15
|
+
|
16
|
+
# @!attribute identifiers
|
17
|
+
# A hash where keys are the `ref` of a `Field` and values are used to identify the
|
18
|
+
# item to update. When multiple identifiers are provided, the update will find
|
19
|
+
# items that match any of the identifiers.
|
20
|
+
#
|
21
|
+
# @return [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}]
|
22
|
+
required :identifiers, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue, nil?: true] }
|
23
|
+
|
24
|
+
# @!attribute values
|
25
|
+
# A hash where keys are the `ref` of a `Field` and values are the data to be set.
|
26
|
+
#
|
27
|
+
# @return [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}]
|
28
|
+
required :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue, nil?: true] }
|
29
|
+
|
30
|
+
# @!attribute update_many_strategy
|
31
|
+
#
|
32
|
+
# @return [Symbol, Moonbase::Models::ItemUpsertParams::UpdateManyStrategy, nil]
|
33
|
+
optional :update_many_strategy, enum: -> { Moonbase::ItemUpsertParams::UpdateManyStrategy }
|
34
|
+
|
35
|
+
# @!attribute update_one_strategy
|
36
|
+
#
|
37
|
+
# @return [Symbol, Moonbase::Models::ItemUpsertParams::UpdateOneStrategy, nil]
|
38
|
+
optional :update_one_strategy, enum: -> { Moonbase::ItemUpsertParams::UpdateOneStrategy }
|
39
|
+
|
40
|
+
# @!method initialize(collection_id:, identifiers:, values:, update_many_strategy: nil, update_one_strategy: nil, request_options: {})
|
41
|
+
# Some parameter documentations has been truncated, see
|
42
|
+
# {Moonbase::Models::ItemUpsertParams} for more details.
|
43
|
+
#
|
44
|
+
# @param collection_id [String] The ID of the `Collection` to create the item in.
|
45
|
+
#
|
46
|
+
# @param identifiers [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] A hash where keys are the `ref` of a `Field` and values are used to identify the
|
47
|
+
#
|
48
|
+
# @param values [Hash{Symbol=>Moonbase::Models::SingleLineTextValue, Moonbase::Models::MultiLineTextValue, Moonbase::Models::IntegerValue, Moonbase::Models::FloatValue, Moonbase::Models::MonetaryValue, Moonbase::Models::PercentageValue, Moonbase::Models::BooleanValue, Moonbase::Models::EmailValue, Moonbase::Models::URLValue, Moonbase::Models::DomainValue, Moonbase::Models::SocialXValue, Moonbase::Models::SocialLinkedInValue, Moonbase::Models::TelephoneNumber, Moonbase::Models::GeoValue, Moonbase::Models::DateValue, Moonbase::Models::DatetimeValue, Moonbase::Models::Choice, Moonbase::Models::FunnelStep, Moonbase::Models::RelationValue, Array<Moonbase::Models::Value>, nil}] A hash where keys are the `ref` of a `Field` and values are the data to be set.
|
49
|
+
#
|
50
|
+
# @param update_many_strategy [Symbol, Moonbase::Models::ItemUpsertParams::UpdateManyStrategy]
|
51
|
+
#
|
52
|
+
# @param update_one_strategy [Symbol, Moonbase::Models::ItemUpsertParams::UpdateOneStrategy]
|
53
|
+
#
|
54
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
55
|
+
|
56
|
+
module UpdateManyStrategy
|
57
|
+
extend Moonbase::Internal::Type::Enum
|
58
|
+
|
59
|
+
REPLACE = :replace
|
60
|
+
PRESERVE = :preserve
|
61
|
+
MERGE = :merge
|
62
|
+
|
63
|
+
# @!method self.values
|
64
|
+
# @return [Array<Symbol>]
|
65
|
+
end
|
66
|
+
|
67
|
+
module UpdateOneStrategy
|
68
|
+
extend Moonbase::Internal::Type::Enum
|
69
|
+
|
70
|
+
REPLACE = :replace
|
71
|
+
PRESERVE = :preserve
|
72
|
+
|
73
|
+
# @!method self.values
|
74
|
+
# @return [Array<Symbol>]
|
75
|
+
end
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
@@ -0,0 +1,217 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Meetings#retrieve
|
6
|
+
class Meeting < Moonbase::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# Unique identifier for the object.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute end_at
|
14
|
+
# The end time of the meeting, as an RFC 3339 timestamp.
|
15
|
+
#
|
16
|
+
# @return [Time]
|
17
|
+
required :end_at, Time
|
18
|
+
|
19
|
+
# @!attribute i_cal_uid
|
20
|
+
# The globally unique iCalendar UID for the meeting event.
|
21
|
+
#
|
22
|
+
# @return [String]
|
23
|
+
required :i_cal_uid, String
|
24
|
+
|
25
|
+
# @!attribute links
|
26
|
+
#
|
27
|
+
# @return [Moonbase::Models::Meeting::Links]
|
28
|
+
required :links, -> { Moonbase::Meeting::Links }
|
29
|
+
|
30
|
+
# @!attribute provider_id
|
31
|
+
# The unique identifier for the meeting from the external calendar provider (e.g.,
|
32
|
+
# Google Calendar).
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
required :provider_id, String
|
36
|
+
|
37
|
+
# @!attribute start_at
|
38
|
+
# The start time of the meeting, as an RFC 3339 timestamp.
|
39
|
+
#
|
40
|
+
# @return [Time]
|
41
|
+
required :start_at, Time
|
42
|
+
|
43
|
+
# @!attribute time_zone
|
44
|
+
# The IANA time zone in which the meeting is scheduled (e.g.,
|
45
|
+
# `America/Los_Angeles`).
|
46
|
+
#
|
47
|
+
# @return [String]
|
48
|
+
required :time_zone, String
|
49
|
+
|
50
|
+
# @!attribute type
|
51
|
+
# String representing the object’s type. Always `meeting` for this object.
|
52
|
+
#
|
53
|
+
# @return [Symbol, :meeting]
|
54
|
+
required :type, const: :meeting
|
55
|
+
|
56
|
+
# @!attribute attendees
|
57
|
+
# A list of `Attendee` objects for the meeting.
|
58
|
+
#
|
59
|
+
# @return [Array<Moonbase::Models::Attendee>, nil]
|
60
|
+
optional :attendees, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Attendee] }
|
61
|
+
|
62
|
+
# @!attribute created_at
|
63
|
+
# Time at which the object was created, as an RFC 3339 timestamp.
|
64
|
+
#
|
65
|
+
# @return [Time, nil]
|
66
|
+
optional :created_at, Time
|
67
|
+
|
68
|
+
# @!attribute description
|
69
|
+
# A detailed description or agenda for the meeting.
|
70
|
+
#
|
71
|
+
# @return [String, nil]
|
72
|
+
optional :description, String
|
73
|
+
|
74
|
+
# @!attribute duration
|
75
|
+
# The duration of the meeting in seconds.
|
76
|
+
#
|
77
|
+
# @return [Float, nil]
|
78
|
+
optional :duration, Float
|
79
|
+
|
80
|
+
# @!attribute location
|
81
|
+
# The physical or virtual location of the meeting.
|
82
|
+
#
|
83
|
+
# @return [String, nil]
|
84
|
+
optional :location, String
|
85
|
+
|
86
|
+
# @!attribute organizer
|
87
|
+
# The `Organizer` of the meeting.
|
88
|
+
#
|
89
|
+
# @return [Moonbase::Models::Organizer, nil]
|
90
|
+
optional :organizer, -> { Moonbase::Organizer }
|
91
|
+
|
92
|
+
# @!attribute provider_uri
|
93
|
+
# A URL to access the meeting in the external provider's system.
|
94
|
+
#
|
95
|
+
# @return [String, nil]
|
96
|
+
optional :provider_uri, String
|
97
|
+
|
98
|
+
# @!attribute summary_ante
|
99
|
+
# A summary or notes generated before the meeting.
|
100
|
+
#
|
101
|
+
# @return [String, nil]
|
102
|
+
optional :summary_ante, String
|
103
|
+
|
104
|
+
# @!attribute summary_post
|
105
|
+
# A summary or notes generated after the meeting.
|
106
|
+
#
|
107
|
+
# @return [String, nil]
|
108
|
+
optional :summary_post, String
|
109
|
+
|
110
|
+
# @!attribute title
|
111
|
+
# The title or subject of the meeting.
|
112
|
+
#
|
113
|
+
# @return [String, nil]
|
114
|
+
optional :title, String
|
115
|
+
|
116
|
+
# @!attribute updated_at
|
117
|
+
# Time at which the object was last updated, as an RFC 3339 timestamp.
|
118
|
+
#
|
119
|
+
# @return [Time, nil]
|
120
|
+
optional :updated_at, Time
|
121
|
+
|
122
|
+
# @!method initialize(id:, end_at:, i_cal_uid:, links:, provider_id:, start_at:, time_zone:, attendees: nil, created_at: nil, description: nil, duration: nil, location: nil, organizer: nil, provider_uri: nil, summary_ante: nil, summary_post: nil, title: nil, updated_at: nil, type: :meeting)
|
123
|
+
# Some parameter documentations has been truncated, see
|
124
|
+
# {Moonbase::Models::Meeting} for more details.
|
125
|
+
#
|
126
|
+
# The Meeting object represents a calendar event. It includes details about the
|
127
|
+
# participants, timing, and associated content like summaries and recordings.
|
128
|
+
#
|
129
|
+
# @param id [String] Unique identifier for the object.
|
130
|
+
#
|
131
|
+
# @param end_at [Time] The end time of the meeting, as an RFC 3339 timestamp.
|
132
|
+
#
|
133
|
+
# @param i_cal_uid [String] The globally unique iCalendar UID for the meeting event.
|
134
|
+
#
|
135
|
+
# @param links [Moonbase::Models::Meeting::Links]
|
136
|
+
#
|
137
|
+
# @param provider_id [String] The unique identifier for the meeting from the external calendar provider (e.g.,
|
138
|
+
#
|
139
|
+
# @param start_at [Time] The start time of the meeting, as an RFC 3339 timestamp.
|
140
|
+
#
|
141
|
+
# @param time_zone [String] The IANA time zone in which the meeting is scheduled (e.g., `America/Los_Angeles
|
142
|
+
#
|
143
|
+
# @param attendees [Array<Moonbase::Models::Attendee>] A list of `Attendee` objects for the meeting.
|
144
|
+
#
|
145
|
+
# @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
|
146
|
+
#
|
147
|
+
# @param description [String] A detailed description or agenda for the meeting.
|
148
|
+
#
|
149
|
+
# @param duration [Float] The duration of the meeting in seconds.
|
150
|
+
#
|
151
|
+
# @param location [String] The physical or virtual location of the meeting.
|
152
|
+
#
|
153
|
+
# @param organizer [Moonbase::Models::Organizer] The `Organizer` of the meeting.
|
154
|
+
#
|
155
|
+
# @param provider_uri [String] A URL to access the meeting in the external provider's system.
|
156
|
+
#
|
157
|
+
# @param summary_ante [String] A summary or notes generated before the meeting.
|
158
|
+
#
|
159
|
+
# @param summary_post [String] A summary or notes generated after the meeting.
|
160
|
+
#
|
161
|
+
# @param title [String] The title or subject of the meeting.
|
162
|
+
#
|
163
|
+
# @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
|
164
|
+
#
|
165
|
+
# @param type [Symbol, :meeting] String representing the object’s type. Always `meeting` for this object.
|
166
|
+
|
167
|
+
# @see Moonbase::Models::Meeting#links
|
168
|
+
class Links < Moonbase::Internal::Type::BaseModel
|
169
|
+
# @!attribute self_
|
170
|
+
# The canonical URL for this object.
|
171
|
+
#
|
172
|
+
# @return [String]
|
173
|
+
required :self_, String, api_name: :self
|
174
|
+
|
175
|
+
# @!attribute note
|
176
|
+
# A link to an associated `Note` object.
|
177
|
+
#
|
178
|
+
# @return [String, nil]
|
179
|
+
optional :note, String
|
180
|
+
|
181
|
+
# @!attribute recording_url
|
182
|
+
# A temporary, signed URL to download the meeting recording. The URL expires after
|
183
|
+
# one hour.
|
184
|
+
#
|
185
|
+
# @return [String, nil]
|
186
|
+
optional :recording_url, String
|
187
|
+
|
188
|
+
# @!attribute summary
|
189
|
+
# A link to a long-form summary of the meeting.
|
190
|
+
#
|
191
|
+
# @return [String, nil]
|
192
|
+
optional :summary, String
|
193
|
+
|
194
|
+
# @!attribute transcript_url
|
195
|
+
# A temporary, signed URL to download the meeting transcript. The URL expires
|
196
|
+
# after one hour.
|
197
|
+
#
|
198
|
+
# @return [String, nil]
|
199
|
+
optional :transcript_url, String
|
200
|
+
|
201
|
+
# @!method initialize(self_:, note: nil, recording_url: nil, summary: nil, transcript_url: nil)
|
202
|
+
# Some parameter documentations has been truncated, see
|
203
|
+
# {Moonbase::Models::Meeting::Links} for more details.
|
204
|
+
#
|
205
|
+
# @param self_ [String] The canonical URL for this object.
|
206
|
+
#
|
207
|
+
# @param note [String] A link to an associated `Note` object.
|
208
|
+
#
|
209
|
+
# @param recording_url [String] A temporary, signed URL to download the meeting recording. The URL expires after
|
210
|
+
#
|
211
|
+
# @param summary [String] A link to a long-form summary of the meeting.
|
212
|
+
#
|
213
|
+
# @param transcript_url [String] A temporary, signed URL to download the meeting transcript. The URL expires afte
|
214
|
+
end
|
215
|
+
end
|
216
|
+
end
|
217
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Meetings#list
|
6
|
+
class MeetingListParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute after
|
11
|
+
# When specified, returns results starting immediately after the item identified
|
12
|
+
# by this cursor. Use the cursor value from the previous response's metadata to
|
13
|
+
# fetch the next page of results.
|
14
|
+
#
|
15
|
+
# @return [String, nil]
|
16
|
+
optional :after, String
|
17
|
+
|
18
|
+
# @!attribute before
|
19
|
+
# When specified, returns results starting immediately before the item identified
|
20
|
+
# by this cursor. Use the cursor value from the response's metadata to fetch the
|
21
|
+
# previous page of results.
|
22
|
+
#
|
23
|
+
# @return [String, nil]
|
24
|
+
optional :before, String
|
25
|
+
|
26
|
+
# @!attribute limit
|
27
|
+
# Maximum number of items to return per page. Must be between 1 and 100. Defaults
|
28
|
+
# to 20 if not specified.
|
29
|
+
#
|
30
|
+
# @return [Integer, nil]
|
31
|
+
optional :limit, Integer
|
32
|
+
|
33
|
+
# @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
|
34
|
+
# Some parameter documentations has been truncated, see
|
35
|
+
# {Moonbase::Models::MeetingListParams} for more details.
|
36
|
+
#
|
37
|
+
# @param after [String] When specified, returns results starting immediately after the item identified b
|
38
|
+
#
|
39
|
+
# @param before [String] When specified, returns results starting immediately before the item identified
|
40
|
+
#
|
41
|
+
# @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
|
42
|
+
#
|
43
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Meetings#retrieve
|
6
|
+
class MeetingRetrieveParams < Moonbase::Internal::Type::BaseModel
|
7
|
+
extend Moonbase::Internal::Type::RequestParameters::Converter
|
8
|
+
include Moonbase::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute include
|
11
|
+
# Specifies which related objects to include in the response. Valid options are
|
12
|
+
# `organizer` and `attendees`.
|
13
|
+
#
|
14
|
+
# @return [Array<Symbol, Moonbase::Models::MeetingRetrieveParams::Include>, nil]
|
15
|
+
optional :include,
|
16
|
+
-> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::MeetingRetrieveParams::Include] }
|
17
|
+
|
18
|
+
# @!method initialize(include: nil, request_options: {})
|
19
|
+
# Some parameter documentations has been truncated, see
|
20
|
+
# {Moonbase::Models::MeetingRetrieveParams} for more details.
|
21
|
+
#
|
22
|
+
# @param include [Array<Symbol, Moonbase::Models::MeetingRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `o
|
23
|
+
#
|
24
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
25
|
+
|
26
|
+
module Include
|
27
|
+
extend Moonbase::Internal::Type::Enum
|
28
|
+
|
29
|
+
ORGANIZER = :organizer
|
30
|
+
ATTENDEES = :attendees
|
31
|
+
|
32
|
+
# @!method self.values
|
33
|
+
# @return [Array<Symbol>]
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|