mailchimp-rest-api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8e4ac41f0ff072d449fab1c0466bed09d533def2a97db463a0dd76e47aaef2
-  data.tar.gz: 24fccb0d0eb4175d77055bdd5ce4e935789cbd5b6ed700d17f7d98ab86ada034
+  metadata.gz: 2154d72e46deb2e45329e343e31978620eaec64932172d32a2b2e5bf69ae0869
+  data.tar.gz: 50479343dea5a9306058079839f9ac82b001a95933608736eefcd4f078cf45db
 SHA512:
-  metadata.gz: 8cc1fa18308afd486cb4418317f8809d9e2758df9a1ea4087aaea57ba66db3570ae91fc99faccd8472a4663f22800151519b5c4c350f750f275a484c147544fe
-  data.tar.gz: 0df6d93f8742d35b73372a5b7ce139723102261f046243e77bcb30f90937fa519a93e0c1fd4e267bc67bb5a38c9932907d5a2373a0f27ac49f81d763bd4465f5
+  metadata.gz: a212a5f4d5794f27bc00a47eaa2d24e5f9d1d982621ea3951f32442693c79ebb81dfebb34fda96936d77c1b4421c80752a502eed25ea202f99d619d06d61c478
+  data.tar.gz: 683cf77583595b8a7992b92d0d1fa1151a22c484ed16f95c89c49a5832fc4a619b60447fc2c303fae2be7ff7abe279d3673d8c0d7416514f41e7d325cb3fa3ca

data/README.md

@@ -1,99 +1,140 @@
 # Mailchimp REST API (Marketing)
 
+A Ruby gem for interacting with the Mailchimp Marketing API. This gem provides a clean, intuitive interface for working
+with Mailchimp's REST API, featuring automatic retries, pagination support, and comprehensive error handling.
+
+## Features
+
+- Supports Ruby versions: 2.6 through 3.3, head, jruby-9.4, truffleruby-24
+- Zero dependencies
+- Configurable auto-retries
+- Built-in pagination support
+- Comprehensive error handling
+- Clean, intuitive API interface
+
 ## Installation
 
-```bash
-bundle add mailchimp-rest-api
+Add this line to your application's Gemfile:
+
+```console
+gem 'mailchimp-rest-api'
 ```
 
-## Features
+And then execute:
+
+```console
+bundle install
+```
+
+## Quick Start
+
+```ruby
+# Configure the client
+MailchimpAPI.client = MailchimpAPI::Client.new(
+  api_key: ENV['MAILCHIMP_API_KEY']
+)
+
+# Example: Add a member to an audience
+response = MailchimpAPI.audience_members.create(
+  'audience_id',
+  body: {
+    email_address: 'user@example.com',
+    status: 'subscribed',
+    merge_fields: {
+      FNAME: 'John',
+      LNAME: 'Doe'
+    }
+  }
+)
+
+puts response.body[:status]
+```
+
+## Configuration
 
-- Supported Ruby Versions - *(2.6 .. 3.3), head, jruby-9.4, truffleruby-24*
-- No dependencies;
-- Auto-retries (configured);
-- Pagination methods
+### Client Configuration
 
-## Usage
+The client accepts several configuration options:
 
 ```ruby
-# Setup client
-MailchimpAPI.client = MailchimpAPI::Client.new(api_key: ENV['MAILCHIMP_API_KEY'])
-
-# Call any HTTP API
-MailchimpAPI.post(path, query: query, body: body, headers: headers)
-MailchimpAPI.get(path, query: query, body: body, headers: headers)
-MailchimpAPI.patch(path, query: query, body: body, headers: headers)
-MailchimpAPI.put(path, query: query, body: body, headers: headers)
-MailchimpAPI.delete(path, query: query, body: body, headers: headers)
-
-# Call any defined REST API (defined in lib/resources)
-MailchimpAPI::Audience::Members.show(audience_id, email, query: query)
-MailchimpAPI::Audience::Members.create(audience_id, body: body)
-
-# Or call it via shortcuts (defined in lib/client/api_methods.rb)
-MailchimpAPI.audience_members.show(audience_id, email, query: query)
-MailchimpAPI.audience_members.create(audience_id, body: body)
+client = MailchimpAPI::Client.new(
+  api_key: ENV['MAILCHIMP_API_KEY'],
+  retries: {
+    enabled: true,
+    count: 4,
+    sleep: [0, 0.25, 0.75, 1.5]  # Retry delays in seconds
+  },
+  http_opts: {
+    read_timeout: 30,
+    write_timeout: 30,
+    open_timeout: 30
+  }
+)
 ```
 
-### Response
+### Retry Configuration
+
+By default, the client will retry failed requests with the following configuration:
 
-`Response` object is returned after each `API` request.
+- Enabled: true
+- Retry count: 4
+- Delay between retries: 0, 0.25, 0.75, 1.5 seconds
 
-#### Original HTTP response data
+Retries are triggered for:
 
-- `response.http_status` - response HTTP status as Integer
-- `response.http_body` - response body as String
-- `response.http_headers` - response headers as Hash with String keys
-- `response.http_response` - original Net::HTTP::Response object
-- `response.request` - Request object that was used to get this response
+- Network errors
+- HTTP status codes: 409, 429, and 5xx responses
 
-#### Parsed JSON body methods
+### HTTP Options
 
-- `response.body` - parsed JSON body, keys are Symbols
-- `response[:field]` - gets `:field` attribute from parsed body,
-  returns nil if response have no such key
-- `response.fetch(:field)` - gets `:field` attribute from parsed body,
-  raises KeyError if response has no such key
+You can configure various HTTP options that are passed to `Net::HTTP.start`. Common options include:
 
-#### Error check methods
+- `read_timeout`
+- `write_timeout`
+- `open_timeout`
 
-- `response.success?` - checks HTTP status code is 2xx
-- `response.failed?` - checks HTTP status code is not 2xx
+## API Usage
 
-## Errors
+### Making Requests
 
-All error classes inherit from `MailchimpAPI::Error` and provide:
+You can make HTTP requests directly:
 
-- `error_type` - Error type returned by Mailchimp
-- `error_title` - Error title or response error class name
-- `error_status` - Error status or HTTP status
-- `error_detail` - Error description from Mailchimp
-- `error_fields` - Field-specific errors
-- `error_instance` - Error ID from Mailchimp
-- `response` - Response object
-- `request` - Request object
+```ruby
+# GET request
+response = MailchimpAPI.get('/lists/<list_id>/members')
+
+# POST request
+response = MailchimpAPI.post(
+  '/lists/<list_id>/members',
+  body: { email_address: 'user@example.com' }
+)
+```
 
-MailchimpAPI provides specific error classes for different types of errors:
+### Working with Responses
+
+The response object provides several useful methods:
+
+```ruby
+response = MailchimpAPI.get('/some/path')
 
-### Network Errors
+# Check response status
+response.success?  # true for 2xx status codes
+response.failed?   # true for non-2xx status codes
 
-- `MailchimpAPI::Errors::NetworkError` - Raised when a network error occurs
-  during request execution
+# Access response data
+response.body      # Parsed JSON body (symbolized keys)
+response[:field]   # Access specific field (returns nil if missing)
+response.fetch(:field)  # Access field (raises KeyError if missing)
 
-### HTTP Status Code Errors
+# Access HTTP details
+response.http_status
+response.http_body
+response.http_headers
+```
 
-- `MailchimpAPI::Errors::BadRequest` (400) - Invalid request parameters
-- `MailchimpAPI::Errors::Unauthorized` (401) - Invalid API key
-- `MailchimpAPI::Errors::Forbidden` (403) - Insufficient permissions
-- `MailchimpAPI::Errors::NotFound` (404) - Resource not found
-- `MailchimpAPI::Errors::MethodNotAllowed` (405) - HTTP method not allowed
-- `MailchimpAPI::Errors::RequestURITooLong` (414) - Request URI too long
-- `MailchimpAPI::Errors::UnprocessableEntity` (422) - Request validation failed
-- `MailchimpAPI::Errors::UpgradeRequired` (426) - API version upgrade required
-- `MailchimpAPI::Errors::TooManyRequests` (429) - Rate limit exceeded
-- `MailchimpAPI::Errors::ServerError` (5xx) - Mailchimp server error
+### Error Handling
 
-Example:
+The gem provides specific error classes for different types of errors:
 
 ```ruby
 begin
@@ -106,129 +147,130 @@ rescue MailchimpAPI::Errors::NetworkError => e
 end
 ```
 
-## Configuration options
-
-MailchimpAPI client accepts this additional options:
-
-- `:retries`
-- `:http_opts`
-
-### Option `:retries`
+Available error classes:
 
-This is a Hash with retries configuration.
-By default retries are enabled, 4 retries with 0, 0.25, 0.75, 1.5 seconds delay.
-Default config: `{enabled: true, count: 4, sleep: [0, 0.25, 0.75, 1.5]}`.
-New options are merged with defaults.
-Please keep `sleep` array same size as `count`.
+- `NetworkError` - Network-related issues
+- `BadRequest` (400) - Invalid request parameters
+- `Unauthorized` (401) - Invalid API key
+- `Forbidden` (403) - Insufficient permissions
+- `NotFound` (404) - Resource not found
+- `UnprocessableEntity` (422) - Request validation failed
+- `TooManyRequests` (429) - Rate limit exceeded
+- `ServerError` (5xx) - Mailchimp server error
 
-Retries happen on any network error, on 409, 429, 5xx response status code.
-
-```ruby
-client = MailchimpAPI::Client.new(
-  retries: {enabled: !Rails.env.test?, count: 5, sleep: [0, 0.25, 0.75, 1.5, 2]}
-  # ...
-)
-```
+## Resources
 
-### Option `:http_opts`
+Most resources support this APIs:
 
-This are the options that are provided to the `Net::HTTP.start` method,
-like `:read_timeout`, `:write_timeout`, etc.
+- `list` - List items
+- `create` - Create new item
+- `show` - Get item details
+- `update` - Update item
+- `delete` - Delete item
+- `each` - Iterate through items
 
-You can find full list of available options here <https://docs.ruby-lang.org/en/master/Net/HTTP.html#method-c-start>
-(Please choose you version of ruby).
+### MailchimpAPI.audience_members
 
-By default it is an empty hash.
+- `list(list_id)` - List members
+- `create(list_id, body: { email_address: 'x', status: 'x' })` - Add member
+- `show(list_id, email)` - Get member
+- `update(list_id, email, body: { status: 'x' })` - Update member
+- `archive(list_id, email)` - Archive member
+- `add_or_update(list_id, email, body: { status: 'x' })` - Upsert member
+- `delete_permanent(list_id, email)` - Permanently delete
+- `each(list_id)` - Iterate members
 
-```ruby
-client = MailchimpAPI::Client.new(
-  http_opts: {read_timeout: 30, write_timeout: 30, open_timeout: 30}
-  # ...
-)
-```
+### MailchimpAPI.audience_member_tags
 
-## Pagination
+- `list(list_id, email)` - List tags
+- `create(list_id, email, body: { tags: [{name: 'x'}] })` - Add tags
+- `each(list_id, email)` - Iterate tags
 
-We have two specific methods:
+### MailchimpAPI.audience_segments
 
-- `MailchimpAPI#each_page(response)` - iterates over current and each next page
-  response
-- `MailchimpAPI#each_page_item(response, items: :members)` - iterates over
-  each item (each member in this case)
+- `list(list_id)` - List segments
+- `create(list_id, body: { name: 'x' })` - Create segment
+- `show(list_id, segment_id)` - Get segment
+- `update(list_id, segment_id, body: { name: 'x' })` - Update segment
+- `delete(list_id, segment_id)` - Delete segment
+- `batch_add_or_remove_members(list_id, segment_id, body: { members_to_add: [] })` - Bulk modify
+- `each(list_id)` - Iterate segments
 
-Example:
+### MailchimpAPI.audience_segment_members
 
-```ruby
-first_page = MailchimpAPI.audience_members.list(list_id, query: { count: 100 }
+- `list(list_id, segment_id)` - List segment members
+- `create(list_id, segment_id, body: { email_address: 'x' })` - Add segment member
+- `delete(list_id, segment_id, email)` - Remove segment member
+- `each(list_id, segment_id)` - Iterate segment members
 
-MailchimpAPI.each_page(first_page) do |response|
-  puts response.body
-end
+### MailchimpAPI.audience_interest_categories
 
-MailchimpAPI.each_page_item(first_page, items: :members) do |item|
-  puts item[:email_address]
-end
-```
+- `list(list_id)` - List categories
+- `create(list_id, body: { title: 'x', type: 'x' })` - Create category
+- `show(list_id, category_id)` - Get category
+- `update(list_id, category_id, body: { title: 'x' })` - Update category
+- `delete(list_id, category_id)` - Delete category
+- `each(list_id)` - Iterate categories
 
-## Request
+### MailchimpAPI.audience_interests
 
-...
+- `list(list_id, category_id)` - List interests
+- `create(list_id, category_id, body: { name: 'x' })` - Create interest
+- `show(list_id, category_id, interest_id)` - Get interest
+- `update(list_id, category_id, interest_id, body: { name: 'x' })` - Update interest
+- `delete(list_id, category_id, interest_id)` - Delete interest
+- `each(list_id, category_id)` - Iterate interests
 
-## APIs
+### MailchimpAPI.audience_webhooks
 
-### Audience Members
+- `list(list_id)` - List webhooks
+- `create(list_id, body: { url: 'x', events: {} })` - Create webhook
+- `show(list_id, webhook_id)` - Get webhook
+- `update(list_id, webhook_id, body: { events: {} })` - Update webhook
+- `delete(list_id, webhook_id)` - Delete webhook
+- `each(list_id)` - Iterate webhooks
 
-- List `MailchimpAPI.audience_members.get(audience_id)`
-- Create `MailchimpAPI.audience_members.create(audience_id, body: body)`
-- Show `MailchimpAPI.audience_members.show(audience_id, email)`
-- Update `MailchimpAPI.audience_members.update(audience_id, email, body: body)`
-- Add or Update `MailchimpAPI.audience_members.add_or_update(audience_id, email, body: body)`
-- Archive `MailchimpAPI.audience_members.delete(audience_id, email)`
-- Delete Permanently `MailchimpAPI.audience_members.delete(audience_id, email)`
+### Pagination
 
-### Audience Member Tags
+Most resources support pagination through the `each` method:
 
-- List `MailchimpAPI.audience_member_tags.get(audience_id, email)`
-- Create `MailchimpAPI.audience_member_tags.create(audience_id, email, body: body)`
+```ruby
+# Iterate through all members
+MailchimpAPI.audience_members.each(audience_id) do |member|
+  puts member['email_address']
+end
 
-### Audience Webhooks
+# Configure page size
+MailchimpAPI.audience_members.each(audience_id, query: { count: 100 }) do |member|
+  puts member['email_address']
+end
+```
 
-- List `MailchimpAPI.audience_webhooks.get(audience_id)`
-- Create `MailchimpAPI.audience_webhooks.create(audience_id, body: body)`
-- Show `MailchimpAPI.audience_webhooks.show(audience_id, webhook_id)`
-- Update `MailchimpAPI.audience_webhooks.update(audience_id, webhook_id, body: body)`
-- Delete `MailchimpAPI.audience_webhooks.delete(audience_id, webhook_id)`
+## Development
 
-### Audience Interest Categories
+After checking out the repo, run:
 
-- List `MailchimpAPI.audience_interest_categories.get(audience_id)`
-- Create `MailchimpAPI.audience_interest_categories.create(audience_id, body: body)`
-- Show `MailchimpAPI.audience_interest_categories.show(audience_id, webhook_id)`
-- Update `MailchimpAPI.audience_interest_categories.update(audience_id, webhook_id, body: body)`
-- Delete `MailchimpAPI.audience_interest_categories.delete(audience_id, webhook_id)`
+```bash
+bundle install
+```
 
-### Audience Interests
+To run tests:
 
-- List `MailchimpAPI.audience_interests.get(audience_id)`
-- Create `MailchimpAPI.audience_interests.create(audience_id, body: body)`
-- Show `MailchimpAPI.audience_interests.show(audience_id, webhook_id)`
-- Update `MailchimpAPI.audience_interests.update(audience_id, webhook_id, body: body)`
-- Delete `MailchimpAPI.audience_interests.delete(audience_id, webhook_id)`
+```bash
+bundle exec rspec
+```
 
-## Development
+To run linters:
 
 ```bash
-  rubocop
-  rspec
-  mdl README.md CHANGELOG.md RELEASE.md
+bundle exec rubocop
+bundle exec mdl README.md CHANGELOG.md RELEASE.md
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/aglushkov/mailchimp-rest-api>.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/andreyruby/mailchimp-rest-api](https://github.com/andreyruby/mailchimp-rest-api).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-[pagination]: #pagination

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.4.0

data/lib/mailchimp-api/batch_request.rb

@@ -1,18 +1,35 @@
 # frozen_string_literal: true
 
 module MailchimpAPI
+  # Internal class for constructing batch operation requests
+  # @api private
   class BatchRequest
+    # API version prefix to be removed from paths
     API_VERSION_PREFIX = "/#{MailchimpAPI::API_VERSION}"
 
-    attr_reader :request, :operation_id
+    # @return [MailchimpAPI::Request] The original request object
+    attr_reader :request
 
+    # @return [String, nil] Optional operation ID for tracking batch operations
+    attr_reader :operation_id
+
+    # Creates a new batch request
+    # @param request [MailchimpAPI::Request] The original request to be batched
+    # @param operation_id [String, nil] Optional operation ID for tracking
     def initialize(request, operation_id: nil)
       @request = request
       @operation_id = operation_id
     end
 
-    # Make a batch operation request
-    # https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#make-a-batch-operations-request
+    # Converts the request into a batch operation format
+    # @return [Hash] The operation in format suitable for `/batch` request
+    # @example
+    #   {
+    #     method: "GET",
+    #     path: "/lists",
+    #     params: { count: 10 },
+    #     operation_id: "get_lists"
+    #   }
     def operation
       operation = {
         method: request.method, # "GET", "POST", "PUT", "PATCH", "DELETE"

data/lib/mailchimp-api/client/api_methods.rb

@@ -2,26 +2,60 @@
 
 module MailchimpAPI
   class Client
-    #
-    # Methods to access API resources
-    #
+    # Methods to access Mailchimp API resources
     module APIMethods
+      # Returns a new instance of Audience::InterestCategories
+      # @return [Audience::InterestCategories] Interest categories resource
+      # @example
+      #   client.audience_interest_categories # => #<MailchimpAPI::Audience::InterestCategories>
       def audience_interest_categories
         Audience::InterestCategories.new(self)
       end
 
+      # Returns a new instance of Audience::Interests
+      # @return [Audience::Interests] Interests resource
+      # @example
+      #   client.audience_interests # => #<MailchimpAPI::Audience::Interests>
       def audience_interests
         Audience::Interests.new(self)
       end
 
+      # Returns a new instance of Audience::MemberTags
+      # @return [Audience::MemberTags] Member tags resource
+      # @example
+      #   client.audience_member_tags # => #<MailchimpAPI::Audience::MemberTags>
       def audience_member_tags
         Audience::MemberTags.new(self)
       end
 
+      # Returns a new instance of Audience::Members
+      # @return [Audience::Members] Members resource
+      # @example
+      #   client.audience_members # => #<MailchimpAPI::Audience::Members>
       def audience_members
         Audience::Members.new(self)
       end
 
+      # Returns a new instance of Audience::Segments
+      # @return [Audience::Segments] Segments resource
+      # @example
+      #   client.audience_segments # => #<MailchimpAPI::Audience::Segments>
+      def audience_segments
+        Audience::Segments.new(self)
+      end
+
+      # Returns a new instance of Audience::SegmentMembers
+      # @return [Audience::SegmentMembers] Segment members resource
+      # @example
+      #   client.audience_segment_members # => #<MailchimpAPI::Audience::SegmentMembers>
+      def audience_segment_members
+        Audience::SegmentMembers.new(self)
+      end
+
+      # Returns a new instance of Audience::Webhooks
+      # @return [Audience::Webhooks] Webhooks resource
+      # @example
+      #   client.audience_webhooks # => #<MailchimpAPI::Audience::Webhooks>
       def audience_webhooks
         Audience::Webhooks.new(self)
       end

data/lib/mailchimp-api/client/batch_methods.rb

@@ -2,30 +2,83 @@
 
 module MailchimpAPI
   class Client
-    #
     # Methods to create and run batch requests
-    #
     module BatchMethods
+      # Creates a new batch GET request
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
+      # @example
+      #   request = client.batch_get_request("/lists", operation_id: "get_lists")
       def batch_get_request(path, query: nil, body: nil, headers: nil, operation_id: nil)
         new_batch_request(Net::HTTP::Get, path, query: query, body: body, headers: headers, operation_id: operation_id)
       end
 
+      # Creates a new batch POST request
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
+      # @example
+      #   request = client.batch_post_request("/lists", body: { name: "New List" }, operation_id: "create_list")
       def batch_post_request(path, query: nil, body: nil, headers: nil, operation_id: nil)
         new_batch_request(Net::HTTP::Post, path, query: query, body: body, headers: headers, operation_id: operation_id)
       end
 
+      # Creates a new batch PUT request
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
+      # @example
+      #   request = client.batch_put_request("/lists/123", body: { name: "Updated List" }, operation_id: "update_list")
       def batch_put_request(path, query: nil, body: nil, headers: nil, operation_id: nil)
         new_batch_request(Net::HTTP::Put, path, query: query, body: body, headers: headers, operation_id: operation_id)
       end
 
+      # Creates a new batch PATCH request
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
+      # @example
+      #   request = client.batch_patch_request("/lists/123", body: { name: "Updated List" }, operation_id: "update_list")
       def batch_patch_request(path, query: nil, body: nil, headers: nil, operation_id: nil)
         new_batch_request(Net::HTTP::Patch, path, query: query, body: body, headers: headers, operation_id: operation_id)
       end
 
+      # Creates a new batch DELETE request
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
+      # @example
+      #   request = client.batch_delete_request("/lists/123", operation_id: "delete_list")
       def batch_delete_request(path, query: nil, body: nil, headers: nil, operation_id: nil)
         new_batch_request(Net::HTTP::Delete, path, query: query, body: body, headers: headers, operation_id: operation_id)
       end
 
+      # Executes a batch of requests
+      # @param batch_requests [Array<BatchRequest>] Array of batch requests to execute
+      # @param query [Hash] Optional query parameters
+      # @return [Response] API response
+      # @example
+      #   requests = [
+      #     client.batch_get_request("/lists", operation_id: "get_lists"),
+      #     client.batch_post_request("/lists", body: { name: "New List" }, operation_id: "create_list")
+      #   ]
+      #   response = client.batch(requests)
       def batch(batch_requests, query: nil)
         operations = batch_requests.map(&:operation)
         post("batches", query: query, body: {operations: operations})
@@ -33,12 +86,18 @@ module MailchimpAPI
 
       private
 
-      # rubocop:disable Metrics/ParameterLists
+      # Creates a new batch request
+      # @param http_method [Net::HTTP::Request] HTTP method class
+      # @param path [String] API endpoint path
+      # @param query [Hash] Optional query parameters
+      # @param body [Hash] Optional request body
+      # @param headers [Hash] Optional request headers
+      # @param operation_id [String] Optional operation ID
+      # @return [BatchRequest] New batch request
       def new_batch_request(http_method, path, query: nil, body: nil, headers: nil, operation_id: nil)
         request = new_request(http_method, path: path, query: query, body: body, headers: headers)
         BatchRequest.new(request, operation_id: operation_id)
       end
-      # rubocop:enable Metrics/ParameterLists
     end
   end
 end