Class: Phyllo::IdentityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phyllo/api/identity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IdentityApi

Returns a new instance of IdentityApi.



17
18
19
 
# File 'lib/phyllo/api/identity_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/phyllo/api/identity_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#v1_get_audience_demographics(account_id, opts = {}) ⇒ V1GetAudienceDemographics200Response

Retrieve audience demographics Retrieves audience demographics for the given account. Demographics object contains information related to the audience of the user: countries, cities, age & gender distribution, etc. The values in this data are in percentages and are tied to a particular work platform account. This data is lifetime data.

Parameters:

  • account_id (String) —

    Unique ID of the connected account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/phyllo/api/identity_api.rb', line 26

def v1_get_audience_demographics(, opts = {})
  data, _status_code, _headers = v1_get_audience_demographics_with_http_info(, opts)
  data
end

#v1_get_audience_demographics_with_http_info(account_id, opts = {}) ⇒ Array<(V1GetAudienceDemographics200Response, Integer, Hash)>

Retrieve audience demographics Retrieves audience demographics for the given account. Demographics object contains information related to the audience of the user: countries, cities, age &amp; gender distribution, etc. The values in this data are in percentages and are tied to a particular work platform account. This data is lifetime data.

Parameters:

  • account_id (String) —

    Unique ID of the connected account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/phyllo/api/identity_api.rb', line 36

def v1_get_audience_demographics_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityApi.v1_get_audience_demographics ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling IdentityApi.v1_get_audience_demographics"
  end
  # resource path
  local_var_path = "/v1/audience"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:account_id] = 

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || "V1GetAudienceDemographics200Response"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"IdentityApi.v1_get_audience_demographics",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityApi#v1_get_audience_demographics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_refresh_profile(opts = {}) ⇒ Refresh1

Refresh a profile Refresh profile for a connected account. Once Phyllo processes the request, you can fetch the updated profile by calling the [retrieve a profile API](../reference/openapi.v1.yml/paths/~1v1~1profiles~1id/get). Subscribe to the "PROFILES.UPDATED" webhook to receive a notification once the request is completed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



90
91
92
93
 
# File 'lib/phyllo/api/identity_api.rb', line 90

def v1_refresh_profile(opts = {})
  data, _status_code, _headers = v1_refresh_profile_with_http_info(opts)
  data
end

#v1_refresh_profile_with_http_info(opts = {}) ⇒ Array<(Refresh1, Integer, Hash)>

Refresh a profile Refresh profile for a connected account. Once Phyllo processes the request, you can fetch the updated profile by calling the [retrieve a profile API](../reference/openapi.v1.yml/paths/~1v1~1profiles~1id/get). Subscribe to the &quot;PROFILES.UPDATED&quot; webhook to receive a notification once the request is completed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Refresh1, Integer, Hash)>) —

    Refresh1 data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/phyllo/api/identity_api.rb', line 100

def v1_refresh_profile_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityApi.v1_refresh_profile ..."
  end
  # resource path
  local_var_path = "/v1/profiles/refresh"

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(["application/json", "application/xml"])
  if !content_type.nil?
    header_params["Content-Type"] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:refresh1])

  # return_type
  return_type = opts[:debug_return_type] || "Refresh1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"IdentityApi.v1_refresh_profile",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityApi#v1_refresh_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_stream_get_profile_by_id(id, opts = {}) ⇒ Profile1

Retrieve a profile Retrieve the information of the Profile with the supplied Profile id. Profile object contains information related to the identity of the user like name, address, contact details, etc. The data in a profile is tied to a particular work platform account that the user has connected to via Connect SDK.

Parameters:

  • id (String) —

    Unique identifier for the profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/phyllo/api/identity_api.rb', line 154

def v1_stream_get_profile_by_id(id, opts = {})
  data, _status_code, _headers = v1_stream_get_profile_by_id_with_http_info(id, opts)
  data
end

#v1_stream_get_profile_by_id_with_http_info(id, opts = {}) ⇒ Array<(Profile1, Integer, Hash)>

Retrieve a profile Retrieve the information of the Profile with the supplied Profile id. Profile object contains information related to the identity of the user like name, address, contact details, etc. The data in a profile is tied to a particular work platform account that the user has connected to via Connect SDK.

Parameters:

  • id (String) —

    Unique identifier for the profile.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Profile1, Integer, Hash)>) —

    Profile1 data, response status code and response headers



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/phyllo/api/identity_api.rb', line 164

def v1_stream_get_profile_by_id_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityApi.v1_stream_get_profile_by_id ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.v1_stream_get_profile_by_id"
  end
  # resource path
  local_var_path = "/v1/profiles/{id}".sub("{" + "id" + "}", CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || "Profile1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"IdentityApi.v1_stream_get_profile_by_id",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityApi#v1_stream_get_profile_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#v1_stream_get_profiles(opts = {}) ⇒ ProfileList1

Retrieve all profiles Lists all Profiles. Profile object contains information related to the identity of the user like name, address, contact details, etc. The data in a profile is tied to a particular work platform account that the user has connected to via Connect SDK.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :account_id (String) —

    Unique ID of the connected account.

  • :work_platform_id (String) —

    Unique ID of the work platform.

  • :user_id (String) —

    Unique ID of the user.

Returns:



221
222
223
224
 
# File 'lib/phyllo/api/identity_api.rb', line 221

def v1_stream_get_profiles(opts = {})
  data, _status_code, _headers = v1_stream_get_profiles_with_http_info(opts)
  data
end

#v1_stream_get_profiles_with_http_info(opts = {}) ⇒ Array<(ProfileList1, Integer, Hash)>

Retrieve all profiles Lists all Profiles. Profile object contains information related to the identity of the user like name, address, contact details, etc. The data in a profile is tied to a particular work platform account that the user has connected to via Connect SDK.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    The number of objects to skip. Use this argument for pagination. The default value is 0. (default to 0)

  • :limit (Integer) —

    The number of objects to be returned. It can be between 1 to 100. The default value is 10. (default to 10)

  • :account_id (String) —

    Unique ID of the connected account.

  • :work_platform_id (String) —

    Unique ID of the work platform.

  • :user_id (String) —

    Unique ID of the user.

Returns:

  • (Array<(ProfileList1, Integer, Hash)>) —

    ProfileList1 data, response status code and response headers



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/phyllo/api/identity_api.rb', line 235

def v1_stream_get_profiles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IdentityApi.v1_stream_get_profiles ..."
  end
  # resource path
  local_var_path = "/v1/profiles"

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:offset] = opts[:offset] if !opts[:offset].nil?
  query_params[:limit] = opts[:limit] if !opts[:limit].nil?
  query_params[:account_id] = opts[:account_id] if !opts[:account_id].nil?
  query_params[:work_platform_id] = opts[:work_platform_id] if !opts[:work_platform_id].nil?
  query_params[:user_id] = opts[:user_id] if !opts[:user_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params["Accept"] = @api_client.select_header_accept(["application/json"])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || "ProfileList1"

  # auth_names
  auth_names = opts[:debug_auth_names] || ["Basic Authentication"]

  new_options = opts.merge(
    operation: :"IdentityApi.v1_stream_get_profiles",
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IdentityApi#v1_stream_get_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end