moderation_api 1.2.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01b054414c274bbd8477a7eb3119f1590d1ef83474500cdfd7cd2d52ee1ff069
-  data.tar.gz: fc294ed0ba8cf33972dda43dd359a2ff25eb8bfb5bba8d3b438563411c8d3ffb
+  metadata.gz: ff604e3336aa1a1647d34e44dc4882d29e085728dc24b366f75ddd73e2127a7d
+  data.tar.gz: 7aa454e649479c02aa6ccd060fed482b3c9dfe18536a2aa4f4152ec58fe6fe38
 SHA512:
-  metadata.gz: 2a72621a0abbc91d8bd61c51a1afeaf0b9e64b0fda84f137ab7a1afd4aa7fc553b8dd548b921da4f9117f3b2e0150c5bdd2e72a5cbfe68c22f1b4cd29dfadc83
-  data.tar.gz: c5f8f6268af67cfb9bf208d32e34aad785a515e8d063f31d5550f47602ec4a8b711f6d8701f80905733dcc32cf580de5a878f96edb1c5336d54f1dbe5f96e61b
+  metadata.gz: 0e69d7cbae2c2fec62591b3f7e8f53e3a7f3de1bdc705297c6e054c4a33f7455b545faee977d40967e77b654aa57259e22bc4ff86c748e5d244daab8820e0223
+  data.tar.gz: 4e93df7176d6cac9f1a7327fdc3aa058723b8e25971b88abb7cb7be2aa7f315f2b1eb55da3ce4a8f619cc6ce55d03cda2e8217f2e21a826cc18b99843d16f756

data/.ignore

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

data/CHANGELOG.md

@@ -0,0 +1,127 @@
+# Changelog
+
+## 2.6.1 (2026-02-07)
+
+Full Changelog: [v2.6.0...v2.6.1](https://github.com/moderation-api/sdk-ruby/compare/v2.6.0...v2.6.1)
+
+### Bug Fixes
+
+* **client:** loosen json header parsing ([58cc470](https://github.com/moderation-api/sdk-ruby/commit/58cc470e748a3b3ff04775cf68ef46e27df719a0))
+
+## 2.6.0 (2026-02-06)
+
+Full Changelog: [v2.5.1...v2.6.0](https://github.com/moderation-api/sdk-ruby/compare/v2.5.1...v2.6.0)
+
+### Features
+
+* **api:** api update ([3f29a05](https://github.com/moderation-api/sdk-ruby/commit/3f29a05c2dcf23a3640f6ec76ca450cd44fcd66c))
+
+
+### Chores
+
+* **docs:** remove www prefix ([f5b51e1](https://github.com/moderation-api/sdk-ruby/commit/f5b51e17d19b441376cedfeca7fbf7858bbf8fe9))
+
+## 2.5.1 (2026-02-03)
+
+Full Changelog: [v2.5.0...v2.5.1](https://github.com/moderation-api/sdk-ruby/compare/v2.5.0...v2.5.1)
+
+### Bug Fixes
+
+* **client:** always add content-length to post body, even when empty ([22201f0](https://github.com/moderation-api/sdk-ruby/commit/22201f0900c1c285c0900dec155b5e0718ccc035))
+
+## 2.5.0 (2026-01-28)
+
+Full Changelog: [v2.4.0...v2.5.0](https://github.com/moderation-api/sdk-ruby/compare/v2.4.0...v2.5.0)
+
+### Features
+
+* **api:** api update ([ebed85c](https://github.com/moderation-api/sdk-ruby/commit/ebed85ca0318e4c4643525430666cec73ef9b8c1))
+
+## 2.4.0 (2026-01-28)
+
+Full Changelog: [v2.3.0...v2.4.0](https://github.com/moderation-api/sdk-ruby/compare/v2.3.0...v2.4.0)
+
+### Features
+
+* **api:** api update ([6f59d50](https://github.com/moderation-api/sdk-ruby/commit/6f59d503d5316ea4989dc7f2826a760599a9cc0d))
+
+
+### Chores
+
+* **internal:** update `actions/checkout` version ([6debb55](https://github.com/moderation-api/sdk-ruby/commit/6debb5528f54ceaefc72ffa445a69aa4f30bc4e7))
+* move `cgi` into dependencies for ruby 4 ([6aab585](https://github.com/moderation-api/sdk-ruby/commit/6aab585a91f2ac47f2bae66f1e21d03eb6b5b475))
+
+## 2.3.0 (2026-01-02)
+
+Full Changelog: [v2.2.1...v2.3.0](https://github.com/moderation-api/sdk-ruby/compare/v2.2.1...v2.3.0)
+
+### Features
+
+* **api:** api update ([b7e4375](https://github.com/moderation-api/sdk-ruby/commit/b7e4375b627d949a7e9ac5794703793c9da54415))
+
+## 2.2.1 (2025-12-19)
+
+Full Changelog: [v2.2.0...v2.2.1](https://github.com/moderation-api/sdk-ruby/compare/v2.2.0...v2.2.1)
+
+### Bug Fixes
+
+* issue where json.parse errors when receiving HTTP 204 with nobody ([fb1960a](https://github.com/moderation-api/sdk-ruby/commit/fb1960aab2de9c04cdb3985f7d75f503eca0b3b8))
+
+## 2.2.0 (2025-12-18)
+
+Full Changelog: [v2.1.1...v2.2.0](https://github.com/moderation-api/sdk-ruby/compare/v2.1.1...v2.2.0)
+
+### Features
+
+* **api:** api update ([37d5a3d](https://github.com/moderation-api/sdk-ruby/commit/37d5a3d6185eaddfce7a79d9b4799568d694782a))
+
+## 2.1.1 (2025-12-17)
+
+Full Changelog: [v2.1.0...v2.1.1](https://github.com/moderation-api/sdk-ruby/compare/v2.1.0...v2.1.1)
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([eda0e72](https://github.com/moderation-api/sdk-ruby/commit/eda0e7289053ab2cd25c0c065c5df69d30d0831f))
+
+## 2.1.0 (2025-12-06)
+
+Full Changelog: [v2.0.1...v2.1.0](https://github.com/moderation-api/sdk-ruby/compare/v2.0.1...v2.1.0)
+
+### Features
+
+* **api:** api update ([4e4acdc](https://github.com/moderation-api/sdk-ruby/commit/4e4acdc4672bc824956fed0c25a1918a8ec719a3))
+
+## 2.0.1 (2025-12-05)
+
+Full Changelog: [v2.0.0...v2.0.1](https://github.com/moderation-api/sdk-ruby/compare/v2.0.0...v2.0.1)
+
+### Documentation
+
+* updated readme ([a824572](https://github.com/moderation-api/sdk-ruby/commit/a8245722455e6486264a86e3e18d4bad516cc2f1))
+
+## 2.0.0 (2025-12-05)
+
+Full Changelog: [v0.0.1...v2.0.0](https://github.com/moderation-api/sdk-ruby/compare/v0.0.1...v2.0.0)
+
+### Features
+
+* **api:** api update ([400d1cc](https://github.com/moderation-api/sdk-ruby/commit/400d1cc55e946cd047ebe6837c64e881f9796120))
+* **api:** api update ([34ddc34](https://github.com/moderation-api/sdk-ruby/commit/34ddc3478338af0c07107d739c570bd0cb688215))
+* **api:** api update ([7b0c383](https://github.com/moderation-api/sdk-ruby/commit/7b0c38363370d29eeacc1a5e6cecb909c0b16353))
+* **api:** manual updates ([aa5e0e6](https://github.com/moderation-api/sdk-ruby/commit/aa5e0e6d3afd7be708d96205d2748a40845b7931))
+* **api:** manual updates ([c38719d](https://github.com/moderation-api/sdk-ruby/commit/c38719de057b770b675e67383cc4e5fac1973a9c))
+* **api:** manual updates ([e304765](https://github.com/moderation-api/sdk-ruby/commit/e304765ec2028a345bcc3e860f1e7f53ffb30a58))
+* **api:** manual updates ([2e5bc4c](https://github.com/moderation-api/sdk-ruby/commit/2e5bc4cfc267ccdfe6d26a9873409856d01ddc5d))
+* **api:** manual updates ([667a0b8](https://github.com/moderation-api/sdk-ruby/commit/667a0b81c42ac2f4fd04035386dedf0cf67380ea))
+* **api:** manual updates ([ed95ed4](https://github.com/moderation-api/sdk-ruby/commit/ed95ed44d04677ce0699a00d9bfedca7b1a1db8f))
+* **api:** manual updates ([495a03b](https://github.com/moderation-api/sdk-ruby/commit/495a03b50318611091d581c0ef3892c44883e391))
+* **api:** manual updates ([a17bf98](https://github.com/moderation-api/sdk-ruby/commit/a17bf98e0d126505db304b1d316812a42ccd2a81))
+* **api:** manual updates ([f20d9aa](https://github.com/moderation-api/sdk-ruby/commit/f20d9aaa79b9d5b043a07bcc133bbdcd930c25c7))
+* **api:** manual updates ([6dc2d9d](https://github.com/moderation-api/sdk-ruby/commit/6dc2d9d4c46a7b4c0fed2a5e2b5821c951e5ccdf))
+* **api:** removed deprecated moderate endpoints ([5b163bc](https://github.com/moderation-api/sdk-ruby/commit/5b163bc4faf3fc881ea176aef9c58cef265943fe))
+
+
+### Chores
+
+* configure new SDK language ([22d6295](https://github.com/moderation-api/sdk-ruby/commit/22d6295c55898708f8e39df213365f37ad17f075))
+* update SDK settings ([492eccb](https://github.com/moderation-api/sdk-ruby/commit/492eccbceb612aef715d3f9c295882c1e5bd5961))

data/README.md

@@ -1,144 +1,235 @@
-# moderation_api
+# Moderation API Ruby library
 
-ModerationAPI - the Ruby gem for the Moderation API
+The Moderation API Ruby library provides convenient access to the Moderation API 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/moderation-api/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.
 
-API for automated content moderation
+## 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/moderation_api).
 
-- API version: 1.0.0
-- Package version: 1.2.0
-- Generator version: 7.10.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+The REST API documentation can be found on [docs.moderationapi.com](https://docs.moderationapi.com).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
 
 ```ruby
-gem 'moderation_api'
+gem "moderation_api", "~> 2.6.1"
 ```
 
-And then execute:
+<!-- x-release-please-end -->
 
-```shell
-bundle install
-```
+## Usage
+
+```ruby
+require "bundler/setup"
+require "moderation_api"
+
+moderation_api = ModerationAPI::Client.new(
+  secret_key: ENV["MODAPI_SECRET_KEY"] # This is the default and can be omitted
+)
 
-Or install it yourself as:
+response = moderation_api.content.submit(content: {text: "x", type: "text"})
 
-```shell
-gem install moderation_api
+puts(response.recommendation)
 ```
 
-## Getting Started
+### Handling errors
 
-Please follow the [installation](#installation) procedure and then run the following code:
+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 `ModerationAPI::Errors::APIError` will be thrown:
 
 ```ruby
-# Load the gem
-require 'moderation_api'
-
-# Setup authorization
-ModerationAPI.configure do |config|
-  # Configure Bearer authorization: Authorization
-  config.access_token = 'YOUR_BEARER_TOKEN'
-  # Configure a proc to get access tokens in lieu of the static access_token configuration
-  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
-  # Configure faraday connection
-  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+begin
+  content = moderation_api.content.submit(content: {text: "x", type: "text"})
+rescue ModerationAPI::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue ModerationAPI::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue ModerationAPI::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
 end
+```
 
-api_instance = ModerationAPI::AccountApi.new
+Error codes are as follows:
 
-begin
-  #Get account details
-  result = api_instance.account_get
-  p result
-rescue ModerationAPI::ApiError => e
-  puts "Exception when calling AccountApi->account_get: #{e}"
-end
+| 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:
+moderation_api = ModerationAPI::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+moderation_api.content.submit(content: {text: "x", type: "text"}, 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:
+moderation_api = ModerationAPI::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+moderation_api.content.submit(content: {text: "x", type: "text"}, request_options: {timeout: 5})
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://moderationapi.com/api/v1*
-
-| Class                            | Method                                                                               | HTTP request                         | Description         |
-| -------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------ | ------------------- |
-| _ModerationAPI::AccountApi_      | [**account_get**](docs/AccountApi.md#account_get)                                    | **GET** /account                     | Get account details |
-| _ModerationAPI::ModerateApi_     | [**moderation_audio**](docs/ModerateApi.md#moderation_audio)                         | **POST** /moderate/audio             | Analyze audio       |
-| _ModerationAPI::ModerateApi_     | [**moderation_image**](docs/ModerateApi.md#moderation_image)                         | **POST** /moderate/image             | Analyze image       |
-| _ModerationAPI::ModerateApi_     | [**moderation_object**](docs/ModerateApi.md#moderation_object)                       | **POST** /moderate/object            | Analyze object.     |
-| _ModerationAPI::ModerateApi_     | [**moderation_text**](docs/ModerateApi.md#moderation_text)                           | **POST** /moderate/text              | Analyze text.       |
-| _ModerationAPI::ModerateApi_     | [**moderation_video**](docs/ModerateApi.md#moderation_video)                         | **POST** /moderate/video             | Analyze video       |
-| _ModerationAPI::QueueActionsApi_ | [**actions_create**](docs/QueueActionsApi.md#actions_create)                         | **POST** /actions                    | Create an action    |
-| _ModerationAPI::QueueActionsApi_ | [**actions_delete**](docs/QueueActionsApi.md#actions_delete)                         | **DELETE** /actions/{id}             | Delete an action    |
-| _ModerationAPI::QueueActionsApi_ | [**actions_execute**](docs/QueueActionsApi.md#actions_execute)                       | **POST** /actions/execute            | Execute an action   |
-| _ModerationAPI::QueueActionsApi_ | [**actions_execute_deprecated**](docs/QueueActionsApi.md#actions_execute_deprecated) | **POST** /actions/{actionId}/execute | Execute an action   |
-| _ModerationAPI::QueueActionsApi_ | [**actions_get**](docs/QueueActionsApi.md#actions_get)                               | **GET** /actions/{id}                | Get an action       |
-| _ModerationAPI::QueueActionsApi_ | [**actions_list**](docs/QueueActionsApi.md#actions_list)                             | **GET** /actions                     | List actions        |
-| _ModerationAPI::QueueActionsApi_ | [**actions_update**](docs/QueueActionsApi.md#actions_update)                         | **PUT** /actions/{id}                | Update an action    |
-
-## Documentation for Models
-
-- [ModerationAPI::AccountGet200Response](docs/AccountGet200Response.md)
-- [ModerationAPI::AccountGet200ResponseCurrentProject](docs/AccountGet200ResponseCurrentProject.md)
-- [ModerationAPI::ActionsCreateRequest](docs/ActionsCreateRequest.md)
-- [ModerationAPI::ActionsCreateRequestWebhooksInner](docs/ActionsCreateRequestWebhooksInner.md)
-- [ModerationAPI::ActionsDelete200Response](docs/ActionsDelete200Response.md)
-- [ModerationAPI::ActionsExecute200Response](docs/ActionsExecute200Response.md)
-- [ModerationAPI::ActionsExecuteDeprecatedRequest](docs/ActionsExecuteDeprecatedRequest.md)
-- [ModerationAPI::ActionsExecuteRequest](docs/ActionsExecuteRequest.md)
-- [ModerationAPI::ActionsGet200Response](docs/ActionsGet200Response.md)
-- [ModerationAPI::ActionsGet200ResponseWebhooksInner](docs/ActionsGet200ResponseWebhooksInner.md)
-- [ModerationAPI::ActionsList200ResponseInner](docs/ActionsList200ResponseInner.md)
-- [ModerationAPI::ActionsList200ResponseInnerPossibleValuesInner](docs/ActionsList200ResponseInnerPossibleValuesInner.md)
-- [ModerationAPI::ActionsList400Response](docs/ActionsList400Response.md)
-- [ModerationAPI::ActionsList400ResponseIssuesInner](docs/ActionsList400ResponseIssuesInner.md)
-- [ModerationAPI::ActionsUpdateRequest](docs/ActionsUpdateRequest.md)
-- [ModerationAPI::ModerationAudioRequest](docs/ModerationAudioRequest.md)
-- [ModerationAPI::ModerationImage200Response](docs/ModerationImage200Response.md)
-- [ModerationAPI::ModerationImage200ResponseLabelsInner](docs/ModerationImage200ResponseLabelsInner.md)
-- [ModerationAPI::ModerationImageRequest](docs/ModerationImageRequest.md)
-- [ModerationAPI::ModerationObject200Response](docs/ModerationObject200Response.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfEntitiesInner](docs/ModerationObject200ResponseAllOfEntitiesInner.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfFieldsInner](docs/ModerationObject200ResponseAllOfFieldsInner.md)
-- [ModerationAPI::ModerationObject200ResponseAllOfLabelsInner](docs/ModerationObject200ResponseAllOfLabelsInner.md)
-- [ModerationAPI::ModerationObjectRequest](docs/ModerationObjectRequest.md)
-- [ModerationAPI::ModerationObjectRequestValue](docs/ModerationObjectRequestValue.md)
-- [ModerationAPI::ModerationObjectRequestValueDataValue](docs/ModerationObjectRequestValueDataValue.md)
-- [ModerationAPI::ModerationText200Response](docs/ModerationText200Response.md)
-- [ModerationAPI::ModerationText200ResponseAllOfAddress](docs/ModerationText200ResponseAllOfAddress.md)
-- [ModerationAPI::ModerationText200ResponseAllOfEmail](docs/ModerationText200ResponseAllOfEmail.md)
-- [ModerationAPI::ModerationText200ResponseAllOfName](docs/ModerationText200ResponseAllOfName.md)
-- [ModerationAPI::ModerationText200ResponseAllOfNsfw](docs/ModerationText200ResponseAllOfNsfw.md)
-- [ModerationAPI::ModerationText200ResponseAllOfNsfwLabelScores](docs/ModerationText200ResponseAllOfNsfwLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfPhone](docs/ModerationText200ResponseAllOfPhone.md)
-- [ModerationAPI::ModerationText200ResponseAllOfProfanity](docs/ModerationText200ResponseAllOfProfanity.md)
-- [ModerationAPI::ModerationText200ResponseAllOfPropriety](docs/ModerationText200ResponseAllOfPropriety.md)
-- [ModerationAPI::ModerationText200ResponseAllOfProprietyLabelScores](docs/ModerationText200ResponseAllOfProprietyLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfQuality](docs/ModerationText200ResponseAllOfQuality.md)
-- [ModerationAPI::ModerationText200ResponseAllOfQualityLabelScores](docs/ModerationText200ResponseAllOfQualityLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfRequest](docs/ModerationText200ResponseAllOfRequest.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSensitive](docs/ModerationText200ResponseAllOfSensitive.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSentiment](docs/ModerationText200ResponseAllOfSentiment.md)
-- [ModerationAPI::ModerationText200ResponseAllOfSentimentLabelScores](docs/ModerationText200ResponseAllOfSentimentLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfToxicity](docs/ModerationText200ResponseAllOfToxicity.md)
-- [ModerationAPI::ModerationText200ResponseAllOfToxicityLabelScores](docs/ModerationText200ResponseAllOfToxicityLabelScores.md)
-- [ModerationAPI::ModerationText200ResponseAllOfUrl](docs/ModerationText200ResponseAllOfUrl.md)
-- [ModerationAPI::ModerationText200ResponseAllOfUsername](docs/ModerationText200ResponseAllOfUsername.md)
-- [ModerationAPI::ModerationText200ResponseAllOfWordlist](docs/ModerationText200ResponseAllOfWordlist.md)
-- [ModerationAPI::ModerationText200ResponseAllOfWordlistsInner](docs/ModerationText200ResponseAllOfWordlistsInner.md)
-- [ModerationAPI::ModerationTextRequest](docs/ModerationTextRequest.md)
-- [ModerationAPI::ModerationVideo200Response](docs/ModerationVideo200Response.md)
-- [ModerationAPI::ModerationVideoRequest](docs/ModerationVideoRequest.md)
-
-## Documentation for Authorization
-
-Authentication schemes defined for the API:
-
-### Authorization
-
-- **Type**: Bearer authentication
+On timeout, `ModerationAPI::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `ModerationAPI::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
+response =
+  moderation_api.content.submit(
+    content: {text: "x", type: "text"},
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(response[: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 `ModerationAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `ModerationAPI::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
+moderation_api.content.submit(content: ModerationAPI::ContentSubmitParams::Content::Text.new(text: "x"))
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+moderation_api.content.submit(content: {text: "x", type: "text"})
+
+# You can also splat a full Params class:
+params = ModerationAPI::ContentSubmitParams.new(
+  content: ModerationAPI::ContentSubmitParams::Content::Text.new(text: "x")
+)
+moderation_api.content.submit(**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
+# :trustLevel
+puts(ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL)
+
+# Revealed type: `T.all(ModerationAPI::AuthorListParams::SortBy, Symbol)`
+T.reveal_type(ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL)
+```
+
+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:
+moderation_api.authors.list(
+  sort_by: ModerationAPI::AuthorListParams::SortBy::TRUST_LEVEL,
+  # …
+)
+
+# Literal values are also permissible:
+moderation_api.authors.list(
+  sort_by: :trustLevel,
+  # …
+)
+```
+
+## 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/moderation-api/sdk-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# 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 Moderation API, please follow the respective company's security reporting guidelines.
+
+### Moderation API Terms and Policies
+
+Please contact support@moderationapi.com for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/moderation_api/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module ModerationAPI
+  class Client < ModerationAPI::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 :secret_key
+
+    # @return [ModerationAPI::Resources::Authors]
+    attr_reader :authors
+
+    # @return [ModerationAPI::Resources::Queue]
+    attr_reader :queue
+
+    # @return [ModerationAPI::Resources::Actions]
+    attr_reader :actions
+
+    # @return [ModerationAPI::Resources::Content]
+    attr_reader :content
+
+    # @return [ModerationAPI::Resources::Account]
+    attr_reader :account
+
+    # @return [ModerationAPI::Resources::Auth]
+    attr_reader :auth
+
+    # @return [ModerationAPI::Resources::Wordlist]
+    attr_reader :wordlist
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @secret_key.nil?
+
+      {"authorization" => "Bearer #{@secret_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param secret_key [String, nil] Defaults to `ENV["MODAPI_SECRET_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["MODERATION_API_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(
+      secret_key: ENV["MODAPI_SECRET_KEY"],
+      base_url: ENV["MODERATION_API_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://api.moderationapi.com/v1"
+
+      if secret_key.nil?
+        raise ArgumentError.new("secret_key is required, and can be set via environ: \"MODAPI_SECRET_KEY\"")
+      end
+
+      @secret_key = secret_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
+      )
+
+      @authors = ModerationAPI::Resources::Authors.new(client: self)
+      @queue = ModerationAPI::Resources::Queue.new(client: self)
+      @actions = ModerationAPI::Resources::Actions.new(client: self)
+      @content = ModerationAPI::Resources::Content.new(client: self)
+      @account = ModerationAPI::Resources::Account.new(client: self)
+      @auth = ModerationAPI::Resources::Auth.new(client: self)
+      @wordlist = ModerationAPI::Resources::Wordlist.new(client: self)
+    end
+  end
+end