knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/message.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#list
+    class Message < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the message.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String, nil]
+      optional :_typename, String, api_name: :__typename
+
+      # @!attribute actors
+      #   One or more actors that are associated with this message. Note: this is a list
+      #   that can contain up to 10 actors if the message is produced from a
+      #   [batch](/designing-workflows/batch-function).
+      #
+      #   @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
+      optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
+
+      # @!attribute archived_at
+      #   Timestamp when the message was archived.
+      #
+      #   @return [Time, nil]
+      optional :archived_at, Time, nil?: true
+
+      # @!attribute channel_id
+      #   The ID for the channel the message was sent through.
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute clicked_at
+      #   Timestamp when the message was clicked.
+      #
+      #   @return [Time, nil]
+      optional :clicked_at, Time, nil?: true
+
+      # @!attribute data
+      #   Data associated with the message’s workflow run. Includes the workflow trigger
+      #   request’s `data` payload merged with any additional data returned by a
+      #   [fetch function](/designing-workflows/fetch-function). For messages produced
+      #   after a [batch step](/designing-workflows/batch-function), includes the payload
+      #   `data` from the most-recent trigger request (the final `activity` in the batch).
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute engagement_statuses
+      #   A list of engagement statuses.
+      #
+      #   @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>, nil]
+      optional :engagement_statuses,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::Message::EngagementStatus] }
+
+      # @!attribute inserted_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time, nil]
+      optional :inserted_at, Time
+
+      # @!attribute interacted_at
+      #   Timestamp when the message was interacted with.
+      #
+      #   @return [Time, nil]
+      optional :interacted_at, Time, nil?: true
+
+      # @!attribute link_clicked_at
+      #   Timestamp when a link in the message was clicked.
+      #
+      #   @return [Time, nil]
+      optional :link_clicked_at, Time, nil?: true
+
+      # @!attribute metadata
+      #   The metadata associated with the message.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute read_at
+      #   Timestamp when the message was read.
+      #
+      #   @return [Time, nil]
+      optional :read_at, Time, nil?: true
+
+      # @!attribute recipient
+      #   A reference to a recipient, either a user identifier (string) or an object
+      #   reference (ID, collection).
+      #
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
+      optional :recipient, union: -> { Knockapi::Models::RecipientReference }
+
+      # @!attribute scheduled_at
+      #   Timestamp when the message was scheduled to be sent.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, nil?: true
+
+      # @!attribute seen_at
+      #   Timestamp when the message was seen.
+      #
+      #   @return [Time, nil]
+      optional :seen_at, Time, nil?: true
+
+      # @!attribute source
+      #   The workflow that triggered the message.
+      #
+      #   @return [Knockapi::Models::Message::Source, nil]
+      optional :source, -> { Knockapi::Models::Message::Source }
+
+      # @!attribute status
+      #   The message delivery status.
+      #
+      #   @return [Symbol, Knockapi::Models::Message::Status, nil]
+      optional :status, enum: -> { Knockapi::Models::Message::Status }
+
+      # @!attribute tenant
+      #   The ID of the `tenant` associated with the message. Only present when a `tenant`
+      #   is provided on a workflow trigger request.
+      #
+      #   @return [String, nil]
+      optional :tenant, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time
+
+      # @!attribute workflow
+      #   @deprecated
+      #
+      #   The key of the workflow that generated the message.
+      #
+      #   @return [String, nil]
+      optional :workflow, String, nil?: true
+
+      # @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::Message} for more details.
+      #
+      #   Represents a single message that was generated by a workflow for a given
+      #   channel.
+      #
+      #   @param id [String] The unique identifier for the message.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param actors [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
+      #   ...
+      #
+      #   @param archived_at [Time, nil] Timestamp when the message was archived.
+      #
+      #   @param channel_id [String] The ID for the channel the message was sent through.
+      #
+      #   @param clicked_at [Time, nil] Timestamp when the message was clicked.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
+      #   ...
+      #
+      #   @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
+      #
+      #   @param inserted_at [Time] Timestamp when the resource was created.
+      #
+      #   @param interacted_at [Time, nil] Timestamp when the message was interacted with.
+      #
+      #   @param link_clicked_at [Time, nil] Timestamp when a link in the message was clicked.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] The metadata associated with the message.
+      #
+      #   @param read_at [Time, nil] Timestamp when the message was read.
+      #
+      #   @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
+      #   ...
+      #
+      #   @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
+      #
+      #   @param seen_at [Time, nil] Timestamp when the message was seen.
+      #
+      #   @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
+      #
+      #   @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
+      #
+      #   @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
+      #   ...
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param workflow [String, nil] The key of the workflow that generated the message.
+
+      # An engagement status for a message. Can be one of: read, seen, interacted,
+      # link_clicked, archived.
+      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
+
+      # @see Knockapi::Models::Message#source
+      class Source < Knockapi::Internal::Type::BaseModel
+        # @!attribute _typename
+        #
+        #   @return [String]
+        required :_typename, String, api_name: :__typename
+
+        # @!attribute categories
+        #   The categories associated with the message.
+        #
+        #   @return [Array<String>]
+        required :categories, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!attribute key
+        #   The key of the workflow that triggered the message.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute version_id
+        #   The ID of the version of the workflow that triggered the message.
+        #
+        #   @return [String]
+        required :version_id, String
+
+        # @!method initialize(_typename:, categories:, key:, version_id:)
+        #   The workflow that triggered the message.
+        #
+        #   @param _typename [String]
+        #
+        #   @param categories [Array<String>] The categories associated with the message.
+        #
+        #   @param key [String] The key of the workflow that triggered the message.
+        #
+        #   @param version_id [String] The ID of the version of the workflow that triggered the message.
+      end
+
+      # The message delivery status.
+      #
+      # @see Knockapi::Models::Message#status
+      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/message_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#archive
+    class MessageArchiveParams < 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/message_delivery_log.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#list_delivery_logs
+    class MessageDeliveryLog < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the message delivery log.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute environment_id
+      #   The ID of the environment in which the message delivery occurred.
+      #
+      #   @return [String]
+      required :environment_id, String
+
+      # @!attribute inserted_at
+      #   Timestamp when the message delivery log was created.
+      #
+      #   @return [String]
+      required :inserted_at, String
+
+      # @!attribute request
+      #   A message delivery log request.
+      #
+      #   @return [Knockapi::Models::MessageDeliveryLog::Request]
+      required :request, -> { Knockapi::Models::MessageDeliveryLog::Request }
+
+      # @!attribute response
+      #   A message delivery log response.
+      #
+      #   @return [Knockapi::Models::MessageDeliveryLog::Response]
+      required :response, -> { Knockapi::Models::MessageDeliveryLog::Response }
+
+      # @!attribute service_name
+      #   The name of the service that processed the delivery.
+      #
+      #   @return [String]
+      required :service_name, String
+
+      # @!method initialize(id:, _typename:, environment_id:, inserted_at:, request:, response:, service_name:)
+      #   A message delivery log contains a `request` from Knock to a downstream provider
+      #   and the `response` that was returned.
+      #
+      #   @param id [String] The unique identifier for the message delivery log.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param environment_id [String] The ID of the environment in which the message delivery occurred.
+      #
+      #   @param inserted_at [String] Timestamp when the message delivery log was created.
+      #
+      #   @param request [Knockapi::Models::MessageDeliveryLog::Request] A message delivery log request.
+      #
+      #   @param response [Knockapi::Models::MessageDeliveryLog::Response] A message delivery log response.
+      #
+      #   @param service_name [String] The name of the service that processed the delivery.
+
+      # @see Knockapi::Models::MessageDeliveryLog#request
+      class Request < Knockapi::Internal::Type::BaseModel
+        # @!attribute body
+        #   The body content that was sent with the request.
+        #
+        #   @return [String, Hash{Symbol=>Object}, nil]
+        optional :body, union: -> { Knockapi::Models::MessageDeliveryLog::Request::Body }
+
+        # @!attribute headers
+        #   The headers that were sent with the request.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :headers, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+        # @!attribute host
+        #   The host to which the request was sent.
+        #
+        #   @return [String, nil]
+        optional :host, String
+
+        # @!attribute method_
+        #   The HTTP method used for the request.
+        #
+        #   @return [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method, nil]
+        optional :method_, enum: -> { Knockapi::Models::MessageDeliveryLog::Request::Method }, api_name: :method
+
+        # @!attribute path
+        #   The path of the URL that was requested.
+        #
+        #   @return [String, nil]
+        optional :path, String
+
+        # @!attribute query
+        #   The query string of the URL that was requested.
+        #
+        #   @return [String, nil]
+        optional :query, String, nil?: true
+
+        # @!method initialize(body: nil, headers: nil, host: nil, method_: nil, path: nil, query: nil)
+        #   A message delivery log request.
+        #
+        #   @param body [String, Hash{Symbol=>Object}] The body content that was sent with the request.
+        #
+        #   @param headers [Hash{Symbol=>Object}, nil] The headers that were sent with the request.
+        #
+        #   @param host [String] The host to which the request was sent.
+        #
+        #   @param method_ [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
+        #
+        #   @param path [String] The path of the URL that was requested.
+        #
+        #   @param query [String, nil] The query string of the URL that was requested.
+
+        # The body content that was sent with the request.
+        #
+        # @see Knockapi::Models::MessageDeliveryLog::Request#body
+        module Body
+          extend Knockapi::Internal::Type::Union
+
+          variant String
+
+          variant -> { Knockapi::Models::MessageDeliveryLog::Request::Body::UnionMember1Map }
+
+          # @!method self.variants
+          #   @return [Array(String, Hash{Symbol=>Object})]
+
+          # @type [Knockapi::Internal::Type::Converter]
+          UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+        end
+
+        # The HTTP method used for the request.
+        #
+        # @see Knockapi::Models::MessageDeliveryLog::Request#method_
+        module Method
+          extend Knockapi::Internal::Type::Enum
+
+          GET = :GET
+          POST = :POST
+          PUT = :PUT
+          DELETE = :DELETE
+          PATCH = :PATCH
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Knockapi::Models::MessageDeliveryLog#response
+      class Response < Knockapi::Internal::Type::BaseModel
+        # @!attribute body
+        #   The body content that was received with the response.
+        #
+        #   @return [String, Hash{Symbol=>Object}, nil]
+        optional :body, union: -> { Knockapi::Models::MessageDeliveryLog::Response::Body }
+
+        # @!attribute headers
+        #   The headers that were received with the response.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :headers, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+        # @!attribute status
+        #   The HTTP status code of the response.
+        #
+        #   @return [Integer, nil]
+        optional :status, Integer
+
+        # @!method initialize(body: nil, headers: nil, status: nil)
+        #   A message delivery log response.
+        #
+        #   @param body [String, Hash{Symbol=>Object}] The body content that was received with the response.
+        #
+        #   @param headers [Hash{Symbol=>Object}, nil] The headers that were received with the response.
+        #
+        #   @param status [Integer] The HTTP status code of the response.
+
+        # The body content that was received with the response.
+        #
+        # @see Knockapi::Models::MessageDeliveryLog::Response#body
+        module Body
+          extend Knockapi::Internal::Type::Union
+
+          variant String
+
+          variant -> { Knockapi::Models::MessageDeliveryLog::Response::Body::UnionMember1Map }
+
+          # @!method self.variants
+          #   @return [Array(String, Hash{Symbol=>Object})]
+
+          # @type [Knockapi::Internal::Type::Converter]
+          UnionMember1Map = Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/message_event.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#list_events
+    class MessageEvent < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the message event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute inserted_at
+      #   Timestamp when the event was created.
+      #
+      #   @return [Time]
+      required :inserted_at, Time
+
+      # @!attribute recipient
+      #   A reference to a recipient, either a user identifier (string) or an object
+      #   reference (ID, collection).
+      #
+      #   @return [String, Knockapi::Models::RecipientReference::ObjectReference]
+      required :recipient, union: -> { Knockapi::Models::RecipientReference }
+
+      # @!attribute type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, Knockapi::Models::MessageEvent::Type]
+      required :type, enum: -> { Knockapi::Models::MessageEvent::Type }
+
+      # @!attribute data
+      #   The data associated with the message event. Only present for some event types.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(id:, _typename:, inserted_at:, recipient:, type:, data: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::MessageEvent} for more details.
+      #
+      #   A message event. Occurs when a message
+      #   [delivery or engagement status](/send-notifications/message-statuses) changes.
+      #
+      #   @param id [String] The unique identifier for the message event.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param inserted_at [Time] Timestamp when the event was created.
+      #
+      #   @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
+      #   ...
+      #
+      #   @param type [Symbol, Knockapi::Models::MessageEvent::Type] The type of event that occurred.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] The data associated with the message event. Only present for some event types.
+
+      # The type of event that occurred.
+      #
+      # @see Knockapi::Models::MessageEvent#type
+      module Type
+        extend Knockapi::Internal::Type::Enum
+
+        MESSAGE_ARCHIVED = :"message.archived"
+        MESSAGE_BOUNCED = :"message.bounced"
+        MESSAGE_DELIVERED = :"message.delivered"
+        MESSAGE_DELIVERY_ATTEMPTED = :"message.delivery_attempted"
+        MESSAGE_INTERACTED = :"message.interacted"
+        MESSAGE_LINK_CLICKED = :"message.link_clicked"
+        MESSAGE_NOT_SENT = :"message.not_sent"
+        MESSAGE_QUEUED = :"message.queued"
+        MESSAGE_READ = :"message.read"
+        MESSAGE_SEEN = :"message.seen"
+        MESSAGE_SENT = :"message.sent"
+        MESSAGE_UNARCHIVED = :"message.unarchived"
+        MESSAGE_UNDELIVERED = :"message.undelivered"
+        MESSAGE_UNREAD = :"message.unread"
+        MESSAGE_UNSEEN = :"message.unseen"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/message_get_content_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Messages#get_content
+    class MessageGetContentParams < 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