{"id":35673431,"url":"https://github.com/knocklabs/knock-ruby","last_synced_at":"2026-01-29T23:01:25.584Z","repository":{"id":40558764,"uuid":"397687652","full_name":"knocklabs/knock-ruby","owner":"knocklabs","description":"Official Ruby SDK for interacting with the Knock API","archived":false,"fork":false,"pushed_at":"2026-01-23T20:41:17.000Z","size":2888,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-01-24T09:48:25.772Z","etag":null,"topics":["ruby","ruby-gem"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/knocklabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-18T17:43:58.000Z","updated_at":"2026-01-23T20:40:37.000Z","dependencies_parsed_at":"2024-01-24T15:26:35.202Z","dependency_job_id":"a7e295fc-5d47-4de6-b0cc-7d7b9a00877c","html_url":"https://github.com/knocklabs/knock-ruby","commit_stats":{"total_commits":23,"total_committers":4,"mean_commits":5.75,"dds":0.4782608695652174,"last_synced_commit":"07d06d1cc85efac31805eb38d57214b3d9291289"},"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"purl":"pkg:github/knocklabs/knock-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knocklabs%2Fknock-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knocklabs%2Fknock-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knocklabs%2Fknock-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knocklabs%2Fknock-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/knocklabs","download_url":"https://codeload.github.com/knocklabs/knock-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/knocklabs%2Fknock-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28889863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"ssl_error","status_checked_at":"2026-01-29T21:06:42.160Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ruby","ruby-gem"],"created_at":"2026-01-05T19:24:06.116Z","updated_at":"2026-01-29T23:01:25.578Z","avatar_url":"https://github.com/knocklabs.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Knock Ruby API library\n\nThe Knock Ruby library provides convenient access to the Knock REST API from any Ruby 3.2.0+ application. It ships with comprehensive types \u0026 docstrings in Yard, RBS, and RBI – [see below](https://github.com/knocklabs/knock-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.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/knockapi).\n\nThe REST API documentation can be found on [docs.knock.app](https://docs.knock.app).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application's `Gemfile`:\n\n\u003c!-- x-release-please-start-version --\u003e\n\n```ruby\ngem \"knockapi\", \"~\u003e 1.30.0\"\n```\n\n\u003c!-- x-release-please-end --\u003e\n\n## Usage\n\n```ruby\nrequire \"bundler/setup\"\nrequire \"knockapi\"\n\nknock = Knockapi::Client.new(\n  api_key: ENV[\"KNOCK_API_KEY\"] # This is the default and can be omitted\n)\n\nresponse = knock.workflows.trigger(\"dinosaurs-loose\", recipients: [\"dnedry\"], data: {dinosaur: \"triceratops\"})\n\nputs(response.workflow_run_id)\n```\n\n### Pagination\n\nList methods in the Knock API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = knock.users.list\n\n# Fetch single item from page.\nuser = page.entries[0]\nputs(user.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |user|\n  puts(user.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n  new_page = page.next_page\n  puts(new_page.entries[0].id)\nend\n```\n\n### Handling errors\n\nWhen 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 `Knockapi::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n  user = knock.users.get(\"dnedry\")\nrescue Knockapi::Errors::APIConnectionError =\u003e e\n  puts(\"The server could not be reached\")\n  puts(e.cause)  # an underlying Exception, likely raised within `net/http`\nrescue Knockapi::Errors::RateLimitError =\u003e e\n  puts(\"A 429 status code was received; we should back off a bit.\")\nrescue Knockapi::Errors::APIStatusError =\u003e e\n  puts(\"Another non-200-range status code was received\")\n  puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause            | Error Type                 |\n| ---------------- | -------------------------- |\n| HTTP 400         | `BadRequestError`          |\n| HTTP 401         | `AuthenticationError`      |\n| HTTP 403         | `PermissionDeniedError`    |\n| HTTP 404         | `NotFoundError`            |\n| HTTP 409         | `ConflictError`            |\n| HTTP 422         | `UnprocessableEntityError` |\n| HTTP 429         | `RateLimitError`           |\n| HTTP \u003e= 500      | `InternalServerError`      |\n| Other HTTP error | `APIStatusError`           |\n| Timeout          | `APITimeoutError`          |\n| Network error    | `APIConnectionError`       |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, \u003e=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nknock = Knockapi::Client.new(\n  max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nknock.users.get(\"dnedry\", request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nknock = Knockapi::Client.new(\n  timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nknock.users.get(\"dnedry\", request_options: {timeout: 5})\n```\n\nOn timeout, `Knockapi::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `Knockapi::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj =\u003e {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\nuser =\n  knock.users.get(\n    \"dnedry\",\n    request_options: {\n      extra_query: {my_query_parameter: value},\n      extra_body: {my_body_parameter: value},\n      extra_headers: {\"my-header\": value}\n    }\n  )\n\nputs(user[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf 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.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n  method: :post,\n  path: '/undocumented/endpoint',\n  query: {\"dog\": \"woof\"},\n  headers: {\"useful-header\": \"interesting-value\"},\n  body: {\"hello\": \"world\"}\n)\n```\n\n### Concurrency \u0026 connection pooling\n\nThe `Knockapi::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `Knockapi::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.\n\nWhen 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.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nknock.workflows.trigger(\"dinosaurs-loose\", recipients: [\"dnedry\"], data: {dinosaur: \"triceratops\"})\n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nknock.workflows.trigger(\"dinosaurs-loose\", recipients: [\"dnedry\"], data: {dinosaur: \"triceratops\"})\n\n# You can also splat a full Params class:\nparams = Knockapi::WorkflowTriggerParams.new(recipients: [\"dnedry\"], data: {dinosaur: \"triceratops\"})\nknock.workflows.trigger(\"dinosaurs-loose\", **params)\n```\n\n### Enums\n\nSince 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:\n\n```ruby\n# :merge\nputs(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE)\n\n# Revealed type: `T.all(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy, Symbol)`\nT.reveal_type(Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE)\n```\n\nEnum parameters have a \"relaxed\" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nknock.users.set_preferences(\n  _persistence_strategy: Knockapi::Recipients::PreferenceSetRequest::PersistenceStrategy::MERGE,\n  # …\n)\n\n# Literal values are also permissible:\nknock.users.set_preferences(\n  _persistence_strategy: :merge,\n  # …\n)\n```\n\n## Versioning\n\nThis 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.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/knocklabs/knock-ruby/tree/main/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknocklabs%2Fknock-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fknocklabs%2Fknock-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fknocklabs%2Fknock-ruby/lists"}