Class: Moonbase::Resources::Collections::Fields

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

Overview

Manage your collections and items

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Fields

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

Parameters:



119
120
121
 
# File 'lib/moonbase/resources/collections/fields.rb', line 119

def initialize(client:)
  @client = client
end

Instance Method Details

#create(collection_id, field:, request_options: {}) ⇒ Moonbase::Models::SingleLineTextField, ...

Creates a new field in a collection.

Parameters:

Returns:

See Also:



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

def create(collection_id, params)
  parsed, options = Moonbase::Collections::FieldCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["collections/%1$s/fields", collection_id],
    body: parsed[:field],
    model: Moonbase::Field,
    options: options
  )
end

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

Permanently deletes a field from a collection.

Parameters:

  • id (String) —

    The ID or ‘ref` of the Field to delete.

  • collection_id (String) —

    The ID or ‘ref` of the Collection the field belongs to.

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

Returns:

  • (nil)

See Also:



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/moonbase/resources/collections/fields.rb', line 102

def delete(id, params)
  parsed, options = Moonbase::Collections::FieldDeleteParams.dump_request(params)
  collection_id =
    parsed.delete(:collection_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["collections/%1$s/fields/%2$s", collection_id, id],
    model: NilClass,
    options: options
  )
end

#retrieve(id, collection_id:, request_options: {}) ⇒ Moonbase::Models::SingleLineTextField, ...

Retrieves the details of a field in a collection.

Parameters:

  • id (String) —

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

  • collection_id (String) —

    The ID or ‘ref` of the Collection the field belongs to.

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

Returns:

See Also:



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

def retrieve(id, params)
  parsed, options = Moonbase::Collections::FieldRetrieveParams.dump_request(params)
  collection_id =
    parsed.delete(:collection_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["collections/%1$s/fields/%2$s", collection_id, id],
    model: Moonbase::Field,
    options: options
  )
end

#update(id, collection_id:, field:, request_options: {}) ⇒ Moonbase::Models::SingleLineTextField, ...

Updates an existing field in a collection.

Parameters:

Returns:

See Also:



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

def update(id, params)
  parsed, options = Moonbase::Collections::FieldUpdateParams.dump_request(params)
  collection_id =
    parsed.delete(:collection_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["collections/%1$s/fields/%2$s", collection_id, id],
    body: parsed[:field],
    model: Moonbase::Field,
    options: options
  )
end