notiflows 0.0.1

data/lib/notiflows/models/users/slack_settings.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      class SlackSettings < Notiflows::Internal::Type::BaseModel
+        # @!attribute slack_channel_id
+        #   Slack channel ID (starts with C)
+        #
+        #   @return [String, nil]
+        optional :slack_channel_id, String
+
+        # @!attribute slack_user_id
+        #   Slack user ID for direct messages (starts with U)
+        #
+        #   @return [String, nil]
+        optional :slack_user_id, String
+
+        # @!method initialize(slack_channel_id: nil, slack_user_id: nil)
+        #   Settings for Slack notifications. At least one of `slack_channel_id` or
+        #   `slack_user_id` must be provided.
+        #
+        #   @param slack_channel_id [String] Slack channel ID (starts with C)
+        #
+        #   @param slack_user_id [String] Slack user ID for direct messages (starts with U)
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/subscription.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Subscriptions#retrieve
+      class Subscription < Notiflows::Internal::Type::BaseModel
+        # @!attribute id
+        #   Subscription ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   When the subscription was created
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute topic_name
+        #   Name of the subscribed topic
+        #
+        #   @return [String]
+        required :topic_name, String
+
+        # @!attribute user_id
+        #   User's internal ID
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(id:, created_at:, topic_name:, user_id:)
+        #   A user's subscription to a topic
+        #
+        #   @param id [String] Subscription ID
+        #
+        #   @param created_at [Time] When the subscription was created
+        #
+        #   @param topic_name [String] Name of the subscribed topic
+        #
+        #   @param user_id [String] User's internal ID
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/subscription_list_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Subscriptions#list
+      class SubscriptionListParams < 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
+
+        # @!method initialize(after: nil, before: nil, created_after: nil, created_before: nil, limit: 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 request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/subscription_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Subscriptions#retrieve
+      class SubscriptionRetrieveParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        # @!attribute user_external_id
+        #
+        #   @return [String]
+        required :user_external_id, String
+
+        # @!method initialize(user_external_id:, request_options: {})
+        #   @param user_external_id [String]
+        #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/subscription_subscribe_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Subscriptions#subscribe
+      class SubscriptionSubscribeParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        # @!attribute topic_name
+        #   Name of the topic to subscribe to. Topics are created automatically if they
+        #   don't exist.
+        #
+        #   @return [String]
+        required :topic_name, String
+
+        # @!method initialize(topic_name:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Notiflows::Models::Users::SubscriptionSubscribeParams} for more details.
+        #
+        #   @param topic_name [String] Name of the topic to subscribe to. Topics are created automatically if they don'
+        #
+        #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/subscription_unsubscribe_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Subscriptions#unsubscribe
+      class SubscriptionUnsubscribeParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        # @!attribute user_external_id
+        #
+        #   @return [String]
+        required :user_external_id, String
+
+        # @!method initialize(user_external_id:, request_options: {})
+        #   @param user_external_id [String]
+        #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/notiflows/models/users/update_preferences_request.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      class UpdatePreferencesRequest < ::Notiflows::Internal::Type::BaseModel
+        # @!attribute channel_types
+        #   Global channel type preferences
+        #
+        #   @return [Hash{Symbol=>Boolean}, nil]
+        optional :channel_types, ::Notiflows::Internal::Type::HashOf[::Notiflows::Internal::Type::Boolean]
+
+        # @!attribute notiflows
+        #   Per-notiflow preferences (keyed by notiflow ID)
+        #
+        #   @return [Hash{Symbol=>::Notiflows::Models::Users::UpdatePreferencesRequest::Notiflow}, nil]
+        optional :notiflows,
+                 -> { ::Notiflows::Internal::Type::HashOf[::Notiflows::Users::UpdatePreferencesRequest::Notiflow] }
+
+        # @!method initialize(channel_types: nil, notiflows: nil)
+        #   Request body for updating user preferences. Only provided fields are updated.
+        #
+        #   @param channel_types [Hash{Symbol=>Boolean}] Global channel type preferences
+        #
+        #   @param notiflows [Hash{Symbol=>::Notiflows::Models::Users::UpdatePreferencesRequest::Notiflow}] Per-notiflow preferences (keyed by notiflow ID)
+
+        class Notiflow < ::Notiflows::Internal::Type::BaseModel
+          # @!attribute channel_types
+          #
+          #   @return [Hash{Symbol=>Boolean}, nil]
+          optional :channel_types, ::Notiflows::Internal::Type::HashOf[::Notiflows::Internal::Type::Boolean]
+
+          # @!attribute enabled
+          #
+          #   @return [Boolean, nil]
+          optional :enabled, ::Notiflows::Internal::Type::Boolean
+
+          # @!method initialize(channel_types: nil, enabled: nil)
+          #   @param channel_types [Hash{Symbol=>Boolean}]
+          #   @param enabled [Boolean]
+        end
+      end
+    end
+  end
+end

data/lib/notiflows/models.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Notiflows
+  [Notiflows::Internal::Type::BaseModel, *Notiflows::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Notiflows::Internal::AnyHash) } }
+  end
+
+  Notiflows::Internal::Util.walk_namespaces(Notiflows::Models).each do |mod|
+    case mod
+    in Notiflows::Internal::Type::Enum | Notiflows::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Notiflows::Internal::Util.walk_namespaces(Notiflows::Models)
+                           .lazy
+                           .grep(Notiflows::Internal::Type::Union)
+                           .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  Delivery = Notiflows::Models::Delivery
+
+  DeliveryListParams = Notiflows::Models::DeliveryListParams
+
+  DeliveryRetrieveParams = Notiflows::Models::DeliveryRetrieveParams
+
+  Notification = Notiflows::Models::Notification
+
+  NotificationListDeliveriesParams = Notiflows::Models::NotificationListDeliveriesParams
+
+  NotificationListParams = Notiflows::Models::NotificationListParams
+
+  NotificationRetrieveParams = Notiflows::Models::NotificationRetrieveParams
+
+  NotiflowRunParams = Notiflows::Models::NotiflowRunParams
+
+  Topic = Notiflows::Models::Topic
+
+  TopicDeleteParams = Notiflows::Models::TopicDeleteParams
+
+  TopicListParams = Notiflows::Models::TopicListParams
+
+  TopicRetrieveParams = Notiflows::Models::TopicRetrieveParams
+
+  Topics = Notiflows::Models::Topics
+
+  User = Notiflows::Models::User
+
+  UserDeleteParams = Notiflows::Models::UserDeleteParams
+
+  UserListParams = Notiflows::Models::UserListParams
+
+  UserRetrieveParams = Notiflows::Models::UserRetrieveParams
+
+  Users = Notiflows::Models::Users
+
+  UserUpsertParams = Notiflows::Models::UserUpsertParams
+end

data/lib/notiflows/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Notiflows
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Notiflows::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Notiflows::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Notiflows::Internal::Type::HashOf[Notiflows::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Notiflows::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Notiflows::Internal::Type::HashOf[Notiflows::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Notiflows::RequestOptions, Notiflows::Internal::AnyHash) }
+    end
+  end
+end

data/lib/notiflows/resources/deliveries.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Resources
+    class Deliveries
+      # Retrieve details of a single delivery attempt.
+      #
+      # Includes the rendered content (`data`), channel information, and all timestamp
+      # tracking (sent, seen, read, clicked, archived).
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Delivery ID (UUID)
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Models::Delivery]
+      #
+      # @see Notiflows::Models::DeliveryRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["deliveries/%1$s", id],
+          model: ::Notiflows::Delivery,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve a paginated list of all deliveries in your project.
+      #
+      # A delivery represents a single attempt to send a notification through a specific
+      # channel. Use filters to narrow down results by channel, status, or time range.
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [Notiflows::Internal::CursorPage<Notiflows::Models::Delivery>]
+      #
+      # @see Notiflows::Models::DeliveryListParams
+      def list(params = {})
+        parsed, options = ::Notiflows::DeliveryListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "deliveries",
+          query: parsed,
+          page: ::Notiflows::Internal::CursorPage,
+          model: ::Notiflows::Delivery,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Notiflows::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/notiflows/resources/notifications.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Resources
+    class Notifications
+      # Retrieve a single notification by ID, including the recipient, actor, and all
+      # delivery attempts.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Notification ID (UUID)
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Models::Notification]
+      #
+      # @see Notiflows::Models::NotificationRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["notifications/%1$s", id],
+          model: ::Notiflows::Notification,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve a paginated list of all notifications in your project.
+      #
+      # A notification represents a message sent to a single recipient through a
+      # notiflow run. Each notification can have multiple deliveries (one per channel).
+      #
+      # @overload list(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}, nil]
+      #
+      # @return [Notiflows::Internal::CursorPage<Notiflows::Models::Notification>]
+      #
+      # @see Notiflows::Models::NotificationListParams
+      def list(params = {})
+        parsed, options = ::Notiflows::NotificationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "notifications",
+          query: parsed,
+          page: ::Notiflows::Internal::CursorPage,
+          model: ::Notiflows::Notification,
+          options: options
+        )
+      end
+
+      # Retrieve all delivery attempts for a specific notification.
+      #
+      # @overload list_deliveries(notification_id, after: nil, before: nil, channel_id: nil, created_after: nil, created_before: nil, limit: nil, status: nil, topic: nil, request_options: {})
+      #
+      # @param notification_id [String] Notification ID (UUID)
+      #
+      # @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}, nil]
+      #
+      # @return [Notiflows::Internal::CursorPage<Notiflows::Models::Delivery>]
+      #
+      # @see Notiflows::Models::NotificationListDeliveriesParams
+      def list_deliveries(notification_id, params = {})
+        parsed, options = ::Notiflows::NotificationListDeliveriesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["notifications/%1$s/deliveries", notification_id],
+          query: parsed,
+          page: ::Notiflows::Internal::CursorPage,
+          model: ::Notiflows::Delivery,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Notiflows::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/notiflows/resources/notiflows.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Resources
+    class Notiflows
+      # Some parameter documentations has been truncated, see
+      # {Notiflows::Models::NotiflowRunParams} for more details.
+      #
+      # Execute a notiflow to send notifications to one or more recipients.
+      #
+      # You must provide either `recipients` (direct targeting) or `topic` (pub/sub
+      # targeting), but not both.
+      #
+      # **Direct targeting (`recipients`):** Specify exactly which users should receive
+      # the notification. Users are identified by their `external_id`. If a user doesn't
+      # exist, they will be created automatically with the provided attributes.
+      #
+      # **Topic targeting (`topic`):** Send to all users subscribed to the specified
+      # topic. Useful for broadcast scenarios.
+      #
+      # **Template variables:** The `data` object is passed to notification templates.
+      # Access variables using Liquid syntax: `{{ data.variable_name }}`
+      #
+      # @overload run(notiflow_id, actor: nil, data: nil, recipients: nil, topic: nil, request_options: {})
+      #
+      # @param notiflow_id [String] Notiflow ID (UUID)
+      #
+      # @param actor [Notiflows::Models::NotiflowRunParams::Actor] Actor (triggering user) specification. Accessible in templates as `actor.*`.
+      #
+      # @param data [Object] Template variables. Accessible in notification templates as `data.*`.
+      #
+      # @param recipients [Array<Notiflows::Models::NotiflowRunParams::Recipient>] List of recipients. Each recipient must have an `external_id`. Users are auto-cr
+      #
+      # @param topic [String] Topic name for pub/sub targeting. Cannot be used with `recipients`.
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Models::NotiflowRunResponse]
+      #
+      # @see Notiflows::Models::NotiflowRunParams
+      def run(notiflow_id, params = {})
+        parsed, options = ::Notiflows::NotiflowRunParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["notiflows/%1$s/run", notiflow_id],
+          body: parsed,
+          model: ::Notiflows::Models::NotiflowRunResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Notiflows::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end