From 7fe00c03384312682a27e927277e70e67c97b0c6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 13 Nov 2024 13:51:00 +0000 Subject: [PATCH] feat(api): api update (#3597) --- .stats.yml | 2 +- brand_protection/brandprotection.go | 2 +- intel/asn.go | 3 ++- intel/dns.go | 4 ++-- intel/domain.go | 2 +- intel/domainhistory.go | 3 ++- intel/ip.go | 3 ++- intel/miscategorization.go | 2 +- 8 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.stats.yml b/.stats.yml index d575e787796..d17621a3577 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,2 +1,2 @@ configured_endpoints: 1365 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-4593529df2c582c5e4de92308af748d9f8abbca6c92fff7e99e08bd463b7271e.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-eafbd03fd73e3a55e352ee0c79c070b09d59559f24c33911a864654a501c778f.yml diff --git a/brand_protection/brandprotection.go b/brand_protection/brandprotection.go index cebd2095f3d..203d082e5fa 100644 --- a/brand_protection/brandprotection.go +++ b/brand_protection/brandprotection.go @@ -53,7 +53,7 @@ func (r *BrandProtectionService) Submit(ctx context.Context, params BrandProtect return } -// Get results for a URL scan +// Gets phishing details about a URL. func (r *BrandProtectionService) URLInfo(ctx context.Context, params BrandProtectionURLInfoParams, opts ...option.RequestOption) (res *Info, err error) { var env BrandProtectionURLInfoResponseEnvelope opts = append(r.Options[:], opts...) diff --git a/intel/asn.go b/intel/asn.go index 433b375efdd..d5ff00edc94 100644 --- a/intel/asn.go +++ b/intel/asn.go @@ -36,7 +36,8 @@ func NewASNService(opts ...option.RequestOption) (r *ASNService) { return } -// Get ASN Overview +// Gets an overview of the Autonomous System Number (ASN) and a list of subnets for +// it. func (r *ASNService) Get(ctx context.Context, asn shared.ASNParam, query ASNGetParams, opts ...option.RequestOption) (res *shared.ASN, err error) { var env ASNGetResponseEnvelope opts = append(r.Options[:], opts...) diff --git a/intel/dns.go b/intel/dns.go index f9d361b5764..087a3766699 100644 --- a/intel/dns.go +++ b/intel/dns.go @@ -38,7 +38,7 @@ func NewDNSService(opts ...option.RequestOption) (r *DNSService) { return } -// Get Passive DNS by IP +// Gets a list of all the domains that have resolved to a specific IP address. func (r *DNSService) List(ctx context.Context, params DNSListParams, opts ...option.RequestOption) (res *pagination.V4PagePagination[DNSListResponse], err error) { var raw *http.Response opts = append(r.Options[:], opts...) @@ -60,7 +60,7 @@ func (r *DNSService) List(ctx context.Context, params DNSListParams, opts ...opt return res, nil } -// Get Passive DNS by IP +// Gets a list of all the domains that have resolved to a specific IP address. func (r *DNSService) ListAutoPaging(ctx context.Context, params DNSListParams, opts ...option.RequestOption) *pagination.V4PagePaginationAutoPager[DNSListResponse] { return pagination.NewV4PagePaginationAutoPager(r.List(ctx, params, opts...)) } diff --git a/intel/domain.go b/intel/domain.go index 6dddc181463..1cc301cc802 100644 --- a/intel/domain.go +++ b/intel/domain.go @@ -38,7 +38,7 @@ func NewDomainService(opts ...option.RequestOption) (r *DomainService) { return } -// Get Domain Details +// Gets security details and statistics about a domain. func (r *DomainService) Get(ctx context.Context, params DomainGetParams, opts ...option.RequestOption) (res *Domain, err error) { var env DomainGetResponseEnvelope opts = append(r.Options[:], opts...) diff --git a/intel/domainhistory.go b/intel/domainhistory.go index 5512f9bbc5e..c4fa0b96401 100644 --- a/intel/domainhistory.go +++ b/intel/domainhistory.go @@ -37,7 +37,8 @@ func NewDomainHistoryService(opts ...option.RequestOption) (r *DomainHistoryServ return } -// Get Domain History +// Gets historical security threat and content categories currently and previously +// assigned to a domain. func (r *DomainHistoryService) Get(ctx context.Context, params DomainHistoryGetParams, opts ...option.RequestOption) (res *[]DomainHistory, err error) { var env DomainHistoryGetResponseEnvelope opts = append(r.Options[:], opts...) diff --git a/intel/ip.go b/intel/ip.go index e49608195e9..c096351ca69 100644 --- a/intel/ip.go +++ b/intel/ip.go @@ -36,7 +36,8 @@ func NewIPService(opts ...option.RequestOption) (r *IPService) { return } -// Same as summary +// Gets the geolocation, ASN, infrastructure type of the ASN, and any security +// threat categories of an IP address. func (r *IPService) Get(ctx context.Context, params IPGetParams, opts ...option.RequestOption) (res *[]IP, err error) { var env IPGetResponseEnvelope opts = append(r.Options[:], opts...) diff --git a/intel/miscategorization.go b/intel/miscategorization.go index 9b8b6b02c09..a0bd113903e 100644 --- a/intel/miscategorization.go +++ b/intel/miscategorization.go @@ -34,7 +34,7 @@ func NewMiscategorizationService(opts ...option.RequestOption) (r *Miscategoriza return } -// Create Miscategorization +// Allows you to submit requests to change a domain’s category. func (r *MiscategorizationService) New(ctx context.Context, params MiscategorizationNewParams, opts ...option.RequestOption) (res *MiscategorizationNewResponse, err error) { opts = append(r.Options[:], opts...) if params.AccountID.Value == "" {