notiflows 0.0.1

data/lib/notiflows/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Internal
+    extend Notiflows::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Notiflows::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Notiflows::FilePart) }
+    end
+  end
+end

data/lib/notiflows/models/delivery.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Deliveries#retrieve
+    class Delivery < Notiflows::Internal::Type::BaseModel
+      # @!attribute id
+      #   Delivery ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channel_type
+      #   Type of channel used for this delivery
+      #
+      #   @return [Symbol, Notiflows::Models::Delivery::ChannelType]
+      required :channel_type, enum: -> { Notiflows::Delivery::ChannelType }
+
+      # @!attribute created_at
+      #   When the delivery was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute notification_id
+      #   ID of the parent notification
+      #
+      #   @return [String]
+      required :notification_id, String
+
+      # @!attribute notiflow_id
+      #   ID of the notiflow
+      #
+      #   @return [String]
+      required :notiflow_id, String
+
+      # @!attribute recipient_id
+      #   Internal ID of the recipient
+      #
+      #   @return [String]
+      required :recipient_id, String
+
+      # @!attribute status
+      #   Delivery status:
+      #
+      #   - `pending`: Queued for sending
+      #   - `sent`: Successfully sent to the provider
+      #   - `failed`: Delivery failed
+      #
+      #   @return [Symbol, Notiflows::Models::Delivery::Status]
+      required :status, enum: -> { Notiflows::Delivery::Status }
+
+      # @!attribute updated_at
+      #   When the delivery was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute actor_id
+      #   Internal ID of the actor
+      #
+      #   @return [String, nil]
+      optional :actor_id, String, nil?: true
+
+      # @!attribute archived_at
+      #   When the recipient archived it
+      #
+      #   @return [Time, nil]
+      optional :archived_at, Time, nil?: true
+
+      # @!attribute channel_id
+      #   ID of the channel used for delivery
+      #
+      #   @return [String, nil]
+      optional :channel_id, String, nil?: true
+
+      # @!attribute clicked_at
+      #   When the recipient clicked/interacted
+      #
+      #   @return [Time, nil]
+      optional :clicked_at, Time, nil?: true
+
+      # @!attribute data
+      #   Rendered notification content (varies by channel type)
+      #
+      #   @return [Object, nil]
+      optional :data, Notiflows::Internal::Type::Unknown
+
+      # @!attribute read_at
+      #   When the recipient marked it as read
+      #
+      #   @return [Time, nil]
+      optional :read_at, Time, nil?: true
+
+      # @!attribute seen_at
+      #   When the recipient saw the notification
+      #
+      #   @return [Time, nil]
+      optional :seen_at, Time, nil?: true
+
+      # @!attribute sent_at
+      #   When the delivery was sent to the provider
+      #
+      #   @return [Time, nil]
+      optional :sent_at, Time, nil?: true
+
+      # @!attribute topic
+      #   Topic name if triggered via topic
+      #
+      #   @return [String, nil]
+      optional :topic, String, nil?: true
+
+      # @!method initialize(id:, channel_type:, created_at:, notification_id:, notiflow_id:, recipient_id:, status:, updated_at:, actor_id: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, read_at: nil, seen_at: nil, sent_at: nil, topic: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Notiflows::Models::Delivery} for more details.
+      #
+      #   A single delivery attempt through a specific channel
+      #
+      #   @param id [String] Delivery ID
+      #
+      #   @param channel_type [Symbol, Notiflows::Models::Delivery::ChannelType] Type of channel used for this delivery
+      #
+      #   @param created_at [Time] When the delivery was created
+      #
+      #   @param notification_id [String] ID of the parent notification
+      #
+      #   @param notiflow_id [String] ID of the notiflow
+      #
+      #   @param recipient_id [String] Internal ID of the recipient
+      #
+      #   @param status [Symbol, Notiflows::Models::Delivery::Status] Delivery status:
+      #
+      #   @param updated_at [Time] When the delivery was last updated
+      #
+      #   @param actor_id [String, nil] Internal ID of the actor
+      #
+      #   @param archived_at [Time, nil] When the recipient archived it
+      #
+      #   @param channel_id [String, nil] ID of the channel used for delivery
+      #
+      #   @param clicked_at [Time, nil] When the recipient clicked/interacted
+      #
+      #   @param data [Object] Rendered notification content (varies by channel type)
+      #
+      #   @param read_at [Time, nil] When the recipient marked it as read
+      #
+      #   @param seen_at [Time, nil] When the recipient saw the notification
+      #
+      #   @param sent_at [Time, nil] When the delivery was sent to the provider
+      #
+      #   @param topic [String, nil] Topic name if triggered via topic
+
+      # Type of channel used for this delivery
+      #
+      # @see Notiflows::Models::Delivery#channel_type
+      module ChannelType
+        extend Notiflows::Internal::Type::Enum
+
+        IN_APP = :in_app
+        EMAIL = :email
+        SMS = :sms
+        CHAT = :chat
+        WEB_PUSH = :web_push
+        MOBILE_PUSH = :mobile_push
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Delivery status:
+      #
+      # - `pending`: Queued for sending
+      # - `sent`: Successfully sent to the provider
+      # - `failed`: Delivery failed
+      #
+      # @see Notiflows::Models::Delivery#status
+      module Status
+        extend Notiflows::Internal::Type::Enum
+
+        PENDING = :pending
+        SENT = :sent
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/notiflows/models/delivery_list_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Deliveries#list
+    class DeliveryListParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for fetching the next page
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for fetching the previous page
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute channel_id
+      #   Filter by channel ID (UUID)
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute created_after
+      #   Filter by created after (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_after, String
+
+      # @!attribute created_before
+      #   Filter by created before (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_before, String
+
+      # @!attribute limit
+      #   Number of items per page (default: 25, max: 1000)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Filter by status (pending, sent, failed)
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute topic
+      #   Filter by topic name
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(after: nil, before: nil, channel_id: nil, created_after: nil, created_before: nil, limit: nil, status: nil, topic: nil, request_options: {})
+      #   @param after [String] Cursor for fetching the next page
+      #
+      #   @param before [String] Cursor for fetching the previous page
+      #
+      #   @param channel_id [String] Filter by channel ID (UUID)
+      #
+      #   @param created_after [String] Filter by created after (ISO 8601 datetime)
+      #
+      #   @param created_before [String] Filter by created before (ISO 8601 datetime)
+      #
+      #   @param limit [Integer] Number of items per page (default: 25, max: 1000)
+      #
+      #   @param status [String] Filter by status (pending, sent, failed)
+      #
+      #   @param topic [String] Filter by topic name
+      #
+      #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/notiflows/models/delivery_retrieve_params.rb

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

data/lib/notiflows/models/notification.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Notifications#retrieve
+    class Notification < Notiflows::Internal::Type::BaseModel
+      # @!attribute id
+      #   Notification ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the notification was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute data
+      #   Template variables passed when running the notiflow
+      #
+      #   @return [Object]
+      required :data, Notiflows::Internal::Type::Unknown
+
+      # @!attribute notiflow_id
+      #   ID of the notiflow that generated this notification
+      #
+      #   @return [String]
+      required :notiflow_id, String
+
+      # @!attribute notiflow_run_id
+      #   ID of the specific notiflow run
+      #
+      #   @return [String]
+      required :notiflow_run_id, String
+
+      # @!attribute recipient_id
+      #   Internal ID of the recipient user
+      #
+      #   @return [String]
+      required :recipient_id, String
+
+      # @!attribute status
+      #   Notification processing status:
+      #
+      #   - `pending`: Queued for processing
+      #   - `processing`: Currently being processed
+      #   - `processed`: Successfully processed (deliveries created)
+      #   - `failed`: Processing failed
+      #
+      #   @return [Symbol, Notiflows::Models::Notification::Status]
+      required :status, enum: -> { Notiflows::Notification::Status }
+
+      # @!attribute updated_at
+      #   When the notification was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute actor
+      #   A user (recipient) in your project
+      #
+      #   @return [Notiflows::Models::User, nil]
+      optional :actor, -> { Notiflows::User }, nil?: true
+
+      # @!attribute actor_id
+      #   Internal ID of the actor (user who triggered the notification)
+      #
+      #   @return [String, nil]
+      optional :actor_id, String, nil?: true
+
+      # @!attribute deliveries
+      #   Delivery attempts for this notification (when expanded)
+      #
+      #   @return [Array<Notiflows::Models::Delivery>, nil]
+      optional :deliveries, -> { Notiflows::Internal::Type::ArrayOf[Notiflows::Delivery] }
+
+      # @!attribute processed_at
+      #   When the notification was processed
+      #
+      #   @return [Time, nil]
+      optional :processed_at, Time, nil?: true
+
+      # @!attribute recipient
+      #   A user (recipient) in your project
+      #
+      #   @return [Notiflows::Models::User, nil]
+      optional :recipient, -> { Notiflows::User }
+
+      # @!attribute topic
+      #   Topic name if triggered via topic
+      #
+      #   @return [String, nil]
+      optional :topic, String, nil?: true
+
+      # @!method initialize(id:, created_at:, data:, notiflow_id:, notiflow_run_id:, recipient_id:, status:, updated_at:, actor: nil, actor_id: nil, deliveries: nil, processed_at: nil, recipient: nil, topic: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Notiflows::Models::Notification} for more details.
+      #
+      #   A notification sent to a recipient through a notiflow run
+      #
+      #   @param id [String] Notification ID
+      #
+      #   @param created_at [Time] When the notification was created
+      #
+      #   @param data [Object] Template variables passed when running the notiflow
+      #
+      #   @param notiflow_id [String] ID of the notiflow that generated this notification
+      #
+      #   @param notiflow_run_id [String] ID of the specific notiflow run
+      #
+      #   @param recipient_id [String] Internal ID of the recipient user
+      #
+      #   @param status [Symbol, Notiflows::Models::Notification::Status] Notification processing status:
+      #
+      #   @param updated_at [Time] When the notification was last updated
+      #
+      #   @param actor [Notiflows::Models::User, nil] A user (recipient) in your project
+      #
+      #   @param actor_id [String, nil] Internal ID of the actor (user who triggered the notification)
+      #
+      #   @param deliveries [Array<Notiflows::Models::Delivery>] Delivery attempts for this notification (when expanded)
+      #
+      #   @param processed_at [Time, nil] When the notification was processed
+      #
+      #   @param recipient [Notiflows::Models::User] A user (recipient) in your project
+      #
+      #   @param topic [String, nil] Topic name if triggered via topic
+
+      # Notification processing status:
+      #
+      # - `pending`: Queued for processing
+      # - `processing`: Currently being processed
+      # - `processed`: Successfully processed (deliveries created)
+      # - `failed`: Processing failed
+      #
+      # @see Notiflows::Models::Notification#status
+      module Status
+        extend Notiflows::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSING = :processing
+        PROCESSED = :processed
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/notiflows/models/notification_list_deliveries_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Notifications#list_deliveries
+    class NotificationListDeliveriesParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for fetching the next page
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for fetching the previous page
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute channel_id
+      #   Filter by channel ID (UUID)
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute created_after
+      #   Filter by created after (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_after, String
+
+      # @!attribute created_before
+      #   Filter by created before (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_before, String
+
+      # @!attribute limit
+      #   Number of items per page (default: 25, max: 1000)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Filter by status (pending, sent, failed)
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute topic
+      #   Filter by topic name
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(after: nil, before: nil, channel_id: nil, created_after: nil, created_before: nil, limit: nil, status: nil, topic: nil, request_options: {})
+      #   @param after [String] Cursor for fetching the next page
+      #
+      #   @param before [String] Cursor for fetching the previous page
+      #
+      #   @param channel_id [String] Filter by channel ID (UUID)
+      #
+      #   @param created_after [String] Filter by created after (ISO 8601 datetime)
+      #
+      #   @param created_before [String] Filter by created before (ISO 8601 datetime)
+      #
+      #   @param limit [Integer] Number of items per page (default: 25, max: 1000)
+      #
+      #   @param status [String] Filter by status (pending, sent, failed)
+      #
+      #   @param topic [String] Filter by topic name
+      #
+      #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/notiflows/models/notification_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Notifications#list
+    class NotificationListParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for fetching the next page
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor for fetching the previous page
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute created_after
+      #   Filter by created after (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_after, String
+
+      # @!attribute created_before
+      #   Filter by created before (ISO 8601 datetime)
+      #
+      #   @return [String, nil]
+      optional :created_before, String
+
+      # @!attribute limit
+      #   Number of items per page (default: 25, max: 1000)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #   Filter by status
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute topic
+      #   Filter by topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(after: nil, before: nil, created_after: nil, created_before: nil, limit: nil, status: nil, topic: nil, request_options: {})
+      #   @param after [String] Cursor for fetching the next page
+      #
+      #   @param before [String] Cursor for fetching the previous page
+      #
+      #   @param created_after [String] Filter by created after (ISO 8601 datetime)
+      #
+      #   @param created_before [String] Filter by created before (ISO 8601 datetime)
+      #
+      #   @param limit [Integer] Number of items per page (default: 25, max: 1000)
+      #
+      #   @param status [String] Filter by status
+      #
+      #   @param topic [String] Filter by topic
+      #
+      #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/notiflows/models/notification_retrieve_params.rb

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