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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +58 -0
  3. data/README.md +10 -1
  4. data/lib/moonbase/client.rb +8 -0
  5. data/lib/moonbase/internal/transport/pooled_net_requester.rb +13 -11
  6. data/lib/moonbase/internal/type/union.rb +5 -5
  7. data/lib/moonbase/internal/util.rb +8 -3
  8. data/lib/moonbase/models/activity.rb +53 -1
  9. data/lib/moonbase/models/activity_list_params.rb +102 -1
  10. data/lib/moonbase/models/agent_setting_retrieve_params.rb +14 -0
  11. data/lib/moonbase/models/agent_setting_retrieve_response.rb +70 -0
  12. data/lib/moonbase/models/boolean_field.rb +9 -1
  13. data/lib/moonbase/models/choice_field.rb +9 -1
  14. data/lib/moonbase/models/collection.rb +10 -1
  15. data/lib/moonbase/models/date_field.rb +9 -1
  16. data/lib/moonbase/models/datetime_field.rb +9 -1
  17. data/lib/moonbase/models/domain_field.rb +9 -1
  18. data/lib/moonbase/models/email_field.rb +9 -1
  19. data/lib/moonbase/models/email_message.rb +10 -2
  20. data/lib/moonbase/models/error.rb +8 -1
  21. data/lib/moonbase/models/float_field.rb +9 -1
  22. data/lib/moonbase/models/geo_field.rb +9 -1
  23. data/lib/moonbase/models/inbox.rb +8 -1
  24. data/lib/moonbase/models/inbox_list_params.rb +3 -3
  25. data/lib/moonbase/models/inbox_message_create_params.rb +127 -0
  26. data/lib/moonbase/models/inbox_message_delete_params.rb +14 -0
  27. data/lib/moonbase/models/inbox_message_update_params.rb +119 -0
  28. data/lib/moonbase/models/inbox_retrieve_params.rb +3 -5
  29. data/lib/moonbase/models/integer_field.rb +9 -1
  30. data/lib/moonbase/models/item.rb +10 -1
  31. data/lib/moonbase/models/item_search_params.rb +53 -0
  32. data/lib/moonbase/models/item_search_response.rb +22 -0
  33. data/lib/moonbase/models/meeting.rb +18 -13
  34. data/lib/moonbase/models/meeting_retrieve_params.rb +3 -1
  35. data/lib/moonbase/models/meeting_update_params.rb +52 -12
  36. data/lib/moonbase/models/monetary_field.rb +9 -1
  37. data/lib/moonbase/models/multi_line_text_field.rb +9 -1
  38. data/lib/moonbase/models/note.rb +30 -2
  39. data/lib/moonbase/models/note_create_params.rb +34 -0
  40. data/lib/moonbase/models/note_update_params.rb +30 -0
  41. data/lib/moonbase/models/percentage_field.rb +9 -1
  42. data/lib/moonbase/models/relation_field.rb +17 -1
  43. data/lib/moonbase/models/single_line_text_field.rb +9 -1
  44. data/lib/moonbase/models/social_linked_in_field.rb +9 -1
  45. data/lib/moonbase/models/social_x_field.rb +9 -1
  46. data/lib/moonbase/models/stage_field.rb +9 -1
  47. data/lib/moonbase/models/subscription.rb +1 -0
  48. data/lib/moonbase/models/telephone_number_field.rb +9 -1
  49. data/lib/moonbase/models/url_field.rb +9 -1
  50. data/lib/moonbase/models/webhook_endpoint_create_params.rb +1 -0
  51. data/lib/moonbase/models/webhook_endpoint_update_params.rb +1 -0
  52. data/lib/moonbase/models.rb +14 -0
  53. data/lib/moonbase/resources/activities.rb +5 -3
  54. data/lib/moonbase/resources/agent_settings.rb +30 -0
  55. data/lib/moonbase/resources/collections/items.rb +2 -2
  56. data/lib/moonbase/resources/inbox_messages.rb +88 -0
  57. data/lib/moonbase/resources/inboxes.rb +4 -4
  58. data/lib/moonbase/resources/items.rb +38 -0
  59. data/lib/moonbase/resources/meetings.rb +8 -3
  60. data/lib/moonbase/resources/notes.rb +47 -0
  61. data/lib/moonbase/version.rb +1 -1
  62. data/lib/moonbase.rb +12 -0
  63. data/manifest.yaml +1 -0
  64. data/rbi/moonbase/client.rbi +6 -0
  65. data/rbi/moonbase/internal/util.rbi +1 -1
  66. data/rbi/moonbase/models/activity.rbi +79 -0
  67. data/rbi/moonbase/models/activity_list_params.rbi +296 -0
  68. data/rbi/moonbase/models/agent_setting_retrieve_params.rbi +30 -0
  69. data/rbi/moonbase/models/agent_setting_retrieve_response.rbi +113 -0
  70. data/rbi/moonbase/models/boolean_field.rbi +8 -0
  71. data/rbi/moonbase/models/choice_field.rbi +8 -0
  72. data/rbi/moonbase/models/collection.rbi +10 -0
  73. data/rbi/moonbase/models/date_field.rbi +8 -0
  74. data/rbi/moonbase/models/datetime_field.rbi +8 -0
  75. data/rbi/moonbase/models/domain_field.rbi +8 -0
  76. data/rbi/moonbase/models/email_field.rbi +8 -0
  77. data/rbi/moonbase/models/email_message.rbi +8 -0
  78. data/rbi/moonbase/models/error.rbi +9 -0
  79. data/rbi/moonbase/models/float_field.rbi +8 -0
  80. data/rbi/moonbase/models/geo_field.rbi +8 -0
  81. data/rbi/moonbase/models/inbox.rbi +9 -0
  82. data/rbi/moonbase/models/inbox_list_params.rbi +12 -4
  83. data/rbi/moonbase/models/inbox_message_create_params.rbi +229 -0
  84. data/rbi/moonbase/models/inbox_message_delete_params.rbi +27 -0
  85. data/rbi/moonbase/models/inbox_message_update_params.rbi +218 -0
  86. data/rbi/moonbase/models/inbox_retrieve_params.rbi +8 -6
  87. data/rbi/moonbase/models/integer_field.rbi +8 -0
  88. data/rbi/moonbase/models/item.rbi +13 -0
  89. data/rbi/moonbase/models/item_search_params.rbi +119 -0
  90. data/rbi/moonbase/models/item_search_response.rbi +33 -0
  91. data/rbi/moonbase/models/meeting.rbi +30 -20
  92. data/rbi/moonbase/models/meeting_retrieve_params.rbi +9 -2
  93. data/rbi/moonbase/models/meeting_update_params.rbi +55 -4
  94. data/rbi/moonbase/models/monetary_field.rbi +8 -0
  95. data/rbi/moonbase/models/multi_line_text_field.rbi +8 -0
  96. data/rbi/moonbase/models/note.rbi +29 -0
  97. data/rbi/moonbase/models/note_create_params.rbi +59 -0
  98. data/rbi/moonbase/models/note_update_params.rbi +54 -0
  99. data/rbi/moonbase/models/percentage_field.rbi +8 -0
  100. data/rbi/moonbase/models/relation_field.rbi +16 -0
  101. data/rbi/moonbase/models/single_line_text_field.rbi +8 -0
  102. data/rbi/moonbase/models/social_linked_in_field.rbi +8 -0
  103. data/rbi/moonbase/models/social_x_field.rbi +8 -0
  104. data/rbi/moonbase/models/stage_field.rbi +8 -0
  105. data/rbi/moonbase/models/subscription.rbi +5 -0
  106. data/rbi/moonbase/models/telephone_number_field.rbi +8 -0
  107. data/rbi/moonbase/models/url_field.rbi +8 -0
  108. data/rbi/moonbase/models/webhook_endpoint_create_params.rbi +5 -0
  109. data/rbi/moonbase/models/webhook_endpoint_update_params.rbi +5 -0
  110. data/rbi/moonbase/models.rbi +14 -0
  111. data/rbi/moonbase/resources/activities.rbi +3 -0
  112. data/rbi/moonbase/resources/agent_settings.rbi +20 -0
  113. data/rbi/moonbase/resources/collections/items.rbi +2 -2
  114. data/rbi/moonbase/resources/inbox_messages.rbi +78 -0
  115. data/rbi/moonbase/resources/inboxes.rbi +2 -2
  116. data/rbi/moonbase/resources/items.rbi +29 -0
  117. data/rbi/moonbase/resources/meetings.rbi +11 -2
  118. data/rbi/moonbase/resources/notes.rbi +38 -0
  119. data/sig/moonbase/client.rbs +4 -0
  120. data/sig/moonbase/models/activity.rbs +38 -0
  121. data/sig/moonbase/models/activity_list_params.rbs +147 -1
  122. data/sig/moonbase/models/agent_setting_retrieve_params.rbs +15 -0
  123. data/sig/moonbase/models/agent_setting_retrieve_response.rbs +79 -0
  124. data/sig/moonbase/models/boolean_field.rbs +5 -0
  125. data/sig/moonbase/models/choice_field.rbs +5 -0
  126. data/sig/moonbase/models/collection.rbs +5 -0
  127. data/sig/moonbase/models/date_field.rbs +5 -0
  128. data/sig/moonbase/models/datetime_field.rbs +5 -0
  129. data/sig/moonbase/models/domain_field.rbs +5 -0
  130. data/sig/moonbase/models/email_field.rbs +5 -0
  131. data/sig/moonbase/models/email_message.rbs +5 -0
  132. data/sig/moonbase/models/error.rbs +7 -0
  133. data/sig/moonbase/models/float_field.rbs +5 -0
  134. data/sig/moonbase/models/geo_field.rbs +5 -0
  135. data/sig/moonbase/models/inbox.rbs +7 -0
  136. data/sig/moonbase/models/inbox_list_params.rbs +6 -6
  137. data/sig/moonbase/models/inbox_message_create_params.rbs +114 -0
  138. data/sig/moonbase/models/inbox_message_delete_params.rbs +15 -0
  139. data/sig/moonbase/models/inbox_message_update_params.rbs +109 -0
  140. data/sig/moonbase/models/inbox_retrieve_params.rbs +6 -6
  141. data/sig/moonbase/models/integer_field.rbs +5 -0
  142. data/sig/moonbase/models/item.rbs +5 -0
  143. data/sig/moonbase/models/item_search_params.rbs +63 -0
  144. data/sig/moonbase/models/item_search_response.rbs +15 -0
  145. data/sig/moonbase/models/meeting.rbs +12 -12
  146. data/sig/moonbase/models/meeting_retrieve_params.rbs +3 -1
  147. data/sig/moonbase/models/monetary_field.rbs +5 -0
  148. data/sig/moonbase/models/multi_line_text_field.rbs +5 -0
  149. data/sig/moonbase/models/note.rbs +15 -0
  150. data/sig/moonbase/models/note_create_params.rbs +35 -0
  151. data/sig/moonbase/models/note_update_params.rbs +28 -0
  152. data/sig/moonbase/models/percentage_field.rbs +5 -0
  153. data/sig/moonbase/models/relation_field.rbs +10 -0
  154. data/sig/moonbase/models/single_line_text_field.rbs +5 -0
  155. data/sig/moonbase/models/social_linked_in_field.rbs +5 -0
  156. data/sig/moonbase/models/social_x_field.rbs +5 -0
  157. data/sig/moonbase/models/stage_field.rbs +5 -0
  158. data/sig/moonbase/models/subscription.rbs +2 -0
  159. data/sig/moonbase/models/telephone_number_field.rbs +5 -0
  160. data/sig/moonbase/models/url_field.rbs +5 -0
  161. data/sig/moonbase/models/webhook_endpoint_create_params.rbs +2 -0
  162. data/sig/moonbase/models/webhook_endpoint_update_params.rbs +2 -0
  163. data/sig/moonbase/models.rbs +14 -0
  164. data/sig/moonbase/resources/activities.rbs +1 -0
  165. data/sig/moonbase/resources/agent_settings.rbs +11 -0
  166. data/sig/moonbase/resources/inbox_messages.rbs +24 -0
  167. data/sig/moonbase/resources/inboxes.rbs +2 -2
  168. data/sig/moonbase/resources/items.rbs +13 -0
  169. data/sig/moonbase/resources/notes.rbs +13 -0
  170. metadata +49 -2
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::DatetimeField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::DatetimeField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/datetime")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/datetime")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::DatetimeField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::DatetimeField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Meeting Time").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::DomainField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::DomainField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/uri/domain")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/uri/domain")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::DomainField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::DomainField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Company Domain").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::EmailField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::EmailField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/email")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/email")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::EmailField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::EmailField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Work Email").
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Moonbase
4
4
  module Models
5
- # @see Moonbase::Resources::InboxMessages#retrieve
5
+ # @see Moonbase::Resources::InboxMessages#create
6
6
  class EmailMessage < Moonbase::Internal::Type::BaseModel
7
7
  # @!attribute id
8
8
  # Unique identifier for the object.
@@ -35,6 +35,12 @@ module Moonbase
35
35
  # @return [Boolean]
36
36
  required :draft, Moonbase::Internal::Type::Boolean
37
37
 
38
+ # @!attribute lock_version
39
+ # The current lock version of the message for optimistic concurrency control.
40
+ #
41
+ # @return [Integer]
42
+ required :lock_version, Integer
43
+
38
44
  # @!attribute spam
39
45
  # `true` if the message is classified as spam.
40
46
  #
@@ -95,7 +101,7 @@ module Moonbase
95
101
  # @return [String, nil]
96
102
  optional :summary, String
97
103
 
98
- # @!method initialize(id:, body:, bulk:, created_at:, draft:, spam:, subject:, trash:, unread:, addresses: nil, attachments: nil, conversation: nil, summary: nil, type: :email_message)
104
+ # @!method initialize(id:, body:, bulk:, created_at:, draft:, lock_version:, spam:, subject:, trash:, unread:, addresses: nil, attachments: nil, conversation: nil, summary: nil, type: :email_message)
99
105
  # Some parameter documentations has been truncated, see
100
106
  # {Moonbase::Models::EmailMessage} for more details.
101
107
  #
@@ -111,6 +117,8 @@ module Moonbase
111
117
  #
112
118
  # @param draft [Boolean] `true` if the message is a draft that has not been sent.
113
119
  #
120
+ # @param lock_version [Integer] The current lock version of the message for optimistic concurrency control.
121
+ #
114
122
  # @param spam [Boolean] `true` if the message is classified as spam.
115
123
  #
116
124
  # @param subject [String] The subject line of the email.
@@ -26,6 +26,11 @@ module Moonbase
26
26
  # @return [String, nil]
27
27
  optional :detail, String
28
28
 
29
+ # @!attribute meta
30
+ #
31
+ # @return [Hash{Symbol=>Object}, nil]
32
+ optional :meta, Moonbase::Internal::Type::HashOf[Moonbase::Internal::Type::Unknown]
33
+
29
34
  # @!attribute source
30
35
  # An object containing more specific information about the part of the request
31
36
  # that caused the error.
@@ -45,7 +50,7 @@ module Moonbase
45
50
  # @return [String, nil]
46
51
  optional :title, String
47
52
 
48
- # @!method initialize(id: nil, code: nil, detail: nil, source: nil, status: nil, title: nil, type: :error)
53
+ # @!method initialize(id: nil, code: nil, detail: nil, meta: nil, source: nil, status: nil, title: nil, type: :error)
49
54
  # Some parameter documentations has been truncated, see {Moonbase::Models::Error}
50
55
  # for more details.
51
56
  #
@@ -60,6 +65,8 @@ module Moonbase
60
65
  #
61
66
  # @param detail [String] A human-readable explanation of this specific error.
62
67
  #
68
+ # @param meta [Hash{Symbol=>Object}]
69
+ #
63
70
  # @param source [Moonbase::Models::Error::Source] An object containing more specific information about the part of the request tha
64
71
  #
65
72
  # @param status [String] The HTTP status code for this problem, as a string.
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::FloatField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::FloatField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/unitless_float")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/unitless_float")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::FloatField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::FloatField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Rating").
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::GeoField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::GeoField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -73,7 +79,7 @@ module Moonbase
73
79
  # @return [String, nil]
74
80
  optional :description, String
75
81
 
76
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/geo")
82
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/geo")
77
83
  # Some parameter documentations has been truncated, see
78
84
  # {Moonbase::Models::GeoField} for more details.
79
85
  #
@@ -83,6 +89,8 @@ module Moonbase
83
89
  #
84
90
  # @param cardinality [Symbol, Moonbase::Models::GeoField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
85
91
  #
92
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
93
+ #
86
94
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
87
95
  #
88
96
  # @param name [String] The human-readable name of the field (e.g., "Location").
@@ -34,6 +34,11 @@ module Moonbase
34
34
  # @return [Time]
35
35
  required :updated_at, Time
36
36
 
37
+ # @!attribute can_read
38
+ #
39
+ # @return [Boolean, nil]
40
+ optional :can_read, Moonbase::Internal::Type::Boolean
41
+
37
42
  # @!attribute tagsets
38
43
  # The list of `Tagset` objects associated with this inbox, which defines the tags
39
44
  # available for its conversations.
@@ -43,7 +48,7 @@ module Moonbase
43
48
  # @return [Array<Moonbase::Models::Tagset>, nil]
44
49
  optional :tagsets, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Tagset] }
45
50
 
46
- # @!method initialize(id:, created_at:, name:, updated_at:, tagsets: nil, type: :inbox)
51
+ # @!method initialize(id:, created_at:, name:, updated_at:, can_read: nil, tagsets: nil, type: :inbox)
47
52
  # Some parameter documentations has been truncated, see {Moonbase::Models::Inbox}
48
53
  # for more details.
49
54
  #
@@ -57,6 +62,8 @@ module Moonbase
57
62
  #
58
63
  # @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
59
64
  #
65
+ # @param can_read [Boolean]
66
+ #
60
67
  # @param tagsets [Array<Moonbase::Models::Tagset>] The list of `Tagset` objects associated with this inbox, which defines the tags
61
68
  #
62
69
  # @param type [Symbol, :inbox] String representing the object’s type. Always `inbox` for this object.
@@ -25,8 +25,8 @@ module Moonbase
25
25
 
26
26
  # @!attribute include
27
27
  #
28
- # @return [Symbol, Moonbase::Models::InboxListParams::Include, nil]
29
- optional :include, enum: -> { Moonbase::InboxListParams::Include }
28
+ # @return [Array<Symbol, Moonbase::Models::InboxListParams::Include>, nil]
29
+ optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxListParams::Include] }
30
30
 
31
31
  # @!attribute limit
32
32
  # Maximum number of items to return per page. Must be between 1 and 100. Defaults
@@ -43,7 +43,7 @@ module Moonbase
43
43
  #
44
44
  # @param before [String] When specified, returns results starting immediately before the item identified
45
45
  #
46
- # @param include [Symbol, Moonbase::Models::InboxListParams::Include]
46
+ # @param include [Array<Symbol, Moonbase::Models::InboxListParams::Include>]
47
47
  #
48
48
  # @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
49
49
  #
@@ -0,0 +1,127 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::InboxMessages#create
6
+ class InboxMessageCreateParams < Moonbase::Internal::Type::BaseModel
7
+ extend Moonbase::Internal::Type::RequestParameters::Converter
8
+ include Moonbase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute body
11
+ # The email body.
12
+ #
13
+ # @return [Moonbase::Models::FormattedText]
14
+ required :body, -> { Moonbase::FormattedText }
15
+
16
+ # @!attribute inbox_id
17
+ # The inbox to use for sending the email.
18
+ #
19
+ # @return [String]
20
+ required :inbox_id, String
21
+
22
+ # @!attribute bcc
23
+ # A list of the BCC recipients.
24
+ #
25
+ # @return [Array<Moonbase::Models::InboxMessageCreateParams::Bcc>, nil]
26
+ optional :bcc, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageCreateParams::Bcc] }
27
+
28
+ # @!attribute cc
29
+ # A list of the CC recipients.
30
+ #
31
+ # @return [Array<Moonbase::Models::InboxMessageCreateParams::Cc>, nil]
32
+ optional :cc, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageCreateParams::Cc] }
33
+
34
+ # @!attribute conversation_id
35
+ # The ID of the conversation, if responding to an existing conversation.
36
+ #
37
+ # @return [String, nil]
38
+ optional :conversation_id, String
39
+
40
+ # @!attribute subject
41
+ # The subject line of the email.
42
+ #
43
+ # @return [String, nil]
44
+ optional :subject, String
45
+
46
+ # @!attribute to
47
+ # A list of recipients.
48
+ #
49
+ # @return [Array<Moonbase::Models::InboxMessageCreateParams::To>, nil]
50
+ optional :to, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageCreateParams::To] }
51
+
52
+ # @!method initialize(body:, inbox_id:, bcc: nil, cc: nil, conversation_id: nil, subject: nil, to: nil, request_options: {})
53
+ # @param body [Moonbase::Models::FormattedText] The email body.
54
+ #
55
+ # @param inbox_id [String] The inbox to use for sending the email.
56
+ #
57
+ # @param bcc [Array<Moonbase::Models::InboxMessageCreateParams::Bcc>] A list of the BCC recipients.
58
+ #
59
+ # @param cc [Array<Moonbase::Models::InboxMessageCreateParams::Cc>] A list of the CC recipients.
60
+ #
61
+ # @param conversation_id [String] The ID of the conversation, if responding to an existing conversation.
62
+ #
63
+ # @param subject [String] The subject line of the email.
64
+ #
65
+ # @param to [Array<Moonbase::Models::InboxMessageCreateParams::To>] A list of recipients.
66
+ #
67
+ # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
68
+
69
+ class Bcc < Moonbase::Internal::Type::BaseModel
70
+ # @!attribute email
71
+ # The email address.
72
+ #
73
+ # @return [String]
74
+ required :email, String
75
+
76
+ # @!attribute name
77
+ # The recipient's name.
78
+ #
79
+ # @return [String, nil]
80
+ optional :name, String
81
+
82
+ # @!method initialize(email:, name: nil)
83
+ # @param email [String] The email address.
84
+ #
85
+ # @param name [String] The recipient's name.
86
+ end
87
+
88
+ class Cc < Moonbase::Internal::Type::BaseModel
89
+ # @!attribute email
90
+ # The email address.
91
+ #
92
+ # @return [String]
93
+ required :email, String
94
+
95
+ # @!attribute name
96
+ # The recipient's name.
97
+ #
98
+ # @return [String, nil]
99
+ optional :name, String
100
+
101
+ # @!method initialize(email:, name: nil)
102
+ # @param email [String] The email address.
103
+ #
104
+ # @param name [String] The recipient's name.
105
+ end
106
+
107
+ class To < Moonbase::Internal::Type::BaseModel
108
+ # @!attribute email
109
+ # The email address.
110
+ #
111
+ # @return [String]
112
+ required :email, String
113
+
114
+ # @!attribute name
115
+ # The recipient's name.
116
+ #
117
+ # @return [String, nil]
118
+ optional :name, String
119
+
120
+ # @!method initialize(email:, name: nil)
121
+ # @param email [String] The email address.
122
+ #
123
+ # @param name [String] The recipient's name.
124
+ end
125
+ end
126
+ end
127
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::InboxMessages#delete
6
+ class InboxMessageDeleteParams < 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,119 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Moonbase
4
+ module Models
5
+ # @see Moonbase::Resources::InboxMessages#update
6
+ class InboxMessageUpdateParams < Moonbase::Internal::Type::BaseModel
7
+ extend Moonbase::Internal::Type::RequestParameters::Converter
8
+ include Moonbase::Internal::Type::RequestParameters
9
+
10
+ # @!attribute lock_version
11
+ # The current lock version of the draft for optimistic concurrency control.
12
+ #
13
+ # @return [Integer]
14
+ required :lock_version, Integer
15
+
16
+ # @!attribute bcc
17
+ # A list of the BCC recipients.
18
+ #
19
+ # @return [Array<Moonbase::Models::InboxMessageUpdateParams::Bcc>, nil]
20
+ optional :bcc, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageUpdateParams::Bcc] }
21
+
22
+ # @!attribute body
23
+ # The email body.
24
+ #
25
+ # @return [Moonbase::Models::FormattedText, nil]
26
+ optional :body, -> { Moonbase::FormattedText }
27
+
28
+ # @!attribute cc
29
+ # A list of the CC recipients.
30
+ #
31
+ # @return [Array<Moonbase::Models::InboxMessageUpdateParams::Cc>, nil]
32
+ optional :cc, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageUpdateParams::Cc] }
33
+
34
+ # @!attribute subject
35
+ # The subject line of the email.
36
+ #
37
+ # @return [String, nil]
38
+ optional :subject, String
39
+
40
+ # @!attribute to
41
+ # A list of the recipients.
42
+ #
43
+ # @return [Array<Moonbase::Models::InboxMessageUpdateParams::To>, nil]
44
+ optional :to, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::InboxMessageUpdateParams::To] }
45
+
46
+ # @!method initialize(lock_version:, bcc: nil, body: nil, cc: nil, subject: nil, to: nil, request_options: {})
47
+ # @param lock_version [Integer] The current lock version of the draft for optimistic concurrency control.
48
+ #
49
+ # @param bcc [Array<Moonbase::Models::InboxMessageUpdateParams::Bcc>] A list of the BCC recipients.
50
+ #
51
+ # @param body [Moonbase::Models::FormattedText] The email body.
52
+ #
53
+ # @param cc [Array<Moonbase::Models::InboxMessageUpdateParams::Cc>] A list of the CC recipients.
54
+ #
55
+ # @param subject [String] The subject line of the email.
56
+ #
57
+ # @param to [Array<Moonbase::Models::InboxMessageUpdateParams::To>] A list of the recipients.
58
+ #
59
+ # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
60
+
61
+ class Bcc < Moonbase::Internal::Type::BaseModel
62
+ # @!attribute email
63
+ # The email address.
64
+ #
65
+ # @return [String]
66
+ required :email, String
67
+
68
+ # @!attribute name
69
+ # The recipient's name.
70
+ #
71
+ # @return [String, nil]
72
+ optional :name, String
73
+
74
+ # @!method initialize(email:, name: nil)
75
+ # @param email [String] The email address.
76
+ #
77
+ # @param name [String] The recipient's name.
78
+ end
79
+
80
+ class Cc < Moonbase::Internal::Type::BaseModel
81
+ # @!attribute email
82
+ # The email address.
83
+ #
84
+ # @return [String]
85
+ required :email, String
86
+
87
+ # @!attribute name
88
+ # The recipient's name.
89
+ #
90
+ # @return [String, nil]
91
+ optional :name, String
92
+
93
+ # @!method initialize(email:, name: nil)
94
+ # @param email [String] The email address.
95
+ #
96
+ # @param name [String] The recipient's name.
97
+ end
98
+
99
+ class To < Moonbase::Internal::Type::BaseModel
100
+ # @!attribute email
101
+ # The email address.
102
+ #
103
+ # @return [String]
104
+ required :email, String
105
+
106
+ # @!attribute name
107
+ # The recipient's name.
108
+ #
109
+ # @return [String, nil]
110
+ optional :name, String
111
+
112
+ # @!method initialize(email:, name: nil)
113
+ # @param email [String] The email address.
114
+ #
115
+ # @param name [String] The recipient's name.
116
+ end
117
+ end
118
+ end
119
+ end
@@ -11,19 +11,17 @@ module Moonbase
11
11
  # Specifies which related objects to include in the response. Valid option is
12
12
  # `tagsets`.
13
13
  #
14
- # @return [Symbol, Moonbase::Models::InboxRetrieveParams::Include, nil]
15
- optional :include, enum: -> { Moonbase::InboxRetrieveParams::Include }
14
+ # @return [Array<Symbol, Moonbase::Models::InboxRetrieveParams::Include>, nil]
15
+ optional :include, -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::InboxRetrieveParams::Include] }
16
16
 
17
17
  # @!method initialize(include: nil, request_options: {})
18
18
  # Some parameter documentations has been truncated, see
19
19
  # {Moonbase::Models::InboxRetrieveParams} for more details.
20
20
  #
21
- # @param include [Symbol, Moonbase::Models::InboxRetrieveParams::Include] Specifies which related objects to include in the response. Valid option is `tag
21
+ # @param include [Array<Symbol, Moonbase::Models::InboxRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `tag
22
22
  #
23
23
  # @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
24
24
 
25
- # Specifies which related objects to include in the response. Valid option is
26
- # `tagsets`.
27
25
  module Include
28
26
  extend Moonbase::Internal::Type::Enum
29
27
 
@@ -16,6 +16,12 @@ module Moonbase
16
16
  # @return [Symbol, Moonbase::Models::IntegerField::Cardinality]
17
17
  required :cardinality, enum: -> { Moonbase::IntegerField::Cardinality }
18
18
 
19
+ # @!attribute core
20
+ # If `true`, this is a built-in field included by default.
21
+ #
22
+ # @return [Boolean]
23
+ required :core, Moonbase::Internal::Type::Boolean
24
+
19
25
  # @!attribute created_at
20
26
  # Time at which the object was created, as an ISO 8601 timestamp in UTC.
21
27
  #
@@ -74,7 +80,7 @@ module Moonbase
74
80
  # @return [String, nil]
75
81
  optional :description, String
76
82
 
77
- # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/unitless_integer")
83
+ # @!method initialize(id:, cardinality:, core:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/number/unitless_integer")
78
84
  # Some parameter documentations has been truncated, see
79
85
  # {Moonbase::Models::IntegerField} for more details.
80
86
  #
@@ -84,6 +90,8 @@ module Moonbase
84
90
  #
85
91
  # @param cardinality [Symbol, Moonbase::Models::IntegerField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
86
92
  #
93
+ # @param core [Boolean] If `true`, this is a built-in field included by default.
94
+ #
87
95
  # @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
88
96
  #
89
97
  # @param name [String] The human-readable name of the field (e.g., "Employee Count").
@@ -9,6 +9,13 @@ module Moonbase
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
+ # @!attribute collection
13
+ # A lightweight reference to a `Collection`, containing the minimal information
14
+ # needed to identify it.
15
+ #
16
+ # @return [Moonbase::Models::CollectionPointer]
17
+ required :collection, -> { Moonbase::CollectionPointer }
18
+
12
19
  # @!attribute type
13
20
  # String representing the object’s type. Always `item` for this object.
14
21
  #
@@ -22,7 +29,7 @@ module Moonbase
22
29
  # @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::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue, 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::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue>}]
23
30
  required :values, -> { Moonbase::Internal::Type::HashOf[union: Moonbase::FieldValue] }
24
31
 
25
- # @!method initialize(id:, values:, type: :item)
32
+ # @!method initialize(id:, collection:, values:, type: :item)
26
33
  # Some parameter documentations has been truncated, see {Moonbase::Models::Item}
27
34
  # for more details.
28
35
  #
@@ -31,6 +38,8 @@ module Moonbase
31
38
  #
32
39
  # @param id [String] Unique identifier for the object.
33
40
  #
41
+ # @param collection [Moonbase::Models::CollectionPointer] A lightweight reference to a `Collection`, containing the minimal information ne
42
+ #
34
43
  # @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::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue, 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::ChoiceValue, Moonbase::Models::FunnelStepValue, Moonbase::Models::RelationValue>}] A hash where keys are the `ref` of a `Field` and values are the data stored for
35
44
  #
36
45
  # @param type [Symbol, :item] String representing the object’s type. Always `item` for this object.