coss 0.1.0

data/lib/coss/email/contacts/types/update_contact_topics_request_topics_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        class UpdateContactTopicsRequestTopicsItem < Internal::Types::Model
+          field :topic, -> { String }, optional: false, nullable: false
+
+          field :status, -> { Coss::Email::Contacts::Types::UpdateContactTopicsRequestTopicsItemStatus }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/update_contact_topics_request_topics_item_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        module UpdateContactTopicsRequestTopicsItemStatus
+          extend Coss::Internal::Types::Enum
+
+          OPTED_IN = "opted_in"
+          OPTED_OUT = "opted_out"
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/upsert_contact_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        class UpsertContactRequest < Internal::Types::Model
+          field :email, -> { String }, optional: false, nullable: false
+
+          field :first_name, -> { String }, optional: true, nullable: false
+
+          field :last_name, -> { String }, optional: true, nullable: false
+
+          field :properties, -> { Internal::Types::Hash[String, Coss::Email::Contacts::Types::UpsertContactRequestPropertiesValue] }, optional: true, nullable: false
+
+          field :status, -> { Coss::Email::Contacts::Types::UpsertContactRequestStatus }, optional: true, nullable: false
+
+          field :audience_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+          field :topics, -> { Internal::Types::Array[Coss::Email::Contacts::Types::UpsertContactRequestTopicsItem] }, optional: true, nullable: false
+
+          field :double_opt_in, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/upsert_contact_request_properties_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        class UpsertContactRequestPropertiesValue < Internal::Types::Model
+          extend Coss::Internal::Types::Union
+
+          member -> { String }
+
+          member -> { Integer }
+
+          member -> { Internal::Types::Boolean }
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/upsert_contact_request_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        module UpsertContactRequestStatus
+          extend Coss::Internal::Types::Enum
+
+          SUBSCRIBED = "subscribed"
+          UNSUBSCRIBED = "unsubscribed"
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/upsert_contact_request_topics_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        class UpsertContactRequestTopicsItem < Internal::Types::Model
+          field :topic, -> { String }, optional: false, nullable: false
+
+          field :status, -> { Coss::Email::Contacts::Types::UpsertContactRequestTopicsItemStatus }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/contacts/types/upsert_contact_request_topics_item_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Contacts
+      module Types
+        module UpsertContactRequestTopicsItemStatus
+          extend Coss::Internal::Types::Enum
+
+          OPTED_IN = "opted_in"
+          OPTED_OUT = "opted_out"
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/dedicated_ips/client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module DedicatedIps
+      class Client
+        # @param client [Coss::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # The organization's dedicated IP pool (the Dedicated IPs add-on, bought on the dashboard's billing page): its
+        # status, its IPs and how much of the last week's mail they delivered. Organization-wide, like domains: every
+        # environment's key sees the same pool; only live emails go through it. Without the add-on the status is
+        # `not_enabled`.
+        #
+        # @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
+        #
+        # @example
+        #   client.email.dedicated_ips.get
+        #
+        # @return [Coss::Types::DedicatedIPPool]
+        def get(request_options: {}, **_params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/dedicated_ips",
+            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::DedicatedIPPool.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/email/marketing_settings/client.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module MarketingSettings
+      class Client
+        # @param client [Coss::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # The API key's environment's sender name and the postal address its marketing emails carry.
+        #
+        # @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
+        #
+        # @example
+        #   client.email.marketing_settings.get
+        #
+        # @return [Coss::Types::MarketingSettings]
+        def get(request_options: {}, **_params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/marketing_settings",
+            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::MarketingSettings.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Changes the fields given (`null` clears one).
+        #
+        # @param request_options [Hash]
+        # @param params [Coss::Email::MarketingSettings::Types::UpdateMarketingSettingsRequest]
+        # @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.email.marketing_settings.update(mailing_address: "Acme Inc., 548 Market St, San Francisco, CA 94104, USA")
+        #
+        # @return [Coss::Types::MarketingSettings]
+        def update(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "PATCH",
+            path: "v1/marketing_settings",
+            body: Coss::Email::MarketingSettings::Types::UpdateMarketingSettingsRequest.new(params).to_h,
+            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::MarketingSettings.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/email/marketing_settings/types/update_marketing_settings_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module MarketingSettings
+      module Types
+        class UpdateMarketingSettingsRequest < Internal::Types::Model
+          field :display_name, -> { String }, optional: true, nullable: false
+
+          field :mailing_address, -> { String }, optional: true, nullable: false
+
+          field :double_opt_in_default, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+          field :confirmation_from, -> { String }, optional: true, nullable: false
+
+          field :confirmation_subject, -> { String }, optional: true, nullable: false
+
+          field :confirmation_html, -> { String }, optional: true, nullable: false
+
+          field :confirmation_text, -> { String }, optional: true, nullable: false
+
+          field :confirmed_redirect_url, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/client.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      class Client
+        # @param client [Coss::Internal::Http::RawClient]
+        #
+        # @return [void]
+        def initialize(client:)
+          @client = client
+        end
+
+        # Emails received by the API key's environment, newest first, without their bodies and headers (retrieve one for
+        # those). Pass the last `id` as `after` to get the next page while `has_more` is true. An `email.received`
+        # webhook announces each one as it arrives.
+        #
+        # @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 [Integer, nil] :limit
+        # @option params [String, nil] :after
+        #
+        # @example
+        #   client.email.received.list
+        #
+        # @return [Coss::Types::ReceivedEmailList]
+        def list(request_options: {}, **params)
+          params = Coss::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          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/received_emails",
+            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::ReceivedEmailList.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # The environment's own domain under coss.com's inbound domain: email sent to any address at it (e.g.
+        # `support@<domain>`) is received by this environment, with no DNS setup. To receive at your own domain, add a
+        # receiving domain instead.
+        #
+        # @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
+        #
+        # @example
+        #   client.email.received.address
+        #
+        # @return [Coss::Types::InboundAddress]
+        def address(request_options: {}, **_params)
+          request = Coss::Internal::JSON::Request.new(
+            base_url: request_options[:base_url],
+            method: "GET",
+            path: "v1/received_emails/address",
+            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::InboundAddress.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # The received email with its headers, text and HTML bodies (each cut at 2 MB, see `truncated`) and attachment
+        # metadata. HTML is the sender's: sanitize it before showing it to anyone.
+        #
+        # @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] :id
+        #
+        # @example
+        #   client.email.received.get(id: "rcvd_01k7c8m4q2f3e9v6t5r1n0p8yz")
+        #
+        # @return [Coss::Types::ReceivedEmail]
+        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/received_emails/#{URI.encode_uri_component(params[: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::ReceivedEmail.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # Deletes the received email with its raw message and attachments right away, instead of at the end of its
+        # retention period.
+        #
+        # @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] :id
+        #
+        # @example
+        #   client.email.received.delete(id: "rcvd_01k7c8m4q2f3e9v6t5r1n0p8yz")
+        #
+        # @return [Coss::Types::DeletedReceivedEmail]
+        def delete(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/received_emails/#{URI.encode_uri_component(params[: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::DeletedReceivedEmail.load(response.body))
+          else
+            error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+
+        # The whole message as received (`message/rfc822`), for your own MIME parser or archive.
+        #
+        # @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] :id
+        #
+        # @example
+        #   client.email.received.get_raw(id: "id")
+        #
+        # @return [untyped]
+        def get_raw(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/received_emails/#{URI.encode_uri_component(params[:id].to_s)}/raw",
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Coss::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          return response.body if code.between?(200, 299)
+
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+
+        # The attachment's bytes, always as `application/octet-stream` (its declared type is the attachment's
+        # `content_type`): treat them as untrusted.
+        #
+        # @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] :id
+        # @option params [String] :attachment_id
+        #
+        # @example
+        #   client.email.received.get_attachment(
+        #     id: "id",
+        #     attachment_id: "attachment_id"
+        #   )
+        #
+        # @return [untyped]
+        def get_attachment(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/received_emails/#{URI.encode_uri_component(params[:id].to_s)}/attachments/#{URI.encode_uri_component(params[:attachment_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
+          return response.body if code.between?(200, 299)
+
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/types/delete_received_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      module Types
+        class DeleteReceivedRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/types/get_attachment_received_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      module Types
+        class GetAttachmentReceivedRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+
+          field :attachment_id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/types/get_raw_received_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      module Types
+        class GetRawReceivedRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/types/get_received_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      module Types
+        class GetReceivedRequest < Internal::Types::Model
+          field :id, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/coss/email/received/types/list_received_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Email
+    module Received
+      module Types
+        class ListReceivedRequest < Internal::Types::Model
+          field :limit, -> { Integer }, optional: true, nullable: false
+
+          field :after, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end