signwell_sdk 0.0.1.pre.alpha.1

data/rbi/signwell_sdk/models/date_format.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    # Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD,
+    # Month DD, YYYY, MM/DD/YYYY hh:mm:ss a. Default: MM/DD/YYYY
+    module DateFormat
+      extend SignwellSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, SignwellSDK::DateFormat) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      MM_DD_YYYY = T.let(:"MM/DD/YYYY", SignwellSDK::DateFormat::TaggedSymbol)
+      DD_MM_YYYY = T.let(:"DD/MM/YYYY", SignwellSDK::DateFormat::TaggedSymbol)
+      YYYY_MM_DD = T.let(:"YYYY/MM/DD", SignwellSDK::DateFormat::TaggedSymbol)
+      MONTH_DD_YYYY =
+        T.let(:"Month DD, YYYY", SignwellSDK::DateFormat::TaggedSymbol)
+      MM_DD_YYYY_HH_MM_SS_A =
+        T.let(:"MM/DD/YYYY hh:mm:ss a", SignwellSDK::DateFormat::TaggedSymbol)
+
+      sig { override.returns(T::Array[SignwellSDK::DateFormat::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/field_type.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    # Type of signing field
+    module FieldType
+      extend SignwellSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, SignwellSDK::FieldType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      INITIALS = T.let(:initials, SignwellSDK::FieldType::TaggedSymbol)
+      SIGNATURE = T.let(:signature, SignwellSDK::FieldType::TaggedSymbol)
+      CHECKBOX = T.let(:checkbox, SignwellSDK::FieldType::TaggedSymbol)
+      DATE = T.let(:date, SignwellSDK::FieldType::TaggedSymbol)
+      SELECT = T.let(:select, SignwellSDK::FieldType::TaggedSymbol)
+      TEXT = T.let(:text, SignwellSDK::FieldType::TaggedSymbol)
+      DROPDOWN = T.let(:dropdown, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_COMPANY =
+        T.let(:autofill_company, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_EMAIL =
+        T.let(:autofill_email, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_FIRST_NAME =
+        T.let(:autofill_first_name, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_LAST_NAME =
+        T.let(:autofill_last_name, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_NAME =
+        T.let(:autofill_name, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_PHONE =
+        T.let(:autofill_phone, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_TITLE =
+        T.let(:autofill_title, SignwellSDK::FieldType::TaggedSymbol)
+      AUTOFILL_DATE_SIGNED =
+        T.let(:autofill_date_signed, SignwellSDK::FieldType::TaggedSymbol)
+
+      sig { override.returns(T::Array[SignwellSDK::FieldType::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/file_info.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class FileInfo < SignwellSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SignwellSDK::FileInfo, SignwellSDK::Internal::AnyHash)
+        end
+
+      # File name
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Number of pages in the file
+      sig { returns(Integer) }
+      attr_accessor :pages_number
+
+      # File information
+      sig do
+        params(name: String, pages_number: Integer).returns(T.attached_class)
+      end
+      def self.new(
+        # File name
+        name:,
+        # Number of pages in the file
+        pages_number:
+      )
+      end
+
+      sig { override.returns({ name: String, pages_number: Integer }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/label_info.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class LabelInfo < SignwellSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SignwellSDK::LabelInfo, SignwellSDK::Internal::AnyHash)
+        end
+
+      # Label ID
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Label name
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Label information
+      sig { params(id: String, name: String).returns(T.attached_class) }
+      def self.new(
+        # Label ID
+        id: nil,
+        # Label name
+        name: nil
+      )
+      end
+
+      sig { override.returns({ id: String, name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/text_validation.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    # Validation rule for text fields
+    module TextValidation
+      extend SignwellSDK::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, SignwellSDK::TextValidation) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      NO_TEXT_VALIDATION =
+        T.let(:no_text_validation, SignwellSDK::TextValidation::TaggedSymbol)
+      NUMBERS = T.let(:numbers, SignwellSDK::TextValidation::TaggedSymbol)
+      LETTERS = T.let(:letters, SignwellSDK::TextValidation::TaggedSymbol)
+      EMAIL_ADDRESS =
+        T.let(:email_address, SignwellSDK::TextValidation::TaggedSymbol)
+      US_PHONE_NUMBER =
+        T.let(:us_phone_number, SignwellSDK::TextValidation::TaggedSymbol)
+      US_ZIP_CODE =
+        T.let(:us_zip_code, SignwellSDK::TextValidation::TaggedSymbol)
+      US_SSN = T.let(:us_ssn, SignwellSDK::TextValidation::TaggedSymbol)
+      US_AGE = T.let(:us_age, SignwellSDK::TextValidation::TaggedSymbol)
+      ALPHANUMERIC =
+        T.let(:alphanumeric, SignwellSDK::TextValidation::TaggedSymbol)
+      US_BANK_ROUTING_NUMBER =
+        T.let(
+          :us_bank_routing_number,
+          SignwellSDK::TextValidation::TaggedSymbol
+        )
+      US_BANK_ACCOUNT_NUMBER =
+        T.let(
+          :us_bank_account_number,
+          SignwellSDK::TextValidation::TaggedSymbol
+        )
+
+      sig do
+        override.returns(T::Array[SignwellSDK::TextValidation::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/api_application_delete_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class APIApplicationDeleteParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::APIApplicationDeleteParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: SignwellSDK::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: SignwellSDK::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/api_application_retrieve_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class APIApplicationRetrieveParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::APIApplicationRetrieveParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: SignwellSDK::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: SignwellSDK::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/attachment_request.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::AttachmentRequest,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Name of the requested attachment.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Unique identifier of the recipient that will view the attachment request.
+        sig { returns(String) }
+        attr_accessor :recipient_id
+
+        # Whether the recipient will need to upload the attachment to successfully
+        # complete/sign the document. Defaults to `true`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :required
+
+        sig { params(required: T::Boolean).void }
+        attr_writer :required
+
+        sig do
+          params(
+            name: String,
+            recipient_id: String,
+            required: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Name of the requested attachment.
+          name:,
+          # Unique identifier of the recipient that will view the attachment request.
+          recipient_id:,
+          # Whether the recipient will need to upload the attachment to successfully
+          # complete/sign the document. Defaults to `true`.
+          required: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { name: String, recipient_id: String, required: T::Boolean }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/bulk_send_create_params.rbi

@@ -0,0 +1,160 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendCreateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendCreateParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # A RFC 4648 base64 string of the template CSV file to be validated.
+        sig { returns(String) }
+        attr_accessor :bulk_send_csv
+
+        # Unique identifiers for a list of templates.
+        sig { returns(T::Array[String]) }
+        attr_accessor :template_ids
+
+        # Unique identifier for API Application settings to use. API Applications are
+        # optional and mainly used when isolating OAuth apps or for more control over
+        # embedded API settings
+        sig { returns(T.nilable(String)) }
+        attr_reader :api_application_id
+
+        sig { params(api_application_id: String).void }
+        attr_writer :api_application_id
+
+        # When set to `true` recipients will sign one at a time in the order of the
+        # `recipients` collection of this request.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :apply_signing_order
+
+        sig { params(apply_signing_order: T::Boolean).void }
+        attr_writer :apply_signing_order
+
+        # Sets the custom requester email for the document. When set, this is the email
+        # used for all email communications, signing notifications, and in the audit file.
+        sig { returns(T.nilable(String)) }
+        attr_reader :custom_requester_email
+
+        sig { params(custom_requester_email: String).void }
+        attr_writer :custom_requester_email
+
+        # Sets the custom requester name for the document. When set, this is the name used
+        # for all email communications, signing notifications, and in the audit file.
+        sig { returns(T.nilable(String)) }
+        attr_reader :custom_requester_name
+
+        sig { params(custom_requester_name: String).void }
+        attr_writer :custom_requester_name
+
+        # Email message for the signature request that recipients will see. Defaults to
+        # the default system message or a template message.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # The name of the Bulk Send. Will be used as the document name for each of the
+        # documents.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Whether to skip errors in the rows. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :skip_row_errors
+
+        sig { params(skip_row_errors: T::Boolean).void }
+        attr_writer :skip_row_errors
+
+        # Email subject for the signature request that recipients will see. Defaults to
+        # the default system subject or a template subject.
+        sig { returns(T.nilable(String)) }
+        attr_reader :subject
+
+        sig { params(subject: String).void }
+        attr_writer :subject
+
+        sig do
+          params(
+            bulk_send_csv: String,
+            template_ids: T::Array[String],
+            api_application_id: String,
+            apply_signing_order: T::Boolean,
+            custom_requester_email: String,
+            custom_requester_name: String,
+            message: String,
+            name: String,
+            skip_row_errors: T::Boolean,
+            subject: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A RFC 4648 base64 string of the template CSV file to be validated.
+          bulk_send_csv:,
+          # Unique identifiers for a list of templates.
+          template_ids:,
+          # Unique identifier for API Application settings to use. API Applications are
+          # optional and mainly used when isolating OAuth apps or for more control over
+          # embedded API settings
+          api_application_id: nil,
+          # When set to `true` recipients will sign one at a time in the order of the
+          # `recipients` collection of this request.
+          apply_signing_order: nil,
+          # Sets the custom requester email for the document. When set, this is the email
+          # used for all email communications, signing notifications, and in the audit file.
+          custom_requester_email: nil,
+          # Sets the custom requester name for the document. When set, this is the name used
+          # for all email communications, signing notifications, and in the audit file.
+          custom_requester_name: nil,
+          # Email message for the signature request that recipients will see. Defaults to
+          # the default system message or a template message.
+          message: nil,
+          # The name of the Bulk Send. Will be used as the document name for each of the
+          # documents.
+          name: nil,
+          # Whether to skip errors in the rows. Defaults to `false`.
+          skip_row_errors: nil,
+          # Email subject for the signature request that recipients will see. Defaults to
+          # the default system subject or a template subject.
+          subject: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              bulk_send_csv: String,
+              template_ids: T::Array[String],
+              api_application_id: String,
+              apply_signing_order: T::Boolean,
+              custom_requester_email: String,
+              custom_requester_name: String,
+              message: String,
+              name: String,
+              skip_row_errors: T::Boolean,
+              subject: String,
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/bulk_send_list_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendListParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendListParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for API Application settings to use. API Applications are
+        # optional and mainly used when isolating OAuth apps or for more control over
+        # embedded API settings
+        sig { returns(T.nilable(String)) }
+        attr_reader :api_application_id
+
+        sig { params(api_application_id: String).void }
+        attr_writer :api_application_id
+
+        # The number of documents to fetch. Defaults to 10, max is 50.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # The page number for pagination. Defaults to the first page.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page
+
+        sig { params(page: Integer).void }
+        attr_writer :page
+
+        # The email address of the user that sent the Bulk Send. Must have the `admin` or
+        # `manager` role to view Bulk Sends of other users. Defaults to the user that the
+        # API key belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_reader :user_email
+
+        sig { params(user_email: String).void }
+        attr_writer :user_email
+
+        sig do
+          params(
+            api_application_id: String,
+            limit: Integer,
+            page: Integer,
+            user_email: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for API Application settings to use. API Applications are
+          # optional and mainly used when isolating OAuth apps or for more control over
+          # embedded API settings
+          api_application_id: nil,
+          # The number of documents to fetch. Defaults to 10, max is 50.
+          limit: nil,
+          # The page number for pagination. Defaults to the first page.
+          page: nil,
+          # The email address of the user that sent the Bulk Send. Must have the `admin` or
+          # `manager` role to view Bulk Sends of other users. Defaults to the user that the
+          # API key belongs to.
+          user_email: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              api_application_id: String,
+              limit: Integer,
+              page: Integer,
+              user_email: String,
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendRetrieveCsvTemplateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendRetrieveCsvTemplateParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Specify one or more templates to generate a single blank CSV file that will
+        # contain available columns for your recipient data. The template_ids[] parameter
+        # is an array of template IDs
+        # (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`).
+        # Each ID should be a separate parameter in the query string.
+        sig { returns(T::Array[String]) }
+        attr_accessor :template_ids
+
+        # A RFC 4648 base64 string of the template CSV file to be validated.
+        sig { returns(T.nilable(String)) }
+        attr_reader :base64
+
+        sig { params(base64: String).void }
+        attr_writer :base64
+
+        sig do
+          params(
+            template_ids: T::Array[String],
+            base64: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Specify one or more templates to generate a single blank CSV file that will
+          # contain available columns for your recipient data. The template_ids[] parameter
+          # is an array of template IDs
+          # (e.g.,`/?template_ids[]=5a67dbd7-928a-4ea0-a7e2-e476a0eb045f&template_ids[]=d7315111-c671-4b15-8354-c9a19bbaefa0`).
+          # Each ID should be a separate parameter in the query string.
+          template_ids:,
+          # A RFC 4648 base64 string of the template CSV file to be validated.
+          base64: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              template_ids: T::Array[String],
+              base64: String,
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end