Class: Mailtrap::ProjectsAPI

Inherits:

Object

• Object
• Mailtrap::ProjectsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/projects_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #create(options) ⇒ Project

  Creates a new project.

• #delete(project_id) ⇒ Object

  Deletes a project.

• #get(project_id) ⇒ Project

  Retrieves a specific project.

• #list ⇒ Array<Project>

  Lists all projects for the account.

• #update(project_id, options) ⇒ Project

  Updates an existing project.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#create(options) ⇒ Project

Creates a new project

Parameters:

• options (Hash) —

  The parameters to create

Options Hash (options):

• :name (String) —

  The project name

Returns:

• (Project) —

  Created project object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

• (ArgumentError) —

  If invalid options are provided

# File 'lib/mailtrap/projects_api.rb', line 36

def create(options)
  base_create(options)
end

#delete(project_id) ⇒ Object

Deletes a project

Parameters:

• project_id (Integer) —

  The project ID

Returns:

• nil

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/projects_api.rb', line 54

def delete(project_id)
  base_delete(project_id)
end

#get(project_id) ⇒ Project

Retrieves a specific project

Parameters:

• project_id (Integer) —

  The project ID

Returns:

• (Project) —

  Project object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/projects_api.rb', line 26

def get(project_id)
  base_get(project_id)
end

#list ⇒ Array<Project>

Lists all projects for the account

Returns:

• (Array<Project>) —

  Array of projects

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/projects_api.rb', line 18

def list
  base_list
end

#update(project_id, options) ⇒ Project

Updates an existing project

Parameters:

• project_id (Integer) —

  The project ID

• options (Hash) —

  The parameters to update

Returns:

• (Project) —

  Updated project object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

• (ArgumentError) —

  If invalid options are provided

# File 'lib/mailtrap/projects_api.rb', line 46

def update(project_id, options)
  base_update(project_id, options)
end