coss 0.1.0

data/lib/coss/hooks/endpoints/types/recover_hook_endpoint_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Endpoints
+      module Types
+        class RecoverHookEndpointRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :endpoint_id, -> { String }, optional: false, nullable: false
+
+          field :since, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/endpoints/types/roll_hook_endpoint_secret_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Endpoints
+      module Types
+        class RollHookEndpointSecretRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :endpoint_id, -> { String }, optional: false, nullable: false
+
+          field :previous_secret_expires_in, -> { Integer }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/endpoints/types/send_hook_test_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Endpoints
+      module Types
+        class SendHookTestRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :endpoint_id, -> { String }, optional: false, nullable: false
+
+          field :event_type, -> { String }, optional: false, nullable: false
+
+          field :payload, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/endpoints/types/update_hook_endpoint_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Endpoints
+      module Types
+        class UpdateHookEndpointRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :endpoint_id, -> { String }, optional: false, nullable: false
+
+          field :url, -> { String }, optional: true, nullable: false
+
+          field :description, -> { String }, optional: true, nullable: false
+
+          field :filter_types, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+          field :rate_limit_per_second, -> { Integer }, optional: true, nullable: false
+
+          field :metadata, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+
+          field :enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/client.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      class Client
+        # @param client [Coss::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # The environment's event types by name; archived ones only with `include_archived`.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [Coss::Hooks::EventTypes::Types::ListEventTypesRequestIncludeArchived, nil] :include_archived
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :after
+        #
+        # @example
+        #   client.hooks.event_types.list
+        #
+        # @return [Coss::Types::HookEventTypeList]
+        def list(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["include_archived"] = params[:include_archived] if params.key?(:include_archived)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["after"] = params[:after] if params.key?(:after)
+
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/hooks/event_types",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookEventTypeList.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Adds a type to the catalog your applications' users subscribe from (in the portal, or the `filter_types` of an
+        # endpoint), with a description, a JSON Schema and examples to show them. Messages can be sent with any type,
+        # registered or not. Hooks resources belong to the API key's own environment: a `coss_test_…` key only ever sees
+        # sandbox ones, a `coss_live_…` key only production ones.
+        #
+        # @param request_options [Hash]
+        # @param params [Coss::Hooks::EventTypes::Types::CreateHookEventTypeRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        #
+        # @example
+        #   client.hooks.event_types.create(
+        #     name: "invoice.paid",
+        #     description: "An invoice was paid in full.",
+        #     examples: [{
+        #       invoice_id: "in_1042",
+        #       amount: 4200,
+        #       currency: "usd"
+        #     }]
+        #   )
+        #
+        # @return [Coss::Types::HookEventType]
+        def create(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          headers = { "Idempotency-Key" => Coss::Internal::IdempotencyKey.generate }
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "v1/hooks/event_types",
+            headers: headers,
+            body: Coss::Hooks::EventTypes::Types::CreateHookEventTypeRequest.new(params).to_h,
+            request_options: request_options,
+            max_retries: 0
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookEventType.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # An event type of the API key's environment, archived or not.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :name
+        #
+        # @example
+        #   client.hooks.event_types.get(name: "invoice.paid")
+        #
+        # @return [Coss::Types::HookEventType]
+        def get(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/hooks/event_types/#{URI.encode_uri_component(params[:name].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookEventType.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Hides the type from the portal and from new subscriptions. Endpoints already subscribed keep receiving it.
+        # Restore it with `PATCH … { archived: false }`.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :name
+        #
+        # @example
+        #   client.hooks.event_types.archive(name: "invoice.paid")
+        #
+        # @return [Coss::Types::HookEventType]
+        def archive(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "DELETE",
+            path: "v1/hooks/event_types/#{URI.encode_uri_component(params[:name].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookEventType.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Changes its description, schema or examples, or archives or restores it.
+        #
+        # @param request_options [Hash]
+        # @param params [Coss::Hooks::EventTypes::Types::UpdateHookEventTypeRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :name
+        #
+        # @example
+        #   client.hooks.event_types.update(
+        #     name: "invoice.paid",
+        #     archived: false
+        #   )
+        #
+        # @return [Coss::Types::HookEventType]
+        def update(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request_data = Coss::Hooks::EventTypes::Types::UpdateHookEventTypeRequest.new(params).to_h
+          non_body_param_names = %w[name]
+          body = request_data.except(*non_body_param_names)
+
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "PATCH",
+            path: "v1/hooks/event_types/#{URI.encode_uri_component(params[:name].to_s)}",
+            body: body,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookEventType.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/archive_event_types_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        class ArchiveEventTypesRequest < Internal::Types::Model
+          field :name, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/create_hook_event_type_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        class CreateHookEventTypeRequest < Internal::Types::Model
+          field :name, -> { String }, optional: false, nullable: false
+
+          field :description, -> { String }, optional: true, nullable: false
+
+          field :schema, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+          field :examples, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/get_event_types_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        class GetEventTypesRequest < Internal::Types::Model
+          field :name, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/list_event_types_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        class ListEventTypesRequest < Internal::Types::Model
+          field :include_archived, -> { Coss::Hooks::EventTypes::Types::ListEventTypesRequestIncludeArchived }, optional: true, nullable: false
+
+          field :limit, -> { Integer }, optional: true, nullable: false
+
+          field :after, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/list_event_types_request_include_archived.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        module ListEventTypesRequestIncludeArchived
+          extend Coss::Internal::Types::Enum
+
+          TRUE = "true"
+          FALSE = "false"
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/event_types/types/update_hook_event_type_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module EventTypes
+      module Types
+        class UpdateHookEventTypeRequest < Internal::Types::Model
+          field :name, -> { String }, optional: false, nullable: false
+
+          field :description, -> { String }, optional: true, nullable: false
+
+          field :schema, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+          field :examples, -> { Internal::Types::Array[Internal::Types::Hash[String, Object]] }, optional: true, nullable: false
+
+          field :archived, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/messages/client.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Messages
+      class Client
+        # @param client [Coss::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # The application's messages, newest first (kept for 30 days).
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :application
+        # @option params [String, nil] :event_type
+        # @option params [Integer, nil] :limit
+        # @option params [String, nil] :after
+        #
+        # @example
+        #   client.hooks.messages.list(application: "customer_8812")
+        #
+        # @return [Coss::Types::HookMessageList]
+        def list(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["event_type"] = params[:event_type] if params.key?(:event_type)
+          query_params["limit"] = params[:limit] if params.key?(:limit)
+          query_params["after"] = params[:after] if params.key?(:after)
+
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/hooks/applications/#{URI.encode_uri_component(params[:application].to_s)}/messages",
+            query: query_params,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookMessageList.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Queues a message to the application: coss.com delivers it to each of its enabled endpoints subscribed to
+        # `event_type` within seconds, signed with each endpoint's secret, and retries failures with backoff for about a
+        # day. Each request's `webhook-id` header is the message's id. Counts against the send quota once per endpoint
+        # it goes to (at least once). Live sends are refused while the organization is suspended (`account_suspended`).
+        # Hooks resources belong to the API key's own environment: a `coss_test_…` key only ever sees sandbox ones, a
+        # `coss_live_…` key only production ones.
+        #
+        # @param request_options [Hash]
+        # @param params [Coss::Hooks::Messages::Types::SendHookMessageRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :application
+        # @option params [String, nil] :idempotency_key
+        #
+        # @example
+        #   client.hooks.messages.send_(
+        #     application: "customer_8812",
+        #     idempotency_key: "invoice-1042-paid",
+        #     event_type: "invoice.paid",
+        #     payload: {
+        #       invoice_id: "in_1042",
+        #       amount: 4200,
+        #       currency: "usd"
+        #     }
+        #   )
+        #
+        # @return [Coss::Types::HookMessage]
+        def send_(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request_data = Coss::Hooks::Messages::Types::SendHookMessageRequest.new(params).to_h
+          non_body_param_names = %w[application Idempotency-Key]
+          body = request_data.except(*non_body_param_names)
+
+          headers = {}
+          headers["Idempotency-Key"] = params[:idempotency_key] if params[:idempotency_key]
+
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "POST",
+            path: "v1/hooks/applications/#{URI.encode_uri_component(params[:application].to_s)}/messages",
+            headers: headers,
+            body: body,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookMessage.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # A message of the application, with its payload.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :application
+        # @option params [String] :message_id
+        #
+        # @example
+        #   client.hooks.messages.get(
+        #     application: "customer_8812",
+        #     message_id: "hmsg_01k7c8m4q2f3e9v6t5r1n0p8yz"
+        #   )
+        #
+        # @return [Coss::Types::HookMessage]
+        def get(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/hooks/applications/#{URI.encode_uri_component(params[:application].to_s)}/messages/#{URI.encode_uri_component(params[:message_id].to_s)}",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookMessage.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # One delivery per endpoint the message went to.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :application
+        # @option params [String] :message_id
+        #
+        # @example
+        #   client.hooks.messages.list_deliveries(
+        #     application: "customer_8812",
+        #     message_id: "hmsg_01k7c8m4q2f3e9v6t5r1n0p8yz"
+        #   )
+        #
+        # @return [Coss::Types::HookDeliveryList]
+        def list_deliveries(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/hooks/applications/#{URI.encode_uri_component(params[:application].to_s)}/messages/#{URI.encode_uri_component(params[:message_id].to_s)}/deliveries",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Coss::Types::HookDeliveryList.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/messages/types/get_messages_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Messages
+      module Types
+        class GetMessagesRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :message_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/messages/types/list_deliveries_messages_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Messages
+      module Types
+        class ListDeliveriesMessagesRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :message_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/hooks/messages/types/list_messages_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Hooks
+    module Messages
+      module Types
+        class ListMessagesRequest < Internal::Types::Model
+          field :application, -> { String }, optional: false, nullable: false
+
+          field :event_type, -> { String }, optional: true, nullable: false
+
+          field :limit, -> { Integer }, optional: true, nullable: false
+
+          field :after, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end