boldsign 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0a4d128418d45a484979b044ce83a9e868ef1a142145962ec0580b0f34f4e20
+  data.tar.gz: 4ee136cc02d3020b4beb1e70d614929de07f0f64e7965d8e0742a3e74cb0b893
+SHA512:
+  metadata.gz: 486cb527ac17cef2ddcf9505a5a2bfe59b3736ee75d9e9b8778344c16a8b6c0e5795d17f5fa7d739fb87f6dc70e1e353fea13929e4303ab8abf1c08adf66e792
+  data.tar.gz: 79edff344004bd59f868a44b6812c1c16bfa922823d0a16eaf28be54f970714b75c16d19be411e6ea175d37b4de8e7ab7bcc30b75da592ade64c49a7afbd9a12

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] — 2026-05-22
+
+### Added
+- Initial release.
+- `Boldsign::Client` covering all 84 endpoints of the BoldSign v1 REST API
+  across 11 resource groups: documents, templates, contacts, contact groups,
+  custom fields, sender identities, brands, teams, users, identity
+  verification, and plan info.
+- Region support (`:us`, `:eu`, `:ca`, `:au`) plus explicit base-URL override.
+- Typed error hierarchy mapped from HTTP status codes.
+- YARD documentation for the public API.
+- 100% line and branch test coverage enforced via SimpleCov.
+- GitHub Actions CI on Ruby 3.4 and 4.0.
+
+[Unreleased]: https://github.com/kleinjm/boldsign-ruby/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/kleinjm/boldsign-ruby/releases/tag/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 James Klein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# boldsign-ruby
+
+[![CI](https://github.com/kleinjm/boldsign-ruby/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kleinjm/boldsign-ruby/actions/workflows/ci.yml)
+[![API docs](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://rubydoc.info/github/kleinjm/boldsign-ruby/main)
+
+A Ruby client for the [BoldSign](https://developers.boldsign.com/) e-signature API.
+
+Wraps every public endpoint of the BoldSign v1 REST API: documents, templates,
+contacts, contact groups, custom fields, sender identities, brands, teams,
+users, identity verification, and plan info.
+
+## Installation
+
+```ruby
+gem "boldsign"
+```
+
+## Configuration
+
+```ruby
+Boldsign.configure do |c|
+  c.api_key = ENV["BOLDSIGN_API_KEY"]
+  c.region  = :us   # :us, :eu, :ca, :au  (or set c.base_url directly)
+end
+```
+
+Or instantiate a client directly:
+
+```ruby
+client = Boldsign::Client.new(api_key: "…", region: :us)
+```
+
+Region base URLs:
+
+| Region | URL |
+| ------ | --- |
+| `:us`  | `https://api.boldsign.com` |
+| `:eu`  | `https://api-eu.boldsign.com` |
+| `:ca`  | `https://api-ca.boldsign.com` |
+| `:au`  | `https://api-au.boldsign.com` |
+
+## Usage
+
+```ruby
+client = Boldsign.client
+
+# Send a document
+client.documents.send_document(
+  title: "NDA",
+  signers: [{ name: "Jane Doe", emailAddress: "jane@example.com", signerOrder: 1 }],
+  files: [...] # see BoldSign docs for the full schema
+)
+
+# List documents
+client.documents.list(page: 1, pageSize: 50)
+
+# Properties / download
+client.documents.properties("DOCUMENT_ID")
+File.binwrite("signed.pdf", client.documents.download("DOCUMENT_ID"))
+
+# Templates
+client.templates.list
+client.templates.send_template("TEMPLATE_ID", roles: [...])
+
+# Contacts / contact groups
+client.contacts.create(contacts: [{ name: "Jane", emailAddress: "jane@example.com" }])
+client.contact_groups.list
+
+# Users & teams
+client.users.list
+client.teams.create(teamName: "Sales")
+
+# Brands
+client.brand.list
+
+# Plan
+client.plan.api_credits_count
+```
+
+## Resources & methods
+
+Each resource on `Boldsign::Client` maps to a group of BoldSign endpoints:
+
+| Accessor | Methods |
+| -------- | ------- |
+| `client.documents` | `list`, `team_list`, `behalf_list`, `properties`, `send_document`, `draft_send`, `edit`, `cancel_editing`, `create_embedded_request_url`, `create_embedded_edit_url`, `get_embedded_sign_link`, `download`, `download_attachment`, `download_audit_log`, `revoke`, `remind`, `delete`, `extend_expiry`, `change_access_code`, `change_recipient`, `add_tags`, `delete_tags`, `add_authentication`, `remove_authentication`, `prefill_fields` |
+| `client.templates` | `list`, `properties`, `download`, `create`, `edit`, `delete`, `send_template`, `merge_and_send`, `create_embedded_template_url`, `get_embedded_template_edit_url`, `create_embedded_request_url`, `merge_create_embedded_request_url`, `create_embedded_preview_url`, `add_tags`, `delete_tags` |
+| `client.contacts` | `list`, `get`, `create`, `update`, `delete` |
+| `client.contact_groups` | `list`, `get`, `create`, `update`, `delete` |
+| `client.custom_fields` | `list`, `create`, `edit`, `delete`, `create_embedded_url` |
+| `client.sender_identities` | `list`, `properties`, `create`, `update`, `delete`, `resend_invitation`, `rerequest` |
+| `client.brand` | `list`, `get`, `create`, `edit`, `delete`, `reset_default` |
+| `client.teams` | `list`, `get`, `create`, `update` |
+| `client.users` | `list`, `get`, `create`, `update`, `update_metadata`, `change_team`, `resend_invitation`, `cancel_invitation` |
+| `client.identity_verification` | `report`, `image`, `create_embedded_url` |
+| `client.plan` | `api_credits_count` |
+
+All methods accept Ruby hashes (with camelCase keys matching the BoldSign API)
+and return parsed JSON. Binary endpoints (`download*`) return raw bytes.
+
+## Errors
+
+HTTP errors raise a typed subclass of `Boldsign::Error`:
+
+`BadRequestError` (400), `AuthenticationError` (401), `ForbiddenError` (403),
+`NotFoundError` (404), `UnprocessableEntityError` (422), `RateLimitError` (429),
+`ServerError` (5xx). Each carries `#status`, `#body`, and `#response`.
+
+## Documentation
+
+Full YARD API documentation is auto-built and hosted at
+[rubydoc.info/github/kleinjm/boldsign-ruby/main](https://rubydoc.info/github/kleinjm/boldsign-ruby/main).
+
+To generate locally:
+
+```sh
+bundle exec yard doc
+open doc/index.html
+```
+
+## Development
+
+```sh
+bundle install
+bundle exec rspec        # run tests (enforces 100% line + branch coverage)
+bundle exec yard doc     # build local API docs to ./doc
+```
+
+## License
+
+MIT

data/boldsign.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/boldsign/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "boldsign"
+  spec.version     = Boldsign::VERSION
+  spec.authors     = ["James Klein"]
+  spec.email       = ["kleinjm007@gmail.com"]
+
+  spec.summary     = "Ruby client for the BoldSign e-signature API"
+  spec.description = "A Ruby wrapper for the BoldSign REST API (documents, templates, " \
+                     "contacts, teams, brands, webhooks, and more)."
+  spec.homepage    = "https://github.com/kleinjm/boldsign-ruby"
+  spec.license     = "MIT"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = spec.homepage
+  spec.metadata["changelog_uri"]     = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"]   = "#{spec.homepage}/issues"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/boldsign"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir["lib/**/*.rb", "README.md", "CHANGELOG.md", "LICENSE.txt", "boldsign.gemspec"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 2.0"
+  spec.add_dependency "faraday-multipart", ">= 1.0"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "webmock", "~> 3.19"
+end

data/lib/boldsign/client.rb

@@ -0,0 +1,171 @@
+module Boldsign
+  # HTTP client for the BoldSign REST API.
+  #
+  # Holds API credentials and exposes one accessor per resource group
+  # (`documents`, `templates`, `contacts`, …). Each accessor returns a memoized
+  # resource object whose methods wrap individual endpoints.
+  #
+  # Low-level verb methods ({#get}, {#post}, {#put}, {#patch}, {#delete},
+  # {#download}) are also available for hitting any endpoint directly.
+  #
+  # @example
+  #   client = Boldsign::Client.new(api_key: ENV["BOLDSIGN_API_KEY"], region: :us)
+  #   client.documents.send_document(title: "NDA", signers: [...])
+  class Client
+    # Default region (US).
+    DEFAULT_BASE_URL = "https://api.boldsign.com".freeze
+
+    # User-Agent header value sent on every request.
+    USER_AGENT = "boldsign-ruby/#{Boldsign::VERSION}".freeze
+
+    # @return [String] the API key in use.
+    attr_reader :api_key
+
+    # @return [String] the resolved base URL (region or explicit override).
+    attr_reader :base_url
+
+    # @param api_key [String, nil] BoldSign API key. Falls back to `ENV["BOLDSIGN_API_KEY"]`.
+    # @param region [Symbol, nil] One of `:us`, `:eu`, `:ca`, `:au`. Ignored if `base_url` is given.
+    # @param base_url [String, nil] Explicit base URL override.
+    # @param adapter [Symbol] Faraday adapter (defaults to `Faraday.default_adapter`).
+    # @param logger [Logger, nil] Optional logger; when present, Faraday's logger middleware is enabled.
+    # @raise [ConfigurationError] when no API key is available.
+    def initialize(api_key: nil, region: nil, base_url: nil, adapter: Faraday.default_adapter, logger: nil)
+      @api_key = api_key || ENV["BOLDSIGN_API_KEY"]
+      raise ConfigurationError, "Missing BoldSign API key" if @api_key.nil? || @api_key.empty?
+
+      @base_url = base_url || Boldsign::REGIONS[region&.to_sym] || DEFAULT_BASE_URL
+      @adapter = adapter
+      @logger = logger
+    end
+
+    # @return [Resources::Brand]
+    def brand;                 @brand ||= Resources::Brand.new(self); end
+    # @return [Resources::Contact]
+    def contacts;              @contacts ||= Resources::Contact.new(self); end
+    # @return [Resources::ContactGroup]
+    def contact_groups;        @contact_groups ||= Resources::ContactGroup.new(self); end
+    # @return [Resources::CustomField]
+    def custom_fields;         @custom_fields ||= Resources::CustomField.new(self); end
+    # @return [Resources::Document]
+    def documents;             @documents ||= Resources::Document.new(self); end
+    # @return [Resources::IdentityVerification]
+    def identity_verification; @identity_verification ||= Resources::IdentityVerification.new(self); end
+    # @return [Resources::Plan]
+    def plan;                  @plan ||= Resources::Plan.new(self); end
+    # @return [Resources::SenderIdentity]
+    def sender_identities;     @sender_identities ||= Resources::SenderIdentity.new(self); end
+    # @return [Resources::Team]
+    def teams;                 @teams ||= Resources::Team.new(self); end
+    # @return [Resources::Template]
+    def templates;             @templates ||= Resources::Template.new(self); end
+    # @return [Resources::User]
+    def users;                 @users ||= Resources::User.new(self); end
+
+    # Issue a GET request.
+    # @param path [String] request path (e.g. `/v1/document/list`).
+    # @param params [Hash] query string parameters.
+    # @return [Hash, Array, String, nil] parsed JSON body, or raw body for non-JSON responses.
+    # @raise [Error] on any non-success HTTP status.
+    def get(path, params = {})
+      request(:get, path, params: params)
+    end
+
+    # Issue a POST request.
+    # @param path [String] request path.
+    # @param body [Hash, String, nil] request body. Hashes are JSON-encoded;
+    #   pre-serialized JSON strings are sent as-is.
+    # @param params [Hash] query string parameters.
+    # @param multipart [Boolean] when `true`, body is sent as `multipart/form-data`
+    #   (include `Faraday::Multipart::FilePart` values to upload files).
+    # @return [Hash, Array, String, nil]
+    # @raise [Error] on any non-success HTTP status.
+    def post(path, body: nil, params: {}, multipart: false)
+      request(:post, path, body: body, params: params, multipart: multipart)
+    end
+
+    # Issue a PUT request. See {#post} for parameter semantics.
+    def put(path, body: nil, params: {})
+      request(:put, path, body: body, params: params)
+    end
+
+    # Issue a PATCH request. See {#post} for parameter semantics.
+    def patch(path, body: nil, params: {})
+      request(:patch, path, body: body, params: params)
+    end
+
+    # Issue a DELETE request.
+    # @param path [String] request path.
+    # @param params [Hash] query string parameters.
+    def delete(path, params = {})
+      request(:delete, path, params: params)
+    end
+
+    # Issue a GET request and return the raw response body without JSON parsing.
+    # Use for binary endpoints (downloads, audit logs, attachments).
+    # @param path [String] request path.
+    # @param params [Hash] query string parameters.
+    # @return [String] raw response bytes.
+    # @raise [Error] on any non-success HTTP status.
+    def download(path, params = {})
+      response = connection.get(path) do |req|
+        req.params.update(params) if params && !params.empty?
+      end
+      handle_errors(response)
+      response.body
+    end
+
+    private
+
+    def request(method, path, body: nil, params: {}, multipart: false)
+      response = connection(multipart: multipart).public_send(method, path) do |req|
+        req.params.update(params) if params && !params.empty?
+        if body
+          if multipart
+            req.body = body
+          else
+            req.headers["Content-Type"] = "application/json"
+            req.body = body.is_a?(String) ? body : JSON.generate(body)
+          end
+        end
+      end
+      handle_errors(response)
+      parse_body(response)
+    end
+
+    def connection(multipart: false)
+      Faraday.new(url: @base_url) do |f|
+        f.request :multipart if multipart
+        f.request :url_encoded
+        f.headers["X-API-KEY"] = @api_key
+        f.headers["Accept"] = "application/json"
+        f.headers["User-Agent"] = USER_AGENT
+        f.response :logger, @logger if @logger
+        f.adapter @adapter
+      end
+    end
+
+    def parse_body(response)
+      return nil if response.body.nil? || response.body.empty?
+      content_type = response.headers["content-type"].to_s
+      return response.body unless content_type.include?("json")
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      response.body
+    end
+
+    def handle_errors(response)
+      return if response.success?
+
+      body = begin
+        JSON.parse(response.body)
+      rescue StandardError
+        response.body
+      end
+      message = body.is_a?(Hash) ? (body["message"] || body["error"] || body.to_s) : body.to_s
+      klass = ERROR_MAP[response.status] || (response.status >= 500 ? ServerError : Error)
+      raise klass.new("BoldSign API error (#{response.status}): #{message}",
+                      status: response.status, body: body, response: response)
+    end
+  end
+end

data/lib/boldsign/error.rb

@@ -0,0 +1,46 @@
+module Boldsign
+  # Base class for all errors raised by this gem.
+  # HTTP failures raise a typed subclass; carry the status code, parsed body, and Faraday response.
+  class Error < StandardError
+    # @return [Integer, nil] HTTP status code, when the error originated from a response.
+    attr_reader :status
+    # @return [Hash, String, nil] parsed response body (JSON Hash) or raw body string.
+    attr_reader :body
+    # @return [Faraday::Response, nil] underlying Faraday response.
+    attr_reader :response
+
+    def initialize(message = nil, status: nil, body: nil, response: nil)
+      super(message)
+      @status = status
+      @body = body
+      @response = response
+    end
+  end
+
+  # Raised when the gem is misconfigured (e.g. missing API key).
+  class ConfigurationError < Error; end
+  # HTTP 400.
+  class BadRequestError < Error; end
+  # HTTP 401.
+  class AuthenticationError < Error; end
+  # HTTP 403.
+  class ForbiddenError < Error; end
+  # HTTP 404.
+  class NotFoundError < Error; end
+  # HTTP 422.
+  class UnprocessableEntityError < Error; end
+  # HTTP 429.
+  class RateLimitError < Error; end
+  # HTTP 5xx.
+  class ServerError < Error; end
+
+  # Maps HTTP status codes to {Error} subclasses.
+  ERROR_MAP = {
+    400 => BadRequestError,
+    401 => AuthenticationError,
+    403 => ForbiddenError,
+    404 => NotFoundError,
+    422 => UnprocessableEntityError,
+    429 => RateLimitError
+  }.freeze
+end

data/lib/boldsign/resource.rb

@@ -0,0 +1,17 @@
+module Boldsign
+  # Base class for all resource wrappers. Holds a reference to the {Client}
+  # instance whose HTTP verb methods the resource methods delegate to.
+  class Resource
+    # @param client [Client]
+    def initialize(client)
+      @client = client
+    end
+  end
+
+  # Namespace for endpoint-group resource classes. Each resource is exposed as
+  # an accessor on {Client} (e.g. {Client#documents} → {Resources::Document}).
+  #
+  # @see https://developers.boldsign.com/ BoldSign API reference
+  module Resources
+  end
+end

data/lib/boldsign/resources/brand.rb

@@ -0,0 +1,14 @@
+module Boldsign
+  module Resources
+    # Brand-customization endpoints (`/v1/brand/*`).
+    # @see https://developers.boldsign.com/branding
+    class Brand < Resource
+      def list(**params);  @client.get("/v1/brand/list", params); end
+      def get(brand_id);   @client.get("/v1/brand/get", brandId: brand_id); end
+      def create(body, **params);  @client.post("/v1/brand/create", body: body, params: params); end
+      def edit(brand_id, body);    @client.post("/v1/brand/edit", body: body, params: { brandId: brand_id }); end
+      def delete(brand_id);        @client.delete("/v1/brand/delete", brandId: brand_id); end
+      def reset_default(brand_id); @client.post("/v1/brand/resetdefault", params: { brandId: brand_id }); end
+    end
+  end
+end

data/lib/boldsign/resources/contact.rb

@@ -0,0 +1,13 @@
+module Boldsign
+  module Resources
+    # Contact-book endpoints (`/v1/contacts/*`).
+    # @see https://developers.boldsign.com/contacts
+    class Contact < Resource
+      def list(**params);    @client.get("/v1/contacts/list", params); end
+      def get(contact_id);   @client.get("/v1/contacts/get", contactId: contact_id); end
+      def create(body);      @client.post("/v1/contacts/create", body: body); end
+      def update(body, **params); @client.put("/v1/contacts/update", body: body, params: params); end
+      def delete(contact_id);     @client.delete("/v1/contacts/delete", contactId: contact_id); end
+    end
+  end
+end

data/lib/boldsign/resources/contact_group.rb

@@ -0,0 +1,12 @@
+module Boldsign
+  module Resources
+    # Contact-group endpoints (`/v1/contactGroups/*`).
+    class ContactGroup < Resource
+      def list(**params); @client.get("/v1/contactGroups/list", params); end
+      def get(group_id);  @client.get("/v1/contactGroups/get", groupId: group_id); end
+      def create(body);   @client.post("/v1/contactGroups/create", body: body); end
+      def update(body, **params); @client.put("/v1/contactGroups/update", body: body, params: params); end
+      def delete(group_id);       @client.delete("/v1/contactGroups/delete", groupId: group_id); end
+    end
+  end
+end

data/lib/boldsign/resources/custom_field.rb

@@ -0,0 +1,12 @@
+module Boldsign
+  module Resources
+    # Reusable custom-field endpoints (`/v1/customField/*`).
+    class CustomField < Resource
+      def list(**params); @client.get("/v1/customField/list", params); end
+      def create(body);   @client.post("/v1/customField/create", body: body); end
+      def edit(body, **params); @client.post("/v1/customField/edit", body: body, params: params); end
+      def delete(**params);     @client.delete("/v1/customField/delete", params); end
+      def create_embedded_url(body); @client.post("/v1/customField/createEmbeddedCustomFieldUrl", body: body); end
+    end
+  end
+end

data/lib/boldsign/resources/document.rb

@@ -0,0 +1,51 @@
+module Boldsign
+  module Resources
+    # Document endpoints (`/v1/document/*`) — the bulk of the BoldSign API:
+    # sending, listing, downloading, editing, reminding, authenticating, tagging,
+    # and embedded signing flows.
+    #
+    # @example Send a document
+    #   client.documents.send_document(
+    #     title: "NDA",
+    #     signers: [{ name: "Jane", emailAddress: "jane@example.com", signerOrder: 1 }],
+    #     files: [...]
+    #   )
+    #
+    # @see https://developers.boldsign.com/documents
+    class Document < Resource
+      def list(**params);       @client.get("/v1/document/list", params); end
+      def team_list(**params);  @client.get("/v1/document/teamlist", params); end
+      def behalf_list(**params); @client.get("/v1/document/behalfList", params); end
+      def properties(document_id); @client.get("/v1/document/properties", documentId: document_id); end
+
+      def send_document(body);  @client.post("/v1/document/send", body: body); end
+      def draft_send(body);     @client.post("/v1/document/draftSend", body: body); end
+      def edit(document_id, body); @client.put("/v1/document/edit", body: body, params: { documentId: document_id }); end
+      def cancel_editing(document_id); @client.post("/v1/document/cancelEditing", params: { documentId: document_id }); end
+
+      def create_embedded_request_url(body); @client.post("/v1/document/createEmbeddedRequestUrl", body: body); end
+      def create_embedded_edit_url(body);    @client.post("/v1/document/createEmbeddedEditUrl", body: body); end
+      def get_embedded_sign_link(**params);  @client.get("/v1/document/getEmbeddedSignLink", params); end
+
+      def download(document_id);   @client.download("/v1/document/download", documentId: document_id); end
+      def download_attachment(**params); @client.download("/v1/document/downloadAttachment", params); end
+      def download_audit_log(document_id); @client.download("/v1/document/downloadAuditLog", documentId: document_id); end
+
+      def revoke(document_id, body = {}); @client.post("/v1/document/revoke", body: body, params: { documentId: document_id }); end
+      def remind(document_id, body = {}); @client.post("/v1/document/remind", body: body, params: { documentId: document_id }); end
+      def delete(document_id);            @client.delete("/v1/document/delete", documentId: document_id); end
+      def extend_expiry(document_id, body); @client.patch("/v1/document/extendExpiry", body: body, params: { documentId: document_id }); end
+
+      def change_access_code(document_id, body); @client.patch("/v1/document/changeAccessCode", body: body, params: { documentId: document_id }); end
+      def change_recipient(document_id, body);   @client.patch("/v1/document/changeRecipient", body: body, params: { documentId: document_id }); end
+
+      def add_tags(body);    @client.patch("/v1/document/addTags", body: body); end
+      def delete_tags(body); @client.delete("/v1/document/deleteTags", body: body); end
+
+      def remove_authentication(document_id, body); @client.patch("/v1/document/RemoveAuthentication", body: body, params: { documentId: document_id }); end
+      def add_authentication(document_id, body);    @client.patch("/v1/document/addAuthentication", body: body, params: { documentId: document_id }); end
+
+      def prefill_fields(document_id, body); @client.patch("/v1/document/prefillFields", body: body, params: { documentId: document_id }); end
+    end
+  end
+end

data/lib/boldsign/resources/identity_verification.rb

@@ -0,0 +1,12 @@
+module Boldsign
+  module Resources
+    # Identity-verification endpoints (`/v1/identityVerification/*`).
+    class IdentityVerification < Resource
+      def report(body); @client.post("/v1/identityVerification/report", body: body); end
+      def image(body);  @client.post("/v1/identityVerification/image", body: body); end
+      def create_embedded_url(body)
+        @client.post("/v1/identityVerification/createEmbeddedVerificationUrl", body: body)
+      end
+    end
+  end
+end

data/lib/boldsign/resources/plan.rb

@@ -0,0 +1,8 @@
+module Boldsign
+  module Resources
+    # Plan / billing endpoints (`/v1/plan/*`).
+    class Plan < Resource
+      def api_credits_count; @client.get("/v1/plan/apiCreditsCount"); end
+    end
+  end
+end

data/lib/boldsign/resources/sender_identity.rb

@@ -0,0 +1,14 @@
+module Boldsign
+  module Resources
+    # Sender-identity endpoints (`/v1/senderIdentities/*`).
+    class SenderIdentity < Resource
+      def list(**params);  @client.get("/v1/senderIdentities/list", params); end
+      def properties(**params); @client.get("/v1/senderIdentities/properties", params); end
+      def create(body);    @client.post("/v1/senderIdentities/create", body: body); end
+      def update(body, **params); @client.post("/v1/senderIdentities/update", body: body, params: params); end
+      def delete(**params);       @client.delete("/v1/senderIdentities/delete", params); end
+      def resend_invitation(**params); @client.post("/v1/senderIdentities/resendInvitation", params: params); end
+      def rerequest(body, **params);   @client.post("/v1/senderIdentities/rerequest", body: body, params: params); end
+    end
+  end
+end

data/lib/boldsign/resources/team.rb

@@ -0,0 +1,11 @@
+module Boldsign
+  module Resources
+    # Team endpoints (`/v1/teams/*`).
+    class Team < Resource
+      def list(**params); @client.get("/v1/teams/list", params); end
+      def get(team_id);   @client.get("/v1/teams/get", teamId: team_id); end
+      def create(body);   @client.post("/v1/teams/create", body: body); end
+      def update(body, **params); @client.put("/v1/teams/update", body: body, params: params); end
+    end
+  end
+end

data/lib/boldsign/resources/template.rb

@@ -0,0 +1,37 @@
+module Boldsign
+  module Resources
+    # Template endpoints (`/v1/template/*`) — create, send, edit, and embed
+    # reusable signing templates.
+    #
+    # @see https://developers.boldsign.com/templates
+    class Template < Resource
+      def list(**params);          @client.get("/v1/template/list", params); end
+      def properties(template_id); @client.get("/v1/template/properties", templateId: template_id); end
+      def download(template_id);   @client.download("/v1/template/download", templateId: template_id); end
+
+      def create(body);            @client.post("/v1/template/create", body: body); end
+      def edit(template_id, body); @client.put("/v1/template/edit", body: body, params: { templateId: template_id }); end
+      def delete(template_id);     @client.delete("/v1/template/delete", templateId: template_id); end
+
+      def send_template(template_id, body)
+        @client.post("/v1/template/send", body: body, params: { templateId: template_id })
+      end
+      def merge_and_send(body); @client.post("/v1/template/mergeAndSend", body: body); end
+
+      def create_embedded_template_url(body); @client.post("/v1/template/createEmbeddedTemplateUrl", body: body); end
+      def get_embedded_template_edit_url(body); @client.post("/v1/template/getEmbeddedTemplateEditUrl", body: body); end
+      def create_embedded_request_url(template_id, body)
+        @client.post("/v1/template/createEmbeddedRequestUrl", body: body, params: { templateId: template_id })
+      end
+      def merge_create_embedded_request_url(body)
+        @client.post("/v1/template/mergeCreateEmbeddedRequestUrl", body: body)
+      end
+      def create_embedded_preview_url(body)
+        @client.post("/v1/template/createEmbeddedPreviewUrl", body: body)
+      end
+
+      def add_tags(body);    @client.patch("/v1/template/addTags", body: body); end
+      def delete_tags(body); @client.delete("/v1/template/deleteTags", body: body); end
+    end
+  end
+end

data/lib/boldsign/resources/user.rb

@@ -0,0 +1,15 @@
+module Boldsign
+  module Resources
+    # User-management endpoints (`/v1/users/*`).
+    class User < Resource
+      def list(**params);   @client.get("/v1/users/list", params); end
+      def get(user_id);     @client.get("/v1/users/get", userId: user_id); end
+      def create(body);     @client.post("/v1/users/create", body: body); end
+      def update(body, **params); @client.put("/v1/users/update", body: body, params: params); end
+      def update_metadata(body, **params); @client.put("/v1/users/updateMetaData", body: body, params: params); end
+      def change_team(body, **params);     @client.put("/v1/users/changeTeam", body: body, params: params); end
+      def resend_invitation(**params); @client.post("/v1/users/resendInvitation", params: params); end
+      def cancel_invitation(**params); @client.post("/v1/users/cancelInvitation", params: params); end
+    end
+  end
+end

data/lib/boldsign/version.rb

@@ -0,0 +1,3 @@
+module Boldsign
+  VERSION = "0.1.0"
+end

data/lib/boldsign.rb

@@ -0,0 +1,69 @@
+require "faraday"
+require "faraday/multipart"
+require "json"
+
+require_relative "boldsign/version"
+require_relative "boldsign/error"
+require_relative "boldsign/client"
+require_relative "boldsign/resource"
+require_relative "boldsign/resources/brand"
+require_relative "boldsign/resources/contact"
+require_relative "boldsign/resources/contact_group"
+require_relative "boldsign/resources/custom_field"
+require_relative "boldsign/resources/document"
+require_relative "boldsign/resources/identity_verification"
+require_relative "boldsign/resources/plan"
+require_relative "boldsign/resources/sender_identity"
+require_relative "boldsign/resources/team"
+require_relative "boldsign/resources/template"
+require_relative "boldsign/resources/user"
+
+# Top-level namespace for the BoldSign Ruby client.
+#
+# Configure once at boot and access a shared {Client} via {Boldsign.client}, or
+# instantiate {Client} directly when you need multiple credentials/regions.
+#
+# @example Configure and use the shared client
+#   Boldsign.configure do |c|
+#     c.api_key = ENV["BOLDSIGN_API_KEY"]
+#     c.region  = :us
+#   end
+#   Boldsign.client.documents.list
+module Boldsign
+  # Region → base URL map for BoldSign's regional API hosts.
+  REGIONS = {
+    us: "https://api.boldsign.com",
+    eu: "https://api-eu.boldsign.com",
+    ca: "https://api-ca.boldsign.com",
+    au: "https://api-au.boldsign.com"
+  }.freeze
+
+  class << self
+    # @return [String, nil] API key used by the shared {client}.
+    attr_accessor :api_key
+
+    # @return [Symbol, nil] Region key (`:us`, `:eu`, `:ca`, `:au`).
+    attr_accessor :region
+
+    # @return [String, nil] Optional explicit base URL override (takes precedence over {region}).
+    attr_accessor :base_url
+
+    # Yields self for block-style configuration.
+    # @yieldparam config [Boldsign] the module itself
+    # @return [void]
+    def configure
+      yield self
+    end
+
+    # @return [Client] memoized shared client built from module-level config.
+    def client
+      @client ||= Client.new(api_key: api_key, region: region, base_url: base_url)
+    end
+
+    # Clears the memoized shared client so the next call to {client} rebuilds it.
+    # @return [void]
+    def reset!
+      @client = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: boldsign
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Klein
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.19'
+description: A Ruby wrapper for the BoldSign REST API (documents, templates, contacts,
+  teams, brands, webhooks, and more).
+email:
+- kleinjm007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- boldsign.gemspec
+- lib/boldsign.rb
+- lib/boldsign/client.rb
+- lib/boldsign/error.rb
+- lib/boldsign/resource.rb
+- lib/boldsign/resources/brand.rb
+- lib/boldsign/resources/contact.rb
+- lib/boldsign/resources/contact_group.rb
+- lib/boldsign/resources/custom_field.rb
+- lib/boldsign/resources/document.rb
+- lib/boldsign/resources/identity_verification.rb
+- lib/boldsign/resources/plan.rb
+- lib/boldsign/resources/sender_identity.rb
+- lib/boldsign/resources/team.rb
+- lib/boldsign/resources/template.rb
+- lib/boldsign/resources/user.rb
+- lib/boldsign/version.rb
+homepage: https://github.com/kleinjm/boldsign-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kleinjm/boldsign-ruby
+  source_code_uri: https://github.com/kleinjm/boldsign-ruby
+  changelog_uri: https://github.com/kleinjm/boldsign-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kleinjm/boldsign-ruby/issues
+  documentation_uri: https://rubydoc.info/gems/boldsign
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for the BoldSign e-signature API
+test_files: []