knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @type [Knockapi::Internal::Type::Converter]
+      BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
+    end
+  end
+end

data/lib/knockapi/models/messages/batch_unarchive_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @see Knockapi::Resources::Messages::Batch#unarchive
+      class BatchUnarchiveParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute message_ids
+        #   The message IDs to update the status of.
+        #
+        #   @return [Array<String>]
+        required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(message_ids:, request_options: {})
+        #   @param message_ids [Array<String>] The message IDs to update the status of.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/messages/batch_unarchive_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Messages
+      # @type [Knockapi::Internal::Type::Converter]
+      BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
+    end
+  end
+end

data/lib/knockapi/models/object.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list
+    class Object < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute collection
+      #   The collection this object belongs to.
+      #
+      #   @return [String]
+      required :collection, String
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute created_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, nil?: true
+
+      # @!method initialize(id:, _typename:, collection:, updated_at:, created_at: nil)
+      #   A custom [Object](/concepts/objects) entity which belongs to a collection.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param collection [String] The collection this object belongs to.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param created_at [Time, nil] Timestamp when the resource was created.
+    end
+  end
+end

data/lib/knockapi/models/object_add_subscriptions_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#add_subscriptions
+    class ObjectAddSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute recipients
+      #   The recipients of the subscription. You can subscribe up to 100 recipients to an
+      #   object at a time.
+      #
+      #   @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
+      required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientRequest] }
+
+      # @!attribute properties
+      #   The custom properties associated with the subscription relationship.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(recipients:, properties: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
+      #
+      #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+      #   ...
+      #
+      #   @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/object_add_subscriptions_response.rb

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

data/lib/knockapi/models/object_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#delete
+    class ObjectDeleteParams < 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/object_delete_subscriptions_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#delete_subscriptions
+    class ObjectDeleteSubscriptionsParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute recipients
+      #   The recipients of the subscription. You can subscribe up to 100 recipients to an
+      #   object at a time.
+      #
+      #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
+      required :recipients,
+               -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
+
+      # @!method initialize(recipients:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
+      #
+      #   @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
+      #   ...
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/object_delete_subscriptions_response.rb

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

data/lib/knockapi/models/object_get_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#get_channel_data
+    class ObjectGetChannelDataParams < 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/object_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#get
+    class ObjectGetParams < 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/object_get_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#get_preferences
+    class ObjectGetPreferencesParams < 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/object_list_messages_params.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list_messages
+    class ObjectListMessagesParams < 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::ObjectListMessagesParams::EngagementStatus>, nil]
+      optional :engagement_status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::ObjectListMessagesParams::EngagementStatus] }
+
+      # @!attribute inserted_at
+      #
+      #   @return [Knockapi::Models::ObjectListMessagesParams::InsertedAt, nil]
+      optional :inserted_at, -> { Knockapi::Models::ObjectListMessagesParams::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::ObjectListMessagesParams::Status>, nil]
+      optional :status,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::ObjectListMessagesParams::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::ObjectListMessagesParams} 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::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      #
+      #   @param inserted_at [Knockapi::Models::ObjectListMessagesParams::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::ObjectListMessagesParams::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/object_list_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list
+    class ObjectListParams < 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
+      #   Includes preferences of the objects in the response.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::ObjectListParams::Include>, nil]
+      optional :include,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::ObjectListParams::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::ObjectListParams::Include>] Includes preferences of the objects 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/object_list_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list_preferences
+    class ObjectListPreferencesParams < 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/object_list_preferences_response.rb

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

data/lib/knockapi/models/object_list_schedules_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Objects#list_schedules
+    class ObjectListSchedulesParams < 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
+      #   Filter schedules by tenant id.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute workflow
+      #   Filter schedules by workflow id.
+      #
+      #   @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] Filter schedules by tenant id.
+      #
+      #   @param workflow [String] Filter schedules by workflow id.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end