knockapi 0.6.1 → 1.0.0

data/lib/knockapi/internal.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Internal
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Knockapi::Internal}::OMIT>" }
+      end
+        .freeze
+  end
+end

data/lib/knockapi/models/activity.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#list_activities
+    class Activity < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the activity.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String, nil]
+      optional :_typename, String, api_name: :__typename
+
+      # @!attribute actor
+      #   A recipient of a notification, which is either a user or an object.
+      #
+      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
+      optional :actor, union: -> { Knockapi::Models::Recipient }, nil?: true
+
+      # @!attribute data
+      #   The workflow trigger `data` payload associated with the activity.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute inserted_at
+      #   Timestamp when the activity was created.
+      #
+      #   @return [Time, nil]
+      optional :inserted_at, Time
+
+      # @!attribute recipient
+      #   A recipient of a notification, which is either a user or an object.
+      #
+      #   @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
+      optional :recipient, union: -> { Knockapi::Models::Recipient }
+
+      # @!attribute updated_at
+      #   Timestamp when the activity was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!method initialize(id: nil, _typename: nil, actor: nil, data: nil, inserted_at: nil, recipient: nil, updated_at: nil)
+      #   An activity associated with a workflow trigger request. Messages produced after
+      #   a [batch step](/designing-workflows/batch-function) can be associated with one
+      #   or more activities. Non-batched messages will always be associated with a single
+      #   activity.
+      #
+      #   @param id [String] Unique identifier for the activity.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] The workflow trigger `data` payload associated with the activity.
+      #
+      #   @param inserted_at [Time] Timestamp when the activity was created.
+      #
+      #   @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
+      #
+      #   @param updated_at [Time] Timestamp when the activity was last updated.
+    end
+  end
+end

data/lib/knockapi/models/audience_add_members_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Audiences#add_members
+    class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute members
+      #   A list of audience members to add.
+      #
+      #   @return [Array<Knockapi::Models::AudienceAddMembersParams::Member>]
+      required :members,
+               -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::AudienceAddMembersParams::Member] }
+
+      # @!method initialize(members:, request_options: {})
+      #   @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      class Member < Knockapi::Internal::Type::BaseModel
+        # @!attribute user
+        #
+        #   @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
+        required :user, -> { Knockapi::Models::AudienceAddMembersParams::Member::User }
+
+        # @!attribute tenant
+        #   The unique identifier for the tenant.
+        #
+        #   @return [String, nil]
+        optional :tenant, String, nil?: true
+
+        # @!method initialize(user:, tenant: nil)
+        #   An audience member.
+        #
+        #   @param user [Knockapi::Models::AudienceAddMembersParams::Member::User]
+        #
+        #   @param tenant [String, nil] The unique identifier for the tenant.
+
+        # @see Knockapi::Models::AudienceAddMembersParams::Member#user
+        class User < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID for the user that you set when identifying them in Knock.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!method initialize(id: nil)
+          #   @param id [String] The ID for the user that you set when identifying them in Knock.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/audience_list_members_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Audiences#list_members
+    class AudienceListMembersParams < 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/audience_list_members_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Audiences#list_members
+    class AudienceListMembersResponse < Knockapi::Internal::Type::BaseModel
+      # @!attribute entries
+      #   A list of audience members.
+      #
+      #   @return [Array<Knockapi::Models::AudienceMember>]
+      required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::AudienceMember] }
+
+      # @!attribute page_info
+      #   Pagination information for a list of resources.
+      #
+      #   @return [Knockapi::Models::PageInfo]
+      required :page_info, -> { Knockapi::Models::PageInfo }
+
+      # @!method initialize(entries:, page_info:)
+      #   A paginated list of audience members.
+      #
+      #   @param entries [Array<Knockapi::Models::AudienceMember>] A list of audience members.
+      #
+      #   @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
+    end
+  end
+end

data/lib/knockapi/models/audience_member.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class AudienceMember < Knockapi::Internal::Type::BaseModel
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute added_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time]
+      required :added_at, Time
+
+      # @!attribute user
+      #   A [User](/concepts/users) represents an individual in your system who can
+      #   receive notifications through Knock. Users are the most common recipients of
+      #   notifications and are always referenced by your internal identifier.
+      #
+      #   @return [Knockapi::Models::User]
+      required :user, -> { Knockapi::Models::User }
+
+      # @!attribute user_id
+      #   The ID for the user that you set when identifying them in Knock.
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!attribute tenant
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String, nil?: true
+
+      # @!method initialize(_typename:, added_at:, user:, user_id:, tenant: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::AudienceMember} for more details.
+      #
+      #   An audience member.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param added_at [Time] Timestamp when the resource was created.
+      #
+      #   @param user [Knockapi::Models::User] A [User](/concepts/users) represents an individual in your system who can receiv
+      #   ...
+      #
+      #   @param user_id [String] The ID for the user that you set when identifying them in Knock.
+      #
+      #   @param tenant [String, nil] The unique identifier for the tenant.
+    end
+  end
+end

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Audiences#remove_members
+    class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute members
+      #   A list of audience members to remove.
+      #
+      #   @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
+      required :members,
+               -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::AudienceRemoveMembersParams::Member] }
+
+      # @!method initialize(members:, request_options: {})
+      #   @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      class Member < Knockapi::Internal::Type::BaseModel
+        # @!attribute user
+        #
+        #   @return [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
+        required :user, -> { Knockapi::Models::AudienceRemoveMembersParams::Member::User }
+
+        # @!attribute tenant
+        #   The unique identifier for the tenant.
+        #
+        #   @return [String, nil]
+        optional :tenant, String, nil?: true
+
+        # @!method initialize(user:, tenant: nil)
+        #   An audience member.
+        #
+        #   @param user [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
+        #
+        #   @param tenant [String, nil] The unique identifier for the tenant.
+
+        # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
+        class User < Knockapi::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID for the user that you set when identifying them in Knock.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!method initialize(id: nil)
+          #   @param id [String] The ID for the user that you set when identifying them in Knock.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/bulk_operation.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::BulkOperations#get
+    class BulkOperation < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the bulk operation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute estimated_total_rows
+      #   The estimated total number of rows to process.
+      #
+      #   @return [Integer]
+      required :estimated_total_rows, Integer
+
+      # @!attribute inserted_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time]
+      required :inserted_at, Time
+
+      # @!attribute name
+      #   The name of the bulk operation.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute processed_rows
+      #   The number of rows processed so far.
+      #
+      #   @return [Integer]
+      required :processed_rows, Integer
+
+      # @!attribute status
+      #   The status of the bulk operation.
+      #
+      #   @return [Symbol, Knockapi::Models::BulkOperation::Status]
+      required :status, enum: -> { Knockapi::Models::BulkOperation::Status }
+
+      # @!attribute success_count
+      #   The number of successful operations.
+      #
+      #   @return [Integer]
+      required :success_count, Integer
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute completed_at
+      #   Timestamp when the bulk operation was completed.
+      #
+      #   @return [Time, nil]
+      optional :completed_at, Time, nil?: true
+
+      # @!attribute error_count
+      #   The number of failed operations.
+      #
+      #   @return [Integer, nil]
+      optional :error_count, Integer
+
+      # @!attribute error_items
+      #   A list of items that failed to be processed.
+      #
+      #   @return [Array<Knockapi::Models::BulkOperation::ErrorItem>, nil]
+      optional :error_items,
+               -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::BulkOperation::ErrorItem] }
+
+      # @!attribute failed_at
+      #   Timestamp when the bulk operation failed.
+      #
+      #   @return [Time, nil]
+      optional :failed_at, Time, nil?: true
+
+      # @!attribute progress_path
+      #   The URI to the bulk operation's progress.
+      #
+      #   @return [String, nil]
+      optional :progress_path, String
+
+      # @!attribute started_at
+      #   Timestamp when the bulk operation was started.
+      #
+      #   @return [Time, nil]
+      optional :started_at, Time, nil?: true
+
+      # @!method initialize(id:, _typename:, estimated_total_rows:, inserted_at:, name:, processed_rows:, status:, success_count:, updated_at:, completed_at: nil, error_count: nil, error_items: nil, failed_at: nil, progress_path: nil, started_at: nil)
+      #   A bulk operation entity.
+      #
+      #   @param id [String] Unique identifier for the bulk operation.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param estimated_total_rows [Integer] The estimated total number of rows to process.
+      #
+      #   @param inserted_at [Time] Timestamp when the resource was created.
+      #
+      #   @param name [String] The name of the bulk operation.
+      #
+      #   @param processed_rows [Integer] The number of rows processed so far.
+      #
+      #   @param status [Symbol, Knockapi::Models::BulkOperation::Status] The status of the bulk operation.
+      #
+      #   @param success_count [Integer] The number of successful operations.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param completed_at [Time, nil] Timestamp when the bulk operation was completed.
+      #
+      #   @param error_count [Integer] The number of failed operations.
+      #
+      #   @param error_items [Array<Knockapi::Models::BulkOperation::ErrorItem>] A list of items that failed to be processed.
+      #
+      #   @param failed_at [Time, nil] Timestamp when the bulk operation failed.
+      #
+      #   @param progress_path [String] The URI to the bulk operation's progress.
+      #
+      #   @param started_at [Time, nil] Timestamp when the bulk operation was started.
+
+      # The status of the bulk operation.
+      #
+      # @see Knockapi::Models::BulkOperation#status
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        PROCESSING = :processing
+        COMPLETED = :completed
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class ErrorItem < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier for the object.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute collection
+        #   The collection this object belongs to.
+        #
+        #   @return [String, nil]
+        optional :collection, String, nil?: true
+
+        # @!method initialize(id:, collection: nil)
+        #   @param id [String] Unique identifier for the object.
+        #
+        #   @param collection [String, nil] The collection this object belongs to.
+      end
+    end
+  end
+end

data/lib/knockapi/models/bulk_operation_get_params.rb

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Channels
+      # @see Knockapi::Resources::Channels::Bulk#update_message_status
+      class BulkUpdateMessageStatusParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute archived
+        #   Limits the results to messages with the given archived status.
+        #
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived, nil]
+        optional :archived, enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived }
+
+        # @!attribute delivery_status
+        #   Limits the results to messages with the given delivery status.
+        #
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
+        optional :delivery_status,
+                 enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus }
+
+        # @!attribute engagement_status
+        #   Limits the results to messages with the given engagement status.
+        #
+        #   @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
+        optional :engagement_status,
+                 enum: -> { Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
+
+        # @!attribute has_tenant
+        #   Limits the results to messages that have a tenant or not.
+        #
+        #   @return [Boolean, nil]
+        optional :has_tenant, Knockapi::Internal::Type::Boolean
+
+        # @!attribute newer_than
+        #   Limits the results to messages inserted after the given date.
+        #
+        #   @return [Time, nil]
+        optional :newer_than, Time
+
+        # @!attribute older_than
+        #   Limits the results to messages inserted before the given date.
+        #
+        #   @return [Time, nil]
+        optional :older_than, Time
+
+        # @!attribute recipient_ids
+        #   Limits the results to messages with the given recipient IDs.
+        #
+        #   @return [Array<String>, nil]
+        optional :recipient_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!attribute tenants
+        #   Limits the results to messages with the given tenant IDs.
+        #
+        #   @return [Array<String>, nil]
+        optional :tenants, Knockapi::Internal::Type::ArrayOf[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 workflows
+        #   Limits the results to messages with the given workflow keys.
+        #
+        #   @return [Array<String>, nil]
+        optional :workflows, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(archived: nil, delivery_status: nil, engagement_status: nil, has_tenant: nil, newer_than: nil, older_than: nil, recipient_ids: nil, tenants: nil, trigger_data: nil, workflows: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
+        #
+        #   @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
+        #
+        #   @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
+        #
+        #   @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
+        #
+        #   @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
+        #
+        #   @param newer_than [Time] Limits the results to messages inserted after the given date.
+        #
+        #   @param older_than [Time] Limits the results to messages inserted before the given date.
+        #
+        #   @param recipient_ids [Array<String>] Limits the results to messages with the given recipient IDs.
+        #
+        #   @param tenants [Array<String>] Limits the results to messages with the given tenant IDs.
+        #
+        #   @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
+        #   ...
+        #
+        #   @param workflows [Array<String>] Limits the results to messages with the given workflow keys.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        module Action
+          extend Knockapi::Internal::Type::Enum
+
+          SEEN = :seen
+          UNSEEN = :unseen
+          READ = :read
+          UNREAD = :unread
+          ARCHIVED = :archived
+          UNARCHIVED = :unarchived
+          INTERACTED = :interacted
+          ARCHIVE = :archive
+          UNARCHIVE = :unarchive
+          DELETE = :delete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Limits the results to messages with the given archived status.
+        module Archived
+          extend Knockapi::Internal::Type::Enum
+
+          EXCLUDE = :exclude
+          INCLUDE = :include
+          ONLY = :only
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Limits the results to messages with the given delivery status.
+        module DeliveryStatus
+          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
+
+        # Limits the results to messages with the given engagement status.
+        module EngagementStatus
+          extend Knockapi::Internal::Type::Enum
+
+          SEEN = :seen
+          UNSEEN = :unseen
+          READ = :read
+          UNREAD = :unread
+          ARCHIVED = :archived
+          UNARCHIVED = :unarchived
+          LINK_CLICKED = :link_clicked
+          INTERACTED = :interacted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end