/
recommendation.go
131 lines (111 loc) · 4.25 KB
/
recommendation.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package ssl
import (
"context"
"fmt"
"net/http"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/internal/shared"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// RecommendationService 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 [NewRecommendationService] method
// instead.
type RecommendationService struct {
Options []option.RequestOption
}
// NewRecommendationService 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 NewRecommendationService(opts ...option.RequestOption) (r *RecommendationService) {
r = &RecommendationService{}
r.Options = opts
return
}
// Retrieve the SSL/TLS Recommender's recommendation for a zone.
func (r *RecommendationService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *RecommendationGetResponse, err error) {
opts = append(r.Options[:], opts...)
var env RecommendationGetResponseEnvelope
path := fmt.Sprintf("zones/%s/ssl/recommendation", zoneIdentifier)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type RecommendationGetResponse struct {
// Identifier of a recommedation result.
ID string `json:"id"`
ModifiedOn time.Time `json:"modified_on" format:"date-time"`
Value RecommendationGetResponseValue `json:"value"`
JSON recommendationGetResponseJSON `json:"-"`
}
// recommendationGetResponseJSON contains the JSON metadata for the struct
// [RecommendationGetResponse]
type recommendationGetResponseJSON struct {
ID apijson.Field
ModifiedOn apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *RecommendationGetResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r recommendationGetResponseJSON) RawJSON() string {
return r.raw
}
type RecommendationGetResponseValue string
const (
RecommendationGetResponseValueFlexible RecommendationGetResponseValue = "flexible"
RecommendationGetResponseValueFull RecommendationGetResponseValue = "full"
RecommendationGetResponseValueStrict RecommendationGetResponseValue = "strict"
)
func (r RecommendationGetResponseValue) IsKnown() bool {
switch r {
case RecommendationGetResponseValueFlexible, RecommendationGetResponseValueFull, RecommendationGetResponseValueStrict:
return true
}
return false
}
type RecommendationGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result RecommendationGetResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success RecommendationGetResponseEnvelopeSuccess `json:"success,required"`
JSON recommendationGetResponseEnvelopeJSON `json:"-"`
}
// recommendationGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [RecommendationGetResponseEnvelope]
type recommendationGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *RecommendationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r recommendationGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type RecommendationGetResponseEnvelopeSuccess bool
const (
RecommendationGetResponseEnvelopeSuccessTrue RecommendationGetResponseEnvelopeSuccess = true
)
func (r RecommendationGetResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case RecommendationGetResponseEnvelopeSuccessTrue:
return true
}
return false
}