signwell_sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02022668207e2410908c334ca7275b7be0dfd46d5f7ce91cc55e50750d54cc21'
-  data.tar.gz: dd43d14eed3f775b98f32fb366fa065d72b6a00df29269c3d3170bd3dffcafe5
+  metadata.gz: 8da5e4f39a9d87d108d2a660d893f44770095c2ffd56d52f76e646f210126f35
+  data.tar.gz: 2433b13f13609027349df9576808961cfd4b11930e8059296f1edb43488a24bf
 SHA512:
-  metadata.gz: b539dbd329d0b71b137d48f0e0341da02085f8a7633421e91cff26180bd194a30bc2626e83ba1819c9e82fdd66abdc078f4f20ef9cc8108ba47fa548c5720dcd
-  data.tar.gz: c1ac5ffc4fc77bcc7d338225e54a7ce42e3446c513dd0d5a304c9a86f6f879d634999a398c25db2c973e197a012a196fba6dc9e6cc609702b57d09ccbd52bc7f
+  metadata.gz: acfaf3173484ff848427a9d527b0db6217050d8c26f59d2ef31d200fb62dfba1dcb759e916dba5a4a900782d87bc207759114e2a384a6353c378387496393128
+  data.tar.gz: '0130486e3b7e1fb47c64bbc1d5f32fad9593e430e3f04c19d0c9d2019728d983069286057e908adf99476c1a8a808d854455cb0261023c05860dc39d4329db4c'

data/CHANGELOG.md

@@ -1,39 +1 @@
 # 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)
-
-### Features
-
-* **api:** manual updates ([3b4115e](https://github.com/Bidsketch/signwell-sdk-ruby/commit/3b4115e027c60f02c39bc5247be4be9add609ed8))
-* **api:** manual updates ([bf265ec](https://github.com/Bidsketch/signwell-sdk-ruby/commit/bf265ece7a5077b8b4fb2e36133eb40c36637934))
-* **api:** manual updates ([45e11aa](https://github.com/Bidsketch/signwell-sdk-ruby/commit/45e11aac78f4ea11fd5ed45ae2ce569118f86a64))
-* **api:** manual updates ([c4a0bce](https://github.com/Bidsketch/signwell-sdk-ruby/commit/c4a0bce2891157aca149cfa0007a88f23d3cb36d))
-* **api:** manual updates ([41d87af](https://github.com/Bidsketch/signwell-sdk-ruby/commit/41d87aff206a12bead4a691b42cdbdcce2fd5926))
-* **api:** manual updates ([666e33f](https://github.com/Bidsketch/signwell-sdk-ruby/commit/666e33f5394e8d005e3eba38407e460daa4670b5))
-* **api:** manual updates ([bb88e1e](https://github.com/Bidsketch/signwell-sdk-ruby/commit/bb88e1e78efab1e855310feb0a039f0596ec1193))
-* **api:** manual updates ([1fa00b1](https://github.com/Bidsketch/signwell-sdk-ruby/commit/1fa00b1c42c8f473f3e784f9376ed7dd27b8cf0c))
-* **api:** manual updates ([9b167be](https://github.com/Bidsketch/signwell-sdk-ruby/commit/9b167be00f2d0275550ca019ae897a77c0d24142))
-
-
-### Chores
-
-* **docs:** remove www prefix ([2105144](https://github.com/Bidsketch/signwell-sdk-ruby/commit/2105144661cef53ed8045eaa9d07771f26c729ba))
-* **documents-api:** Removes nom151 from SDK Generation ([a608dda](https://github.com/Bidsketch/signwell-sdk-ruby/commit/a608dda6a026da7837a6ad087d94d627da7b31c4))
-* update SDK settings ([373d73c](https://github.com/Bidsketch/signwell-sdk-ruby/commit/373d73c6b7cfc95073dd7b3a3d41d0b80d3e790c))

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -1,400 +1,193 @@
-# Signwell SDK Ruby API library
+# signwell_sdk
 
-The Signwell SDK Ruby library provides convenient access to the Signwell SDK REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Bidsketch/signwell-sdk-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+SignWell - the Ruby gem for the SignWell Developer API
 
-It is generated with [Stainless](https://www.stainless.com/).
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-## Documentation
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-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/).
+- API version: v1
+- Package version: 0.1.0
+- Generator version: 7.12.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
 
-To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
-
-<!-- x-release-please-start-version -->
-
-```ruby
-gem "signwell_sdk", "~> 0.1.0.pre.alpha.2"
-```
-
-<!-- x-release-please-end -->
-
-## Usage
-
-```ruby
-require "bundler/setup"
-require "signwell_sdk"
-
-signwell_sdk = SignwellSDK::Client.new(
-  api_key: ENV["SIGNWELL_SDK_API_KEY"] # This is the default and can be omitted
-)
-
-document = signwell_sdk.v1.documents.create(
-  files: [{name: "employment_agreement.pdf", file_url: "https://example.com/documents/employment_agreement.pdf"}],
-  recipients: [
-    {id: "1", name: "John Doe", email: "john.doe@example.com"},
-    {id: "2", name: "HR Manager", email: "hr@company.com"}
-  ],
-  allow_decline: true,
-  apply_signing_order: true,
-  copied_contacts: [{name: "Legal Department", email: "legal@company.com"}],
-  decline_redirect_url: "https://example.com/signing-declined",
-  expires_in: 14,
-  fields: [
-    [
-      {x: 150, y: 600, page: 1, recipient_id: "1", type: "signature", required: true, api_id: "employee_signature"},
-      {x: 150, y: 650, page: 1, recipient_id: "1", type: "date", required: true, label: "Date Signed"},
-      {x: 400, y: 600, page: 1, recipient_id: "2", type: "signature", required: true, api_id: "hr_signature"}
-    ]
-  ],
-  message: "Hi John,\n\nPlease review and sign the attached employment agreement at your earliest convenience.\n\nBest regards,\nHR Team",
-  metadata: {employee_id: "EMP-2024-001", department: "Engineering", contract_type: "full_time"},
-  name: "Employment Agreement - John Doe",
-  redirect_url: "https://example.com/signing-complete",
-  reminders: true,
-  subject: "Action Required: Please sign your Employment Agreement",
-  test_mode: true
-)
-
-puts(document.id)
-```
-
-### Handling errors
-
-When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `SignwellSDK::Errors::APIError` will be thrown:
-
-```ruby
-begin
-  document = signwell_sdk.v1.documents.list
-rescue SignwellSDK::Errors::APIConnectionError => e
-  puts("The server could not be reached")
-  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
-rescue SignwellSDK::Errors::RateLimitError => e
-  puts("A 429 status code was received; we should back off a bit.")
-rescue SignwellSDK::Errors::APIStatusError => e
-  puts("Another non-200-range status code was received")
-  puts(e.status)
-end
-```
-
-Error codes are as follows:
-
-| Cause            | Error Type                 |
-| ---------------- | -------------------------- |
-| HTTP 400         | `BadRequestError`          |
-| HTTP 401         | `AuthenticationError`      |
-| HTTP 403         | `PermissionDeniedError`    |
-| HTTP 404         | `NotFoundError`            |
-| HTTP 409         | `ConflictError`            |
-| HTTP 422         | `UnprocessableEntityError` |
-| HTTP 429         | `RateLimitError`           |
-| HTTP >= 500      | `InternalServerError`      |
-| Other HTTP error | `APIStatusError`           |
-| Timeout          | `APITimeoutError`          |
-| Network error    | `APIConnectionError`       |
-
-### Retries
-
-Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
-
-Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
-
-You can use the `max_retries` option to configure or disable this:
-
-```ruby
-# Configure the default for all requests:
-signwell_sdk = SignwellSDK::Client.new(
-  max_retries: 0 # default is 2
-)
-
-# Or, configure per-request:
-signwell_sdk.v1.documents.list(request_options: {max_retries: 5})
-```
-
-### Timeouts
-
-By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
-
-```ruby
-# Configure the default for all requests:
-signwell_sdk = SignwellSDK::Client.new(
-  timeout: nil # default is 60
-)
-
-# Or, configure per-request:
-signwell_sdk.v1.documents.list(request_options: {timeout: 5})
-```
-
-On timeout, `SignwellSDK::Errors::APITimeoutError` is raised.
-
-Note that requests that time out are retried by default.
-
-## Advanced concepts
-
-### BaseModel
-
-All parameter and response objects inherit from `SignwellSDK::Internal::Type::BaseModel`, which provides several conveniences, including:
-
-1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
-
-2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+### Build a gem
 
-3. Both instances and the classes themselves can be pretty-printed.
+To build the Ruby code into a gem:
 
-4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
-
-### Making custom or undocumented requests
-
-#### Undocumented properties
-
-You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
-
-Note: the `extra_` parameters of the same name overrides the documented parameters.
-
-```ruby
-documents =
-  signwell_sdk.v1.documents.list(
-    request_options: {
-      extra_query: {my_query_parameter: value},
-      extra_body: {my_body_parameter: value},
-      extra_headers: {"my-header": value}
-    }
-  )
-
-puts(documents[:my_undocumented_property])
+```shell
+gem build signwell_sdk.gemspec
 ```
 
-#### Undocumented request params
-
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
-
-#### Undocumented endpoints
+Then either install the gem locally:
 
-To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
-
-```ruby
-response = client.request(
-  method: :post,
-  path: '/undocumented/endpoint',
-  query: {"dog": "woof"},
-  headers: {"useful-header": "interesting-value"},
-  body: {"hello": "world"}
-)
+```shell
+gem install ./signwell_sdk-0.1.0.gem
 ```
 
-### Concurrency & connection pooling
+(for development, run `gem install --dev ./signwell_sdk-0.1.0.gem` to install the development dependencies)
 
-The `SignwellSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-Each instance of `SignwellSDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+Finally add this to the Gemfile:
 
-When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+    gem 'signwell_sdk', '~> 0.1.0'
 
-Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+### Install from Git
 
-## Sorbet
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
 
-This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+    gem 'signwell_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
-You can provide typesafe request parameters like so:
-
-```ruby
-signwell_sdk.v1.documents.create(
-  files: [
-    SignwellSDK::V1::DocumentFile.new(
-      name: "employment_agreement.pdf",
-      file_url: "https://example.com/documents/employment_agreement.pdf"
-    )
-  ],
-  recipients: [
-    SignwellSDK::V1::DocumentCreateParams::Recipient.new(
-      id: "1",
-      name: "John Doe",
-      email: "john.doe@example.com"
-    ),
-    SignwellSDK::V1::DocumentCreateParams::Recipient.new(id: "2", name: "HR Manager", email: "hr@company.com")
-  ],
-  allow_decline: true,
-  apply_signing_order: true,
-  copied_contacts: [SignwellSDK::V1::CopiedContact.new(name: "Legal Department", email: "legal@company.com")],
-  decline_redirect_url: "https://example.com/signing-declined",
-  expires_in: 14,
-  fields: [
-    [
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 150,
-        y_: 600,
-        page: 1,
-        recipient_id: "1",
-        type: "signature",
-        required: true,
-        api_id: "employee_signature"
-      ),
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 150,
-        y_: 650,
-        page: 1,
-        recipient_id: "1",
-        type: "date",
-        required: true,
-        label: "Date Signed"
-      ),
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 400,
-        y_: 600,
-        page: 1,
-        recipient_id: "2",
-        type: "signature",
-        required: true,
-        api_id: "hr_signature"
-      )
-    ]
-  ],
-  message: "Hi John,\n\nPlease review and sign the attached employment agreement at your earliest convenience.\n\nBest regards,\nHR Team",
-  metadata: {employee_id: "EMP-2024-001", department: "Engineering", contract_type: "full_time"},
-  name: "Employment Agreement - John Doe",
-  redirect_url: "https://example.com/signing-complete",
-  reminders: true,
-  subject: "Action Required: Please sign your Employment Agreement",
-  test_mode: true
-)
-```
+### Include the Ruby code directly
 
-Or, equivalently:
+Include the Ruby code directly using `-I` as follows:
 
-```ruby
-# Hashes work, but are not typesafe:
-signwell_sdk.v1.documents.create(
-  files: [{name: "employment_agreement.pdf", file_url: "https://example.com/documents/employment_agreement.pdf"}],
-  recipients: [
-    {id: "1", name: "John Doe", email: "john.doe@example.com"},
-    {id: "2", name: "HR Manager", email: "hr@company.com"}
-  ],
-  allow_decline: true,
-  apply_signing_order: true,
-  copied_contacts: [{name: "Legal Department", email: "legal@company.com"}],
-  decline_redirect_url: "https://example.com/signing-declined",
-  expires_in: 14,
-  fields: [
-    [
-      {x: 150, y: 600, page: 1, recipient_id: "1", type: "signature", required: true, api_id: "employee_signature"},
-      {x: 150, y: 650, page: 1, recipient_id: "1", type: "date", required: true, label: "Date Signed"},
-      {x: 400, y: 600, page: 1, recipient_id: "2", type: "signature", required: true, api_id: "hr_signature"}
-    ]
-  ],
-  message: "Hi John,\n\nPlease review and sign the attached employment agreement at your earliest convenience.\n\nBest regards,\nHR Team",
-  metadata: {employee_id: "EMP-2024-001", department: "Engineering", contract_type: "full_time"},
-  name: "Employment Agreement - John Doe",
-  redirect_url: "https://example.com/signing-complete",
-  reminders: true,
-  subject: "Action Required: Please sign your Employment Agreement",
-  test_mode: true
-)
-
-# You can also splat a full Params class:
-params = SignwellSDK::V1::DocumentCreateParams.new(
-  files: [
-    SignwellSDK::V1::DocumentFile.new(
-      name: "employment_agreement.pdf",
-      file_url: "https://example.com/documents/employment_agreement.pdf"
-    )
-  ],
-  recipients: [
-    SignwellSDK::V1::DocumentCreateParams::Recipient.new(
-      id: "1",
-      name: "John Doe",
-      email: "john.doe@example.com"
-    ),
-    SignwellSDK::V1::DocumentCreateParams::Recipient.new(id: "2", name: "HR Manager", email: "hr@company.com")
-  ],
-  allow_decline: true,
-  apply_signing_order: true,
-  copied_contacts: [SignwellSDK::V1::CopiedContact.new(name: "Legal Department", email: "legal@company.com")],
-  decline_redirect_url: "https://example.com/signing-declined",
-  expires_in: 14,
-  fields: [
-    [
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 150,
-        y_: 600,
-        page: 1,
-        recipient_id: "1",
-        type: "signature",
-        required: true,
-        api_id: "employee_signature"
-      ),
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 150,
-        y_: 650,
-        page: 1,
-        recipient_id: "1",
-        type: "date",
-        required: true,
-        label: "Date Signed"
-      ),
-      SignwellSDK::V1::DocumentCreateParams::Field.new(
-        x: 400,
-        y_: 600,
-        page: 1,
-        recipient_id: "2",
-        type: "signature",
-        required: true,
-        api_id: "hr_signature"
-      )
-    ]
-  ],
-  message: "Hi John,\n\nPlease review and sign the attached employment agreement at your earliest convenience.\n\nBest regards,\nHR Team",
-  metadata: {employee_id: "EMP-2024-001", department: "Engineering", contract_type: "full_time"},
-  name: "Employment Agreement - John Doe",
-  redirect_url: "https://example.com/signing-complete",
-  reminders: true,
-  subject: "Action Required: Please sign your Employment Agreement",
-  test_mode: true
-)
-signwell_sdk.v1.documents.create(**params)
+```shell
+ruby -Ilib script.rb
 ```
 
-### Enums
+## Getting Started
 
-Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+Please follow the [installation](#installation) procedure and then run the following code:
 
 ```ruby
-# :pdf
-puts(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::PDF)
+# Load the gem
+require 'signwell_sdk'
+
+# Setup authorization
+SignWell.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Api-Key'] = 'Bearer'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
 
-# Revealed type: `T.all(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat, Symbol)`
-T.reveal_type(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::PDF)
-```
+api_instance = SignWell::APIApplicationApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 
-Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+begin
+  #Delete API Application
+  api_instance.delete_api_application(id)
+rescue SignWell::ApiError => e
+  puts "Exception when calling APIApplicationApi->delete_api_application: #{e}"
+end
 
-```ruby
-# Using the enum constants preserves the tagged type information:
-signwell_sdk.v1.documents.retrieve_completed_pdf(
-  file_format: SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::PDF,
-  # …
-)
-
-# Literal values are also permissible:
-signwell_sdk.v1.documents.retrieve_completed_pdf(
-  file_format: :pdf,
-  # …
-)
 ```
 
-## Versioning
-
-This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
-
-This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
-
-## Requirements
-
-Ruby 3.2.0 or higher.
-
-## Contributing
+## Documentation for API Endpoints
+
+All URIs are relative to *https://www.signwell.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SignWell::APIApplicationApi* | [**delete_api_application**](docs/APIApplicationApi.md#delete_api_application) | **DELETE** /api/v1/api_applications/{id} | Delete API Application
+*SignWell::APIApplicationApi* | [**get_api_application**](docs/APIApplicationApi.md#get_api_application) | **GET** /api/v1/api_applications/{id} | Get API Application
+*SignWell::BulkSendApi* | [**create_bulk_send**](docs/BulkSendApi.md#create_bulk_send) | **POST** /api/v1/bulk_sends | Create Bulk Send
+*SignWell::BulkSendApi* | [**get_bulk_send**](docs/BulkSendApi.md#get_bulk_send) | **GET** /api/v1/bulk_sends/{id} | Get Bulk Send
+*SignWell::BulkSendApi* | [**get_bulk_send_csv_template**](docs/BulkSendApi.md#get_bulk_send_csv_template) | **GET** /api/v1/bulk_sends/csv_template | Get Bulk Send CSV Template
+*SignWell::BulkSendApi* | [**get_bulk_send_documents**](docs/BulkSendApi.md#get_bulk_send_documents) | **GET** /api/v1/bulk_sends/{id}/documents | Get Bulk Send Documents
+*SignWell::BulkSendApi* | [**list_bulk_sends**](docs/BulkSendApi.md#list_bulk_sends) | **GET** /api/v1/bulk_sends | List Bulk Sendings
+*SignWell::BulkSendApi* | [**validate_bulk_send_csv**](docs/BulkSendApi.md#validate_bulk_send_csv) | **POST** /api/v1/bulk_sends/validate_csv | Validate Bulk Send CSV
+*SignWell::DocumentApi* | [**create_document**](docs/DocumentApi.md#create_document) | **POST** /api/v1/documents | Create Document
+*SignWell::DocumentApi* | [**create_document_from_template**](docs/DocumentApi.md#create_document_from_template) | **POST** /api/v1/document_templates/documents | Create Document from Template
+*SignWell::DocumentApi* | [**delete_document**](docs/DocumentApi.md#delete_document) | **DELETE** /api/v1/documents/{id} | Delete Document
+*SignWell::DocumentApi* | [**get_completed_pdf**](docs/DocumentApi.md#get_completed_pdf) | **GET** /api/v1/documents/{id}/completed_pdf | Completed PDF
+*SignWell::DocumentApi* | [**get_document**](docs/DocumentApi.md#get_document) | **GET** /api/v1/documents/{id} | Get Document
+*SignWell::DocumentApi* | [**send_document**](docs/DocumentApi.md#send_document) | **POST** /api/v1/documents/{id}/send | Update and Send Document
+*SignWell::DocumentApi* | [**send_reminder**](docs/DocumentApi.md#send_reminder) | **POST** /api/v1/documents/{id}/remind | Send Reminder
+*SignWell::MeApi* | [**get_me**](docs/MeApi.md#get_me) | **GET** /api/v1/me | Get credentials
+*SignWell::TemplateApi* | [**create_template**](docs/TemplateApi.md#create_template) | **POST** /api/v1/document_templates | Create Template
+*SignWell::TemplateApi* | [**delete_template**](docs/TemplateApi.md#delete_template) | **DELETE** /api/v1/document_templates/{id} | Delete Template
+*SignWell::TemplateApi* | [**get_template**](docs/TemplateApi.md#get_template) | **GET** /api/v1/document_templates/{id} | Get Template
+*SignWell::TemplateApi* | [**update_template**](docs/TemplateApi.md#update_template) | **PUT** /api/v1/document_templates/{id} | Update Template
+*SignWell::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /api/v1/hooks | Create Webhook
+*SignWell::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /api/v1/hooks/{id} | Delete Webhook
+*SignWell::WebhooksApi* | [**list_webhooks**](docs/WebhooksApi.md#list_webhooks) | **GET** /api/v1/hooks | List Webhooks
+
+
+## Documentation for Models
+
+ - [SignWell::AdditionalFieldsInnerInner](docs/AdditionalFieldsInnerInner.md)
+ - [SignWell::AdditionalFieldsInnerInnerValue](docs/AdditionalFieldsInnerInnerValue.md)
+ - [SignWell::AdditionalFilesInner](docs/AdditionalFilesInner.md)
+ - [SignWell::AttachmentRequestInfo](docs/AttachmentRequestInfo.md)
+ - [SignWell::AttachmentRequestsInner](docs/AttachmentRequestsInner.md)
+ - [SignWell::BulkSendCsvRequest](docs/BulkSendCsvRequest.md)
+ - [SignWell::CheckboxGroupInfo](docs/CheckboxGroupInfo.md)
+ - [SignWell::CheckboxGroupsInner](docs/CheckboxGroupsInner.md)
+ - [SignWell::CheckboxValidation](docs/CheckboxValidation.md)
+ - [SignWell::CompletedPdfUrlResponse](docs/CompletedPdfUrlResponse.md)
+ - [SignWell::CopiedContactInfo](docs/CopiedContactInfo.md)
+ - [SignWell::CopiedContactsInner](docs/CopiedContactsInner.md)
+ - [SignWell::CopiedPlaceholdersInner](docs/CopiedPlaceholdersInner.md)
+ - [SignWell::CreateBulkSendRequest](docs/CreateBulkSendRequest.md)
+ - [SignWell::CreateWebhookRequest](docs/CreateWebhookRequest.md)
+ - [SignWell::DateFormat](docs/DateFormat.md)
+ - [SignWell::DetailedOption](docs/DetailedOption.md)
+ - [SignWell::DocumentFromTemplateRequest](docs/DocumentFromTemplateRequest.md)
+ - [SignWell::DocumentFromTemplateResponse](docs/DocumentFromTemplateResponse.md)
+ - [SignWell::DocumentFromTemplateResponseFieldsInnerInner](docs/DocumentFromTemplateResponseFieldsInnerInner.md)
+ - [SignWell::DocumentFromTemplateResponseFieldsInnerInnerRecipient](docs/DocumentFromTemplateResponseFieldsInnerInnerRecipient.md)
+ - [SignWell::DocumentFromTemplateResponseRecipientsInner](docs/DocumentFromTemplateResponseRecipientsInner.md)
+ - [SignWell::DocumentListResponse](docs/DocumentListResponse.md)
+ - [SignWell::DocumentRequest](docs/DocumentRequest.md)
+ - [SignWell::DocumentResponse](docs/DocumentResponse.md)
+ - [SignWell::DocumentResponseAttachmentRequestsInner](docs/DocumentResponseAttachmentRequestsInner.md)
+ - [SignWell::DocumentResponseFieldsInnerInner](docs/DocumentResponseFieldsInnerInner.md)
+ - [SignWell::DocumentResponseFieldsInnerInnerOptionsInner](docs/DocumentResponseFieldsInnerInnerOptionsInner.md)
+ - [SignWell::DocumentResponseFieldsInnerInnerRecipient](docs/DocumentResponseFieldsInnerInnerRecipient.md)
+ - [SignWell::DocumentResponseFieldsInnerInnerValue](docs/DocumentResponseFieldsInnerInnerValue.md)
+ - [SignWell::DocumentResponseRecipientsInner](docs/DocumentResponseRecipientsInner.md)
+ - [SignWell::DocumentTemplateListResponse](docs/DocumentTemplateListResponse.md)
+ - [SignWell::DocumentTemplateRequest](docs/DocumentTemplateRequest.md)
+ - [SignWell::DocumentTemplateResponse](docs/DocumentTemplateResponse.md)
+ - [SignWell::DocumentTemplateResponseCopiedPlaceholdersInner](docs/DocumentTemplateResponseCopiedPlaceholdersInner.md)
+ - [SignWell::DocumentTemplateResponsePlaceholdersInner](docs/DocumentTemplateResponsePlaceholdersInner.md)
+ - [SignWell::DocumentTemplateUpdateRequest](docs/DocumentTemplateUpdateRequest.md)
+ - [SignWell::DropdownOption](docs/DropdownOption.md)
+ - [SignWell::ErrorResponse](docs/ErrorResponse.md)
+ - [SignWell::ErrorResponseMeta](docs/ErrorResponseMeta.md)
+ - [SignWell::FieldType](docs/FieldType.md)
+ - [SignWell::FieldsInnerInner](docs/FieldsInnerInner.md)
+ - [SignWell::FileFormat](docs/FileFormat.md)
+ - [SignWell::FileInfo](docs/FileInfo.md)
+ - [SignWell::FilesInner](docs/FilesInner.md)
+ - [SignWell::LabelInfo](docs/LabelInfo.md)
+ - [SignWell::LabelRequest](docs/LabelRequest.md)
+ - [SignWell::LabelResponse](docs/LabelResponse.md)
+ - [SignWell::Nom151CertificateResponse](docs/Nom151CertificateResponse.md)
+ - [SignWell::Nom151CertificateResponseNom151](docs/Nom151CertificateResponseNom151.md)
+ - [SignWell::Nom151UrlResponse](docs/Nom151UrlResponse.md)
+ - [SignWell::PaginationMeta](docs/PaginationMeta.md)
+ - [SignWell::PlaceholdersInner](docs/PlaceholdersInner.md)
+ - [SignWell::RateLimitErrorResponse](docs/RateLimitErrorResponse.md)
+ - [SignWell::RecipientsInner](docs/RecipientsInner.md)
+ - [SignWell::ReminderRecipientsInner](docs/ReminderRecipientsInner.md)
+ - [SignWell::SendReminderRequest](docs/SendReminderRequest.md)
+ - [SignWell::TemplateAttachmentRequestsInner](docs/TemplateAttachmentRequestsInner.md)
+ - [SignWell::TemplateCheckboxGroupsInner](docs/TemplateCheckboxGroupsInner.md)
+ - [SignWell::TemplateFieldValuesInner](docs/TemplateFieldValuesInner.md)
+ - [SignWell::TemplateFieldValuesInnerValue](docs/TemplateFieldValuesInnerValue.md)
+ - [SignWell::TemplateFieldsInnerInner](docs/TemplateFieldsInnerInner.md)
+ - [SignWell::TemplateRecipientsInner](docs/TemplateRecipientsInner.md)
+ - [SignWell::TextValidation](docs/TextValidation.md)
+ - [SignWell::UpdateDocumentAndSendRequest](docs/UpdateDocumentAndSendRequest.md)
+ - [SignWell::ValidationErrorResponse](docs/ValidationErrorResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### api_key
+
+
+- **Type**: API key
+- **API key parameter name**: X-Api-Key
+- **Location**: HTTP header
 
-See [the contributing documentation](https://github.com/Bidsketch/signwell-sdk-ruby/tree/main/CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end