Method: Courier::ListsClient#get

Defined in:
lib/trycourier/lists/client.rb

#get(list_id:, request_options: nil) ⇒ Lists::List

Returns a list based on the list ID provided.

Parameters:

  • list_id (String) —

    A unique identifier representing the list you wish to retrieve.

  • request_options (RequestOptions) (defaults to: nil)

Returns:



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/trycourier/lists/client.rb', line 51

def get(list_id:, request_options: nil)
  response = @request_client.conn.get("/lists/#{list_id}") do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    unless request_options&.authorization_token.nil?
      req.headers["Authorization"] =
        request_options.authorization_token
    end
    req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
  end
  Lists::List.from_json(json_object: response.body)
end