knockapi 1.32.1 → 1.34.0

data/lib/knockapi/resources/providers/ms_teams.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       class MsTeams
         # Check if a connection to Microsoft Teams has been authorized for a given
         # Microsoft Teams tenant object.
@@ -20,10 +22,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamCheckAuthParams
         def check_auth(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamCheckAuthParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/auth_check", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamCheckAuthResponse,
             options: options
           )
@@ -49,10 +52,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamListChannelsParams
         def list_channels(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamListChannelsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/channels", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamListChannelsResponse,
             options: options
           )
@@ -76,10 +80,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamListTeamsParams
         def list_teams(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamListTeamsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/ms-teams/%1$s/teams", channel_id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::MsTeamsPagination,
             model: Knockapi::Models::Providers::MsTeamListTeamsResponse,
             options: options
@@ -101,10 +106,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::MsTeamRevokeAccessParams
         def revoke_access(channel_id, params)
           parsed, options = Knockapi::Providers::MsTeamRevokeAccessParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :put,
             path: ["v1/providers/ms-teams/%1$s/revoke_access", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::MsTeamRevokeAccessResponse,
             options: options
           )

data/lib/knockapi/resources/providers/slack.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       class Slack
         # Check if a Slack channel is authenticated.
         #
@@ -19,10 +21,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackCheckAuthParams
         def check_auth(channel_id, params)
           parsed, options = Knockapi::Providers::SlackCheckAuthParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/slack/%1$s/auth_check", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::SlackCheckAuthResponse,
             options: options
           )
@@ -45,10 +48,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackListChannelsParams
         def list_channels(channel_id, params)
           parsed, options = Knockapi::Providers::SlackListChannelsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/providers/slack/%1$s/channels", channel_id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::SlackChannelsCursor,
             model: Knockapi::Models::Providers::SlackListChannelsResponse,
             options: options
@@ -70,10 +74,11 @@ module Knockapi
         # @see Knockapi::Models::Providers::SlackRevokeAccessParams
         def revoke_access(channel_id, params)
           parsed, options = Knockapi::Providers::SlackRevokeAccessParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :put,
             path: ["v1/providers/slack/%1$s/revoke_access", channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Providers::SlackRevokeAccessResponse,
             options: options
           )

data/lib/knockapi/resources/providers.rb

@@ -3,9 +3,13 @@
 module Knockapi
   module Resources
     class Providers
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       # @return [Knockapi::Resources::Providers::Slack]
       attr_reader :slack
 
+      # A provider represents a third-party service that Knock integrates with and is
+      # configured via a channel.
       # @return [Knockapi::Resources::Providers::MsTeams]
       attr_reader :ms_teams
 

data/lib/knockapi/resources/schedules/bulk.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Schedules
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Bulk creates up to 1,000 schedules at a time. This endpoint also handles
         # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)

data/lib/knockapi/resources/schedules.rb

@@ -2,7 +2,11 @@
 
 module Knockapi
   module Resources
+    # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
+    # workflow.
     class Schedules
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       # @return [Knockapi::Resources::Schedules::Bulk]
       attr_reader :bulk
 
@@ -114,10 +118,11 @@ module Knockapi
       # @see Knockapi::Models::ScheduleListParams
       def list(params)
         parsed, options = Knockapi::ScheduleListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/schedules",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Schedule,
           options: options

data/lib/knockapi/resources/tenants/bulk.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Tenants
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Delete up to 1,000 tenants at a time in a single operation. This operation
         # cannot be undone.
@@ -18,10 +20,11 @@ module Knockapi
         # @see Knockapi::Models::Tenants::BulkDeleteParams
         def delete(params)
           parsed, options = Knockapi::Tenants::BulkDeleteParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :post,
             path: "v1/tenants/bulk/delete",
-            query: parsed,
+            query: query,
             model: Knockapi::BulkOperation,
             options: options
           )

data/lib/knockapi/resources/tenants.rb

@@ -2,7 +2,11 @@
 
 module Knockapi
   module Resources
+    # A tenant represents a top-level entity from your system, like a company,
+    # organization, account, or workspace.
     class Tenants
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       # @return [Knockapi::Resources::Tenants::Bulk]
       attr_reader :bulk
 
@@ -27,10 +31,11 @@ module Knockapi
       # @see Knockapi::Models::TenantListParams
       def list(params = {})
         parsed, options = Knockapi::TenantListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/tenants",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Tenant,
           options: options
@@ -75,10 +80,11 @@ module Knockapi
       # @see Knockapi::Models::TenantGetParams
       def get(id, params = {})
         parsed, options = Knockapi::TenantGetParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/tenants/%1$s", id],
-          query: parsed,
+          query: query,
           model: Knockapi::Tenant,
           options: options
         )
@@ -108,12 +114,13 @@ module Knockapi
       #
       # @see Knockapi::Models::TenantSetParams
       def set(id, params = {})
-        parsed, options = Knockapi::TenantSetParams.dump_request(params)
         query_params = [:resolve_full_preference_settings]
+        parsed, options = Knockapi::TenantSetParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :put,
           path: ["v1/tenants/%1$s", id],
-          query: parsed.slice(*query_params),
+          query: query,
           body: parsed.except(*query_params),
           model: Knockapi::Tenant,
           options: options

data/lib/knockapi/resources/users/bulk.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       class Bulk
         # Permanently deletes up to 1,000 users at a time.
         #

data/lib/knockapi/resources/users/feeds.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       class Feeds
         # Returns the feed settings for a user.
         #
@@ -88,10 +90,11 @@ module Knockapi
         # @see Knockapi::Models::Users::FeedListItemsParams
         def list_items(user_id, id, params = {})
           parsed, options = Knockapi::Users::FeedListItemsParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/users/%1$s/feeds/%2$s", user_id, id],
-            query: parsed,
+            query: query,
             page: Knockapi::Internal::EntriesCursor,
             model: Knockapi::Models::Users::FeedListItemsResponse,
             options: options

data/lib/knockapi/resources/users/guides.rb

@@ -3,6 +3,8 @@
 module Knockapi
   module Resources
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       class Guides
         # Returns a list of eligible in-app guides for a specific user and channel.
         #
@@ -25,10 +27,11 @@ module Knockapi
         # @see Knockapi::Models::Users::GuideGetChannelParams
         def get_channel(user_id, channel_id, params = {})
           parsed, options = Knockapi::Users::GuideGetChannelParams.dump_request(params)
+          query = Knockapi::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["v1/users/%1$s/guides/%2$s", user_id, channel_id],
-            query: parsed,
+            query: query,
             model: Knockapi::Models::Users::GuideGetChannelResponse,
             options: options
           )

data/lib/knockapi/resources/users.rb

@@ -2,13 +2,21 @@
 
 module Knockapi
   module Resources
+    # A user is an individual from your system, represented in Knock. They are most
+    # commonly a recipient of a notification.
     class Users
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       # @return [Knockapi::Resources::Users::Feeds]
       attr_reader :feeds
 
+      # A user is an individual from your system, represented in Knock. They are most
+      # commonly a recipient of a notification.
       # @return [Knockapi::Resources::Users::Guides]
       attr_reader :guides
 
+      # A bulk operation is a set of changes applied across zero or more records
+      # triggered via a call to the Knock API and performed asynchronously.
       # @return [Knockapi::Resources::Users::Bulk]
       attr_reader :bulk
 
@@ -77,10 +85,11 @@ module Knockapi
       # @see Knockapi::Models::UserListParams
       def list(params = {})
         parsed, options = Knockapi::UserListParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "v1/users",
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::User,
           options: options
@@ -167,10 +176,11 @@ module Knockapi
       # @see Knockapi::Models::UserGetPreferencesParams
       def get_preferences(user_id, id, params = {})
         parsed, options = Knockapi::UserGetPreferencesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/preferences/%2$s", user_id, id],
-          query: parsed,
+          query: query,
           model: Knockapi::Recipients::PreferenceSet,
           options: options
         )
@@ -222,10 +232,11 @@ module Knockapi
       # @see Knockapi::Models::UserListMessagesParams
       def list_messages(user_id, params = {})
         parsed, options = Knockapi::UserListMessagesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/messages", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::ItemsCursor,
           model: Knockapi::Message,
           options: options
@@ -275,10 +286,11 @@ module Knockapi
       # @see Knockapi::Models::UserListSchedulesParams
       def list_schedules(user_id, params = {})
         parsed, options = Knockapi::UserListSchedulesParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/schedules", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Schedule,
           options: options
@@ -309,10 +321,11 @@ module Knockapi
       # @see Knockapi::Models::UserListSubscriptionsParams
       def list_subscriptions(user_id, params = {})
         parsed, options = Knockapi::UserListSubscriptionsParams.dump_request(params)
+        query = Knockapi::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["v1/users/%1$s/subscriptions", user_id],
-          query: parsed,
+          query: query,
           page: Knockapi::Internal::EntriesCursor,
           model: Knockapi::Recipients::Subscription,
           options: options

data/lib/knockapi/resources/workflows.rb

@@ -2,6 +2,8 @@
 
 module Knockapi
   module Resources
+    # A workflow is a structured set of steps that is triggered to produce
+    # notifications sent over channels.
     class Workflows
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::WorkflowCancelParams} for more details.

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.32.1"
+  VERSION = "1.34.0"
 end

data/rbi/knockapi/client.rbi

@@ -20,18 +20,26 @@ module Knockapi
     sig { returns(Knockapi::Resources::Recipients) }
     attr_reader :recipients
 
+    # A user is an individual from your system, represented in Knock. They are most
+    # commonly a recipient of a notification.
     sig { returns(Knockapi::Resources::Users) }
     attr_reader :users
 
+    # An object represents a resource in your system that you want to map into Knock.
     sig { returns(Knockapi::Resources::Objects) }
     attr_reader :objects
 
+    # A tenant represents a top-level entity from your system, like a company,
+    # organization, account, or workspace.
     sig { returns(Knockapi::Resources::Tenants) }
     attr_reader :tenants
 
+    # A bulk operation is a set of changes applied across zero or more records
+    # triggered via a call to the Knock API and performed asynchronously.
     sig { returns(Knockapi::Resources::BulkOperations) }
     attr_reader :bulk_operations
 
+    # A message sent to a single recipient on a channel.
     sig { returns(Knockapi::Resources::Messages) }
     attr_reader :messages
 
@@ -41,15 +49,20 @@ module Knockapi
     sig { returns(Knockapi::Resources::Integrations) }
     attr_reader :integrations
 
+    # A workflow is a structured set of steps that is triggered to produce
+    # notifications sent over channels.
     sig { returns(Knockapi::Resources::Workflows) }
     attr_reader :workflows
 
+    # A schedule is a per-recipient, timezone-aware configuration for when to invoke a
+    # workflow.
     sig { returns(Knockapi::Resources::Schedules) }
     attr_reader :schedules
 
     sig { returns(Knockapi::Resources::Channels) }
     attr_reader :channels
 
+    # An Audience is a segment of users.
     sig { returns(Knockapi::Resources::Audiences) }
     attr_reader :audiences
 

data/rbi/knockapi/internal/util.rbi

@@ -301,6 +301,26 @@ module Knockapi
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Knockapi::Internal::AnyHash).returns(
+            Knockapi::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Knockapi::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/knockapi/models/audience_add_members_params.rbi

@@ -11,6 +11,9 @@ module Knockapi
           T.any(Knockapi::AudienceAddMembersParams, Knockapi::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # A list of audience members to add. You can add up to 1,000 members per request.
       sig { returns(T::Array[Knockapi::AudienceAddMembersParams::Member]) }
       attr_accessor :members
@@ -24,12 +27,14 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
           create_audience: T::Boolean,
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # A list of audience members to add. You can add up to 1,000 members per request.
         members:,
         # Create the audience if it does not exist.
@@ -41,6 +46,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             members: T::Array[Knockapi::AudienceAddMembersParams::Member],
             create_audience: T::Boolean,
             request_options: Knockapi::RequestOptions

data/rbi/knockapi/models/audience_list_members_params.rbi

@@ -14,15 +14,23 @@ module Knockapi
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       sig do
-        params(request_options: Knockapi::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          key: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(key:, request_options: {})
       end
 
-      sig { override.returns({ request_options: Knockapi::RequestOptions }) }
+      sig do
+        override.returns(
+          { key: String, request_options: Knockapi::RequestOptions }
+        )
+      end
       def to_hash
       end
     end

data/rbi/knockapi/models/audience_remove_members_params.rbi

@@ -14,6 +14,9 @@ module Knockapi
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :key
+
       # A list of audience members to remove. You can remove up to 1,000 members per
       # request.
       sig { returns(T::Array[Knockapi::AudienceRemoveMembersParams::Member]) }
@@ -21,12 +24,14 @@ module Knockapi
 
       sig do
         params(
+          key: String,
           members:
             T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
           request_options: Knockapi::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
+        key:,
         # A list of audience members to remove. You can remove up to 1,000 members per
         # request.
         members:,
@@ -37,6 +42,7 @@ module Knockapi
       sig do
         override.returns(
           {
+            key: String,
             members: T::Array[Knockapi::AudienceRemoveMembersParams::Member],
             request_options: Knockapi::RequestOptions
           }

data/rbi/knockapi/models/bulk_operation_get_params.rbi

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

data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi

@@ -15,6 +15,16 @@ module Knockapi
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        sig do
+          returns(
+            Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
         # Limits the results to messages with the given archived status.
         sig do
           returns(
@@ -122,6 +132,9 @@ module Knockapi
 
         sig do
           params(
+            channel_id: String,
+            action:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
             archived:
               Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
             delivery_status:
@@ -139,6 +152,8 @@ module Knockapi
           ).returns(T.attached_class)
         end
         def self.new(
+          channel_id:,
+          action:,
           # Limits the results to messages with the given archived status.
           archived: nil,
           # Limits the results to messages with the given delivery status.
@@ -168,6 +183,9 @@ module Knockapi
         sig do
           override.returns(
             {
+              channel_id: String,
+              action:
+                Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
               archived:
                 Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
               delivery_status:

data/rbi/knockapi/models/condition.rbi

@@ -113,6 +113,8 @@ module Knockapi
             :is_timestamp_between,
             Knockapi::Condition::Operator::TaggedSymbol
           )
+        IS_BETWEEN =
+          T.let(:is_between, Knockapi::Condition::Operator::TaggedSymbol)
         IS_AUDIENCE_MEMBER =
           T.let(
             :is_audience_member,