/
deviceoverridecode.go
182 lines (156 loc) · 6.4 KB
/
deviceoverridecode.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package zero_trust
import (
"context"
"fmt"
"net/http"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/internal/shared"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// DeviceOverrideCodeService contains methods and other services that help with
// interacting with the cloudflare API. Note, unlike clients, this service does not
// read variables from the environment automatically. You should not instantiate
// this service directly, and instead use the [NewDeviceOverrideCodeService] method
// instead.
type DeviceOverrideCodeService struct {
Options []option.RequestOption
}
// NewDeviceOverrideCodeService generates a new service that applies the given
// options to each request. These options are applied after the parent client's
// options (if there is one), and before any request-specific options.
func NewDeviceOverrideCodeService(opts ...option.RequestOption) (r *DeviceOverrideCodeService) {
r = &DeviceOverrideCodeService{}
r.Options = opts
return
}
// Fetches a one-time use admin override code for a device. This relies on the
// **Admin Override** setting being enabled in your device configuration.
func (r *DeviceOverrideCodeService) List(ctx context.Context, deviceID string, query DeviceOverrideCodeListParams, opts ...option.RequestOption) (res *DeviceOverrideCodeListResponse, err error) {
opts = append(r.Options[:], opts...)
var env DeviceOverrideCodeListResponseEnvelope
path := fmt.Sprintf("accounts/%s/devices/%s/override_codes", query.AccountID, deviceID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type DeviceOverrideCodeListResponse struct {
DisableForTime DeviceOverrideCodeListResponseDisableForTime `json:"disable_for_time"`
JSON deviceOverrideCodeListResponseJSON `json:"-"`
}
// deviceOverrideCodeListResponseJSON contains the JSON metadata for the struct
// [DeviceOverrideCodeListResponse]
type deviceOverrideCodeListResponseJSON struct {
DisableForTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DeviceOverrideCodeListResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r deviceOverrideCodeListResponseJSON) RawJSON() string {
return r.raw
}
type DeviceOverrideCodeListResponseDisableForTime struct {
// Override code that is valid for 1 hour.
Number1 string `json:"1"`
// Override code that is valid for 12 hour2.
Number12 string `json:"12"`
// Override code that is valid for 24 hour.2.
Number24 string `json:"24"`
// Override code that is valid for 3 hours.
Number3 string `json:"3"`
// Override code that is valid for 6 hours.
Number6 string `json:"6"`
JSON deviceOverrideCodeListResponseDisableForTimeJSON `json:"-"`
}
// deviceOverrideCodeListResponseDisableForTimeJSON contains the JSON metadata for
// the struct [DeviceOverrideCodeListResponseDisableForTime]
type deviceOverrideCodeListResponseDisableForTimeJSON struct {
Number1 apijson.Field
Number12 apijson.Field
Number24 apijson.Field
Number3 apijson.Field
Number6 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DeviceOverrideCodeListResponseDisableForTime) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r deviceOverrideCodeListResponseDisableForTimeJSON) RawJSON() string {
return r.raw
}
type DeviceOverrideCodeListParams struct {
AccountID param.Field[string] `path:"account_id,required"`
}
type DeviceOverrideCodeListResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result DeviceOverrideCodeListResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success DeviceOverrideCodeListResponseEnvelopeSuccess `json:"success,required"`
ResultInfo DeviceOverrideCodeListResponseEnvelopeResultInfo `json:"result_info"`
JSON deviceOverrideCodeListResponseEnvelopeJSON `json:"-"`
}
// deviceOverrideCodeListResponseEnvelopeJSON contains the JSON metadata for the
// struct [DeviceOverrideCodeListResponseEnvelope]
type deviceOverrideCodeListResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
ResultInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DeviceOverrideCodeListResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r deviceOverrideCodeListResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful.
type DeviceOverrideCodeListResponseEnvelopeSuccess bool
const (
DeviceOverrideCodeListResponseEnvelopeSuccessTrue DeviceOverrideCodeListResponseEnvelopeSuccess = true
)
func (r DeviceOverrideCodeListResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case DeviceOverrideCodeListResponseEnvelopeSuccessTrue:
return true
}
return false
}
type DeviceOverrideCodeListResponseEnvelopeResultInfo struct {
// Total number of results for the requested service
Count float64 `json:"count"`
// Current page within paginated list of results
Page float64 `json:"page"`
// Number of results per page of results
PerPage float64 `json:"per_page"`
// Total results available without any search parameters
TotalCount float64 `json:"total_count"`
JSON deviceOverrideCodeListResponseEnvelopeResultInfoJSON `json:"-"`
}
// deviceOverrideCodeListResponseEnvelopeResultInfoJSON contains the JSON metadata
// for the struct [DeviceOverrideCodeListResponseEnvelopeResultInfo]
type deviceOverrideCodeListResponseEnvelopeResultInfoJSON struct {
Count apijson.Field
Page apijson.Field
PerPage apijson.Field
TotalCount apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DeviceOverrideCodeListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r deviceOverrideCodeListResponseEnvelopeResultInfoJSON) RawJSON() string {
return r.raw
}