coss 0.1.0 → 0.2.0

data/lib/coss/types/inbox_thread_summary_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module InboxThreadSummaryObject
+      extend Coss::Internal::Types::Enum
+
+      INBOX_THREAD = "inbox_thread"
+    end
+  end
+end

data/lib/coss/types/invoice_line_meter.rb

@@ -7,10 +7,17 @@ module Coss
 
       EMAIL_RECIPIENTS = "email.recipients"
       EMAIL_DEDICATED_IP = "email.dedicated_ip"
+      EMAIL_RECEIVED = "email.received"
+      EMAIL_INBOXES = "email.inboxes"
       SMS_SEGMENTS = "sms.segments"
       SMS_RECEIVED_SEGMENTS = "sms.received_segments"
       SMS_NUMBERS = "sms.numbers"
       SMS_REGISTRATIONS = "sms.registrations"
+      SIGN_COMPLETED_REQUESTS = "sign.completed_requests"
+      RISK_PHONE_CHECKS = "risk.phone_checks"
+      VERIFY_VERIFICATIONS = "verify.verifications"
+      VERIFY_SMS = "verify.sms"
+      FORMS_SUBMISSIONS = "forms.submissions"
       VIDEO_PARTICIPANT_MINUTES = "video.participant_minutes"
       SCHEDULING_BOOKINGS = "scheduling.bookings"
     end

data/lib/coss/types/log_drain_source.rb

@@ -11,6 +11,9 @@ module Coss
       RISK = "risk"
       SMTP = "smtp"
       SMS = "sms"
+      SIGN = "sign"
+      VERIFY = "verify"
+      FORMS = "forms"
       AUDIT = "audit"
     end
   end

data/lib/coss/types/log_source.rb

@@ -11,6 +11,9 @@ module Coss
       RISK = "risk"
       SMTP = "smtp"
       SMS = "sms"
+      SIGN = "sign"
+      VERIFY = "verify"
+      FORMS = "forms"
     end
   end
 end

data/lib/coss/types/risk_phone_carrier.rb

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

data/lib/coss/types/risk_phone_check.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class RiskPhoneCheck < Internal::Types::Model
+      field :object, -> { Coss::Types::RiskPhoneCheckObject }, optional: false, nullable: false
+
+      field :phone, -> { String }, optional: false, nullable: false
+
+      field :valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :country, -> { String }, optional: false, nullable: true
+
+      field :line_type, -> { Coss::Types::RiskPhoneCheckLineType }, optional: false, nullable: true
+
+      field :carrier, -> { Coss::Types::RiskPhoneCarrier }, optional: false, nullable: true
+
+      field :sim_swap, -> { Coss::Types::RiskPhoneSimSwap }, optional: false, nullable: true
+
+      field :degraded, -> { Internal::Types::Array[Coss::Types::RiskPhoneCheckDegradedItem] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/risk_phone_check_degraded_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module RiskPhoneCheckDegradedItem
+      extend Coss::Internal::Types::Enum
+
+      PHONE_DATA = "phone_data"
+      SIM_SWAP = "sim_swap"
+    end
+  end
+end

data/lib/coss/types/risk_phone_check_line_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module RiskPhoneCheckLineType
+      extend Coss::Internal::Types::Enum
+
+      MOBILE = "mobile"
+      LANDLINE = "landline"
+      FIXED_VOIP = "fixed_voip"
+      NON_FIXED_VOIP = "non_fixed_voip"
+      TOLL_FREE = "toll_free"
+      PREMIUM = "premium"
+      SHARED_COST = "shared_cost"
+      PERSONAL = "personal"
+      UAN = "uan"
+      VOICEMAIL = "voicemail"
+      PAGER = "pager"
+      UNKNOWN = "unknown"
+    end
+  end
+end

data/lib/coss/types/risk_phone_check_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module RiskPhoneCheckObject
+      extend Coss::Internal::Types::Enum
+
+      RISK_PHONE_CHECK = "risk_phone_check"
+    end
+  end
+end

data/lib/coss/types/risk_phone_sim_swap.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class RiskPhoneSimSwap < Internal::Types::Model
+      field :recent, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :swapped_at, -> { String }, optional: false, nullable: true
+
+      field :period, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/coss/types/send_email_request.rb

@@ -40,6 +40,8 @@ module Coss
       field :tracking, -> { Coss::Types::TrackingOptions }, optional: true, nullable: false
 
       field :stream, -> { Coss::Types::SendEmailRequestStream }, optional: true, nullable: false
+
+      field :subaccount, -> { String }, optional: true, nullable: false
     end
   end
 end

data/lib/coss/types/sign_builder_session.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignBuilderSession < Internal::Types::Model
+      field :object, -> { Coss::Types::SignBuilderSessionObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :template_id, -> { String }, optional: false, nullable: false
+
+      field :url, -> { String }, optional: false, nullable: false
+
+      field :token, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_builder_session_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignBuilderSessionObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_BUILDER_SESSION = "sign_builder_session"
+    end
+  end
+end

data/lib/coss/types/sign_document.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignDocument < Internal::Types::Model
+      field :object, -> { Coss::Types::SignDocumentObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :filename, -> { String }, optional: false, nullable: false
+
+      field :size, -> { Integer }, optional: false, nullable: false
+
+      field :sha256, -> { String }, optional: false, nullable: false
+
+      field :page_count, -> { Integer }, optional: false, nullable: false
+
+      field :pages, -> { Internal::Types::Array[Coss::Types::SignDocumentPagesItem] }, optional: false, nullable: false
+
+      field :anchors, -> { Internal::Types::Array[Coss::Types::SignDocumentAnchorsItem] }, optional: false, nullable: false
+
+      field :sandbox, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_document_anchors_item.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    # A text anchor found in the document, in points from the page's top left.
+    class SignDocumentAnchorsItem < Internal::Types::Model
+      field :text, -> { String }, optional: false, nullable: false
+
+      field :page, -> { Integer }, optional: false, nullable: false
+
+      field :x, -> { Integer }, optional: false, nullable: false
+
+      field :y, -> { Integer }, optional: false, nullable: false
+
+      field :width, -> { Integer }, optional: false, nullable: false
+
+      field :height, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_document_list.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignDocumentList < Internal::Types::Model
+      field :object, -> { Coss::Types::SignDocumentListObject }, optional: false, nullable: false
+
+      field :data, -> { Internal::Types::Array[Coss::Types::SignDocument] }, optional: false, nullable: false
+
+      field :has_more, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_document_list_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignDocumentListObject
+      extend Coss::Internal::Types::Enum
+
+      LIST = "list"
+    end
+  end
+end

data/lib/coss/types/sign_document_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignDocumentObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_DOCUMENT = "sign_document"
+    end
+  end
+end

data/lib/coss/types/sign_document_pages_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignDocumentPagesItem < Internal::Types::Model
+      field :width, -> { Integer }, optional: false, nullable: false
+
+      field :height, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_event.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignEvent < Internal::Types::Model
+      field :object, -> { Coss::Types::SignEventObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :sequence, -> { Integer }, optional: false, nullable: false
+
+      field :type, -> { Coss::Types::SignEventType }, optional: false, nullable: false
+
+      field :signer_id, -> { String }, optional: false, nullable: true
+
+      field :actor, -> { Coss::Types::SignEventActor }, optional: false, nullable: false
+
+      field :ip_address, -> { String }, optional: false, nullable: true
+
+      field :user_agent, -> { String }, optional: false, nullable: true
+
+      field :details, -> { Coss::Types::SignEventDetails }, optional: false, nullable: false
+
+      field :occurred_at, -> { String }, optional: false, nullable: false
+
+      field :previous_hash, -> { String }, optional: false, nullable: true
+
+      field :hash_, -> { String }, optional: false, nullable: false, api_name: "hash"
+    end
+  end
+end

data/lib/coss/types/sign_event_actor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignEventActor
+      extend Coss::Internal::Types::Enum
+
+      API_KEY = "api_key"
+      SIGNER = "signer"
+      DASHBOARD = "dashboard"
+      SYSTEM = "system"
+    end
+  end
+end

data/lib/coss/types/sign_event_details.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignEventDetails < Internal::Types::Model
+      field :reason, -> { String }, optional: true, nullable: false
+
+      field :document_sha256, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+
+      field :disclosure_sha256, -> { String }, optional: true, nullable: false
+
+      field :field_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :signature_sha256, -> { String }, optional: true, nullable: false
+
+      field :initials_sha256, -> { String }, optional: true, nullable: false
+
+      field :session_id, -> { String }, optional: true, nullable: false
+
+      field :signed_document_sha256, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_event_list.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignEventList < Internal::Types::Model
+      field :object, -> { Coss::Types::SignEventListObject }, optional: false, nullable: false
+
+      field :data, -> { Internal::Types::Array[Coss::Types::SignEvent] }, optional: false, nullable: false
+
+      field :has_more, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_event_list_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignEventListObject
+      extend Coss::Internal::Types::Enum
+
+      LIST = "list"
+    end
+  end
+end

data/lib/coss/types/sign_event_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignEventObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_EVENT = "sign_event"
+    end
+  end
+end

data/lib/coss/types/sign_event_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignEventType
+      extend Coss::Internal::Types::Enum
+
+      CREATED = "created"
+      SENT = "sent"
+      NOTIFIED = "notified"
+      VIEWED = "viewed"
+      CONSENTED = "consented"
+      SIGNED = "signed"
+      DECLINED = "declined"
+      REMINDED = "reminded"
+      CANCELED = "canceled"
+      EXPIRED = "expired"
+      COMPLETED = "completed"
+      SEALED = "sealed"
+    end
+  end
+end

data/lib/coss/types/sign_field.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignField < Internal::Types::Model
+      field :object, -> { Coss::Types::SignFieldObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :signer_id, -> { String }, optional: false, nullable: false
+
+      field :document_id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Coss::Types::SignFieldType }, optional: false, nullable: false
+
+      field :page, -> { Integer }, optional: false, nullable: false
+
+      field :x, -> { Integer }, optional: false, nullable: false
+
+      field :y, -> { Integer }, optional: false, nullable: false
+
+      field :width, -> { Integer }, optional: false, nullable: false
+
+      field :height, -> { Integer }, optional: false, nullable: false
+
+      field :required, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: false, nullable: true
+
+      field :anchor, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/coss/types/sign_field_input.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignFieldInput < Internal::Types::Model
+      extend Coss::Internal::Types::Union
+
+      member -> { Coss::Types::SignFieldInputDocument }
+
+      member -> { Coss::Types::SignFieldInputAnchor }
+    end
+  end
+end

data/lib/coss/types/sign_field_input_anchor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignFieldInputAnchor < Internal::Types::Model
+      field :type, -> { Coss::Types::SignFieldInputAnchorType }, optional: false, nullable: false
+
+      field :required, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :label, -> { String }, optional: true, nullable: false
+
+      field :anchor, -> { String }, optional: false, nullable: false
+
+      field :width, -> { Integer }, optional: true, nullable: false
+
+      field :height, -> { Integer }, optional: true, nullable: false
+
+      field :offset_x, -> { Integer }, optional: true, nullable: false
+
+      field :offset_y, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_field_input_anchor_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignFieldInputAnchorType
+      extend Coss::Internal::Types::Enum
+
+      SIGNATURE = "signature"
+      INITIALS = "initials"
+      DATE_SIGNED = "date_signed"
+      NAME = "name"
+      EMAIL = "email"
+      TEXT = "text"
+      CHECKBOX = "checkbox"
+    end
+  end
+end

data/lib/coss/types/sign_field_input_document.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignFieldInputDocument < Internal::Types::Model
+      field :type, -> { Coss::Types::SignFieldInputDocumentType }, optional: false, nullable: false
+
+      field :required, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :label, -> { String }, optional: true, nullable: false
+
+      field :document, -> { Integer }, optional: true, nullable: false
+
+      field :page, -> { Integer }, optional: false, nullable: false
+
+      field :x, -> { Integer }, optional: false, nullable: false
+
+      field :y, -> { Integer }, optional: false, nullable: false
+
+      field :width, -> { Integer }, optional: false, nullable: false
+
+      field :height, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_field_input_document_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignFieldInputDocumentType
+      extend Coss::Internal::Types::Enum
+
+      SIGNATURE = "signature"
+      INITIALS = "initials"
+      DATE_SIGNED = "date_signed"
+      NAME = "name"
+      EMAIL = "email"
+      TEXT = "text"
+      CHECKBOX = "checkbox"
+    end
+  end
+end

data/lib/coss/types/sign_field_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignFieldObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_FIELD = "sign_field"
+    end
+  end
+end

data/lib/coss/types/sign_field_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignFieldType
+      extend Coss::Internal::Types::Enum
+
+      SIGNATURE = "signature"
+      INITIALS = "initials"
+      DATE_SIGNED = "date_signed"
+      NAME = "name"
+      EMAIL = "email"
+      TEXT = "text"
+      CHECKBOX = "checkbox"
+    end
+  end
+end

data/lib/coss/types/sign_request.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignRequest < Internal::Types::Model
+      field :object, -> { Coss::Types::SignRequestObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Coss::Types::SignRequestStatus }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :signing_order, -> { Coss::Types::SignRequestSigningOrder }, optional: false, nullable: false
+
+      field :documents, -> { Internal::Types::Array[Coss::Types::SignRequestDocumentsItem] }, optional: false, nullable: false
+
+      field :signers, -> { Internal::Types::Array[Coss::Types::SignSigner] }, optional: false, nullable: false
+
+      field :fields, -> { Internal::Types::Array[Coss::Types::SignField] }, optional: false, nullable: false
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :sandbox, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :reminder_interval_days, -> { Integer }, optional: false, nullable: true
+
+      field :expires_at, -> { String }, optional: false, nullable: true
+
+      field :expired_at, -> { String }, optional: false, nullable: true
+
+      field :sent_at, -> { String }, optional: false, nullable: true
+
+      field :completed_at, -> { String }, optional: false, nullable: true
+
+      field :canceled_at, -> { String }, optional: false, nullable: true
+
+      field :declined_at, -> { String }, optional: false, nullable: true
+
+      field :signed_document, -> { Coss::Types::SignRequestSignedDocument }, optional: false, nullable: true
+
+      field :created_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_request_documents_item.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignRequestDocumentsItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :filename, -> { String }, optional: false, nullable: false
+
+      field :sha256, -> { String }, optional: false, nullable: false
+
+      field :page_count, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end