signwell_sdk 0.0.1.pre.alpha.1

data/lib/signwell_sdk/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Internal
+    extend SignwellSDK::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{SignwellSDK::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, SignwellSDK::FilePart) }
+    end
+  end
+end

data/lib/signwell_sdk/models/attachment_request_info.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class AttachmentRequestInfo < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute name
+      #   Name of the attachment request
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute required
+      #   Whether the attachment is required
+      #
+      #   @return [Boolean]
+      required :required, SignwellSDK::Internal::Type::Boolean
+
+      # @!attribute url
+      #   URL of the uploaded attachment (when available)
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!method initialize(name:, required:, url: nil)
+      #   Attachment request information
+      #
+      #   @param name [String] Name of the attachment request
+      #
+      #   @param required [Boolean] Whether the attachment is required
+      #
+      #   @param url [String] URL of the uploaded attachment (when available)
+    end
+  end
+end

data/lib/signwell_sdk/models/checkbox_group_info.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class CheckboxGroupInfo < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Checkbox group ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute checkbox_ids
+      #   IDs of checkboxes in this group
+      #
+      #   @return [Array<String>]
+      required :checkbox_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute required
+      #   Whether at least one checkbox must be checked
+      #
+      #   @return [Boolean]
+      required :required, SignwellSDK::Internal::Type::Boolean
+
+      # @!attribute group_name
+      #   Name of the checkbox group
+      #
+      #   @return [String, nil]
+      optional :group_name, String, nil?: true
+
+      # @!attribute min_value
+      #   Minimum number of checkboxes to check
+      #
+      #   @return [Integer, nil]
+      optional :min_value, Integer
+
+      # @!attribute recipient_id
+      #   Recipient ID associated with the group
+      #
+      #   @return [String, nil]
+      optional :recipient_id, String, nil?: true
+
+      # @!attribute validation
+      #   Validation rule for checkbox groups
+      #
+      #   @return [Symbol, SignwellSDK::Models::CheckboxValidation, nil]
+      optional :validation, enum: -> { SignwellSDK::CheckboxValidation }, nil?: true
+
+      # @!method initialize(id:, checkbox_ids:, required:, group_name: nil, min_value: nil, recipient_id: nil, validation: nil)
+      #   Checkbox group configuration
+      #
+      #   @param id [String] Checkbox group ID
+      #
+      #   @param checkbox_ids [Array<String>] IDs of checkboxes in this group
+      #
+      #   @param required [Boolean] Whether at least one checkbox must be checked
+      #
+      #   @param group_name [String, nil] Name of the checkbox group
+      #
+      #   @param min_value [Integer] Minimum number of checkboxes to check
+      #
+      #   @param recipient_id [String, nil] Recipient ID associated with the group
+      #
+      #   @param validation [Symbol, SignwellSDK::Models::CheckboxValidation, nil] Validation rule for checkbox groups
+    end
+  end
+end

data/lib/signwell_sdk/models/checkbox_validation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    # Validation rule for checkbox groups
+    module CheckboxValidation
+      extend SignwellSDK::Internal::Type::Enum
+
+      MINIMUM = :minimum
+      MAXIMUM = :maximum
+      RANGE = :range
+      EXACT = :exact
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/signwell_sdk/models/copied_contact_info.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class CopiedContactInfo < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute email
+      #   Contact email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute id
+      #   Contact ID
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute name
+      #   Contact name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(email:, id: nil, name: nil)
+      #   Copied contact information
+      #
+      #   @param email [String] Contact email
+      #
+      #   @param id [String] Contact ID
+      #
+      #   @param name [String] Contact name
+    end
+  end
+end

data/lib/signwell_sdk/models/date_format.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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
+
+      MM_DD_YYYY = :"MM/DD/YYYY"
+      DD_MM_YYYY = :"DD/MM/YYYY"
+      YYYY_MM_DD = :"YYYY/MM/DD"
+      MONTH_DD_YYYY = :"Month DD, YYYY"
+      MM_DD_YYYY_HH_MM_SS_A = :"MM/DD/YYYY hh:mm:ss a"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/signwell_sdk/models/field_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    # Type of signing field
+    module FieldType
+      extend SignwellSDK::Internal::Type::Enum
+
+      INITIALS = :initials
+      SIGNATURE = :signature
+      CHECKBOX = :checkbox
+      DATE = :date
+      SELECT = :select
+      TEXT = :text
+      DROPDOWN = :dropdown
+      AUTOFILL_COMPANY = :autofill_company
+      AUTOFILL_EMAIL = :autofill_email
+      AUTOFILL_FIRST_NAME = :autofill_first_name
+      AUTOFILL_LAST_NAME = :autofill_last_name
+      AUTOFILL_NAME = :autofill_name
+      AUTOFILL_PHONE = :autofill_phone
+      AUTOFILL_TITLE = :autofill_title
+      AUTOFILL_DATE_SIGNED = :autofill_date_signed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/signwell_sdk/models/file_info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class FileInfo < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute name
+      #   File name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute pages_number
+      #   Number of pages in the file
+      #
+      #   @return [Integer]
+      required :pages_number, Integer
+
+      # @!method initialize(name:, pages_number:)
+      #   File information
+      #
+      #   @param name [String] File name
+      #
+      #   @param pages_number [Integer] Number of pages in the file
+    end
+  end
+end

data/lib/signwell_sdk/models/label_info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class LabelInfo < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Label ID
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute name
+      #   Label name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(id: nil, name: nil)
+      #   Label information
+      #
+      #   @param id [String] Label ID
+      #
+      #   @param name [String] Label name
+    end
+  end
+end

data/lib/signwell_sdk/models/text_validation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    # Validation rule for text fields
+    module TextValidation
+      extend SignwellSDK::Internal::Type::Enum
+
+      NO_TEXT_VALIDATION = :no_text_validation
+      NUMBERS = :numbers
+      LETTERS = :letters
+      EMAIL_ADDRESS = :email_address
+      US_PHONE_NUMBER = :us_phone_number
+      US_ZIP_CODE = :us_zip_code
+      US_SSN = :us_ssn
+      US_AGE = :us_age
+      ALPHANUMERIC = :alphanumeric
+      US_BANK_ROUTING_NUMBER = :us_bank_routing_number
+      US_BANK_ACCOUNT_NUMBER = :us_bank_account_number
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/api_application_delete_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::APIApplications#delete
+      class APIApplicationDeleteParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/api_application_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::APIApplications#retrieve
+      class APIApplicationRetrieveParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/attachment_request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the requested attachment.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute recipient_id
+        #   Unique identifier of the recipient that will view the attachment request.
+        #
+        #   @return [String]
+        required :recipient_id, String
+
+        # @!attribute required
+        #   Whether the recipient will need to upload the attachment to successfully
+        #   complete/sign the document. Defaults to `true`.
+        #
+        #   @return [Boolean, nil]
+        optional :required, SignwellSDK::Internal::Type::Boolean
+
+        # @!method initialize(name:, recipient_id:, required: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::AttachmentRequest} for more details.
+        #
+        #   @param name [String] Name of the requested attachment.
+        #
+        #   @param recipient_id [String] Unique identifier of the recipient that will view the attachment request.
+        #
+        #   @param required [Boolean] Whether the recipient will need to upload the attachment to successfully complet
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_create_params.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#create
+      class BulkSendCreateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute bulk_send_csv
+        #   A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @return [String]
+        required :bulk_send_csv, String
+
+        # @!attribute template_ids
+        #   Unique identifiers for a list of templates.
+        #
+        #   @return [Array<String>]
+        required :template_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute api_application_id
+        #   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
+        #
+        #   @return [String, nil]
+        optional :api_application_id, String
+
+        # @!attribute apply_signing_order
+        #   When set to `true` recipients will sign one at a time in the order of the
+        #   `recipients` collection of this request.
+        #
+        #   @return [Boolean, nil]
+        optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute custom_requester_email
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :custom_requester_email, String
+
+        # @!attribute custom_requester_name
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :custom_requester_name, String
+
+        # @!attribute message
+        #   Email message for the signature request that recipients will see. Defaults to
+        #   the default system message or a template message.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute name
+        #   The name of the Bulk Send. Will be used as the document name for each of the
+        #   documents.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute skip_row_errors
+        #   Whether to skip errors in the rows. Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :skip_row_errors, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute subject
+        #   Email subject for the signature request that recipients will see. Defaults to
+        #   the default system subject or a template subject.
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!method initialize(bulk_send_csv:, template_ids:, api_application_id: nil, apply_signing_order: nil, custom_requester_email: nil, custom_requester_name: nil, message: nil, name: nil, skip_row_errors: nil, subject: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::BulkSendCreateParams} for more details.
+        #
+        #   @param bulk_send_csv [String] A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @param template_ids [Array<String>] Unique identifiers for a list of templates.
+        #
+        #   @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
+        #
+        #   @param apply_signing_order [Boolean] When set to `true` recipients will sign one at a time in the order of the `recip
+        #
+        #   @param custom_requester_email [String] Sets the custom requester email for the document. When set, this is the email us
+        #
+        #   @param custom_requester_name [String] Sets the custom requester name for the document. When set, this is the name used
+        #
+        #   @param message [String] Email message for the signature request that recipients will see. Defaults to th
+        #
+        #   @param name [String] The name of the Bulk Send. Will be used as the document name for each of the doc
+        #
+        #   @param skip_row_errors [Boolean] Whether to skip errors in the rows. Defaults to `false`.
+        #
+        #   @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_list_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#list
+      class BulkSendListParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute api_application_id
+        #   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
+        #
+        #   @return [String, nil]
+        optional :api_application_id, String
+
+        # @!attribute limit
+        #   The number of documents to fetch. Defaults to 10, max is 50.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute page
+        #   The page number for pagination. Defaults to the first page.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute user_email
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :user_email, String
+
+        # @!method initialize(api_application_id: nil, limit: nil, page: nil, user_email: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::BulkSendListParams} for more details.
+        #
+        #   @param api_application_id [String] Unique identifier for API Application settings to use. API Applications are opti
+        #
+        #   @param limit [Integer] The number of documents to fetch. Defaults to 10, max is 50.
+        #
+        #   @param page [Integer] The page number for pagination. Defaults to the first page.
+        #
+        #   @param user_email [String] The email address of the user that sent the Bulk Send. Must have the `admin` or
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_retrieve_csv_template_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#retrieve_csv_template
+      class BulkSendRetrieveCsvTemplateParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute template_ids
+        #   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.
+        #
+        #   @return [Array<String>]
+        required :template_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute base64
+        #   A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @return [String, nil]
+        optional :base64, String
+
+        # @!method initialize(template_ids:, base64: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::BulkSendRetrieveCsvTemplateParams} for more details.
+        #
+        #   @param template_ids [Array<String>] Specify one or more templates to generate a single blank CSV file that will cont
+        #
+        #   @param base64 [String] A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_retrieve_documents_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#retrieve_documents
+      class BulkSendRetrieveDocumentsParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute limit
+        #   The number of documents to fetch. Defaults to 10, max is 50.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute page
+        #   The page number for pagination. Defaults to the first page.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!method initialize(limit: nil, page: nil, request_options: {})
+        #   @param limit [Integer] The number of documents to fetch. Defaults to 10, max is 50.
+        #
+        #   @param page [Integer] The page number for pagination. Defaults to the first page.
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_retrieve_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#retrieve
+      class BulkSendRetrieveParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/v1/bulk_send_validate_csv_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::BulkSends#validate_csv
+      class BulkSendValidateCsvParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute bulk_send_csv
+        #   A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @return [String]
+        required :bulk_send_csv, String
+
+        # @!attribute template_ids
+        #   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.
+        #
+        #   @return [Array<String>]
+        required :template_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(bulk_send_csv:, template_ids:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::BulkSendValidateCsvParams} for more details.
+        #
+        #   @param bulk_send_csv [String] A RFC 4648 base64 string of the template CSV file to be validated.
+        #
+        #   @param template_ids [Array<String>] Specify one or more templates to generate a single blank CSV file that will cont
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end