signwell_sdk 0.0.1.pre.alpha.1

data/rbi/signwell_sdk/models/v1/document_delete_params.rbi

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

@@ -0,0 +1,55 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class DocumentFile < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(SignwellSDK::V1::DocumentFile, SignwellSDK::Internal::AnyHash)
+          end
+
+        # Name of the file that will be uploaded.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # A RFC 4648 base64 string of the file to be uploaded.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_base64
+
+        sig { params(file_base64: String).void }
+        attr_writer :file_base64
+
+        # Publicly available URL of the file to be uploaded.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_url
+
+        sig { params(file_url: String).void }
+        attr_writer :file_url
+
+        sig do
+          params(name: String, file_base64: String, file_url: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Name of the file that will be uploaded.
+          name:,
+          # A RFC 4648 base64 string of the file to be uploaded.
+          file_base64: nil,
+          # Publicly available URL of the file to be uploaded.
+          file_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { name: String, file_base64: String, file_url: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/document_list_params.rbi

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

@@ -0,0 +1,71 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class DocumentListResponse < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::Models::V1::DocumentListResponse,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :current_page
+
+        sig { returns(T::Array[SignwellSDK::V1::Document]) }
+        attr_accessor :documents
+
+        sig { returns(Integer) }
+        attr_accessor :total_count
+
+        sig { returns(Integer) }
+        attr_accessor :total_pages
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :next_page
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :previous_page
+
+        # List of documents with pagination
+        sig do
+          params(
+            current_page: Integer,
+            documents: T::Array[SignwellSDK::V1::Document::OrHash],
+            total_count: Integer,
+            total_pages: Integer,
+            next_page: T.nilable(Integer),
+            previous_page: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          current_page:,
+          documents:,
+          total_count:,
+          total_pages:,
+          next_page: nil,
+          previous_page: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              current_page: Integer,
+              documents: T::Array[SignwellSDK::V1::Document],
+              total_count: Integer,
+              total_pages: Integer,
+              next_page: T.nilable(Integer),
+              previous_page: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/document_remind_params.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class DocumentRemindParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::DocumentRemindParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Optional list if recipients within the document to send a reminder email to. If
+        # none are specified, all recipients that have not signed yet will receive a
+        # reminder email.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[SignwellSDK::V1::DocumentRemindParams::Recipient]
+            )
+          )
+        end
+        attr_reader :recipients
+
+        sig do
+          params(
+            recipients:
+              T::Array[SignwellSDK::V1::DocumentRemindParams::Recipient::OrHash]
+          ).void
+        end
+        attr_writer :recipients
+
+        sig do
+          params(
+            recipients:
+              T::Array[
+                SignwellSDK::V1::DocumentRemindParams::Recipient::OrHash
+              ],
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Optional list if recipients within the document to send a reminder email to. If
+          # none are specified, all recipients that have not signed yet will receive a
+          # reminder email.
+          recipients: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              recipients:
+                T::Array[SignwellSDK::V1::DocumentRemindParams::Recipient],
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Recipient < SignwellSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                SignwellSDK::V1::DocumentRemindParams::Recipient,
+                SignwellSDK::Internal::AnyHash
+              )
+            end
+
+          # Recipient's email address.
+          sig { returns(T.nilable(String)) }
+          attr_reader :email
+
+          sig { params(email: String).void }
+          attr_writer :email
+
+          # Recipient's name (required if multiple recipients share the same email).
+          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(
+            # Recipient's email address.
+            email: nil,
+            # Recipient's name (required if multiple recipients share the same email).
+            name: nil
+          )
+          end
+
+          sig { override.returns({ email: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/document_retrieve_completed_pdf_params.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class DocumentRetrieveCompletedPdfParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Whether to include the audit page as part of the document. Defaults to `true`
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :audit_page
+
+        sig { params(audit_page: T::Boolean).void }
+        attr_writer :audit_page
+
+        # Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+        sig do
+          returns(
+            T.nilable(
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::OrSymbol
+            )
+          )
+        end
+        attr_reader :file_format
+
+        sig do
+          params(
+            file_format:
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::OrSymbol
+          ).void
+        end
+        attr_writer :file_format
+
+        # Whether to return the URL of the completed PDF or the actual PDF content.
+        # Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :url_only
+
+        sig { params(url_only: T::Boolean).void }
+        attr_writer :url_only
+
+        sig do
+          params(
+            audit_page: T::Boolean,
+            file_format:
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::OrSymbol,
+            url_only: T::Boolean,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether to include the audit page as part of the document. Defaults to `true`
+          audit_page: nil,
+          # Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+          file_format: nil,
+          # Whether to return the URL of the completed PDF or the actual PDF content.
+          # Defaults to `false`.
+          url_only: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              audit_page: T::Boolean,
+              file_format:
+                SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::OrSymbol,
+              url_only: T::Boolean,
+              request_options: SignwellSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+        module FileFormat
+          extend SignwellSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PDF =
+            T.let(
+              :pdf,
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::TaggedSymbol
+            )
+          ZIP =
+            T.let(
+              :zip,
+              SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/document_retrieve_completed_pdf_response.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class DocumentRetrieveCompletedPdfResponse < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfResponse,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # URL to download the completed document
+        sig { returns(String) }
+        attr_accessor :file_url
+
+        # Response containing the URL to the completed PDF file (returned when
+        # url_only=true)
+        sig { params(file_url: String).returns(T.attached_class) }
+        def self.new(
+          # URL to download the completed document
+          file_url:
+        )
+        end
+
+        sig { override.returns({ file_url: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/v1/document_retrieve_params.rbi

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