Class: ESP::Organization

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

Return a paginated list.

Returns:




# File 'lib/esp/resources/organization.rb', line 76

.create ⇒ void

This method returns an undefined value.

Not Implemented. You cannot create an Organization.




# File 'lib/esp/resources/organization.rb', line 81

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

Find an Organization by id

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

Overloads:

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

    Parameters:

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

      Optional 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 organization to retrieve.

Returns:




# File 'lib/esp/resources/organization.rb', line 58

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

Return a paginated 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/organization.rb', line 47

Instance Method Details

#custom_signatures ⇒ ActiveResource::PaginatedCollection<ESP::CustomSignature>

The collection of organizations that belong to the organization.

Returns:



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

has_many :custom_signatures, class_name: 'ESP::CustomSignature'

#destroy ⇒ void

This method returns an undefined value.

Not Implemented. You cannot destroy an Organization.



43
44
45
 
# File 'lib/esp/resources/organization.rb', line 43

def destroy
  fail ESP::NotImplementedError
end

#external_accounts ⇒ ActiveResource::PaginatedCollection<ESP::ExternalAccount>

The collection of external_accounts that belong to the organization.

Returns:



26
 
# File 'lib/esp/resources/organization.rb', line 26

has_many :external_accounts, class_name: 'ESP::ExternalAccount'

#reports ⇒ ActiveResource::PaginatedCollection<ESP::Report>

The collection of reports that belong to the organization.

Returns:



21
 
# File 'lib/esp/resources/organization.rb', line 21

has_many :reports, class_name: 'ESP::Report'

#save ⇒ Boolean

Update an Organization.

Valid Attributes

See API documentation for valid arguments

Returns:

  • (Boolean) 



# File 'lib/esp/resources/organization.rb', line 86

#sub_organizations ⇒ ActiveResource::PaginatedCollection<ESP::SubOrganization>

The collection of sub_organizations that belong to the organization.

Returns:



11
 
# File 'lib/esp/resources/organization.rb', line 11

has_many :sub_organizations, class_name: 'ESP::SubOrganization'

#teams ⇒ ActiveResource::PaginatedCollection<ESP::Team>

The collection of teams that belong to the organization.

Returns:



6
 
# File 'lib/esp/resources/organization.rb', line 6

has_many :teams, class_name: 'ESP::Team'

#users ⇒ ActiveResource::PaginatedCollection<ESP::User>

The collection of users that belong to the organization.

Returns:



16
 
# File 'lib/esp/resources/organization.rb', line 16

has_many :users, class_name: 'ESP::User'