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 



39
40
41
 
# File 'lib/m2x/metadata.rb', line 39

def metadata_path
  "#{path}/metadata"
end

#read_metadata ⇒ Object

Read an object’s metadata

m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata



8
9
10
 
# File 'lib/m2x/metadata.rb', line 8

def read_metadata
  @client.get(metadata_path)
end

#read_metadata_field(field_name) ⇒ Object

Read a single field of an object’s metadata

m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata-Field m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata-Field



17
18
19
 
# File 'lib/m2x/metadata.rb', line 17

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

#update_metadata(params) ⇒ Object

Update an object’s metadata

m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata



26
27
28
 
# File 'lib/m2x/metadata.rb', line 26

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

#update_metadata_field(field_name, value) ⇒ Object

Update a single field of an object’s metadata

m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata-Field m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata-Field



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

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