knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/user_list_subscriptions_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_subscriptions
+    class UserListSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute include
+      #   Associated resources to include in the response.
+      #
+      #   @return [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>, nil]
+      optional :include,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListSubscriptionsParams::Include] }
+
+      # @!attribute objects
+      #   Only returns subscriptions for the specified object GIDs.
+      #
+      #   @return [Array<String>, nil]
+      optional :objects, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(after: nil, before: nil, include: nil, objects: nil, page_size: nil, request_options: {})
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
+      #
+      #   @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES = :preferences
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user_merge_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#merge
+    class UserMergeParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute from_user_id
+      #   The user ID to merge from.
+      #
+      #   @return [String]
+      required :from_user_id, String
+
+      # @!method initialize(from_user_id:, request_options: {})
+      #   @param from_user_id [String] The user ID to merge from.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_set_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#set_channel_data
+    class UserSetChannelDataParams < Knockapi::Models::Recipients::ChannelDataRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_set_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#set_preferences
+    class UserSetPreferencesParams < Knockapi::Models::Recipients::PreferenceSetRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_unset_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#unset_channel_data
+    class UserUnsetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_unset_channel_data_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    UserUnsetChannelDataResponse = String
+  end
+end

data/lib/knockapi/models/user_update_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#update
+    class UserUpdateParams < Knockapi::Models::IdentifyUserRequest
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/users/bulk_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Bulk#delete
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute user_ids
+        #   A list of user IDs.
+        #
+        #   @return [Array<String>]
+        required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(user_ids:, request_options: {})
+        #   @param user_ids [Array<String>] A list of user IDs.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/bulk_identify_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Bulk#identify
+      class BulkIdentifyParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute users
+        #   A list of users.
+        #
+        #   @return [Array<Knockapi::InlineIdentifyUserRequest>]
+        required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineIdentifyUserRequest] }
+
+        # @!method initialize(users:, request_options: {})
+        #   @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/bulk_set_preferences_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Bulk#set_preferences
+      class BulkSetPreferencesParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute preferences
+        #   A request to set a preference set for a recipient.
+        #
+        #   @return [Knockapi::Recipients::PreferenceSetRequest]
+        required :preferences, -> { Knockapi::Recipients::PreferenceSetRequest }
+
+        # @!attribute user_ids
+        #   A list of user IDs.
+        #
+        #   @return [Array<String>]
+        required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(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}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/feed_get_settings_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Feeds#get_settings
+      class FeedGetSettingsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/feed_get_settings_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Feeds#get_settings
+      class FeedGetSettingsResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute features
+        #   Features configuration for the user's feed.
+        #
+        #   @return [Knockapi::Models::Users::FeedGetSettingsResponse::Features]
+        required :features, -> { Knockapi::Models::Users::FeedGetSettingsResponse::Features }
+
+        # @!method initialize(features:)
+        #   The response for the user's feed settings.
+        #
+        #   @param features [Knockapi::Models::Users::FeedGetSettingsResponse::Features] Features configuration for the user's feed.
+
+        # @see Knockapi::Models::Users::FeedGetSettingsResponse#features
+        class Features < Knockapi::Internal::Type::BaseModel
+          # @!attribute branding_required
+          #   Whether branding is required for the user's feed.
+          #
+          #   @return [Boolean]
+          required :branding_required, Knockapi::Internal::Type::Boolean
+
+          # @!method initialize(branding_required:)
+          #   Features configuration for the user's feed.
+          #
+          #   @param branding_required [Boolean] Whether branding is required for the user's feed.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/users/feed_list_items_params.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Feeds#list_items
+      class FeedListItemsParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute after
+        #   The cursor to fetch entries after.
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!attribute archived
+        #   The archived status of the feed items.
+        #
+        #   @return [Symbol, Knockapi::Users::FeedListItemsParams::Archived, nil]
+        optional :archived, enum: -> { Knockapi::Users::FeedListItemsParams::Archived }
+
+        # @!attribute before
+        #   The cursor to fetch entries before.
+        #
+        #   @return [String, nil]
+        optional :before, String
+
+        # @!attribute has_tenant
+        #   Whether the feed items have a tenant.
+        #
+        #   @return [Boolean, nil]
+        optional :has_tenant, Knockapi::Internal::Type::Boolean
+
+        # @!attribute page_size
+        #   The number of items per page.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute source
+        #   The source of the feed items.
+        #
+        #   @return [String, nil]
+        optional :source, String
+
+        # @!attribute status
+        #   The status of the feed items.
+        #
+        #   @return [Symbol, Knockapi::Users::FeedListItemsParams::Status, nil]
+        optional :status, enum: -> { Knockapi::Users::FeedListItemsParams::Status }
+
+        # @!attribute tenant
+        #   The tenant associated with the feed items.
+        #
+        #   @return [String, nil]
+        optional :tenant, String
+
+        # @!attribute trigger_data
+        #   The trigger data of the feed items (as a JSON string).
+        #
+        #   @return [String, nil]
+        optional :trigger_data, String
+
+        # @!attribute workflow_categories
+        #   The workflow categories of the feed items.
+        #
+        #   @return [Array<String>, nil]
+        optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(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 after [String] The cursor to fetch entries after.
+        #
+        #   @param archived [Symbol, Knockapi::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::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}]
+
+        # The archived status of the feed items.
+        module Archived
+          extend Knockapi::Internal::Type::Enum
+
+          EXCLUDE = :exclude
+          INCLUDE = :include
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the feed items.
+        module Status
+          extend Knockapi::Internal::Type::Enum
+
+          UNREAD = :unread
+          READ = :read
+          UNSEEN = :unseen
+          SEEN = :seen
+          ALL = :all
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end