Class: Moonbase::Resources::Collections

Inherits:
Object
  • Object
show all
Defined in:
lib/moonbase/resources/collections.rb,
lib/moonbase/resources/collections/items.rb,
lib/moonbase/resources/collections/fields.rb

Overview

Manage your collections and items

Defined Under Namespace

Classes: Fields, Items

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Collections

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

Parameters:



123
124
125
126
127
 
# File 'lib/moonbase/resources/collections.rb', line 123

def initialize(client:)
  @client = client
  @fields = Moonbase::Resources::Collections::Fields.new(client: client)
  @items = Moonbase::Resources::Collections::Items.new(client: client)
end

Instance Attribute Details

#fields ⇒ Moonbase::Resources::Collections::Fields (readonly)

Manage your collections and items

Returns:



9
10
11
 
# File 'lib/moonbase/resources/collections.rb', line 9

def fields
  @fields
end

#items ⇒ Moonbase::Resources::Collections::Items (readonly)

Manage your collections and items

Returns:



13
14
15
 
# File 'lib/moonbase/resources/collections.rb', line 13

def items
  @items
end

Instance Method Details

#create(name:, description: nil, request_options: {}) ⇒ Moonbase::Models::Collection

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

Creates a new collection with default fields (name, created_at, updated_at) and a default view.

Parameters:

  • name (String) —

    The user-facing name of the collection (e.g., “Leads”). A ‘ref` is automatically

  • description (String) —

    An optional, longer-form description of the collection’s purpose.

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

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/moonbase/resources/collections.rb', line 32

def create(params)
  parsed, options = Moonbase::CollectionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "collections",
    body: parsed,
    model: Moonbase::Collection,
    options: options
  )
end

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

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

Returns a list of your collections.

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:



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/moonbase/resources/collections.rb', line 107

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

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

Retrieves the details of an existing collection.

Parameters:

  • id (String) —

    The ID or ‘ref` of the Collection to retrieve.

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

Returns:

See Also:



54
55
56
57
58
59
60
61
 
# File 'lib/moonbase/resources/collections.rb', line 54

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

#update(id, description: nil, name: nil, request_options: {}) ⇒ Moonbase::Models::Collection

Updates an existing collection.

Parameters:

  • id (String) —

    The ID or ‘ref` of the Collection to update.

  • description (String) —

    An optional, longer-form description of the collection’s purpose.

  • name (String) —

    The user-facing name of the collection.

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

Returns:

See Also:



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/moonbase/resources/collections.rb', line 78

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