knockapi 1.0.0 → 1.2.0

data/rbi/knockapi/models.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Knockapi
+  Activity = Knockapi::Models::Activity
+
+  AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
+
+  AudienceListMembersParams = Knockapi::Models::AudienceListMembersParams
+
+  AudienceMember = Knockapi::Models::AudienceMember
+
+  AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
+
+  BulkOperation = Knockapi::Models::BulkOperation
+
+  BulkOperationGetParams = Knockapi::Models::BulkOperationGetParams
+
+  Channels = Knockapi::Models::Channels
+
+  Condition = Knockapi::Models::Condition
+
+  IdentifyUserRequest = Knockapi::Models::IdentifyUserRequest
+
+  InlineIdentifyUserRequest = Knockapi::Models::InlineIdentifyUserRequest
+
+  InlineObjectRequest = Knockapi::Models::InlineObjectRequest
+
+  InlineTenantRequest = Knockapi::Models::InlineTenantRequest
+
+  Integrations = Knockapi::Models::Integrations
+
+  Message = Knockapi::Models::Message
+
+  MessageArchiveParams = Knockapi::Models::MessageArchiveParams
+
+  MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
+
+  MessageEvent = Knockapi::Models::MessageEvent
+
+  MessageGetContentParams = Knockapi::Models::MessageGetContentParams
+
+  MessageGetParams = Knockapi::Models::MessageGetParams
+
+  MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
+
+  MessageListDeliveryLogsParams =
+    Knockapi::Models::MessageListDeliveryLogsParams
+
+  MessageListEventsParams = Knockapi::Models::MessageListEventsParams
+
+  MessageListParams = Knockapi::Models::MessageListParams
+
+  MessageMarkAsInteractedParams =
+    Knockapi::Models::MessageMarkAsInteractedParams
+
+  MessageMarkAsReadParams = Knockapi::Models::MessageMarkAsReadParams
+
+  MessageMarkAsSeenParams = Knockapi::Models::MessageMarkAsSeenParams
+
+  MessageMarkAsUnreadParams = Knockapi::Models::MessageMarkAsUnreadParams
+
+  MessageMarkAsUnseenParams = Knockapi::Models::MessageMarkAsUnseenParams
+
+  Messages = Knockapi::Models::Messages
+
+  MessageUnarchiveParams = Knockapi::Models::MessageUnarchiveParams
+
+  Object = Knockapi::Models::Object
+
+  ObjectAddSubscriptionsParams = Knockapi::Models::ObjectAddSubscriptionsParams
+
+  ObjectDeleteParams = Knockapi::Models::ObjectDeleteParams
+
+  ObjectDeleteSubscriptionsParams =
+    Knockapi::Models::ObjectDeleteSubscriptionsParams
+
+  ObjectGetChannelDataParams = Knockapi::Models::ObjectGetChannelDataParams
+
+  ObjectGetParams = Knockapi::Models::ObjectGetParams
+
+  ObjectGetPreferencesParams = Knockapi::Models::ObjectGetPreferencesParams
+
+  ObjectListMessagesParams = Knockapi::Models::ObjectListMessagesParams
+
+  ObjectListParams = Knockapi::Models::ObjectListParams
+
+  ObjectListPreferencesParams = Knockapi::Models::ObjectListPreferencesParams
+
+  ObjectListSchedulesParams = Knockapi::Models::ObjectListSchedulesParams
+
+  ObjectListSubscriptionsParams =
+    Knockapi::Models::ObjectListSubscriptionsParams
+
+  Objects = Knockapi::Models::Objects
+
+  ObjectSetChannelDataParams = Knockapi::Models::ObjectSetChannelDataParams
+
+  ObjectSetParams = Knockapi::Models::ObjectSetParams
+
+  ObjectSetPreferencesParams = Knockapi::Models::ObjectSetPreferencesParams
+
+  ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
+
+  PageInfo = Knockapi::Models::PageInfo
+
+  Providers = Knockapi::Models::Providers
+
+  Recipient = Knockapi::Models::Recipient
+
+  RecipientReference = Knockapi::Models::RecipientReference
+
+  RecipientRequest = Knockapi::Models::RecipientRequest
+
+  Recipients = Knockapi::Models::Recipients
+
+  Schedule = Knockapi::Models::Schedule
+
+  ScheduleCreateParams = Knockapi::Models::ScheduleCreateParams
+
+  ScheduleDeleteParams = Knockapi::Models::ScheduleDeleteParams
+
+  ScheduleListParams = Knockapi::Models::ScheduleListParams
+
+  ScheduleRepeatRule = Knockapi::Models::ScheduleRepeatRule
+
+  Schedules = Knockapi::Models::Schedules
+
+  ScheduleUpdateParams = Knockapi::Models::ScheduleUpdateParams
+
+  Tenant = Knockapi::Models::Tenant
+
+  TenantDeleteParams = Knockapi::Models::TenantDeleteParams
+
+  TenantGetParams = Knockapi::Models::TenantGetParams
+
+  TenantListParams = Knockapi::Models::TenantListParams
+
+  TenantRequest = Knockapi::Models::TenantRequest
+
+  Tenants = Knockapi::Models::Tenants
+
+  TenantSetParams = Knockapi::Models::TenantSetParams
+
+  User = Knockapi::Models::User
+
+  UserDeleteParams = Knockapi::Models::UserDeleteParams
+
+  UserGetChannelDataParams = Knockapi::Models::UserGetChannelDataParams
+
+  UserGetParams = Knockapi::Models::UserGetParams
+
+  UserGetPreferencesParams = Knockapi::Models::UserGetPreferencesParams
+
+  UserListMessagesParams = Knockapi::Models::UserListMessagesParams
+
+  UserListParams = Knockapi::Models::UserListParams
+
+  UserListPreferencesParams = Knockapi::Models::UserListPreferencesParams
+
+  UserListSchedulesParams = Knockapi::Models::UserListSchedulesParams
+
+  UserListSubscriptionsParams = Knockapi::Models::UserListSubscriptionsParams
+
+  UserMergeParams = Knockapi::Models::UserMergeParams
+
+  Users = Knockapi::Models::Users
+
+  UserSetChannelDataParams = Knockapi::Models::UserSetChannelDataParams
+
+  UserSetPreferencesParams = Knockapi::Models::UserSetPreferencesParams
+
+  UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
+
+  UserUpdateParams = Knockapi::Models::UserUpdateParams
+
+  WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
+
+  WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
+end

data/rbi/knockapi/request_options.rbi

@@ -1,17 +1,21 @@
 # typed: strong
 
 module Knockapi
-  RequestOpts = T.type_alias { T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash) }
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   # or override those provided at the client level.
   #
   # When making a request, you can pass an actual {RequestOptions} instance, or
   # simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < Knockapi::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
+      end
+
     # @api private
-    sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
-    def self.validate!(opts); end
+    sig { params(opts: Knockapi::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
 
     # Idempotency key to send with request and all associated retries. Will only be
     # sent for write requests.
@@ -20,7 +24,11 @@ module Knockapi
 
     # Extra query params to send with the request. These are `.merge`’d into any
     # `query` given at the client level.
-    sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
     attr_accessor :extra_query
 
     # Extra headers to send with the request. These are `.merged`’d into any
@@ -42,7 +50,10 @@ module Knockapi
     attr_accessor :timeout
 
     # Returns a new instance of RequestOptions.
-    sig { params(values: Knockapi::Internal::AnyHash).returns(T.attached_class) }
-    def self.new(values = {}); end
+    sig do
+      params(values: Knockapi::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
   end
 end

data/rbi/knockapi/resources/audiences.rbi

@@ -7,10 +7,9 @@ module Knockapi
       sig do
         params(
           key: String,
-          members: T::Array[T.any(Knockapi::Models::AudienceAddMembersParams::Member, Knockapi::Internal::AnyHash)],
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(String)
+          members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
       end
       def add_members(
         # The key of the audience.
@@ -18,25 +17,31 @@ module Knockapi
         # A list of audience members to add.
         members:,
         request_options: {}
-      ); end
+      )
+      end
+
       # Returns a paginated list of members for the specified audience.
       sig do
-        params(key: String, request_options: Knockapi::RequestOpts)
-          .returns(Knockapi::Models::AudienceListMembersResponse)
+        params(
+          key: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::Models::AudienceListMembersResponse)
       end
       def list_members(
         # The key of the audience.
         key,
         request_options: {}
-      ); end
+      )
+      end
+
       # Removes one or more members from the specified audience.
       sig do
         params(
           key: String,
-          members: T::Array[T.any(Knockapi::Models::AudienceRemoveMembersParams::Member, Knockapi::Internal::AnyHash)],
-          request_options: Knockapi::RequestOpts
-        )
-          .returns(String)
+          members:
+            T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
       end
       def remove_members(
         # The key of the audience.
@@ -44,10 +49,13 @@ module Knockapi
         # A list of audience members to remove.
         members:,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/bulk_operations.rbi

@@ -4,15 +4,23 @@ module Knockapi
   module Resources
     class BulkOperations
       # Retrieves a bulk operation (if it exists) and displays the current state of it.
-      sig { params(id: String, request_options: Knockapi::RequestOpts).returns(Knockapi::Models::BulkOperation) }
+      sig do
+        params(
+          id: String,
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(Knockapi::BulkOperation)
+      end
       def get(
         # The ID of the bulk operation to retrieve.
         id,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/channels/bulk.rbi

@@ -11,10 +11,14 @@ module Knockapi
         sig do
           params(
             channel_id: String,
-            action: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
-            archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
-            delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
-            engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
+            action:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::Action::OrSymbol,
+            archived:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
+            delivery_status:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
+            engagement_status:
+              Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
             has_tenant: T::Boolean,
             newer_than: Time,
             older_than: Time,
@@ -22,9 +26,8 @@ module Knockapi
             tenants: T::Array[String],
             trigger_data: String,
             workflows: T::Array[String],
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(Knockapi::Models::BulkOperation)
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
         end
         def update_message_status(
           # The ID of the channel to update messages for.
@@ -54,10 +57,13 @@ module Knockapi
           # Limits the results to messages with the given workflow keys.
           workflows: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/channels.rbi

@@ -8,7 +8,8 @@ module Knockapi
 
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/integrations/census.rbi

@@ -11,9 +11,10 @@ module Knockapi
             jsonrpc: String,
             method_: String,
             params: T::Hash[Symbol, T.anything],
-            request_options: Knockapi::RequestOpts
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            Knockapi::Models::Integrations::CensusCustomDestinationResponse
           )
-            .returns(Knockapi::Models::Integrations::CensusCustomDestinationResponse)
         end
         def custom_destination(
           # The unique identifier for the RPC request.
@@ -25,10 +26,13 @@ module Knockapi
           # The parameters for the method.
           params: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/integrations/hightouch.rbi

@@ -11,9 +11,10 @@ module Knockapi
             jsonrpc: String,
             method_: String,
             params: T::Hash[Symbol, T.anything],
-            request_options: Knockapi::RequestOpts
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse
           )
-            .returns(Knockapi::Models::Integrations::HightouchEmbeddedDestinationResponse)
         end
         def embedded_destination(
           # The unique identifier for the RPC request.
@@ -25,10 +26,13 @@ module Knockapi
           # The parameters for the method.
           params: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/knockapi/resources/integrations.rbi

@@ -11,7 +11,8 @@ module Knockapi
 
       # @api private
       sig { params(client: Knockapi::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/knockapi/resources/messages/batch.rbi

@@ -7,24 +7,34 @@ module Knockapi
         # Marks the given messages as archived. Archived messages are hidden from the
         # default message list in the feed but can still be accessed and unarchived later.
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def archive(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Get the contents of multiple messages in a single request.
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Messages::BatchGetContentResponseItem])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(
+            T::Array[Knockapi::Models::Messages::BatchGetContentResponseItem]
+          )
         end
         def get_content(
           # The IDs of the messages to fetch contents of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as interacted with by the user. This can include any
         # user action on the message, with optional metadata about the specific
         # interaction. Cannot include more than 5 key-value pairs, must not contain nested
@@ -34,9 +44,8 @@ module Knockapi
           params(
             message_ids: T::Array[String],
             metadata: T.nilable(T::Hash[Symbol, T.anything]),
-            request_options: Knockapi::RequestOpts
-          )
-            .returns(T::Array[Knockapi::Models::Message])
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_interacted(
           # The message IDs to batch mark as interacted with.
@@ -44,69 +53,92 @@ module Knockapi
           # Metadata about the interaction.
           metadata: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as `read`. Read more about message engagement statuses
         # [here](/send-notifications/message-statuses#engagement-status).
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_read(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as `seen`. This indicates that the user has viewed the
         # message in their feed or inbox. Read more about message engagement statuses
         # [here](/send-notifications/message-statuses#engagement-status).
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_seen(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as `unread`. This reverses the `read` state. Read more
         # about message engagement statuses
         # [here](/send-notifications/message-statuses#engagement-status).
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_unread(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as `unseen`. This reverses the `seen` state. Read more
         # about message engagement statuses
         # [here](/send-notifications/message-statuses#engagement-status).
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def mark_as_unseen(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Marks the given messages as unarchived. This reverses the `archived` state.
         # Archived messages are hidden from the default message list in the feed but can
         # still be accessed and unarchived later.
         sig do
-          params(message_ids: T::Array[String], request_options: Knockapi::RequestOpts)
-            .returns(T::Array[Knockapi::Models::Message])
+          params(
+            message_ids: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T::Array[Knockapi::Message])
         end
         def unarchive(
           # The message IDs to update the status of.
           message_ids:,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Knockapi::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end