signwell_sdk 0.0.1.pre.alpha.1

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#list
+      class DocumentListParams < 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/document_list_response.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#list
+      class DocumentListResponse < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute current_page
+        #
+        #   @return [Integer]
+        required :current_page, Integer
+
+        # @!attribute documents
+        #
+        #   @return [Array<SignwellSDK::Models::V1::Document>]
+        required :documents, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Document] }
+
+        # @!attribute total_count
+        #
+        #   @return [Integer]
+        required :total_count, Integer
+
+        # @!attribute total_pages
+        #
+        #   @return [Integer]
+        required :total_pages, Integer
+
+        # @!attribute next_page
+        #
+        #   @return [Integer, nil]
+        optional :next_page, Integer, nil?: true
+
+        # @!attribute previous_page
+        #
+        #   @return [Integer, nil]
+        optional :previous_page, Integer, nil?: true
+
+        # @!method initialize(current_page:, documents:, total_count:, total_pages:, next_page: nil, previous_page: nil)
+        #   List of documents with pagination
+        #
+        #   @param current_page [Integer]
+        #   @param documents [Array<SignwellSDK::Models::V1::Document>]
+        #   @param total_count [Integer]
+        #   @param total_pages [Integer]
+        #   @param next_page [Integer, nil]
+        #   @param previous_page [Integer, nil]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#remind
+      class DocumentRemindParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute recipients
+        #   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.
+        #
+        #   @return [Array<SignwellSDK::Models::V1::DocumentRemindParams::Recipient>, nil]
+        optional :recipients,
+                 -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::DocumentRemindParams::Recipient] }
+
+        # @!method initialize(recipients: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::DocumentRemindParams} for more details.
+        #
+        #   @param recipients [Array<SignwellSDK::Models::V1::DocumentRemindParams::Recipient>] Optional list if recipients within the document to send a reminder email to. If
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        class Recipient < SignwellSDK::Internal::Type::BaseModel
+          # @!attribute email
+          #   Recipient's email address.
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!attribute name
+          #   Recipient's name (required if multiple recipients share the same email).
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(email: nil, name: nil)
+          #   @param email [String] Recipient's email address.
+          #
+          #   @param name [String] Recipient's name (required if multiple recipients share the same email).
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#retrieve_completed_pdf
+      class DocumentRetrieveCompletedPdfParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute audit_page
+        #   Whether to include the audit page as part of the document. Defaults to `true`
+        #
+        #   @return [Boolean, nil]
+        optional :audit_page, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute file_format
+        #   Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+        #
+        #   @return [Symbol, SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams::FileFormat, nil]
+        optional :file_format, enum: -> { SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat }
+
+        # @!attribute url_only
+        #   Whether to return the URL of the completed PDF or the actual PDF content.
+        #   Defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :url_only, SignwellSDK::Internal::Type::Boolean
+
+        # @!method initialize(audit_page: nil, file_format: nil, url_only: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams} for more details.
+        #
+        #   @param audit_page [Boolean] Whether to include the audit page as part of the document. Defaults to `true`
+        #
+        #   @param file_format [Symbol, SignwellSDK::Models::V1::DocumentRetrieveCompletedPdfParams::FileFormat] Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+        #
+        #   @param url_only [Boolean] Whether to return the URL of the completed PDF or the actual PDF content. Defaul
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Format of the file to be downloaded. Supported formats are 'pdf' and 'zip'.
+        module FileFormat
+          extend SignwellSDK::Internal::Type::Enum
+
+          PDF = :pdf
+          ZIP = :zip
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#retrieve_completed_pdf
+      class DocumentRetrieveCompletedPdfResponse < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute file_url
+        #   URL to download the completed document
+        #
+        #   @return [String]
+        required :file_url, String
+
+        # @!method initialize(file_url:)
+        #   Response containing the URL to the completed PDF file (returned when
+        #   url_only=true)
+        #
+        #   @param file_url [String] URL to download the completed document
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#retrieve
+      class DocumentRetrieveParams < 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/document_send_params.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    module V1
+      # @see SignwellSDK::Resources::V1::Documents#send_
+      class DocumentSendParams < SignwellSDK::Internal::Type::BaseModel
+        extend SignwellSDK::Internal::Type::RequestParameters::Converter
+        include SignwellSDK::Internal::Type::RequestParameters
+
+        # @!attribute allow_decline
+        #   Whether to allow recipients the option to decline signing a document. If
+        #   multiple signers are involved in a document, any single recipient can cancel the
+        #   entire document signing process by declining to sign.
+        #
+        #   @return [Boolean, nil]
+        optional :allow_decline, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute allow_reassign
+        #   In some cases a signer is not the right person to sign and may need to reassign
+        #   their signing responsibilities to another person. This feature allows them to
+        #   reassign the document to someone else.
+        #
+        #   @return [Boolean, nil]
+        optional :allow_reassign, SignwellSDK::Internal::Type::Boolean
+
+        # @!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 checkbox_groups
+        #   Checkbox fields that are placed on a document can be grouped with selection
+        #   requirements. At least 2 checkbox fields in an array of fields must be assigned
+        #   to the same recipient.
+        #
+        #   @return [Array<SignwellSDK::Models::V1::CheckboxGroup>, nil]
+        optional :checkbox_groups, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::CheckboxGroup] }
+
+        # @!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 decline_redirect_url
+        #   A URL that recipients are redirected to if the document is declined.
+        #
+        #   @return [String, nil]
+        optional :decline_redirect_url, String
+
+        # @!attribute embedded_signing
+        #   When set to `true` it enables embedded signing in your website/web application.
+        #   Embedded functionality works with an iFrame and email authentication is
+        #   disabled. :embedded_signinig defaults to `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :embedded_signing, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute embedded_signing_notifications
+        #   On embedding signing, document owners (and CC'd contacts) do not get a
+        #   notification email when documents have been completed. Setting this param to
+        #   `true` will send out those final completed notifications. Default is `false`
+        #
+        #   @return [Boolean, nil]
+        optional :embedded_signing_notifications, SignwellSDK::Internal::Type::Boolean
+
+        # @!attribute expires_in
+        #   Number of days before the signature request expires. Defaults to the account
+        #   expiration setting or template expiration (if the document is created from a
+        #   template).
+        #
+        #   @return [Integer, nil]
+        optional :expires_in, Integer
+
+        # @!attribute labels
+        #   Labels can be used to organize documents in a way that can make it easy to find
+        #   using the document search in SignWell. A document can have multiple labels.
+        #   Updating labels on a document will replace any existing labels for that
+        #   document.
+        #
+        #   @return [Array<SignwellSDK::Models::V1::Label>, nil]
+        optional :labels, -> { SignwellSDK::Internal::Type::ArrayOf[SignwellSDK::V1::Label] }
+
+        # @!attribute message
+        #   Email message for the signature request that recipients will see. Defaults to
+        #   the default system message or a template message (if the document is created
+        #   from a template).
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute metadata
+        #   Optional key-value data that can be associated with the document. If set, will
+        #   be available every time the document data is returned.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, SignwellSDK::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #   The name of the document.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute redirect_url
+        #   A URL that recipients are redirected to after successfully signing a document.
+        #
+        #   @return [String, nil]
+        optional :redirect_url, String
+
+        # @!attribute reminders
+        #   Whether to send signing reminders to recipients. Reminders are sent on day 3,
+        #   day 6, and day 10 if set to `true`. Defaults to `true`.
+        #
+        #   @return [Boolean, nil]
+        optional :reminders, 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 (if the document is created
+        #   from a template).
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!attribute test_mode
+        #   Set to `true` to enable Test Mode. Documents created with Test Mode do not count
+        #   towards API billing and are not legally binding. Defaults to `false`
+        #
+        #   @return [Boolean, nil]
+        optional :test_mode, SignwellSDK::Internal::Type::Boolean
+
+        # @!method initialize(allow_decline: nil, allow_reassign: nil, api_application_id: nil, apply_signing_order: nil, checkbox_groups: nil, custom_requester_email: nil, custom_requester_name: nil, decline_redirect_url: nil, embedded_signing: nil, embedded_signing_notifications: nil, expires_in: nil, labels: nil, message: nil, metadata: nil, name: nil, redirect_url: nil, reminders: nil, subject: nil, test_mode: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {SignwellSDK::Models::V1::DocumentSendParams} for more details.
+        #
+        #   @param allow_decline [Boolean] Whether to allow recipients the option to decline signing a document. If multipl
+        #
+        #   @param allow_reassign [Boolean] In some cases a signer is not the right person to sign and may need to reassign
+        #
+        #   @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 checkbox_groups [Array<SignwellSDK::Models::V1::CheckboxGroup>] Checkbox fields that are placed on a document can be grouped with selection requ
+        #
+        #   @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 decline_redirect_url [String] A URL that recipients are redirected to if the document is declined.
+        #
+        #   @param embedded_signing [Boolean] When set to `true` it enables embedded signing in your website/web application.
+        #
+        #   @param embedded_signing_notifications [Boolean] On embedding signing, document owners (and CC'd contacts) do not get a notificat
+        #
+        #   @param expires_in [Integer] Number of days before the signature request expires. Defaults to the account exp
+        #
+        #   @param labels [Array<SignwellSDK::Models::V1::Label>] Labels can be used to organize documents in a way that can make it easy to find
+        #
+        #   @param message [String] Email message for the signature request that recipients will see. Defaults to th
+        #
+        #   @param metadata [Hash{Symbol=>String}] Optional key-value data that can be associated with the document. If set, will b
+        #
+        #   @param name [String] The name of the document.
+        #
+        #   @param redirect_url [String] A URL that recipients are redirected to after successfully signing a document.
+        #
+        #   @param reminders [Boolean] Whether to send signing reminders to recipients. Reminders are sent on day 3, da
+        #
+        #   @param subject [String] Email subject for the signature request that recipients will see. Defaults to th
+        #
+        #   @param test_mode [Boolean] Set to `true` to enable Test Mode. Documents created with Test Mode do not count
+        #
+        #   @param request_options [SignwellSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end