moonbase-sdk 0.1.0.pre.alpha.1

data/lib/moonbase/models/program_list_params.rb

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::ProgramMessages#create
+    class ProgramMessageCreateParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute person
+      #   The person to send the message to.
+      #
+      #   @return [Moonbase::Models::ProgramMessageCreateParams::Person]
+      required :person, -> { Moonbase::ProgramMessageCreateParams::Person }
+
+      # @!attribute program_template_id
+      #   The ID of the `ProgramTemplate` to use for sending the message.
+      #
+      #   @return [String]
+      required :program_template_id, String
+
+      # @!attribute custom_variables
+      #   Any custom Liquid variables to be interpolated into the message template.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :custom_variables, Moonbase::Internal::Type::HashOf[Moonbase::Internal::Type::Unknown]
+
+      # @!method initialize(person:, program_template_id:, custom_variables: nil, request_options: {})
+      #   @param person [Moonbase::Models::ProgramMessageCreateParams::Person] The person to send the message to.
+      #
+      #   @param program_template_id [String] The ID of the `ProgramTemplate` to use for sending the message.
+      #
+      #   @param custom_variables [Hash{Symbol=>Object}] Any custom Liquid variables to be interpolated into the message template.
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Person < Moonbase::Internal::Type::BaseModel
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!method initialize(email:)
+        #   The person to send the message to.
+        #
+        #   @param email [String]
+      end
+    end
+  end
+end

data/lib/moonbase/models/program_message_create_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::ProgramMessages#create
+    class ProgramMessageCreateResponse < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Time at which the message was created and enqueued for sending, as an RFC 3339
+      #   timestamp.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::ProgramMessageCreateResponse::Links]
+      required :links, -> { Moonbase::Models::ProgramMessageCreateResponse::Links }
+
+      # @!attribute program_template
+      #   The `ProgramTemplate` used to generate this message.
+      #
+      #   @return [Moonbase::Models::ProgramTemplate]
+      required :program_template, -> { Moonbase::ProgramTemplate }
+
+      # @!attribute type
+      #   String representing the object’s type. Always `program_message` for this object.
+      #
+      #   @return [Symbol, :program_message]
+      required :type, const: :program_message
+
+      # @!attribute updated_at
+      #   Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, created_at:, links:, program_template:, updated_at:, type: :program_message)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ProgramMessageCreateResponse} for more details.
+      #
+      #   Represents a single message sent as part of a `Program`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param created_at [Time] Time at which the message was created and enqueued for sending, as an RFC 3339 t
+      #
+      #   @param links [Moonbase::Models::ProgramMessageCreateResponse::Links]
+      #
+      #   @param program_template [Moonbase::Models::ProgramTemplate] The `ProgramTemplate` used to generate this message.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :program_message] String representing the object’s type. Always `program_message` for this object.
+
+      # @see Moonbase::Models::ProgramMessageCreateResponse#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute program_template
+        #   A link to the `ProgramTemplate` used.
+        #
+        #   @return [String]
+        required :program_template, String
+
+        # @!method initialize(program_template:)
+        #   @param program_template [String] A link to the `ProgramTemplate` used.
+      end
+    end
+  end
+end

data/lib/moonbase/models/program_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Programs#retrieve
+    class ProgramRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid options are
+      #   `activity_metrics` and `program_template`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::ProgramRetrieveParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::ProgramRetrieveParams::Include] }
+
+      # @!method initialize(include: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ProgramRetrieveParams} for more details.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::ProgramRetrieveParams::Include>] Specifies which related objects to include in the response. Valid options are `a
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        ACTIVITY_METRICS = :activity_metrics
+        PROGRAM_TEMPLATE = :program_template
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/program_template.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::ProgramTemplates#retrieve
+    class ProgramTemplate < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute body
+      #   The body content of the email, which can include Liquid variables.
+      #
+      #   @return [String]
+      required :body, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::ProgramTemplate::Links]
+      required :links, -> { Moonbase::ProgramTemplate::Links }
+
+      # @!attribute subject
+      #   The subject line of the email, which can include Liquid variables.
+      #
+      #   @return [String]
+      required :subject, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `program_template` for this
+      #   object.
+      #
+      #   @return [Symbol, :program_template]
+      required :type, const: :program_template
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute program
+      #   The `Program` that uses this template.
+      #
+      #   @return [Moonbase::Models::Program, nil]
+      optional :program, -> { Moonbase::Program }
+
+      # @!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:, body:, links:, subject:, created_at: nil, program: nil, updated_at: nil, type: :program_template)
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ProgramTemplate} for more details.
+      #
+      #   The ProgramTemplate object defines the content of a message sent by a `Program`,
+      #   including support for Liquid templating.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param body [String] The body content of the email, which can include Liquid variables.
+      #
+      #   @param links [Moonbase::Models::ProgramTemplate::Links]
+      #
+      #   @param subject [String] The subject line of the email, which can include Liquid variables.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param program [Moonbase::Models::Program] The `Program` that uses this template.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :program_template] String representing the object’s type. Always `program_template` for this object
+
+      # @see Moonbase::Models::ProgramTemplate#links
+      class Links < Moonbase::Internal::Type::BaseModel
+        # @!attribute self_
+        #   The canonical URL for this object.
+        #
+        #   @return [String]
+        required :self_, String, api_name: :self
+
+        # @!attribute program
+        #   A link to the `Program` using this template.
+        #
+        #   @return [String, nil]
+        optional :program, String
+
+        # @!method initialize(self_:, program: nil)
+        #   @param self_ [String] The canonical URL for this object.
+        #
+        #   @param program [String] A link to the `Program` using this template.
+      end
+    end
+  end
+end

data/lib/moonbase/models/program_template_list_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::ProgramTemplates#list
+    class ProgramTemplateListParams < 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 include
+      #   Specifies which related objects to include in the response. Valid option is
+      #   `program`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::ProgramTemplateListParams::Include>, nil]
+      optional :include,
+               -> { Moonbase::Internal::Type::ArrayOf[enum: Moonbase::ProgramTemplateListParams::Include] }
+
+      # @!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, include: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ProgramTemplateListParams} 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 include [Array<Symbol, Moonbase::Models::ProgramTemplateListParams::Include>] Specifies which related objects to include in the response. Valid option is `pro
+      #
+      #   @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}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        PROGRAM = :program
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/program_template_retrieve_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::ProgramTemplates#retrieve
+    class ProgramTemplateRetrieveParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute include
+      #   Specifies which related objects to include in the response. Valid option is
+      #   `program`.
+      #
+      #   @return [Array<Symbol, Moonbase::Models::ProgramTemplateRetrieveParams::Include>, nil]
+      optional :include,
+               -> {
+                 Moonbase::Internal::Type::ArrayOf[enum: Moonbase::ProgramTemplateRetrieveParams::Include]
+               }
+
+      # @!method initialize(include: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::ProgramTemplateRetrieveParams} for more details.
+      #
+      #   @param include [Array<Symbol, Moonbase::Models::ProgramTemplateRetrieveParams::Include>] Specifies which related objects to include in the response. Valid option is `pro
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Moonbase::Internal::Type::Enum
+
+        PROGRAM = :program
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/moonbase/models/relation_value.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class RelationValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute item
+      #   An Item represents a single record or row within a Collection. It holds a set of
+      #   `values` corresponding to the Collection's `fields`.
+      #
+      #   @return [Moonbase::Models::Item]
+      required :item, -> { Moonbase::Item }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/relation"]
+      required :type, const: :"value/relation"
+
+      # @!method initialize(item:, type: :"value/relation")
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::RelationValue} for more details.
+      #
+      #   Related item reference
+      #
+      #   @param item [Moonbase::Models::Item] An Item represents a single record or row within a Collection. It holds a set of
+      #
+      #   @param type [Symbol, :"value/relation"]
+    end
+  end
+end

data/lib/moonbase/models/single_line_text_value.rb

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

data/lib/moonbase/models/social_linked_in_value.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class SocialLinkedInValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute profile
+      #
+      #   @return [Moonbase::Models::SocialLinkedInValue::Profile]
+      required :profile, -> { Moonbase::SocialLinkedInValue::Profile }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/uri/social_linked_in"]
+      required :type, const: :"value/uri/social_linked_in"
+
+      # @!method initialize(profile:, type: :"value/uri/social_linked_in")
+      #   LinkedIn profile link
+      #
+      #   @param profile [Moonbase::Models::SocialLinkedInValue::Profile]
+      #   @param type [Symbol, :"value/uri/social_linked_in"]
+
+      # @see Moonbase::Models::SocialLinkedInValue#profile
+      class Profile < Moonbase::Internal::Type::BaseModel
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute username
+        #
+        #   @return [String, nil]
+        optional :username, String
+
+        # @!method initialize(url: nil, username: nil)
+        #   @param url [String]
+        #   @param username [String]
+      end
+    end
+  end
+end

data/lib/moonbase/models/social_x_value.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    class SocialXValue < Moonbase::Internal::Type::BaseModel
+      # @!attribute profile
+      #
+      #   @return [Moonbase::Models::SocialXValue::Profile]
+      required :profile, -> { Moonbase::SocialXValue::Profile }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :"value/uri/social_x"]
+      required :type, const: :"value/uri/social_x"
+
+      # @!method initialize(profile:, type: :"value/uri/social_x")
+      #   X (formerly Twitter) username
+      #
+      #   @param profile [Moonbase::Models::SocialXValue::Profile]
+      #   @param type [Symbol, :"value/uri/social_x"]
+
+      # @see Moonbase::Models::SocialXValue#profile
+      class Profile < Moonbase::Internal::Type::BaseModel
+        # @!attribute url
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!attribute username
+        #
+        #   @return [String, nil]
+        optional :username, String
+
+        # @!method initialize(url: nil, username: nil)
+        #   @param url [String]
+        #   @param username [String]
+      end
+    end
+  end
+end

data/lib/moonbase/models/tagset.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Tagsets#retrieve
+    class Tagset < Moonbase::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute links
+      #
+      #   @return [Moonbase::Models::Tagset::Links]
+      required :links, -> { Moonbase::Tagset::Links }
+
+      # @!attribute name
+      #   The name of the tagset.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute type
+      #   String representing the object’s type. Always `tagset` for this object.
+      #
+      #   @return [Symbol, :tagset]
+      required :type, const: :tagset
+
+      # @!attribute created_at
+      #   Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   An optional description of the tagset's purpose.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute tags
+      #   A list of `Tag` objects belonging to this tagset.
+      #
+      #   @return [Array<Moonbase::Models::Tagset::Tag>, nil]
+      optional :tags, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Tagset::Tag] }
+
+      # @!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:, name:, created_at: nil, description: nil, tags: nil, updated_at: nil, type: :tagset)
+      #   A Tagset is a collection of `Tag` objects that can be applied within a specific
+      #   `Inbox`.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param links [Moonbase::Models::Tagset::Links]
+      #
+      #   @param name [String] The name of the tagset.
+      #
+      #   @param created_at [Time] Time at which the object was created, as an RFC 3339 timestamp.
+      #
+      #   @param description [String] An optional description of the tagset's purpose.
+      #
+      #   @param tags [Array<Moonbase::Models::Tagset::Tag>] A list of `Tag` objects belonging to this tagset.
+      #
+      #   @param updated_at [Time] Time at which the object was last updated, as an RFC 3339 timestamp.
+      #
+      #   @param type [Symbol, :tagset] String representing the object’s type. Always `tagset` for this object.
+
+      # @see Moonbase::Models::Tagset#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
+
+      class Tag < Moonbase::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the tag.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   String representing the object’s type. Always `tag` for this object.
+        #
+        #   @return [Symbol, :tag]
+        required :type, const: :tag
+
+        # @!method initialize(id:, name:, type: :tag)
+        #   A Tag is a label that can be applied to `Conversation` objects for organization
+        #   and filtering.
+        #
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param name [String] The name of the tag.
+        #
+        #   @param type [Symbol, :tag] String representing the object’s type. Always `tag` for this object.
+      end
+    end
+  end
+end