Module: Profiles

Included in:
CustomerData
Defined in:
lib/user/customer-data/profiles.rb

Instance Method Summary collapse

Instance Method Details

#create_profile(data, options = nil) ⇒ Object

Create profile.

Create a profile with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
    example_field: 'example_value'
}
@data = @cxf_user.create_profile(data)



57
58
59
 
# File 'lib/user/customer-data/profiles.rb', line 57

def create_profile(data, options = nil)
  @client.raw('post', '/customer-data/profiles/', options, data_transform(data))
end

#delete_profiles(data) ⇒ Object

Delete Profiles.

Delete a group of profiles.

Parameters

data

(Hash) – Data to be submitted.

Example

data = { ids: %w[21 22] }
@data = @cxf_user.delete_profiles(data)



90
91
92
 
# File 'lib/user/customer-data/profiles.rb', line 90

def delete_profiles(data)
  @client.raw('delete', '/customer-data/profiles/delete', nil, data_transform(data))
end

#get_profile(id, options = nil) ⇒ Object

Get profile.

Get a profile info.

Parameters

id

(Integer) – Company id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_profile(21)

Second Example

options = { fields: 'id, title' }
@data = @cxf_user.get_profile(21, options)



42
43
44
 
# File 'lib/user/customer-data/profiles.rb', line 42

def get_profile(id, options = nil)
  @client.raw('get', "/customer-data/profiles/#{id}", options)
end

#get_profiles(options = nil, use_post = true) ⇒ Object

Get profiles.

Get a collection of profiles.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @cxf_user.get_profiles

Second Example

options = { fields: 'id, title', sort: '-id' }
@data = @cxf_user.get_profiles(options)

Third Example

options = { fields: 'id, title', sort: '-id' }
@data = @cxf_user.get_profiles(options, false)



25
26
27
 
# File 'lib/user/customer-data/profiles.rb', line 25

def get_profiles(options = nil, use_post = true)
  get_query_results('/customer-data/profiles', options, use_post)
end

#update_profile(id, data, options = nil) ⇒ Object

Update profile.

Update a profile info.

Parameters

id

(Integer) – Company id.

data

(Hash) – Data to be submitted.

Example

data = {
    example_field: 'example_value_modified'
}
@data = @cxf_user.update_profile(23, data)



73
74
75
 
# File 'lib/user/customer-data/profiles.rb', line 73

def update_profile(id, data, options = nil)
  @client.raw('put', "/customer-data/profiles/#{id}", options, data_transform(data))
end