Class: MailerLite::Batch

Inherits:

Object

• Object
• MailerLite::Batch

Defined in:

lib/mailerlite/batch/batch.rb

Overview

This is a class for manipulating the Batch from MailerLite API.

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

Instance Method Summary

• #initialize(client: MailerLite::Client.new) ⇒ Batch constructor

  Inits the ‘Batch` class with the specified `client`.

• #request(requests:) ⇒ HTTP::Response

  Create a Batch Request.

Constructor Details

#initialize(client: MailerLite::Client.new) ⇒ Batch

Inits the ‘Batch` class with the specified `client`.

Parameters:

• client (MailerLite::Client) (defaults to: MailerLite::Client.new) —

  the ‘Client` instance to use

# File 'lib/mailerlite/batch/batch.rb', line 11

def initialize(client: MailerLite::Client.new)
  @client = client
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/mailerlite/batch/batch.rb', line 6

def client
  @client
end

Instance Method Details

#request(requests:) ⇒ HTTP::Response

Create a Batch Request

Parameters:

• requests (Array) —

  Array of objects containing required method and path properties and optional body

Returns:

• (HTTP::Response) —

  the response from the API

# File 'lib/mailerlite/batch/batch.rb', line 19

def request(requests:)
  params = { requests: requests }
  client.http.post("#{MAILERLITE_API_URL}/batch", body: params.to_json)
end