Class: DealMakerAPI::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



19
20
21
 
# File 'lib/DealMakerAPI/api/users_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/DealMakerAPI/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_users_id_contexts(id, opts = {}) ⇒ V1EntitiesUsersContexts

Get contexts for a user Get contexts for a user

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/DealMakerAPI/api/users_api.rb', line 27

def get_users_id_contexts(id, opts = {})
  data, _status_code, _headers = get_users_id_contexts_with_http_info(id, opts)
  data
end

#get_users_id_contexts_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesUsersContexts, Integer, Hash)>

Get contexts for a user Get contexts for a user

Parameters:

  • (defaults to: {})

    the optional parameters

Returns:

  • V1EntitiesUsersContexts data, response status code and response headers



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/DealMakerAPI/api/users_api.rb', line 37

def get_users_id_contexts_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_users_id_contexts ...'
  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 UsersApi.get_users_id_contexts"
  end
  # resource path
  local_var_path = '/users/{id}/contexts'.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesUsersContexts'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UsersApi.get_users_id_contexts",
    :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: UsersApi#get_users_id_contexts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_users_investments(email, opts = {}) ⇒ V1EntitiesInvestors

Gets the investments for a specific user. Get Investments

Parameters:

  • The email of the user.

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:



93
94
95
96
 
# File 'lib/DealMakerAPI/api/users_api.rb', line 93

def get_users_investments(email, opts = {})
  data, _status_code, _headers = get_users_investments_with_http_info(email, opts)
  data
end

#get_users_investments_with_http_info(email, opts = {}) ⇒ Array<(V1EntitiesInvestors, Integer, Hash)>

Gets the investments for a specific user. Get Investments

Parameters:

  • The email of the user.

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page offset to fetch. (default to 1)

  • :per_page (Integer) —

    Number of results to return per page. (default to 25)

  • :offset (Integer) —

    Pad a number of results. (default to 0)

Returns:

  • V1EntitiesInvestors data, response status code and response headers



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
148
149
150
151
152
153
154
155
156
 
# File 'lib/DealMakerAPI/api/users_api.rb', line 106

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'email'] = email
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesInvestors'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"UsersApi.get_users_investments",
    :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: UsersApi#get_users_investments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end