forked from meraki/dashboard-api-go
/
api_upgrades.go
415 lines (362 loc) · 15 KB
/
api_upgrades.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
/*
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"
"reflect"
)
// UpgradesAPIService UpgradesAPI service
type UpgradesAPIService service
type UpgradesAPIGetOrganizationFirmwareUpgradesRequest struct {
ctx context.Context
ApiService *UpgradesAPIService
organizationId string
status *[]string
productTypes *[]string
}
// The status of an upgrade
func (r UpgradesAPIGetOrganizationFirmwareUpgradesRequest) Status(status []string) UpgradesAPIGetOrganizationFirmwareUpgradesRequest {
r.status = &status
return r
}
// The product type in a given upgrade ID
func (r UpgradesAPIGetOrganizationFirmwareUpgradesRequest) ProductTypes(productTypes []string) UpgradesAPIGetOrganizationFirmwareUpgradesRequest {
r.productTypes = &productTypes
return r
}
func (r UpgradesAPIGetOrganizationFirmwareUpgradesRequest) Execute() ([]GetOrganizationFirmwareUpgrades200ResponseInner, *http.Response, error) {
return r.ApiService.GetOrganizationFirmwareUpgradesExecute(r)
}
/*
GetOrganizationFirmwareUpgrades Get firmware upgrade information for an organization
Get firmware upgrade information for an organization
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param organizationId Organization ID
@return UpgradesAPIGetOrganizationFirmwareUpgradesRequest
*/
func (a *UpgradesAPIService) GetOrganizationFirmwareUpgrades(ctx context.Context, organizationId string) UpgradesAPIGetOrganizationFirmwareUpgradesRequest {
return UpgradesAPIGetOrganizationFirmwareUpgradesRequest{
ApiService: a,
ctx: ctx,
organizationId: organizationId,
}
}
// Execute executes the request
// @return []GetOrganizationFirmwareUpgrades200ResponseInner
func (a *UpgradesAPIService) GetOrganizationFirmwareUpgradesExecute(r UpgradesAPIGetOrganizationFirmwareUpgradesRequest) ([]GetOrganizationFirmwareUpgrades200ResponseInner, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []GetOrganizationFirmwareUpgrades200ResponseInner
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "UpgradesAPIService.GetOrganizationFirmwareUpgrades")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/organizations/{organizationId}/firmware/upgrades"
localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", url.PathEscape(parameterValueToString(r.organizationId, "organizationId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.status != nil {
t := *r.status
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "status", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "status", t, "multi")
}
}
if r.productTypes != nil {
t := *r.productTypes
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "productTypes", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "productTypes", t, "multi")
}
}
// 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 UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest struct {
ctx context.Context
ApiService *UpgradesAPIService
organizationId string
perPage *int32
startingAfter *string
endingBefore *string
networkIds *[]string
serials *[]string
macs *[]string
firmwareUpgradeBatchIds *[]string
upgradeStatuses *[]string
}
// The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) PerPage(perPage int32) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.perPage = &perPage
return r
}
// A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) StartingAfter(startingAfter string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.startingAfter = &startingAfter
return r
}
// A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) EndingBefore(endingBefore string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.endingBefore = &endingBefore
return r
}
// Optional parameter to filter by network
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) NetworkIds(networkIds []string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.networkIds = &networkIds
return r
}
// Optional parameter to filter by serial number. All returned devices will have a serial number that is an exact match.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) Serials(serials []string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.serials = &serials
return r
}
// Optional parameter to filter by one or more MAC addresses belonging to devices. All devices returned belong to MAC addresses that are an exact match.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) Macs(macs []string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.macs = &macs
return r
}
// Optional parameter to filter by firmware upgrade batch ids.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) FirmwareUpgradeBatchIds(firmwareUpgradeBatchIds []string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.firmwareUpgradeBatchIds = &firmwareUpgradeBatchIds
return r
}
// Optional parameter to filter by firmware upgrade statuses.
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) UpgradeStatuses(upgradeStatuses []string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
r.upgradeStatuses = &upgradeStatuses
return r
}
func (r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) Execute() ([]GetOrganizationFirmwareUpgradesByDevice200ResponseInner, *http.Response, error) {
return r.ApiService.GetOrganizationFirmwareUpgradesByDeviceExecute(r)
}
/*
GetOrganizationFirmwareUpgradesByDevice Get firmware upgrade status for the filtered devices
Get firmware upgrade status for the filtered devices
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param organizationId Organization ID
@return UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest
*/
func (a *UpgradesAPIService) GetOrganizationFirmwareUpgradesByDevice(ctx context.Context, organizationId string) UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest {
return UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest{
ApiService: a,
ctx: ctx,
organizationId: organizationId,
}
}
// Execute executes the request
// @return []GetOrganizationFirmwareUpgradesByDevice200ResponseInner
func (a *UpgradesAPIService) GetOrganizationFirmwareUpgradesByDeviceExecute(r UpgradesAPIGetOrganizationFirmwareUpgradesByDeviceRequest) ([]GetOrganizationFirmwareUpgradesByDevice200ResponseInner, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue []GetOrganizationFirmwareUpgradesByDevice200ResponseInner
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "UpgradesAPIService.GetOrganizationFirmwareUpgradesByDevice")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/organizations/{organizationId}/firmware/upgrades/byDevice"
localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", url.PathEscape(parameterValueToString(r.organizationId, "organizationId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.perPage != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "perPage", r.perPage, "")
}
if r.startingAfter != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "startingAfter", r.startingAfter, "")
}
if r.endingBefore != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "endingBefore", r.endingBefore, "")
}
if r.networkIds != nil {
t := *r.networkIds
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "networkIds", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "networkIds", t, "multi")
}
}
if r.serials != nil {
t := *r.serials
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "serials", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "serials", t, "multi")
}
}
if r.macs != nil {
t := *r.macs
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "macs", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "macs", t, "multi")
}
}
if r.firmwareUpgradeBatchIds != nil {
t := *r.firmwareUpgradeBatchIds
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "firmwareUpgradeBatchIds", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "firmwareUpgradeBatchIds", t, "multi")
}
}
if r.upgradeStatuses != nil {
t := *r.upgradeStatuses
if reflect.TypeOf(t).Kind() == reflect.Slice {
s := reflect.ValueOf(t)
for i := 0; i < s.Len(); i++ {
parameterAddToHeaderOrQuery(localVarQueryParams, "upgradeStatuses", s.Index(i), "multi")
}
} else {
parameterAddToHeaderOrQuery(localVarQueryParams, "upgradeStatuses", t, "multi")
}
}
// 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
}