knockapi 0.6.1 → 1.1.0

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Providers
+      class Slack
+        # Check if a Slack channel is authenticated.
+        #
+        # @overload check_auth(channel_id, access_token_object:, request_options: {})
+        #
+        # @param channel_id [String] The ID of the Knock Slack channel to check.
+        #
+        # @param access_token_object [String] A JSON encoded string containing the access token object reference.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Providers::SlackCheckAuthResponse]
+        #
+        # @see Knockapi::Models::Providers::SlackCheckAuthParams
+        def check_auth(channel_id, params)
+          parsed, options = Knockapi::Providers::SlackCheckAuthParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v1/providers/slack/%1$s/auth_check", channel_id],
+            query: parsed,
+            model: Knockapi::Models::Providers::SlackCheckAuthResponse,
+            options: options
+          )
+        end
+
+        # List Slack channels for a Slack workspace.
+        #
+        # @overload list_channels(channel_id, access_token_object:, query_options: nil, request_options: {})
+        #
+        # @param channel_id [String] The ID of the Knock Slack channel to get channels for.
+        #
+        # @param access_token_object [String] A JSON encoded string containing the access token object reference.
+        #
+        # @param query_options [Knockapi::Providers::SlackListChannelsParams::QueryOptions]
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Internal::SlackChannelsCursor<Knockapi::Models::Providers::SlackListChannelsResponse>]
+        #
+        # @see Knockapi::Models::Providers::SlackListChannelsParams
+        def list_channels(channel_id, params)
+          parsed, options = Knockapi::Providers::SlackListChannelsParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v1/providers/slack/%1$s/channels", channel_id],
+            query: parsed,
+            page: Knockapi::Internal::SlackChannelsCursor,
+            model: Knockapi::Models::Providers::SlackListChannelsResponse,
+            options: options
+          )
+        end
+
+        # Revoke access for a Slack channel.
+        #
+        # @overload revoke_access(channel_id, access_token_object:, request_options: {})
+        #
+        # @param channel_id [String] The ID of the Knock Slack channel to revoke access for.
+        #
+        # @param access_token_object [String] A JSON encoded string containing the access token object reference.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Providers::SlackRevokeAccessResponse]
+        #
+        # @see Knockapi::Models::Providers::SlackRevokeAccessParams
+        def revoke_access(channel_id, params)
+          parsed, options = Knockapi::Providers::SlackRevokeAccessParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["v1/providers/slack/%1$s/revoke_access", channel_id],
+            query: parsed,
+            model: Knockapi::Models::Providers::SlackRevokeAccessResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/providers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Providers
+      # @return [Knockapi::Resources::Providers::Slack]
+      attr_reader :slack
+
+      # @return [Knockapi::Resources::Providers::MsTeams]
+      attr_reader :ms_teams
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @slack = Knockapi::Resources::Providers::Slack.new(client: client)
+        @ms_teams = Knockapi::Resources::Providers::MsTeams.new(client: client)
+      end
+    end
+  end
+end

data/lib/knockapi/resources/recipients/channel_data.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Recipients
+      class ChannelData
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/recipients/preferences.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Recipients
+      class Preferences
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/recipients/subscriptions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Recipients
+      class Subscriptions
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/recipients.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Recipients
+      # @return [Knockapi::Resources::Recipients::Subscriptions]
+      attr_reader :subscriptions
+
+      # @return [Knockapi::Resources::Recipients::Preferences]
+      attr_reader :preferences
+
+      # @return [Knockapi::Resources::Recipients::ChannelData]
+      attr_reader :channel_data
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @subscriptions = Knockapi::Resources::Recipients::Subscriptions.new(client: client)
+        @preferences = Knockapi::Resources::Recipients::Preferences.new(client: client)
+        @channel_data = Knockapi::Resources::Recipients::ChannelData.new(client: client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Schedules
+      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)
+        # for the `actor`, `recipient`, and `tenant` fields.
+        #
+        # @overload create(schedules:, request_options: {})
+        #
+        # @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Schedules::BulkCreateParams
+        def create(params)
+          parsed, options = Knockapi::Schedules::BulkCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/schedules/bulk/create",
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/schedules.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Schedules
+      # @return [Knockapi::Resources::Schedules::Bulk]
+      attr_reader :bulk
+
+      # Creates one or more schedules for a workflow with the specified recipients,
+      # timing, and data. Schedules can be one-time or recurring. This endpoint also
+      # handles
+      # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+      # for the `actor`, `recipient`, and `tenant` fields.
+      #
+      # @overload create(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
+      #
+      # @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
+      #
+      # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
+      # @param workflow [String] The key of the workflow.
+      #
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      #
+      # @param ending_at [Time, nil] The ending date and time for the schedule.
+      #
+      # @param scheduled_at [Time, nil] The starting date and time for the schedule.
+      #
+      # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Knockapi::Schedule>]
+      #
+      # @see Knockapi::Models::ScheduleCreateParams
+      def create(params)
+        parsed, options = Knockapi::ScheduleCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/schedules",
+          body: parsed,
+          model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Knockapi::Models::ScheduleUpdateParams} for more details.
+      #
+      # Updates one or more existing schedules with new timing, data, or other
+      # properties. All specified schedule IDs will be updated with the same values.
+      # This endpoint also handles
+      # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
+      # for the `actor`, `recipient`, and `tenant` fields.
+      #
+      # @overload update(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
+      #
+      # @param schedule_ids [Array<String>] A list of schedule IDs.
+      #
+      # @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
+      #
+      # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      #
+      # @param ending_at [Time, nil] The ending date and time for the schedule.
+      #
+      # @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
+      # @param scheduled_at [Time, nil] The starting date and time for the schedule.
+      #
+      # @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Knockapi::Schedule>]
+      #
+      # @see Knockapi::Models::ScheduleUpdateParams
+      def update(params)
+        parsed, options = Knockapi::ScheduleUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: "v1/schedules",
+          body: parsed,
+          model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+          options: options
+        )
+      end
+
+      # Returns a paginated list of schedules for the current environment, filtered by
+      # workflow and optionally by recipients and tenant.
+      #
+      # @overload list(workflow:, after: nil, before: nil, page_size: nil, recipients: nil, tenant: nil, request_options: {})
+      #
+      # @param workflow [String] Filter by workflow key.
+      #
+      # @param after [String] The cursor to fetch entries after.
+      #
+      # @param before [String] The cursor to fetch entries before.
+      #
+      # @param page_size [Integer] The number of items per page.
+      #
+      # @param recipients [Array<String>] Filter by recipient IDs.
+      #
+      # @param tenant [String] Filter by tenant ID.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
+      #
+      # @see Knockapi::Models::ScheduleListParams
+      def list(params)
+        parsed, options = Knockapi::ScheduleListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/schedules",
+          query: parsed,
+          page: Knockapi::Internal::EntriesCursor,
+          model: Knockapi::Schedule,
+          options: options
+        )
+      end
+
+      # Permanently deletes one or more schedules identified by the provided schedule
+      # IDs. This operation cannot be undone.
+      #
+      # @overload delete(schedule_ids:, request_options: {})
+      #
+      # @param schedule_ids [Array<String>] A list of schedule IDs.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<Knockapi::Schedule>]
+      #
+      # @see Knockapi::Models::ScheduleDeleteParams
+      def delete(params)
+        parsed, options = Knockapi::ScheduleDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: "v1/schedules",
+          body: parsed,
+          model: Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule],
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @bulk = Knockapi::Resources::Schedules::Bulk.new(client: client)
+      end
+    end
+  end
+end

data/lib/knockapi/resources/shared.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Shared
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Tenants
+      class Bulk
+        # Delete multiple tenants in a single operation. This operation cannot be undone.
+        #
+        # @overload delete(tenant_ids:, request_options: {})
+        #
+        # @param tenant_ids [Array<String>] The IDs of the tenants to delete.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Tenants::BulkDeleteParams
+        def delete(params)
+          parsed, options = Knockapi::Tenants::BulkDeleteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/tenants/bulk/delete",
+            query: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # Set or update up to 1,000 tenants in a single operation.
+        #
+        # @overload set(tenants:, request_options: {})
+        #
+        # @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Tenants::BulkSetParams
+        def set(params)
+          parsed, options = Knockapi::Tenants::BulkSetParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/tenants/bulk/set",
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/tenants.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Tenants
+      # @return [Knockapi::Resources::Tenants::Bulk]
+      attr_reader :bulk
+
+      # List tenants for the current environment.
+      #
+      # @overload list(after: nil, before: nil, name: nil, page_size: nil, tenant_id: nil, request_options: {})
+      #
+      # @param after [String] The cursor to fetch entries after.
+      #
+      # @param before [String] The cursor to fetch entries before.
+      #
+      # @param name [String] Filter tenants by name.
+      #
+      # @param page_size [Integer] The number of items per page.
+      #
+      # @param tenant_id [String] Filter tenants by ID.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Tenant>]
+      #
+      # @see Knockapi::Models::TenantListParams
+      def list(params = {})
+        parsed, options = Knockapi::TenantListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/tenants",
+          query: parsed,
+          page: Knockapi::Internal::EntriesCursor,
+          model: Knockapi::Tenant,
+          options: options
+        )
+      end
+
+      # Delete a tenant and all associated data. This operation cannot be undone.
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] The unique identifier for the tenant.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Knockapi::Models::TenantDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/tenants/%1$s", id],
+          model: String,
+          options: params[:request_options]
+        )
+      end
+
+      # Get a tenant by ID.
+      #
+      # @overload get(id, request_options: {})
+      #
+      # @param id [String] The unique identifier for the tenant.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Tenant]
+      #
+      # @see Knockapi::Models::TenantGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/tenants/%1$s", id],
+          model: Knockapi::Tenant,
+          options: params[:request_options]
+        )
+      end
+
+      # Sets a tenant within an environment, performing an upsert operation. Any
+      # existing properties will be merged with the incoming properties.
+      #
+      # @overload set(id, channel_data: nil, preferences: nil, settings: nil, request_options: {})
+      #
+      # @param id [String] The unique identifier for the tenant.
+      #
+      # @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      #
+      # @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      # @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Tenant]
+      #
+      # @see Knockapi::Models::TenantSetParams
+      def set(id, params = {})
+        parsed, options = Knockapi::TenantSetParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["v1/tenants/%1$s", id],
+          body: parsed,
+          model: Knockapi::Tenant,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @bulk = Knockapi::Resources::Tenants::Bulk.new(client: client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Users
+      class Bulk
+        # Deletes multiple users in a single operation. Accepts up to 100 user IDs to
+        # delete and returns a bulk operation that can be queried for progress.
+        #
+        # @overload delete(user_ids:, request_options: {})
+        #
+        # @param user_ids [Array<String>] A list of user IDs.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkDeleteParams
+        def delete(params)
+          parsed, options = Knockapi::Users::BulkDeleteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/delete",
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # Identifies multiple users in a single operation. Allows creating or updating up
+        # to 100 users in a single batch with various properties, preferences, and channel
+        # data.
+        #
+        # @overload identify(users:, request_options: {})
+        #
+        # @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkIdentifyParams
+        def identify(params)
+          parsed, options = Knockapi::Users::BulkIdentifyParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/identify",
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # Sets preferences for multiple users in a single operation. Supports either
+        # setting the same preferences for multiple users or specific preferences for each
+        # user.
+        #
+        # @overload set_preferences(preferences:, user_ids:, request_options: {})
+        #
+        # @param preferences [Knockapi::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
+        #
+        # @param user_ids [Array<String>] A list of user IDs.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkSetPreferencesParams
+        def set_preferences(params)
+          parsed, options = Knockapi::Users::BulkSetPreferencesParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/preferences",
+            body: parsed,
+            model: Knockapi::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end