notiflows 0.0.1

data/lib/notiflows/models/notiflow_run_params.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Notiflows#run
+    class NotiflowRunParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      # @!attribute actor
+      #   Actor (triggering user) specification. Accessible in templates as `actor.*`.
+      #
+      #   @return [Notiflows::Models::NotiflowRunParams::Actor, nil]
+      optional :actor, -> { Notiflows::NotiflowRunParams::Actor }
+
+      # @!attribute data
+      #   Template variables. Accessible in notification templates as `data.*`.
+      #
+      #   @return [Object, nil]
+      optional :data, Notiflows::Internal::Type::Unknown
+
+      # @!attribute recipients
+      #   List of recipients. Each recipient must have an `external_id`. Users are
+      #   auto-created if they don't exist.
+      #
+      #   @return [Array<Notiflows::Models::NotiflowRunParams::Recipient>, nil]
+      optional :recipients, -> { Notiflows::Internal::Type::ArrayOf[Notiflows::NotiflowRunParams::Recipient] }
+
+      # @!attribute topic
+      #   Topic name for pub/sub targeting. Cannot be used with `recipients`.
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(actor: nil, data: nil, recipients: nil, topic: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Notiflows::Models::NotiflowRunParams} for more details.
+      #
+      #   @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}]
+
+      class Actor < Notiflows::Internal::Type::BaseModel
+        # @!attribute external_id
+        #   Your system's identifier for the actor (required)
+        #
+        #   @return [String]
+        required :external_id, String
+
+        # @!attribute avatar
+        #
+        #   @return [String, nil]
+        optional :avatar, String
+
+        # @!attribute custom_fields
+        #
+        #   @return [Object, nil]
+        optional :custom_fields, Notiflows::Internal::Type::Unknown
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String
+
+        # @!attribute locale
+        #
+        #   @return [String, nil]
+        optional :locale, String
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute timezone
+        #
+        #   @return [String, nil]
+        optional :timezone, String
+
+        # @!method initialize(external_id:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil)
+        #   Actor (triggering user) specification. Accessible in templates as `actor.*`.
+        #
+        #   @param external_id [String] Your system's identifier for the actor (required)
+        #
+        #   @param avatar [String]
+        #
+        #   @param custom_fields [Object]
+        #
+        #   @param email [String]
+        #
+        #   @param first_name [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param locale [String]
+        #
+        #   @param phone [String]
+        #
+        #   @param timezone [String]
+      end
+
+      class Recipient < Notiflows::Internal::Type::BaseModel
+        # @!attribute external_id
+        #   Your system's unique identifier for this user (required)
+        #
+        #   @return [String]
+        required :external_id, String
+
+        # @!attribute avatar
+        #   Avatar URL
+        #
+        #   @return [String, nil]
+        optional :avatar, String
+
+        # @!attribute custom_fields
+        #   Custom attributes
+        #
+        #   @return [Object, nil]
+        optional :custom_fields, Notiflows::Internal::Type::Unknown
+
+        # @!attribute email
+        #   Email address (used if user is auto-created)
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #   First name
+        #
+        #   @return [String, nil]
+        optional :first_name, String
+
+        # @!attribute last_name
+        #   Last name
+        #
+        #   @return [String, nil]
+        optional :last_name, String
+
+        # @!attribute locale
+        #   BCP 47 locale
+        #
+        #   @return [String, nil]
+        optional :locale, String
+
+        # @!attribute phone
+        #   Phone number in E.164 format
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute timezone
+        #   IANA timezone
+        #
+        #   @return [String, nil]
+        optional :timezone, String
+
+        # @!method initialize(external_id:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil)
+        #   Recipient specification for running a notiflow. Users are auto-created if they
+        #   don't exist.
+        #
+        #   @param external_id [String] Your system's unique identifier for this user (required)
+        #
+        #   @param avatar [String] Avatar URL
+        #
+        #   @param custom_fields [Object] Custom attributes
+        #
+        #   @param email [String] Email address (used if user is auto-created)
+        #
+        #   @param first_name [String] First name
+        #
+        #   @param last_name [String] Last name
+        #
+        #   @param locale [String] BCP 47 locale
+        #
+        #   @param phone [String] Phone number in E.164 format
+        #
+        #   @param timezone [String] IANA timezone
+      end
+    end
+  end
+end

data/lib/notiflows/models/notiflow_run_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Notiflows#run
+    class NotiflowRunResponse < Notiflows::Internal::Type::BaseModel
+      # @!attribute notiflow_run_id
+      #   ID of the notiflow run. Use this to query notifications created by this run.
+      #
+      #   @return [String]
+      required :notiflow_run_id, String
+
+      # @!method initialize(notiflow_run_id:)
+      #   Response after successfully running a notiflow
+      #
+      #   @param notiflow_run_id [String] ID of the notiflow run. Use this to query notifications created by this run.
+    end
+  end
+end

data/lib/notiflows/models/topic.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Topics#retrieve
+    class Topic < Notiflows::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   When the topic was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   Unique topic name within your project
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(created_at:, name:)
+      #   A topic for pub/sub notification patterns
+      #
+      #   @param created_at [Time] When the topic was created
+      #
+      #   @param name [String] Unique topic name within your project
+    end
+  end
+end

data/lib/notiflows/models/topic_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Topics#delete
+    class TopicDeleteParams < 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

data/lib/notiflows/models/topic_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Topics#list
+    class TopicListParams < 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 limit
+      #   Number of items per page (default: 25, max: 1000)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, 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 limit [Integer] Number of items per page (default: 25, max: 1000)
+      #
+      #   @param request_options [Notiflows::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/notiflows/models/topic_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Topics#retrieve
+    class TopicRetrieveParams < 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

data/lib/notiflows/models/topics/bulk_operation_response.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Topics
+      # @see Notiflows::Resources::Topics::Subscriptions#subscribe_bulk
+      class BulkOperationResponse < Notiflows::Internal::Type::BaseModel
+        # @!attribute failed
+        #   Failed operations with error details
+        #
+        #   @return [Array<Notiflows::Models::Topics::BulkOperationResponse::Failed>]
+        required :failed,
+                 -> { Notiflows::Internal::Type::ArrayOf[Notiflows::Topics::BulkOperationResponse::Failed] }
+
+        # @!attribute successful
+        #   Successfully processed subscriptions
+        #
+        #   @return [Array<Notiflows::Models::Users::Subscription>]
+        required :successful, -> { Notiflows::Internal::Type::ArrayOf[Notiflows::Users::Subscription] }
+
+        # @!method initialize(failed:, successful:)
+        #   Response for bulk operations showing successful and failed items
+        #
+        #   @param failed [Array<Notiflows::Models::Topics::BulkOperationResponse::Failed>] Failed operations with error details
+        #
+        #   @param successful [Array<Notiflows::Models::Users::Subscription>] Successfully processed subscriptions
+
+        class Failed < Notiflows::Internal::Type::BaseModel
+          # @!attribute external_id
+          #   The external ID that failed
+          #
+          #   @return [String]
+          required :external_id, String
+
+          # @!attribute reason
+          #   Human-readable error reason
+          #
+          #   @return [String]
+          required :reason, String
+
+          # @!method initialize(external_id:, reason:)
+          #   Details of a failed bulk operation item
+          #
+          #   @param external_id [String] The external ID that failed
+          #
+          #   @param reason [String] Human-readable error reason
+        end
+      end
+    end
+  end
+end

data/lib/notiflows/models/topics/bulk_subscribe_request.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Topics
+      class BulkSubscribeRequest < Notiflows::Internal::Type::BaseModel
+        # @!attribute user_external_ids
+        #   List of user external IDs to subscribe/unsubscribe
+        #
+        #   @return [Array<String>]
+        required :user_external_ids, Notiflows::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(user_external_ids:)
+        #   Request body for bulk subscribe/unsubscribe operations
+        #
+        #   @param user_external_ids [Array<String>] List of user external IDs to subscribe/unsubscribe
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Topics
+      # @see Notiflows::Resources::Topics::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/topics/subscription_subscribe_bulk_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Topics
+      # @see Notiflows::Resources::Topics::Subscriptions#subscribe_bulk
+      class SubscriptionSubscribeBulkParams < Notiflows::Models::Topics::BulkSubscribeRequest
+        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/topics/subscription_unsubscribe_bulk_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    module Topics
+      # @see Notiflows::Resources::Topics::Subscriptions#unsubscribe_bulk
+      class SubscriptionUnsubscribeBulkParams < Notiflows::Models::Topics::BulkSubscribeRequest
+        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/user.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Users#retrieve
+    class User < Notiflows::Internal::Type::BaseModel
+      # @!attribute id
+      #   Internal Notiflows user ID (UUIDv7)
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   When the user was created (ISO 8601)
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute external_id
+      #   Your system's unique identifier for this user
+      #
+      #   @return [String]
+      required :external_id, String
+
+      # @!attribute updated_at
+      #   When the user was last updated (ISO 8601)
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute avatar
+      #   URL to user's avatar image (must be https://)
+      #
+      #   @return [String, nil]
+      optional :avatar, String, nil?: true
+
+      # @!attribute custom_fields
+      #   Arbitrary JSON object for additional user attributes. Accessible in templates as
+      #   `recipient.custom_fields.*`
+      #
+      #   @return [Object, nil]
+      optional :custom_fields, Notiflows::Internal::Type::Unknown, nil?: true
+
+      # @!attribute email
+      #   User's email address for email notifications
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute first_name
+      #   User's first name for personalization
+      #
+      #   @return [String, nil]
+      optional :first_name, String, nil?: true
+
+      # @!attribute last_name
+      #   User's last name for personalization
+      #
+      #   @return [String, nil]
+      optional :last_name, String, nil?: true
+
+      # @!attribute locale
+      #   BCP 47 locale code for localized notifications
+      #
+      #   @return [String, nil]
+      optional :locale, String, nil?: true
+
+      # @!attribute phone
+      #   User's phone number in E.164 format for SMS notifications
+      #
+      #   @return [String, nil]
+      optional :phone, String, nil?: true
+
+      # @!attribute timezone
+      #   IANA timezone for time-sensitive notifications
+      #
+      #   @return [String, nil]
+      optional :timezone, String, nil?: true
+
+      # @!method initialize(id:, created_at:, external_id:, updated_at:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see {Notiflows::Models::User}
+      #   for more details.
+      #
+      #   A user (recipient) in your project
+      #
+      #   @param id [String] Internal Notiflows user ID (UUIDv7)
+      #
+      #   @param created_at [Time] When the user was created (ISO 8601)
+      #
+      #   @param external_id [String] Your system's unique identifier for this user
+      #
+      #   @param updated_at [Time] When the user was last updated (ISO 8601)
+      #
+      #   @param avatar [String, nil] URL to user's avatar image (must be https://)
+      #
+      #   @param custom_fields [Object, nil] Arbitrary JSON object for additional user attributes. Accessible in templates as
+      #
+      #   @param email [String, nil] User's email address for email notifications
+      #
+      #   @param first_name [String, nil] User's first name for personalization
+      #
+      #   @param last_name [String, nil] User's last name for personalization
+      #
+      #   @param locale [String, nil] BCP 47 locale code for localized notifications
+      #
+      #   @param phone [String, nil] User's phone number in E.164 format for SMS notifications
+      #
+      #   @param timezone [String, nil] IANA timezone for time-sensitive notifications
+    end
+  end
+end

data/lib/notiflows/models/user_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Users#delete
+    class UserDeleteParams < 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

data/lib/notiflows/models/user_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Notiflows
+  module Models
+    # @see Notiflows::Resources::Users#list
+    class UserListParams < 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 users created after this datetime (ISO 8601)
+      #
+      #   @return [String, nil]
+      optional :created_after, String
+
+      # @!attribute created_before
+      #   Filter users created before this datetime (ISO 8601)
+      #
+      #   @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 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}]
+    end
+  end
+end

data/lib/notiflows/models/user_retrieve_params.rb

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