coss 0.1.0 → 0.2.0

data/lib/coss/verify/client.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    class Client
+      # @param client [Coss::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Verifications of the API key's environment, newest first. Pass the last `id` as `after` to get the next page
+      # while `has_more` is true.
+      #
+      # @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, nil] :to
+      # @option params [Coss::Verify::Types::ListVerifyRequestStatus, nil] :status
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :after
+      #
+      # @example
+      #   client.verify.list
+      #
+      # @return [Coss::Types::VerificationList]
+      def list(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["status"] = params[:status] if params.key?(:status)
+        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/verifications",
+          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::VerificationList.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Sends a one-time code to a phone number (SMS) or an email address and returns the verification, `pending` until
+      # you check the code the end user typed (`POST /v1/verifications/check`). Starting again for the same destination
+      # while it is pending sends a new code (the earlier one stops working), up to 5 times. Before a new verification
+      # costs anything, the fraud guard checks it (your Risk lists, premium-rate numbers, Tor, and velocity per IP,
+      # user, number range and country, with how often their codes are entered): a blocked one is stored with its
+      # `reasons` and nothing is sent. Pass the end user's `ip` (and your `user_id`) so it can tell them apart. SMS
+      # codes come from coss.com's shared numbers unless the environment's Verify settings name one of your own; email
+      # codes from your sender, else coss.com's. Sandbox (`coss_test_…`) keys deliver nothing and the code is always
+      # zeros.
+      #
+      # @param request_options [Hash]
+      # @param params [Coss::Verify::Types::StartVerificationRequest]
+      # @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, nil] :idempotency_key
+      #
+      # @example
+      #   client.verify.start(
+      #     idempotency_key: "welcome-user-123",
+      #     to: "+14155550199",
+      #     ip: "203.0.113.7",
+      #     user_id: "user_42"
+      #   )
+      #
+      # @return [Coss::Types::Verification]
+      def start(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        request_data = Coss::Verify::Types::StartVerificationRequest.new(params).to_h
+        non_body_param_names = %w[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/verifications",
+          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::Verification.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Checks the code the end user typed, by the verification's id or by the destination (its latest verification).
+      # `valid: true` approves it (`verification.approved`, billed once); a wrong code spends an attempt, and the last
+      # one fails it. Checking an approved verification again with its code stays valid until it expires, without being
+      # billed again.
+      #
+      # @param request_options [Hash]
+      # @param params [Coss::Verify::Types::CheckVerificationRequest]
+      # @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, nil] :idempotency_key
+      #
+      # @example
+      #   client.verify.check(
+      #     idempotency_key: "welcome-user-123",
+      #     to: "+14155550199",
+      #     code: "482913"
+      #   )
+      #
+      # @return [Coss::Types::VerificationCheck]
+      def check(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        request_data = Coss::Verify::Types::CheckVerificationRequest.new(params).to_h
+        non_body_param_names = %w[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/verifications/check",
+          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::VerificationCheck.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @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.verify.get(id: "vrf_01k8e2m4q2f3e9v6t5r1n0p8yz")
+      #
+      # @return [Coss::Types::Verification]
+      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/verifications/#{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::Verification.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Cancels a pending verification: its code stops working. Canceling it again returns it as is.
+      #
+      # @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.verify.cancel(id: "vrf_01k8e2m4q2f3e9v6t5r1n0p8yz")
+      #
+      # @return [Coss::Types::Verification]
+      def cancel(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/verifications/#{URI.encode_uri_component(params[:id].to_s)}/cancel",
+          headers: headers,
+          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::Verification.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

data/lib/coss/verify/types/cancel_verify_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      class CancelVerifyRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/verify/types/check_verification_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      class CheckVerificationRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
+
+        field :verification_id, -> { String }, optional: true, nullable: false
+
+        field :to, -> { String }, optional: true, nullable: false
+
+        field :code, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/verify/types/get_verify_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      class GetVerifyRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/verify/types/list_verify_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      class ListVerifyRequest < Internal::Types::Model
+        field :to, -> { String }, optional: true, nullable: false
+
+        field :status, -> { Coss::Verify::Types::ListVerifyRequestStatus }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :after, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/verify/types/list_verify_request_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      module ListVerifyRequestStatus
+        extend Coss::Internal::Types::Enum
+
+        PENDING = "pending"
+        APPROVED = "approved"
+        EXPIRED = "expired"
+        CANCELED = "canceled"
+        FAILED = "failed"
+        BLOCKED = "blocked"
+      end
+    end
+  end
+end

data/lib/coss/verify/types/start_verification_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      class StartVerificationRequest < Internal::Types::Model
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "Idempotency-Key"
+
+        field :to, -> { String }, optional: false, nullable: false
+
+        field :channel, -> { Coss::Verify::Types::StartVerificationRequestChannel }, optional: true, nullable: false
+
+        field :ip, -> { String }, optional: true, nullable: false
+
+        field :user_id, -> { String }, optional: true, nullable: false
+
+        field :tags, -> { Internal::Types::Array[Coss::Verify::Types::StartVerificationRequestTagsItem] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/verify/types/start_verification_request_channel.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coss
+  module Verify
+    module Types
+      module StartVerificationRequestChannel
+        extend Coss::Internal::Types::Enum
+
+        SMS = "sms"
+        EMAIL = "email"
+      end
+    end
+  end
+end

data/lib/coss/verify/types/start_verification_request_tags_item.rb

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

data/lib/coss/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coss
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/coss/webhook_endpoints/types/create_webhook_endpoint_request_event_types_item.rb

@@ -27,6 +27,10 @@ module Coss
         ACCOUNT_REINSTATED = "account.reinstated"
         ACCOUNT_MARKETING_PAUSED = "account.marketing_paused"
         ACCOUNT_MARKETING_REINSTATED = "account.marketing_reinstated"
+        SUBACCOUNT_REPUTATION_WARNING = "subaccount.reputation_warning"
+        SUBACCOUNT_REPUTATION_RECOVERED = "subaccount.reputation_recovered"
+        SUBACCOUNT_PAUSED = "subaccount.paused"
+        SUBACCOUNT_REINSTATED = "subaccount.reinstated"
         HOOK_ENDPOINT_DISABLED = "hook_endpoint.disabled"
         BILLING_INVOICE_FINALIZED = "billing.invoice_finalized"
         BILLING_INVOICE_PAID = "billing.invoice_paid"
@@ -52,6 +56,7 @@ module Coss
         BROADCAST_PAUSED = "broadcast.paused"
         BROADCAST_CANCELED = "broadcast.canceled"
         BROADCAST_FAILED = "broadcast.failed"
+        INBOX_MESSAGE_RECEIVED = "inbox.message.received"
         SMS_SCHEDULED = "sms.scheduled"
         SMS_SENT = "sms.sent"
         SMS_DELIVERED = "sms.delivered"
@@ -62,6 +67,18 @@ module Coss
         SMS_RECEIVED = "sms.received"
         SMS_OPTED_OUT = "sms.opted_out"
         SMS_OPTED_IN = "sms.opted_in"
+        SIGN_REQUEST_SENT = "sign_request.sent"
+        SIGN_REQUEST_VIEWED = "sign_request.viewed"
+        SIGN_REQUEST_SIGNER_SIGNED = "sign_request.signer_signed"
+        SIGN_REQUEST_DECLINED = "sign_request.declined"
+        SIGN_REQUEST_COMPLETED = "sign_request.completed"
+        SIGN_REQUEST_CANCELED = "sign_request.canceled"
+        SIGN_REQUEST_EXPIRED = "sign_request.expired"
+        VERIFICATION_APPROVED = "verification.approved"
+        VERIFICATION_FAILED = "verification.failed"
+        VERIFICATION_BLOCKED = "verification.blocked"
+        FORM_SUBMISSION_RECEIVED = "form.submission.received"
+        FORM_SUBMISSION_FLAGGED = "form.submission.flagged"
       end
     end
   end

data/lib/coss/webhook_endpoints/types/update_webhook_endpoint_request_event_types_item.rb

@@ -27,6 +27,10 @@ module Coss
         ACCOUNT_REINSTATED = "account.reinstated"
         ACCOUNT_MARKETING_PAUSED = "account.marketing_paused"
         ACCOUNT_MARKETING_REINSTATED = "account.marketing_reinstated"
+        SUBACCOUNT_REPUTATION_WARNING = "subaccount.reputation_warning"
+        SUBACCOUNT_REPUTATION_RECOVERED = "subaccount.reputation_recovered"
+        SUBACCOUNT_PAUSED = "subaccount.paused"
+        SUBACCOUNT_REINSTATED = "subaccount.reinstated"
         HOOK_ENDPOINT_DISABLED = "hook_endpoint.disabled"
         BILLING_INVOICE_FINALIZED = "billing.invoice_finalized"
         BILLING_INVOICE_PAID = "billing.invoice_paid"
@@ -52,6 +56,7 @@ module Coss
         BROADCAST_PAUSED = "broadcast.paused"
         BROADCAST_CANCELED = "broadcast.canceled"
         BROADCAST_FAILED = "broadcast.failed"
+        INBOX_MESSAGE_RECEIVED = "inbox.message.received"
         SMS_SCHEDULED = "sms.scheduled"
         SMS_SENT = "sms.sent"
         SMS_DELIVERED = "sms.delivered"
@@ -62,6 +67,18 @@ module Coss
         SMS_RECEIVED = "sms.received"
         SMS_OPTED_OUT = "sms.opted_out"
         SMS_OPTED_IN = "sms.opted_in"
+        SIGN_REQUEST_SENT = "sign_request.sent"
+        SIGN_REQUEST_VIEWED = "sign_request.viewed"
+        SIGN_REQUEST_SIGNER_SIGNED = "sign_request.signer_signed"
+        SIGN_REQUEST_DECLINED = "sign_request.declined"
+        SIGN_REQUEST_COMPLETED = "sign_request.completed"
+        SIGN_REQUEST_CANCELED = "sign_request.canceled"
+        SIGN_REQUEST_EXPIRED = "sign_request.expired"
+        VERIFICATION_APPROVED = "verification.approved"
+        VERIFICATION_FAILED = "verification.failed"
+        VERIFICATION_BLOCKED = "verification.blocked"
+        FORM_SUBMISSION_RECEIVED = "form.submission.received"
+        FORM_SUBMISSION_FLAGGED = "form.submission.flagged"
       end
     end
   end

data/lib/coss/webhook_events/types/create_test_webhook_event_request_type.rb

@@ -27,6 +27,10 @@ module Coss
         ACCOUNT_REINSTATED = "account.reinstated"
         ACCOUNT_MARKETING_PAUSED = "account.marketing_paused"
         ACCOUNT_MARKETING_REINSTATED = "account.marketing_reinstated"
+        SUBACCOUNT_REPUTATION_WARNING = "subaccount.reputation_warning"
+        SUBACCOUNT_REPUTATION_RECOVERED = "subaccount.reputation_recovered"
+        SUBACCOUNT_PAUSED = "subaccount.paused"
+        SUBACCOUNT_REINSTATED = "subaccount.reinstated"
         HOOK_ENDPOINT_DISABLED = "hook_endpoint.disabled"
         BILLING_INVOICE_FINALIZED = "billing.invoice_finalized"
         BILLING_INVOICE_PAID = "billing.invoice_paid"
@@ -52,6 +56,7 @@ module Coss
         BROADCAST_PAUSED = "broadcast.paused"
         BROADCAST_CANCELED = "broadcast.canceled"
         BROADCAST_FAILED = "broadcast.failed"
+        INBOX_MESSAGE_RECEIVED = "inbox.message.received"
         SMS_SCHEDULED = "sms.scheduled"
         SMS_SENT = "sms.sent"
         SMS_DELIVERED = "sms.delivered"
@@ -62,6 +67,18 @@ module Coss
         SMS_RECEIVED = "sms.received"
         SMS_OPTED_OUT = "sms.opted_out"
         SMS_OPTED_IN = "sms.opted_in"
+        SIGN_REQUEST_SENT = "sign_request.sent"
+        SIGN_REQUEST_VIEWED = "sign_request.viewed"
+        SIGN_REQUEST_SIGNER_SIGNED = "sign_request.signer_signed"
+        SIGN_REQUEST_DECLINED = "sign_request.declined"
+        SIGN_REQUEST_COMPLETED = "sign_request.completed"
+        SIGN_REQUEST_CANCELED = "sign_request.canceled"
+        SIGN_REQUEST_EXPIRED = "sign_request.expired"
+        VERIFICATION_APPROVED = "verification.approved"
+        VERIFICATION_FAILED = "verification.failed"
+        VERIFICATION_BLOCKED = "verification.blocked"
+        FORM_SUBMISSION_RECEIVED = "form.submission.received"
+        FORM_SUBMISSION_FLAGGED = "form.submission.flagged"
       end
     end
   end

data/lib/coss/webhook_listeners/types/create_webhook_listener_request_event_types_item.rb

@@ -27,6 +27,10 @@ module Coss
         ACCOUNT_REINSTATED = "account.reinstated"
         ACCOUNT_MARKETING_PAUSED = "account.marketing_paused"
         ACCOUNT_MARKETING_REINSTATED = "account.marketing_reinstated"
+        SUBACCOUNT_REPUTATION_WARNING = "subaccount.reputation_warning"
+        SUBACCOUNT_REPUTATION_RECOVERED = "subaccount.reputation_recovered"
+        SUBACCOUNT_PAUSED = "subaccount.paused"
+        SUBACCOUNT_REINSTATED = "subaccount.reinstated"
         HOOK_ENDPOINT_DISABLED = "hook_endpoint.disabled"
         BILLING_INVOICE_FINALIZED = "billing.invoice_finalized"
         BILLING_INVOICE_PAID = "billing.invoice_paid"
@@ -52,6 +56,7 @@ module Coss
         BROADCAST_PAUSED = "broadcast.paused"
         BROADCAST_CANCELED = "broadcast.canceled"
         BROADCAST_FAILED = "broadcast.failed"
+        INBOX_MESSAGE_RECEIVED = "inbox.message.received"
         SMS_SCHEDULED = "sms.scheduled"
         SMS_SENT = "sms.sent"
         SMS_DELIVERED = "sms.delivered"
@@ -62,6 +67,18 @@ module Coss
         SMS_RECEIVED = "sms.received"
         SMS_OPTED_OUT = "sms.opted_out"
         SMS_OPTED_IN = "sms.opted_in"
+        SIGN_REQUEST_SENT = "sign_request.sent"
+        SIGN_REQUEST_VIEWED = "sign_request.viewed"
+        SIGN_REQUEST_SIGNER_SIGNED = "sign_request.signer_signed"
+        SIGN_REQUEST_DECLINED = "sign_request.declined"
+        SIGN_REQUEST_COMPLETED = "sign_request.completed"
+        SIGN_REQUEST_CANCELED = "sign_request.canceled"
+        SIGN_REQUEST_EXPIRED = "sign_request.expired"
+        VERIFICATION_APPROVED = "verification.approved"
+        VERIFICATION_FAILED = "verification.failed"
+        VERIFICATION_BLOCKED = "verification.blocked"
+        FORM_SUBMISSION_RECEIVED = "form.submission.received"
+        FORM_SUBMISSION_FLAGGED = "form.submission.flagged"
       end
     end
   end