coss 0.1.0 → 0.2.0

data/lib/coss/types/sign_request_list.rb

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

data/lib/coss/types/sign_request_list_object.rb

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

data/lib/coss/types/sign_request_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_REQUEST = "sign_request"
+    end
+  end
+end

data/lib/coss/types/sign_request_signed_document.rb

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

data/lib/coss/types/sign_request_signing_order.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestSigningOrder
+      extend Coss::Internal::Types::Enum
+
+      PARALLEL = "parallel"
+      SEQUENTIAL = "sequential"
+    end
+  end
+end

data/lib/coss/types/sign_request_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestStatus
+      extend Coss::Internal::Types::Enum
+
+      DRAFT = "draft"
+      SENT = "sent"
+      COMPLETED = "completed"
+      DECLINED = "declined"
+      CANCELED = "canceled"
+      EXPIRED = "expired"
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignRequestWebhookEvent < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :object, -> { Coss::Types::SignRequestWebhookEventObject }, optional: false, nullable: false
+
+      field :type, -> { Coss::Types::SignRequestWebhookEventType }, optional: false, nullable: false
+
+      field :api_version, -> { String }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :data, -> { Coss::Types::SignRequestWebhookEventData }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_data.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignRequestWebhookEventData < Internal::Types::Model
+      field :sign_request_id, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Coss::Types::SignRequestWebhookEventDataStatus }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: false
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :signer, -> { Coss::Types::SignRequestWebhookEventDataSigner }, optional: false, nullable: true
+
+      field :reason, -> { String }, optional: false, nullable: true
+
+      field :sandbox, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :occurred_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_data_signer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    # The signer who viewed, signed or declined; `null` otherwise.
+    class SignRequestWebhookEventDataSigner < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: false, nullable: false
+
+      field :client_ref, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Coss::Types::SignRequestWebhookEventDataSignerStatus }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_data_signer_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestWebhookEventDataSignerStatus
+      extend Coss::Internal::Types::Enum
+
+      PENDING = "pending"
+      NOTIFIED = "notified"
+      VIEWED = "viewed"
+      SIGNED = "signed"
+      DECLINED = "declined"
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_data_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestWebhookEventDataStatus
+      extend Coss::Internal::Types::Enum
+
+      DRAFT = "draft"
+      SENT = "sent"
+      COMPLETED = "completed"
+      DECLINED = "declined"
+      CANCELED = "canceled"
+      EXPIRED = "expired"
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestWebhookEventObject
+      extend Coss::Internal::Types::Enum
+
+      EVENT = "event"
+    end
+  end
+end

data/lib/coss/types/sign_request_webhook_event_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignRequestWebhookEventType
+      extend Coss::Internal::Types::Enum
+
+      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"
+    end
+  end
+end

data/lib/coss/types/sign_session.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignSession < Internal::Types::Model
+      field :object, -> { Coss::Types::SignSessionObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :request_id, -> { String }, optional: false, nullable: false
+
+      field :signer_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_session_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSessionObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_SESSION = "sign_session"
+    end
+  end
+end

data/lib/coss/types/sign_settings.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignSettings < Internal::Types::Model
+      field :object, -> { Coss::Types::SignSettingsObject }, optional: false, nullable: false
+
+      field :allowed_origins, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :display_name, -> { String }, optional: false, nullable: true
+
+      field :accent_color, -> { String }, optional: false, nullable: true
+
+      field :theme, -> { Coss::Types::SignSettingsTheme }, optional: false, nullable: false
+
+      field :disclosure, -> { String }, optional: false, nullable: true
+
+      field :email_from, -> { String }, optional: false, nullable: true
+
+      field :reminder_interval_days, -> { Integer }, optional: false, nullable: true
+    end
+  end
+end

data/lib/coss/types/sign_settings_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSettingsObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_SETTINGS = "sign_settings"
+    end
+  end
+end

data/lib/coss/types/sign_settings_theme.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSettingsTheme
+      extend Coss::Internal::Types::Enum
+
+      SYSTEM = "system"
+      LIGHT = "light"
+      DARK = "dark"
+    end
+  end
+end

data/lib/coss/types/sign_signer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignSigner < Internal::Types::Model
+      field :object, -> { Coss::Types::SignSignerObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: false, nullable: false
+
+      field :order, -> { Integer }, optional: false, nullable: false
+
+      field :delivery, -> { Coss::Types::SignSignerDelivery }, optional: false, nullable: false
+
+      field :authentication, -> { Coss::Types::SignSignerAuthentication }, optional: false, nullable: false
+
+      field :status, -> { Coss::Types::SignSignerStatus }, optional: false, nullable: false
+
+      field :client_ref, -> { String }, optional: false, nullable: true
+
+      field :viewed_at, -> { String }, optional: false, nullable: true
+
+      field :signed_at, -> { String }, optional: false, nullable: true
+
+      field :declined_at, -> { String }, optional: false, nullable: true
+
+      field :decline_reason, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/coss/types/sign_signer_authentication.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSignerAuthentication
+      extend Coss::Internal::Types::Enum
+
+      EMAIL_LINK = "email_link"
+      CUSTOMER_ASSERTED = "customer_asserted"
+    end
+  end
+end

data/lib/coss/types/sign_signer_delivery.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSignerDelivery
+      extend Coss::Internal::Types::Enum
+
+      EMBEDDED = "embedded"
+      EMAIL = "email"
+    end
+  end
+end

data/lib/coss/types/sign_signer_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSignerObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_SIGNER = "sign_signer"
+    end
+  end
+end

data/lib/coss/types/sign_signer_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignSignerStatus
+      extend Coss::Internal::Types::Enum
+
+      PENDING = "pending"
+      NOTIFIED = "notified"
+      VIEWED = "viewed"
+      SIGNED = "signed"
+      DECLINED = "declined"
+    end
+  end
+end

data/lib/coss/types/sign_template.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignTemplate < Internal::Types::Model
+      field :object, -> { Coss::Types::SignTemplateObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :title, -> { String }, optional: false, nullable: true
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :signing_order, -> { Coss::Types::SignTemplateSigningOrder }, optional: false, nullable: false
+
+      field :documents, -> { Internal::Types::Array[Coss::Types::SignTemplateDocumentsItem] }, optional: false, nullable: false
+
+      field :roles, -> { Internal::Types::Array[Coss::Types::SignTemplateRolesItem] }, optional: false, nullable: false
+
+      field :fields, -> { Internal::Types::Array[Coss::Types::SignTemplateFieldsItem] }, optional: false, nullable: false
+
+      field :ready, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :sandbox, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_template_documents_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignTemplateDocumentsItem < 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
+
+      field :pages, -> { Internal::Types::Array[Coss::Types::SignTemplateDocumentsItemPagesItem] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/sign_template_documents_item_pages_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignTemplateDocumentsItemPagesItem < 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_template_fields_item.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SignTemplateFieldsItem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :role, -> { String }, optional: false, nullable: false
+
+      field :document_id, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Coss::Types::SignTemplateFieldsItemType }, 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 :merge_key, -> { String }, optional: false, nullable: true
+    end
+  end
+end

data/lib/coss/types/sign_template_fields_item_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignTemplateFieldsItemType
+      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_template_list.rb

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

data/lib/coss/types/sign_template_list_object.rb

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

data/lib/coss/types/sign_template_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignTemplateObject
+      extend Coss::Internal::Types::Enum
+
+      SIGN_TEMPLATE = "sign_template"
+    end
+  end
+end

data/lib/coss/types/sign_template_roles_item.rb

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

data/lib/coss/types/sign_template_signing_order.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SignTemplateSigningOrder
+      extend Coss::Internal::Types::Enum
+
+      PARALLEL = "parallel"
+      SEQUENTIAL = "sequential"
+    end
+  end
+end

data/lib/coss/types/subaccount.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class Subaccount < Internal::Types::Model
+      field :object, -> { Coss::Types::SubaccountObject }, optional: false, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :uid, -> { String }, optional: false, nullable: true
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :metadata, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: false
+
+      field :status, -> { Coss::Types::SubaccountStatus }, optional: false, nullable: false
+
+      field :quotas, -> { Coss::Types::SubaccountQuotas }, optional: false, nullable: false
+
+      field :reputation, -> { Coss::Types::SubaccountReputation }, optional: false, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false
+
+      field :updated_at, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/coss/types/subaccount_list.rb

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

data/lib/coss/types/subaccount_list_object.rb

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

data/lib/coss/types/subaccount_object.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    module SubaccountObject
+      extend Coss::Internal::Types::Enum
+
+      SUBACCOUNT = "subaccount"
+    end
+  end
+end

data/lib/coss/types/subaccount_quotas.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Coss
+  module Types
+    class SubaccountQuotas < Internal::Types::Model
+      field :recipients_per_day, -> { Integer }, optional: false, nullable: true
+
+      field :recipients_per_second, -> { Integer }, optional: false, nullable: true
+
+      field :burst, -> { Integer }, optional: false, nullable: true
+    end
+  end
+end