notiflows 0.0.1

data/sig/notiflows/models/users/preferences.rbs

@@ -0,0 +1,118 @@
+module Notiflows
+  module Models
+    module Users
+      type users_preferences =
+        {
+          channel_types: ::Notiflows::Users::UsersPreferences::ChannelTypes,
+          notiflows: ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+        }
+
+      class UsersPreferences < ::Notiflows::Internal::Type::BaseModel
+        attr_reader channel_types: ::Notiflows::Users::UsersPreferences::ChannelTypes?
+
+        def channel_types=: (
+          ::Notiflows::Users::UsersPreferences::ChannelTypes
+        ) -> ::Notiflows::Users::UsersPreferences::ChannelTypes
+
+        attr_reader notiflows: ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]?
+
+        def notiflows=: (
+          ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+        ) -> ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+
+        def initialize: (
+          ?channel_types: ::Notiflows::Users::UsersPreferences::ChannelTypes,
+          ?notiflows: ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+        ) -> void
+
+        def to_hash: -> {
+          channel_types: ::Notiflows::Users::UsersPreferences::ChannelTypes,
+          notiflows: ::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+        }
+
+        type channel_types =
+          {
+            chat: bool,
+            email: bool,
+            in_app: bool,
+            mobile_push: bool,
+            sms: bool,
+            web_push: bool
+          }
+
+        class ChannelTypes < ::Notiflows::Internal::Type::BaseModel
+          attr_reader chat: bool?
+
+          def chat=: (bool) -> bool
+
+          attr_reader email: bool?
+
+          def email=: (bool) -> bool
+
+          attr_reader in_app: bool?
+
+          def in_app=: (bool) -> bool
+
+          attr_reader mobile_push: bool?
+
+          def mobile_push=: (bool) -> bool
+
+          attr_reader sms: bool?
+
+          def sms=: (bool) -> bool
+
+          attr_reader web_push: bool?
+
+          def web_push=: (bool) -> bool
+
+          def initialize: (
+            ?chat: bool,
+            ?email: bool,
+            ?in_app: bool,
+            ?mobile_push: bool,
+            ?sms: bool,
+            ?web_push: bool
+          ) -> void
+
+          def to_hash: -> {
+            chat: bool,
+            email: bool,
+            in_app: bool,
+            mobile_push: bool,
+            sms: bool,
+            web_push: bool
+          }
+        end
+
+        type notiflow =
+          { channel_types: ::Hash[Symbol, bool], enabled: bool, name: String }
+
+        class Notiflow < ::Notiflows::Internal::Type::BaseModel
+          attr_reader channel_types: ::Hash[Symbol, bool]?
+
+          def channel_types=: (::Hash[Symbol, bool]) -> ::Hash[Symbol, bool]
+
+          attr_reader enabled: bool?
+
+          def enabled=: (bool) -> bool
+
+          attr_reader name: String?
+
+          def name=: (String) -> String
+
+          def initialize: (
+            ?channel_types: ::Hash[Symbol, bool],
+            ?enabled: bool,
+            ?name: String
+          ) -> void
+
+          def to_hash: -> {
+            channel_types: ::Hash[Symbol, bool],
+            enabled: bool,
+            name: String
+          }
+        end
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/slack_settings.rbs

@@ -0,0 +1,24 @@
+module Notiflows
+  module Models
+    module Users
+      type slack_settings = { slack_channel_id: String, slack_user_id: String }
+
+      class SlackSettings < Notiflows::Internal::Type::BaseModel
+        attr_reader slack_channel_id: String?
+
+        def slack_channel_id=: (String) -> String
+
+        attr_reader slack_user_id: String?
+
+        def slack_user_id=: (String) -> String
+
+        def initialize: (
+          ?slack_channel_id: String,
+          ?slack_user_id: String
+        ) -> void
+
+        def to_hash: -> { slack_channel_id: String, slack_user_id: String }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/subscription.rbs

@@ -0,0 +1,32 @@
+module Notiflows
+  module Models
+    module Users
+      type subscription =
+        { id: String, created_at: Time, topic_name: String, user_id: String }
+
+      class Subscription < Notiflows::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Time
+
+        attr_accessor topic_name: String
+
+        attr_accessor user_id: String
+
+        def initialize: (
+          id: String,
+          created_at: Time,
+          topic_name: String,
+          user_id: String
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Time,
+          topic_name: String,
+          user_id: String
+        }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/subscription_list_params.rbs

@@ -0,0 +1,58 @@
+module Notiflows
+  module Models
+    module Users
+      type subscription_list_params =
+        {
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          limit: Integer
+        }
+        & Notiflows::Internal::Type::request_parameters
+
+      class SubscriptionListParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        attr_reader after: String?
+
+        def after=: (String) -> String
+
+        attr_reader before: String?
+
+        def before=: (String) -> String
+
+        attr_reader created_after: String?
+
+        def created_after=: (String) -> String
+
+        attr_reader created_before: String?
+
+        def created_before=: (String) -> String
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        def initialize: (
+          ?after: String,
+          ?before: String,
+          ?created_after: String,
+          ?created_before: String,
+          ?limit: Integer,
+          ?request_options: Notiflows::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          limit: Integer,
+          request_options: Notiflows::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/subscription_retrieve_params.rbs

@@ -0,0 +1,26 @@
+module Notiflows
+  module Models
+    module Users
+      type subscription_retrieve_params =
+        { user_external_id: String }
+        & Notiflows::Internal::Type::request_parameters
+
+      class SubscriptionRetrieveParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        attr_accessor user_external_id: String
+
+        def initialize: (
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_external_id: String,
+          request_options: Notiflows::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/subscription_subscribe_params.rbs

@@ -0,0 +1,25 @@
+module Notiflows
+  module Models
+    module Users
+      type subscription_subscribe_params =
+        { topic_name: String } & Notiflows::Internal::Type::request_parameters
+
+      class SubscriptionSubscribeParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        attr_accessor topic_name: String
+
+        def initialize: (
+          topic_name: String,
+          ?request_options: Notiflows::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          topic_name: String,
+          request_options: Notiflows::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/subscription_unsubscribe_params.rbs

@@ -0,0 +1,26 @@
+module Notiflows
+  module Models
+    module Users
+      type subscription_unsubscribe_params =
+        { user_external_id: String }
+        & Notiflows::Internal::Type::request_parameters
+
+      class SubscriptionUnsubscribeParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        attr_accessor user_external_id: String
+
+        def initialize: (
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_external_id: String,
+          request_options: Notiflows::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/notiflows/models/users/update_preferences_request.rbs

@@ -0,0 +1,52 @@
+module Notiflows
+  module Models
+    module Users
+      type update_preferences_request =
+        {
+          channel_types: ::Hash[Symbol, bool],
+          notiflows: ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]
+        }
+
+      class UpdatePreferencesRequest < ::Notiflows::Internal::Type::BaseModel
+        attr_reader channel_types: ::Hash[Symbol, bool]?
+
+        def channel_types=: (::Hash[Symbol, bool]) -> ::Hash[Symbol, bool]
+
+        attr_reader notiflows: ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]?
+
+        def notiflows=: (
+          ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]
+        ) -> ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]
+
+        def initialize: (
+          ?channel_types: ::Hash[Symbol, bool],
+          ?notiflows: ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]
+        ) -> void
+
+        def to_hash: -> {
+          channel_types: ::Hash[Symbol, bool],
+          notiflows: ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow]
+        }
+
+        type notiflow = { channel_types: ::Hash[Symbol, bool], enabled: bool }
+
+        class Notiflow < ::Notiflows::Internal::Type::BaseModel
+          attr_reader channel_types: ::Hash[Symbol, bool]?
+
+          def channel_types=: (::Hash[Symbol, bool]) -> ::Hash[Symbol, bool]
+
+          attr_reader enabled: bool?
+
+          def enabled=: (bool) -> bool
+
+          def initialize: (
+            ?channel_types: ::Hash[Symbol, bool],
+            ?enabled: bool
+          ) -> void
+
+          def to_hash: -> { channel_types: ::Hash[Symbol, bool], enabled: bool }
+        end
+      end
+    end
+  end
+end

data/sig/notiflows/models.rbs

@@ -0,0 +1,39 @@
+module Notiflows
+  class Delivery = Notiflows::Models::Delivery
+
+  class DeliveryListParams = Notiflows::Models::DeliveryListParams
+
+  class DeliveryRetrieveParams = Notiflows::Models::DeliveryRetrieveParams
+
+  class Notification = Notiflows::Models::Notification
+
+  class NotificationListDeliveriesParams = Notiflows::Models::NotificationListDeliveriesParams
+
+  class NotificationListParams = Notiflows::Models::NotificationListParams
+
+  class NotificationRetrieveParams = Notiflows::Models::NotificationRetrieveParams
+
+  class NotiflowRunParams = Notiflows::Models::NotiflowRunParams
+
+  class Topic = Notiflows::Models::Topic
+
+  class TopicDeleteParams = Notiflows::Models::TopicDeleteParams
+
+  class TopicListParams = Notiflows::Models::TopicListParams
+
+  class TopicRetrieveParams = Notiflows::Models::TopicRetrieveParams
+
+  module Topics = Notiflows::Models::Topics
+
+  class User = Notiflows::Models::User
+
+  class UserDeleteParams = Notiflows::Models::UserDeleteParams
+
+  class UserListParams = Notiflows::Models::UserListParams
+
+  class UserRetrieveParams = Notiflows::Models::UserRetrieveParams
+
+  module Users = Notiflows::Models::Users
+
+  class UserUpsertParams = Notiflows::Models::UserUpsertParams
+end

data/sig/notiflows/request_options.rbs

@@ -0,0 +1,34 @@
+module Notiflows
+  type request_opts =
+    Notiflows::RequestOptions | Notiflows::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Notiflows::Internal::Type::BaseModel
+    def self.validate!: (Notiflows::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Notiflows::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/notiflows/resources/deliveries.rbs

@@ -0,0 +1,24 @@
+module Notiflows
+  module Resources
+    class Deliveries
+      def retrieve: (
+        String id,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Delivery
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?created_after: String,
+        ?created_before: String,
+        ?limit: Integer,
+        ?status: String,
+        ?topic: String,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Internal::CursorPage[Notiflows::Delivery]
+
+      def initialize: (client: Notiflows::Client) -> void
+    end
+  end
+end

data/sig/notiflows/resources/notifications.rbs

@@ -0,0 +1,36 @@
+module Notiflows
+  module Resources
+    class Notifications
+      def retrieve: (
+        String id,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Notification
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?created_after: String,
+        ?created_before: String,
+        ?limit: Integer,
+        ?status: String,
+        ?topic: String,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Internal::CursorPage[Notiflows::Notification]
+
+      def list_deliveries: (
+        String notification_id,
+        ?after: String,
+        ?before: String,
+        ?channel_id: String,
+        ?created_after: String,
+        ?created_before: String,
+        ?limit: Integer,
+        ?status: String,
+        ?topic: String,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Internal::CursorPage[Notiflows::Delivery]
+
+      def initialize: (client: Notiflows::Client) -> void
+    end
+  end
+end

data/sig/notiflows/resources/notiflows.rbs

@@ -0,0 +1,16 @@
+module Notiflows
+  module Resources
+    class Notiflows
+      def run: (
+        String notiflow_id,
+        ?actor: Notiflows::NotiflowRunParams::Actor,
+        ?data: top,
+        ?recipients: ::Array[Notiflows::NotiflowRunParams::Recipient],
+        ?topic: String,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Models::NotiflowRunResponse
+
+      def initialize: (client: Notiflows::Client) -> void
+    end
+  end
+end

data/sig/notiflows/resources/topics/subscriptions.rbs

@@ -0,0 +1,31 @@
+module Notiflows
+  module Resources
+    class Topics
+      class Subscriptions
+        def list: (
+          String topic_id,
+          ?after: String,
+          ?before: String,
+          ?created_after: String,
+          ?created_before: String,
+          ?limit: Integer,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Internal::CursorPage[Notiflows::Users::Subscription]
+
+        def subscribe_bulk: (
+          String topic_id,
+          user_external_ids: ::Array[String],
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Topics::BulkOperationResponse
+
+        def unsubscribe_bulk: (
+          String topic_id,
+          user_external_ids: ::Array[String],
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Topics::BulkOperationResponse
+
+        def initialize: (client: Notiflows::Client) -> void
+      end
+    end
+  end
+end

data/sig/notiflows/resources/topics.rbs

@@ -0,0 +1,23 @@
+module Notiflows
+  module Resources
+    class Topics
+      attr_reader subscriptions: Notiflows::Resources::Topics::Subscriptions
+
+      def retrieve: (
+        String id,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Topic
+
+      def list: (
+        ?after: String,
+        ?before: String,
+        ?limit: Integer,
+        ?request_options: Notiflows::request_opts
+      ) -> Notiflows::Internal::CursorPage[Notiflows::Topic]
+
+      def delete: (String id, ?request_options: Notiflows::request_opts) -> nil
+
+      def initialize: (client: Notiflows::Client) -> void
+    end
+  end
+end

data/sig/notiflows/resources/users/channel_settings.rbs

@@ -0,0 +1,28 @@
+module Notiflows
+  module Resources
+    class Users
+      class ChannelSettings
+        def retrieve: (
+          String channel_id,
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Users::UsersChannelSettings
+
+        def update: (
+          String channel_id,
+          user_external_id: String,
+          settings: Notiflows::Models::Users::ChannelSettingUpdateParams::settings,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Users::UsersChannelSettings
+
+        def delete: (
+          String channel_id,
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> nil
+
+        def initialize: (client: Notiflows::Client) -> void
+      end
+    end
+  end
+end

data/sig/notiflows/resources/users/deliveries.rbs

@@ -0,0 +1,28 @@
+module Notiflows
+  module Resources
+    class Users
+      class Deliveries
+        def retrieve: (
+          String delivery_id,
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Delivery
+
+        def list: (
+          String user_external_id,
+          ?after: String,
+          ?before: String,
+          ?channel_id: String,
+          ?created_after: String,
+          ?created_before: String,
+          ?limit: Integer,
+          ?status: String,
+          ?topic: String,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Internal::CursorPage[Notiflows::Delivery]
+
+        def initialize: (client: Notiflows::Client) -> void
+      end
+    end
+  end
+end

data/sig/notiflows/resources/users/notifications.rbs

@@ -0,0 +1,27 @@
+module Notiflows
+  module Resources
+    class Users
+      class Notifications
+        def retrieve: (
+          String notification_id,
+          user_external_id: String,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Notification
+
+        def list: (
+          String user_external_id,
+          ?after: String,
+          ?before: String,
+          ?created_after: String,
+          ?created_before: String,
+          ?limit: Integer,
+          ?status: String,
+          ?topic: String,
+          ?request_options: Notiflows::request_opts
+        ) -> Notiflows::Internal::CursorPage[Notiflows::Notification]
+
+        def initialize: (client: Notiflows::Client) -> void
+      end
+    end
+  end
+end

data/sig/notiflows/resources/users/preferences.rbs

@@ -0,0 +1,21 @@
+module Notiflows
+  module Resources
+    class Users
+      class Preferences
+        def retrieve: (
+          String user_external_id,
+          ?request_options: Notiflows::request_opts
+        ) -> ::Notiflows::Users::UsersPreferences
+
+        def update: (
+          String user_external_id,
+          ?channel_types: ::Hash[Symbol, bool],
+          ?notiflows: ::Hash[Symbol, ::Notiflows::Users::UpdatePreferencesRequest::Notiflow],
+          ?request_options: Notiflows::request_opts
+        ) -> ::Notiflows::Users::UsersPreferences
+
+        def initialize: (client: Notiflows::Client) -> void
+      end
+    end
+  end
+end