notiflows 0.0.1

data/rbi/notiflows/models/notification_list_params.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class NotificationListParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::NotificationListParams, Notiflows::Internal::AnyHash)
+        end
+
+      # Cursor for fetching the next page
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for fetching the previous page
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Filter by created after (ISO 8601 datetime)
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_after
+
+      sig { params(created_after: String).void }
+      attr_writer :created_after
+
+      # Filter by created before (ISO 8601 datetime)
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_before
+
+      sig { params(created_before: String).void }
+      attr_writer :created_before
+
+      # Number of items per page (default: 25, max: 1000)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Filter by status
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # Filter by topic
+      sig { returns(T.nilable(String)) }
+      attr_reader :topic
+
+      sig { params(topic: String).void }
+      attr_writer :topic
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          limit: Integer,
+          status: String,
+          topic: String,
+          request_options: Notiflows::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for fetching the next page
+        after: nil,
+        # Cursor for fetching the previous page
+        before: nil,
+        # Filter by created after (ISO 8601 datetime)
+        created_after: nil,
+        # Filter by created before (ISO 8601 datetime)
+        created_before: nil,
+        # Number of items per page (default: 25, max: 1000)
+        limit: nil,
+        # Filter by status
+        status: nil,
+        # Filter by topic
+        topic: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            created_after: String,
+            created_before: String,
+            limit: Integer,
+            status: String,
+            topic: String,
+            request_options: Notiflows::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/notification_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class NotificationRetrieveParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Notiflows::NotificationRetrieveParams,
+            Notiflows::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Notiflows::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Notiflows::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/notiflow_run_params.rbi

@@ -0,0 +1,320 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class NotiflowRunParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::NotiflowRunParams, Notiflows::Internal::AnyHash)
+        end
+
+      # Actor (triggering user) specification. Accessible in templates as `actor.*`.
+      sig { returns(T.nilable(Notiflows::NotiflowRunParams::Actor)) }
+      attr_reader :actor
+
+      sig { params(actor: Notiflows::NotiflowRunParams::Actor::OrHash).void }
+      attr_writer :actor
+
+      # Template variables. Accessible in notification templates as `data.*`.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :data
+
+      sig { params(data: T.anything).void }
+      attr_writer :data
+
+      # List of recipients. Each recipient must have an `external_id`. Users are
+      # auto-created if they don't exist.
+      sig do
+        returns(T.nilable(T::Array[Notiflows::NotiflowRunParams::Recipient]))
+      end
+      attr_reader :recipients
+
+      sig do
+        params(
+          recipients: T::Array[Notiflows::NotiflowRunParams::Recipient::OrHash]
+        ).void
+      end
+      attr_writer :recipients
+
+      # Topic name for pub/sub targeting. Cannot be used with `recipients`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :topic
+
+      sig { params(topic: String).void }
+      attr_writer :topic
+
+      sig do
+        params(
+          actor: Notiflows::NotiflowRunParams::Actor::OrHash,
+          data: T.anything,
+          recipients: T::Array[Notiflows::NotiflowRunParams::Recipient::OrHash],
+          topic: String,
+          request_options: Notiflows::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Actor (triggering user) specification. Accessible in templates as `actor.*`.
+        actor: nil,
+        # Template variables. Accessible in notification templates as `data.*`.
+        data: nil,
+        # List of recipients. Each recipient must have an `external_id`. Users are
+        # auto-created if they don't exist.
+        recipients: nil,
+        # Topic name for pub/sub targeting. Cannot be used with `recipients`.
+        topic: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            actor: Notiflows::NotiflowRunParams::Actor,
+            data: T.anything,
+            recipients: T::Array[Notiflows::NotiflowRunParams::Recipient],
+            topic: String,
+            request_options: Notiflows::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Actor < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::NotiflowRunParams::Actor,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Your system's identifier for the actor (required)
+        sig { returns(String) }
+        attr_accessor :external_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :avatar
+
+        sig { params(avatar: String).void }
+        attr_writer :avatar
+
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :custom_fields
+
+        sig { params(custom_fields: T.anything).void }
+        attr_writer :custom_fields
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :locale
+
+        sig { params(locale: String).void }
+        attr_writer :locale
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone
+
+        sig { params(phone: String).void }
+        attr_writer :phone
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :timezone
+
+        sig { params(timezone: String).void }
+        attr_writer :timezone
+
+        # Actor (triggering user) specification. Accessible in templates as `actor.*`.
+        sig do
+          params(
+            external_id: String,
+            avatar: String,
+            custom_fields: T.anything,
+            email: String,
+            first_name: String,
+            last_name: String,
+            locale: String,
+            phone: String,
+            timezone: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Your system's identifier for the actor (required)
+          external_id:,
+          avatar: nil,
+          custom_fields: nil,
+          email: nil,
+          first_name: nil,
+          last_name: nil,
+          locale: nil,
+          phone: nil,
+          timezone: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              external_id: String,
+              avatar: String,
+              custom_fields: T.anything,
+              email: String,
+              first_name: String,
+              last_name: String,
+              locale: String,
+              phone: String,
+              timezone: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Recipient < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::NotiflowRunParams::Recipient,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Your system's unique identifier for this user (required)
+        sig { returns(String) }
+        attr_accessor :external_id
+
+        # Avatar URL
+        sig { returns(T.nilable(String)) }
+        attr_reader :avatar
+
+        sig { params(avatar: String).void }
+        attr_writer :avatar
+
+        # Custom attributes
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :custom_fields
+
+        sig { params(custom_fields: T.anything).void }
+        attr_writer :custom_fields
+
+        # Email address (used if user is auto-created)
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # First name
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        # Last name
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        # BCP 47 locale
+        sig { returns(T.nilable(String)) }
+        attr_reader :locale
+
+        sig { params(locale: String).void }
+        attr_writer :locale
+
+        # Phone number in E.164 format
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone
+
+        sig { params(phone: String).void }
+        attr_writer :phone
+
+        # IANA timezone
+        sig { returns(T.nilable(String)) }
+        attr_reader :timezone
+
+        sig { params(timezone: String).void }
+        attr_writer :timezone
+
+        # Recipient specification for running a notiflow. Users are auto-created if they
+        # don't exist.
+        sig do
+          params(
+            external_id: String,
+            avatar: String,
+            custom_fields: T.anything,
+            email: String,
+            first_name: String,
+            last_name: String,
+            locale: String,
+            phone: String,
+            timezone: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Your system's unique identifier for this user (required)
+          external_id:,
+          # Avatar URL
+          avatar: nil,
+          # Custom attributes
+          custom_fields: nil,
+          # Email address (used if user is auto-created)
+          email: nil,
+          # First name
+          first_name: nil,
+          # Last name
+          last_name: nil,
+          # BCP 47 locale
+          locale: nil,
+          # Phone number in E.164 format
+          phone: nil,
+          # IANA timezone
+          timezone: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              external_id: String,
+              avatar: String,
+              custom_fields: T.anything,
+              email: String,
+              first_name: String,
+              last_name: String,
+              locale: String,
+              phone: String,
+              timezone: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/notiflow_run_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class NotiflowRunResponse < Notiflows::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Notiflows::Models::NotiflowRunResponse,
+            Notiflows::Internal::AnyHash
+          )
+        end
+
+      # ID of the notiflow run. Use this to query notifications created by this run.
+      sig { returns(String) }
+      attr_accessor :notiflow_run_id
+
+      # Response after successfully running a notiflow
+      sig { params(notiflow_run_id: String).returns(T.attached_class) }
+      def self.new(
+        # ID of the notiflow run. Use this to query notifications created by this run.
+        notiflow_run_id:
+      )
+      end
+
+      sig { override.returns({ notiflow_run_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/topic.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class Topic < Notiflows::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Notiflows::Topic, Notiflows::Internal::AnyHash) }
+
+      # When the topic was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Unique topic name within your project
+      sig { returns(String) }
+      attr_accessor :name
+
+      # A topic for pub/sub notification patterns
+      sig { params(created_at: Time, name: String).returns(T.attached_class) }
+      def self.new(
+        # When the topic was created
+        created_at:,
+        # Unique topic name within your project
+        name:
+      )
+      end
+
+      sig { override.returns({ created_at: Time, name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/topic_delete_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class TopicDeleteParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::TopicDeleteParams, Notiflows::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Notiflows::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Notiflows::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/topic_list_params.rbi

@@ -0,0 +1,68 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class TopicListParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::TopicListParams, Notiflows::Internal::AnyHash)
+        end
+
+      # Cursor for fetching the next page
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor for fetching the previous page
+      sig { returns(T.nilable(String)) }
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Number of items per page (default: 25, max: 1000)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          after: String,
+          before: String,
+          limit: Integer,
+          request_options: Notiflows::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for fetching the next page
+        after: nil,
+        # Cursor for fetching the previous page
+        before: nil,
+        # Number of items per page (default: 25, max: 1000)
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            before: String,
+            limit: Integer,
+            request_options: Notiflows::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/notiflows/models/topic_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class TopicRetrieveParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::TopicRetrieveParams, Notiflows::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Notiflows::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Notiflows::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end