signwell_sdk 0.0.1.pre.alpha.1

data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_documents_params.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendRetrieveDocumentsParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendRetrieveDocumentsParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # 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
+
+        sig do
+          params(
+            limit: Integer,
+            page: Integer,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              limit: Integer,
+              page: Integer,
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/bulk_send_retrieve_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendRetrieveParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendRetrieveParams,
+              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/bulk_send_validate_csv_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class BulkSendValidateCsvParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::BulkSendValidateCsvParams,
+              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
+
+        # 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
+
+        sig do
+          params(
+            bulk_send_csv: String,
+            template_ids: T::Array[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:,
+          # 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:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              bulk_send_csv: String,
+              template_ids: T::Array[String],
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/checkbox_group.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class CheckboxGroup < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::CheckboxGroup,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :checkbox_ids
+
+        # A unique identifier for the checkbox group.
+        sig { returns(String) }
+        attr_accessor :group_name
+
+        # The recipient ID associated with the checkbox group.
+        sig { returns(String) }
+        attr_accessor :recipient_id
+
+        # The exact number of checkboxes that must be checked in the group. (Only for
+        # validation: exact)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :exact_value
+
+        sig { params(exact_value: Integer).void }
+        attr_writer :exact_value
+
+        # The maximum number of checkboxes that can be checked in the group. (Only for
+        # validation: maximum and range)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :max_value
+
+        sig { params(max_value: Integer).void }
+        attr_writer :max_value
+
+        # The minimum number of checkboxes that must be checked in the group. (Only for
+        # validation: minimum and range)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :min_value
+
+        sig { params(min_value: Integer).void }
+        attr_writer :min_value
+
+        # Whether the group must be completed by the recipient. Defaults to false.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :required
+
+        sig { params(required: T::Boolean).void }
+        attr_writer :required
+
+        # Set requirements for the group of one or multiple selections by the recipient.
+        # Defaults to minimum. Validation values: minimum, maximum, exact, range.
+        sig { returns(T.nilable(SignwellSDK::CheckboxValidation::OrSymbol)) }
+        attr_reader :validation
+
+        sig do
+          params(validation: SignwellSDK::CheckboxValidation::OrSymbol).void
+        end
+        attr_writer :validation
+
+        sig do
+          params(
+            checkbox_ids: T::Array[String],
+            group_name: String,
+            recipient_id: String,
+            exact_value: Integer,
+            max_value: Integer,
+            min_value: Integer,
+            required: T::Boolean,
+            validation: SignwellSDK::CheckboxValidation::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          checkbox_ids:,
+          # A unique identifier for the checkbox group.
+          group_name:,
+          # The recipient ID associated with the checkbox group.
+          recipient_id:,
+          # The exact number of checkboxes that must be checked in the group. (Only for
+          # validation: exact)
+          exact_value: nil,
+          # The maximum number of checkboxes that can be checked in the group. (Only for
+          # validation: maximum and range)
+          max_value: nil,
+          # The minimum number of checkboxes that must be checked in the group. (Only for
+          # validation: minimum and range)
+          min_value: nil,
+          # Whether the group must be completed by the recipient. Defaults to false.
+          required: nil,
+          # Set requirements for the group of one or multiple selections by the recipient.
+          # Defaults to minimum. Validation values: minimum, maximum, exact, range.
+          validation: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              checkbox_ids: T::Array[String],
+              group_name: String,
+              recipient_id: String,
+              exact_value: Integer,
+              max_value: Integer,
+              min_value: Integer,
+              required: T::Boolean,
+              validation: SignwellSDK::CheckboxValidation::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/copied_contact.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class CopiedContact < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::CopiedContact,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Email for the copied contact.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # Name of the copied contact.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig { params(email: String, name: String).returns(T.attached_class) }
+        def self.new(
+          # Email for the copied contact.
+          email:,
+          # Name of the copied contact.
+          name: nil
+        )
+        end
+
+        sig { override.returns({ email: String, name: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end