knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/user_list_messages_params.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_messages
+    class UserListMessagesParams < 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 channel_id
+      #   Limits the results to items with the corresponding channel ID.
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute engagement_status
+      #   Limits the results to messages with the given engagement status.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>, nil]
+      optional :engagement_status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::UserListMessagesParams::EngagementStatus] }
+
+      # @!attribute inserted_at
+      #
+      #   @return [Knockapi::Models::UserListMessagesParams::InsertedAt, nil]
+      optional :inserted_at, -> { Knockapi::Models::UserListMessagesParams::InsertedAt }
+
+      # @!attribute message_ids
+      #   Limits the results to only the message IDs given (max 50). Note: when using this
+      #   option, the results will be subject to any other filters applied to the query.
+      #
+      #   @return [Array<String>, nil]
+      optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute source
+      #   Limits the results to messages triggered by the given workflow key.
+      #
+      #   @return [String, nil]
+      optional :source, String
+
+      # @!attribute status
+      #   Limits the results to messages with the given delivery status.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>, nil]
+      optional :status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::UserListMessagesParams::Status] }
+
+      # @!attribute tenant
+      #   Limits the results to items with the corresponding tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute trigger_data
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :trigger_data, String
+
+      # @!attribute workflow_categories
+      #   Limits the results to messages related to any of the provided categories.
+      #
+      #   @return [Array<String>, nil]
+      optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute workflow_recipient_run_id
+      #   Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @return [String, nil]
+      optional :workflow_recipient_run_id, String
+
+      # @!attribute workflow_run_id
+      #   Limits the results to messages associated with the top-level workflow run ID
+      #   returned by the workflow trigger request.
+      #
+      #   @return [String, nil]
+      optional :workflow_run_id, String
+
+      # @!method initialize(after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::UserListMessagesParams} for more details.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param channel_id [String] Limits the results to items with the corresponding channel ID.
+      #
+      #   @param engagement_status [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      #
+      #   @param inserted_at [Knockapi::Models::UserListMessagesParams::InsertedAt]
+      #
+      #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
+      #   ...
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param source [String] Limits the results to messages triggered by the given workflow key.
+      #
+      #   @param status [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
+      #
+      #   @param tenant [String] Limits the results to items with the corresponding tenant.
+      #
+      #   @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
+      #   ...
+      #
+      #   @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
+      #
+      #   @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
+      #   ...
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        SEEN = :seen
+        READ = :read
+        INTERACTED = :interacted
+        LINK_CLICKED = :link_clicked
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        # @!attribute gt
+        #   Limits the results to messages inserted after the given date.
+        #
+        #   @return [String, nil]
+        optional :gt, String
+
+        # @!attribute gte
+        #   Limits the results to messages inserted after or on the given date.
+        #
+        #   @return [String, nil]
+        optional :gte, String
+
+        # @!attribute lt
+        #   Limits the results to messages inserted before the given date.
+        #
+        #   @return [String, nil]
+        optional :lt, String
+
+        # @!attribute lte
+        #   Limits the results to messages inserted before or on the given date.
+        #
+        #   @return [String, nil]
+        optional :lte, String
+
+        # @!method initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+        #   @param gt [String] Limits the results to messages inserted after the given date.
+        #
+        #   @param gte [String] Limits the results to messages inserted after or on the given date.
+        #
+        #   @param lt [String] Limits the results to messages inserted before the given date.
+        #
+        #   @param lte [String] Limits the results to messages inserted before or on the given date.
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        SENT = :sent
+        DELIVERED = :delivered
+        DELIVERY_ATTEMPTED = :delivery_attempted
+        UNDELIVERED = :undelivered
+        NOT_SENT = :not_sent
+        BOUNCED = :bounced
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user_list_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list
+    class UserListParams < 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::Models::UserListParams::Include>, nil]
+      optional :include,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::UserListParams::Include] }
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(after: nil, before: nil, include: 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::Models::UserListParams::Include>] Associated resources to include in the response.
+      #
+      #   @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_list_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_preferences
+    class UserListPreferencesParams < 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_list_preferences_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @type [Knockapi::Internal::Type::Converter]
+    UserListPreferencesResponse =
+      Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Recipients::PreferenceSet }]
+  end
+end

data/lib/knockapi/models/user_list_schedules_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_schedules
+    class UserListSchedulesParams < 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 page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute tenant
+      #   The tenant ID to filter schedules for.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute workflow
+      #   The workflow key to filter schedules for.
+      #
+      #   @return [String, nil]
+      optional :workflow, String
+
+      # @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
+      #   @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 tenant [String] The tenant ID to filter schedules for.
+      #
+      #   @param workflow [String] The workflow key to filter schedules for.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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::Models::UserListSubscriptionsParams::Include>, nil]
+      optional :include,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::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::Models::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_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::Models::InlineIdentifyUserRequest>]
+        required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::InlineIdentifyUserRequest] }
+
+        # @!method initialize(users:, request_options: {})
+        #   @param users [Array<Knockapi::Models::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::Models::Recipients::PreferenceSetRequest]
+        required :preferences, -> { Knockapi::Models::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::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}]
+      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