prelude-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd2764aef5a2905ae9ff686383745a878831c2402b1858f60025c4185f9fce1
-  data.tar.gz: be34c995e5c189bd7bfc38a03f30d0e399376ffdbb70f42c3776f64df56de7e4
+  metadata.gz: 20bf770b210bf23b3214f6dc77fd7e2f74a96869d52c7f96788a548a87c8afb0
+  data.tar.gz: fcb6a885d033659e8a2d8f7c91b97e04cf9df00ac8da6ad1392961f77f52c525
 SHA512:
-  metadata.gz: 953de3f45bdc0854d720388783118e6daff94fcfda5fa3de09bace85598b61e7165f87ac2439f1c275822e80f6811d711c055d2d8b5399824aec74f2dd715208
-  data.tar.gz: c7b590b961d3bcdb03aafbcc97fa3d4c80e0ac59a70a2dd79451000fe300b702c90a1cb30f7a6fa8c0604c73365f4e5fbb0da7a05e0df2aa77a1ee672ce5e008
+  metadata.gz: 2797a1a23e09c4a7038ac2f06a86d491c1505c734d7fecaea592b7d0fc125818a1517cab2d1431229c3cf1634b8847c754e58b511c7d7968517f2095a3aa1536
+  data.tar.gz: 5bdad09b05d0f22ceba1f75fd9b3fbf7f045331729c288ae938b78de419a378382469347e1ea50ab7f6fcf044f3ffe120ff27136c995ea163bad08987991840c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.2.0 (2025-12-05)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** add Notify API methods ([8ce7793](https://github.com/prelude-so/ruby-sdk/commit/8ce7793912b2b074deaa66c32e4cc2b7d0873623))
+
+
+### Chores
+
+* explicitly require "base64" gem ([ce6be23](https://github.com/prelude-so/ruby-sdk/commit/ce6be23941786dfe0ed1356b31eb65014da48407))
+
 ## 0.1.0 (2025-11-17)
 
 Full Changelog: [v0.1.0-alpha.3...v0.1.0](https://github.com/prelude-so/ruby-sdk/compare/v0.1.0-alpha.3...v0.1.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "prelude-sdk", "~> 0.1.0"
+gem "prelude-sdk", "~> 0.2.0"
 ```
 
 <!-- x-release-please-end -->
@@ -207,25 +207,25 @@ prelude.verification.create(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :allow
-puts(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW)
+# :SUB
+puts(PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::SUB)
 
-# Revealed type: `T.all(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action, Symbol)`
-T.reveal_type(PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW)
+# Revealed type: `T.all(PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State, Symbol)`
+T.reveal_type(PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::SUB)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-prelude.verification_management.delete_phone_number(
-  action: PreludeSDK::VerificationManagementDeletePhoneNumberParams::Action::ALLOW,
+prelude.notify.list_subscription_phone_numbers(
+  state: PreludeSDK::NotifyListSubscriptionPhoneNumbersParams::State::SUB,
   # …
 )
 
 # Literal values are also permissible:
-prelude.verification_management.delete_phone_number(
-  action: :allow,
+prelude.notify.list_subscription_phone_numbers(
+  state: :SUB,
   # …
 )
 ```

data/lib/prelude_sdk/client.rb

@@ -22,6 +22,9 @@ module PreludeSDK
     # @return [PreludeSDK::Resources::Lookup]
     attr_reader :lookup
 
+    # @return [PreludeSDK::Resources::Notify]
+    attr_reader :notify
+
     # @return [PreludeSDK::Resources::Transactional]
     attr_reader :transactional
 
@@ -82,6 +85,7 @@ module PreludeSDK
       )
 
       @lookup = PreludeSDK::Resources::Lookup.new(client: self)
+      @notify = PreludeSDK::Resources::Notify.new(client: self)
       @transactional = PreludeSDK::Resources::Transactional.new(client: self)
       @verification = PreludeSDK::Resources::Verification.new(client: self)
       @verification_management = PreludeSDK::Resources::VerificationManagement.new(client: self)

data/lib/prelude_sdk/models/notify_get_subscription_config_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#get_subscription_config
+    class NotifyGetSubscriptionConfigParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_get_subscription_config_response.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#get_subscription_config
+    class NotifyGetSubscriptionConfigResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The subscription configuration ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute callback_url
+      #   The URL to call when subscription status changes.
+      #
+      #   @return [String]
+      required :callback_url, String
+
+      # @!attribute created_at
+      #   The date and time when the configuration was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute messages
+      #   The subscription messages configuration.
+      #
+      #   @return [PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages]
+      required :messages, -> { PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages }
+
+      # @!attribute name
+      #   The human-readable name for the subscription configuration.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #   The date and time when the configuration was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute mo_phone_numbers
+      #   A list of phone numbers for receiving inbound messages.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber>, nil]
+      optional :mo_phone_numbers,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber] }
+
+      # @!method initialize(id:, callback_url:, created_at:, messages:, name:, updated_at:, mo_phone_numbers: nil)
+      #   @param id [String] The subscription configuration ID.
+      #
+      #   @param callback_url [String] The URL to call when subscription status changes.
+      #
+      #   @param created_at [Time] The date and time when the configuration was created.
+      #
+      #   @param messages [PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::Messages] The subscription messages configuration.
+      #
+      #   @param name [String] The human-readable name for the subscription configuration.
+      #
+      #   @param updated_at [Time] The date and time when the configuration was last updated.
+      #
+      #   @param mo_phone_numbers [Array<PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber>] A list of phone numbers for receiving inbound messages.
+
+      # @see PreludeSDK::Models::NotifyGetSubscriptionConfigResponse#messages
+      class Messages < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute help_message
+        #   Message sent when user requests help.
+        #
+        #   @return [String, nil]
+        optional :help_message, String
+
+        # @!attribute start_message
+        #   Message sent when user subscribes.
+        #
+        #   @return [String, nil]
+        optional :start_message, String
+
+        # @!attribute stop_message
+        #   Message sent when user unsubscribes.
+        #
+        #   @return [String, nil]
+        optional :stop_message, String
+
+        # @!method initialize(help_message: nil, start_message: nil, stop_message: nil)
+        #   The subscription messages configuration.
+        #
+        #   @param help_message [String] Message sent when user requests help.
+        #
+        #   @param start_message [String] Message sent when user subscribes.
+        #
+        #   @param stop_message [String] Message sent when user unsubscribes.
+      end
+
+      class MoPhoneNumber < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute country_code
+        #   The ISO 3166-1 alpha-2 country code.
+        #
+        #   @return [String]
+        required :country_code, String
+
+        # @!attribute phone_number
+        #   The phone number in E.164 format for long codes, or short code format for short
+        #   codes.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!method initialize(country_code:, phone_number:)
+        #   Some parameter documentations has been truncated, see
+        #   {PreludeSDK::Models::NotifyGetSubscriptionConfigResponse::MoPhoneNumber} for
+        #   more details.
+        #
+        #   @param country_code [String] The ISO 3166-1 alpha-2 country code.
+        #
+        #   @param phone_number [String] The phone number in E.164 format for long codes, or short code format for short
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_get_subscription_phone_number_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#get_subscription_phone_number
+    class NotifyGetSubscriptionPhoneNumberParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute config_id
+      #
+      #   @return [String]
+      required :config_id, String
+
+      # @!method initialize(config_id:, request_options: {})
+      #   @param config_id [String]
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_get_subscription_phone_number_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#get_subscription_phone_number
+    class NotifyGetSubscriptionPhoneNumberResponse < 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::NotifyGetSubscriptionPhoneNumberResponse::Source]
+      required :source, enum: -> { PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::Source }
+
+      # @!attribute state
+      #   The subscription state:
+      #
+      #   - `SUB` - Subscribed (user can receive marketing messages)
+      #   - `UNSUB` - Unsubscribed (user has opted out)
+      #
+      #   @return [Symbol, PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::State]
+      required :state, enum: -> { PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse} 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::NotifyGetSubscriptionPhoneNumberResponse::Source] How the subscription state was changed:
+      #
+      #   @param state [Symbol, PreludeSDK::Models::NotifyGetSubscriptionPhoneNumberResponse::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::NotifyGetSubscriptionPhoneNumberResponse#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::NotifyGetSubscriptionPhoneNumberResponse#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_configs_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_configs
+    class NotifyListSubscriptionConfigsParams < 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 configurations to return per page
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   @param cursor [String] Pagination cursor from the previous response
+      #
+      #   @param limit [Integer] Maximum number of configurations to return per page
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_list_subscription_configs_response.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_configs
+    class NotifyListSubscriptionConfigsResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute configs
+      #   A list of subscription management configurations.
+      #
+      #   @return [Array<PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config>]
+      required :configs,
+               -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config] }
+
+      # @!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(configs:, next_cursor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::NotifyListSubscriptionConfigsResponse} for more details.
+      #
+      #   @param configs [Array<PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config>] A list of subscription management configurations.
+      #
+      #   @param next_cursor [String] Pagination cursor for the next page of results. Omitted if there are no more pag
+
+      class Config < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The subscription configuration ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute callback_url
+        #   The URL to call when subscription status changes.
+        #
+        #   @return [String]
+        required :callback_url, String
+
+        # @!attribute created_at
+        #   The date and time when the configuration was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute messages
+        #   The subscription messages configuration.
+        #
+        #   @return [PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages]
+        required :messages, -> { PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages }
+
+        # @!attribute name
+        #   The human-readable name for the subscription configuration.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute updated_at
+        #   The date and time when the configuration was last updated.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute mo_phone_numbers
+        #   A list of phone numbers for receiving inbound messages.
+        #
+        #   @return [Array<PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber>, nil]
+        optional :mo_phone_numbers,
+                 -> { PreludeSDK::Internal::Type::ArrayOf[PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber] }
+
+        # @!method initialize(id:, callback_url:, created_at:, messages:, name:, updated_at:, mo_phone_numbers: nil)
+        #   @param id [String] The subscription configuration ID.
+        #
+        #   @param callback_url [String] The URL to call when subscription status changes.
+        #
+        #   @param created_at [Time] The date and time when the configuration was created.
+        #
+        #   @param messages [PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::Messages] The subscription messages configuration.
+        #
+        #   @param name [String] The human-readable name for the subscription configuration.
+        #
+        #   @param updated_at [Time] The date and time when the configuration was last updated.
+        #
+        #   @param mo_phone_numbers [Array<PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber>] A list of phone numbers for receiving inbound messages.
+
+        # @see PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config#messages
+        class Messages < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute help_message
+          #   Message sent when user requests help.
+          #
+          #   @return [String, nil]
+          optional :help_message, String
+
+          # @!attribute start_message
+          #   Message sent when user subscribes.
+          #
+          #   @return [String, nil]
+          optional :start_message, String
+
+          # @!attribute stop_message
+          #   Message sent when user unsubscribes.
+          #
+          #   @return [String, nil]
+          optional :stop_message, String
+
+          # @!method initialize(help_message: nil, start_message: nil, stop_message: nil)
+          #   The subscription messages configuration.
+          #
+          #   @param help_message [String] Message sent when user requests help.
+          #
+          #   @param start_message [String] Message sent when user subscribes.
+          #
+          #   @param stop_message [String] Message sent when user unsubscribes.
+        end
+
+        class MoPhoneNumber < PreludeSDK::Internal::Type::BaseModel
+          # @!attribute country_code
+          #   The ISO 3166-1 alpha-2 country code.
+          #
+          #   @return [String]
+          required :country_code, String
+
+          # @!attribute phone_number
+          #   The phone number in E.164 format for long codes, or short code format for short
+          #   codes.
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(country_code:, phone_number:)
+          #   Some parameter documentations has been truncated, see
+          #   {PreludeSDK::Models::NotifyListSubscriptionConfigsResponse::Config::MoPhoneNumber}
+          #   for more details.
+          #
+          #   @param country_code [String] The ISO 3166-1 alpha-2 country code.
+          #
+          #   @param phone_number [String] The phone number in E.164 format for long codes, or short code format for short
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/notify_list_subscription_phone_number_events_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Notify#list_subscription_phone_number_events
+    class NotifyListSubscriptionPhoneNumberEventsParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute config_id
+      #
+      #   @return [String]
+      required :config_id, String
+
+      # @!attribute cursor
+      #   Pagination cursor from the previous response
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Maximum number of events to return per page
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(config_id:, cursor: nil, limit: nil, request_options: {})
+      #   @param config_id [String]
+      #
+      #   @param cursor [String] Pagination cursor from the previous response
+      #
+      #   @param limit [Integer] Maximum number of events to return per page
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end