Class: Moonbase::Resources::Funnels

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

Overview

Manage your collections and items

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Funnels

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

Parameters:



134
135
136
 
# File 'lib/moonbase/resources/funnels.rb', line 134

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, steps: nil, request_options: {}) ⇒ Moonbase::Models::Funnel

Creates a new funnel.

Parameters:

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/moonbase/resources/funnels.rb', line 20

def create(params)
  parsed, options = Moonbase::FunnelCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "funnels",
    body: parsed,
    model: Moonbase::Funnel,
    options: options
  )
end

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

Permanently deletes a funnel.

Parameters:

Returns:

  • (nil)

See Also:



122
123
124
125
126
127
128
129
 
# File 'lib/moonbase/resources/funnels.rb', line 122

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

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

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

Returns a list of funnels.

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:



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/moonbase/resources/funnels.rb', line 98

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

#retrieve(id, request_options: {}) ⇒ Moonbase::Models::Funnel

Retrieves the details of an existing funnel.

Parameters:

  • id (String) —

    The ID of the funnel to retrieve.

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

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/moonbase/resources/funnels.rb', line 42

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["funnels/%1$s", id],
    model: Moonbase::Funnel,
    options: params[:request_options]
  )
end

#update(id, name: nil, steps: nil, request_options: {}) ⇒ Moonbase::Models::Funnel

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

Updates a funnel.

Parameters:

Returns:

See Also:



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

def update(id, params = {})
  parsed, options = Moonbase::FunnelUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["funnels/%1$s", id],
    body: parsed,
    model: Moonbase::Funnel,
    options: options
  )
end