notiflows 0.0.1

data/lib/notiflows/resources/users/subscriptions.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Resources
+    class Users
+      class Subscriptions
+        # Check if a user is subscribed to a specific topic.
+        #
+        # @overload retrieve(topic_name, user_external_id:, request_options: {})
+        #
+        # @param topic_name [String] Topic name
+        #
+        # @param user_external_id [String] User external ID
+        #
+        # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Notiflows::Models::Users::Subscription]
+        #
+        # @see Notiflows::Models::Users::SubscriptionRetrieveParams
+        def retrieve(topic_name, params)
+          parsed, options = ::Notiflows::Users::SubscriptionRetrieveParams.dump_request(params)
+          user_external_id =
+            parsed.delete(:user_external_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/subscriptions/%2$s", user_external_id, topic_name],
+            model: ::Notiflows::Users::Subscription,
+            options: options
+          )
+        end
+
+        # Retrieve all topic subscriptions for a user.
+        #
+        # @overload list(user_external_id, after: nil, before: nil, created_after: nil, created_before: nil, limit: nil, request_options: {})
+        #
+        # @param user_external_id [String] User external ID
+        #
+        # @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}, nil]
+        #
+        # @return [Notiflows::Internal::CursorPage<Notiflows::Models::Users::Subscription>]
+        #
+        # @see Notiflows::Models::Users::SubscriptionListParams
+        def list(user_external_id, params = {})
+          parsed, options = ::Notiflows::Users::SubscriptionListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/subscriptions", user_external_id],
+            query: parsed,
+            page: ::Notiflows::Internal::CursorPage,
+            model: ::Notiflows::Users::Subscription,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Notiflows::Models::Users::SubscriptionSubscribeParams} for more details.
+        #
+        # Subscribe a user to a topic. Topics are created automatically if they don't
+        # exist.
+        #
+        # **Idempotent:** If the user is already subscribed, returns the existing
+        # subscription with `200 OK`.
+        #
+        # @overload subscribe(user_external_id, topic_name:, request_options: {})
+        #
+        # @param user_external_id [String] User external ID
+        #
+        # @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}, nil]
+        #
+        # @return [Notiflows::Models::Users::Subscription]
+        #
+        # @see Notiflows::Models::Users::SubscriptionSubscribeParams
+        def subscribe(user_external_id, params)
+          parsed, options = ::Notiflows::Users::SubscriptionSubscribeParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["users/%1$s/subscriptions", user_external_id],
+            body: parsed,
+            model: ::Notiflows::Users::Subscription,
+            options: options
+          )
+        end
+
+        # Remove a user's subscription from a topic. The user will no longer receive
+        # notifications triggered for this topic.
+        #
+        # @overload unsubscribe(topic_name, user_external_id:, request_options: {})
+        #
+        # @param topic_name [String] Topic name
+        #
+        # @param user_external_id [String] User external ID
+        #
+        # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Notiflows::Models::Users::SubscriptionUnsubscribeParams
+        def unsubscribe(topic_name, params)
+          parsed, options = ::Notiflows::Users::SubscriptionUnsubscribeParams.dump_request(params)
+          user_external_id =
+            parsed.delete(:user_external_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["users/%1$s/subscriptions/%2$s", user_external_id, topic_name],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Notiflows::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/notiflows/resources/users.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Resources
+    class Users
+      # @return [Notiflows::Resources::Users::ChannelSettings]
+      attr_reader :channel_settings
+
+      # @return [Notiflows::Resources::Users::Deliveries]
+      attr_reader :deliveries
+
+      # @return [Notiflows::Resources::Users::Notifications]
+      attr_reader :notifications
+
+      # @return [Notiflows::Resources::Users::Preferences]
+      attr_reader :preferences
+
+      # @return [Notiflows::Resources::Users::Subscriptions]
+      attr_reader :subscriptions
+
+      # Retrieve a single user by their external ID. The external ID is the identifier
+      # you assigned when creating the user.
+      #
+      # @overload retrieve(user_external_id, request_options: {})
+      #
+      # @param user_external_id [String] User external ID (your system's user identifier)
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Models::User]
+      #
+      # @see Notiflows::Models::UserRetrieveParams
+      def retrieve(user_external_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["users/%1$s", user_external_id],
+          model: ::Notiflows::User,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieve a paginated list of users in your project. Users are sorted by creation
+      # date (newest first).
+      #
+      # @overload list(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 users created after this datetime (ISO 8601)
+      #
+      # @param created_before [String] Filter users created before this datetime (ISO 8601)
+      #
+      # @param limit [Integer] Number of items per page (default: 25, max: 1000)
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Internal::CursorPage<Notiflows::Models::User>]
+      #
+      # @see Notiflows::Models::UserListParams
+      def list(params = {})
+        parsed, options = ::Notiflows::UserListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "users",
+          query: parsed,
+          page: ::Notiflows::Internal::CursorPage,
+          model: ::Notiflows::User,
+          options: options
+        )
+      end
+
+      # Permanently delete a user and all their associated data including:
+      #
+      # - Subscriptions
+      # - Preferences
+      # - Channel settings
+      # - Notifications and deliveries
+      #
+      # **This action cannot be undone.**
+      #
+      # @overload delete(user_external_id, request_options: {})
+      #
+      # @param user_external_id [String] User external ID
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Notiflows::Models::UserDeleteParams
+      def delete(user_external_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["users/%1$s", user_external_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Create a new user or update an existing user by external ID (upsert operation).
+      #
+      # - If the user doesn't exist, they will be created with the provided attributes.
+      # - If the user exists, their attributes will be updated (merge behavior).
+      # - `custom_fields` are deep-merged with existing values.
+      #
+      # **Returns:**
+      #
+      # - `201 Created` when a new user is created
+      # - `200 OK` when an existing user is updated
+      #
+      # @overload upsert(user_external_id, external_id:, avatar: nil, channel_settings: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, preferences: nil, timezone: nil, request_options: {})
+      #
+      # @param user_external_id [String] User external ID
+      #
+      # @param external_id [String] Your system's unique identifier for this user. Required for creating new users.
+      #
+      # @param avatar [String] URL to user's avatar image (must start with http:// or https://)
+      #
+      # @param channel_settings [Array<Notiflows::Models::UserUpsertParams::ChannelSetting>] Initial channel settings (e.g., device tokens for push)
+      #
+      # @param custom_fields [Object] Custom attributes. Deep-merged with existing values on update.
+      #
+      # @param email [String] User's email address
+      #
+      # @param first_name [String] User's first name
+      #
+      # @param last_name [String] User's last name
+      #
+      # @param locale [String] BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
+      #
+      # @param phone [String] User's phone number in E.164 format
+      #
+      # @param preferences [::Notiflows::Models::Users::UpdatePreferencesRequest] Request body for updating user preferences. Only provided fields are updated.
+      #
+      # @param timezone [String] IANA timezone (e.g., America/New_York, Europe/London)
+      #
+      # @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Notiflows::Models::User]
+      #
+      # @see Notiflows::Models::UserUpsertParams
+      def upsert(user_external_id, params)
+        parsed, options = ::Notiflows::UserUpsertParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["users/%1$s", user_external_id],
+          body: parsed,
+          model: ::Notiflows::User,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Notiflows::Client]
+      def initialize(client:)
+        @client = client
+        @channel_settings = ChannelSettings.new(client: client)
+        @deliveries = Deliveries.new(client: client)
+        @notifications = Notifications.new(client: client)
+        @preferences = Preferences.new(client: client)
+        @subscriptions = Subscriptions.new(client: client)
+      end
+    end
+  end
+end

data/lib/notiflows/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Notiflows
+  VERSION = "0.0.1"
+end

data/lib/notiflows.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "notiflows/version"
+require_relative "notiflows/internal/util"
+require_relative "notiflows/internal/type/converter"
+require_relative "notiflows/internal/type/unknown"
+require_relative "notiflows/internal/type/boolean"
+require_relative "notiflows/internal/type/file_input"
+require_relative "notiflows/internal/type/enum"
+require_relative "notiflows/internal/type/union"
+require_relative "notiflows/internal/type/array_of"
+require_relative "notiflows/internal/type/hash_of"
+require_relative "notiflows/internal/type/base_model"
+require_relative "notiflows/internal/type/base_page"
+require_relative "notiflows/internal/type/request_parameters"
+require_relative "notiflows/internal"
+require_relative "notiflows/request_options"
+require_relative "notiflows/file_part"
+require_relative "notiflows/errors"
+require_relative "notiflows/internal/transport/base_client"
+require_relative "notiflows/internal/transport/pooled_net_requester"
+require_relative "notiflows/client"
+require_relative "notiflows/internal/cursor_page"
+require_relative "notiflows/models/topics/bulk_subscribe_request"
+require_relative "notiflows/models/users/update_preferences_request"
+require_relative "notiflows/models/delivery"
+require_relative "notiflows/models/delivery_list_params"
+require_relative "notiflows/models/delivery_retrieve_params"
+require_relative "notiflows/models/notification"
+require_relative "notiflows/models/notification_list_deliveries_params"
+require_relative "notiflows/models/notification_list_params"
+require_relative "notiflows/models/notification_retrieve_params"
+require_relative "notiflows/models/notiflow_run_params"
+require_relative "notiflows/models/notiflow_run_response"
+require_relative "notiflows/models/topic"
+require_relative "notiflows/models/topic_delete_params"
+require_relative "notiflows/models/topic_list_params"
+require_relative "notiflows/models/topic_retrieve_params"
+require_relative "notiflows/models/topics/bulk_operation_response"
+require_relative "notiflows/models/topics/subscription_list_params"
+require_relative "notiflows/models/topics/subscription_subscribe_bulk_params"
+require_relative "notiflows/models/topics/subscription_unsubscribe_bulk_params"
+require_relative "notiflows/models/user"
+require_relative "notiflows/models/user_delete_params"
+require_relative "notiflows/models/user_list_params"
+require_relative "notiflows/models/user_retrieve_params"
+require_relative "notiflows/models/users/channel_setting_delete_params"
+require_relative "notiflows/models/users/channel_setting_retrieve_params"
+require_relative "notiflows/models/users/channel_setting_update_params"
+require_relative "notiflows/models/users/delivery_list_params"
+require_relative "notiflows/models/users/delivery_retrieve_params"
+require_relative "notiflows/models/users/mobile_push_settings"
+require_relative "notiflows/models/users/notification_list_params"
+require_relative "notiflows/models/users/notification_retrieve_params"
+require_relative "notiflows/models/users/preference_retrieve_params"
+require_relative "notiflows/models/users/preference_update_params"
+require_relative "notiflows/models/users/slack_settings"
+require_relative "notiflows/models/users/subscription"
+require_relative "notiflows/models/users/subscription_list_params"
+require_relative "notiflows/models/users/subscription_retrieve_params"
+require_relative "notiflows/models/users/subscription_subscribe_params"
+require_relative "notiflows/models/users/subscription_unsubscribe_params"
+require_relative "notiflows/models/users/channel_settings"
+require_relative "notiflows/models/users/preferences"
+require_relative "notiflows/models/user_upsert_params"
+require_relative "notiflows/models"
+require_relative "notiflows/resources/deliveries"
+require_relative "notiflows/resources/notifications"
+require_relative "notiflows/resources/notiflows"
+require_relative "notiflows/resources/topics/subscriptions"
+require_relative "notiflows/resources/topics"
+require_relative "notiflows/resources/users/channel_settings"
+require_relative "notiflows/resources/users/deliveries"
+require_relative "notiflows/resources/users/notifications"
+require_relative "notiflows/resources/users/preferences"
+require_relative "notiflows/resources/users/subscriptions"
+require_relative "notiflows/resources/users"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/notiflows/client.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Notiflows
+  class Client < Notiflows::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    # Your project's public API key. Found in Project Settings. Starts with `pk_`.
+    sig { returns(String) }
+    attr_reader :api_key
+
+    # Your project's secret key. Found in Project Settings. Starts with `sk_`. **Keep
+    # this secret!**
+    sig { returns(String) }
+    attr_reader :secret
+
+    sig { returns(Notiflows::Resources::Deliveries) }
+    attr_reader :deliveries
+
+    sig { returns(Notiflows::Resources::Notifications) }
+    attr_reader :notifications
+
+    sig { returns(Notiflows::Resources::Notiflows) }
+    attr_reader :notiflows
+
+    sig { returns(Notiflows::Resources::Topics) }
+    attr_reader :topics
+
+    sig { returns(Notiflows::Resources::Users) }
+    attr_reader :users
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def api_key_auth
+    end
+
+    # @api private
+    sig { returns(T::Hash[String, String]) }
+    private def secret_key_auth
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        secret: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Your project's public API key. Found in Project Settings. Starts with `pk_`.
+      # Defaults to `ENV["NOTIFLOWS_SDK_API_KEY"]`
+      api_key: ENV["NOTIFLOWS_SDK_API_KEY"],
+      # Your project's secret key. Found in Project Settings. Starts with `sk_`. **Keep
+      # this secret!** Defaults to `ENV["NOTIFLOWS_SDK_SECRET"]`
+      secret: ENV["NOTIFLOWS_SDK_SECRET"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["NOTIFLOWS_BASE_URL"]`
+      base_url: ENV["NOTIFLOWS_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Notiflows::Client::DEFAULT_MAX_RETRIES,
+      timeout: Notiflows::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Notiflows::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Notiflows::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end