prelude-sdk 0.1.0 → 0.2.0

data/lib/prelude_sdk/models/notify_list_subscription_phone_number_events_response.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_phone_number_events
+    class NotifyListSubscriptionPhoneNumberEventsResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute events
+      #   A list of subscription events (status changes) ordered by timestamp descending.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event>]
+      required :events,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event] }
+
+      # @!attribute next_cursor
+      #   Pagination cursor for the next page of results. Omitted if there are no more
+      #   pages.
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String
+
+      # @!method initialize(events:, next_cursor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse} for more
+      #   details.
+      #
+      #   @param events [Array<PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event>] A list of subscription events (status changes) ordered by timestamp descending.
+      #
+      #   @param next_cursor [String] Pagination cursor for the next page of results. Omitted if there are no more pag
+
+      class Event < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute config_id
+        #   The subscription configuration ID.
+        #
+        #   @return [String]
+        required :config_id, String
+
+        # @!attribute phone_number
+        #   The phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute source
+        #   How the subscription state was changed:
+        #
+        #   - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        #   - `API` - Changed via API
+        #   - `CSV_IMPORT` - Imported from CSV
+        #   - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        #
+        #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source]
+        required :source,
+                 enum: -> { PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source }
+
+        # @!attribute state
+        #   The subscription state after this event:
+        #
+        #   - `SUB` - Subscribed (user can receive marketing messages)
+        #   - `UNSUB` - Unsubscribed (user has opted out)
+        #
+        #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State]
+        required :state,
+                 enum: -> { PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State }
+
+        # @!attribute timestamp
+        #   The date and time when the event occurred.
+        #
+        #   @return [Time]
+        required :timestamp, Time
+
+        # @!attribute reason
+        #   Additional context about the state change (e.g., the keyword that was sent).
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!method initialize(config_id:, phone_number:, source:, state:, timestamp:, reason: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event} for
+        #   more details.
+        #
+        #   @param config_id [String] The subscription configuration ID.
+        #
+        #   @param phone_number [String] The phone number in E.164 format.
+        #
+        #   @param source [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::Source] How the subscription state was changed:
+        #
+        #   @param state [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event::State] The subscription state after this event:
+        #
+        #   @param timestamp [Time] The date and time when the event occurred.
+        #
+        #   @param reason [String] Additional context about the state change (e.g., the keyword that was sent).
+
+        # How the subscription state was changed:
+        #
+        # - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        # - `API` - Changed via API
+        # - `CSV_IMPORT` - Imported from CSV
+        # - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        #
+        # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event#source
+        module Source
+          extend PreludeSDK::Internal::Type::Enum
+
+          MO_KEYWORD = :MO_KEYWORD
+          API = :API
+          CSV_IMPORT = :CSV_IMPORT
+          CARRIER_DISCONNECT = :CARRIER_DISCONNECT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The subscription state after this event:
+        #
+        # - `SUB` - Subscribed (user can receive marketing messages)
+        # - `UNSUB` - Unsubscribed (user has opted out)
+        #
+        # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumberEventsResponse::Event#state
+        module State
+          extend PreludeSDK::Internal::Type::Enum
+
+          SUB = :SUB
+          UNSUB = :UNSUB
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_list_subscription_phone_numbers_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_phone_numbers
+    class NotifyListSubscriptionPhoneNumbersParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Pagination cursor from the previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Maximum number of phone numbers to return per page
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute state
+      #   Filter by subscription state
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State, nil]
+      optional :state, enum: -> { PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State }
+
+      # @!method initialize(cursor: nil, limit: nil, state: nil, request_options: {})
+      #   @param cursor [String] Pagination cursor from the previous response
+      #
+      #   @param limit [Integer] Maximum number of phone numbers to return per page
+      #
+      #   @param state [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersParams::State] Filter by subscription state
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter by subscription state
+      module State
+        extend PreludeSDK::Internal::Type::Enum
+
+        SUB = :SUB
+        UNSUB = :UNSUB
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_list_subscription_phone_numbers_response.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_phone_numbers
+    class NotifyListSubscriptionPhoneNumbersResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute phone_numbers
+      #   A list of phone numbers and their subscription statuses.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber>]
+      required :phone_numbers,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber] }
+
+      # @!attribute next_cursor
+      #   Pagination cursor for the next page of results. Omitted if there are no more
+      #   pages.
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String
+
+      # @!method initialize(phone_numbers:, next_cursor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse} for more
+      #   details.
+      #
+      #   @param phone_numbers [Array<PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber>] A list of phone numbers and their subscription statuses.
+      #
+      #   @param next_cursor [String] Pagination cursor for the next page of results. Omitted if there are no more pag
+
+      class PhoneNumber < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute config_id
+        #   The subscription configuration ID.
+        #
+        #   @return [String]
+        required :config_id, String
+
+        # @!attribute phone_number
+        #   The phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute source
+        #   How the subscription state was changed:
+        #
+        #   - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        #   - `API` - Changed via API
+        #   - `CSV_IMPORT` - Imported from CSV
+        #   - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        #
+        #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source]
+        required :source,
+                 enum: -> { PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source }
+
+        # @!attribute state
+        #   The subscription state:
+        #
+        #   - `SUB` - Subscribed (user can receive marketing messages)
+        #   - `UNSUB` - Unsubscribed (user has opted out)
+        #
+        #   @return [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State]
+        required :state,
+                 enum: -> { PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State }
+
+        # @!attribute updated_at
+        #   The date and time when the subscription status was last updated.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute reason
+        #   Additional context about the state change (e.g., the keyword that was sent).
+        #
+        #   @return [String, nil]
+        optional :reason, String
+
+        # @!method initialize(config_id:, phone_number:, source:, state:, updated_at:, reason: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber}
+        #   for more details.
+        #
+        #   @param config_id [String] The subscription configuration ID.
+        #
+        #   @param phone_number [String] The phone number in E.164 format.
+        #
+        #   @param source [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::Source] How the subscription state was changed:
+        #
+        #   @param state [Symbol, PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber::State] The subscription state:
+        #
+        #   @param updated_at [Time] The date and time when the subscription status was last updated.
+        #
+        #   @param reason [String] Additional context about the state change (e.g., the keyword that was sent).
+
+        # How the subscription state was changed:
+        #
+        # - `MO_KEYWORD` - User sent a keyword (STOP/START)
+        # - `API` - Changed via API
+        # - `CSV_IMPORT` - Imported from CSV
+        # - `CARRIER_DISCONNECT` - Automatically unsubscribed due to carrier disconnect
+        #
+        # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber#source
+        module Source
+          extend PreludeSDK::Internal::Type::Enum
+
+          MO_KEYWORD = :MO_KEYWORD
+          API = :API
+          CSV_IMPORT = :CSV_IMPORT
+          CARRIER_DISCONNECT = :CARRIER_DISCONNECT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The subscription state:
+        #
+        # - `SUB` - Subscribed (user can receive marketing messages)
+        # - `UNSUB` - Unsubscribed (user has opted out)
+        #
+        # @see PreludeSDK::Models::NotifyListSubscriptionPhoneNumbersResponse::PhoneNumber#state
+        module State
+          extend PreludeSDK::Internal::Type::Enum
+
+          SUB = :SUB
+          UNSUB = :UNSUB
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_send_batch_params.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#send_batch
+    class NotifySendBatchParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #   The template identifier configured by your Customer Success team.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute to
+      #   The list of recipients' phone numbers in E.164 format.
+      #
+      #   @return [Array<String>]
+      required :to, PreludeSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute callback_url
+      #   The URL where webhooks will be sent for delivery events.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   A user-defined identifier to correlate this request with your internal systems.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute expires_at
+      #   The message expiration date in RFC3339 format. Messages will not be sent after
+      #   this time.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time
+
+      # @!attribute from
+      #   The Sender ID. Must be approved for your account.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!attribute locale
+      #   A BCP-47 formatted locale string.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!attribute preferred_channel
+      #   Preferred channel for delivery. If unavailable, automatic fallback applies.
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifySendBatchParams::PreferredChannel, nil]
+      optional :preferred_channel, enum: -> { PreludeSDK::NotifySendBatchParams::PreferredChannel }
+
+      # @!attribute schedule_at
+      #   Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply
+      #   with local time windows.
+      #
+      #   @return [Time, nil]
+      optional :schedule_at, Time
+
+      # @!attribute variables
+      #   The variables to be replaced in the template.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, preferred_channel: nil, schedule_at: nil, variables: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifySendBatchParams} for more details.
+      #
+      #   @param template_id [String] The template identifier configured by your Customer Success team.
+      #
+      #   @param to [Array<String>] The list of recipients' phone numbers in E.164 format.
+      #
+      #   @param callback_url [String] The URL where webhooks will be sent for delivery events.
+      #
+      #   @param correlation_id [String] A user-defined identifier to correlate this request with your internal systems.
+      #
+      #   @param expires_at [Time] The message expiration date in RFC3339 format. Messages will not be sent after t
+      #
+      #   @param from [String] The Sender ID. Must be approved for your account.
+      #
+      #   @param locale [String] A BCP-47 formatted locale string.
+      #
+      #   @param preferred_channel [Symbol, PreludeSDK::Models::NotifySendBatchParams::PreferredChannel] Preferred channel for delivery. If unavailable, automatic fallback applies.
+      #
+      #   @param schedule_at [Time] Schedule delivery in RFC3339 format. Marketing sends may be adjusted to comply w
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Preferred channel for delivery. If unavailable, automatic fallback applies.
+      module PreferredChannel
+        extend PreludeSDK::Internal::Type::Enum
+
+        SMS = :sms
+        WHATSAPP = :whatsapp
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_send_batch_response.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#send_batch
+    class NotifySendBatchResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute error_count
+      #   Number of failed sends.
+      #
+      #   @return [Integer]
+      required :error_count, Integer
+
+      # @!attribute results
+      #   The per-recipient result of the bulk send.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifySendBatchResponse::Result>]
+      required :results,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifySendBatchResponse::Result] }
+
+      # @!attribute success_count
+      #   Number of successful sends.
+      #
+      #   @return [Integer]
+      required :success_count, Integer
+
+      # @!attribute total_count
+      #   Total number of recipients.
+      #
+      #   @return [Integer]
+      required :total_count, Integer
+
+      # @!attribute callback_url
+      #   The callback URL used for this bulk request, if any.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute request_id
+      #   A string that identifies this specific request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute template_id
+      #   The template identifier used for this bulk request.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute variables
+      #   The variables used for this bulk request.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!method initialize(error_count:, results:, success_count:, total_count:, callback_url: nil, request_id: nil, template_id: nil, variables: nil)
+      #   @param error_count [Integer] Number of failed sends.
+      #
+      #   @param results [Array<PreludeSDK::Models::NotifySendBatchResponse::Result>] The per-recipient result of the bulk send.
+      #
+      #   @param success_count [Integer] Number of successful sends.
+      #
+      #   @param total_count [Integer] Total number of recipients.
+      #
+      #   @param callback_url [String] The callback URL used for this bulk request, if any.
+      #
+      #   @param request_id [String] A string that identifies this specific request.
+      #
+      #   @param template_id [String] The template identifier used for this bulk request.
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables used for this bulk request.
+
+      class Result < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute phone_number
+        #   The recipient's phone number in E.164 format.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!attribute success
+        #   Whether the message was accepted for delivery.
+        #
+        #   @return [Boolean]
+        required :success, PreludeSDK::Internal::Type::Boolean
+
+        # @!attribute error
+        #   Present only if success is false.
+        #
+        #   @return [PreludeSDK::Models::NotifySendBatchResponse::Result::Error, nil]
+        optional :error, -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Error }
+
+        # @!attribute message
+        #   Present only if success is true.
+        #
+        #   @return [PreludeSDK::Models::NotifySendBatchResponse::Result::Message, nil]
+        optional :message, -> { PreludeSDK::Models::NotifySendBatchResponse::Result::Message }
+
+        # @!method initialize(phone_number:, success:, error: nil, message: nil)
+        #   @param phone_number [String] The recipient's phone number in E.164 format.
+        #
+        #   @param success [Boolean] Whether the message was accepted for delivery.
+        #
+        #   @param error [PreludeSDK::Models::NotifySendBatchResponse::Result::Error] Present only if success is false.
+        #
+        #   @param message [PreludeSDK::Models::NotifySendBatchResponse::Result::Message] Present only if success is true.
+
+        # @see PreludeSDK::Models::NotifySendBatchResponse::Result#error
+        class Error < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute code
+          #   The error code.
+          #
+          #   @return [String, nil]
+          optional :code, String
+
+          # @!attribute message
+          #   A human-readable error message.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!method initialize(code: nil, message: nil)
+          #   Present only if success is false.
+          #
+          #   @param code [String] The error code.
+          #
+          #   @param message [String] A human-readable error message.
+        end
+
+        # @see PreludeSDK::Models::NotifySendBatchResponse::Result#message
+        class Message < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   The message identifier.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute correlation_id
+          #   The correlation identifier for the message.
+          #
+          #   @return [String, nil]
+          optional :correlation_id, String
+
+          # @!attribute created_at
+          #   The message creation date in RFC3339 format.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute expires_at
+          #   The message expiration date in RFC3339 format.
+          #
+          #   @return [Time, nil]
+          optional :expires_at, Time
+
+          # @!attribute from
+          #   The Sender ID used for this message.
+          #
+          #   @return [String, nil]
+          optional :from, String
+
+          # @!attribute locale
+          #   The locale used for the message, if any.
+          #
+          #   @return [String, nil]
+          optional :locale, String
+
+          # @!attribute schedule_at
+          #   When the message will actually be sent in RFC3339 format with timezone offset.
+          #
+          #   @return [Time, nil]
+          optional :schedule_at, Time
+
+          # @!attribute to
+          #   The recipient's phone number in E.164 format.
+          #
+          #   @return [String, nil]
+          optional :to, String
+
+          # @!method initialize(id: nil, correlation_id: nil, created_at: nil, expires_at: nil, from: nil, locale: nil, schedule_at: nil, to: nil)
+          #   Present only if success is true.
+          #
+          #   @param id [String] The message identifier.
+          #
+          #   @param correlation_id [String] The correlation identifier for the message.
+          #
+          #   @param created_at [Time] The message creation date in RFC3339 format.
+          #
+          #   @param expires_at [Time] The message expiration date in RFC3339 format.
+          #
+          #   @param from [String] The Sender ID used for this message.
+          #
+          #   @param locale [String] The locale used for the message, if any.
+          #
+          #   @param schedule_at [Time] When the message will actually be sent in RFC3339 format with timezone offset.
+          #
+          #   @param to [String] The recipient's phone number in E.164 format.
+        end
+      end
+    end
+  end
+end