knockapi 0.6.1 → 1.0.0

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::Models::Tenant>]
+      #
+      # @see Knockapi::Models::TenantListParams
+      def list(params = {})
+        parsed, options = Knockapi::Models::TenantListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/tenants",
+          query: parsed,
+          page: Knockapi::Internal::EntriesCursor,
+          model: Knockapi::Models::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::Models::Tenant]
+      #
+      # @see Knockapi::Models::TenantGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/tenants/%1$s", id],
+          model: Knockapi::Models::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::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Models::Tenant]
+      #
+      # @see Knockapi::Models::TenantSetParams
+      def set(id, params = {})
+        parsed, options = Knockapi::Models::TenantSetParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["v1/tenants/%1$s", id],
+          body: parsed,
+          model: Knockapi::Models::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::Models::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkDeleteParams
+        def delete(params)
+          parsed, options = Knockapi::Models::Users::BulkDeleteParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/delete",
+            body: parsed,
+            model: Knockapi::Models::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::Models::InlineIdentifyUserRequest>] A list of users.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkIdentifyParams
+        def identify(params)
+          parsed, options = Knockapi::Models::Users::BulkIdentifyParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/identify",
+            body: parsed,
+            model: Knockapi::Models::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::Models::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::Models::BulkOperation]
+        #
+        # @see Knockapi::Models::Users::BulkSetPreferencesParams
+        def set_preferences(params)
+          parsed, options = Knockapi::Models::Users::BulkSetPreferencesParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/users/bulk/preferences",
+            body: parsed,
+            model: Knockapi::Models::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Users
+      class Feeds
+        # Returns the feed settings for a user.
+        #
+        # @overload get_settings(user_id, id, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param id [String] The unique identifier for the channel.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Users::FeedGetSettingsResponse]
+        #
+        # @see Knockapi::Models::Users::FeedGetSettingsParams
+        def get_settings(user_id, id, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/users/%1$s/feeds/%2$s/settings", user_id, id],
+            model: Knockapi::Models::Users::FeedGetSettingsResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # Returns a paginated list of feed items for a user, including metadata about the
+        # feed.
+        #
+        # @overload list_items(user_id, id, after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param id [String] The unique identifier for the channel.
+        #
+        # @param after [String] The cursor to fetch entries after.
+        #
+        # @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
+        #
+        # @param before [String] The cursor to fetch entries before.
+        #
+        # @param has_tenant [Boolean] Whether the feed items have a tenant.
+        #
+        # @param page_size [Integer] The number of items per page.
+        #
+        # @param source [String] The source of the feed items.
+        #
+        # @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
+        #
+        # @param tenant [String] The tenant associated with the feed items.
+        #
+        # @param trigger_data [String] The trigger data of the feed items (as a JSON string).
+        #
+        # @param workflow_categories [Array<String>] The workflow categories of the feed items.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Users::FeedListItemsResponse>]
+        #
+        # @see Knockapi::Models::Users::FeedListItemsParams
+        def list_items(user_id, id, params = {})
+          parsed, options = Knockapi::Models::Users::FeedListItemsParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v1/users/%1$s/feeds/%2$s", user_id, id],
+            query: parsed,
+            page: Knockapi::Internal::EntriesCursor,
+            model: Knockapi::Models::Users::FeedListItemsResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Users
+      class Guides
+        # Returns a list of eligible in-app guides for a specific user and channel.
+        #
+        # @overload get_channel(user_id, channel_id, data: nil, tenant: nil, type: nil, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param channel_id [String] The unique identifier for the channel.
+        #
+        # @param data [String] The data (JSON encoded object) to use for targeting and rendering guides.
+        #
+        # @param tenant [String] The tenant ID to use for targeting and rendering guides.
+        #
+        # @param type [String] The type of guides to filter by.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Users::GuideGetChannelResponse]
+        #
+        # @see Knockapi::Models::Users::GuideGetChannelParams
+        def get_channel(user_id, channel_id, params = {})
+          parsed, options = Knockapi::Models::Users::GuideGetChannelParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["v1/users/%1$s/guides/%2$s", user_id, channel_id],
+            query: parsed,
+            model: Knockapi::Models::Users::GuideGetChannelResponse,
+            options: options
+          )
+        end
+
+        # Records that a guide has been archived by a user, triggering any associated
+        # archived events.
+        #
+        # @overload mark_message_as_archived(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param message_id [String] The unique identifier for the message.
+        #
+        # @param channel_id [String] The unique identifier for the channel.
+        #
+        # @param guide_id [String] The unique identifier for the guide.
+        #
+        # @param guide_key [String] The key of the guide.
+        #
+        # @param guide_step_ref [String] The step reference of the guide.
+        #
+        # @param content [Hash{Symbol=>Object}] The content of the guide.
+        #
+        # @param data [Hash{Symbol=>Object}] The data of the guide.
+        #
+        # @param is_final [Boolean] Whether the guide is final.
+        #
+        # @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+        #
+        # @param tenant [String, nil] The tenant ID of the guide.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse]
+        #
+        # @see Knockapi::Models::Users::GuideMarkMessageAsArchivedParams
+        def mark_message_as_archived(user_id, message_id, params)
+          parsed, options = Knockapi::Models::Users::GuideMarkMessageAsArchivedParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["v1/users/%1$s/guides/messages/%2$s/archived", user_id, message_id],
+            body: parsed,
+            model: Knockapi::Models::Users::GuideMarkMessageAsArchivedResponse,
+            options: options
+          )
+        end
+
+        # Records that a user has interacted with a guide, triggering any associated
+        # interacted events.
+        #
+        # @overload mark_message_as_interacted(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param message_id [String] The unique identifier for the message.
+        #
+        # @param channel_id [String] The unique identifier for the channel.
+        #
+        # @param guide_id [String] The unique identifier for the guide.
+        #
+        # @param guide_key [String] The key of the guide.
+        #
+        # @param guide_step_ref [String] The step reference of the guide.
+        #
+        # @param content [Hash{Symbol=>Object}] The content of the guide.
+        #
+        # @param data [Hash{Symbol=>Object}] The data of the guide.
+        #
+        # @param is_final [Boolean] Whether the guide is final.
+        #
+        # @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+        #
+        # @param tenant [String, nil] The tenant ID of the guide.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse]
+        #
+        # @see Knockapi::Models::Users::GuideMarkMessageAsInteractedParams
+        def mark_message_as_interacted(user_id, message_id, params)
+          parsed, options = Knockapi::Models::Users::GuideMarkMessageAsInteractedParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["v1/users/%1$s/guides/messages/%2$s/interacted", user_id, message_id],
+            body: parsed,
+            model: Knockapi::Models::Users::GuideMarkMessageAsInteractedResponse,
+            options: options
+          )
+        end
+
+        # Records that a guide has been seen by a user, triggering any associated seen
+        # events.
+        #
+        # @overload mark_message_as_seen(user_id, message_id, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #
+        # @param user_id [String] The ID for the user that you set when identifying them in Knock.
+        #
+        # @param message_id [String] The unique identifier for the message.
+        #
+        # @param channel_id [String] The unique identifier for the channel.
+        #
+        # @param guide_id [String] The unique identifier for the guide.
+        #
+        # @param guide_key [String] The key of the guide.
+        #
+        # @param guide_step_ref [String] The step reference of the guide.
+        #
+        # @param content [Hash{Symbol=>Object}] The content of the guide.
+        #
+        # @param data [Hash{Symbol=>Object}] The data of the guide.
+        #
+        # @param is_final [Boolean] Whether the guide is final.
+        #
+        # @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+        #
+        # @param tenant [String, nil] The tenant ID of the guide.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Users::GuideMarkMessageAsSeenResponse]
+        #
+        # @see Knockapi::Models::Users::GuideMarkMessageAsSeenParams
+        def mark_message_as_seen(user_id, message_id, params)
+          parsed, options = Knockapi::Models::Users::GuideMarkMessageAsSeenParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["v1/users/%1$s/guides/messages/%2$s/seen", user_id, message_id],
+            body: parsed,
+            model: Knockapi::Models::Users::GuideMarkMessageAsSeenResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end