signwell_sdk 0.0.1.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60864cf9015af7d0f2b8c1c4b7a3a484e1e0cb933b56c3e0643c2db476d892b9
+  data.tar.gz: adea91d15c788f95bd8963cb429ef1e334daac1589f46cf95d767cc2fad70374
+SHA512:
+  metadata.gz: 70b29469727a352851861ff5deb8f36d7f0e88cd3d57e1de6ade1f889a4f56d2e941486395cf7483892e3638bcf3a6db3016b3a1bec69486dcde4740e8bc6ee8
+  data.tar.gz: 106a2e69133c45d2ef4f17d42a0fa6fcd0776553164cb521feac6f02e65440c6593d519da7f899897401748e11de001d64f7a995d3f53a7c7b23fd33c9376d3a

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 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/README.md

@@ -0,0 +1,398 @@
+# Signwell SDK Ruby API library
+
+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.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/signwell_sdk).
+
+## 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.0.1.pre.alpha.1"
+```
+
+<!-- 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.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+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])
+```
+
+#### 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
+
+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"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `SignwellSDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+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.
+
+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.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+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
+)
+```
+
+Or, equivalently:
+
+```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)
+```
+
+### Enums
+
+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:
+
+```ruby
+# :pdf
+puts(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::PDF)
+
+# Revealed type: `T.all(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat, Symbol)`
+T.reveal_type(SignwellSDK::V1::DocumentRetrieveCompletedPdfParams::FileFormat::PDF)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```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
+
+See [the contributing documentation](https://github.com/Bidsketch/signwell-sdk-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+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.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/signwell_sdk/client.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module SignwellSDK
+  class Client < SignwellSDK::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [SignwellSDK::Resources::V1]
+    attr_reader :v1
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      {"x-api-key" => @api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["SIGNWELL_SDK_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["SIGNWELL_SDK_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["SIGNWELL_SDK_API_KEY"],
+      base_url: ENV["SIGNWELL_SDK_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://www.signwell.com"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"SIGNWELL_SDK_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @v1 = SignwellSDK::Resources::V1.new(client: self)
+    end
+  end
+end