trycourier 3.4.0.pre.alpha4 → 3.4.0.pre.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8ed19fc539c3c0b660cf35d5475515d40c75b21e2e039a8f0cc069637741c7
-  data.tar.gz: 2b198bf79669dc0b800d7f0ea057a4ec53cba426c3f2dd00d13f76027c9295a5
+  metadata.gz: f14ee1336a781820bc7322a988b66af49dc962deb69ca3d632678a9d87418dae
+  data.tar.gz: 48cf6121b3dfdea6d0333a4d3c099dcdff65a44e487312ff4c662e8132e7da96
 SHA512:
-  metadata.gz: 93294b8e7d0c2976e02862888f528ca968c9d96a25a123f6482abb92d037543734af2f22007edbee2fcc19c7d7537e31e3099643bbb8d3adc97fad88af5ce2c3
-  data.tar.gz: 60bc826438268cc30b97995839221fa86c1da5034a740521a9fb946f56988644379441daea03c4c1d373913a54fd23f5f9bcf5a3aaa7386b29740e47cffe6b44
+  metadata.gz: 76668745729ceabd8103834ff1c0a4f314554bb7011cfed1602474b3d7209b742b6f68f62a25a24e8b49cdb1c72391a83ff4502c52df1ed34eb7c4173a05ffe5
+  data.tar.gz: eea8f1d219fd7253402ae012e2e5364d4e80b93e35eba7f124426ce03f95afdc2c776ad342c3af80ccf5b4005c36f2300780ceeca4358f926c82befcc3f9a215

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 3.4.0-alpha5 (2025-10-17)
+
+Full Changelog: [v3.4.0-alpha4...v3.4.0-alpha5](https://github.com/trycourier/courier-ruby/compare/v3.4.0-alpha4...v3.4.0-alpha5)
+
+### Bug Fixes
+
+* Updated paths for each model and go example updates ([3589716](https://github.com/trycourier/courier-ruby/commit/358971631427bdec2f3c609aa0b96139ee285503))
+
 ## 3.4.0-alpha4 (2025-10-16)
 
 Full Changelog: [v3.4.0-alpha3...v3.4.0-alpha4](https://github.com/trycourier/courier-ruby/compare/v3.4.0-alpha3...v3.4.0-alpha4)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "trycourier", "~> 3.4.0.pre.alpha4"
+gem "trycourier", "~> 3.4.0.pre.alpha5"
 ```
 
 <!-- x-release-please-end -->

data/lib/trycourier/internal/type/base_model.rb

@@ -438,11 +438,9 @@ module Trycourier
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `audience` is a `Trycourier::Audience`
-        #   audience => {
-        #     id: id,
-        #     created_at: created_at,
-        #     description: description
+        #   # `channel_preference` is a `Trycourier::ChannelPreference`
+        #   channel_preference => {
+        #     channel: channel
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/trycourier/models/audience.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Audiences#retrieve
     class Audience < Trycourier::Internal::Type::BaseModel
       # @!attribute id
       #   A unique identifier representing the audience_id

data/lib/trycourier/models/audit_event.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::AuditEvents#retrieve
     class AuditEvent < Trycourier::Internal::Type::BaseModel
       # @!attribute actor
       #

data/lib/trycourier/models/brand.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Brands#create
     class Brand < Trycourier::Internal::Type::BaseModel
       # @!attribute id
       #

data/lib/trycourier/models/message_details.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Messages#cancel
     class MessageDetails < Trycourier::Internal::Type::BaseModel
       # @!attribute id
       #   A unique identifier associated with the message you wish to retrieve (results

data/lib/trycourier/models/notification_get_content.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Notifications#retrieve_content
     class NotificationGetContent < Trycourier::Internal::Type::BaseModel
       # @!attribute blocks
       #

data/lib/trycourier/models/subscription_list.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Lists#retrieve
     class SubscriptionList < Trycourier::Internal::Type::BaseModel
       # @!attribute id
       #

data/lib/trycourier/models/tenant.rb

@@ -2,6 +2,7 @@
 
 module Trycourier
   module Models
+    # @see Trycourier::Resources::Tenants#retrieve
     class Tenant < Trycourier::Internal::Type::BaseModel
       # @!attribute id
       #   Id of the tenant.

data/lib/trycourier/models/users/preference_retrieve_response.rb

@@ -8,8 +8,8 @@ module Trycourier
         # @!attribute items
         #   The Preferences associated with the user_id.
         #
-        #   @return [Array<Trycourier::Models::TopicPreference>]
-        required :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::TopicPreference] }
+        #   @return [Array<Trycourier::Models::Users::TopicPreference>]
+        required :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Users::TopicPreference] }
 
         # @!attribute paging
         #   Deprecated - Paging not implemented on this endpoint
@@ -18,7 +18,7 @@ module Trycourier
         required :paging, -> { Trycourier::Paging }
 
         # @!method initialize(items:, paging:)
-        #   @param items [Array<Trycourier::Models::TopicPreference>] The Preferences associated with the user_id.
+        #   @param items [Array<Trycourier::Models::Users::TopicPreference>] The Preferences associated with the user_id.
         #
         #   @param paging [Trycourier::Models::Paging] Deprecated - Paging not implemented on this endpoint
       end

data/lib/trycourier/models/users/preference_retrieve_topic_response.rb

@@ -7,11 +7,11 @@ module Trycourier
       class PreferenceRetrieveTopicResponse < Trycourier::Internal::Type::BaseModel
         # @!attribute topic
         #
-        #   @return [Trycourier::Models::TopicPreference]
-        required :topic, -> { Trycourier::TopicPreference }
+        #   @return [Trycourier::Models::Users::TopicPreference]
+        required :topic, -> { Trycourier::Users::TopicPreference }
 
         # @!method initialize(topic:)
-        #   @param topic [Trycourier::Models::TopicPreference]
+        #   @param topic [Trycourier::Models::Users::TopicPreference]
       end
     end
   end

data/lib/trycourier/models/users/token_add_single_params.rb

@@ -4,7 +4,7 @@ module Trycourier
   module Models
     module Users
       # @see Trycourier::Resources::Users::Tokens#add_single
-      class TokenAddSingleParams < Trycourier::Models::UserToken
+      class TokenAddSingleParams < Trycourier::Models::Users::UserToken
         extend Trycourier::Internal::Type::RequestParameters::Converter
         include Trycourier::Internal::Type::RequestParameters
 

data/lib/trycourier/models/users/token_list_response.rb

@@ -4,7 +4,7 @@ module Trycourier
   module Models
     module Users
       # @type [Trycourier::Internal::Type::Converter]
-      TokenListResponse = Trycourier::Internal::Type::ArrayOf[-> { Trycourier::UserToken }]
+      TokenListResponse = Trycourier::Internal::Type::ArrayOf[-> { Trycourier::Users::UserToken }]
     end
   end
 end

data/lib/trycourier/models/users/token_retrieve_response.rb

@@ -4,7 +4,7 @@ module Trycourier
   module Models
     module Users
       # @see Trycourier::Resources::Users::Tokens#retrieve
-      class TokenRetrieveResponse < Trycourier::Models::UserToken
+      class TokenRetrieveResponse < Trycourier::Models::Users::UserToken
         # @!attribute status
         #
         #   @return [Symbol, Trycourier::Models::Users::TokenRetrieveResponse::Status, nil]

data/lib/trycourier/models/users/topic_preference.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      class TopicPreference < Trycourier::Internal::Type::BaseModel
+        # @!attribute default_status
+        #
+        #   @return [Symbol, Trycourier::Models::PreferenceStatus]
+        required :default_status, enum: -> { Trycourier::PreferenceStatus }
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Trycourier::Models::PreferenceStatus]
+        required :status, enum: -> { Trycourier::PreferenceStatus }
+
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
+        # @!attribute topic_name
+        #
+        #   @return [String]
+        required :topic_name, String
+
+        # @!attribute custom_routing
+        #   The Channels a user has chosen to receive notifications through for this topic
+        #
+        #   @return [Array<Symbol, Trycourier::Models::ChannelClassification>, nil]
+        optional :custom_routing,
+                 -> { Trycourier::Internal::Type::ArrayOf[enum: Trycourier::ChannelClassification] },
+                 nil?: true
+
+        # @!attribute has_custom_routing
+        #
+        #   @return [Boolean, nil]
+        optional :has_custom_routing, Trycourier::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(default_status:, status:, topic_id:, topic_name:, custom_routing: nil, has_custom_routing: nil)
+        #   @param default_status [Symbol, Trycourier::Models::PreferenceStatus]
+        #
+        #   @param status [Symbol, Trycourier::Models::PreferenceStatus]
+        #
+        #   @param topic_id [String]
+        #
+        #   @param topic_name [String]
+        #
+        #   @param custom_routing [Array<Symbol, Trycourier::Models::ChannelClassification>, nil] The Channels a user has chosen to receive notifications through for this topic
+        #
+        #   @param has_custom_routing [Boolean, nil]
+      end
+    end
+  end
+end

data/lib/trycourier/models/users/user_token.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      class UserToken < Trycourier::Internal::Type::BaseModel
+        # @!attribute provider_key
+        #
+        #   @return [Symbol, Trycourier::Models::Users::UserToken::ProviderKey]
+        required :provider_key, enum: -> { Trycourier::Users::UserToken::ProviderKey }
+
+        # @!attribute token
+        #   Full body of the token. Must match token in URL.
+        #
+        #   @return [String, nil]
+        optional :token, String, nil?: true
+
+        # @!attribute device
+        #   Information about the device the token is associated with.
+        #
+        #   @return [Trycourier::Models::Users::UserToken::Device, nil]
+        optional :device, -> { Trycourier::Users::UserToken::Device }, nil?: true
+
+        # @!attribute expiry_date
+        #   ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        #   disable expiration.
+        #
+        #   @return [String, Boolean, nil]
+        optional :expiry_date, union: -> { Trycourier::Users::UserToken::ExpiryDate }, nil?: true
+
+        # @!attribute properties
+        #   Properties sent to the provider along with the token
+        #
+        #   @return [Object, nil]
+        optional :properties, Trycourier::Internal::Type::Unknown
+
+        # @!attribute tracking
+        #   Information about the device the token is associated with.
+        #
+        #   @return [Trycourier::Models::Users::UserToken::Tracking, nil]
+        optional :tracking, -> { Trycourier::Users::UserToken::Tracking }, nil?: true
+
+        # @!method initialize(provider_key:, token: nil, device: nil, expiry_date: nil, properties: nil, tracking: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Trycourier::Models::Users::UserToken} for more details.
+        #
+        #   @param provider_key [Symbol, Trycourier::Models::Users::UserToken::ProviderKey]
+        #
+        #   @param token [String, nil] Full body of the token. Must match token in URL.
+        #
+        #   @param device [Trycourier::Models::Users::UserToken::Device, nil] Information about the device the token is associated with.
+        #
+        #   @param expiry_date [String, Boolean, nil] ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        #
+        #   @param properties [Object] Properties sent to the provider along with the token
+        #
+        #   @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Information about the device the token is associated with.
+
+        # @see Trycourier::Models::Users::UserToken#provider_key
+        module ProviderKey
+          extend Trycourier::Internal::Type::Enum
+
+          FIREBASE_FCM = :"firebase-fcm"
+          APN = :apn
+          EXPO = :expo
+          ONESIGNAL = :onesignal
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Trycourier::Models::Users::UserToken#device
+        class Device < Trycourier::Internal::Type::BaseModel
+          # @!attribute ad_id
+          #   Id of the advertising identifier
+          #
+          #   @return [String, nil]
+          optional :ad_id, String, nil?: true
+
+          # @!attribute app_id
+          #   Id of the application the token is used for
+          #
+          #   @return [String, nil]
+          optional :app_id, String, nil?: true
+
+          # @!attribute device_id
+          #   Id of the device the token is associated with
+          #
+          #   @return [String, nil]
+          optional :device_id, String, nil?: true
+
+          # @!attribute manufacturer
+          #   The device manufacturer
+          #
+          #   @return [String, nil]
+          optional :manufacturer, String, nil?: true
+
+          # @!attribute model
+          #   The device model
+          #
+          #   @return [String, nil]
+          optional :model, String, nil?: true
+
+          # @!attribute platform
+          #   The device platform i.e. android, ios, web
+          #
+          #   @return [String, nil]
+          optional :platform, String, nil?: true
+
+          # @!method initialize(ad_id: nil, app_id: nil, device_id: nil, manufacturer: nil, model: nil, platform: nil)
+          #   Information about the device the token is associated with.
+          #
+          #   @param ad_id [String, nil] Id of the advertising identifier
+          #
+          #   @param app_id [String, nil] Id of the application the token is used for
+          #
+          #   @param device_id [String, nil] Id of the device the token is associated with
+          #
+          #   @param manufacturer [String, nil] The device manufacturer
+          #
+          #   @param model [String, nil] The device model
+          #
+          #   @param platform [String, nil] The device platform i.e. android, ios, web
+        end
+
+        # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        # disable expiration.
+        #
+        # @see Trycourier::Models::Users::UserToken#expiry_date
+        module ExpiryDate
+          extend Trycourier::Internal::Type::Union
+
+          variant String
+
+          variant Trycourier::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Boolean)]
+        end
+
+        # @see Trycourier::Models::Users::UserToken#tracking
+        class Tracking < Trycourier::Internal::Type::BaseModel
+          # @!attribute ip
+          #   The IP address of the device
+          #
+          #   @return [String, nil]
+          optional :ip, String, nil?: true
+
+          # @!attribute lat
+          #   The latitude of the device
+          #
+          #   @return [String, nil]
+          optional :lat, String, nil?: true
+
+          # @!attribute long
+          #   The longitude of the device
+          #
+          #   @return [String, nil]
+          optional :long, String, nil?: true
+
+          # @!attribute os_version
+          #   The operating system version
+          #
+          #   @return [String, nil]
+          optional :os_version, String, nil?: true
+
+          # @!method initialize(ip: nil, lat: nil, long: nil, os_version: nil)
+          #   Information about the device the token is associated with.
+          #
+          #   @param ip [String, nil] The IP address of the device
+          #
+          #   @param lat [String, nil] The latitude of the device
+          #
+          #   @param long [String, nil] The longitude of the device
+          #
+          #   @param os_version [String, nil] The operating system version
+        end
+      end
+    end
+
+    UserToken = Users::UserToken
+  end
+end

data/lib/trycourier/models.rb

@@ -251,8 +251,6 @@ module Trycourier
 
   TextStyle = Trycourier::Models::TextStyle
 
-  TopicPreference = Trycourier::Models::TopicPreference
-
   TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
 
   TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
@@ -261,8 +259,6 @@ module Trycourier
 
   Users = Trycourier::Models::Users
 
-  UserToken = Trycourier::Models::UserToken
-
   Utm = Trycourier::Models::Utm
 
   WidgetBackground = Trycourier::Models::WidgetBackground

data/lib/trycourier/resources/users/tokens.rb

@@ -69,14 +69,14 @@ module Trycourier
         #
         # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Trycourier::Models::UserToken>]
+        # @return [Array<Trycourier::Models::Users::UserToken>]
         #
         # @see Trycourier::Models::Users::TokenListParams
         def list(user_id, params = {})
           @client.request(
             method: :get,
             path: ["users/%1$s/tokens", user_id],
-            model: Trycourier::Internal::Type::ArrayOf[Trycourier::UserToken],
+            model: Trycourier::Internal::Type::ArrayOf[Trycourier::Users::UserToken],
             options: params[:request_options]
           )
         end
@@ -139,17 +139,17 @@ module Trycourier
         #
         # @param user_id [String] Path param: The user's ID. This can be any uniquely identifiable string.
         #
-        # @param provider_key [Symbol, Trycourier::Models::UserToken::ProviderKey] Body param:
+        # @param provider_key [Symbol, Trycourier::Models::Users::UserToken::ProviderKey] Body param:
         #
         # @param body_token [String, nil] Body param: Full body of the token. Must match token in URL.
         #
-        # @param device [Trycourier::Models::UserToken::Device, nil] Body param: Information about the device the token is associated with.
+        # @param device [Trycourier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token is associated with.
         #
         # @param expiry_date [String, Boolean, nil] Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set
         #
         # @param properties [Object] Body param: Properties sent to the provider along with the token
         #
-        # @param tracking [Trycourier::Models::UserToken::Tracking, nil] Body param: Information about the device the token is associated with.
+        # @param tracking [Trycourier::Models::Users::UserToken::Tracking, nil] Body param: Information about the device the token is associated with.
         #
         # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/trycourier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trycourier
-  VERSION = "3.4.0.pre.alpha4"
+  VERSION = "3.4.0.pre.alpha5"
 end

data/lib/trycourier.rb

@@ -58,7 +58,7 @@ require_relative "trycourier/models/subscription_topic_new"
 require_relative "trycourier/models/elemental_channel_node"
 require_relative "trycourier/models/message_details"
 require_relative "trycourier/models/base_template_tenant_association"
-require_relative "trycourier/models/user_token"
+require_relative "trycourier/models/users/user_token"
 require_relative "trycourier/models/alignment"
 require_relative "trycourier/models/audience"
 require_relative "trycourier/models/audience_delete_params"
@@ -199,7 +199,6 @@ require_relative "trycourier/models/tenants/tenant_default_preferences/item_dele
 require_relative "trycourier/models/tenants/tenant_default_preferences/item_update_params"
 require_relative "trycourier/models/tenant_update_params"
 require_relative "trycourier/models/text_style"
-require_relative "trycourier/models/topic_preference"
 require_relative "trycourier/models/translation_retrieve_params"
 require_relative "trycourier/models/translation_retrieve_response"
 require_relative "trycourier/models/translation_update_params"
@@ -224,6 +223,7 @@ require_relative "trycourier/models/users/token_list_response"
 require_relative "trycourier/models/users/token_retrieve_params"
 require_relative "trycourier/models/users/token_retrieve_response"
 require_relative "trycourier/models/users/token_update_params"
+require_relative "trycourier/models/users/topic_preference"
 require_relative "trycourier/models/utm"
 require_relative "trycourier/models/widget_background"
 require_relative "trycourier/models"

data/rbi/trycourier/models/users/preference_retrieve_response.rbi

@@ -13,7 +13,7 @@ module Trycourier
           end
 
         # The Preferences associated with the user_id.
-        sig { returns(T::Array[Trycourier::TopicPreference]) }
+        sig { returns(T::Array[Trycourier::Users::TopicPreference]) }
         attr_accessor :items
 
         # Deprecated - Paging not implemented on this endpoint
@@ -25,7 +25,7 @@ module Trycourier
 
         sig do
           params(
-            items: T::Array[Trycourier::TopicPreference::OrHash],
+            items: T::Array[Trycourier::Users::TopicPreference::OrHash],
             paging: Trycourier::Paging::OrHash
           ).returns(T.attached_class)
         end
@@ -40,7 +40,7 @@ module Trycourier
         sig do
           override.returns(
             {
-              items: T::Array[Trycourier::TopicPreference],
+              items: T::Array[Trycourier::Users::TopicPreference],
               paging: Trycourier::Paging
             }
           )

data/rbi/trycourier/models/users/preference_retrieve_topic_response.rbi

@@ -12,21 +12,21 @@ module Trycourier
             )
           end
 
-        sig { returns(Trycourier::TopicPreference) }
+        sig { returns(Trycourier::Users::TopicPreference) }
         attr_reader :topic
 
-        sig { params(topic: Trycourier::TopicPreference::OrHash).void }
+        sig { params(topic: Trycourier::Users::TopicPreference::OrHash).void }
         attr_writer :topic
 
         sig do
-          params(topic: Trycourier::TopicPreference::OrHash).returns(
+          params(topic: Trycourier::Users::TopicPreference::OrHash).returns(
             T.attached_class
           )
         end
         def self.new(topic:)
         end
 
-        sig { override.returns({ topic: Trycourier::TopicPreference }) }
+        sig { override.returns({ topic: Trycourier::Users::TopicPreference }) }
         def to_hash
         end
       end

data/rbi/trycourier/models/users/token_add_single_params.rbi

@@ -3,7 +3,7 @@
 module Trycourier
   module Models
     module Users
-      class TokenAddSingleParams < Trycourier::Models::UserToken
+      class TokenAddSingleParams < Trycourier::Models::Users::UserToken
         extend Trycourier::Internal::Type::RequestParameters::Converter
         include Trycourier::Internal::Type::RequestParameters
 

data/rbi/trycourier/models/users/token_list_response.rbi

@@ -5,7 +5,7 @@ module Trycourier
     module Users
       TokenListResponse =
         T.let(
-          Trycourier::Internal::Type::ArrayOf[Trycourier::UserToken],
+          Trycourier::Internal::Type::ArrayOf[Trycourier::Users::UserToken],
           Trycourier::Internal::Type::Converter
         )
     end

data/rbi/trycourier/models/users/token_retrieve_response.rbi

@@ -3,7 +3,7 @@
 module Trycourier
   module Models
     module Users
-      class TokenRetrieveResponse < Trycourier::Models::UserToken
+      class TokenRetrieveResponse < Trycourier::Models::Users::UserToken
         OrHash =
           T.type_alias do
             T.any(