moonbase-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

data/lib/moonbase/models/activity_program_message_failed.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class ActivityProgramMessageFailed < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute occurred_at
+      #   The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute program_message
+      #   A lightweight reference to another resource.
+      #
+      #   @return [Moonbase::Models::Pointer, nil]
+      required :program_message, -> { Moonbase::Pointer }, nil?: true
+
+      # @!attribute recipient
+      #   A reference to an `Item` within a specific `Collection`, providing the context
+      #   needed to locate the item.
+      #
+      #   @return [Moonbase::Models::ItemPointer, nil]
+      required :recipient, -> { Moonbase::ItemPointer }, nil?: true
+
+      # @!attribute type
+      #   The type of activity. Always `activity/program_message_failed`.
+      #
+      #   @return [Symbol, :"activity/program_message_failed"]
+      required :type, const: :"activity/program_message_failed"
+
+      # @!attribute reason_code
+      #   A code indicating the reason for the failure (e.g., `message_contained_virus`).
+      #
+      #   @return [String, nil]
+      optional :reason_code, String
+
+      # @!method initialize(id:, occurred_at:, program_message:, recipient:, reason_code: nil, type: :"activity/program_message_failed")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ActivityProgramMessageFailed} for more details.
+      #
+      #   Represents an event that occurs when a `ProgramMessage` fails to be delivered
+      #   for a technical reason.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param occurred_at [Time] The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param program_message [Moonbase::Models::Pointer, nil] A lightweight reference to another resource.
+      #
+      #   @param recipient [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
+      #
+      #   @param reason_code [String] A code indicating the reason for the failure (e.g., `message_contained_virus`).
+      #
+      #   @param type [Symbol, :"activity/program_message_failed"] The type of activity. Always `activity/program_message_failed`.
+    end
+  end
+end

data/lib/moonbase/models/activity_program_message_opened.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class ActivityProgramMessageOpened < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute occurred_at
+      #   The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute program_message
+      #   A lightweight reference to another resource.
+      #
+      #   @return [Moonbase::Models::Pointer, nil]
+      required :program_message, -> { Moonbase::Pointer }, nil?: true
+
+      # @!attribute recipient
+      #   A reference to an `Item` within a specific `Collection`, providing the context
+      #   needed to locate the item.
+      #
+      #   @return [Moonbase::Models::ItemPointer, nil]
+      required :recipient, -> { Moonbase::ItemPointer }, nil?: true
+
+      # @!attribute type
+      #   The type of activity. Always `activity/program_message_opened`.
+      #
+      #   @return [Symbol, :"activity/program_message_opened"]
+      required :type, const: :"activity/program_message_opened"
+
+      # @!method initialize(id:, occurred_at:, program_message:, recipient:, type: :"activity/program_message_opened")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ActivityProgramMessageOpened} for more details.
+      #
+      #   Represents an event that occurs when a recipient opens a `ProgramMessage`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param occurred_at [Time] The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param program_message [Moonbase::Models::Pointer, nil] A lightweight reference to another resource.
+      #
+      #   @param recipient [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
+      #
+      #   @param type [Symbol, :"activity/program_message_opened"] The type of activity. Always `activity/program_message_opened`.
+    end
+  end
+end

data/lib/moonbase/models/activity_program_message_sent.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class ActivityProgramMessageSent < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute occurred_at
+      #   The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute program_message
+      #   A lightweight reference to another resource.
+      #
+      #   @return [Moonbase::Models::Pointer, nil]
+      required :program_message, -> { Moonbase::Pointer }, nil?: true
+
+      # @!attribute recipient
+      #   A reference to an `Item` within a specific `Collection`, providing the context
+      #   needed to locate the item.
+      #
+      #   @return [Moonbase::Models::ItemPointer, nil]
+      required :recipient, -> { Moonbase::ItemPointer }, nil?: true
+
+      # @!attribute type
+      #   The type of activity. Always `activity/program_message_sent`.
+      #
+      #   @return [Symbol, :"activity/program_message_sent"]
+      required :type, const: :"activity/program_message_sent"
+
+      # @!attribute recipient_emails
+      #   List of email addresses the message was sent to.
+      #
+      #   @return [Array<String>, nil]
+      optional :recipient_emails, Moonbase::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id:, occurred_at:, program_message:, recipient:, recipient_emails: nil, type: :"activity/program_message_sent")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ActivityProgramMessageSent} for more details.
+      #
+      #   Represents an event that occurs when a `ProgramMessage` is successfully sent.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param occurred_at [Time] The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param program_message [Moonbase::Models::Pointer, nil] A lightweight reference to another resource.
+      #
+      #   @param recipient [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
+      #
+      #   @param recipient_emails [Array<String>] List of email addresses the message was sent to.
+      #
+      #   @param type [Symbol, :"activity/program_message_sent"] The type of activity. Always `activity/program_message_sent`.
+    end
+  end
+end

data/lib/moonbase/models/activity_program_message_shielded.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class ActivityProgramMessageShielded < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute occurred_at
+      #   The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute program_message
+      #   A lightweight reference to another resource.
+      #
+      #   @return [Moonbase::Models::Pointer, nil]
+      required :program_message, -> { Moonbase::Pointer }, nil?: true
+
+      # @!attribute recipient
+      #   A reference to an `Item` within a specific `Collection`, providing the context
+      #   needed to locate the item.
+      #
+      #   @return [Moonbase::Models::ItemPointer, nil]
+      required :recipient, -> { Moonbase::ItemPointer }, nil?: true
+
+      # @!attribute type
+      #   The type of activity. Always `activity/program_message_shielded`.
+      #
+      #   @return [Symbol, :"activity/program_message_shielded"]
+      required :type, const: :"activity/program_message_shielded"
+
+      # @!attribute reason_code
+      #   A code indicating why the message was shielded (e.g.,
+      #   `person_previously_unsubscribed`).
+      #
+      #   @return [String, nil]
+      optional :reason_code, String
+
+      # @!method initialize(id:, occurred_at:, program_message:, recipient:, reason_code: nil, type: :"activity/program_message_shielded")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ActivityProgramMessageShielded} for more details.
+      #
+      #   Represents an event that occurs when a `ProgramMessage` is prevented from being
+      #   sent by a delivery protection rule.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param occurred_at [Time] The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param program_message [Moonbase::Models::Pointer, nil] A lightweight reference to another resource.
+      #
+      #   @param recipient [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
+      #
+      #   @param reason_code [String] A code indicating why the message was shielded (e.g., `person_previously_unsubsc
+      #
+      #   @param type [Symbol, :"activity/program_message_shielded"] The type of activity. Always `activity/program_message_shielded`.
+    end
+  end
+end

data/lib/moonbase/models/activity_program_message_unsubscribed.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class ActivityProgramMessageUnsubscribed < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute occurred_at
+      #   The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :occurred_at, Time
+
+      # @!attribute program_message
+      #   A lightweight reference to another resource.
+      #
+      #   @return [Moonbase::Models::Pointer, nil]
+      required :program_message, -> { Moonbase::Pointer }, nil?: true
+
+      # @!attribute recipient
+      #   A reference to an `Item` within a specific `Collection`, providing the context
+      #   needed to locate the item.
+      #
+      #   @return [Moonbase::Models::ItemPointer, nil]
+      required :recipient, -> { Moonbase::ItemPointer }, nil?: true
+
+      # @!attribute type
+      #   The type of activity. Always `activity/program_message_unsubscribed`.
+      #
+      #   @return [Symbol, :"activity/program_message_unsubscribed"]
+      required :type, const: :"activity/program_message_unsubscribed"
+
+      # @!attribute email
+      #   The email address of the person who unsubscribed.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!method initialize(id:, occurred_at:, program_message:, recipient:, email: nil, type: :"activity/program_message_unsubscribed")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ActivityProgramMessageUnsubscribed} for more details.
+      #
+      #   Represents an event that occurs when a recipient unsubscribes after receiving a
+      #   `ProgramMessage`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param occurred_at [Time] The time at which the event occurred, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param program_message [Moonbase::Models::Pointer, nil] A lightweight reference to another resource.
+      #
+      #   @param recipient [Moonbase::Models::ItemPointer, nil] A reference to an `Item` within a specific `Collection`, providing the context n
+      #
+      #   @param email [String] The email address of the person who unsubscribed.
+      #
+      #   @param type [Symbol, :"activity/program_message_unsubscribed"] The type of activity. Always `activity/program_message_unsubscribed`.
+    end
+  end
+end

data/lib/moonbase/models/address.rb

@@ -15,38 +15,32 @@ module Moonbase
       #   @return [String]
       required :email, String
 
-      # @!attribute type
-      #   String representing the object’s type. Always `address` for this object.
+      # @!attribute role
+      #   The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`,
+      #   or `bcc`.
       #
-      #   @return [Symbol, :address]
-      required :type, const: :address
+      #   @return [Symbol, Moonbase::Models::Address::Role]
+      required :role, enum: -> { Moonbase::Address::Role }
 
-      # @!attribute created_at
-      #   Time at which the object was created, as an RFC 3339 timestamp.
+      # @!attribute type
+      #   String representing the object’s type. Always `message_address` for this object.
       #
-      #   @return [Time, nil]
-      optional :created_at, Time
+      #   @return [Symbol, :message_address]
+      required :type, const: :message_address
 
-      # @!attribute links
-      #   A hash of related links.
+      # @!attribute organization
+      #   A lightweight reference to another resource.
       #
-      #   @return [Moonbase::Models::Address::Links, nil]
-      optional :links, -> { Moonbase::Address::Links }
+      #   @return [Moonbase::Models::Pointer, nil]
+      optional :organization, -> { Moonbase::Pointer }
 
-      # @!attribute role
-      #   The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`,
-      #   or `bcc`.
+      # @!attribute person
+      #   A lightweight reference to another resource.
       #
-      #   @return [Symbol, Moonbase::Models::Address::Role, nil]
-      optional :role, enum: -> { Moonbase::Address::Role }
+      #   @return [Moonbase::Models::Pointer, nil]
+      optional :person, -> { Moonbase::Pointer }
 
-      # @!attribute updated_at
-      #   Time at which the object was last updated, as an RFC 3339 timestamp.
-      #
-      #   @return [Time, nil]
-      optional :updated_at, Time
-
-      # @!method initialize(id:, email:, created_at: nil, links: nil, role: nil, updated_at: nil, type: :address)
+      # @!method initialize(id:, email:, role:, organization: nil, person: nil, type: :message_address)
       #   Some parameter documentations has been truncated, see
       #   {Moonbase::Models::Address} for more details.
       #
@@ -58,37 +52,13 @@ module Moonbase
       #
       #   @param email [String] The email address.
       #
-      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
-      #
-      #   @param links [Moonbase::Models::Address::Links] A hash of related links.
-      #
       #   @param role [Symbol, Moonbase::Models::Address::Role] The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`, o
       #
-      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #   @param organization [Moonbase::Models::Pointer] A lightweight reference to another resource.
       #
-      #   @param type [Symbol, :address] String representing the object’s type. Always `address` for this object.
-
-      # @see Moonbase::Models::Address#links
-      class Links < Moonbase::Internal::Type::BaseModel
-        # @!attribute organization
-        #   A link to the associated `Organization` item.
-        #
-        #   @return [String, nil]
-        optional :organization, String
-
-        # @!attribute person
-        #   A link to the associated `Person` item.
-        #
-        #   @return [String, nil]
-        optional :person, String
-
-        # @!method initialize(organization: nil, person: nil)
-        #   A hash of related links.
-        #
-        #   @param organization [String] A link to the associated `Organization` item.
-        #
-        #   @param person [String] A link to the associated `Person` item.
-      end
+      #   @param person [Moonbase::Models::Pointer] A lightweight reference to another resource.
+      #
+      #   @param type [Symbol, :message_address] String representing the object’s type. Always `message_address` for this object.
 
       # The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`,
       # or `bcc`.

data/lib/moonbase/models/attendee.rb

@@ -15,31 +15,29 @@ module Moonbase
       #   @return [String]
       required :email, String
 
-      # @!attribute links
-      #   A hash of related links.
-      #
-      #   @return [Moonbase::Models::Attendee::Links]
-      required :links, -> { Moonbase::Attendee::Links }
-
       # @!attribute type
-      #   String representing the object’s type. Always `attendee` for this object.
+      #   String representing the object’s type. Always `meeting_attendee` for this
+      #   object.
       #
-      #   @return [Symbol, :attendee]
-      required :type, const: :attendee
+      #   @return [Symbol, :meeting_attendee]
+      required :type, const: :meeting_attendee
 
-      # @!attribute created_at
-      #   Time at which the object was created, as an RFC 3339 timestamp.
+      # @!attribute organization
+      #   A lightweight reference to another resource.
       #
-      #   @return [Time, nil]
-      optional :created_at, Time
+      #   @return [Moonbase::Models::Pointer, nil]
+      optional :organization, -> { Moonbase::Pointer }
 
-      # @!attribute updated_at
-      #   Time at which the object was last updated, as an RFC 3339 timestamp.
+      # @!attribute person
+      #   A lightweight reference to another resource.
       #
-      #   @return [Time, nil]
-      optional :updated_at, Time
+      #   @return [Moonbase::Models::Pointer, nil]
+      optional :person, -> { Moonbase::Pointer }
 
-      # @!method initialize(id:, email:, links:, created_at: nil, updated_at: nil, type: :attendee)
+      # @!method initialize(id:, email:, organization: nil, person: nil, type: :meeting_attendee)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::Attendee} for more details.
+      #
       #   The Attendee object represents a participant in a meeting. It includes their
       #   email address and links to associated `Person` and `Organization` items, if they
       #   exist in your collections.
@@ -48,35 +46,11 @@ module Moonbase
       #
       #   @param email [String] The email address of the attendee.
       #
-      #   @param links [Moonbase::Models::Attendee::Links] A hash of related links.
-      #
-      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #   @param organization [Moonbase::Models::Pointer] A lightweight reference to another resource.
       #
-      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #   @param person [Moonbase::Models::Pointer] A lightweight reference to another resource.
       #
-      #   @param type [Symbol, :attendee] String representing the object’s type. Always `attendee` for this object.
-
-      # @see Moonbase::Models::Attendee#links
-      class Links < Moonbase::Internal::Type::BaseModel
-        # @!attribute organization
-        #   A link to the associated `Organization` item.
-        #
-        #   @return [String]
-        required :organization, String
-
-        # @!attribute person
-        #   A link to the associated `Person` item.
-        #
-        #   @return [String]
-        required :person, String
-
-        # @!method initialize(organization:, person:)
-        #   A hash of related links.
-        #
-        #   @param organization [String] A link to the associated `Organization` item.
-        #
-        #   @param person [String] A link to the associated `Person` item.
-      end
+      #   @param type [Symbol, :meeting_attendee] String representing the object’s type. Always `meeting_attendee` for this object
     end
   end
 end

data/lib/moonbase/models/boolean_field.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class BooleanField < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute cardinality
+      #   Specifies whether the field can hold a single value (`one`) or multiple values
+      #   (`many`).
+      #
+      #   @return [Symbol, Moonbase::Models::BooleanField::Cardinality]
+      required :cardinality, enum: -> { Moonbase::BooleanField::Cardinality }
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   The human-readable name of the field (e.g., "Is Active").
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute readonly
+      #   If `true`, the value of this field is system-managed and cannot be updated via
+      #   the API.
+      #
+      #   @return [Boolean]
+      required :readonly, Moonbase::Internal::Type::Boolean
+
+      # @!attribute ref
+      #   A unique, stable, machine-readable identifier for the field within its
+      #   collection (e.g., `is_active`).
+      #
+      #   @return [String]
+      required :ref, String
+
+      # @!attribute required
+      #   If `true`, this field must have a value.
+      #
+      #   @return [Boolean]
+      required :required, Moonbase::Internal::Type::Boolean
+
+      # @!attribute type
+      #   The data type of the field. Always `field/boolean` for this field.
+      #
+      #   @return [Symbol, :"field/boolean"]
+      required :type, const: :"field/boolean"
+
+      # @!attribute unique
+      #   If `true`, values for this field must be unique across all items in the
+      #   collection.
+      #
+      #   @return [Boolean]
+      required :unique, Moonbase::Internal::Type::Boolean
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   An optional, longer-form description of the field's purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(id:, cardinality:, created_at:, name:, readonly:, ref:, required:, unique:, updated_at:, description: nil, type: :"field/boolean")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::BooleanField} for more details.
+      #
+      #   A field that stores true or false values.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param cardinality [Symbol, Moonbase::Models::BooleanField::Cardinality] Specifies whether the field can hold a single value (`one`) or multiple values (
+      #
+      #   @param created_at [Time] Time at which the object was created, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param name [String] The human-readable name of the field (e.g., "Is Active").
+      #
+      #   @param readonly [Boolean] If `true`, the value of this field is system-managed and cannot be updated via t
+      #
+      #   @param ref [String] A unique, stable, machine-readable identifier for the field within its collectio
+      #
+      #   @param required [Boolean] If `true`, this field must have a value.
+      #
+      #   @param unique [Boolean] If `true`, values for this field must be unique across all items in the collecti
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an ISO 8601 timestamp in UTC.
+      #
+      #   @param description [String] An optional, longer-form description of the field's purpose.
+      #
+      #   @param type [Symbol, :"field/boolean"] The data type of the field. Always `field/boolean` for this field.
+
+      # Specifies whether the field can hold a single value (`one`) or multiple values
+      # (`many`).
+      #
+      # @see Moonbase::Models::BooleanField#cardinality
+      module Cardinality
+        extend Moonbase::Internal::Type::Enum
+
+        ONE = :one
+        MANY = :many
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/boolean_value.rb

@@ -3,20 +3,20 @@
 module Moonbase
   module Models
     class BooleanValue < Moonbase::Internal::Type::BaseModel
-      # @!attribute boolean
+      # @!attribute data
       #
       #   @return [Boolean]
-      required :boolean, Moonbase::Internal::Type::Boolean
+      required :data, Moonbase::Internal::Type::Boolean
 
       # @!attribute type
       #
       #   @return [Symbol, :"value/boolean"]
       required :type, const: :"value/boolean"
 
-      # @!method initialize(boolean:, type: :"value/boolean")
+      # @!method initialize(data:, type: :"value/boolean")
       #   True or false value
       #
-      #   @param boolean [Boolean]
+      #   @param data [Boolean]
       #   @param type [Symbol, :"value/boolean"]
     end
   end