Class: Moonbase::Resources::Programs

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

Overview

Manage your marketing campaigns and forms

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Programs

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

Parameters:



69
70
71
 
# File 'lib/moonbase/resources/programs.rb', line 69

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

Returns a list of your marketing programs.

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:



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/moonbase/resources/programs.rb', line 53

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

#retrieve(id, include: nil, request_options: {}) ⇒ Moonbase::Models::Program

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

Retrieves the details of an existing program.

Parameters:

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/moonbase/resources/programs.rb', line 23

def retrieve(id, params = {})
  parsed, options = Moonbase::ProgramRetrieveParams.dump_request(params)
  query = Moonbase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["programs/%1$s", id],
    query: query,
    model: Moonbase::Program,
    options: options
  )
end