From ce6d833a236587b4cb38b3e2c969b0c5b30960c1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 15 Mar 2024 02:56:14 +0000 Subject: [PATCH] feat(api): update via SDK Studio (#1563) --- api.md | 6 +- internal/shared/union.go | 2 +- zero_trust/accesscertificatesetting.go | 86 ++++++++++----------- zero_trust/accesscertificatesetting_test.go | 4 +- zero_trust/accesskey.go | 76 +++++++++--------- zero_trust/accesskey_test.go | 4 +- 6 files changed, 89 insertions(+), 89 deletions(-) diff --git a/api.md b/api.md index af2fc862f05..e1fe1c60fab 100644 --- a/api.md +++ b/api.md @@ -4505,7 +4505,7 @@ Response Types: Methods: - client.ZeroTrust.Access.Certificates.Settings.Update(ctx context.Context, params zero_trust.AccessCertificateSettingUpdateParams) ([]zero_trust.AccessSettings, error) -- client.ZeroTrust.Access.Certificates.Settings.List(ctx context.Context, query zero_trust.AccessCertificateSettingListParams) ([]zero_trust.AccessSettings, error) +- client.ZeroTrust.Access.Certificates.Settings.Get(ctx context.Context, query zero_trust.AccessCertificateSettingGetParams) ([]zero_trust.AccessSettings, error) ### Groups @@ -4559,13 +4559,13 @@ Methods: Response Types: - zero_trust.AccessKeyUpdateResponse -- zero_trust.AccessKeyListResponse +- zero_trust.AccessKeyGetResponse - zero_trust.AccessKeyRotateResponse Methods: - client.ZeroTrust.Access.Keys.Update(ctx context.Context, identifier string, body zero_trust.AccessKeyUpdateParams) (zero_trust.AccessKeyUpdateResponse, error) -- client.ZeroTrust.Access.Keys.List(ctx context.Context, identifier string) (zero_trust.AccessKeyListResponse, error) +- client.ZeroTrust.Access.Keys.Get(ctx context.Context, identifier string) (zero_trust.AccessKeyGetResponse, error) - client.ZeroTrust.Access.Keys.Rotate(ctx context.Context, identifier string) (zero_trust.AccessKeyRotateResponse, error) ### Logs diff --git a/internal/shared/union.go b/internal/shared/union.go index a0bb599d279..d40977166ee 100644 --- a/internal/shared/union.go +++ b/internal/shared/union.go @@ -177,7 +177,7 @@ func (UnionString) ImplementsZeroTrustAccessApplicationCANewResponse() func (UnionString) ImplementsZeroTrustAccessApplicationCAGetResponse() {} func (UnionString) ImplementsZeroTrustAccessApplicationUserPolicyCheckListParamsAppID() {} func (UnionString) ImplementsZeroTrustAccessKeyUpdateResponse() {} -func (UnionString) ImplementsZeroTrustAccessKeyListResponse() {} +func (UnionString) ImplementsZeroTrustAccessKeyGetResponse() {} func (UnionString) ImplementsZeroTrustAccessKeyRotateResponse() {} func (UnionString) ImplementsZeroTrustTunnelConfigurationUpdateResponse() {} func (UnionString) ImplementsZeroTrustTunnelConfigurationGetResponse() {} diff --git a/zero_trust/accesscertificatesetting.go b/zero_trust/accesscertificatesetting.go index 00ceccb4f22..72da3100cb2 100644 --- a/zero_trust/accesscertificatesetting.go +++ b/zero_trust/accesscertificatesetting.go @@ -54,9 +54,9 @@ func (r *AccessCertificateSettingService) Update(ctx context.Context, params Acc } // List all mTLS hostname settings for this account or zone. -func (r *AccessCertificateSettingService) List(ctx context.Context, query AccessCertificateSettingListParams, opts ...option.RequestOption) (res *[]AccessSettings, err error) { +func (r *AccessCertificateSettingService) Get(ctx context.Context, query AccessCertificateSettingGetParams, opts ...option.RequestOption) (res *[]AccessSettings, err error) { opts = append(r.Options[:], opts...) - var env AccessCertificateSettingListResponseEnvelope + var env AccessCertificateSettingGetResponseEnvelope var accountOrZone string var accountOrZoneID param.Field[string] if query.AccountID.Present { @@ -248,26 +248,26 @@ func (r accessCertificateSettingUpdateResponseEnvelopeResultInfoJSON) RawJSON() return r.raw } -type AccessCertificateSettingListParams struct { +type AccessCertificateSettingGetParams struct { // The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. AccountID param.Field[string] `path:"account_id"` // The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. ZoneID param.Field[string] `path:"zone_id"` } -type AccessCertificateSettingListResponseEnvelope struct { - Errors []AccessCertificateSettingListResponseEnvelopeErrors `json:"errors,required"` - Messages []AccessCertificateSettingListResponseEnvelopeMessages `json:"messages,required"` - Result []AccessSettings `json:"result,required,nullable"` +type AccessCertificateSettingGetResponseEnvelope struct { + Errors []AccessCertificateSettingGetResponseEnvelopeErrors `json:"errors,required"` + Messages []AccessCertificateSettingGetResponseEnvelopeMessages `json:"messages,required"` + Result []AccessSettings `json:"result,required,nullable"` // Whether the API call was successful - Success AccessCertificateSettingListResponseEnvelopeSuccess `json:"success,required"` - ResultInfo AccessCertificateSettingListResponseEnvelopeResultInfo `json:"result_info"` - JSON accessCertificateSettingListResponseEnvelopeJSON `json:"-"` + Success AccessCertificateSettingGetResponseEnvelopeSuccess `json:"success,required"` + ResultInfo AccessCertificateSettingGetResponseEnvelopeResultInfo `json:"result_info"` + JSON accessCertificateSettingGetResponseEnvelopeJSON `json:"-"` } -// accessCertificateSettingListResponseEnvelopeJSON contains the JSON metadata for -// the struct [AccessCertificateSettingListResponseEnvelope] -type accessCertificateSettingListResponseEnvelopeJSON struct { +// accessCertificateSettingGetResponseEnvelopeJSON contains the JSON metadata for +// the struct [AccessCertificateSettingGetResponseEnvelope] +type accessCertificateSettingGetResponseEnvelopeJSON struct { Errors apijson.Field Messages apijson.Field Result apijson.Field @@ -277,68 +277,68 @@ type accessCertificateSettingListResponseEnvelopeJSON struct { ExtraFields map[string]apijson.Field } -func (r *AccessCertificateSettingListResponseEnvelope) UnmarshalJSON(data []byte) (err error) { +func (r *AccessCertificateSettingGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessCertificateSettingListResponseEnvelopeJSON) RawJSON() string { +func (r accessCertificateSettingGetResponseEnvelopeJSON) RawJSON() string { return r.raw } -type AccessCertificateSettingListResponseEnvelopeErrors struct { - Code int64 `json:"code,required"` - Message string `json:"message,required"` - JSON accessCertificateSettingListResponseEnvelopeErrorsJSON `json:"-"` +type AccessCertificateSettingGetResponseEnvelopeErrors struct { + Code int64 `json:"code,required"` + Message string `json:"message,required"` + JSON accessCertificateSettingGetResponseEnvelopeErrorsJSON `json:"-"` } -// accessCertificateSettingListResponseEnvelopeErrorsJSON contains the JSON -// metadata for the struct [AccessCertificateSettingListResponseEnvelopeErrors] -type accessCertificateSettingListResponseEnvelopeErrorsJSON struct { +// accessCertificateSettingGetResponseEnvelopeErrorsJSON contains the JSON metadata +// for the struct [AccessCertificateSettingGetResponseEnvelopeErrors] +type accessCertificateSettingGetResponseEnvelopeErrorsJSON struct { Code apijson.Field Message apijson.Field raw string ExtraFields map[string]apijson.Field } -func (r *AccessCertificateSettingListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error) { +func (r *AccessCertificateSettingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessCertificateSettingListResponseEnvelopeErrorsJSON) RawJSON() string { +func (r accessCertificateSettingGetResponseEnvelopeErrorsJSON) RawJSON() string { return r.raw } -type AccessCertificateSettingListResponseEnvelopeMessages struct { - Code int64 `json:"code,required"` - Message string `json:"message,required"` - JSON accessCertificateSettingListResponseEnvelopeMessagesJSON `json:"-"` +type AccessCertificateSettingGetResponseEnvelopeMessages struct { + Code int64 `json:"code,required"` + Message string `json:"message,required"` + JSON accessCertificateSettingGetResponseEnvelopeMessagesJSON `json:"-"` } -// accessCertificateSettingListResponseEnvelopeMessagesJSON contains the JSON -// metadata for the struct [AccessCertificateSettingListResponseEnvelopeMessages] -type accessCertificateSettingListResponseEnvelopeMessagesJSON struct { +// accessCertificateSettingGetResponseEnvelopeMessagesJSON contains the JSON +// metadata for the struct [AccessCertificateSettingGetResponseEnvelopeMessages] +type accessCertificateSettingGetResponseEnvelopeMessagesJSON struct { Code apijson.Field Message apijson.Field raw string ExtraFields map[string]apijson.Field } -func (r *AccessCertificateSettingListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error) { +func (r *AccessCertificateSettingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessCertificateSettingListResponseEnvelopeMessagesJSON) RawJSON() string { +func (r accessCertificateSettingGetResponseEnvelopeMessagesJSON) RawJSON() string { return r.raw } // Whether the API call was successful -type AccessCertificateSettingListResponseEnvelopeSuccess bool +type AccessCertificateSettingGetResponseEnvelopeSuccess bool const ( - AccessCertificateSettingListResponseEnvelopeSuccessTrue AccessCertificateSettingListResponseEnvelopeSuccess = true + AccessCertificateSettingGetResponseEnvelopeSuccessTrue AccessCertificateSettingGetResponseEnvelopeSuccess = true ) -type AccessCertificateSettingListResponseEnvelopeResultInfo struct { +type AccessCertificateSettingGetResponseEnvelopeResultInfo struct { // Total number of results for the requested service Count float64 `json:"count"` // Current page within paginated list of results @@ -346,13 +346,13 @@ type AccessCertificateSettingListResponseEnvelopeResultInfo struct { // 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 accessCertificateSettingListResponseEnvelopeResultInfoJSON `json:"-"` + TotalCount float64 `json:"total_count"` + JSON accessCertificateSettingGetResponseEnvelopeResultInfoJSON `json:"-"` } -// accessCertificateSettingListResponseEnvelopeResultInfoJSON contains the JSON -// metadata for the struct [AccessCertificateSettingListResponseEnvelopeResultInfo] -type accessCertificateSettingListResponseEnvelopeResultInfoJSON struct { +// accessCertificateSettingGetResponseEnvelopeResultInfoJSON contains the JSON +// metadata for the struct [AccessCertificateSettingGetResponseEnvelopeResultInfo] +type accessCertificateSettingGetResponseEnvelopeResultInfoJSON struct { Count apijson.Field Page apijson.Field PerPage apijson.Field @@ -361,10 +361,10 @@ type accessCertificateSettingListResponseEnvelopeResultInfoJSON struct { ExtraFields map[string]apijson.Field } -func (r *AccessCertificateSettingListResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) { +func (r *AccessCertificateSettingGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessCertificateSettingListResponseEnvelopeResultInfoJSON) RawJSON() string { +func (r accessCertificateSettingGetResponseEnvelopeResultInfoJSON) RawJSON() string { return r.raw } diff --git a/zero_trust/accesscertificatesetting_test.go b/zero_trust/accesscertificatesetting_test.go index fe9690f69ea..abf118cd535 100644 --- a/zero_trust/accesscertificatesetting_test.go +++ b/zero_trust/accesscertificatesetting_test.go @@ -54,7 +54,7 @@ func TestAccessCertificateSettingUpdateWithOptionalParams(t *testing.T) { } } -func TestAccessCertificateSettingListWithOptionalParams(t *testing.T) { +func TestAccessCertificateSettingGetWithOptionalParams(t *testing.T) { t.Skip("skipped: tests are disabled for the time being") baseURL := "http://localhost:4010" if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok { @@ -68,7 +68,7 @@ func TestAccessCertificateSettingListWithOptionalParams(t *testing.T) { option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) - _, err := client.ZeroTrust.Access.Certificates.Settings.List(context.TODO(), zero_trust.AccessCertificateSettingListParams{ + _, err := client.ZeroTrust.Access.Certificates.Settings.Get(context.TODO(), zero_trust.AccessCertificateSettingGetParams{ AccountID: cloudflare.F("string"), ZoneID: cloudflare.F("string"), }) diff --git a/zero_trust/accesskey.go b/zero_trust/accesskey.go index fb84cd3ec07..87fbf5c09e3 100644 --- a/zero_trust/accesskey.go +++ b/zero_trust/accesskey.go @@ -48,9 +48,9 @@ func (r *AccessKeyService) Update(ctx context.Context, identifier string, body A } // Gets the Access key rotation settings for an account. -func (r *AccessKeyService) List(ctx context.Context, identifier string, opts ...option.RequestOption) (res *AccessKeyListResponse, err error) { +func (r *AccessKeyService) Get(ctx context.Context, identifier string, opts ...option.RequestOption) (res *AccessKeyGetResponse, err error) { opts = append(r.Options[:], opts...) - var env AccessKeyListResponseEnvelope + var env AccessKeyGetResponseEnvelope path := fmt.Sprintf("accounts/%s/access/keys", identifier) err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...) if err != nil { @@ -90,15 +90,15 @@ func init() { ) } -// Union satisfied by [zero_trust.AccessKeyListResponseUnknown] or +// Union satisfied by [zero_trust.AccessKeyGetResponseUnknown] or // [shared.UnionString]. -type AccessKeyListResponse interface { - ImplementsZeroTrustAccessKeyListResponse() +type AccessKeyGetResponse interface { + ImplementsZeroTrustAccessKeyGetResponse() } func init() { apijson.RegisterUnion( - reflect.TypeOf((*AccessKeyListResponse)(nil)).Elem(), + reflect.TypeOf((*AccessKeyGetResponse)(nil)).Elem(), "", apijson.UnionVariant{ TypeFilter: gjson.String, @@ -223,24 +223,24 @@ const ( AccessKeyUpdateResponseEnvelopeSuccessTrue AccessKeyUpdateResponseEnvelopeSuccess = true ) -type AccessKeyListResponseEnvelope struct { - Errors []AccessKeyListResponseEnvelopeErrors `json:"errors,required"` - Messages []AccessKeyListResponseEnvelopeMessages `json:"messages,required"` - Result AccessKeyListResponse `json:"result,required"` +type AccessKeyGetResponseEnvelope struct { + Errors []AccessKeyGetResponseEnvelopeErrors `json:"errors,required"` + Messages []AccessKeyGetResponseEnvelopeMessages `json:"messages,required"` + Result AccessKeyGetResponse `json:"result,required"` // Whether the API call was successful - Success AccessKeyListResponseEnvelopeSuccess `json:"success,required"` + Success AccessKeyGetResponseEnvelopeSuccess `json:"success,required"` // The number of days until the next key rotation. DaysUntilNextRotation float64 `json:"days_until_next_rotation"` // The number of days between key rotations. KeyRotationIntervalDays float64 `json:"key_rotation_interval_days"` // The timestamp of the previous key rotation. - LastKeyRotationAt time.Time `json:"last_key_rotation_at" format:"date-time"` - JSON accessKeyListResponseEnvelopeJSON `json:"-"` + LastKeyRotationAt time.Time `json:"last_key_rotation_at" format:"date-time"` + JSON accessKeyGetResponseEnvelopeJSON `json:"-"` } -// accessKeyListResponseEnvelopeJSON contains the JSON metadata for the struct -// [AccessKeyListResponseEnvelope] -type accessKeyListResponseEnvelopeJSON struct { +// accessKeyGetResponseEnvelopeJSON contains the JSON metadata for the struct +// [AccessKeyGetResponseEnvelope] +type accessKeyGetResponseEnvelopeJSON struct { Errors apijson.Field Messages apijson.Field Result apijson.Field @@ -252,65 +252,65 @@ type accessKeyListResponseEnvelopeJSON struct { ExtraFields map[string]apijson.Field } -func (r *AccessKeyListResponseEnvelope) UnmarshalJSON(data []byte) (err error) { +func (r *AccessKeyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessKeyListResponseEnvelopeJSON) RawJSON() string { +func (r accessKeyGetResponseEnvelopeJSON) RawJSON() string { return r.raw } -type AccessKeyListResponseEnvelopeErrors struct { - Code int64 `json:"code,required"` - Message string `json:"message,required"` - JSON accessKeyListResponseEnvelopeErrorsJSON `json:"-"` +type AccessKeyGetResponseEnvelopeErrors struct { + Code int64 `json:"code,required"` + Message string `json:"message,required"` + JSON accessKeyGetResponseEnvelopeErrorsJSON `json:"-"` } -// accessKeyListResponseEnvelopeErrorsJSON contains the JSON metadata for the -// struct [AccessKeyListResponseEnvelopeErrors] -type accessKeyListResponseEnvelopeErrorsJSON struct { +// accessKeyGetResponseEnvelopeErrorsJSON contains the JSON metadata for the struct +// [AccessKeyGetResponseEnvelopeErrors] +type accessKeyGetResponseEnvelopeErrorsJSON struct { Code apijson.Field Message apijson.Field raw string ExtraFields map[string]apijson.Field } -func (r *AccessKeyListResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error) { +func (r *AccessKeyGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessKeyListResponseEnvelopeErrorsJSON) RawJSON() string { +func (r accessKeyGetResponseEnvelopeErrorsJSON) RawJSON() string { return r.raw } -type AccessKeyListResponseEnvelopeMessages struct { - Code int64 `json:"code,required"` - Message string `json:"message,required"` - JSON accessKeyListResponseEnvelopeMessagesJSON `json:"-"` +type AccessKeyGetResponseEnvelopeMessages struct { + Code int64 `json:"code,required"` + Message string `json:"message,required"` + JSON accessKeyGetResponseEnvelopeMessagesJSON `json:"-"` } -// accessKeyListResponseEnvelopeMessagesJSON contains the JSON metadata for the -// struct [AccessKeyListResponseEnvelopeMessages] -type accessKeyListResponseEnvelopeMessagesJSON struct { +// accessKeyGetResponseEnvelopeMessagesJSON contains the JSON metadata for the +// struct [AccessKeyGetResponseEnvelopeMessages] +type accessKeyGetResponseEnvelopeMessagesJSON struct { Code apijson.Field Message apijson.Field raw string ExtraFields map[string]apijson.Field } -func (r *AccessKeyListResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error) { +func (r *AccessKeyGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error) { return apijson.UnmarshalRoot(data, r) } -func (r accessKeyListResponseEnvelopeMessagesJSON) RawJSON() string { +func (r accessKeyGetResponseEnvelopeMessagesJSON) RawJSON() string { return r.raw } // Whether the API call was successful -type AccessKeyListResponseEnvelopeSuccess bool +type AccessKeyGetResponseEnvelopeSuccess bool const ( - AccessKeyListResponseEnvelopeSuccessTrue AccessKeyListResponseEnvelopeSuccess = true + AccessKeyGetResponseEnvelopeSuccessTrue AccessKeyGetResponseEnvelopeSuccess = true ) type AccessKeyRotateResponseEnvelope struct { diff --git a/zero_trust/accesskey_test.go b/zero_trust/accesskey_test.go index 4a312384778..17b34415fc9 100644 --- a/zero_trust/accesskey_test.go +++ b/zero_trust/accesskey_test.go @@ -44,7 +44,7 @@ func TestAccessKeyUpdate(t *testing.T) { } } -func TestAccessKeyList(t *testing.T) { +func TestAccessKeyGet(t *testing.T) { t.Skip("skipped: tests are disabled for the time being") baseURL := "http://localhost:4010" if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok { @@ -58,7 +58,7 @@ func TestAccessKeyList(t *testing.T) { option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) - _, err := client.ZeroTrust.Access.Keys.List(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353") + _, err := client.ZeroTrust.Access.Keys.Get(context.TODO(), "023e105f4ecef8ad9ca31a8372d0c353") if err != nil { var apierr *cloudflare.Error if errors.As(err, &apierr) {