module M2X::Client::Metadata

Public Instance Methods

metadata_path() click to toggle source
# File lib/m2x/metadata.rb, line 54
def metadata_path
  "#{path}/metadata"
end
read_metadata() click to toggle source

Method for {m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata Read Device Metadata}, {m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata Read Distribution Metadata}, {m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata Read Collection Metadata} endpoints. @return {Response} The API response, see M2X API docs for details

# File lib/m2x/metadata.rb, line 10
def read_metadata
  @client.get(metadata_path)
end
read_metadata_field(field_name) click to toggle source

Method for {m2x.att.com/developer/documentation/v2/device#Read-Device-Metadata-Field Read Device Metadata Field}, {m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field Read Distribution Metadata Field}, {m2x.att.com/developer/documentation/v2/collections#Read-Collection-Metadata-Field Read Collection Metadata Field} endpoints.

@param (String) field_name The metada field to be read @return {Response} The API response, see M2X API docs for details

# File lib/m2x/metadata.rb, line 23
def read_metadata_field(field_name)
  @client.get("#{metadata_path}/#{field_name}")
end
update_metadata(params) click to toggle source

Method for {m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata Update Device Metadata}, {m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata Update Distribution Metadata}, {m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata Update Collection Metadata} endpoints.

@param params Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters. @return {Response} The API response, see M2X API docs for details

# 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) click to toggle source

Method for {m2x.att.com/developer/documentation/v2/device#Update-Device-Metadata-Field Update Device Metadata Field}, {m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field Update Distribution Metadata Field}, {m2x.att.com/developer/documentation/v2/collections#Update-Collection-Metadata-Field Update Collection Metadata Field} endpoints.

@param (String) field_name The metadata field to be updated @param (String) value The value to be updated @return {Response} The API response, see M2X API docs for details

# 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