knockapi 0.6.1 → 1.0.0

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_interacted
+      class GuideMarkMessageAsInteractedParams < 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_interacted_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Users
+      # @see Knockapi::Resources::Users::Guides#mark_message_as_interacted
+      class GuideMarkMessageAsInteractedResponse < 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/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,42 @@
+# 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::Models::RecipientReference::ObjectReference>, nil]
+      optional :recipients,
+               -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::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::Models::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_trigger_params.rb

@@ -0,0 +1,67 @@
+# 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::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
+      required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::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::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
+      optional :actor, union: -> { Knockapi::Models::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::Models::TenantRequest, nil]
+      optional :tenant, union: -> { Knockapi::Models::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::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
+      #   ...
+      #
+      #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::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::Models::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,24 @@
+# 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/request_options.rb

@@ -0,0 +1,73 @@
+# 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}]
+  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::Models::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::Models::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::Models::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::Models::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::Models::BulkOperation]
+      #
+      # @see Knockapi::Models::BulkOperationGetParams
+      def get(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/bulk_operations/%1$s", id],
+          model: Knockapi::Models::BulkOperation,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/knockapi/resources/channels/bulk.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Channels
+      class Bulk
+        # Some parameter documentations has been truncated, see
+        # {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
+        #
+        # Bulk update the status of messages for a specific channel. The channel is
+        # specified by the `channel_id` parameter. The action to perform is specified by
+        # the `action` parameter, where the action is a status change action (e.g.
+        # `archive`, `unarchive`).
+        #
+        # @overload update_message_status(channel_id, action, 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: {})
+        #
+        # @param channel_id [String] The ID of the channel to update messages for.
+        #
+        # @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
+        #
+        # @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}, nil]
+        #
+        # @return [Knockapi::Models::BulkOperation]
+        #
+        # @see Knockapi::Models::Channels::BulkUpdateMessageStatusParams
+        def update_message_status(channel_id, action, params = {})
+          parsed, options = Knockapi::Models::Channels::BulkUpdateMessageStatusParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/channels/%1$s/messages/bulk/%2$s", channel_id, action],
+            body: parsed,
+            model: Knockapi::Models::BulkOperation,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/resources/channels.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Channels
+      # @return [Knockapi::Resources::Channels::Bulk]
+      attr_reader :bulk
+
+      # @api private
+      #
+      # @param client [Knockapi::Client]
+      def initialize(client:)
+        @client = client
+        @bulk = Knockapi::Resources::Channels::Bulk.new(client: client)
+      end
+    end
+  end
+end

data/lib/knockapi/resources/integrations/census.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Resources
+    class Integrations
+      class Census
+        # Processes a Census custom destination RPC request.
+        #
+        # @overload custom_destination(id:, jsonrpc:, method_:, params: nil, request_options: {})
+        #
+        # @param id [String] The unique identifier for the RPC request.
+        #
+        # @param jsonrpc [String] The JSON-RPC version.
+        #
+        # @param method_ [String] The method name to execute.
+        #
+        # @param params [Hash{Symbol=>Object}] The parameters for the method.
+        #
+        # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Knockapi::Models::Integrations::CensusCustomDestinationResponse]
+        #
+        # @see Knockapi::Models::Integrations::CensusCustomDestinationParams
+        def custom_destination(params)
+          parsed, options = Knockapi::Models::Integrations::CensusCustomDestinationParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/integrations/census/custom-destination",
+            body: parsed,
+            model: Knockapi::Models::Integrations::CensusCustomDestinationResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Knockapi::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end