signwell_sdk 0.0.1.pre.alpha.1

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      class CheckboxGroup < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute checkbox_ids
+        #
+        #   @return [Array<String>]
+        required :checkbox_ids, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute group_name
+        #   A unique identifier for the checkbox group.
+        #
+        #   @return [String]
+        required :group_name, String
+
+        # @!attribute recipient_id
+        #   The recipient ID associated with the checkbox group.
+        #
+        #   @return [String]
+        required :recipient_id, String
+
+        # @!attribute exact_value
+        #   The exact number of checkboxes that must be checked in the group. (Only for
+        #   validation: exact)
+        #
+        #   @return [Integer, nil]
+        optional :exact_value, Integer
+
+        # @!attribute max_value
+        #   The maximum number of checkboxes that can be checked in the group. (Only for
+        #   validation: maximum and range)
+        #
+        #   @return [Integer, nil]
+        optional :max_value, Integer
+
+        # @!attribute min_value
+        #   The minimum number of checkboxes that must be checked in the group. (Only for
+        #   validation: minimum and range)
+        #
+        #   @return [Integer, nil]
+        optional :min_value, Integer
+
+        # @!attribute required
+        #   Whether the group must be completed by the recipient. Defaults to false.
+        #
+        #   @return [Boolean, nil]
+        optional :required, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute validation
+        #   Set requirements for the group of one or multiple selections by the recipient.
+        #   Defaults to minimum. Validation values: minimum, maximum, exact, range.
+        #
+        #   @return [Symbol, SignwellSDK::Models::CheckboxValidation, nil]
+        optional :validation, enum: -> { SignwellSDK::CheckboxValidation }
+
+        # @!method initialize(checkbox_ids:, group_name:, recipient_id:, exact_value: nil, max_value: nil, min_value: nil, required: nil, validation: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::CheckboxGroup} for more details.
+        #
+        #   @param checkbox_ids [Array<String>]
+        #
+        #   @param group_name [String] A unique identifier for the checkbox group.
+        #
+        #   @param recipient_id [String] The recipient ID associated with the checkbox group.
+        #
+        #   @param exact_value [Integer] The exact number of checkboxes that must be checked in the group. (Only for vali
+        #
+        #   @param max_value [Integer] The maximum number of checkboxes that can be checked in the group. (Only for val
+        #
+        #   @param min_value [Integer] The minimum number of checkboxes that must be checked in the group. (Only for va
+        #
+        #   @param required [Boolean] Whether the group must be completed by the recipient. Defaults to false.
+        #
+        #   @param validation [Symbol, SignwellSDK::Models::CheckboxValidation] Set requirements for the group of one or multiple selections by the recipient. D
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      class CopiedContact < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute email
+        #   Email for the copied contact.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute name
+        #   Name of the copied contact.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(email:, name: nil)
+        #   @param email [String] Email for the copied contact.
+        #
+        #   @param name [String] Name of the copied contact.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,543 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#create
+      class Document < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute test_mode
+        #
+        #   @return [Boolean]
+        required :test_mode, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute allow_decline
+        #
+        #   @return [Boolean, nil]
+        optional :allow_decline, SignwellSDK::Internal::Type::Boolean, nil?: true
+
+        # @!attribute allow_reassign
+        #
+        #   @return [Boolean, nil]
+        optional :allow_reassign, SignwellSDK::Internal::Type::Boolean, nil?: true
+
+        # @!attribute api_application_id
+        #
+        #   @return [String, nil]
+        optional :api_application_id, String, nil?: true
+
+        # @!attribute apply_signing_order
+        #
+        #   @return [Boolean, nil]
+        optional :apply_signing_order, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute archived
+        #
+        #   @return [Boolean, nil]
+        optional :archived, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute attachment_requests
+        #
+        #   @return [Array<SignwellSDK::Models::V1::Document::AttachmentRequest>, nil]
+        optional :attachment_requests,
+                 -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::AttachmentRequest] }
+
+        # @!attribute checkbox_groups
+        #
+        #   @return [Array<SignwellSDK::Models::CheckboxGroupInfo>, nil]
+        optional :checkbox_groups, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::CheckboxGroupInfo] }
+
+        # @!attribute copied_contacts
+        #
+        #   @return [Array<SignwellSDK::Models::CopiedContactInfo>, nil]
+        optional :copied_contacts, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::CopiedContactInfo] }
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute custom_requester_email
+        #
+        #   @return [String, nil]
+        optional :custom_requester_email, String, nil?: true
+
+        # @!attribute custom_requester_name
+        #
+        #   @return [String, nil]
+        optional :custom_requester_name, String, nil?: true
+
+        # @!attribute decline_redirect_url
+        #
+        #   @return [String, nil]
+        optional :decline_redirect_url, String, nil?: true
+
+        # @!attribute embedded
+        #
+        #   @return [Boolean, nil]
+        optional :embedded, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute embedded_edit_url
+        #
+        #   @return [String, nil]
+        optional :embedded_edit_url, String
+
+        # @!attribute embedded_preview_url
+        #
+        #   @return [String, nil]
+        optional :embedded_preview_url, String, nil?: true
+
+        # @!attribute expires_in
+        #
+        #   @return [Integer, nil]
+        optional :expires_in, Integer
+
+        # @!attribute fields
+        #
+        #   @return [Array<Array<SignwellSDK::Models::V1::Document::Field>>, nil]
+        optional :fields,
+                 -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Field]] }
+
+        # @!attribute files
+        #
+        #   @return [Array<SignwellSDK::Models::FileInfo>, nil]
+        optional :files, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::FileInfo] }
+
+        # @!attribute labels
+        #
+        #   @return [Array<SignwellSDK::Models::LabelInfo>, nil]
+        optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::LabelInfo] }
+
+        # @!attribute language
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute metadata
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, SignwellSDK::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute recipients
+        #
+        #   @return [Array<SignwellSDK::Models::V1::Document::Recipient>, nil]
+        optional :recipients, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Recipient] }
+
+        # @!attribute redirect_url
+        #
+        #   @return [String, nil]
+        optional :redirect_url, String, nil?: true
+
+        # @!attribute reminders
+        #
+        #   @return [Boolean, nil]
+        optional :reminders, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute requester_email_address
+        #
+        #   @return [String, nil]
+        optional :requester_email_address, String
+
+        # @!attribute status
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute subject
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id:, test_mode:, allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, archived: nil, attachment_requests: nil, checkbox_groups: nil, copied_contacts: nil, created_at: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded: nil, embedded_edit_url: nil, embedded_preview_url: nil, expires_in: nil, fields: nil, files: nil, labels: nil, language: nil, message: nil, metadata: nil, name: nil, recipients: nil, redirect_url: nil, reminders: nil, requester_email_address: nil, status: nil, subject: nil, updated_at: nil)
+        #   @param id [String]
+        #   @param test_mode [Boolean]
+        #   @param allow_decline [Boolean, nil]
+        #   @param allow_reassign [Boolean, nil]
+        #   @param api_application_id [String, nil]
+        #   @param apply_signing_order [Boolean]
+        #   @param archived [Boolean]
+        #   @param attachment_requests [Array<SignwellSDK::Models::V1::Document::AttachmentRequest>]
+        #   @param checkbox_groups [Array<SignwellSDK::Models::CheckboxGroupInfo>]
+        #   @param copied_contacts [Array<SignwellSDK::Models::CopiedContactInfo>]
+        #   @param created_at [Time]
+        #   @param custom_requester_email [String, nil]
+        #   @param custom_requester_name [String, nil]
+        #   @param decline_redirect_url [String, nil]
+        #   @param embedded [Boolean]
+        #   @param embedded_edit_url [String]
+        #   @param embedded_preview_url [String, nil]
+        #   @param expires_in [Integer]
+        #   @param fields [Array<Array<SignwellSDK::Models::V1::Document::Field>>]
+        #   @param files [Array<SignwellSDK::Models::FileInfo>]
+        #   @param labels [Array<SignwellSDK::Models::LabelInfo>]
+        #   @param language [String]
+        #   @param message [String]
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #   @param name [String]
+        #   @param recipients [Array<SignwellSDK::Models::V1::Document::Recipient>]
+        #   @param redirect_url [String, nil]
+        #   @param reminders [Boolean]
+        #   @param requester_email_address [String]
+        #   @param status [String]
+        #   @param subject [String]
+        #   @param updated_at [Time]
+
+        class AttachmentRequest < SignwellSDK::Internal::Type::BaseModel
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute recipient_id
+          #
+          #   @return [String]
+          required :recipient_id, String
+
+          # @!attribute required
+          #
+          #   @return [Boolean, nil]
+          optional :required, SignwellSDK::Internal::Type::Boolean
+
+          # @!method initialize(name:, recipient_id:, required: nil)
+          #   @param name [String]
+          #   @param recipient_id [String]
+          #   @param required [Boolean]
+        end
+
+        class Field < SignwellSDK::Internal::Type::BaseModel
+          # @!attribute page
+          #
+          #   @return [Integer]
+          required :page, Integer
+
+          # @!attribute x
+          #
+          #   @return [Float]
+          required :x, Float
+
+          # @!attribute y_
+          #
+          #   @return [Float]
+          required :y_, Float, api_name: :y
+
+          # @!attribute allow_other
+          #   Whether "Other" option is allowed
+          #
+          #   @return [Boolean, nil]
+          optional :allow_other, SignwellSDK::Internal::Type::Boolean
+
+          # @!attribute api_id
+          #
+          #   @return [String, nil]
+          optional :api_id, String
+
+          # @!attribute date_format
+          #   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
+          #
+          #   @return [Symbol, SignwellSDK::Models::DateFormat, nil]
+          optional :date_format, enum: -> { SignwellSDK::DateFormat }
+
+          # @!attribute default_option
+          #   Default selected option
+          #
+          #   @return [String, nil]
+          optional :default_option, String
+
+          # @!attribute fixed_width
+          #
+          #   @return [Boolean, nil]
+          optional :fixed_width, SignwellSDK::Internal::Type::Boolean
+
+          # @!attribute height
+          #
+          #   @return [String, nil]
+          optional :height, String
+
+          # @!attribute label
+          #
+          #   @return [String, nil]
+          optional :label, String
+
+          # @!attribute lock_sign_date
+          #
+          #   @return [Boolean, nil]
+          optional :lock_sign_date, SignwellSDK::Internal::Type::Boolean
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute options
+          #   Dropdown options (for dropdown/select fields)
+          #
+          #   @return [Array<SignwellSDK::Models::V1::Document::Field::Option>, nil]
+          optional :options, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document::Field::Option] }
+
+          # @!attribute placeholder_name
+          #
+          #   @return [String, nil]
+          optional :placeholder_name, String
+
+          # @!attribute recipient
+          #
+          #   @return [SignwellSDK::Models::V1::Document::Field::Recipient, nil]
+          optional :recipient, -> { SignwellSDK::V1::Document::Field::Recipient }
+
+          # @!attribute recipient_id
+          #
+          #   @return [String, nil]
+          optional :recipient_id, String, nil?: true
+
+          # @!attribute required
+          #
+          #   @return [Boolean, nil]
+          optional :required, SignwellSDK::Internal::Type::Boolean
+
+          # @!attribute signing_elements_group_id
+          #
+          #   @return [String, nil]
+          optional :signing_elements_group_id, String
+
+          # @!attribute type
+          #   Type of signing field
+          #
+          #   @return [Symbol, SignwellSDK::Models::FieldType, nil]
+          optional :type, enum: -> { SignwellSDK::FieldType }
+
+          # @!attribute validation
+          #   Validation rule for text fields
+          #
+          #   @return [Symbol, SignwellSDK::Models::TextValidation, nil]
+          optional :validation, enum: -> { SignwellSDK::TextValidation }
+
+          # @!attribute value
+          #
+          #   @return [String, Boolean, Float, nil]
+          optional :value, union: -> { SignwellSDK::V1::Document::Field::Value }, nil?: true
+
+          # @!attribute width
+          #
+          #   @return [String, nil]
+          optional :width, String
+
+          # @!method initialize(page:, x:, y_:, allow_other: nil, api_id: nil, date_format: nil, default_option: nil, fixed_width: nil, height: nil, label: nil, lock_sign_date: nil, name: nil, options: nil, placeholder_name: nil, recipient: nil, recipient_id: nil, required: nil, signing_elements_group_id: nil, type: nil, validation: nil, value: nil, width: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {SignwellSDK::Models::V1::Document::Field} for more details.
+          #
+          #   @param page [Integer]
+          #
+          #   @param x [Float]
+          #
+          #   @param y_ [Float]
+          #
+          #   @param allow_other [Boolean] Whether "Other" option is allowed
+          #
+          #   @param api_id [String]
+          #
+          #   @param date_format [Symbol, SignwellSDK::Models::DateFormat] Date format for date fields. Valid values: MM/DD/YYYY, DD/MM/YYYY, YYYY/MM/DD, M
+          #
+          #   @param default_option [String] Default selected option
+          #
+          #   @param fixed_width [Boolean]
+          #
+          #   @param height [String]
+          #
+          #   @param label [String]
+          #
+          #   @param lock_sign_date [Boolean]
+          #
+          #   @param name [String, nil]
+          #
+          #   @param options [Array<SignwellSDK::Models::V1::Document::Field::Option>] Dropdown options (for dropdown/select fields)
+          #
+          #   @param placeholder_name [String]
+          #
+          #   @param recipient [SignwellSDK::Models::V1::Document::Field::Recipient]
+          #
+          #   @param recipient_id [String, nil]
+          #
+          #   @param required [Boolean]
+          #
+          #   @param signing_elements_group_id [String]
+          #
+          #   @param type [Symbol, SignwellSDK::Models::FieldType] Type of signing field
+          #
+          #   @param validation [Symbol, SignwellSDK::Models::TextValidation] Validation rule for text fields
+          #
+          #   @param value [String, Boolean, Float, nil]
+          #
+          #   @param width [String]
+
+          class Option < SignwellSDK::Internal::Type::BaseModel
+            # @!attribute api_id
+            #
+            #   @return [String, nil]
+            optional :api_id, String
+
+            # @!attribute is_other
+            #
+            #   @return [Boolean, nil]
+            optional :is_other, SignwellSDK::Internal::Type::Boolean
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(api_id: nil, is_other: nil, name: nil)
+            #   @param api_id [String]
+            #   @param is_other [Boolean]
+            #   @param name [String]
+          end
+
+          # @see SignwellSDK::Models::V1::Document::Field#recipient
+          class Recipient < SignwellSDK::Internal::Type::BaseModel
+            # @!attribute email
+            #
+            #   @return [String]
+            required :email, String
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(email:, name:)
+            #   @param email [String]
+            #   @param name [String]
+          end
+
+          # @see SignwellSDK::Models::V1::Document::Field#value
+          module Value
+            extend SignwellSDK::Internal::Type::Union
+
+            variant String
+
+            variant SignwellSDK::Internal::Type::Boolean
+
+            variant Float
+
+            # @!method self.variants
+            #   @return [Array(String, Boolean, Float)]
+          end
+        end
+
+        class Recipient < SignwellSDK::Internal::Type::BaseModel
+          # @!attribute email
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute attachment_requests
+          #
+          #   @return [Array<SignwellSDK::Models::AttachmentRequestInfo>, nil]
+          optional :attachment_requests,
+                   -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::AttachmentRequestInfo] }
+
+          # @!attribute body
+          #
+          #   @return [String, nil]
+          optional :body, String
+
+          # @!attribute bounced
+          #
+          #   @return [Boolean, nil]
+          optional :bounced, SignwellSDK::Internal::Type::Boolean, nil?: true
+
+          # @!attribute bounced_details
+          #
+          #   @return [String, nil]
+          optional :bounced_details, String, nil?: true
+
+          # @!attribute message
+          #
+          #   @return [String, nil]
+          optional :message, String, nil?: true
+
+          # @!attribute passcode
+          #
+          #   @return [String, nil]
+          optional :passcode, String, nil?: true
+
+          # @!attribute send_email
+          #
+          #   @return [Boolean, nil]
+          optional :send_email, SignwellSDK::Internal::Type::Boolean, nil?: true
+
+          # @!attribute send_email_delay
+          #
+          #   @return [Integer, nil]
+          optional :send_email_delay, Integer, nil?: true
+
+          # @!attribute signing_order
+          #
+          #   @return [Integer, nil]
+          optional :signing_order, Integer
+
+          # @!attribute signing_url
+          #
+          #   @return [String, nil]
+          optional :signing_url, String
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute subject
+          #
+          #   @return [String, nil]
+          optional :subject, String, nil?: true
+
+          # @!method initialize(email:, name:, id: nil, attachment_requests: nil, body: nil, bounced: nil, bounced_details: nil, message: nil, passcode: nil, send_email: nil, send_email_delay: nil, signing_order: nil, signing_url: nil, status: nil, subject: nil)
+          #   @param email [String]
+          #   @param name [String]
+          #   @param id [String]
+          #   @param attachment_requests [Array<SignwellSDK::Models::AttachmentRequestInfo>]
+          #   @param body [String]
+          #   @param bounced [Boolean, nil]
+          #   @param bounced_details [String, nil]
+          #   @param message [String, nil]
+          #   @param passcode [String, nil]
+          #   @param send_email [Boolean, nil]
+          #   @param send_email_delay [Integer, nil]
+          #   @param signing_order [Integer]
+          #   @param signing_url [String]
+          #   @param status [String]
+          #   @param subject [String, nil]
+        end
+      end
+    end
+  end
+end