Class: Moonbase::Resources::Unsubscribes

Inherits:
Object
  • Object
show all
Defined in:
lib/moonbase/resources/unsubscribes.rb

Overview

Manage your marketing campaigns and forms

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Unsubscribes

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 Unsubscribes.

Parameters:



82
83
84
 
# File 'lib/moonbase/resources/unsubscribes.rb', line 82

def initialize(client:)
  @client = client
end

Instance Method Details

#create(email:, request_options: {}) ⇒ Moonbase::Models::Unsubscribe

Create a new unsubscribe.

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/moonbase/resources/unsubscribes.rb', line 17

def create(params)
  parsed, options = Moonbase::UnsubscribeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "unsubscribes",
    body: parsed,
    model: Moonbase::Unsubscribe,
    options: options
  )
end

#delete(email, request_options: {}) ⇒ nil

Permanently deletes an unsubscribe by email address.

Parameters:

  • email (String) —

    The email address of the unsubscribe to delete.

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

Returns:

  • (nil)

See Also:



70
71
72
73
74
75
76
77
 
# File 'lib/moonbase/resources/unsubscribes.rb', line 70

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

#list(after: nil, before: nil, limit: nil, request_options: {}) ⇒ Moonbase::Internal::CursorPage<Moonbase::Models::Unsubscribe>

Some parameter documentations has been truncated, see Models::UnsubscribeListParams for more details.

Returns a list of unsubscribes.

Parameters:

  • after (String) —

    When specified, returns results starting immediately after the item identified b

  • before (String) —

    When specified, returns results starting immediately before the item identified

  • limit (Integer) —

    Maximum number of items to return per page. Must be between 1 and 100. Defaults

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

Returns:

See Also:



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/moonbase/resources/unsubscribes.rb', line 46

def list(params = {})
  parsed, options = Moonbase::UnsubscribeListParams.dump_request(params)
  query = Moonbase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "unsubscribes",
    query: query,
    page: Moonbase::Internal::CursorPage,
    model: Moonbase::Unsubscribe,
    options: options
  )
end