Class: Postmen::LabelCollection

Inherits:

Object

• Object
• Postmen::LabelCollection

Includes:

CollectionProxy

Defined in:

lib/postmen/label_collection.rb

Overview

This class wraps the array of Label models

Class Method Summary

• .all(options = {}) ⇒ Object

  Fetch all labels.

• .create(params) ⇒ Label

  Creates a label.

• .find(id) ⇒ Label

  Fetch single label.

Methods included from CollectionProxy

included, #initialize

Class Method Details

.all(options = {}) ⇒ Object

Fetch all labels.

Examples:

.all # Returns all labels, default query.
.all(status: :cancelled) # Returns only cancelled labels

Parameters:

• options (Hash) (defaults to: {}) —

  Options for the query.

See Also:

• API documentation

# File 'lib/postmen/label_collection.rb', line 16

def self.all(options = {})
  new(Connection.new.get('/labels', LabelQuery.new(options).to_query).parsed_response)
end

.create(params) ⇒ Label

Creates a label

Parameters:

• params (Hash) —

  Label params

Returns:

• (Label)

See Also:

• API documentation

# File 'lib/postmen/label_collection.rb', line 35

def self.create(params)
  Label.new(Connection.new.post('/labels', CreateLabelQuery.new(params).to_query).parsed_response[:data])
end

.find(id) ⇒ Label

Fetch single label

Parameters:

• id (UUID) —

  Label UUID

Returns:

• (Label)

Raises:

• ResourceNotFound if label with given id was not fount

See Also:

• API documentation

# File 'lib/postmen/label_collection.rb', line 26

def self.find(id)
  get(Connection.new.get("/labels/#{id}").parsed_response)
end