feat(api): api update (#4034)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 1611
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-7119751984d8966c461abbc0c7826bde723d66c14eaa3516d0f7061ad49e9505.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-bde1b5a6daa5f9827ec7e0f04cfb6d85a2fb6678aef7a2073a00f8225673a142.yml

cloudforce_one/scanconfig.go

@@ -122,12 +122,19 @@ func (r *ScanConfigService) Edit(ctx context.Context, configID string, params Sc
 }
 
 type ScanConfigNewResponse struct {
-	ID        string                    `json:"id,required"`
-	AccountID string                    `json:"account_id,required"`
-	Frequency float64                   `json:"frequency,required"`
-	IPs       []string                  `json:"ips,required"`
-	Ports     []string                  `json:"ports,required"`
-	JSON      scanConfigNewResponseJSON `json:"-"`
+	// Config ID
+	ID        string `json:"id,required"`
+	AccountID string `json:"account_id,required"`
+	// The number of days between each scan (0 = no recurring scans).
+	Frequency float64 `json:"frequency,required"`
+	// A list of IP addresses or CIDR blocks to scan. The maximum number of total IP
+	// addresses allowed is 5000.
+	IPs []string `json:"ips,required"`
+	// A list of ports to scan. Allowed values:"default", "all", or a comma-separated
+	// list of ports or range of ports (e.g. ["1-80", "443"]). Default will scan the
+	// 100 most commonly open ports.
+	Ports []string                  `json:"ports,required"`
+	JSON  scanConfigNewResponseJSON `json:"-"`
 }
 
 // scanConfigNewResponseJSON contains the JSON metadata for the struct
@@ -151,12 +158,19 @@ func (r scanConfigNewResponseJSON) RawJSON() string {
 }
 
 type ScanConfigListResponse struct {
-	ID        string                     `json:"id,required"`
-	AccountID string                     `json:"account_id,required"`
-	Frequency float64                    `json:"frequency,required"`
-	IPs       []string                   `json:"ips,required"`
-	Ports     []string                   `json:"ports,required"`
-	JSON      scanConfigListResponseJSON `json:"-"`
+	// Config ID
+	ID        string `json:"id,required"`
+	AccountID string `json:"account_id,required"`
+	// The number of days between each scan (0 = no recurring scans).
+	Frequency float64 `json:"frequency,required"`
+	// A list of IP addresses or CIDR blocks to scan. The maximum number of total IP
+	// addresses allowed is 5000.
+	IPs []string `json:"ips,required"`
+	// A list of ports to scan. Allowed values:"default", "all", or a comma-separated
+	// list of ports or range of ports (e.g. ["1-80", "443"]). Default will scan the
+	// 100 most commonly open ports.
+	Ports []string                   `json:"ports,required"`
+	JSON  scanConfigListResponseJSON `json:"-"`
 }
 
 // scanConfigListResponseJSON contains the JSON metadata for the struct
@@ -182,12 +196,19 @@ func (r scanConfigListResponseJSON) RawJSON() string {
 type ScanConfigDeleteResponse = interface{}
 
 type ScanConfigEditResponse struct {
-	ID        string                     `json:"id,required"`
-	AccountID string                     `json:"account_id,required"`
-	Frequency float64                    `json:"frequency,required"`
-	IPs       []string                   `json:"ips,required"`
-	Ports     []string                   `json:"ports,required"`
-	JSON      scanConfigEditResponseJSON `json:"-"`
+	// Config ID
+	ID        string `json:"id,required"`
+	AccountID string `json:"account_id,required"`
+	// The number of days between each scan (0 = no recurring scans).
+	Frequency float64 `json:"frequency,required"`
+	// A list of IP addresses or CIDR blocks to scan. The maximum number of total IP
+	// addresses allowed is 5000.
+	IPs []string `json:"ips,required"`
+	// A list of ports to scan. Allowed values:"default", "all", or a comma-separated
+	// list of ports or range of ports (e.g. ["1-80", "443"]). Default will scan the
+	// 100 most commonly open ports.
+	Ports []string                   `json:"ports,required"`
+	JSON  scanConfigEditResponseJSON `json:"-"`
 }
 
 // scanConfigEditResponseJSON contains the JSON metadata for the struct

cloudforce_one/scanconfig_test.go

@@ -29,7 +29,7 @@ func TestScanConfigNewWithOptionalParams(t *testing.T) {
 	)
 	_, err := client.CloudforceOne.Scans.Config.New(context.TODO(), cloudforce_one.ScanConfigNewParams{
 		AccountID: cloudflare.F("account_id"),
-		IPs:       cloudflare.F([]string{"1.1.1.1"}),
+		IPs:       cloudflare.F([]string{"1.1.1.1", "2606:4700:4700::1111"}),
 		Frequency: cloudflare.F(7.000000),
 		Ports:     cloudflare.F([]string{"default"}),
 	})
@@ -115,7 +115,7 @@ func TestScanConfigEditWithOptionalParams(t *testing.T) {
 		cloudforce_one.ScanConfigEditParams{
 			AccountID: cloudflare.F("account_id"),
 			Frequency: cloudflare.F(7.000000),
-			IPs:       cloudflare.F([]string{"1.1.1.1"}),
+			IPs:       cloudflare.F([]string{"1.1.1.1", "2606:4700:4700::1111"}),
 			Ports:     cloudflare.F([]string{"default"}),
 		},
 	)