feat(api): api update (#3674)

cloudflare · Nov 26, 2024 · 5b1f3e7 · 5b1f3e7
1 parent 91623fd
commit 5b1f3e7
Show file tree

Hide file tree

Showing 10 changed files with 213 additions and 392 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
-configured_endpoints: 1451
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-3151e81bdc8e6e6f3dc90b21f78c472b90c934926fef1dad65df1f1e13f21b6d.yml
+configured_endpoints: 1448
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-96e28d4d04ac2f1a00dda1130ef53e8bd9f2f1590e5d7ba8bed38cad29f8b2de.yml
diff --git a/api.md b/api.md
@@ -1300,17 +1300,11 @@ Response Types:
 
 - <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainNewResponseUnion">SettingTrustedDomainNewResponseUnion</a>
 - <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainListResponse">SettingTrustedDomainListResponse</a>
-- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainDeleteResponse">SettingTrustedDomainDeleteResponse</a>
-- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainEditResponse">SettingTrustedDomainEditResponse</a>
-- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainGetResponse">SettingTrustedDomainGetResponse</a>
 
 Methods:
 
 - <code title="post /accounts/{account_id}/email-security/settings/trusted_domains">client.EmailSecurity.Settings.TrustedDomains.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainNewParams">SettingTrustedDomainNewParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainNewResponseUnion">SettingTrustedDomainNewResponseUnion</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 - <code title="get /accounts/{account_id}/email-security/settings/trusted_domains">client.EmailSecurity.Settings.TrustedDomains.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainListParams">SettingTrustedDomainListParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/packages/pagination#V4PagePaginationArray">V4PagePaginationArray</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainListResponse">SettingTrustedDomainListResponse</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="delete /accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}">client.EmailSecurity.Settings.TrustedDomains.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainService.Delete">Delete</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, patternID <a href="https://pkg.go.dev/builtin#int64">int64</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainDeleteParams">SettingTrustedDomainDeleteParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainDeleteResponse">SettingTrustedDomainDeleteResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="patch /accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}">client.EmailSecurity.Settings.TrustedDomains.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainService.Edit">Edit</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, patternID <a href="https://pkg.go.dev/builtin#int64">int64</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainEditParams">SettingTrustedDomainEditParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainEditResponse">SettingTrustedDomainEditResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
-- <code title="get /accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}">client.EmailSecurity.Settings.TrustedDomains.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, patternID <a href="https://pkg.go.dev/builtin#int64">int64</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainGetParams">SettingTrustedDomainGetParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security">email_security</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v3/email_security#SettingTrustedDomainGetResponse">SettingTrustedDomainGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
 
 ## Submissions
 

diff --git a/email_security/investigatepreview.go b/email_security/investigatepreview.go
@@ -121,12 +121,12 @@ func (r investigatePreviewGetResponseJSON) RawJSON() string {
 type InvestigatePreviewNewParams struct {
 	// Account Identifier
 	AccountID param.Field[string] `path:"account_id,required"`
-	// A list of messages identfied by their `postfix_id`s that should be released.
-	Body []string `json:"body,required"`
+	// The identifier of the message.
+	PostfixID param.Field[string] `json:"postfix_id,required"`
 }
 
 func (r InvestigatePreviewNewParams) MarshalJSON() (data []byte, err error) {
-	return apijson.MarshalRoot(r.Body)
+	return apijson.MarshalRoot(r)
 }
 
 type InvestigatePreviewNewResponseEnvelope struct {

diff --git a/email_security/investigatepreview_test.go b/email_security/investigatepreview_test.go
@@ -29,7 +29,7 @@ func TestInvestigatePreviewNew(t *testing.T) {
 	)
 	_, err := client.EmailSecurity.Investigate.Preview.New(context.TODO(), email_security.InvestigatePreviewNewParams{
 		AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
-		Body:      []string{"4Njp3P0STMz2c02Q"},
+		PostfixID: cloudflare.F("4Njp3P0STMz2c02Q"),
 	})
 	if err != nil {
 		var apierr *cloudflare.Error

diff --git a/email_security/settingallowpolicy.go b/email_security/settingallowpolicy.go
@@ -134,6 +134,7 @@ func (r *SettingAllowPolicyService) Get(ctx context.Context, policyID int64, que
 }
 
 type SettingAllowPolicyNewResponse struct {
+	// The unique identifier for the allow policy.
 	ID        int64     `json:"id,required"`
 	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
 	// Messages from this sender will be exempted from Spam, Spoof and Bulk
@@ -205,6 +206,7 @@ func (r SettingAllowPolicyNewResponsePatternType) IsKnown() bool {
 }
 
 type SettingAllowPolicyListResponse struct {
+	// The unique identifier for the allow policy.
 	ID        int64     `json:"id,required"`
 	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
 	// Messages from this sender will be exempted from Spam, Spoof and Bulk
@@ -276,6 +278,7 @@ func (r SettingAllowPolicyListResponsePatternType) IsKnown() bool {
 }
 
 type SettingAllowPolicyDeleteResponse struct {
+	// The unique identifier for the allow policy.
 	ID   int64                                `json:"id,required"`
 	JSON settingAllowPolicyDeleteResponseJSON `json:"-"`
 }
@@ -297,6 +300,7 @@ func (r settingAllowPolicyDeleteResponseJSON) RawJSON() string {
 }
 
 type SettingAllowPolicyEditResponse struct {
+	// The unique identifier for the allow policy.
 	ID        int64     `json:"id,required"`
 	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
 	// Messages from this sender will be exempted from Spam, Spoof and Bulk
@@ -368,6 +372,7 @@ func (r SettingAllowPolicyEditResponsePatternType) IsKnown() bool {
 }
 
 type SettingAllowPolicyGetResponse struct {
+	// The unique identifier for the allow policy.
 	ID        int64     `json:"id,required"`
 	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
 	// Messages from this sender will be exempted from Spam, Spoof and Bulk
@@ -513,10 +518,13 @@ type SettingAllowPolicyListParams struct {
 	// Account Identifier
 	AccountID param.Field[string] `path:"account_id,required"`
 	// The sorting direction.
-	Direction   param.Field[SettingAllowPolicyListParamsDirection] `query:"direction"`
-	IsRecipient param.Field[bool]                                  `query:"is_recipient"`
-	IsSender    param.Field[bool]                                  `query:"is_sender"`
-	IsSpoof     param.Field[bool]                                  `query:"is_spoof"`
+	Direction          param.Field[SettingAllowPolicyListParamsDirection] `query:"direction"`
+	IsAcceptableSender param.Field[bool]                                  `query:"is_acceptable_sender"`
+	IsExemptRecipient  param.Field[bool]                                  `query:"is_exempt_recipient"`
+	IsRecipient        param.Field[bool]                                  `query:"is_recipient"`
+	IsSender           param.Field[bool]                                  `query:"is_sender"`
+	IsSpoof            param.Field[bool]                                  `query:"is_spoof"`
+	IsTrustedSender    param.Field[bool]                                  `query:"is_trusted_sender"`
 	// The field to sort by.
 	Order param.Field[SettingAllowPolicyListParamsOrder] `query:"order"`
 	// The page number of paginated results.

diff --git a/email_security/settingallowpolicy_test.go b/email_security/settingallowpolicy_test.go
@@ -64,17 +64,20 @@ func TestSettingAllowPolicyListWithOptionalParams(t *testing.T) {
 		option.WithAPIEmail("user@example.com"),
 	)
 	_, err := client.EmailSecurity.Settings.AllowPolicies.List(context.TODO(), email_security.SettingAllowPolicyListParams{
-		AccountID:    cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
-		Direction:    cloudflare.F(email_security.SettingAllowPolicyListParamsDirectionAsc),
-		IsRecipient:  cloudflare.F(true),
-		IsSender:     cloudflare.F(true),
-		IsSpoof:      cloudflare.F(true),
-		Order:        cloudflare.F(email_security.SettingAllowPolicyListParamsOrderPattern),
-		Page:         cloudflare.F(int64(1)),
-		PatternType:  cloudflare.F(email_security.SettingAllowPolicyListParamsPatternTypeEmail),
-		PerPage:      cloudflare.F(int64(1)),
-		Search:       cloudflare.F("search"),
-		VerifySender: cloudflare.F(true),
+		AccountID:          cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
+		Direction:          cloudflare.F(email_security.SettingAllowPolicyListParamsDirectionAsc),
+		IsAcceptableSender: cloudflare.F(true),
+		IsExemptRecipient:  cloudflare.F(true),
+		IsRecipient:        cloudflare.F(true),
+		IsSender:           cloudflare.F(true),
+		IsSpoof:            cloudflare.F(true),
+		IsTrustedSender:    cloudflare.F(true),
+		Order:              cloudflare.F(email_security.SettingAllowPolicyListParamsOrderPattern),
+		Page:               cloudflare.F(int64(1)),
+		PatternType:        cloudflare.F(email_security.SettingAllowPolicyListParamsPatternTypeEmail),
+		PerPage:            cloudflare.F(int64(1)),
+		Search:             cloudflare.F("search"),
+		VerifySender:       cloudflare.F(true),
 	})
 	if err != nil {
 		var apierr *cloudflare.Error