moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/models/activity_list_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Activities#list
+    class ActivityListParams < 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::ActivityListParams} 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/activity_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Activities#retrieve
+    class ActivityRetrieveParams < 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/address.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Address < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email
+      #   The email address.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `address` for this object.
+      #
+      #   @return [Symbol, :address]
+      required :type, const: :address
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute links
+      #   A hash of related links.
+      #
+      #   @return [Moonbase::Models::Address::Links, nil]
+      optional :links, -> { Moonbase::Address::Links }
+
+      # @!attribute role
+      #   The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`,
+      #   or `bcc`.
+      #
+      #   @return [Symbol, Moonbase::Models::Address::Role, nil]
+      optional :role, enum: -> { Moonbase::Address::Role }
+
+      # @!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)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::Address} for more details.
+      #
+      #   The Address object represents a recipient or sender of a message. It contains an
+      #   email address and can be linked to a person and an organization in your
+      #   collections.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @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 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
+
+      # The role of the address in the message. Can be `from`, `reply_to`, `to`, `cc`,
+      # or `bcc`.
+      #
+      # @see Moonbase::Models::Address#role
+      module Role
+        extend Moonbase::Internal::Type::Enum
+
+        FROM = :from
+        REPLY_TO = :reply_to
+        TO = :to
+        CC = :cc
+        BCC = :bcc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/attendee.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Attendee < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email
+      #   The email address of the attendee.
+      #
+      #   @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.
+      #
+      #   @return [Symbol, :attendee]
+      required :type, const: :attendee
+
+      # @!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: :attendee)
+      #   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.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @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 updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @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
+    end
+  end
+end

data/lib/moonbase/models/boolean_value.rb

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

data/lib/moonbase/models/call.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Calls#create
+    class Call < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute direction
+      #   The direction of the call, either `incoming` or `outgoing`.
+      #
+      #   @return [Symbol, Moonbase::Models::Call::Direction]
+      required :direction, enum: -> { Moonbase::Call::Direction }
+
+      # @!attribute participants
+      #   The participants involved in the call.
+      #
+      #   @return [Array<Moonbase::Models::Call::Participant>]
+      required :participants, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Call::Participant] }
+
+      # @!attribute provider
+      #   The name of the phone provider that handled the call.
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute provider_id
+      #   The unique identifier for the call from the provider's system.
+      #
+      #   @return [String]
+      required :provider_id, String
+
+      # @!attribute start_at
+      #   The time the call started, as an RFC 3339 timestamp.
+      #
+      #   @return [Time]
+      required :start_at, Time
+
+      # @!attribute status
+      #   The current status of the call.
+      #
+      #   @return [Symbol, Moonbase::Models::Call::Status]
+      required :status, enum: -> { Moonbase::Call::Status }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `call` for this object.
+      #
+      #   @return [Symbol, :call]
+      required :type, const: :call
+
+      # @!attribute answered_at
+      #   The time the call was answered, if available, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :answered_at, Time
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute end_at
+      #   The time the call ended, if available, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :end_at, Time
+
+      # @!attribute provider_metadata
+      #   A hash of additional metadata from the provider.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :provider_metadata, Moonbase::Internal::Type::HashOf[Moonbase::Internal::Type::Unknown]
+
+      # @!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:, direction:, participants:, provider:, provider_id:, start_at:, status:, answered_at: nil, created_at: nil, end_at: nil, provider_metadata: nil, updated_at: nil, type: :call)
+      #   The Call object represents a phone call that has been logged in the system. It
+      #   contains details about the participants, timing, and outcome of the call.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param direction [Symbol, Moonbase::Models::Call::Direction] The direction of the call, either `incoming` or `outgoing`.
+      #
+      #   @param participants [Array<Moonbase::Models::Call::Participant>] The participants involved in the call.
+      #
+      #   @param provider [String] The name of the phone provider that handled the call.
+      #
+      #   @param provider_id [String] The unique identifier for the call from the provider's system.
+      #
+      #   @param start_at [Time] The time the call started, as an RFC 3339 timestamp.
+      #
+      #   @param status [Symbol, Moonbase::Models::Call::Status] The current status of the call.
+      #
+      #   @param answered_at [Time] The time the call was answered, if available, as an RFC 3339 timestamp.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param end_at [Time] The time the call ended, if available, as an RFC 3339 timestamp.
+      #
+      #   @param provider_metadata [Hash{Symbol=>Object}] A hash of additional metadata from the provider.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :call] String representing the object’s type. Always `call` for this object.
+
+      # The direction of the call, either `incoming` or `outgoing`.
+      #
+      # @see Moonbase::Models::Call#direction
+      module Direction
+        extend Moonbase::Internal::Type::Enum
+
+        INCOMING = :incoming
+        OUTGOING = :outgoing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Participant < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute phone
+        #   The E.164 formatted phone number of the participant.
+        #
+        #   @return [String]
+        required :phone, String
+
+        # @!attribute role
+        #   The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+        #
+        #   @return [Symbol, Moonbase::Models::Call::Participant::Role]
+        required :role, enum: -> { Moonbase::Call::Participant::Role }
+
+        # @!attribute type
+        #   String representing the object’s type. Always `participant` for this object.
+        #
+        #   @return [Symbol, :participant]
+        required :type, const: :participant
+
+        # @!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:, phone:, role:, created_at: nil, updated_at: nil, type: :participant)
+        #   Represents a participant in a call.
+        #
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param phone [String] The E.164 formatted phone number of the participant.
+        #
+        #   @param role [Symbol, Moonbase::Models::Call::Participant::Role] The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+        #
+        #   @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, :participant] String representing the object’s type. Always `participant` for this object.
+
+        # The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+        #
+        # @see Moonbase::Models::Call::Participant#role
+        module Role
+          extend Moonbase::Internal::Type::Enum
+
+          CALLER = :caller
+          CALLEE = :callee
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The current status of the call.
+      #
+      # @see Moonbase::Models::Call#status
+      module Status
+        extend Moonbase::Internal::Type::Enum
+
+        QUEUED = :queued
+        INITIATED = :initiated
+        RINGING = :ringing
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        BUSY = :busy
+        FAILED = :failed
+        NO_ANSWER = :no_answer
+        CANCELED = :canceled
+        MISSED = :missed
+        ANSWERED = :answered
+        FORWARDED = :forwarded
+        ABANDONED = :abandoned
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/call_create_params.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Calls#create
+    class CallCreateParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute direction
+      #   The direction of the call, either `incoming` or `outgoing`.
+      #
+      #   @return [Symbol, Moonbase::Models::CallCreateParams::Direction]
+      required :direction, enum: -> { Moonbase::CallCreateParams::Direction }
+
+      # @!attribute participants
+      #   An array of participants involved in the call.
+      #
+      #   @return [Array<Moonbase::Models::CallCreateParams::Participant>]
+      required :participants,
+               -> {
+                 Moonbase::Internal::Type::ArrayOf[Moonbase::CallCreateParams::Participant]
+               }
+
+      # @!attribute provider
+      #   The name of the phone provider that handled the call (e.g., `openphone`).
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute provider_id
+      #   The unique identifier for the call from the provider's system.
+      #
+      #   @return [String]
+      required :provider_id, String
+
+      # @!attribute start_at
+      #   The time the call started, as an RFC 3339 timestamp.
+      #
+      #   @return [Time]
+      required :start_at, Time
+
+      # @!attribute status
+      #   The status of the call.
+      #
+      #   @return [Symbol, Moonbase::Models::CallCreateParams::Status]
+      required :status, enum: -> { Moonbase::CallCreateParams::Status }
+
+      # @!attribute answered_at
+      #   The time the call was answered, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :answered_at, Time
+
+      # @!attribute end_at
+      #   The time the call ended, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :end_at, Time
+
+      # @!attribute provider_metadata
+      #   A hash of additional metadata from the provider.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :provider_metadata, Moonbase::Internal::Type::HashOf[Moonbase::Internal::Type::Unknown]
+
+      # @!method initialize(direction:, participants:, provider:, provider_id:, start_at:, status:, answered_at: nil, end_at: nil, provider_metadata: nil, request_options: {})
+      #   @param direction [Symbol, Moonbase::Models::CallCreateParams::Direction] The direction of the call, either `incoming` or `outgoing`.
+      #
+      #   @param participants [Array<Moonbase::Models::CallCreateParams::Participant>] An array of participants involved in the call.
+      #
+      #   @param provider [String] The name of the phone provider that handled the call (e.g., `openphone`).
+      #
+      #   @param provider_id [String] The unique identifier for the call from the provider's system.
+      #
+      #   @param start_at [Time] The time the call started, as an RFC 3339 timestamp.
+      #
+      #   @param status [Symbol, Moonbase::Models::CallCreateParams::Status] The status of the call.
+      #
+      #   @param answered_at [Time] The time the call was answered, as an RFC 3339 timestamp.
+      #
+      #   @param end_at [Time] The time the call ended, as an RFC 3339 timestamp.
+      #
+      #   @param provider_metadata [Hash{Symbol=>Object}] A hash of additional metadata from the provider.
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The direction of the call, either `incoming` or `outgoing`.
+      module Direction
+        extend Moonbase::Internal::Type::Enum
+
+        INCOMING = :incoming
+        OUTGOING = :outgoing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Participant < Moonbase::Internal::Type::BaseModel
+        # @!attribute phone
+        #   The E.164 formatted phone number of the participant.
+        #
+        #   @return [String]
+        required :phone, String
+
+        # @!attribute role
+        #   The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+        #
+        #   @return [Symbol, Moonbase::Models::CallCreateParams::Participant::Role]
+        required :role, enum: -> { Moonbase::CallCreateParams::Participant::Role }
+
+        # @!method initialize(phone:, role:)
+        #   Parameters for creating a `Participant` object.
+        #
+        #   @param phone [String] The E.164 formatted phone number of the participant.
+        #
+        #   @param role [Symbol, Moonbase::Models::CallCreateParams::Participant::Role] The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+
+        # The role of the participant in the call. Can be `caller`, `callee`, or `other`.
+        #
+        # @see Moonbase::Models::CallCreateParams::Participant#role
+        module Role
+          extend Moonbase::Internal::Type::Enum
+
+          CALLER = :caller
+          CALLEE = :callee
+          OTHER = :other
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The status of the call.
+      module Status
+        extend Moonbase::Internal::Type::Enum
+
+        QUEUED = :queued
+        INITIATED = :initiated
+        RINGING = :ringing
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+        BUSY = :busy
+        FAILED = :failed
+        NO_ANSWER = :no_answer
+        CANCELED = :canceled
+        MISSED = :missed
+        ANSWERED = :answered
+        FORWARDED = :forwarded
+        ABANDONED = :abandoned
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/choice.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class Choice < Moonbase::Internal::Type::BaseModel
+      # @!attribute option
+      #
+      #   @return [Moonbase::Models::Choice::Option]
+      required :option, -> { Moonbase::Choice::Option }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/choice"]
+      required :type, const: :"value/choice"
+
+      # @!method initialize(option:, type: :"value/choice")
+      #   Selected choice option
+      #
+      #   @param option [Moonbase::Models::Choice::Option]
+      #   @param type [Symbol, :"value/choice"]
+
+      # @see Moonbase::Models::Choice#option
+      class Option < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :field_option]
+        required :type, const: :field_option
+
+        # @!attribute label
+        #
+        #   @return [String, nil]
+        optional :label, String
+
+        # @!method initialize(id:, label: nil, type: :field_option)
+        #   @param id [String]
+        #   @param label [String]
+        #   @param type [Symbol, :field_option]
+      end
+    end
+  end
+end