Module: ActiveCampaign::API::AccountContacts

Defined in:

lib/active_campaign/api/account_contacts.rb

Overview

Interface to account endpoints

Author:

• Mikael Henriksson mikael@mhenrixon.com

Instance Method Summary

• #create_account_contact(params) ⇒ Hash

  Create a new account.

• #delete_account_contact(id) ⇒ Hash

  Deletes a account with given id.

• #show_account_contact(id) ⇒ Hash

  Get a single account.

• #show_account_contacts(search = nil) ⇒ Array<Hash>

  Get a list of accounts.

• #update_account_contact(id, params) ⇒ Hash

  Update an existing account with given id.

Instance Method Details

#create_account_contact(params) ⇒ Hash

Create a new account

Parameters:

• params (Hash) —

  create a new account with this data

Options Hash (params):

• :contact (String) —

  the id of the contact

• :account (String) —

  the id of the account

• :job_title (String) —

  job title of the account contact

Returns:

• (Hash) —

  a hash with information about the newly created account

# File 'lib/active_campaign/api/account_contacts.rb', line 21

def create_account_contact(params)
  post('accountContacts', account_contact: params)
end

#delete_account_contact(id) ⇒ Hash

Deletes a account with given id

Parameters:

• id (String) —

  the id of a account to delete

Returns:

• (Hash)

# File 'lib/active_campaign/api/account_contacts.rb', line 69

def delete_account_contact(id)
  delete("accountContacts/#{id}")
end

#show_account_contact(id) ⇒ Hash

Get a single account

Parameters:

• id (Integer) —

  the id of a account to show

Returns:

• (Hash)

# File 'lib/active_campaign/api/account_contacts.rb', line 32

def show_account_contact(id)
  get("accountContacts/#{id}")
end

#show_account_contacts(search = nil) ⇒ Array<Hash>

Get a list of accounts

Parameters:

• search (String) (defaults to: nil) —

  Filter accounts that match the given value in the account attributes

Returns:

• (Array<Hash>)

# File 'lib/active_campaign/api/account_contacts.rb', line 43

def show_account_contacts(search = nil)
  get('accountContacts', search: search)
end

#update_account_contact(id, params) ⇒ Hash

Update an existing account with given id

Parameters:

• id (String) —

  the id of a account to update

• params (Hash) —

  create a new account with this data

Options Hash (params):

• :contact (String) —

  the id of the contact

• :account (String) —

  the id of the account

• :job_title (String) —

  job title of the account contact

Returns:

• (Hash) —

  a hash with information about the newly created account

# File 'lib/active_campaign/api/account_contacts.rb', line 58

def update_account_contact(id, params)
  put("accountContacts/#{id}", account_contact: params)
end