Class: ESP::Region

Inherits:
Resource show all
Defined in:
lib/esp/resources/region.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::Region>

Return a paginated list.

Returns:




# File 'lib/esp/resources/region.rb', line 50

.find(id) ⇒ ESP::Region

Find a Region by id

call-seq -> super.find(id)

Parameters:

  • id (Integer, Numeric, #to_i) —

    Required ID of the region to retrieve.

Returns:




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

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

Return a paginated Region list filtered by search parameters

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

Parameters:

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

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

    Valid Clauses

    See API documentation for valid arguments

Returns:




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

Instance Method Details

#destroy ⇒ void

This method returns an undefined value.

Not Implemented. You cannot destroy a Region.



13
14
15
 
# File 'lib/esp/resources/region.rb', line 13

def destroy
  fail ESP::NotImplementedError
end

#save ⇒ void

This method returns an undefined value.

Not Implemented. You cannot create or update a Region.



6
7
8
 
# File 'lib/esp/resources/region.rb', line 6

def save
  fail ESP::NotImplementedError
end

#suppress(arguments = {}) ⇒ ESP::Suppression::Region

Create a suppression for this region.

Examples:

suppress(external_account_ids: [5], reason: 'My very good reason for creating this suppression')

Parameters:

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

    Required hash of region suppression attributes.

    Valid Arguments

    See API documentation for valid arguments

Returns:



26
27
28
29
 
# File 'lib/esp/resources/region.rb', line 26

def suppress(arguments = {})
  arguments = arguments.with_indifferent_access
  ESP::Suppression::Region.create(regions: [code], external_account_ids: Array(arguments[:external_account_ids]), reason: arguments[:reason])
end