knockapi 0.6.1 → 1.1.0

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_seen
+      class GuideMarkMessageAsSeenParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute channel_id
+        #   The unique identifier for the channel.
+        #
+        #   @return [String]
+        required :channel_id, String
+
+        # @!attribute guide_id
+        #   The unique identifier for the guide.
+        #
+        #   @return [String]
+        required :guide_id, String
+
+        # @!attribute guide_key
+        #   The key of the guide.
+        #
+        #   @return [String]
+        required :guide_key, String
+
+        # @!attribute guide_step_ref
+        #   The step reference of the guide.
+        #
+        #   @return [String]
+        required :guide_step_ref, String
+
+        # @!attribute content
+        #   The content of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :content, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute data
+        #   The data of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute is_final
+        #   Whether the guide is final.
+        #
+        #   @return [Boolean, nil]
+        optional :is_final, Knockapi::Internal::Type::Boolean
+
+        # @!attribute metadata
+        #   The metadata of the guide.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!attribute tenant
+        #   The tenant ID of the guide.
+        #
+        #   @return [String, nil]
+        optional :tenant, String, nil?: true
+
+        # @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
+        #   @param channel_id [String] The unique identifier for the channel.
+        #
+        #   @param guide_id [String] The unique identifier for the guide.
+        #
+        #   @param guide_key [String] The key of the guide.
+        #
+        #   @param guide_step_ref [String] The step reference of the guide.
+        #
+        #   @param content [Hash{Symbol=>Object}] The content of the guide.
+        #
+        #   @param data [Hash{Symbol=>Object}] The data of the guide.
+        #
+        #   @param is_final [Boolean] Whether the guide is final.
+        #
+        #   @param metadata [Hash{Symbol=>Object}] The metadata of the guide.
+        #
+        #   @param tenant [String, nil] The tenant ID of the guide.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_seen
+      class GuideMarkMessageAsSeenResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute status
+        #   The status of a guide's action.
+        #
+        #   @return [String]
+        required :status, String
+
+        # @!method initialize(status:)
+        #   A response for a guide action.
+        #
+        #   @param status [String] The status of a guide's action.
+      end
+    end
+  end
+end

data/lib/knockapi/models/workflow_cancel_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Workflows#cancel
+    class WorkflowCancelParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute cancellation_key
+      #   An optional key that is used to reference a specific workflow trigger request
+      #   when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      #   request. Must be provided while triggering a workflow in order to enable
+      #   subsequent cancellation. Should be unique across trigger requests to avoid
+      #   unintentional cancellations.
+      #
+      #   @return [String]
+      required :cancellation_key, String
+
+      # @!attribute recipients
+      #   A list of recipients to cancel the notification for. If omitted, cancels for all
+      #   recipients associated with the cancellation key.
+      #
+      #   @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
+      optional :recipients,
+               -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
+               nil?: true
+
+      # @!method initialize(cancellation_key:, recipients: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowCancelParams} for more details.
+      #
+      #   @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
+      #
+      #   @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/workflow_cancel_response.rb

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

data/lib/knockapi/models/workflow_trigger_params.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Workflows#trigger
+    class WorkflowTriggerParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute recipients
+      #   The recipients to trigger the workflow for. Can inline identify users, objects,
+      #   or use a list of user IDs. Limited to 1,000 recipients.
+      #
+      #   @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
+      required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
+
+      # @!attribute actor
+      #   Specifies a recipient in a request. This can either be a user identifier
+      #   (string), an inline user request (object), or an inline object request, which is
+      #   determined by the presence of a `collection` property.
+      #
+      #   @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
+      optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
+
+      # @!attribute cancellation_key
+      #   An optional key that is used to reference a specific workflow trigger request
+      #   when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
+      #   request. Must be provided while triggering a workflow in order to enable
+      #   subsequent cancellation. Should be unique across trigger requests to avoid
+      #   unintentional cancellations.
+      #
+      #   @return [String, nil]
+      optional :cancellation_key, String, nil?: true
+
+      # @!attribute data
+      #   An optional map of data to pass into the workflow execution.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute tenant
+      #   An request to set a tenant inline.
+      #
+      #   @return [String, Knockapi::TenantRequest, nil]
+      optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
+
+      # @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowTriggerParams} for more details.
+      #
+      #   @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
+      #
+      #   @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
+      #
+      #   @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      #
+      #   @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/workflow_trigger_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Workflows#trigger
+    class WorkflowTriggerResponse < Knockapi::Internal::Type::BaseModel
+      # @!attribute workflow_run_id
+      #   This value allows you to track individual messages associated with this trigger
+      #   request.
+      #
+      #   @return [String]
+      required :workflow_run_id, String
+
+      # @!method initialize(workflow_run_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::WorkflowTriggerResponse} for more details.
+      #
+      #   The response from triggering a workflow.
+      #
+      #   @param workflow_run_id [String] This value allows you to track individual messages associated with this trigger
+    end
+  end
+end

data/lib/knockapi/models.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Knockapi
+  [Knockapi::Internal::Type::BaseModel, *Knockapi::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Knockapi::Internal::AnyHash) } }
+  end
+
+  [
+    *Knockapi::Internal::Type::Enum.included_modules,
+    *Knockapi::Internal::Type::Union.included_modules
+  ].each do |cls|
+    cls.constants.each do |name|
+      case cls.const_get(name)
+      in true | false
+        cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
+        cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+      in Integer
+        cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
+        cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+      in Float
+        cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
+        cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+      in Symbol
+        cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
+        cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+      else
+      end
+    end
+  end
+
+  Activity = Knockapi::Models::Activity
+
+  AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
+
+  AudienceListMembersParams = Knockapi::Models::AudienceListMembersParams
+
+  AudienceMember = Knockapi::Models::AudienceMember
+
+  AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
+
+  BulkOperation = Knockapi::Models::BulkOperation
+
+  BulkOperationGetParams = Knockapi::Models::BulkOperationGetParams
+
+  Channels = Knockapi::Models::Channels
+
+  Condition = Knockapi::Models::Condition
+
+  IdentifyUserRequest = Knockapi::Models::IdentifyUserRequest
+
+  InlineIdentifyUserRequest = Knockapi::Models::InlineIdentifyUserRequest
+
+  InlineObjectRequest = Knockapi::Models::InlineObjectRequest
+
+  InlineTenantRequest = Knockapi::Models::InlineTenantRequest
+
+  Integrations = Knockapi::Models::Integrations
+
+  Message = Knockapi::Models::Message
+
+  MessageArchiveParams = Knockapi::Models::MessageArchiveParams
+
+  MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
+
+  MessageEvent = Knockapi::Models::MessageEvent
+
+  MessageGetContentParams = Knockapi::Models::MessageGetContentParams
+
+  MessageGetParams = Knockapi::Models::MessageGetParams
+
+  MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
+
+  MessageListDeliveryLogsParams = Knockapi::Models::MessageListDeliveryLogsParams
+
+  MessageListEventsParams = Knockapi::Models::MessageListEventsParams
+
+  MessageListParams = Knockapi::Models::MessageListParams
+
+  MessageMarkAsInteractedParams = Knockapi::Models::MessageMarkAsInteractedParams
+
+  MessageMarkAsReadParams = Knockapi::Models::MessageMarkAsReadParams
+
+  MessageMarkAsSeenParams = Knockapi::Models::MessageMarkAsSeenParams
+
+  MessageMarkAsUnreadParams = Knockapi::Models::MessageMarkAsUnreadParams
+
+  MessageMarkAsUnseenParams = Knockapi::Models::MessageMarkAsUnseenParams
+
+  Messages = Knockapi::Models::Messages
+
+  MessageUnarchiveParams = Knockapi::Models::MessageUnarchiveParams
+
+  Object = Knockapi::Models::Object
+
+  ObjectAddSubscriptionsParams = Knockapi::Models::ObjectAddSubscriptionsParams
+
+  ObjectDeleteParams = Knockapi::Models::ObjectDeleteParams
+
+  ObjectDeleteSubscriptionsParams = Knockapi::Models::ObjectDeleteSubscriptionsParams
+
+  ObjectGetChannelDataParams = Knockapi::Models::ObjectGetChannelDataParams
+
+  ObjectGetParams = Knockapi::Models::ObjectGetParams
+
+  ObjectGetPreferencesParams = Knockapi::Models::ObjectGetPreferencesParams
+
+  ObjectListMessagesParams = Knockapi::Models::ObjectListMessagesParams
+
+  ObjectListParams = Knockapi::Models::ObjectListParams
+
+  ObjectListPreferencesParams = Knockapi::Models::ObjectListPreferencesParams
+
+  ObjectListSchedulesParams = Knockapi::Models::ObjectListSchedulesParams
+
+  ObjectListSubscriptionsParams = Knockapi::Models::ObjectListSubscriptionsParams
+
+  Objects = Knockapi::Models::Objects
+
+  ObjectSetChannelDataParams = Knockapi::Models::ObjectSetChannelDataParams
+
+  ObjectSetParams = Knockapi::Models::ObjectSetParams
+
+  ObjectSetPreferencesParams = Knockapi::Models::ObjectSetPreferencesParams
+
+  ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
+
+  PageInfo = Knockapi::Models::PageInfo
+
+  Providers = Knockapi::Models::Providers
+
+  Recipient = Knockapi::Models::Recipient
+
+  RecipientReference = Knockapi::Models::RecipientReference
+
+  RecipientRequest = Knockapi::Models::RecipientRequest
+
+  Recipients = Knockapi::Models::Recipients
+
+  Schedule = Knockapi::Models::Schedule
+
+  ScheduleCreateParams = Knockapi::Models::ScheduleCreateParams
+
+  ScheduleDeleteParams = Knockapi::Models::ScheduleDeleteParams
+
+  ScheduleListParams = Knockapi::Models::ScheduleListParams
+
+  ScheduleRepeatRule = Knockapi::Models::ScheduleRepeatRule
+
+  Schedules = Knockapi::Models::Schedules
+
+  ScheduleUpdateParams = Knockapi::Models::ScheduleUpdateParams
+
+  Tenant = Knockapi::Models::Tenant
+
+  TenantDeleteParams = Knockapi::Models::TenantDeleteParams
+
+  TenantGetParams = Knockapi::Models::TenantGetParams
+
+  TenantListParams = Knockapi::Models::TenantListParams
+
+  TenantRequest = Knockapi::Models::TenantRequest
+
+  Tenants = Knockapi::Models::Tenants
+
+  TenantSetParams = Knockapi::Models::TenantSetParams
+
+  User = Knockapi::Models::User
+
+  UserDeleteParams = Knockapi::Models::UserDeleteParams
+
+  UserGetChannelDataParams = Knockapi::Models::UserGetChannelDataParams
+
+  UserGetParams = Knockapi::Models::UserGetParams
+
+  UserGetPreferencesParams = Knockapi::Models::UserGetPreferencesParams
+
+  UserListMessagesParams = Knockapi::Models::UserListMessagesParams
+
+  UserListParams = Knockapi::Models::UserListParams
+
+  UserListPreferencesParams = Knockapi::Models::UserListPreferencesParams
+
+  UserListSchedulesParams = Knockapi::Models::UserListSchedulesParams
+
+  UserListSubscriptionsParams = Knockapi::Models::UserListSubscriptionsParams
+
+  UserMergeParams = Knockapi::Models::UserMergeParams
+
+  Users = Knockapi::Models::Users
+
+  UserSetChannelDataParams = Knockapi::Models::UserSetChannelDataParams
+
+  UserSetPreferencesParams = Knockapi::Models::UserSetPreferencesParams
+
+  UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
+
+  UserUpdateParams = Knockapi::Models::UserUpdateParams
+
+  WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
+
+  WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
+end

data/lib/knockapi/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Knockapi
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Knockapi::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Knockapi::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Knockapi::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash) }
+    end
+  end
+end

data/lib/knockapi/resources/audiences.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Audiences
+      # Adds one or more members to the specified audience.
+      #
+      # @overload add_members(key, members:, request_options: {})
+      #
+      # @param key [String] The key of the audience.
+      #
+      # @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Knockapi::Models::AudienceAddMembersParams
+      def add_members(key, params)
+        parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/audiences/%1$s/members", key],
+          body: parsed,
+          model: String,
+          options: options
+        )
+      end
+
+      # Returns a paginated list of members for the specified audience.
+      #
+      # @overload list_members(key, request_options: {})
+      #
+      # @param key [String] The key of the audience.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::Models::AudienceListMembersResponse]
+      #
+      # @see Knockapi::Models::AudienceListMembersParams
+      def list_members(key, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/audiences/%1$s/members", key],
+          model: Knockapi::Models::AudienceListMembersResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Removes one or more members from the specified audience.
+      #
+      # @overload remove_members(key, members:, request_options: {})
+      #
+      # @param key [String] The key of the audience.
+      #
+      # @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Knockapi::Models::AudienceRemoveMembersParams
+      def remove_members(key, params)
+        parsed, options = Knockapi::AudienceRemoveMembersParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["v1/audiences/%1$s/members", key],
+          body: parsed,
+          model: String,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/knockapi/resources/bulk_operations.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class BulkOperations
+      # Retrieves a bulk operation (if it exists) and displays the current state of it.
+      #
+      # @overload get(id, request_options: {})
+      #
+      # @param id [String] The ID of the bulk operation to retrieve.
+      #
+      # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Knockapi::BulkOperation]
+      #
+      # @see Knockapi::Models::BulkOperationGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/bulk_operations/%1$s", id],
+          model: Knockapi::BulkOperation,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end