trycourier 4.7.1 → 4.9.0

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

@@ -133,30 +133,28 @@ module Courier
         #
         # Adds a single token to a user and overwrites a matching existing token.
         #
-        # @overload add_single(path_token, user_id:, body_token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
+        # @overload add_single(token, user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
         #
-        # @param path_token [String] Path param: The full token string.
+        # @param token [String] Path param: The full token string.
         #
         # @param user_id [String] Path param: The user's ID. This can be any uniquely identifiable string.
         #
-        # @param body_token [String] Body param: Full body of the token. Must match token in URL path parameter.
-        #
-        # @param provider_key [Symbol, Courier::Models::Users::UserToken::ProviderKey] Body param
+        # @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] Body param
         #
-        # @param device [Courier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token came from.
+        # @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Body param: Information about the device the token came from.
         #
         # @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 about the token.
         #
-        # @param tracking [Courier::Models::Users::UserToken::Tracking, nil] Body param: Tracking information about the device the token came from.
+        # @param tracking [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] Body param: Tracking information about the device the token came from.
         #
         # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
         #
         # @see Courier::Models::Users::TokenAddSingleParams
-        def add_single(path_token, params)
+        def add_single(token, params)
           parsed, options = Courier::Users::TokenAddSingleParams.dump_request(params)
           user_id =
             parsed.delete(:user_id) do
@@ -164,7 +162,7 @@ module Courier
             end
           @client.request(
             method: :put,
-            path: ["users/%1$s/tokens/%2$s", user_id, path_token],
+            path: ["users/%1$s/tokens/%2$s", user_id, token],
             body: parsed,
             model: NilClass,
             options: options

data/lib/courier/version.rb

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

data/lib/courier.rb

@@ -58,7 +58,14 @@ require_relative "courier/models/inbound_bulk_message_user"
 require_relative "courier/models/base_check"
 require_relative "courier/models/subscription_topic_new"
 require_relative "courier/models/elemental_channel_node"
+require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/message_details"
+require_relative "courier/models/notification_template_create_request"
+require_relative "courier/models/notification_template_publish_request"
+require_relative "courier/models/notification_template_update_request"
+require_relative "courier/models/notification_template_payload"
+require_relative "courier/models/routing_strategy_create_request"
+require_relative "courier/models/routing_strategy_replace_request"
 require_relative "courier/models/base_template_tenant_association"
 require_relative "courier/models/post_tenant_template_publish_request"
 require_relative "courier/models/put_tenant_template_request"
@@ -111,7 +118,9 @@ require_relative "courier/models/bulk_list_users_response"
 require_relative "courier/models/bulk_retrieve_job_params"
 require_relative "courier/models/bulk_retrieve_job_response"
 require_relative "courier/models/bulk_run_job_params"
+require_relative "courier/models/channel"
 require_relative "courier/models/channel_classification"
+require_relative "courier/models/channel_metadata"
 require_relative "courier/models/channel_preference"
 require_relative "courier/models/check"
 require_relative "courier/models/default_preferences"
@@ -122,6 +131,7 @@ require_relative "courier/models/elemental_channel_node_with_type"
 require_relative "courier/models/elemental_content"
 require_relative "courier/models/elemental_content_sugar"
 require_relative "courier/models/elemental_divider_node_with_type"
+require_relative "courier/models/elemental_html_node_with_type"
 require_relative "courier/models/elemental_image_node_with_type"
 require_relative "courier/models/elemental_meta_node_with_type"
 require_relative "courier/models/elemental_node"
@@ -138,6 +148,11 @@ require_relative "courier/models/inbound_track_event_params"
 require_relative "courier/models/inbound_track_event_response"
 require_relative "courier/models/intercom"
 require_relative "courier/models/intercom_recipient"
+require_relative "courier/models/journey"
+require_relative "courier/models/journey_invoke_params"
+require_relative "courier/models/journey_list_params"
+require_relative "courier/models/journeys_invoke_response"
+require_relative "courier/models/journeys_list_response"
 require_relative "courier/models/list_delete_params"
 require_relative "courier/models/list_filter"
 require_relative "courier/models/list_list_params"
@@ -155,6 +170,7 @@ require_relative "courier/models/lists/subscription_unsubscribe_user_params"
 require_relative "courier/models/list_update_params"
 require_relative "courier/models/logo"
 require_relative "courier/models/message_cancel_params"
+require_relative "courier/models/message_channels"
 require_relative "courier/models/message_content_params"
 require_relative "courier/models/message_content_response"
 require_relative "courier/models/message_context"
@@ -162,25 +178,38 @@ require_relative "courier/models/message_history_params"
 require_relative "courier/models/message_history_response"
 require_relative "courier/models/message_list_params"
 require_relative "courier/models/message_list_response"
+require_relative "courier/models/message_providers"
+require_relative "courier/models/message_providers_type"
 require_relative "courier/models/message_retrieve_params"
 require_relative "courier/models/message_retrieve_response"
 require_relative "courier/models/message_routing"
 require_relative "courier/models/message_routing_channel"
+require_relative "courier/models/metadata"
 require_relative "courier/models/ms_teams"
 require_relative "courier/models/ms_teams_base_properties"
 require_relative "courier/models/ms_teams_recipient"
 require_relative "courier/models/multiple_tokens"
+require_relative "courier/models/notification_archive_params"
+require_relative "courier/models/notification_create_params"
 require_relative "courier/models/notification_get_content"
 require_relative "courier/models/notification_list_params"
 require_relative "courier/models/notification_list_response"
+require_relative "courier/models/notification_list_versions_params"
 require_relative "courier/models/notification_preference_details"
+require_relative "courier/models/notification_publish_params"
+require_relative "courier/models/notification_replace_params"
 require_relative "courier/models/notification_retrieve_content_params"
+require_relative "courier/models/notification_retrieve_params"
 require_relative "courier/models/notifications/check_delete_params"
 require_relative "courier/models/notifications/check_list_params"
 require_relative "courier/models/notifications/check_list_response"
 require_relative "courier/models/notifications/check_update_params"
 require_relative "courier/models/notifications/check_update_response"
 require_relative "courier/models/notifications/draft_retrieve_content_params"
+require_relative "courier/models/notification_template_get_response"
+require_relative "courier/models/notification_template_mutation_response"
+require_relative "courier/models/notification_template_summary"
+require_relative "courier/models/notification_template_version_list_response"
 require_relative "courier/models/pagerduty"
 require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
@@ -201,10 +230,29 @@ require_relative "courier/models/profiles/list_retrieve_response"
 require_relative "courier/models/profiles/list_subscribe_params"
 require_relative "courier/models/profiles/list_subscribe_response"
 require_relative "courier/models/profile_update_params"
+require_relative "courier/models/provider"
+require_relative "courier/models/provider_create_params"
+require_relative "courier/models/provider_delete_params"
+require_relative "courier/models/provider_list_params"
+require_relative "courier/models/provider_list_response"
+require_relative "courier/models/provider_retrieve_params"
+require_relative "courier/models/providers/catalog_list_params"
+require_relative "courier/models/providers/catalog_list_response"
+require_relative "courier/models/providers_catalog_entry"
+require_relative "courier/models/provider_update_params"
 require_relative "courier/models/put_subscriptions_recipient"
 require_relative "courier/models/put_tenant_template_response"
 require_relative "courier/models/recipient_preferences"
 require_relative "courier/models/request_archive_params"
+require_relative "courier/models/routing_strategy_archive_params"
+require_relative "courier/models/routing_strategy_create_params"
+require_relative "courier/models/routing_strategy_get_response"
+require_relative "courier/models/routing_strategy_list_params"
+require_relative "courier/models/routing_strategy_list_response"
+require_relative "courier/models/routing_strategy_mutation_response"
+require_relative "courier/models/routing_strategy_replace_params"
+require_relative "courier/models/routing_strategy_retrieve_params"
+require_relative "courier/models/routing_strategy_summary"
 require_relative "courier/models/rule"
 require_relative "courier/models/send_direct_message"
 require_relative "courier/models/send_message_params"
@@ -242,6 +290,7 @@ require_relative "courier/models/tenants/templates/version_retrieve_params"
 require_relative "courier/models/tenant_template_input"
 require_relative "courier/models/tenant_update_params"
 require_relative "courier/models/text_style"
+require_relative "courier/models/timeouts"
 require_relative "courier/models/token"
 require_relative "courier/models/translation_retrieve_params"
 require_relative "courier/models/translation_retrieve_response"
@@ -271,6 +320,7 @@ require_relative "courier/models/users/token_retrieve_response"
 require_relative "courier/models/users/token_update_params"
 require_relative "courier/models/users/topic_preference"
 require_relative "courier/models/utm"
+require_relative "courier/models/version_node"
 require_relative "courier/models/webhook_authentication"
 require_relative "courier/models/webhook_auth_mode"
 require_relative "courier/models/webhook_method"
@@ -287,6 +337,7 @@ require_relative "courier/resources/automations/invoke"
 require_relative "courier/resources/brands"
 require_relative "courier/resources/bulk"
 require_relative "courier/resources/inbound"
+require_relative "courier/resources/journeys"
 require_relative "courier/resources/lists"
 require_relative "courier/resources/lists/subscriptions"
 require_relative "courier/resources/messages"
@@ -295,7 +346,10 @@ require_relative "courier/resources/notifications/checks"
 require_relative "courier/resources/notifications/draft"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
+require_relative "courier/resources/providers"
+require_relative "courier/resources/providers/catalog"
 require_relative "courier/resources/requests"
+require_relative "courier/resources/routing_strategies"
 require_relative "courier/resources/send"
 require_relative "courier/resources/tenants"
 require_relative "courier/resources/tenants/preferences"

data/rbi/courier/client.rbi

@@ -19,6 +19,9 @@ module Courier
     sig { returns(Courier::Resources::Audiences) }
     attr_reader :audiences
 
+    sig { returns(Courier::Resources::Providers) }
+    attr_reader :providers
+
     sig { returns(Courier::Resources::AuditEvents) }
     attr_reader :audit_events
 
@@ -28,6 +31,9 @@ module Courier
     sig { returns(Courier::Resources::Automations) }
     attr_reader :automations
 
+    sig { returns(Courier::Resources::Journeys) }
+    attr_reader :journeys
+
     sig { returns(Courier::Resources::Brands) }
     attr_reader :brands
 
@@ -49,6 +55,9 @@ module Courier
     sig { returns(Courier::Resources::Notifications) }
     attr_reader :notifications
 
+    sig { returns(Courier::Resources::RoutingStrategies) }
+    attr_reader :routing_strategies
+
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 

data/rbi/courier/internal/util.rbi

@@ -148,12 +148,20 @@ module Courier
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -301,6 +309,26 @@ module Courier
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Courier::Internal::AnyHash).returns(
+            Courier::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Courier::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/courier/models/audience_delete_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::AudienceDeleteParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :audience_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          audience_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(audience_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { audience_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/audience_list_members_params.rbi

@@ -11,17 +11,22 @@ module Courier
           T.any(Courier::AudienceListMembersParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :audience_id
+
       # A unique identifier that allows for fetching the next set of members
       sig { returns(T.nilable(String)) }
       attr_accessor :cursor
 
       sig do
         params(
+          audience_id: String,
           cursor: T.nilable(String),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        audience_id:,
         # A unique identifier that allows for fetching the next set of members
         cursor: nil,
         request_options: {}
@@ -31,6 +36,7 @@ module Courier
       sig do
         override.returns(
           {
+            audience_id: String,
             cursor: T.nilable(String),
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/audience_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::AudienceRetrieveParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :audience_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          audience_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(audience_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { audience_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/audience_update_params.rbi

@@ -11,6 +11,9 @@ module Courier
           T.any(Courier::AudienceUpdateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :audience_id
+
       # A description of the audience
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -36,6 +39,7 @@ module Courier
 
       sig do
         params(
+          audience_id: String,
           description: T.nilable(String),
           filter: T.nilable(Courier::AudienceFilterConfig::OrHash),
           name: T.nilable(String),
@@ -45,6 +49,7 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
+        audience_id:,
         # A description of the audience
         description: nil,
         # Filter configuration for audience membership containing an array of filter rules
@@ -60,6 +65,7 @@ module Courier
       sig do
         override.returns(
           {
+            audience_id: String,
             description: T.nilable(String),
             filter: T.nilable(Courier::AudienceFilterConfig),
             name: T.nilable(String),

data/rbi/courier/models/audit_event_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::AuditEventRetrieveParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :audit_event_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          audit_event_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(audit_event_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { audit_event_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

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

@@ -15,6 +15,9 @@ module Courier
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :template_id
+
         sig { returns(T.nilable(String)) }
         attr_accessor :recipient
 
@@ -32,6 +35,7 @@ module Courier
 
         sig do
           params(
+            template_id: String,
             recipient: T.nilable(String),
             brand: T.nilable(String),
             data: T.nilable(T::Hash[Symbol, T.anything]),
@@ -41,6 +45,7 @@ module Courier
           ).returns(T.attached_class)
         end
         def self.new(
+          template_id:,
           recipient:,
           brand: nil,
           data: nil,
@@ -53,6 +58,7 @@ module Courier
         sig do
           override.returns(
             {
+              template_id: String,
               recipient: T.nilable(String),
               brand: T.nilable(String),
               data: T.nilable(T::Hash[Symbol, T.anything]),

data/rbi/courier/models/brand_delete_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::BrandDeleteParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :brand_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          brand_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(brand_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { brand_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/brand_retrieve_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::BrandRetrieveParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :brand_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          brand_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(brand_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { brand_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/brand_update_params.rbi

@@ -11,6 +11,9 @@ module Courier
           T.any(Courier::BrandUpdateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :brand_id
+
       # The name of the brand.
       sig { returns(String) }
       attr_accessor :name
@@ -29,6 +32,7 @@ module Courier
 
       sig do
         params(
+          brand_id: String,
           name: String,
           settings: T.nilable(Courier::BrandSettings::OrHash),
           snippets: T.nilable(Courier::BrandSnippets::OrHash),
@@ -36,6 +40,7 @@ module Courier
         ).returns(T.attached_class)
       end
       def self.new(
+        brand_id:,
         # The name of the brand.
         name:,
         settings: nil,
@@ -47,6 +52,7 @@ module Courier
       sig do
         override.returns(
           {
+            brand_id: String,
             name: String,
             settings: T.nilable(Courier::BrandSettings),
             snippets: T.nilable(Courier::BrandSnippets),

data/rbi/courier/models/bulk_add_users_params.rbi

@@ -11,21 +11,26 @@ module Courier
           T.any(Courier::BulkAddUsersParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :job_id
+
       sig { returns(T::Array[Courier::InboundBulkMessageUser]) }
       attr_accessor :users
 
       sig do
         params(
+          job_id: String,
           users: T::Array[Courier::InboundBulkMessageUser::OrHash],
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(users:, request_options: {})
+      def self.new(job_id:, users:, request_options: {})
       end
 
       sig do
         override.returns(
           {
+            job_id: String,
             users: T::Array[Courier::InboundBulkMessageUser],
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/bulk_list_users_params.rbi

@@ -11,6 +11,9 @@ module Courier
           T.any(Courier::BulkListUsersParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :job_id
+
       # A unique identifier that allows for fetching the next set of users added to the
       # bulk job
       sig { returns(T.nilable(String)) }
@@ -18,11 +21,13 @@ module Courier
 
       sig do
         params(
+          job_id: String,
           cursor: T.nilable(String),
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        job_id:,
         # A unique identifier that allows for fetching the next set of users added to the
         # bulk job
         cursor: nil,
@@ -33,6 +38,7 @@ module Courier
       sig do
         override.returns(
           {
+            job_id: String,
             cursor: T.nilable(String),
             request_options: Courier::RequestOptions
           }

data/rbi/courier/models/bulk_retrieve_job_params.rbi

@@ -11,15 +11,23 @@ module Courier
           T.any(Courier::BulkRetrieveJobParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :job_id
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          job_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(job_id:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          { job_id: String, request_options: Courier::RequestOptions }
+        )
+      end
       def to_hash
       end
     end