trycourier 4.21.0 → 4.22.0

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.21.0"
+  VERSION = "4.22.0"
 end

data/lib/courier.rb

@@ -158,6 +158,8 @@ require_relative "courier/models/filter_config"
 require_relative "courier/models/icons"
 require_relative "courier/models/inbound_track_event_params"
 require_relative "courier/models/inbound_track_event_response"
+require_relative "courier/models/inbox/message_delete_params"
+require_relative "courier/models/inbox/message_restore_params"
 require_relative "courier/models/intercom"
 require_relative "courier/models/intercom_recipient"
 require_relative "courier/models/journey"
@@ -424,6 +426,8 @@ require_relative "courier/resources/brands"
 require_relative "courier/resources/digests"
 require_relative "courier/resources/digests/schedules"
 require_relative "courier/resources/inbound"
+require_relative "courier/resources/inbox"
+require_relative "courier/resources/inbox/messages"
 require_relative "courier/resources/journeys"
 require_relative "courier/resources/journeys/templates"
 require_relative "courier/resources/lists"

data/rbi/courier/client.rbi

@@ -13,60 +13,98 @@ module Courier
     sig { returns(String) }
     attr_reader :api_key
 
+    # Send a message to one or more recipients — users, lists, audiences, or tenants —
+    # across every channel you have configured.
     sig { returns(Courier::Resources::Send) }
     attr_reader :send_
 
+    # Define filter-based groups whose membership Courier recalculates as user
+    # profiles change.
     sig { returns(Courier::Resources::Audiences) }
     attr_reader :audiences
 
+    # Configure the channel providers Courier delivers through, and browse the
+    # provider types it supports.
     sig { returns(Courier::Resources::Providers) }
     attr_reader :providers
 
+    # Read the audit trail of configuration and access changes in your workspace.
     sig { returns(Courier::Resources::AuditEvents) }
     attr_reader :audit_events
 
+    # Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the
+    # embedded designer — can call Courier as a single user. Server-side requests
+    # authenticate with your workspace API key instead.
     sig { returns(Courier::Resources::Auth) }
     attr_reader :auth
 
+    # Invoke a stored automation template or an ad hoc automation defined in the
+    # request.
     sig { returns(Courier::Resources::Automations) }
     attr_reader :automations
 
+    # Build, version, publish, invoke, and cancel multi-step notification workflows,
+    # along with the templates scoped to them.
     sig { returns(Courier::Resources::Journeys) }
     attr_reader :journeys
 
+    # Manage the logos, colors, and layout that give the templates you send a
+    # consistent look.
     sig { returns(Courier::Resources::Brands) }
     attr_reader :brands
 
     sig { returns(Courier::Resources::Digests) }
     attr_reader :digests
 
+    # Record an inbound event that triggers the journeys and automations mapped to it.
     sig { returns(Courier::Resources::Inbound) }
     attr_reader :inbound
 
+    # Manage static groups of users that you subscribe explicitly, and send to them by
+    # list id or list pattern.
     sig { returns(Courier::Resources::Lists) }
     attr_reader :lists
 
+    sig { returns(Courier::Resources::Inbox) }
+    attr_reader :inbox
+
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     sig { returns(Courier::Resources::Messages) }
     attr_reader :messages
 
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     sig { returns(Courier::Resources::Requests) }
     attr_reader :requests
 
+    # Create, update, version, publish, and localize notification templates and their
+    # content.
     sig { returns(Courier::Resources::Notifications) }
     attr_reader :notifications
 
+    # Define reusable channel routing and failover strategies, and see which templates
+    # use them.
     sig { returns(Courier::Resources::RoutingStrategies) }
     attr_reader :routing_strategies
 
+    # Manage the workspace catalog of subscription topics, the sections that group
+    # them, and publishing the preference page.
     sig { returns(Courier::Resources::WorkspacePreferences) }
     attr_reader :workspace_preferences
 
+    # Store the contact information Courier delivers to for each user — email, phone
+    # number, push tokens, and any custom data you send to.
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 
+    # Manage tenants — the organizations, teams, or accounts your users belong to —
+    # along with their users and default preferences.
     sig { returns(Courier::Resources::Tenants) }
     attr_reader :tenants
 
+    # Store and retrieve the translation strings Courier uses to render localized
+    # template content.
     sig { returns(Courier::Resources::Translations) }
     attr_reader :translations
 

data/rbi/courier/models/automations/invoke_invoke_ad_hoc_params.rbi

@@ -43,6 +43,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :template
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             automation:
@@ -52,6 +64,8 @@ module Courier
             profile: T.nilable(T::Hash[Symbol, T.anything]),
             recipient: T.nilable(String),
             template: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -62,6 +76,8 @@ module Courier
           profile: nil,
           recipient: nil,
           template: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -76,6 +92,8 @@ module Courier
               profile: T.nilable(T::Hash[Symbol, T.anything]),
               recipient: T.nilable(String),
               template: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi

@@ -33,6 +33,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :template
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             template_id: String,
@@ -41,6 +53,8 @@ module Courier
             data: T.nilable(T::Hash[Symbol, T.anything]),
             profile: T.nilable(T::Hash[Symbol, T.anything]),
             template: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -51,6 +65,8 @@ module Courier
           data: nil,
           profile: nil,
           template: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -64,6 +80,8 @@ module Courier
               data: T.nilable(T::Hash[Symbol, T.anything]),
               profile: T.nilable(T::Hash[Symbol, T.anything]),
               template: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/brand_create_params.rbi

@@ -29,12 +29,26 @@ module Courier
       sig { params(snippets: T.nilable(Courier::BrandSnippets::OrHash)).void }
       attr_writer :snippets
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           name: String,
           settings: Courier::BrandSettings::OrHash,
           id: T.nilable(String),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -43,6 +57,8 @@ module Courier
         settings:,
         id: nil,
         snippets: nil,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -54,6 +70,8 @@ module Courier
             settings: Courier::BrandSettings,
             id: T.nilable(String),
             snippets: T.nilable(Courier::BrandSnippets),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/inbox/message_delete_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Inbox
+      class MessageDeleteParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Inbox::MessageDeleteParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        sig do
+          params(
+            message_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(message_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { message_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/inbox/message_restore_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Inbox
+      class MessageRestoreParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Inbox::MessageRestoreParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :message_id
+
+        sig do
+          params(
+            message_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(message_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { message_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_cancel_params.rbi

@@ -11,15 +11,41 @@ module Courier
           T.any(Courier::JourneyCancelParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/journey_create_params.rbi

@@ -11,15 +11,41 @@ module Courier
           T.any(Courier::JourneyCreateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/journey_invoke_params.rbi

@@ -14,18 +14,42 @@ module Courier
       sig { returns(String) }
       attr_accessor :template_id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           template_id: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(template_id:, request_options: {})
+      def self.new(
+        template_id:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { template_id: String, request_options: Courier::RequestOptions }
+          {
+            template_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/journey_publish_params.rbi

@@ -14,18 +14,42 @@ module Courier
       sig { returns(String) }
       attr_accessor :template_id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           template_id: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(template_id:, request_options: {})
+      def self.new(
+        template_id:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { template_id: String, request_options: Courier::RequestOptions }
+          {
+            template_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/journeys/template_create_params.rbi

@@ -18,18 +18,42 @@ module Courier
         sig { returns(String) }
         attr_accessor :template_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             template_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(template_id:, request_options: {})
+        def self.new(
+          template_id:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { template_id: String, request_options: Courier::RequestOptions }
+            {
+              template_id: String,
+              idempotency_key: String,
+              x_idempotency_expiration: String,
+              request_options: Courier::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/courier/models/journeys/template_publish_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(String) }
         attr_accessor :notification_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             template_id: String,
             notification_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(template_id:, notification_id:, request_options: {})
+        def self.new(
+          template_id:,
+          notification_id:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               template_id: String,
               notification_id: String,
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/lists/subscription_add_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) }
         attr_accessor :recipients
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             list_id: String,
             recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(list_id:, recipients:, request_options: {})
+        def self.new(
+          list_id:,
+          recipients:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               list_id: String,
               recipients: T::Array[Courier::PutSubscriptionsRecipient],
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )