Class: Courier::Resources::Requests

Inherits:
Object
  • Object
show all
Defined in:
lib/courier/resources/requests.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Requests

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Requests.

Parameters:



29
30
31
 
# File 'lib/courier/resources/requests.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(request_id, request_options: {}) ⇒ nil

Archive message

Parameters:

  • request_id (String) —

    A unique identifier representing the request ID

  • request_options (Courier::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/courier/resources/requests.rb', line 17

def archive(request_id, params = {})
  @client.request(
    method: :put,
    path: ["requests/%1$s/archive", request_id],
    model: NilClass,
    options: params[:request_options]
  )
end