Module: Insightly2::DSL::ProjectCategories

Included in:
Insightly2::DSL
Defined in:
lib/insightly2/dsl/project_categories.rb

Instance Method Summary collapse

Instance Method Details

#create_project_category(category: nil) ⇒ Insightly2::Resources::ProjectCategory?

POST /v2.1/ProjectCategories Create a project category.

Parameters:

  • category: (Hash) (defaults to: nil) —

    The project category to create.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



27
28
29
30
 
# File 'lib/insightly2/dsl/project_categories.rb', line 27

def create_project_category(category: nil)
  raise ArgumentError, "Category cannot be blank" if category.blank?
  Resources::ProjectCategory.parse(request(:post, "ProjectCategories", category))
end

#delete_project_category(id: nil) ⇒ Faraday::Response

DELETE /v2.1/ProjectCategories/id Delete a project category.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    A project category’s ID.

Returns:

  • (Faraday::Response) —

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



47
48
49
50
 
# File 'lib/insightly2/dsl/project_categories.rb', line 47

def delete_project_category(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  request(:delete, "ProjectCategories/#{id}")
end

#get_project_categories ⇒ Array?

GET /v2.1/ProjectCategories Get a list of project categories.

Returns:

  • (Array, nil) —

    .



18
19
20
 
# File 'lib/insightly2/dsl/project_categories.rb', line 18

def get_project_categories
  Resources::ProjectCategory.parse(request(:get, "ProjectCategories"))
end

#get_project_category(id: nil) ⇒ Insightly2::Resources::ProjectCategory?

GET /v2.1/ProjectCategories/id Get a project category.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    A project category’s ID.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



10
11
12
13
 
# File 'lib/insightly2/dsl/project_categories.rb', line 10

def get_project_category(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::ProjectCategory.parse(request(:get, "ProjectCategories/#{id}"))
end

#update_project_category(category: nil) ⇒ Insightly2::Resources::ProjectCategory?

PUT /v2.1/ProjectCategories Update a project category.

Parameters:

  • category (Hash) (defaults to: nil) —

    The project category to update.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



37
38
39
40
 
# File 'lib/insightly2/dsl/project_categories.rb', line 37

def update_project_category(category: nil)
  raise ArgumentError, "Category cannot be blank" if category.blank?
  Resources::ProjectCategory.parse(request(:put, "ProjectCategories", category))
end