feat(api): api update (#3573)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 1397
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-011592842d973a3e62f468488f0f813dd511233ee29c6feab3516ce5b9475814.yml
+configured_endpoints: 1361
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-f42cd2aad7c5dc546130b78d1b183a339ff0c666d7b0e98159bdfbf09eecd80d.yml

api.md

@@ -82,99 +82,3 @@ func TestAccessRuleListWithOptionalParams(t *testing.T) {
 		t.Fatalf("err should be nil: %s", err.Error())
 	}
 }
-
-func TestAccessRuleDeleteWithOptionalParams(t *testing.T) {
-	t.Skip("TODO: investigate broken test")
-	baseURL := "http://localhost:4010"
-	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
-		baseURL = envURL
-	}
-	if !testutil.CheckTestServer(t, baseURL) {
-		return
-	}
-	client := cloudflare.NewClient(
-		option.WithBaseURL(baseURL),
-		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
-		option.WithAPIEmail("user@example.com"),
-	)
-	_, err := client.Firewall.AccessRules.Delete(
-		context.TODO(),
-		"023e105f4ecef8ad9ca31a8372d0c353",
-		firewall.AccessRuleDeleteParams{
-			AccountID: cloudflare.F("account_id"),
-		},
-	)
-	if err != nil {
-		var apierr *cloudflare.Error
-		if errors.As(err, &apierr) {
-			t.Log(string(apierr.DumpRequest(true)))
-		}
-		t.Fatalf("err should be nil: %s", err.Error())
-	}
-}
-
-func TestAccessRuleEditWithOptionalParams(t *testing.T) {
-	t.Skip("TODO: investigate broken test")
-	baseURL := "http://localhost:4010"
-	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
-		baseURL = envURL
-	}
-	if !testutil.CheckTestServer(t, baseURL) {
-		return
-	}
-	client := cloudflare.NewClient(
-		option.WithBaseURL(baseURL),
-		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
-		option.WithAPIEmail("user@example.com"),
-	)
-	_, err := client.Firewall.AccessRules.Edit(
-		context.TODO(),
-		"023e105f4ecef8ad9ca31a8372d0c353",
-		firewall.AccessRuleEditParams{
-			Configuration: cloudflare.F[firewall.AccessRuleEditParamsConfigurationUnion](firewall.AccessRuleIPConfigurationParam{
-				Target: cloudflare.F(firewall.AccessRuleIPConfigurationTargetIP),
-				Value:  cloudflare.F("198.51.100.4"),
-			}),
-			Mode:      cloudflare.F(firewall.AccessRuleEditParamsModeBlock),
-			AccountID: cloudflare.F("account_id"),
-			Notes:     cloudflare.F("This rule is enabled because of an event that occurred on date X."),
-		},
-	)
-	if err != nil {
-		var apierr *cloudflare.Error
-		if errors.As(err, &apierr) {
-			t.Log(string(apierr.DumpRequest(true)))
-		}
-		t.Fatalf("err should be nil: %s", err.Error())
-	}
-}
-
-func TestAccessRuleGetWithOptionalParams(t *testing.T) {
-	t.Skip("TODO: investigate broken test")
-	baseURL := "http://localhost:4010"
-	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
-		baseURL = envURL
-	}
-	if !testutil.CheckTestServer(t, baseURL) {
-		return
-	}
-	client := cloudflare.NewClient(
-		option.WithBaseURL(baseURL),
-		option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
-		option.WithAPIEmail("user@example.com"),
-	)
-	_, err := client.Firewall.AccessRules.Get(
-		context.TODO(),
-		"023e105f4ecef8ad9ca31a8372d0c353",
-		firewall.AccessRuleGetParams{
-			AccountID: cloudflare.F("account_id"),
-		},
-	)
-	if err != nil {
-		var apierr *cloudflare.Error
-		if errors.As(err, &apierr) {
-			t.Log(string(apierr.DumpRequest(true)))
-		}
-		t.Fatalf("err should be nil: %s", err.Error())
-	}
-}

filters/filter.go

@@ -3,21 +3,7 @@
 package firewall
 
 import (
-	"context"
-	"errors"
-	"fmt"
-	"net/http"
-	"net/url"
-	"reflect"
-
-	"github.com/cloudflare/cloudflare-go/v3/internal/apijson"
-	"github.com/cloudflare/cloudflare-go/v3/internal/apiquery"
-	"github.com/cloudflare/cloudflare-go/v3/internal/param"
-	"github.com/cloudflare/cloudflare-go/v3/internal/requestconfig"
 	"github.com/cloudflare/cloudflare-go/v3/option"
-	"github.com/cloudflare/cloudflare-go/v3/packages/pagination"
-	"github.com/cloudflare/cloudflare-go/v3/shared"
-	"github.com/tidwall/gjson"
 )
 
 // WAFPackageService contains methods and other services that help with interacting
@@ -42,287 +28,3 @@ func NewWAFPackageService(opts ...option.RequestOption) (r *WAFPackageService) {
 	r.Rules = NewWAFPackageRuleService(opts...)
 	return
 }
-
-// Fetches WAF packages for a zone.
-//
-// **Note:** Applies only to the
-// [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
-func (r *WAFPackageService) List(ctx context.Context, params WAFPackageListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[WAFPackageListResponse], err error) {
-	var raw *http.Response
-	opts = append(r.Options[:], opts...)
-	opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
-	if params.ZoneID.Value == "" {
-		err = errors.New("missing required zone_id parameter")
-		return
-	}
-	path := fmt.Sprintf("zones/%s/firewall/waf/packages", params.ZoneID)
-	cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, params, &res, opts...)
-	if err != nil {
-		return nil, err
-	}
-	err = cfg.Execute()
-	if err != nil {
-		return nil, err
-	}
-	res.SetPageConfig(cfg, raw)
-	return res, nil
-}
-
-// Fetches WAF packages for a zone.
-//
-// **Note:** Applies only to the
-// [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
-func (r *WAFPackageService) ListAutoPaging(ctx context.Context, params WAFPackageListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[WAFPackageListResponse] {
-	return pagination.NewV4PagePaginationArrayAutoPager(r.List(ctx, params, opts...))
-}
-
-// Fetches the details of a WAF package.
-//
-// **Note:** Applies only to the
-// [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).
-func (r *WAFPackageService) Get(ctx context.Context, packageID string, query WAFPackageGetParams, opts ...option.RequestOption) (res *WAFPackageGetResponse, err error) {
-	opts = append(r.Options[:], opts...)
-	if query.ZoneID.Value == "" {
-		err = errors.New("missing required zone_id parameter")
-		return
-	}
-	if packageID == "" {
-		err = errors.New("missing required package_id parameter")
-		return
-	}
-	path := fmt.Sprintf("zones/%s/firewall/waf/packages/%s", query.ZoneID, packageID)
-	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
-	return
-}
-
-type WAFPackageListResponse = interface{}
-
-type WAFPackageGetResponse struct {
-	// This field can have the runtime type of [[]shared.ResponseInfo].
-	Errors interface{} `json:"errors,required"`
-	// This field can have the runtime type of [[]shared.ResponseInfo].
-	Messages interface{} `json:"messages,required"`
-	// This field can have the runtime type of [interface{}].
-	Result interface{} `json:"result,required"`
-	// Whether the API call was successful
-	Success WAFPackageGetResponseSuccess `json:"success"`
-	JSON    wafPackageGetResponseJSON    `json:"-"`
-	union   WAFPackageGetResponseUnion
-}
-
-// wafPackageGetResponseJSON contains the JSON metadata for the struct
-// [WAFPackageGetResponse]
-type wafPackageGetResponseJSON struct {
-	Errors      apijson.Field
-	Messages    apijson.Field
-	Result      apijson.Field
-	Success     apijson.Field
-	raw         string
-	ExtraFields map[string]apijson.Field
-}
-
-func (r wafPackageGetResponseJSON) RawJSON() string {
-	return r.raw
-}
-
-func (r *WAFPackageGetResponse) UnmarshalJSON(data []byte) (err error) {
-	*r = WAFPackageGetResponse{}
-	err = apijson.UnmarshalRoot(data, &r.union)
-	if err != nil {
-		return err
-	}
-	return apijson.Port(r.union, &r)
-}
-
-// AsUnion returns a [WAFPackageGetResponseUnion] interface which you can cast to
-// the specific types for more type safety.
-//
-// Possible runtime types of the union are
-// [firewall.WAFPackageGetResponseFirewallAPIResponseSingle],
-// [firewall.WAFPackageGetResponseResult].
-func (r WAFPackageGetResponse) AsUnion() WAFPackageGetResponseUnion {
-	return r.union
-}
-
-// Union satisfied by [firewall.WAFPackageGetResponseFirewallAPIResponseSingle] or
-// [firewall.WAFPackageGetResponseResult].
-type WAFPackageGetResponseUnion interface {
-	implementsFirewallWAFPackageGetResponse()
-}
-
-func init() {
-	apijson.RegisterUnion(
-		reflect.TypeOf((*WAFPackageGetResponseUnion)(nil)).Elem(),
-		"",
-		apijson.UnionVariant{
-			TypeFilter: gjson.JSON,
-			Type:       reflect.TypeOf(WAFPackageGetResponseFirewallAPIResponseSingle{}),
-		},
-		apijson.UnionVariant{
-			TypeFilter: gjson.JSON,
-			Type:       reflect.TypeOf(WAFPackageGetResponseResult{}),
-		},
-	)
-}
-
-type WAFPackageGetResponseFirewallAPIResponseSingle struct {
-	Errors   []shared.ResponseInfo `json:"errors,required"`
-	Messages []shared.ResponseInfo `json:"messages,required"`
-	Result   interface{}           `json:"result,required"`
-	// Whether the API call was successful
-	Success WAFPackageGetResponseFirewallAPIResponseSingleSuccess `json:"success,required"`
-	JSON    wafPackageGetResponseFirewallAPIResponseSingleJSON    `json:"-"`
-}
-
-// wafPackageGetResponseFirewallAPIResponseSingleJSON contains the JSON metadata
-// for the struct [WAFPackageGetResponseFirewallAPIResponseSingle]
-type wafPackageGetResponseFirewallAPIResponseSingleJSON struct {
-	Errors      apijson.Field
-	Messages    apijson.Field
-	Result      apijson.Field
-	Success     apijson.Field
-	raw         string
-	ExtraFields map[string]apijson.Field
-}
-
-func (r *WAFPackageGetResponseFirewallAPIResponseSingle) UnmarshalJSON(data []byte) (err error) {
-	return apijson.UnmarshalRoot(data, r)
-}
-
-func (r wafPackageGetResponseFirewallAPIResponseSingleJSON) RawJSON() string {
-	return r.raw
-}
-
-func (r WAFPackageGetResponseFirewallAPIResponseSingle) implementsFirewallWAFPackageGetResponse() {}
-
-// Whether the API call was successful
-type WAFPackageGetResponseFirewallAPIResponseSingleSuccess bool
-
-const (
-	WAFPackageGetResponseFirewallAPIResponseSingleSuccessTrue WAFPackageGetResponseFirewallAPIResponseSingleSuccess = true
-)
-
-func (r WAFPackageGetResponseFirewallAPIResponseSingleSuccess) IsKnown() bool {
-	switch r {
-	case WAFPackageGetResponseFirewallAPIResponseSingleSuccessTrue:
-		return true
-	}
-	return false
-}
-
-type WAFPackageGetResponseResult struct {
-	Result interface{}                     `json:"result"`
-	JSON   wafPackageGetResponseResultJSON `json:"-"`
-}
-
-// wafPackageGetResponseResultJSON contains the JSON metadata for the struct
-// [WAFPackageGetResponseResult]
-type wafPackageGetResponseResultJSON struct {
-	Result      apijson.Field
-	raw         string
-	ExtraFields map[string]apijson.Field
-}
-
-func (r *WAFPackageGetResponseResult) UnmarshalJSON(data []byte) (err error) {
-	return apijson.UnmarshalRoot(data, r)
-}
-
-func (r wafPackageGetResponseResultJSON) RawJSON() string {
-	return r.raw
-}
-
-func (r WAFPackageGetResponseResult) implementsFirewallWAFPackageGetResponse() {}
-
-// Whether the API call was successful
-type WAFPackageGetResponseSuccess bool
-
-const (
-	WAFPackageGetResponseSuccessTrue WAFPackageGetResponseSuccess = true
-)
-
-func (r WAFPackageGetResponseSuccess) IsKnown() bool {
-	switch r {
-	case WAFPackageGetResponseSuccessTrue:
-		return true
-	}
-	return false
-}
-
-type WAFPackageListParams struct {
-	// Identifier
-	ZoneID param.Field[string] `path:"zone_id,required"`
-	// The direction used to sort returned packages.
-	Direction param.Field[WAFPackageListParamsDirection] `query:"direction"`
-	// When set to `all`, all the search requirements must match. When set to `any`,
-	// only one of the search requirements has to match.
-	Match param.Field[WAFPackageListParamsMatch] `query:"match"`
-	// The name of the WAF package.
-	Name param.Field[string] `query:"name"`
-	// The field used to sort returned packages.
-	Order param.Field[WAFPackageListParamsOrder] `query:"order"`
-	// The page number of paginated results.
-	Page param.Field[float64] `query:"page"`
-	// The number of packages per page.
-	PerPage param.Field[float64] `query:"per_page"`
-}
-
-// URLQuery serializes [WAFPackageListParams]'s query parameters as `url.Values`.
-func (r WAFPackageListParams) URLQuery() (v url.Values) {
-	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
-		ArrayFormat:  apiquery.ArrayQueryFormatRepeat,
-		NestedFormat: apiquery.NestedQueryFormatDots,
-	})
-}
-
-// The direction used to sort returned packages.
-type WAFPackageListParamsDirection string
-
-const (
-	WAFPackageListParamsDirectionAsc  WAFPackageListParamsDirection = "asc"
-	WAFPackageListParamsDirectionDesc WAFPackageListParamsDirection = "desc"
-)
-
-func (r WAFPackageListParamsDirection) IsKnown() bool {
-	switch r {
-	case WAFPackageListParamsDirectionAsc, WAFPackageListParamsDirectionDesc:
-		return true
-	}
-	return false
-}
-
-// When set to `all`, all the search requirements must match. When set to `any`,
-// only one of the search requirements has to match.
-type WAFPackageListParamsMatch string
-
-const (
-	WAFPackageListParamsMatchAny WAFPackageListParamsMatch = "any"
-	WAFPackageListParamsMatchAll WAFPackageListParamsMatch = "all"
-)
-
-func (r WAFPackageListParamsMatch) IsKnown() bool {
-	switch r {
-	case WAFPackageListParamsMatchAny, WAFPackageListParamsMatchAll:
-		return true
-	}
-	return false
-}
-
-// The field used to sort returned packages.
-type WAFPackageListParamsOrder string
-
-const (
-	WAFPackageListParamsOrderName WAFPackageListParamsOrder = "name"
-)
-
-func (r WAFPackageListParamsOrder) IsKnown() bool {
-	switch r {
-	case WAFPackageListParamsOrderName:
-		return true
-	}
-	return false
-}
-
-type WAFPackageGetParams struct {
-	// Identifier
-	ZoneID param.Field[string] `path:"zone_id,required"`
-}