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,305 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
class Field < Moonbase::Internal::Type::BaseModel
|
6
|
+
# @!attribute id
|
7
|
+
# Unique identifier for the object.
|
8
|
+
#
|
9
|
+
# @return [String]
|
10
|
+
required :id, String
|
11
|
+
|
12
|
+
# @!attribute cardinality
|
13
|
+
# Specifies whether the field can hold a single value (`one`) or multiple values
|
14
|
+
# (`many`).
|
15
|
+
#
|
16
|
+
# @return [Symbol, Moonbase::Models::Field::Cardinality]
|
17
|
+
required :cardinality, enum: -> { Moonbase::Field::Cardinality }
|
18
|
+
|
19
|
+
# @!attribute links
|
20
|
+
#
|
21
|
+
# @return [Moonbase::Models::Field::Links]
|
22
|
+
required :links, -> { Moonbase::Field::Links }
|
23
|
+
|
24
|
+
# @!attribute name
|
25
|
+
# The human-readable name of the field (e.g., “Due Date”).
|
26
|
+
#
|
27
|
+
# @return [String]
|
28
|
+
required :name, String
|
29
|
+
|
30
|
+
# @!attribute ref
|
31
|
+
# A unique, stable, machine-readable identifier for the field within its
|
32
|
+
# collection (e.g., `due_date`).
|
33
|
+
#
|
34
|
+
# @return [String]
|
35
|
+
required :ref, String
|
36
|
+
|
37
|
+
# @!attribute type
|
38
|
+
# The data type of the field. This determines how values are stored, validated,
|
39
|
+
# and rendered.
|
40
|
+
#
|
41
|
+
# @return [Symbol, Moonbase::Models::Field::Type]
|
42
|
+
required :type, enum: -> { Moonbase::Field::Type }
|
43
|
+
|
44
|
+
# @!attribute created_at
|
45
|
+
# Time at which the object was created, as an RFC 3339 timestamp.
|
46
|
+
#
|
47
|
+
# @return [Time, nil]
|
48
|
+
optional :created_at, Time
|
49
|
+
|
50
|
+
# @!attribute description
|
51
|
+
# An optional, longer-form description of the field's purpose.
|
52
|
+
#
|
53
|
+
# @return [String, nil]
|
54
|
+
optional :description, String
|
55
|
+
|
56
|
+
# @!attribute field_options
|
57
|
+
# If the field `type` is `field/choice`, this is the list of available
|
58
|
+
# `FieldOption` objects.
|
59
|
+
#
|
60
|
+
# @return [Array<Moonbase::Models::Field::FieldOption>, nil]
|
61
|
+
optional :field_options, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Field::FieldOption] }
|
62
|
+
|
63
|
+
# @!attribute funnel
|
64
|
+
# If the field `type` is `field/stage`, this is the associated `Funnel` object.
|
65
|
+
#
|
66
|
+
# @return [Moonbase::Models::Field::Funnel, nil]
|
67
|
+
optional :funnel, -> { Moonbase::Field::Funnel }
|
68
|
+
|
69
|
+
# @!attribute readonly
|
70
|
+
# If `true`, the value of this field is system-managed and cannot be updated via
|
71
|
+
# the API.
|
72
|
+
#
|
73
|
+
# @return [Boolean, nil]
|
74
|
+
optional :readonly, Moonbase::Internal::Type::Boolean
|
75
|
+
|
76
|
+
# @!attribute required
|
77
|
+
# If `true`, this field must have a value.
|
78
|
+
#
|
79
|
+
# @return [Boolean, nil]
|
80
|
+
optional :required, Moonbase::Internal::Type::Boolean
|
81
|
+
|
82
|
+
# @!attribute unique
|
83
|
+
# If `true`, values for this field must be unique across all items in the
|
84
|
+
# collection.
|
85
|
+
#
|
86
|
+
# @return [Boolean, nil]
|
87
|
+
optional :unique, Moonbase::Internal::Type::Boolean
|
88
|
+
|
89
|
+
# @!attribute updated_at
|
90
|
+
# Time at which the object was last updated, as an RFC 3339 timestamp.
|
91
|
+
#
|
92
|
+
# @return [Time, nil]
|
93
|
+
optional :updated_at, Time
|
94
|
+
|
95
|
+
# @!method initialize(id:, cardinality:, links:, name:, ref:, type:, created_at: nil, description: nil, field_options: nil, funnel: nil, readonly: nil, required: nil, unique: nil, updated_at: nil)
|
96
|
+
# Some parameter documentations has been truncated, see {Moonbase::Models::Field}
|
97
|
+
# for more details.
|
98
|
+
#
|
99
|
+
# A Field defines a single column in a Collection's schema. It specifies the data
|
100
|
+
# type, validation rules, and other properties for the values stored in that
|
101
|
+
# column.
|
102
|
+
#
|
103
|
+
# @param id [String] Unique identifier for the object.
|
104
|
+
#
|
105
|
+
# @param cardinality [Symbol, Moonbase::Models::Field::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
|
106
|
+
#
|
107
|
+
# @param links [Moonbase::Models::Field::Links]
|
108
|
+
#
|
109
|
+
# @param name [String] The human-readable name of the field (e.g., “Due Date”).
|
110
|
+
#
|
111
|
+
# @param ref [String] A unique, stable, machine-readable identifier for the field within its collectio
|
112
|
+
#
|
113
|
+
# @param type [Symbol, Moonbase::Models::Field::Type] The data type of the field. This determines how values are stored, validated, an
|
114
|
+
#
|
115
|
+
# @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
|
116
|
+
#
|
117
|
+
# @param description [String] An optional, longer-form description of the field's purpose.
|
118
|
+
#
|
119
|
+
# @param field_options [Array<Moonbase::Models::Field::FieldOption>] If the field `type` is `field/choice`, this is the list of available `FieldOptio
|
120
|
+
#
|
121
|
+
# @param funnel [Moonbase::Models::Field::Funnel] If the field `type` is `field/stage`, this is the associated `Funnel` object.
|
122
|
+
#
|
123
|
+
# @param readonly [Boolean] If `true`, the value of this field is system-managed and cannot be updated via t
|
124
|
+
#
|
125
|
+
# @param required [Boolean] If `true`, this field must have a value.
|
126
|
+
#
|
127
|
+
# @param unique [Boolean] If `true`, values for this field must be unique across all items in the collecti
|
128
|
+
#
|
129
|
+
# @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
|
130
|
+
|
131
|
+
# Specifies whether the field can hold a single value (`one`) or multiple values
|
132
|
+
# (`many`).
|
133
|
+
#
|
134
|
+
# @see Moonbase::Models::Field#cardinality
|
135
|
+
module Cardinality
|
136
|
+
extend Moonbase::Internal::Type::Enum
|
137
|
+
|
138
|
+
ONE = :one
|
139
|
+
MANY = :many
|
140
|
+
|
141
|
+
# @!method self.values
|
142
|
+
# @return [Array<Symbol>]
|
143
|
+
end
|
144
|
+
|
145
|
+
# @see Moonbase::Models::Field#links
|
146
|
+
class Links < Moonbase::Internal::Type::BaseModel
|
147
|
+
# @!attribute collection
|
148
|
+
# The `Collection` this field belongs to.
|
149
|
+
#
|
150
|
+
# @return [String]
|
151
|
+
required :collection, String
|
152
|
+
|
153
|
+
# @!attribute self_
|
154
|
+
# The canonical URL for this object.
|
155
|
+
#
|
156
|
+
# @return [String]
|
157
|
+
required :self_, String, api_name: :self
|
158
|
+
|
159
|
+
# @!method initialize(collection:, self_:)
|
160
|
+
# @param collection [String] The `Collection` this field belongs to.
|
161
|
+
#
|
162
|
+
# @param self_ [String] The canonical URL for this object.
|
163
|
+
end
|
164
|
+
|
165
|
+
# The data type of the field. This determines how values are stored, validated,
|
166
|
+
# and rendered.
|
167
|
+
#
|
168
|
+
# @see Moonbase::Models::Field#type
|
169
|
+
module Type
|
170
|
+
extend Moonbase::Internal::Type::Enum
|
171
|
+
|
172
|
+
FIELD_TEXT_SINGLE_LINE = :"field/text/single_line"
|
173
|
+
FIELD_TEXT_MULTI_LINE = :"field/text/multi_line"
|
174
|
+
FIELD_NUMBER_UNITLESS_INTEGER = :"field/number/unitless_integer"
|
175
|
+
FIELD_NUMBER_UNITLESS_FLOAT = :"field/number/unitless_float"
|
176
|
+
FIELD_NUMBER_MONETARY = :"field/number/monetary"
|
177
|
+
FIELD_NUMBER_PERCENTAGE = :"field/number/percentage"
|
178
|
+
FIELD_BOOLEAN = :"field/boolean"
|
179
|
+
FIELD_EMAIL = :"field/email"
|
180
|
+
FIELD_URI_URL = :"field/uri/url"
|
181
|
+
FIELD_URI_DOMAIN = :"field/uri/domain"
|
182
|
+
FIELD_URI_SOCIAL_X = :"field/uri/social_x"
|
183
|
+
FIELD_URI_SOCIAL_LINKED_IN = :"field/uri/social_linked_in"
|
184
|
+
FIELD_TELEPHONE_NUMBER = :"field/telephone_number"
|
185
|
+
FIELD_GEO = :"field/geo"
|
186
|
+
FIELD_DATE = :"field/date"
|
187
|
+
FIELD_DATETIME = :"field/datetime"
|
188
|
+
FIELD_CHOICE = :"field/choice"
|
189
|
+
FIELD_STAGE = :"field/stage"
|
190
|
+
FIELD_RELATION_ONE_WAY = :"field/relation/one_way"
|
191
|
+
FIELD_RELATION_TWO_WAY = :"field/relation/two_way"
|
192
|
+
|
193
|
+
# @!method self.values
|
194
|
+
# @return [Array<Symbol>]
|
195
|
+
end
|
196
|
+
|
197
|
+
class FieldOption < Moonbase::Internal::Type::BaseModel
|
198
|
+
# @!attribute id
|
199
|
+
# Unique identifier for the object.
|
200
|
+
#
|
201
|
+
# @return [String]
|
202
|
+
required :id, String
|
203
|
+
|
204
|
+
# @!attribute label
|
205
|
+
# The human-readable text for the option.
|
206
|
+
#
|
207
|
+
# @return [String]
|
208
|
+
required :label, String
|
209
|
+
|
210
|
+
# @!attribute type
|
211
|
+
# String representing the object’s type. Always `field_option` for this object.
|
212
|
+
#
|
213
|
+
# @return [Symbol, :field_option]
|
214
|
+
required :type, const: :field_option
|
215
|
+
|
216
|
+
# @!method initialize(id:, label:, type: :field_option)
|
217
|
+
# Represents a selectable option within a `choice` field.
|
218
|
+
#
|
219
|
+
# @param id [String] Unique identifier for the object.
|
220
|
+
#
|
221
|
+
# @param label [String] The human-readable text for the option.
|
222
|
+
#
|
223
|
+
# @param type [Symbol, :field_option] String representing the object’s type. Always `field_option` for this object.
|
224
|
+
end
|
225
|
+
|
226
|
+
# @see Moonbase::Models::Field#funnel
|
227
|
+
class Funnel < Moonbase::Internal::Type::BaseModel
|
228
|
+
# @!attribute id
|
229
|
+
# Unique identifier for the object.
|
230
|
+
#
|
231
|
+
# @return [String]
|
232
|
+
required :id, String
|
233
|
+
|
234
|
+
# @!attribute type
|
235
|
+
# String representing the object’s type. Always `funnel` for this object.
|
236
|
+
#
|
237
|
+
# @return [Symbol, :funnel]
|
238
|
+
required :type, const: :funnel
|
239
|
+
|
240
|
+
# @!attribute steps
|
241
|
+
# An ordered list of `FunnelStep` objects that make up the funnel.
|
242
|
+
#
|
243
|
+
# @return [Array<Moonbase::Models::Field::Funnel::Step>, nil]
|
244
|
+
optional :steps, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Field::Funnel::Step] }
|
245
|
+
|
246
|
+
# @!method initialize(id:, steps: nil, type: :funnel)
|
247
|
+
# If the field `type` is `field/stage`, this is the associated `Funnel` object.
|
248
|
+
#
|
249
|
+
# @param id [String] Unique identifier for the object.
|
250
|
+
#
|
251
|
+
# @param steps [Array<Moonbase::Models::Field::Funnel::Step>] An ordered list of `FunnelStep` objects that make up the funnel.
|
252
|
+
#
|
253
|
+
# @param type [Symbol, :funnel] String representing the object’s type. Always `funnel` for this object.
|
254
|
+
|
255
|
+
class Step < Moonbase::Internal::Type::BaseModel
|
256
|
+
# @!attribute id
|
257
|
+
# Unique identifier for the object.
|
258
|
+
#
|
259
|
+
# @return [String]
|
260
|
+
required :id, String
|
261
|
+
|
262
|
+
# @!attribute name
|
263
|
+
# The name of the step.
|
264
|
+
#
|
265
|
+
# @return [String]
|
266
|
+
required :name, String
|
267
|
+
|
268
|
+
# @!attribute type
|
269
|
+
# The type of step, which can be `funnel_step/active`, `funnel_step/success`, or
|
270
|
+
# `funnel_step/failure`.
|
271
|
+
#
|
272
|
+
# @return [Symbol, Moonbase::Models::Field::Funnel::Step::Type]
|
273
|
+
required :type, enum: -> { Moonbase::Field::Funnel::Step::Type }
|
274
|
+
|
275
|
+
# @!method initialize(id:, name:, type:)
|
276
|
+
# Some parameter documentations has been truncated, see
|
277
|
+
# {Moonbase::Models::Field::Funnel::Step} for more details.
|
278
|
+
#
|
279
|
+
# Represents a single step within a `Funnel`.
|
280
|
+
#
|
281
|
+
# @param id [String] Unique identifier for the object.
|
282
|
+
#
|
283
|
+
# @param name [String] The name of the step.
|
284
|
+
#
|
285
|
+
# @param type [Symbol, Moonbase::Models::Field::Funnel::Step::Type] The type of step, which can be `funnel_step/active`, `funnel_step/success`, or `
|
286
|
+
|
287
|
+
# The type of step, which can be `funnel_step/active`, `funnel_step/success`, or
|
288
|
+
# `funnel_step/failure`.
|
289
|
+
#
|
290
|
+
# @see Moonbase::Models::Field::Funnel::Step#type
|
291
|
+
module Type
|
292
|
+
extend Moonbase::Internal::Type::Enum
|
293
|
+
|
294
|
+
FUNNEL_STEP_ACTIVE = :"funnel_step/active"
|
295
|
+
FUNNEL_STEP_SUCCESS = :"funnel_step/success"
|
296
|
+
FUNNEL_STEP_FAILURE = :"funnel_step/failure"
|
297
|
+
|
298
|
+
# @!method self.values
|
299
|
+
# @return [Array<Symbol>]
|
300
|
+
end
|
301
|
+
end
|
302
|
+
end
|
303
|
+
end
|
304
|
+
end
|
305
|
+
end
|
@@ -0,0 +1,75 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# A field can be null, a single value, or an array of values
|
6
|
+
module FieldValue
|
7
|
+
extend Moonbase::Internal::Type::Union
|
8
|
+
|
9
|
+
# A single line of text
|
10
|
+
variant -> { Moonbase::SingleLineTextValue }
|
11
|
+
|
12
|
+
# Multiple lines of text
|
13
|
+
variant -> { Moonbase::MultiLineTextValue }
|
14
|
+
|
15
|
+
# Integer value without units
|
16
|
+
variant -> { Moonbase::IntegerValue }
|
17
|
+
|
18
|
+
# Floating point number
|
19
|
+
variant -> { Moonbase::FloatValue }
|
20
|
+
|
21
|
+
# Monetary or currency value
|
22
|
+
variant -> { Moonbase::MonetaryValue }
|
23
|
+
|
24
|
+
# Percentage numeric value
|
25
|
+
variant -> { Moonbase::PercentageValue }
|
26
|
+
|
27
|
+
# True or false value
|
28
|
+
variant -> { Moonbase::BooleanValue }
|
29
|
+
|
30
|
+
# Email address value
|
31
|
+
variant -> { Moonbase::EmailValue }
|
32
|
+
|
33
|
+
# URL or web address
|
34
|
+
variant -> { Moonbase::URLValue }
|
35
|
+
|
36
|
+
# Internet domain name
|
37
|
+
variant -> { Moonbase::DomainValue }
|
38
|
+
|
39
|
+
# X (formerly Twitter) username
|
40
|
+
variant -> { Moonbase::SocialXValue }
|
41
|
+
|
42
|
+
# LinkedIn profile link
|
43
|
+
variant -> { Moonbase::SocialLinkedInValue }
|
44
|
+
|
45
|
+
# Telephone number value
|
46
|
+
variant -> { Moonbase::TelephoneNumber }
|
47
|
+
|
48
|
+
# Geographic coordinate value
|
49
|
+
variant -> { Moonbase::GeoValue }
|
50
|
+
|
51
|
+
# Date without time
|
52
|
+
variant -> { Moonbase::DateValue }
|
53
|
+
|
54
|
+
# Date and time value
|
55
|
+
variant -> { Moonbase::DatetimeValue }
|
56
|
+
|
57
|
+
# Selected choice option
|
58
|
+
variant -> { Moonbase::Choice }
|
59
|
+
|
60
|
+
# Funnel step value
|
61
|
+
variant -> { Moonbase::FunnelStep }
|
62
|
+
|
63
|
+
# Related item reference
|
64
|
+
variant -> { Moonbase::RelationValue }
|
65
|
+
|
66
|
+
variant -> { Moonbase::Models::FieldValue::ValueArray }
|
67
|
+
|
68
|
+
# @!method self.variants
|
69
|
+
# @return [Array(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>)]
|
70
|
+
|
71
|
+
# @type [Moonbase::Internal::Type::Converter]
|
72
|
+
ValueArray = Moonbase::Internal::Type::ArrayOf[union: -> { Moonbase::Value }]
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Files#list
|
6
|
+
class FileListParams < 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::FileListParams} 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,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Files#retrieve
|
6
|
+
class FileRetrieveParams < 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,23 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
class FloatValue < Moonbase::Internal::Type::BaseModel
|
6
|
+
# @!attribute number
|
7
|
+
#
|
8
|
+
# @return [Float]
|
9
|
+
required :number, Float
|
10
|
+
|
11
|
+
# @!attribute type
|
12
|
+
#
|
13
|
+
# @return [Symbol, :"value/number/unitless_float"]
|
14
|
+
required :type, const: :"value/number/unitless_float"
|
15
|
+
|
16
|
+
# @!method initialize(number:, type: :"value/number/unitless_float")
|
17
|
+
# Floating point number
|
18
|
+
#
|
19
|
+
# @param number [Float]
|
20
|
+
# @param type [Symbol, :"value/number/unitless_float"]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,111 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Forms#retrieve
|
6
|
+
class Form < Moonbase::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# Unique identifier for the object.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute collection
|
14
|
+
# The `Collection` that submissions to this form are saved to.
|
15
|
+
#
|
16
|
+
# @return [Moonbase::Models::Collection]
|
17
|
+
required :collection, -> { Moonbase::Collection }
|
18
|
+
|
19
|
+
# @!attribute links
|
20
|
+
#
|
21
|
+
# @return [Moonbase::Models::Form::Links]
|
22
|
+
required :links, -> { Moonbase::Form::Links }
|
23
|
+
|
24
|
+
# @!attribute name
|
25
|
+
# The name of the form, used as the title on its public page.
|
26
|
+
#
|
27
|
+
# @return [String]
|
28
|
+
required :name, String
|
29
|
+
|
30
|
+
# @!attribute type
|
31
|
+
# String representing the object’s type. Always `form` for this object.
|
32
|
+
#
|
33
|
+
# @return [Symbol, :form]
|
34
|
+
required :type, const: :form
|
35
|
+
|
36
|
+
# @!attribute created_at
|
37
|
+
# Time at which the object was created, as an RFC 3339 timestamp.
|
38
|
+
#
|
39
|
+
# @return [Time, nil]
|
40
|
+
optional :created_at, Time
|
41
|
+
|
42
|
+
# @!attribute pages_enabled
|
43
|
+
# `true` if the form is available at a public URL.
|
44
|
+
#
|
45
|
+
# @return [Boolean, nil]
|
46
|
+
optional :pages_enabled, Moonbase::Internal::Type::Boolean
|
47
|
+
|
48
|
+
# @!attribute pages_url
|
49
|
+
# The public URL for the form, if `pages_enabled` is `true`.
|
50
|
+
#
|
51
|
+
# @return [String, nil]
|
52
|
+
optional :pages_url, String
|
53
|
+
|
54
|
+
# @!attribute redirect_url
|
55
|
+
# An optional URL to redirect users to after a successful submission.
|
56
|
+
#
|
57
|
+
# @return [String, nil]
|
58
|
+
optional :redirect_url, String
|
59
|
+
|
60
|
+
# @!attribute updated_at
|
61
|
+
# Time at which the object was last updated, as an RFC 3339 timestamp.
|
62
|
+
#
|
63
|
+
# @return [Time, nil]
|
64
|
+
optional :updated_at, Time
|
65
|
+
|
66
|
+
# @!method initialize(id:, collection:, links:, name:, created_at: nil, pages_enabled: nil, pages_url: nil, redirect_url: nil, updated_at: nil, type: :form)
|
67
|
+
# A Form provides a way to create `Items` in a `Collection`, often via a public
|
68
|
+
# URL for external users. Each form submission creates a new item.
|
69
|
+
#
|
70
|
+
# @param id [String] Unique identifier for the object.
|
71
|
+
#
|
72
|
+
# @param collection [Moonbase::Models::Collection] The `Collection` that submissions to this form are saved to.
|
73
|
+
#
|
74
|
+
# @param links [Moonbase::Models::Form::Links]
|
75
|
+
#
|
76
|
+
# @param name [String] The name of the form, used as the title on its public page.
|
77
|
+
#
|
78
|
+
# @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
|
79
|
+
#
|
80
|
+
# @param pages_enabled [Boolean] `true` if the form is available at a public URL.
|
81
|
+
#
|
82
|
+
# @param pages_url [String] The public URL for the form, if `pages_enabled` is `true`.
|
83
|
+
#
|
84
|
+
# @param redirect_url [String] An optional URL to redirect users to after a successful submission.
|
85
|
+
#
|
86
|
+
# @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
|
87
|
+
#
|
88
|
+
# @param type [Symbol, :form] String representing the object’s type. Always `form` for this object.
|
89
|
+
|
90
|
+
# @see Moonbase::Models::Form#links
|
91
|
+
class Links < Moonbase::Internal::Type::BaseModel
|
92
|
+
# @!attribute self_
|
93
|
+
# The canonical URL for this object.
|
94
|
+
#
|
95
|
+
# @return [String]
|
96
|
+
required :self_, String, api_name: :self
|
97
|
+
|
98
|
+
# @!attribute collection
|
99
|
+
# A link to the `Collection` where form submissions are saved.
|
100
|
+
#
|
101
|
+
# @return [String, nil]
|
102
|
+
optional :collection, String
|
103
|
+
|
104
|
+
# @!method initialize(self_:, collection: nil)
|
105
|
+
# @param self_ [String] The canonical URL for this object.
|
106
|
+
#
|
107
|
+
# @param collection [String] A link to the `Collection` where form submissions are saved.
|
108
|
+
end
|
109
|
+
end
|
110
|
+
end
|
111
|
+
end
|
@@ -0,0 +1,64 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Forms#list
|
6
|
+
class FormListParams < 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 include
|
27
|
+
# Specifies which related objects to include in the response. Valid option is
|
28
|
+
# `collection.fields`.
|
29
|
+
#
|
30
|
+
# @return [Array<Symbol, Moonbase::Models::FormListParams::Include>, nil]
|
31
|
+
optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::FormListParams::Include] }
|
32
|
+
|
33
|
+
# @!attribute limit
|
34
|
+
# Maximum number of items to return per page. Must be between 1 and 100. Defaults
|
35
|
+
# to 20 if not specified.
|
36
|
+
#
|
37
|
+
# @return [Integer, nil]
|
38
|
+
optional :limit, Integer
|
39
|
+
|
40
|
+
# @!method initialize(after: nil, before: nil, include: nil, limit: nil, request_options: {})
|
41
|
+
# Some parameter documentations has been truncated, see
|
42
|
+
# {Moonbase::Models::FormListParams} for more details.
|
43
|
+
#
|
44
|
+
# @param after [String] When specified, returns results starting immediately after the item identified b
|
45
|
+
#
|
46
|
+
# @param before [String] When specified, returns results starting immediately before the item identified
|
47
|
+
#
|
48
|
+
# @param include [Array<Symbol, Moonbase::Models::FormListParams::Include>] Specifies which related objects to include in the response. Valid option is `col
|
49
|
+
#
|
50
|
+
# @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
|
51
|
+
#
|
52
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
53
|
+
|
54
|
+
module Include
|
55
|
+
extend Moonbase::Internal::Type::Enum
|
56
|
+
|
57
|
+
COLLECTION_FIELDS = :"collection.fields"
|
58
|
+
|
59
|
+
# @!method self.values
|
60
|
+
# @return [Array<Symbol>]
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Moonbase
|
4
|
+
module Models
|
5
|
+
# @see Moonbase::Resources::Forms#retrieve
|
6
|
+
class FormRetrieveParams < 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
|
+
# `collection.fields`.
|
13
|
+
#
|
14
|
+
# @return [Array<Symbol, Moonbase::Models::FormRetrieveParams::Include>, nil]
|
15
|
+
optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::FormRetrieveParams::Include] }
|
16
|
+
|
17
|
+
# @!method initialize(include: nil, request_options: {})
|
18
|
+
# Some parameter documentations has been truncated, see
|
19
|
+
# {Moonbase::Models::FormRetrieveParams} for more details.
|
20
|
+
#
|
21
|
+
# @param include [Array<Symbol, Moonbase::Models::FormRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `col
|
22
|
+
#
|
23
|
+
# @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
|
24
|
+
|
25
|
+
module Include
|
26
|
+
extend Moonbase::Internal::Type::Enum
|
27
|
+
|
28
|
+
COLLECTION_FIELDS = :"collection.fields"
|
29
|
+
|
30
|
+
# @!method self.values
|
31
|
+
# @return [Array<Symbol>]
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|