Class: GroupDocsPlatformCloud::UsageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_platform_cloud/api/usage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsageApi

Returns a new instance of UsageApi.



19
20
21
 
# File 'lib/groupdocs_platform_cloud/api/usage_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/groupdocs_platform_cloud/api/usage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#usage_get_user_usage(start, _end, opts = {}) ⇒ File

Get usage logs for some period.

Parameters:

  • start —

    The period start.

  • _end —

    The period end.

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 29

def usage_get_user_usage(start, _end, opts = {})
  data, _status_code, _headers = usage_get_user_usage_with_http_info(start, _end, opts)
  return data
end

#usage_get_user_usage_current_month(opts = {}) ⇒ File

Get usage for current subscription period.

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 90

def usage_get_user_usage_current_month(opts = {})
  data, _status_code, _headers = usage_get_user_usage_current_month_with_http_info(opts)
  return data
end

#usage_get_user_usage_current_month_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get usage for current subscription period.

Parameters:

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 99

def usage_get_user_usage_current_month_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.usage_get_user_usage_current_month ..."
  end
  # resource path
  local_var_path = "/usage/currentPeriod"

  # 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(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#usage_get_user_usage_current_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usage_get_user_usage_current_period_summary(opts = {}) ⇒ UserUsageSummaryResponse

Get summary usage for current subscription period.

Parameters:

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 139

def usage_get_user_usage_current_period_summary(opts = {})
  data, _status_code, _headers = usage_get_user_usage_current_period_summary_with_http_info(opts)
  return data
end

#usage_get_user_usage_current_period_summary_with_http_info(opts = {}) ⇒ Array<(UserUsageSummaryResponse, Fixnum, Hash)>

Get summary usage for current subscription period.

Parameters:

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

    the optional parameters

Returns:

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

    UserUsageSummaryResponse data, response status code and response headers



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
180
181
182
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 148

def usage_get_user_usage_current_period_summary_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.usage_get_user_usage_current_period_summary ..."
  end
  # resource path
  local_var_path = "/usage/summary"

  # 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(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'UserUsageSummaryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#usage_get_user_usage_current_period_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usage_get_user_usage_previous_month(opts = {}) ⇒ File

Get usage logs for previous subscription period.

Parameters:

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 188

def usage_get_user_usage_previous_month(opts = {})
  data, _status_code, _headers = usage_get_user_usage_previous_month_with_http_info(opts)
  return data
end

#usage_get_user_usage_previous_month_with_http_info(opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get usage logs for previous subscription period.

Parameters:

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



197
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
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 197

def usage_get_user_usage_previous_month_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.usage_get_user_usage_previous_month ..."
  end
  # resource path
  local_var_path = "/usage/previousPeriod"

  # 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(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#usage_get_user_usage_previous_month\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usage_get_user_usage_with_http_info(start, _end, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get usage logs for some period.

Parameters:

  • start —

    The period start.

  • _end —

    The period end.

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
84
 
# File 'lib/groupdocs_platform_cloud/api/usage_api.rb', line 40

def usage_get_user_usage_with_http_info(start, _end, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.usage_get_user_usage ..."
  end
  # verify the required parameter 'start' is set
  if @api_client.config.client_side_validation && start.nil?
    fail ArgumentError, "Missing the required parameter 'start' when calling UsageApi.usage_get_user_usage"
  end
  # verify the required parameter '_end' is set
  if @api_client.config.client_side_validation && _end.nil?
    fail ArgumentError, "Missing the required parameter '_end' when calling UsageApi.usage_get_user_usage"
  end
  # resource path
  local_var_path = "/usage"

  # query parameters
  query_params = {}
  query_params[:'start'] = start
  query_params[:'end'] = _end

  # 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(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#usage_get_user_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end