Module: ActiveCampaign::API::Addresses

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

Overview

Interface to address endpoints

Author:

Instance Method Summary collapse

Instance Method Details

#create_address(params) ⇒ Hash

Create a new address

Parameters:

  • params (Hash) —

    create a new address with this data

Options Hash (params):

  • :groupid (Integer)
  • :global (Object)
  • :company_name (String)
  • :address_1 (String) —

    street address line one

  • :address_2 (String) —

    street address line one

  • :city (String)
  • :state (String)
  • :zip (String)
  • :district (String) — default: Optional for countries that use it
  • :country (String) —

    Accepts a (2) two character string - country code ISO2 (eg 'US', 'CA', 'MX')

  • :allgroup (Integer)
  • :is_default (true, false) —

    Indicates default address

Returns:

  • (Hash) —

    a hash with information about the newly created address



30
31
32
 
# File 'lib/active_campaign/api/addresses.rb', line 30

def create_address(params)
  post('addresses', address: params, change_case: false)
end

#delete_address(id) ⇒ Hash

Deletes a address with given id

Parameters:

  • id (Integer) —

    the id of a address to delete

Returns:

  • (Hash) 


85
86
87
 
# File 'lib/active_campaign/api/addresses.rb', line 85

def delete_address(id)
  delete("addresses/#{id}")
end

#delete_address_group(id) ⇒ Hash

Delete address associated with a specific user group

Parameters:

  • id (Integer) —

    the id of a address to delete

Returns:

  • (Hash) 


96
97
98
 
# File 'lib/active_campaign/api/addresses.rb', line 96

def delete_address_group(id)
  delete("addressGroups/#{id}")
end

#delete_address_list(id) ⇒ Hash

Delete address associated with a specific list

Parameters:

  • id (Integer) —

    the id of a address to delete

Returns:

  • (Hash) 


107
108
109
 
# File 'lib/active_campaign/api/addresses.rb', line 107

def delete_address_list(id)
  delete("addressGroups/#{id}")
end

#show_address(id) ⇒ Hash

Get a single address

Parameters:

  • id (Integer) —

    the id of a address to show

Returns:

  • (Hash) 


41
42
43
 
# File 'lib/active_campaign/api/addresses.rb', line 41

def show_address(id)
  get("addresses/#{id}")
end

#show_addresses(*params) ⇒ Array<Hash>

Get a list of address

Returns:

  • (Array<Hash>) 


50
51
52
 
# File 'lib/active_campaign/api/addresses.rb', line 50

def show_addresses(*params)
  get('addresses', *params)
end

#update_address(id, params) ⇒ Hash

Update an existing address with given id

Parameters:

  • id (Integer) —

    the id of a address to update

  • params (Hash) —

    create a new address with this data

Options Hash (params):

  • :groupid (Integer)
  • :global (Object)
  • :company_name (String)
  • :address_1 (String) —

    street address line one

  • :address_2 (String) —

    street address line one

  • :city (String)
  • :state (String)
  • :zip (String)
  • :district (String) — default: Optional for countries that use it
  • :country (String) —

    Accepts a (2) two character string - country code ISO2 (eg 'US', 'CA', 'MX')

  • :allgroup (Integer)
  • :is_default (true, false) —

    Indicates default address

Returns:

  • (Hash) —

    a hash with information about the newly created address



74
75
76
 
# File 'lib/active_campaign/api/addresses.rb', line 74

def update_address(id, params)
  put("addresses/#{id}", address: params, change_case: false)
end