moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/models/monetary_value.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class MonetaryValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute amount
+      #
+      #   @return [Moonbase::Models::MonetaryValue::Amount]
+      required :amount, -> { Moonbase::MonetaryValue::Amount }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/number/monetary"]
+      required :type, const: :"value/number/monetary"
+
+      # @!method initialize(amount:, type: :"value/number/monetary")
+      #   Monetary or currency value
+      #
+      #   @param amount [Moonbase::Models::MonetaryValue::Amount]
+      #   @param type [Symbol, :"value/number/monetary"]
+
+      # @see Moonbase::Models::MonetaryValue#amount
+      class Amount < Moonbase::Internal::Type::BaseModel
+        # @!attribute amount_in_minor_units
+        #
+        #   @return [Integer]
+        required :amount_in_minor_units, Integer
+
+        # @!attribute currency
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :currency]
+        required :type, const: :currency
+
+        # @!method initialize(amount_in_minor_units:, currency:, type: :currency)
+        #   @param amount_in_minor_units [Integer]
+        #   @param currency [String]
+        #   @param type [Symbol, :currency]
+      end
+    end
+  end
+end

data/lib/moonbase/models/moonbase_file.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Files#retrieve
+    class MoonbaseFile < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute filename
+      #   The original filename of the uploaded file.
+      #
+      #   @return [String]
+      required :filename, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::MoonbaseFile::Links]
+      required :links, -> { Moonbase::MoonbaseFile::Links }
+
+      # @!attribute name
+      #   The display name of the file.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute size
+      #   The size of the file in bytes.
+      #
+      #   @return [Float]
+      required :size, Float
+
+      # @!attribute type
+      #   String representing the object’s type. Always `file` for this object.
+      #
+      #   @return [Symbol, :file]
+      required :type, const: :file
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!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:, filename:, links:, name:, size:, created_at: nil, updated_at: nil, type: :file)
+      #   The File object represents a file that has been uploaded to your library.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param filename [String] The original filename of the uploaded file.
+      #
+      #   @param links [Moonbase::Models::MoonbaseFile::Links]
+      #
+      #   @param name [String] The display name of the file.
+      #
+      #   @param size [Float] The size of the file in bytes.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :file] String representing the object’s type. Always `file` for this object.
+
+      # @see Moonbase::Models::MoonbaseFile#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute download_url
+        #   A temporary, signed URL to download the file content. The URL expires after one
+        #   hour.
+        #
+        #   @return [String]
+        required :download_url, String
+
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(download_url:, self_:)
+        #   Some parameter documentations has been truncated, see
+        #   {Moonbase::Models::MoonbaseFile::Links} for more details.
+        #
+        #   @param download_url [String] A temporary, signed URL to download the file content. The URL expires after one
+        #
+        #   @param self_ [String] The canonical URL for this object.
+      end
+    end
+  end
+end

data/lib/moonbase/models/multi_line_text_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class MultiLineTextValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/text/multi_line"]
+      required :type, const: :"value/text/multi_line"
+
+      # @!method initialize(text:, type: :"value/text/multi_line")
+      #   Multiple lines of text
+      #
+      #   @param text [String]
+      #   @param type [Symbol, :"value/text/multi_line"]
+    end
+  end
+end

data/lib/moonbase/models/note.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Notes#retrieve
+    class Note < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::Note::Links]
+      required :links, -> { Moonbase::Note::Links }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `note` for this object.
+      #
+      #   @return [Symbol, :note]
+      required :type, const: :note
+
+      # @!attribute body
+      #   The main content of the note.
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute summary
+      #   A short, system-generated summary of the note's content.
+      #
+      #   @return [String, nil]
+      optional :summary, String
+
+      # @!attribute title
+      #   An optional title for the note.
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!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:, links:, body: nil, created_at: nil, summary: nil, title: nil, updated_at: nil, type: :note)
+      #   The Note object represents a block of text content, often used for meeting notes
+      #   or summaries.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::Note::Links]
+      #
+      #   @param body [String] The main content of the note.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param summary [String] A short, system-generated summary of the note's content.
+      #
+      #   @param title [String] An optional title for the note.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :note] String representing the object’s type. Always `note` for this object.
+
+      # @see Moonbase::Models::Note#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(self_:)
+        #   @param self_ [String] The canonical URL for this object.
+      end
+    end
+  end
+end

data/lib/moonbase/models/note_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Notes#list
+    class NoteListParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   When specified, returns results starting immediately after the item identified
+      #   by this cursor. Use the cursor value from the previous response's metadata to
+      #   fetch the next page of results.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   When specified, returns results starting immediately before the item identified
+      #   by this cursor. Use the cursor value from the response's metadata to fetch the
+      #   previous page of results.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute limit
+      #   Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #   to 20 if not specified.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, before: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::NoteListParams} for more details.
+      #
+      #   @param after [String] When specified, returns results starting immediately after the item identified b
+      #
+      #   @param before [String] When specified, returns results starting immediately before the item identified
+      #
+      #   @param limit [Integer] Maximum number of items to return per page. Must be between 1 and 100. Defaults
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moonbase/models/note_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Notes#retrieve
+    class NoteRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/moonbase/models/organizer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Organizer < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email
+      #   The email address of the organizer.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::Organizer::Links]
+      required :links, -> { Moonbase::Organizer::Links }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `organizer` for this object.
+      #
+      #   @return [Symbol, :organizer]
+      required :type, const: :organizer
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!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:, links:, created_at: nil, updated_at: nil, type: :organizer)
+      #   Represents the organizer of a meeting.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param email [String] The email address of the organizer.
+      #
+      #   @param links [Moonbase::Models::Organizer::Links]
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :organizer] String representing the object’s type. Always `organizer` for this object.
+
+      # @see Moonbase::Models::Organizer#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:)
+        #   @param organization [String] A link to the associated `Organization` item.
+        #
+        #   @param person [String] A link to the associated `Person` item.
+      end
+    end
+  end
+end

data/lib/moonbase/models/percentage_value.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class PercentageValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute percentage
+      #
+      #   @return [Float]
+      required :percentage, Float
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/number/percentage"]
+      required :type, const: :"value/number/percentage"
+
+      # @!method initialize(percentage:, type: :"value/number/percentage")
+      #   Percentage numeric value
+      #
+      #   @param percentage [Float]
+      #   @param type [Symbol, :"value/number/percentage"]
+    end
+  end
+end

data/lib/moonbase/models/program.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Programs#retrieve
+    class Program < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::Program::Links]
+      required :links, -> { Moonbase::Program::Links }
+
+      # @!attribute status
+      #   The current status of the program. Can be `draft`, `published`, `paused`, or
+      #   `archived`.
+      #
+      #   @return [Symbol, Moonbase::Models::Program::Status]
+      required :status, enum: -> { Moonbase::Program::Status }
+
+      # @!attribute trigger
+      #   The sending trigger for the program. Can be `api` for transactional sends or
+      #   `broadcast` for scheduled sends.
+      #
+      #   @return [Symbol, Moonbase::Models::Program::Trigger]
+      required :trigger, enum: -> { Moonbase::Program::Trigger }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `program` for this object.
+      #
+      #   @return [Symbol, :program]
+      required :type, const: :program
+
+      # @!attribute activity_metrics
+      #   A `ProgramActivityMetrics` object summarizing engagement for this program.
+      #
+      #   @return [Moonbase::Models::Program::ActivityMetrics, nil]
+      optional :activity_metrics, -> { Moonbase::Program::ActivityMetrics }
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute display_name
+      #   The user-facing name of the program.
+      #
+      #   @return [String, nil]
+      optional :display_name, String
+
+      # @!attribute program_template
+      #   The `ProgramTemplate` used for messages in this program.
+      #
+      #   @return [Moonbase::Models::ProgramTemplate, nil]
+      optional :program_template, -> { Moonbase::ProgramTemplate }
+
+      # @!attribute scheduled_at
+      #   For `broadcast` programs, the time the program is scheduled to send, as an RFC
+      #   3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time
+
+      # @!attribute track_clicks
+      #   `true` if link clicks are tracked for this program.
+      #
+      #   @return [Boolean, nil]
+      optional :track_clicks, Moonbase::Internal::Type::Boolean
+
+      # @!attribute track_opens
+      #   `true` if email opens are tracked for this program.
+      #
+      #   @return [Boolean, nil]
+      optional :track_opens, Moonbase::Internal::Type::Boolean
+
+      # @!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:, links:, status:, trigger:, activity_metrics: nil, created_at: nil, display_name: nil, program_template: nil, scheduled_at: nil, track_clicks: nil, track_opens: nil, updated_at: nil, type: :program)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::Program} for more details.
+      #
+      #   The Program object represents an email campaign. It defines the sending behavior
+      #   and tracks engagement metrics.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::Program::Links]
+      #
+      #   @param status [Symbol, Moonbase::Models::Program::Status] The current status of the program. Can be `draft`, `published`, `paused`, or `ar
+      #
+      #   @param trigger [Symbol, Moonbase::Models::Program::Trigger] The sending trigger for the program. Can be `api` for transactional sends or `br
+      #
+      #   @param activity_metrics [Moonbase::Models::Program::ActivityMetrics] A `ProgramActivityMetrics` object summarizing engagement for this program.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param display_name [String] The user-facing name of the program.
+      #
+      #   @param program_template [Moonbase::Models::ProgramTemplate] The `ProgramTemplate` used for messages in this program.
+      #
+      #   @param scheduled_at [Time] For `broadcast` programs, the time the program is scheduled to send, as an RFC 3
+      #
+      #   @param track_clicks [Boolean] `true` if link clicks are tracked for this program.
+      #
+      #   @param track_opens [Boolean] `true` if email opens are tracked for this program.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :program] String representing the object’s type. Always `program` for this object.
+
+      # @see Moonbase::Models::Program#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute program_template
+        #   A link to the `ProgramTemplate` for this program.
+        #
+        #   @return [String]
+        required :program_template, String
+
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!method initialize(program_template:, self_:)
+        #   @param program_template [String] A link to the `ProgramTemplate` for this program.
+        #
+        #   @param self_ [String] The canonical URL for this object.
+      end
+
+      # The current status of the program. Can be `draft`, `published`, `paused`, or
+      # `archived`.
+      #
+      # @see Moonbase::Models::Program#status
+      module Status
+        extend Moonbase::Internal::Type::Enum
+
+        DRAFT = :draft
+        PUBLISHED = :published
+        PAUSED = :paused
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The sending trigger for the program. Can be `api` for transactional sends or
+      # `broadcast` for scheduled sends.
+      #
+      # @see Moonbase::Models::Program#trigger
+      module Trigger
+        extend Moonbase::Internal::Type::Enum
+
+        API = :api
+        BROADCAST = :broadcast
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Moonbase::Models::Program#activity_metrics
+      class ActivityMetrics < Moonbase::Internal::Type::BaseModel
+        # @!attribute bounced
+        #   The number of emails that could not be delivered.
+        #
+        #   @return [Integer, nil]
+        optional :bounced, Integer
+
+        # @!attribute clicked
+        #   The number of recipients who clicked at least one link.
+        #
+        #   @return [Integer, nil]
+        optional :clicked, Integer
+
+        # @!attribute complained
+        #   The number of recipients who marked the email as spam.
+        #
+        #   @return [Integer, nil]
+        optional :complained, Integer
+
+        # @!attribute failed
+        #   The number of emails that failed to send due to a technical issue.
+        #
+        #   @return [Integer, nil]
+        optional :failed, Integer
+
+        # @!attribute opened
+        #   The number of recipients who opened the email.
+        #
+        #   @return [Integer, nil]
+        optional :opened, Integer
+
+        # @!attribute sent
+        #   The total number of emails successfully sent.
+        #
+        #   @return [Integer, nil]
+        optional :sent, Integer
+
+        # @!attribute shielded
+        #   The number of emails blocked by delivery protection rules.
+        #
+        #   @return [Integer, nil]
+        optional :shielded, Integer
+
+        # @!attribute unsubscribed
+        #   The number of recipients who unsubscribed.
+        #
+        #   @return [Integer, nil]
+        optional :unsubscribed, Integer
+
+        # @!method initialize(bounced: nil, clicked: nil, complained: nil, failed: nil, opened: nil, sent: nil, shielded: nil, unsubscribed: nil)
+        #   A `ProgramActivityMetrics` object summarizing engagement for this program.
+        #
+        #   @param bounced [Integer] The number of emails that could not be delivered.
+        #
+        #   @param clicked [Integer] The number of recipients who clicked at least one link.
+        #
+        #   @param complained [Integer] The number of recipients who marked the email as spam.
+        #
+        #   @param failed [Integer] The number of emails that failed to send due to a technical issue.
+        #
+        #   @param opened [Integer] The number of recipients who opened the email.
+        #
+        #   @param sent [Integer] The total number of emails successfully sent.
+        #
+        #   @param shielded [Integer] The number of emails blocked by delivery protection rules.
+        #
+        #   @param unsubscribed [Integer] The number of recipients who unsubscribed.
+      end
+    end
+  end
+end