signwell_sdk 0.0.1.pre.alpha.1

data/rbi/signwell_sdk/models/v1/template_checkbox_group.rbi

@@ -0,0 +1,121 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    module V1
+      class TemplateCheckboxGroup < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::V1::TemplateCheckboxGroup,
+              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 :placeholder_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,
+            placeholder_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.
+          placeholder_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,
+              placeholder_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_me_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class V1MeParams < SignwellSDK::Internal::Type::BaseModel
+      extend SignwellSDK::Internal::Type::RequestParameters::Converter
+      include SignwellSDK::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(SignwellSDK::V1MeParams, SignwellSDK::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: SignwellSDK::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: SignwellSDK::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module SignwellSDK
+  AttachmentRequestInfo = SignwellSDK::Models::AttachmentRequestInfo
+
+  CheckboxGroupInfo = SignwellSDK::Models::CheckboxGroupInfo
+
+  CheckboxValidation = SignwellSDK::Models::CheckboxValidation
+
+  CopiedContactInfo = SignwellSDK::Models::CopiedContactInfo
+
+  DateFormat = SignwellSDK::Models::DateFormat
+
+  FieldType = SignwellSDK::Models::FieldType
+
+  FileInfo = SignwellSDK::Models::FileInfo
+
+  LabelInfo = SignwellSDK::Models::LabelInfo
+
+  TextValidation = SignwellSDK::Models::TextValidation
+
+  V1 = SignwellSDK::Models::V1
+
+  V1MeParams = SignwellSDK::Models::V1MeParams
+end

data/rbi/signwell_sdk/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module SignwellSDK
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < SignwellSDK::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(SignwellSDK::RequestOptions, SignwellSDK::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: SignwellSDK::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: SignwellSDK::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/signwell_sdk/resources/v1/api_applications.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module SignwellSDK
+  module Resources
+    class V1
+      class APIApplications
+        # Gets the details of a specific API Application within an account. Supply the
+        # unique Application ID from either the Create API Application response or the API
+        # Application edit page.
+        sig do
+          params(
+            id: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve(
+          # Unique identifier for the API Application.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Deletes an API Application from an account. Supply the unique Application ID
+        # from either the Create API Application response or the API Application edit page
+        sig do
+          params(
+            id: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Unique identifier for the API Application.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: SignwellSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/resources/v1/bulk_sends.rbi

@@ -0,0 +1,173 @@
+# typed: strong
+
+module SignwellSDK
+  module Resources
+    class V1
+      class BulkSends
+        # Creates a bulk send, and it validates the CSV file before creating the bulk
+        # send.
+        sig do
+          params(
+            bulk_send_csv: String,
+            template_ids: T::Array[String],
+            api_application_id: String,
+            apply_signing_order: T::Boolean,
+            custom_requester_email: String,
+            custom_requester_name: String,
+            message: String,
+            name: String,
+            skip_row_errors: T::Boolean,
+            subject: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def create(
+          # A RFC 4648 base64 string of the template CSV file to be validated.
+          bulk_send_csv:,
+          # Unique identifiers for a list of templates.
+          template_ids:,
+          # 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
+          api_application_id: nil,
+          # When set to `true` recipients will sign one at a time in the order of the
+          # `recipients` collection of this request.
+          apply_signing_order: nil,
+          # 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.
+          custom_requester_email: nil,
+          # 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.
+          custom_requester_name: nil,
+          # Email message for the signature request that recipients will see. Defaults to
+          # the default system message or a template message.
+          message: nil,
+          # The name of the Bulk Send. Will be used as the document name for each of the
+          # documents.
+          name: nil,
+          # Whether to skip errors in the rows. Defaults to `false`.
+          skip_row_errors: nil,
+          # Email subject for the signature request that recipients will see. Defaults to
+          # the default system subject or a template subject.
+          subject: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns information about the Bulk Send.
+        sig do
+          params(
+            id: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve(
+          # Unique identifier for a bulk send.
+          id,
+          request_options: {}
+        )
+        end
+
+        # Returns information about the Bulk Send.
+        sig do
+          params(
+            api_application_id: String,
+            limit: Integer,
+            page: Integer,
+            user_email: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def list(
+          # 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
+          api_application_id: nil,
+          # 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,
+          # 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.
+          user_email: nil,
+          request_options: {}
+        )
+        end
+
+        # Fetches a CSV template that corresponds to the provided document template IDs.
+        # CSV templates are blank CSV files that have columns containing required and
+        # optional data that can be sent when creating a bulk send. Fields can be
+        # referenced by the field label. Example: [placeholder name]\_[field label] could
+        # be something like customer_address or signer_company_name (if 'Customer' and
+        # 'Signer' were placeholder names for templates set up in SignWell).
+        sig do
+          params(
+            template_ids: T::Array[String],
+            base64: String,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).returns(StringIO)
+        end
+        def retrieve_csv_template(
+          # 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:,
+          # A RFC 4648 base64 string of the template CSV file to be validated.
+          base64: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns information about the Bulk Send.
+        sig do
+          params(
+            id: String,
+            limit: Integer,
+            page: Integer,
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def retrieve_documents(
+          # Unique identifier for a bulk send.
+          id,
+          # 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
+
+        # Validates a Bulk Send CSV file before creating the Bulk Send. It will check the
+        # structure of the CSV and the data it contains, and return any errors found.
+        sig do
+          params(
+            bulk_send_csv: String,
+            template_ids: T::Array[String],
+            request_options: SignwellSDK::RequestOptions::OrHash
+          ).void
+        end
+        def validate_csv(
+          # 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
+
+        # @api private
+        sig { params(client: SignwellSDK::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end