Class: ESP::CustomSignature::Definition

Inherits:
Resource show all
Defined in:
lib/esp/resources/custom_signature/definition.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.all ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Definition>

Return a paginated list

Returns:




# File 'lib/esp/resources/custom_signature/definition.rb', line 60

.create(attributes = {}) ⇒ ESP::CustomSignature::Definition

Create a CustomSignature::Definition call-seq -> super.create(attributes={})

Examples:

definition = ESP::CustomSignature::Definition.create(custom_signature_id: 1)

Parameters:

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

    Required hash of custom signature definition attributes.

    Valid Attributes

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/custom_signature/definition.rb', line 65

.find(id) ⇒ ESP::CustomSignature::Definition .find(id, options = {}) ⇒ ESP::CustomSignature::Definition

Find a CustomSignature::Definition by id

call-seq -> find(id, options = {})

Overloads:

  • .find(id, options = {}) ⇒ ESP::CustomSignature::Definition

    Parameters:

    • options (defaults to: {}) —

      | Optional | A hash of options

      Valid Options

      include | The list of associated objects to return on the initial request.

      Valid Includable Associations

      See API documentation for valid arguments

Parameters:

  • id (Integer, Numeric, #to_i) —

    Required ID of the custom signature definition to retrieve

Returns:




# File 'lib/esp/resources/custom_signature/definition.rb', line 42

.where(clauses = {}) ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature::Definition>

Return a list filtered by search parameters

call-seq -> super.where(clauses = {})

Parameters:

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

    A hash of attributes with appended predicates to search, sort and include.

    Valid Clauses

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/custom_signature/definition.rb', line 31

Instance Method Details

#activate ⇒ Net::HTTPSuccess, false

Returns:

  • (Net::HTTPSuccess, false) 


10
11
12
13
14
15
16
17
18
 
# File 'lib/esp/resources/custom_signature/definition.rb', line 10

def activate
  patch(:activate).tap do |response|
    load_attributes_from_response(response)
  end
rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess, ActiveResource::ForbiddenAccess => error
  load_remote_errors(error, true)
  self.code = error.response.code
  false
end

#archive ⇒ Net::HTTPSuccess, false

Returns:

  • (Net::HTTPSuccess, false) 


21
22
23
24
25
26
27
28
29
 
# File 'lib/esp/resources/custom_signature/definition.rb', line 21

def archive
  patch(:archive).tap do |response|
    load_attributes_from_response(response)
  end
rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess, ActiveResource::ForbiddenAccess => error
  load_remote_errors(error, true)
  self.code = error.response.code
  false
end

#destroy ⇒ self

Delete a CustomSignature::Definition

Returns:

  • (self) 



# File 'lib/esp/resources/custom_signature/definition.rb', line 89

#save ⇒ Boolean

Create or update a CustomSignature::Definition

Valid Attributes

See API documentation for valid arguments

Examples:

definition = ESP::CustomSignature::Definition.new(custom_signature_id: 1)
definition.save

Returns:

  • (Boolean) 



# File 'lib/esp/resources/custom_signature/definition.rb', line 77