Class: Aimastering::UserApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aimastering/api/user_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



19
20
21
 
# File 'lib/aimastering/api/user_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/aimastering/api/user_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_self(opts = {}) ⇒ User

Get self user.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/aimastering/api/user_api.rb', line 27

def get_self(opts = {})
  data, _status_code, _headers = get_self_with_http_info(opts)
  return data
end

#get_self_with_http_info(opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get self user.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(User, Fixnum, Hash)>) —

    User data, response status code and response headers



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
 
# File 'lib/aimastering/api/user_api.rb', line 36

def get_self_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.get_self ..."
  end
  # resource path
  local_var_path = "/users/self"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#notify_registration(opts = {}) ⇒ User

Notify user is registered.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :affiliate_id (String) —

    The affiliate id of inviter.

  • :referrer_url (String) —

    The referrer URL.

Returns:



76
77
78
79
 
# File 'lib/aimastering/api/user_api.rb', line 76

def notify_registration(opts = {})
  data, _status_code, _headers = notify_registration_with_http_info(opts)
  return data
end

#notify_registration_with_http_info(opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Notify user is registered.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :affiliate_id (String) —

    The affiliate id of inviter.

  • :referrer_url (String) —

    The referrer URL.

Returns:

  • (Array<(User, Fixnum, Hash)>) —

    User data, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/aimastering/api/user_api.rb', line 87

def notify_registration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.notify_registration ..."
  end
  # resource path
  local_var_path = "/users/self/notify_registration"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["affiliate_id"] = opts[:'affiliate_id'] if !opts[:'affiliate_id'].nil?
  form_params["referrer_url"] = opts[:'referrer_url'] if !opts[:'referrer_url'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#notify_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_invitation(invitee_email, opts = {}) ⇒ User

Send invitation.

Parameters:

  • invitee_email —

    The email of invitee.

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

    the optional parameters

Returns:



130
131
132
133
 
# File 'lib/aimastering/api/user_api.rb', line 130

def send_invitation(invitee_email, opts = {})
  data, _status_code, _headers = send_invitation_with_http_info(invitee_email, opts)
  return data
end

#send_invitation_with_http_info(invitee_email, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Send invitation.

Parameters:

  • invitee_email —

    The email of invitee.

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

    the optional parameters

Returns:

  • (Array<(User, Fixnum, Hash)>) —

    User data, response status code and response headers



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aimastering/api/user_api.rb', line 140

def send_invitation_with_http_info(invitee_email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.send_invitation ..."
  end
  # verify the required parameter 'invitee_email' is set
  if @api_client.config.client_side_validation && invitee_email.nil?
    fail ArgumentError, "Missing the required parameter 'invitee_email' when calling UserApi.send_invitation"
  end
  # resource path
  local_var_path = "/users/self/send_invitation"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["invitee_email"] = invitee_email

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#send_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_self(opts = {}) ⇒ User

Update self user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agreed_terms_of_service (BOOLEAN) —

    Whether you agreed terms of service.

  • :email (String) —

    The email.

Returns:



187
188
189
190
 
# File 'lib/aimastering/api/user_api.rb', line 187

def update_self(opts = {})
  data, _status_code, _headers = update_self_with_http_info(opts)
  return data
end

#update_self_with_http_info(opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Update self user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :agreed_terms_of_service (BOOLEAN) —

    Whether you agreed terms of service.

  • :email (String) —

    The email.

Returns:

  • (Array<(User, Fixnum, Hash)>) —

    User data, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/aimastering/api/user_api.rb', line 198

def update_self_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UserApi.update_self ..."
  end
  # resource path
  local_var_path = "/users/self"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["agreed_terms_of_service"] = opts[:'agreed_terms_of_service'] if !opts[:'agreed_terms_of_service'].nil?
  form_params["email"] = opts[:'email'] if !opts[:'email'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_self\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end