forked from meraki/dashboard-api-go
/
api_usage_history.go
519 lines (444 loc) · 18.8 KB
/
api_usage_history.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
84
85
86
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
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
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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
/*
Meraki Dashboard API
A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale. > Date: 02 August, 2023 > > [Recent Updates](https://meraki.io/whats-new/) --- [API Documentation](https://meraki.io/api) [Community Support](https://meraki.io/community) [Meraki Homepage](https://www.meraki.com)
API version: 1.36.0
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package client
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// UsageHistoryAPIService UsageHistoryAPI service
type UsageHistoryAPIService service
type UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest struct {
ctx context.Context
ApiService *UsageHistoryAPIService
networkId string
t0 *string
t1 *string
timespan *float32
resolution *int32
}
// The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
func (r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) T0(t0 string) UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest {
r.t0 = &t0
return r
}
// The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
func (r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) T1(t1 string) UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest {
r.t1 = &t1
return r
}
// The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 10 minutes.
func (r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) Timespan(timespan float32) UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest {
r.timespan = ×pan
return r
}
// The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 600, 1800, 3600, 86400. The default is 60.
func (r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) Resolution(resolution int32) UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest {
r.resolution = &resolution
return r
}
func (r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) Execute() ([]map[string]interface{}, *http.Response, error) {
return r.ApiService.GetNetworkApplianceUplinksUsageHistoryExecute(r)
}
/*
GetNetworkApplianceUplinksUsageHistory Get the sent and received bytes for each uplink of a network.
Get the sent and received bytes for each uplink of a network.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param networkId Network ID
@return UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest
*/
func (a *UsageHistoryAPIService) GetNetworkApplianceUplinksUsageHistory(ctx context.Context, networkId string) UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest {
return UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest{
ApiService: a,
ctx: ctx,
networkId: networkId,
}
}
// Execute executes the request
// @return []map[string]interface{}
func (a *UsageHistoryAPIService) GetNetworkApplianceUplinksUsageHistoryExecute(r UsageHistoryAPIGetNetworkApplianceUplinksUsageHistoryRequest) ([]map[string]interface{}, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []map[string]interface{}
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "UsageHistoryAPIService.GetNetworkApplianceUplinksUsageHistory")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/networks/{networkId}/appliance/uplinks/usageHistory"
localVarPath = strings.Replace(localVarPath, "{"+"networkId"+"}", url.PathEscape(parameterValueToString(r.networkId, "networkId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.t0 != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "t0", r.t0, "")
}
if r.t1 != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "t1", r.t1, "")
}
if r.timespan != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "timespan", r.timespan, "")
}
if r.resolution != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "resolution", r.resolution, "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
if r.ctx != nil {
// API Key Authentication
if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok {
if apiKey, ok := auth["meraki_api_key"]; ok {
var key string
if apiKey.Prefix != "" {
key = apiKey.Prefix + " " + apiKey.Key
} else {
key = apiKey.Key
}
localVarHeaderParams["X-Cisco-Meraki-API-Key"] = key
}
}
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type UsageHistoryAPIGetNetworkClientUsageHistoryRequest struct {
ctx context.Context
ApiService *UsageHistoryAPIService
networkId string
clientId string
}
func (r UsageHistoryAPIGetNetworkClientUsageHistoryRequest) Execute() ([]map[string]interface{}, *http.Response, error) {
return r.ApiService.GetNetworkClientUsageHistoryExecute(r)
}
/*
GetNetworkClientUsageHistory Return the client's daily usage history
Return the client's daily usage history. Usage data is in kilobytes. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param networkId Network ID
@param clientId Client ID
@return UsageHistoryAPIGetNetworkClientUsageHistoryRequest
*/
func (a *UsageHistoryAPIService) GetNetworkClientUsageHistory(ctx context.Context, networkId string, clientId string) UsageHistoryAPIGetNetworkClientUsageHistoryRequest {
return UsageHistoryAPIGetNetworkClientUsageHistoryRequest{
ApiService: a,
ctx: ctx,
networkId: networkId,
clientId: clientId,
}
}
// Execute executes the request
// @return []map[string]interface{}
func (a *UsageHistoryAPIService) GetNetworkClientUsageHistoryExecute(r UsageHistoryAPIGetNetworkClientUsageHistoryRequest) ([]map[string]interface{}, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []map[string]interface{}
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "UsageHistoryAPIService.GetNetworkClientUsageHistory")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/networks/{networkId}/clients/{clientId}/usageHistory"
localVarPath = strings.Replace(localVarPath, "{"+"networkId"+"}", url.PathEscape(parameterValueToString(r.networkId, "networkId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"clientId"+"}", url.PathEscape(parameterValueToString(r.clientId, "clientId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
if r.ctx != nil {
// API Key Authentication
if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok {
if apiKey, ok := auth["meraki_api_key"]; ok {
var key string
if apiKey.Prefix != "" {
key = apiKey.Prefix + " " + apiKey.Key
} else {
key = apiKey.Key
}
localVarHeaderParams["X-Cisco-Meraki-API-Key"] = key
}
}
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest struct {
ctx context.Context
ApiService *UsageHistoryAPIService
networkId string
t0 *string
t1 *string
timespan *float32
resolution *int32
autoResolution *bool
clientId *string
deviceSerial *string
apTag *string
band *string
ssid *int32
}
// The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) T0(t0 string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.t0 = &t0
return r
}
// The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) T1(t1 string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.t1 = &t1
return r
}
// The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) Timespan(timespan float32) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.timespan = ×pan
return r
}
// The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) Resolution(resolution int32) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.resolution = &resolution
return r
}
// Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) AutoResolution(autoResolution bool) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.autoResolution = &autoResolution
return r
}
// Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) ClientId(clientId string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.clientId = &clientId
return r
}
// Filter results by device. Requires :band.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) DeviceSerial(deviceSerial string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.deviceSerial = &deviceSerial
return r
}
// Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) ApTag(apTag string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.apTag = &apTag
return r
}
// Filter results by band (either '2.4', '5' or '6').
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) Band(band string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.band = &band
return r
}
// Filter results by SSID number.
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) Ssid(ssid int32) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
r.ssid = &ssid
return r
}
func (r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) Execute() ([]GetNetworkWirelessUsageHistory200ResponseInner, *http.Response, error) {
return r.ApiService.GetNetworkWirelessUsageHistoryExecute(r)
}
/*
GetNetworkWirelessUsageHistory Return AP usage over time for a device or network client
Return AP usage over time for a device or network client
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param networkId Network ID
@return UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest
*/
func (a *UsageHistoryAPIService) GetNetworkWirelessUsageHistory(ctx context.Context, networkId string) UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest {
return UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest{
ApiService: a,
ctx: ctx,
networkId: networkId,
}
}
// Execute executes the request
// @return []GetNetworkWirelessUsageHistory200ResponseInner
func (a *UsageHistoryAPIService) GetNetworkWirelessUsageHistoryExecute(r UsageHistoryAPIGetNetworkWirelessUsageHistoryRequest) ([]GetNetworkWirelessUsageHistory200ResponseInner, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []GetNetworkWirelessUsageHistory200ResponseInner
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "UsageHistoryAPIService.GetNetworkWirelessUsageHistory")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/networks/{networkId}/wireless/usageHistory"
localVarPath = strings.Replace(localVarPath, "{"+"networkId"+"}", url.PathEscape(parameterValueToString(r.networkId, "networkId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.t0 != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "t0", r.t0, "")
}
if r.t1 != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "t1", r.t1, "")
}
if r.timespan != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "timespan", r.timespan, "")
}
if r.resolution != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "resolution", r.resolution, "")
}
if r.autoResolution != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "autoResolution", r.autoResolution, "")
}
if r.clientId != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "clientId", r.clientId, "")
}
if r.deviceSerial != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "deviceSerial", r.deviceSerial, "")
}
if r.apTag != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "apTag", r.apTag, "")
}
if r.band != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "band", r.band, "")
}
if r.ssid != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "ssid", r.ssid, "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
if r.ctx != nil {
// API Key Authentication
if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok {
if apiKey, ok := auth["meraki_api_key"]; ok {
var key string
if apiKey.Prefix != "" {
key = apiKey.Prefix + " " + apiKey.Key
} else {
key = apiKey.Key
}
localVarHeaderParams["X-Cisco-Meraki-API-Key"] = key
}
}
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}