signwell_sdk 0.0.1.pre.alpha.1 → 0.1.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60864cf9015af7d0f2b8c1c4b7a3a484e1e0cb933b56c3e0643c2db476d892b9
-  data.tar.gz: adea91d15c788f95bd8963cb429ef1e334daac1589f46cf95d767cc2fad70374
+  metadata.gz: '02022668207e2410908c334ca7275b7be0dfd46d5f7ce91cc55e50750d54cc21'
+  data.tar.gz: dd43d14eed3f775b98f32fb366fa065d72b6a00df29269c3d3170bd3dffcafe5
 SHA512:
-  metadata.gz: 70b29469727a352851861ff5deb8f36d7f0e88cd3d57e1de6ade1f889a4f56d2e941486395cf7483892e3638bcf3a6db3016b3a1bec69486dcde4740e8bc6ee8
-  data.tar.gz: 106a2e69133c45d2ef4f17d42a0fa6fcd0776553164cb521feac6f02e65440c6593d519da7f899897401748e11de001d64f7a995d3f53a7c7b23fd33c9376d3a
+  metadata.gz: b539dbd329d0b71b137d48f0e0341da02085f8a7633421e91cff26180bd194a30bc2626e83ba1819c9e82fdd66abdc078f4f20ef9cc8108ba47fa548c5720dcd
+  data.tar.gz: c1ac5ffc4fc77bcc7d338225e54a7ce42e3446c513dd0d5a304c9a86f6f879d634999a398c25db2c973e197a012a196fba6dc9e6cc609702b57d09ccbd52bc7f

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.1.0-alpha.2 (2026-02-04)
+
+Full Changelog: [v0.0.1-alpha.1...v0.1.0-alpha.2](https://github.com/Bidsketch/signwell-sdk-ruby/compare/v0.0.1-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** adds contact information ([4d03e53](https://github.com/Bidsketch/signwell-sdk-ruby/commit/4d03e530a065aabce613ac34b5e7e760498fa822))
+* **api:** manual updates ([d1d35ee](https://github.com/Bidsketch/signwell-sdk-ruby/commit/d1d35ee21e78a13ed90f0bd9f340e9b4c3cf640e))
+* **api:** updates error responses ([aeff826](https://github.com/Bidsketch/signwell-sdk-ruby/commit/aeff82647d6d8340a758c2ff1ef1eac188ed944b))
+
+
+### Chores
+
+* update SDK settings ([21722bb](https://github.com/Bidsketch/signwell-sdk-ruby/commit/21722bb094b2def47aae35fb448265141f22fcf7))
+
 ## 0.0.1-alpha.1 (2026-02-04)
 
 Full Changelog: [v0.0.1...v0.0.1-alpha.1](https://github.com/Bidsketch/signwell-sdk-ruby/compare/v0.0.1...v0.0.1-alpha.1)

data/README.md

@@ -8,6 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/signwell_sdk).
 
+The REST API documentation can be found on [developers.signwell.com](https://developers.signwell.com/).
+
 ## Installation
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
@@ -15,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "signwell_sdk", "~> 0.0.1.pre.alpha.1"
+gem "signwell_sdk", "~> 0.1.0.pre.alpha.2"
 ```
 
 <!-- x-release-please-end -->

data/SECURITY.md

@@ -18,6 +18,10 @@ before making any information public.
 If you encounter security issues that are not directly related to SDKs but pertain to the services
 or products provided by Signwell SDK, please follow the respective company's security reporting guidelines.
 
+### Signwell SDK Terms and Policies
+
+Please contact support@signwell.com for any questions or concerns regarding the security of our services.
+
 ---
 
 Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/signwell_sdk/models/error_response.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class ErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute message
+      #   Human-readable error message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute meta
+      #
+      #   @return [SignwellSDK::Models::ErrorResponse::Meta, nil]
+      optional :meta, -> { SignwellSDK::ErrorResponse::Meta }
+
+      # @!method initialize(message: nil, meta: nil)
+      #   Standard error response
+      #
+      #   @param message [String] Human-readable error message
+      #
+      #   @param meta [SignwellSDK::Models::ErrorResponse::Meta]
+
+      # @see SignwellSDK::Models::ErrorResponse#meta
+      class Meta < SignwellSDK::Internal::Type::BaseModel
+        # @!attribute error
+        #   Error code identifier
+        #
+        #   @return [String]
+        required :error, String
+
+        # @!attribute message
+        #   Detailed error message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute messages
+        #   List of error messages
+        #
+        #   @return [Array<String>, nil]
+        optional :messages, SignwellSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(error:, message:, messages: nil)
+        #   @param error [String] Error code identifier
+        #
+        #   @param message [String] Detailed error message
+        #
+        #   @param messages [Array<String>] List of error messages
+      end
+    end
+  end
+end

data/lib/signwell_sdk/models/rate_limit_error_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class RateLimitErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute error
+      #   Rate limit error message indicating the limit and reset time
+      #
+      #   @return [String]
+      required :error, String
+
+      # @!method initialize(error:)
+      #   Rate limit exceeded error response (HTTP 429)
+      #
+      #   @param error [String] Rate limit error message indicating the limit and reset time
+    end
+  end
+end

data/lib/signwell_sdk/models/validation_error_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  module Models
+    class ValidationErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      # @!attribute errors
+      #   Field-specific validation errors. Keys are field names (e.g., recipients,
+      #   fields, files). Values can be strings, arrays of strings, or nested objects with
+      #   further field-specific errors.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :errors, SignwellSDK::Internal::Type::HashOf[SignwellSDK::Internal::Type::Unknown]
+
+      # @!method initialize(errors:)
+      #   Some parameter documentations has been truncated, see
+      #   {SignwellSDK::Models::ValidationErrorResponse} for more details.
+      #
+      #   Validation error response. The errors object contains field-specific error
+      #   details with dynamic keys.
+      #
+      #   @param errors [Hash{Symbol=>Object}] Field-specific validation errors. Keys are field names (e.g., recipients, fields
+    end
+  end
+end

data/lib/signwell_sdk/models.rb

@@ -49,15 +49,21 @@ module SignwellSDK
 
   DateFormat = SignwellSDK::Models::DateFormat
 
+  ErrorResponse = SignwellSDK::Models::ErrorResponse
+
   FieldType = SignwellSDK::Models::FieldType
 
   FileInfo = SignwellSDK::Models::FileInfo
 
   LabelInfo = SignwellSDK::Models::LabelInfo
 
+  RateLimitErrorResponse = SignwellSDK::Models::RateLimitErrorResponse
+
   TextValidation = SignwellSDK::Models::TextValidation
 
   V1 = SignwellSDK::Models::V1
 
   V1MeParams = SignwellSDK::Models::V1MeParams
+
+  ValidationErrorResponse = SignwellSDK::Models::ValidationErrorResponse
 end

data/lib/signwell_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SignwellSDK
-  VERSION = "0.0.1.pre.alpha.1"
+  VERSION = "0.1.0.pre.alpha.2"
 end

data/lib/signwell_sdk.rb

@@ -57,9 +57,11 @@ require_relative "signwell_sdk/models/checkbox_group_info"
 require_relative "signwell_sdk/models/checkbox_validation"
 require_relative "signwell_sdk/models/copied_contact_info"
 require_relative "signwell_sdk/models/date_format"
+require_relative "signwell_sdk/models/error_response"
 require_relative "signwell_sdk/models/field_type"
 require_relative "signwell_sdk/models/file_info"
 require_relative "signwell_sdk/models/label_info"
+require_relative "signwell_sdk/models/rate_limit_error_response"
 require_relative "signwell_sdk/models/text_validation"
 require_relative "signwell_sdk/models/v1/api_application_delete_params"
 require_relative "signwell_sdk/models/v1/api_application_retrieve_params"
@@ -98,6 +100,7 @@ require_relative "signwell_sdk/models/v1/hook_list_params"
 require_relative "signwell_sdk/models/v1/label"
 require_relative "signwell_sdk/models/v1/template_checkbox_group"
 require_relative "signwell_sdk/models/v1_me_params"
+require_relative "signwell_sdk/models/validation_error_response"
 require_relative "signwell_sdk/models"
 require_relative "signwell_sdk/resources/v1"
 require_relative "signwell_sdk/resources/v1/api_applications"

data/rbi/signwell_sdk/models/error_response.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class ErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(SignwellSDK::ErrorResponse, SignwellSDK::Internal::AnyHash)
+        end
+
+      # Human-readable error message
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      sig { returns(T.nilable(SignwellSDK::ErrorResponse::Meta)) }
+      attr_reader :meta
+
+      sig { params(meta: SignwellSDK::ErrorResponse::Meta::OrHash).void }
+      attr_writer :meta
+
+      # Standard error response
+      sig do
+        params(
+          message: String,
+          meta: SignwellSDK::ErrorResponse::Meta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Human-readable error message
+        message: nil,
+        meta: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { message: String, meta: SignwellSDK::ErrorResponse::Meta }
+        )
+      end
+      def to_hash
+      end
+
+      class Meta < SignwellSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              SignwellSDK::ErrorResponse::Meta,
+              SignwellSDK::Internal::AnyHash
+            )
+          end
+
+        # Error code identifier
+        sig { returns(String) }
+        attr_accessor :error
+
+        # Detailed error message
+        sig { returns(String) }
+        attr_accessor :message
+
+        # List of error messages
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :messages
+
+        sig { params(messages: T::Array[String]).void }
+        attr_writer :messages
+
+        sig do
+          params(
+            error: String,
+            message: String,
+            messages: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Error code identifier
+          error:,
+          # Detailed error message
+          message:,
+          # List of error messages
+          messages: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { error: String, message: String, messages: T::Array[String] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/rate_limit_error_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class RateLimitErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SignwellSDK::RateLimitErrorResponse,
+            SignwellSDK::Internal::AnyHash
+          )
+        end
+
+      # Rate limit error message indicating the limit and reset time
+      sig { returns(String) }
+      attr_accessor :error
+
+      # Rate limit exceeded error response (HTTP 429)
+      sig { params(error: String).returns(T.attached_class) }
+      def self.new(
+        # Rate limit error message indicating the limit and reset time
+        error:
+      )
+      end
+
+      sig { override.returns({ error: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models/validation_error_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module SignwellSDK
+  module Models
+    class ValidationErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            SignwellSDK::ValidationErrorResponse,
+            SignwellSDK::Internal::AnyHash
+          )
+        end
+
+      # Field-specific validation errors. Keys are field names (e.g., recipients,
+      # fields, files). Values can be strings, arrays of strings, or nested objects with
+      # further field-specific errors.
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :errors
+
+      # Validation error response. The errors object contains field-specific error
+      # details with dynamic keys.
+      sig do
+        params(errors: T::Hash[Symbol, T.anything]).returns(T.attached_class)
+      end
+      def self.new(
+        # Field-specific validation errors. Keys are field names (e.g., recipients,
+        # fields, files). Values can be strings, arrays of strings, or nested objects with
+        # further field-specific errors.
+        errors:
+      )
+      end
+
+      sig { override.returns({ errors: T::Hash[Symbol, T.anything] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/signwell_sdk/models.rbi

@@ -11,15 +11,21 @@ module SignwellSDK
 
   DateFormat = SignwellSDK::Models::DateFormat
 
+  ErrorResponse = SignwellSDK::Models::ErrorResponse
+
   FieldType = SignwellSDK::Models::FieldType
 
   FileInfo = SignwellSDK::Models::FileInfo
 
   LabelInfo = SignwellSDK::Models::LabelInfo
 
+  RateLimitErrorResponse = SignwellSDK::Models::RateLimitErrorResponse
+
   TextValidation = SignwellSDK::Models::TextValidation
 
   V1 = SignwellSDK::Models::V1
 
   V1MeParams = SignwellSDK::Models::V1MeParams
+
+  ValidationErrorResponse = SignwellSDK::Models::ValidationErrorResponse
 end

data/sig/signwell_sdk/models/error_response.rbs

@@ -0,0 +1,52 @@
+module SignwellSDK
+  module Models
+    type error_response =
+      { message: String, meta: SignwellSDK::ErrorResponse::Meta }
+
+    class ErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      attr_reader meta: SignwellSDK::ErrorResponse::Meta?
+
+      def meta=: (
+        SignwellSDK::ErrorResponse::Meta
+      ) -> SignwellSDK::ErrorResponse::Meta
+
+      def initialize: (
+        ?message: String,
+        ?meta: SignwellSDK::ErrorResponse::Meta
+      ) -> void
+
+      def to_hash: -> {
+        message: String,
+        meta: SignwellSDK::ErrorResponse::Meta
+      }
+
+      type meta = { error: String, message: String, messages: ::Array[String] }
+
+      class Meta < SignwellSDK::Internal::Type::BaseModel
+        attr_accessor error: String
+
+        attr_accessor message: String
+
+        attr_reader messages: ::Array[String]?
+
+        def messages=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          error: String,
+          message: String,
+          ?messages: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          error: String,
+          message: String,
+          messages: ::Array[String]
+        }
+      end
+    end
+  end
+end

data/sig/signwell_sdk/models/rate_limit_error_response.rbs

@@ -0,0 +1,13 @@
+module SignwellSDK
+  module Models
+    type rate_limit_error_response = { error: String }
+
+    class RateLimitErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      attr_accessor error: String
+
+      def initialize: (error: String) -> void
+
+      def to_hash: -> { error: String }
+    end
+  end
+end

data/sig/signwell_sdk/models/validation_error_response.rbs

@@ -0,0 +1,13 @@
+module SignwellSDK
+  module Models
+    type validation_error_response = { errors: ::Hash[Symbol, top] }
+
+    class ValidationErrorResponse < SignwellSDK::Internal::Type::BaseModel
+      attr_accessor errors: ::Hash[Symbol, top]
+
+      def initialize: (errors: ::Hash[Symbol, top]) -> void
+
+      def to_hash: -> { errors: ::Hash[Symbol, top] }
+    end
+  end
+end

data/sig/signwell_sdk/models.rbs

@@ -9,15 +9,21 @@ module SignwellSDK
 
   module DateFormat = SignwellSDK::Models::DateFormat
 
+  class ErrorResponse = SignwellSDK::Models::ErrorResponse
+
   module FieldType = SignwellSDK::Models::FieldType
 
   class FileInfo = SignwellSDK::Models::FileInfo
 
   class LabelInfo = SignwellSDK::Models::LabelInfo
 
+  class RateLimitErrorResponse = SignwellSDK::Models::RateLimitErrorResponse
+
   module TextValidation = SignwellSDK::Models::TextValidation
 
   module V1 = SignwellSDK::Models::V1
 
   class V1MeParams = SignwellSDK::Models::V1MeParams
+
+  class ValidationErrorResponse = SignwellSDK::Models::ValidationErrorResponse
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signwell_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.alpha.1
+  version: 0.1.0.pre.alpha.2
 platform: ruby
 authors:
 - Signwell SDK
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description:
-email: ''
+email: support@signwell.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -74,9 +74,11 @@ files:
 - lib/signwell_sdk/models/checkbox_validation.rb
 - lib/signwell_sdk/models/copied_contact_info.rb
 - lib/signwell_sdk/models/date_format.rb
+- lib/signwell_sdk/models/error_response.rb
 - lib/signwell_sdk/models/field_type.rb
 - lib/signwell_sdk/models/file_info.rb
 - lib/signwell_sdk/models/label_info.rb
+- lib/signwell_sdk/models/rate_limit_error_response.rb
 - lib/signwell_sdk/models/text_validation.rb
 - lib/signwell_sdk/models/v1/api_application_delete_params.rb
 - lib/signwell_sdk/models/v1/api_application_retrieve_params.rb
@@ -115,6 +117,7 @@ files:
 - lib/signwell_sdk/models/v1/label.rb
 - lib/signwell_sdk/models/v1/template_checkbox_group.rb
 - lib/signwell_sdk/models/v1_me_params.rb
+- lib/signwell_sdk/models/validation_error_response.rb
 - lib/signwell_sdk/request_options.rb
 - lib/signwell_sdk/resources/v1.rb
 - lib/signwell_sdk/resources/v1/api_applications.rb
@@ -148,9 +151,11 @@ files:
 - rbi/signwell_sdk/models/checkbox_validation.rbi
 - rbi/signwell_sdk/models/copied_contact_info.rbi
 - rbi/signwell_sdk/models/date_format.rbi
+- rbi/signwell_sdk/models/error_response.rbi
 - rbi/signwell_sdk/models/field_type.rbi
 - rbi/signwell_sdk/models/file_info.rbi
 - rbi/signwell_sdk/models/label_info.rbi
+- rbi/signwell_sdk/models/rate_limit_error_response.rbi
 - rbi/signwell_sdk/models/text_validation.rbi
 - rbi/signwell_sdk/models/v1/api_application_delete_params.rbi
 - rbi/signwell_sdk/models/v1/api_application_retrieve_params.rbi
@@ -189,6 +194,7 @@ files:
 - rbi/signwell_sdk/models/v1/label.rbi
 - rbi/signwell_sdk/models/v1/template_checkbox_group.rbi
 - rbi/signwell_sdk/models/v1_me_params.rbi
+- rbi/signwell_sdk/models/validation_error_response.rbi
 - rbi/signwell_sdk/request_options.rbi
 - rbi/signwell_sdk/resources/v1.rbi
 - rbi/signwell_sdk/resources/v1/api_applications.rbi
@@ -221,9 +227,11 @@ files:
 - sig/signwell_sdk/models/checkbox_validation.rbs
 - sig/signwell_sdk/models/copied_contact_info.rbs
 - sig/signwell_sdk/models/date_format.rbs
+- sig/signwell_sdk/models/error_response.rbs
 - sig/signwell_sdk/models/field_type.rbs
 - sig/signwell_sdk/models/file_info.rbs
 - sig/signwell_sdk/models/label_info.rbs
+- sig/signwell_sdk/models/rate_limit_error_response.rbs
 - sig/signwell_sdk/models/text_validation.rbs
 - sig/signwell_sdk/models/v1/api_application_delete_params.rbs
 - sig/signwell_sdk/models/v1/api_application_retrieve_params.rbs
@@ -262,6 +270,7 @@ files:
 - sig/signwell_sdk/models/v1/label.rbs
 - sig/signwell_sdk/models/v1/template_checkbox_group.rbs
 - sig/signwell_sdk/models/v1_me_params.rbs
+- sig/signwell_sdk/models/validation_error_response.rbs
 - sig/signwell_sdk/request_options.rbs
 - sig/signwell_sdk/resources/v1.rbs
 - sig/signwell_sdk/resources/v1/api_applications.rbs