knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/workflow_cancel_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::WorkflowCancelParams, Knockapi::Internal::AnyHash)
+        end
+
+      # An optional key that is used to reference a specific workflow trigger request
+      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      # request. Must be provided while triggering a workflow in order to enable
+      # subsequent cancellation. Should be unique across trigger requests to avoid
+      # unintentional cancellations.
+      sig { returns(String) }
+      attr_accessor :cancellation_key
+
+      # A list of recipients to cancel the notification for. If omitted, cancels for all
+      # recipients associated with the cancellation key.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              T.any(String, Knockapi::RecipientReference::ObjectReference)
+            ]
+          )
+        )
+      end
+      attr_accessor :recipients
+
+      sig do
+        params(
+          cancellation_key: String,
+          recipients:
+            T.nilable(
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::RecipientReference::ObjectReference::OrHash
+                )
+              ]
+            ),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # An optional key that is used to reference a specific workflow trigger request
+        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+        # request. Must be provided while triggering a workflow in order to enable
+        # subsequent cancellation. Should be unique across trigger requests to avoid
+        # unintentional cancellations.
+        cancellation_key:,
+        # A list of recipients to cancel the notification for. If omitted, cancels for all
+        # recipients associated with the cancellation key.
+        recipients: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cancellation_key: String,
+            recipients:
+              T.nilable(
+                T::Array[
+                  T.any(String, Knockapi::RecipientReference::ObjectReference)
+                ]
+              ),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_cancel_response.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    WorkflowCancelResponse = String
+  end
+end

data/rbi/knockapi/models/workflow_trigger_params.rbi

@@ -0,0 +1,137 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::WorkflowTriggerParams, Knockapi::Internal::AnyHash)
+        end
+
+      # The recipients to trigger the workflow for. Can inline identify users, objects,
+      # or use a list of user IDs. Limited to 1,000 recipients.
+      sig do
+        returns(
+          T::Array[
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          ]
+        )
+      end
+      attr_accessor :recipients
+
+      # Specifies a recipient in a request. This can either be a user identifier
+      # (string), an inline user request (object), or an inline object request, which is
+      # determined by the presence of a `collection` property.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          )
+        )
+      end
+      attr_accessor :actor
+
+      # An optional key that is used to reference a specific workflow trigger request
+      # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      # request. Must be provided while triggering a workflow in order to enable
+      # subsequent cancellation. Should be unique across trigger requests to avoid
+      # unintentional cancellations.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cancellation_key
+
+      # An optional map of data to pass into the workflow execution.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      # An request to set a tenant inline.
+      sig { returns(T.nilable(T.any(String, Knockapi::TenantRequest))) }
+      attr_accessor :tenant
+
+      sig do
+        params(
+          recipients:
+            T::Array[
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ],
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
+          cancellation_key: T.nilable(String),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The recipients to trigger the workflow for. Can inline identify users, objects,
+        # or use a list of user IDs. Limited to 1,000 recipients.
+        recipients:,
+        # Specifies a recipient in a request. This can either be a user identifier
+        # (string), an inline user request (object), or an inline object request, which is
+        # determined by the presence of a `collection` property.
+        actor: nil,
+        # An optional key that is used to reference a specific workflow trigger request
+        # when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+        # request. Must be provided while triggering a workflow in order to enable
+        # subsequent cancellation. Should be unique across trigger requests to avoid
+        # unintentional cancellations.
+        cancellation_key: nil,
+        # An optional map of data to pass into the workflow execution.
+        data: nil,
+        # An request to set a tenant inline.
+        tenant: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipients:
+              T::Array[
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ],
+            actor:
+              T.nilable(
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ),
+            cancellation_key: T.nilable(String),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
+            request_options: Knockapi::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/workflow_trigger_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::Models::WorkflowTriggerResponse,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      # This value allows you to track individual messages associated with this trigger
+      # request.
+      sig { returns(String) }
+      attr_accessor :workflow_run_id
+
+      # The response from triggering a workflow.
+      sig { params(workflow_run_id: String).returns(T.attached_class) }
+      def self.new(
+        # This value allows you to track individual messages associated with this trigger
+        # request.
+        workflow_run_id:
+      )
+      end
+
+      sig { override.returns({ workflow_run_id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Knockapi
+  # 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: 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.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    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
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    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

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Audiences
+      # Adds one or more members to the specified audience.
+      sig do
+        params(
+          key: String,
+          members: T::Array[Knockapi::AudienceAddMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def add_members(
+        # The key of the audience.
+        key,
+        # A list of audience members to add.
+        members:,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of members for the specified audience.
+      sig do
+        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
+
+      # Removes one or more members from the specified audience.
+      sig do
+        params(
+          key: String,
+          members:
+            T::Array[Knockapi::AudienceRemoveMembersParams::Member::OrHash],
+          request_options: Knockapi::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def remove_members(
+        # The key of the audience.
+        key,
+        # A list of audience members to remove.
+        members:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/bulk_operations.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class BulkOperations
+      # Retrieves a bulk operation (if it exists) and displays the current state of it.
+      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
+
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Channels
+      class Bulk
+        # Bulk update the status of messages for a specific channel. The channel is
+        # specified by the `channel_id` parameter. The action to perform is specified by
+        # the `action` parameter, where the action is a status change action (e.g.
+        # `archive`, `unarchive`).
+        sig do
+          params(
+            channel_id: String,
+            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,
+            recipient_ids: T::Array[String],
+            tenants: T::Array[String],
+            trigger_data: String,
+            workflows: T::Array[String],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(Knockapi::BulkOperation)
+        end
+        def update_message_status(
+          # The ID of the channel to update messages for.
+          channel_id,
+          # The target status to be applied to the messages.
+          action,
+          # Limits the results to messages with the given archived status.
+          archived: nil,
+          # Limits the results to messages with the given delivery status.
+          delivery_status: nil,
+          # Limits the results to messages with the given engagement status.
+          engagement_status: nil,
+          # Limits the results to messages that have a tenant or not.
+          has_tenant: nil,
+          # Limits the results to messages inserted after the given date.
+          newer_than: nil,
+          # Limits the results to messages inserted before the given date.
+          older_than: nil,
+          # Limits the results to messages with the given recipient IDs.
+          recipient_ids: nil,
+          # Limits the results to messages with the given tenant IDs.
+          tenants: nil,
+          # Limits the results to only messages that were generated with the given data. See
+          # [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
+          # more information.
+          trigger_data: nil,
+          # Limits the results to messages with the given workflow keys.
+          workflows: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Knockapi::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/resources/channels.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Knockapi
+  module Resources
+    class Channels
+      sig { returns(Knockapi::Resources::Channels::Bulk) }
+      attr_reader :bulk
+
+      # @api private
+      sig { params(client: Knockapi::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end