Module: ActiveCampaign::API::Accounts

Defined in:
lib/active_campaign/api/accounts.rb

Overview

Interface to account endpoints

Author:

Instance Method Summary collapse

Instance Method Details

#bulk_delete_accounts(ids) ⇒ Hash

Deletes a account with given ids

Parameters:

  • ids (Array<String>) —

    a collection of ids to delete

Returns:

  • (Hash) 


78
79
80
 
# File 'lib/active_campaign/api/accounts.rb', line 78

def bulk_delete_accounts(ids)
  delete('accounts/bulk_delete', ids: ids)
end

#create_account(params) ⇒ Hash

Create a new account

Parameters:

  • params (Hash) —

    create a new account with this data

Options Hash (params):

  • :name (String) —

    the name of the account

  • :account_url (String) —

    the address of the accounts website

Returns:

  • (Hash) —

    a hash with information about the newly created account



20
21
22
 
# File 'lib/active_campaign/api/accounts.rb', line 20

def (params)
  post('accounts', account: params)
end

#delete_account(id) ⇒ Hash

Deletes a account with given id

Parameters:

  • id (String) —

    the id of a account to delete

Returns:

  • (Hash) 


67
68
69
 
# File 'lib/active_campaign/api/accounts.rb', line 67

def (id)
  delete("accounts/#{id}")
end

#show_account(id) ⇒ Hash

Get a single account

Parameters:

  • id (Integer) —

    the id of a account to show

Returns:

  • (Hash) 


31
32
33
 
# File 'lib/active_campaign/api/accounts.rb', line 31

def (id)
  get("accounts/#{id}")
end

#show_accounts(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>) 


42
43
44
 
# File 'lib/active_campaign/api/accounts.rb', line 42

def show_accounts(search = nil)
  get('accounts', search: search)
end

#update_account(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):

  • :name (String) —

    the name of the account

  • :account_url (String) —

    the address of the accounts website

Returns:

  • (Hash) —

    a hash with information about the newly created account



56
57
58
 
# File 'lib/active_campaign/api/accounts.rb', line 56

def (id, params)
  put("accounts/#{id}", account: params)
end