Class: ESP::SubOrganization

Inherits:
Resource show all
Defined in:
lib/esp/resources/sub_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::SubOrganization>

Return a paginated SubOrganization list

Returns:




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

.create(attributes = {}) ⇒ ESP::SubOrganization

Create a SubOrganization. call-seq -> super.create(attributes={})

Examples:

sub_organization = ESP::SubOrganization.create(name: "Sub Organization Name")

Parameters:

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

    Required hash of run arguments.

    Valid Attributes

    See API documentation for valid arguments

Returns:




# File 'lib/esp/resources/sub_organization.rb', line 55

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

Find a SubOrganization by id

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

Parameters:

  • id (Integer, Numeric, #to_i) —

    Required ID of the sub organization to retrieve.

  • 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

Returns:




# File 'lib/esp/resources/sub_organization.rb', line 34

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

Return a paginated SubOrganization 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/sub_organization.rb', line 23

Instance Method Details

#destroy ⇒ self

Delete a SubOrganization.

Returns:

  • (self) 



# File 'lib/esp/resources/sub_organization.rb', line 79

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

The collection of external_accounts that belong to the sub organization.

Returns:



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

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

#organization ⇒ ESP::Organization

The organization this sub organization belongs to.

Returns:



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

belongs_to :organization, class_name: 'ESP::Organization'

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

The collection of reports that belong to the sub organization.

Returns:



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

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

#save(attributes = {}) ⇒ Boolean

Create and update a SubOrganization.

Examples:

sub_organization = ESP::SubOrganization.new(name: "Sub Organization Name")
sub_organization.save

Parameters:

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

    Required hash of run arguments.

    Valid Attributes

    See API documentation for valid arguments

Returns:

  • (Boolean) 



# File 'lib/esp/resources/sub_organization.rb', line 67

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

The collection of teams that belong to the sub organization.

Returns:



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

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