trycourier 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea2404c89e513c6edbd7266b26273fc582d30ba791ad01c6302c69fa617d9056
-  data.tar.gz: 779e524afaab09c6ce8ad61f16f7df393e43c37700e115e4e1ea09f68c494a6e
+  metadata.gz: 2a4f027015d04ed359a86b062efcbc581ee5b5a73580490aa894f93aa5d26a3c
+  data.tar.gz: cb98bc6dd20c7212a25d3503c6f46dcee5177fb86ac9ac409b9ed3466d41cdc8
 SHA512:
-  metadata.gz: 2a7b4546cb947275415973788acb30e65c80921f3d188f2d0ecd7040236d79bab868f7fb27376893632196cb4144c78e86ab5bbc25284c2efd764e99aa6ec333
-  data.tar.gz: 191e3e880ed1fe9a6fc2c402f1f0afef8193fe60f0a1a8f68df3247ff83aafc8210bfa0a8daf49715e8544f4d9dedd47c058615fec3eca59cb83d35c101653f3
+  metadata.gz: 83e592af437c4d50bbcfff2872a49fd97c1d3077304a147bc92ff7593fbf837fd21455bf3c2eb2aab728cab16076c5e3f1b2d8b655847103a4f3a1837276aa03
+  data.tar.gz: ea26ce25919e5f06128658854bec555fddd30641542f3fbfd02677a0c15823298c7782a10edf29f1055c45aac5d9b9a00c911298a85b729ee454c627434124d1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 4.1.0 (2025-11-18)
+
+Full Changelog: [v4.0.0...v4.1.0](https://github.com/trycourier/courier-ruby/compare/v4.0.0...v4.1.0)
+
+### Features
+
+* JWT scope updates ([4d36db2](https://github.com/trycourier/courier-ruby/commit/4d36db263ca5cdb2749a1f118b43021d0848cb7a))
+* NPM enabled ([4f2235d](https://github.com/trycourier/courier-ruby/commit/4f2235d54287d1792ecc6ffae986510e1deb47a4))
+* Test ([dbc83af](https://github.com/trycourier/courier-ruby/commit/dbc83af1bb3c96f874766e751e21ca051cc5d4c4))
+
 ## 4.0.0 (2025-11-12)
 
 Full Changelog: [v3.4.0-alpha9...v4.0.0](https://github.com/trycourier/courier-ruby/compare/v3.4.0-alpha9...v4.0.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 "trycourier", "~> 4.0.0"
+gem "trycourier", "~> 4.1.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/trycourier/models/auth_issue_token_params.rb

@@ -8,18 +8,49 @@ module Trycourier
       include Trycourier::Internal::Type::RequestParameters
 
       # @!attribute expires_in
+      #   Duration for token expiration. Accepts various time formats:
+      #
+      #   - "2 hours" - 2 hours from now
+      #   - "1d" - 1 day
+      #   - "3 days" - 3 days
+      #   - "10h" - 10 hours
+      #   - "2.5 hrs" - 2.5 hours
+      #   - "1m" - 1 minute
+      #   - "5s" - 5 seconds
+      #   - "1y" - 1 year
       #
       #   @return [String]
       required :expires_in, String
 
       # @!attribute scope
+      #   Available scopes:
+      #
+      #   - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+      #     can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+      #   - `read:messages` - Read messages.
+      #   - `read:user-tokens` - Read user push tokens.
+      #   - `write:user-tokens` - Write user push tokens.
+      #   - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+      #     brand_id. Examples `read:brands`, `read:brands:my_brand`.
+      #   - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+      #     specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+      #   - `inbox:read:messages` - Read inbox messages.
+      #   - `inbox:write:events` - Write inbox events, such as mark message as read.
+      #   - `read:preferences` - Read user preferences.
+      #   - `write:preferences` - Write user preferences. Example:
+      #     `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
       #
       #   @return [String]
       required :scope, String
 
       # @!method initialize(expires_in:, scope:, request_options: {})
-      #   @param expires_in [String]
-      #   @param scope [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::AuthIssueTokenParams} for more details.
+      #
+      #   @param expires_in [String] Duration for token expiration. Accepts various time formats:
+      #
+      #   @param scope [String] Available scopes:
+      #
       #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/trycourier/resources/auth.rb

@@ -3,12 +3,17 @@
 module Trycourier
   module Resources
     class Auth
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::AuthIssueTokenParams} for more details.
+      #
       # Returns a new access token.
       #
       # @overload issue_token(expires_in:, scope:, request_options: {})
       #
-      # @param expires_in [String]
-      # @param scope [String]
+      # @param expires_in [String] Duration for token expiration. Accepts various time formats:
+      #
+      # @param scope [String] Available scopes:
+      #
       # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Trycourier::Models::AuthIssueTokenResponse]

data/lib/trycourier/resources/send.rb

@@ -6,7 +6,7 @@ module Trycourier
       # Some parameter documentations has been truncated, see
       # {Trycourier::Models::SendMessageParams} for more details.
       #
-      # API to send a message to one or more recipients.
+      # Send a message to one or more recipients.
       #
       # @overload message(message:, request_options: {})
       #

data/lib/trycourier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trycourier
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

data/rbi/trycourier/models/auth_issue_token_params.rbi

@@ -11,9 +11,35 @@ module Trycourier
           T.any(Trycourier::AuthIssueTokenParams, Trycourier::Internal::AnyHash)
         end
 
+      # Duration for token expiration. Accepts various time formats:
+      #
+      # - "2 hours" - 2 hours from now
+      # - "1d" - 1 day
+      # - "3 days" - 3 days
+      # - "10h" - 10 hours
+      # - "2.5 hrs" - 2.5 hours
+      # - "1m" - 1 minute
+      # - "5s" - 5 seconds
+      # - "1y" - 1 year
       sig { returns(String) }
       attr_accessor :expires_in
 
+      # Available scopes:
+      #
+      # - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+      #   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+      # - `read:messages` - Read messages.
+      # - `read:user-tokens` - Read user push tokens.
+      # - `write:user-tokens` - Write user push tokens.
+      # - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+      #   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+      # - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+      #   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+      # - `inbox:read:messages` - Read inbox messages.
+      # - `inbox:write:events` - Write inbox events, such as mark message as read.
+      # - `read:preferences` - Read user preferences.
+      # - `write:preferences` - Write user preferences. Example:
+      #   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
       sig { returns(String) }
       attr_accessor :scope
 
@@ -24,7 +50,37 @@ module Trycourier
           request_options: Trycourier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(expires_in:, scope:, request_options: {})
+      def self.new(
+        # Duration for token expiration. Accepts various time formats:
+        #
+        # - "2 hours" - 2 hours from now
+        # - "1d" - 1 day
+        # - "3 days" - 3 days
+        # - "10h" - 10 hours
+        # - "2.5 hrs" - 2.5 hours
+        # - "1m" - 1 minute
+        # - "5s" - 5 seconds
+        # - "1y" - 1 year
+        expires_in:,
+        # Available scopes:
+        #
+        # - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+        #   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+        # - `read:messages` - Read messages.
+        # - `read:user-tokens` - Read user push tokens.
+        # - `write:user-tokens` - Write user push tokens.
+        # - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+        #   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+        # - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+        #   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+        # - `inbox:read:messages` - Read inbox messages.
+        # - `inbox:write:events` - Write inbox events, such as mark message as read.
+        # - `read:preferences` - Read user preferences.
+        # - `write:preferences` - Write user preferences. Example:
+        #   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+        scope:,
+        request_options: {}
+      )
       end
 
       sig do

data/rbi/trycourier/resources/auth.rbi

@@ -11,7 +11,37 @@ module Trycourier
           request_options: Trycourier::RequestOptions::OrHash
         ).returns(Trycourier::Models::AuthIssueTokenResponse)
       end
-      def issue_token(expires_in:, scope:, request_options: {})
+      def issue_token(
+        # Duration for token expiration. Accepts various time formats:
+        #
+        # - "2 hours" - 2 hours from now
+        # - "1d" - 1 day
+        # - "3 days" - 3 days
+        # - "10h" - 10 hours
+        # - "2.5 hrs" - 2.5 hours
+        # - "1m" - 1 minute
+        # - "5s" - 5 seconds
+        # - "1y" - 1 year
+        expires_in:,
+        # Available scopes:
+        #
+        # - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+        #   can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+        # - `read:messages` - Read messages.
+        # - `read:user-tokens` - Read user push tokens.
+        # - `write:user-tokens` - Write user push tokens.
+        # - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+        #   brand_id. Examples `read:brands`, `read:brands:my_brand`.
+        # - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+        #   specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+        # - `inbox:read:messages` - Read inbox messages.
+        # - `inbox:write:events` - Write inbox events, such as mark message as read.
+        # - `read:preferences` - Read user preferences.
+        # - `write:preferences` - Write user preferences. Example:
+        #   `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+        scope:,
+        request_options: {}
+      )
       end
 
       # @api private

data/rbi/trycourier/resources/send.rbi

@@ -3,7 +3,7 @@
 module Trycourier
   module Resources
     class Send
-      # API to send a message to one or more recipients.
+      # Send a message to one or more recipients.
       sig do
         params(
           message: Trycourier::SendMessageParams::Message::OrHash,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trycourier
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Courier
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-12 00:00:00.000000000 Z
+date: 2025-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool