Module: M2X::Client::Metadata

Included in:
Collection, Device, Distribution
Defined in:
lib/m2x/metadata.rb

Instance Method Summary collapse

Instance Method Details

#metadata_path ⇒ Object 



54
55
56
 
# File 'lib/m2x/metadata.rb', line 54

def metadata_path
  "#{path}/metadata"
end

#read_metadata ⇒ Response

Method for Read Device Metadata, Read Distribution Metadata, Read Collection Metadata endpoints.

Returns:

  • (Response) —

    The API response, see M2X API docs for details



10
11
12
 
# File 'lib/m2x/metadata.rb', line 10

def read_metadata
  @client.get(metadata_path)
end

#read_metadata_field(field_name) ⇒ Response

Method for Read Device Metadata Field, Read Distribution Metadata Field, Read Collection Metadata Field endpoints.

Parameters:

  • field_name (String) —

    The metada field to be read

Returns:

  • (Response) —

    The API response, see M2X API docs for details



23
24
25
 
# File 'lib/m2x/metadata.rb', line 23

def read_metadata_field(field_name)
  @client.get("#{metadata_path}/#{field_name}")
end

#update_metadata(params) ⇒ Response

Method for Update Device Metadata, Update Distribution Metadata, Update Collection Metadata endpoints.

Parameters:

  • params —

    Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.

Returns:

  • (Response) —

    The API response, see M2X API docs for details



36
37
38
 
# File 'lib/m2x/metadata.rb', line 36

def update_metadata(params)
  @client.put(metadata_path, nil, params, "Content-Type" => "application/json")
end

#update_metadata_field(field_name, value) ⇒ Response

Method for Update Device Metadata Field, Update Distribution Metadata Field, Update Collection Metadata Field endpoints.

Parameters:

  • field_name (String) —

    The metadata field to be updated

  • value (String) —

    The value to be updated

Returns:

  • (Response) —

    The API response, see M2X API docs for details



50
51
52
 
# File 'lib/m2x/metadata.rb', line 50

def update_metadata_field(field_name, value)
  @client.put("#{metadata_path}/#{field_name}", nil, { value: value }, "Content-Type" => "application/json")
end