notiflows 0.0.1

data/lib/notiflows/models/user_upsert_params.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Users#upsert
+    class UserUpsertParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      # @!attribute external_id
+      #   Your system's unique identifier for this user. Required for creating new users.
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute avatar
+      #   URL to user's avatar image (must start with http:// or https://)
+      #
+      #   @return [String, nil]
+      optional :avatar, String
+
+      # @!attribute channel_settings
+      #   Initial channel settings (e.g., device tokens for push)
+      #
+      #   @return [Array<Notiflows::Models::UserUpsertParams::ChannelSetting>, nil]
+      optional :channel_settings,
+               -> { Notiflows::Internal::Type::ArrayOf[Notiflows::UserUpsertParams::ChannelSetting] }
+
+      # @!attribute custom_fields
+      #   Custom attributes. Deep-merged with existing values on update.
+      #
+      #   @return [Object, nil]
+      optional :custom_fields, Notiflows::Internal::Type::Unknown
+
+      # @!attribute email
+      #   User's email address
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute first_name
+      #   User's first name
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   User's last name
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute locale
+      #   BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!attribute phone
+      #   User's phone number in E.164 format
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!attribute preferences
+      #   Request body for updating user preferences. Only provided fields are updated.
+      #
+      #   @return [::Notiflows::Models::Users::UpdatePreferencesRequest, nil]
+      optional :preferences, -> { ::Notiflows::Users::UpdatePreferencesRequest }
+
+      # @!attribute timezone
+      #   IANA timezone (e.g., America/New_York, Europe/London)
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(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 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}]
+
+      class ChannelSetting < Notiflows::Internal::Type::BaseModel
+        # @!attribute channel_id
+        #   Channel ID
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute settings
+        #   Provider-specific settings
+        #
+        #   @return [Object]
+        required :settings, Notiflows::Internal::Type::Unknown
+
+        # @!method initialize(channel_id:, settings:)
+        #   @param channel_id [String] Channel ID
+        #
+        #   @param settings [Object] Provider-specific settings
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::ChannelSettings#delete
+      class ChannelSettingDeleteParams < 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/channel_setting_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::ChannelSettings#retrieve
+      class ChannelSettingRetrieveParams < 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/channel_setting_update_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::ChannelSettings#update
+      class ChannelSettingUpdateParams < 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
+
+        # @!attribute settings
+        #   Provider-specific settings. Structure depends on channel provider.
+        #
+        #   @return [Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings]
+        required :settings, union: -> { Notiflows::Users::ChannelSettingUpdateParams::Settings }
+
+        # @!method initialize(user_external_id:, settings:, request_options: {})
+        #   @param user_external_id [String]
+        #
+        #   @param settings [Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings] Provider-specific settings. Structure depends on channel provider.
+        #
+        #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+
+        # Provider-specific settings. Structure depends on channel provider.
+        module Settings
+          extend Notiflows::Internal::Type::Union
+
+          # Settings for mobile push notifications (APNS/FCM)
+          variant -> { Notiflows::Users::MobilePushSettings }
+
+          # Settings for Slack notifications. At least one of `slack_channel_id` or `slack_user_id` must be provided.
+          variant -> { Notiflows::Users::SlackSettings }
+
+          # @!method self.variants
+          #   @return [Array(Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::ChannelSettings#retrieve
+      class UsersChannelSettings < Notiflows::Internal::Type::BaseModel
+        # @!attribute channel_id
+        #   Channel ID
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute created_at
+        #   When the settings were created
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute provider
+        #   The provider type for this channel
+        #
+        #   @return [Symbol, Notiflows::Models::Users::UsersChannelSettings::Provider]
+        required :provider, enum: -> { Notiflows::Users::UsersChannelSettings::Provider }
+
+        # @!attribute settings
+        #   Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+        #
+        #   @return [Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings]
+        required :settings, union: -> { Notiflows::Users::UsersChannelSettings::Settings }
+
+        # @!attribute updated_at
+        #   When the settings were last updated
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute user_id
+        #   Internal user ID
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(channel_id:, created_at:, provider:, settings:, updated_at:, user_id:)
+        #   User's settings for a specific channel (e.g., device tokens, Slack credentials)
+        #
+        #   @param channel_id [String] Channel ID
+        #
+        #   @param created_at [Time] When the settings were created
+        #
+        #   @param provider [Symbol, Notiflows::Models::Users::UsersChannelSettings::Provider] The provider type for this channel
+        #
+        #   @param settings [Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings] Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+        #
+        #   @param updated_at [Time] When the settings were last updated
+        #
+        #   @param user_id [String] Internal user ID
+
+        # The provider type for this channel
+        #
+        # @see Notiflows::Models::Users::UsersChannelSettings#provider
+        module Provider
+          extend Notiflows::Internal::Type::Enum
+
+          APNS = :apns
+          FCM = :fcm
+          SLACK = :slack
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+        #
+        # @see Notiflows::Models::Users::UsersChannelSettings#settings
+        module Settings
+          extend Notiflows::Internal::Type::Union
+
+          # Settings for mobile push notifications (APNS/FCM)
+          variant -> { Notiflows::Users::MobilePushSettings }
+
+          # Settings for Slack notifications. At least one of `slack_channel_id` or `slack_user_id` must be provided.
+          variant -> { Notiflows::Users::SlackSettings }
+
+          # @!method self.variants
+          #   @return [Array(Notiflows::Models::Users::MobilePushSettings, Notiflows::Models::Users::SlackSettings)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::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
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Deliveries#retrieve
+      class DeliveryRetrieveParams < 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/mobile_push_settings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      class MobilePushSettings < Notiflows::Internal::Type::BaseModel
+        # @!attribute device_tokens
+        #   List of device tokens for push notifications. At least one token is required.
+        #
+        #   @return [Array<String>]
+        required :device_tokens, Notiflows::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(device_tokens:)
+        #   Settings for mobile push notifications (APNS/FCM)
+        #
+        #   @param device_tokens [Array<String>] List of device tokens for push notifications. At least one token is required.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::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
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Notifications#retrieve
+      class NotificationRetrieveParams < 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/preference_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Preferences#retrieve
+      class PreferenceRetrieveParams < 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
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Preferences#update
+      class PreferenceUpdateParams < ::Notiflows::Models::Users::UpdatePreferencesRequest
+        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
+end

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Users
+      # @see Notiflows::Resources::Users::Preferences#retrieve
+      class UsersPreferences < ::Notiflows::Internal::Type::BaseModel
+        # @!attribute channel_types
+        #   Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+        #   opted out.
+        #
+        #   @return [::Notiflows::Models::Users::UsersPreferences::ChannelTypes, nil]
+        optional :channel_types, -> { ::Notiflows::Users::UsersPreferences::ChannelTypes }
+
+        # @!attribute notiflows
+        #   Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+        #
+        #   @return [Hash{Symbol=>::Notiflows::Models::Users::UsersPreferences::Notiflow}, nil]
+        optional :notiflows,
+                 -> { ::Notiflows::Internal::Type::HashOf[::Notiflows::Users::UsersPreferences::Notiflow] }
+
+        # @!method initialize(channel_types: nil, notiflows: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {::Notiflows::Models::Users::UsersPreferences} for more details.
+        #
+        #   User notification preferences
+        #
+        #   @param channel_types [::Notiflows::Models::Users::UsersPreferences::ChannelTypes] Global opt-in/opt-out settings per channel type. `true` = enabled, `false` = opt
+        #
+        #   @param notiflows [Hash{Symbol=>::Notiflows::Models::Users::UsersPreferences::Notiflow}] Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+
+        # @see Notiflows::Models::Users::UsersPreferences#channel_types
+        class ChannelTypes < ::Notiflows::Internal::Type::BaseModel
+          # @!attribute chat
+          #   Chat notifications (Slack, etc.)
+          #
+          #   @return [Boolean, nil]
+          optional :chat, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute email
+          #   Email notifications
+          #
+          #   @return [Boolean, nil]
+          optional :email, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute in_app
+          #   In-app feed notifications
+          #
+          #   @return [Boolean, nil]
+          optional :in_app, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute mobile_push
+          #   Mobile push notifications (iOS/Android)
+          #
+          #   @return [Boolean, nil]
+          optional :mobile_push, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute sms
+          #   SMS notifications
+          #
+          #   @return [Boolean, nil]
+          optional :sms, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute web_push
+          #   Web push notifications
+          #
+          #   @return [Boolean, nil]
+          optional :web_push, ::Notiflows::Internal::Type::Boolean
+
+          # @!method initialize(chat: nil, email: nil, in_app: nil, mobile_push: nil, sms: nil, web_push: nil)
+          #   Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+          #   opted out.
+          #
+          #   @param chat [Boolean] Chat notifications (Slack, etc.)
+          #
+          #   @param email [Boolean] Email notifications
+          #
+          #   @param in_app [Boolean] In-app feed notifications
+          #
+          #   @param mobile_push [Boolean] Mobile push notifications (iOS/Android)
+          #
+          #   @param sms [Boolean] SMS notifications
+          #
+          #   @param web_push [Boolean] Web push notifications
+        end
+
+        class Notiflow < ::Notiflows::Internal::Type::BaseModel
+          # @!attribute channel_types
+          #   Channel-specific overrides for this notiflow
+          #
+          #   @return [Hash{Symbol=>Boolean}, nil]
+          optional :channel_types, ::Notiflows::Internal::Type::HashOf[::Notiflows::Internal::Type::Boolean]
+
+          # @!attribute enabled
+          #   Whether this notiflow is enabled for the user
+          #
+          #   @return [Boolean, nil]
+          optional :enabled, ::Notiflows::Internal::Type::Boolean
+
+          # @!attribute name
+          #   Notiflow name (read-only, for display)
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(channel_types: nil, enabled: nil, name: nil)
+          #   @param channel_types [Hash{Symbol=>Boolean}] Channel-specific overrides for this notiflow
+          #
+          #   @param enabled [Boolean] Whether this notiflow is enabled for the user
+          #
+          #   @param name [String] Notiflow name (read-only, for display)
+        end
+      end
+    end
+  end
+end