Cloudflare Go Library

All request parameters are wrapped in a generic Field type. This allows the SDK to distinguish between a zero value (like 0, false, or "") and a field that was omitted or explicitly set to null.

• Use cloudflare.F[T](value) to set a value.
• Use cloudflare.Null[T]() to explicitly send a null value.
• Use cloudflare.Raw[T](value) to send a value that doesn't strictly match the expected type (e.g., sending a float where an int is expected).
• Helpers like String(), Int(), and Float() are also available.

params := FooParams{
	Name: cloudflare.F("hello"),

	// Explicitly send `"description": null`
	Description: cloudflare.Null[string](),

	Point: cloudflare.F(cloudflare.Point{
		X: cloudflare.Int(0),
		Y: cloudflare.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: cloudflare.Raw[int64](0.01), // sends a float
	},
}

Response struct fields are value types. If a field is null or missing in the API response, the struct field will contain its zero value.

To inspect the actual state of the JSON response, use the .JSON field on the response object. This provides metadata about each property:

• res.JSON.Field.IsNull(): True if the field was null or not present.
• res.JSON.Field.IsMissing(): True if the key was not present in the JSON at all.
• res.JSON.Field.IsInvalid(): True if the API returned data that couldn't be coerced to the expected type. Use res.JSON.Field.Raw() to get the raw data for manual unmarshaling.

Additionally, .JSON.ExtraFields is a map containing any properties returned by the API that were not defined in the SDK's response struct.

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the response JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string ` + "`json:\"first\"`" + `
			Last  string ` + "`json:\"last\"`" + `
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

// Accessing undocumented fields
body := res.JSON.ExtraFields["my_unexpected_field"].Raw()

The cloudflare-go library uses a shared package to provide consistent types across different API services. These types are used for both request parameters and API responses to ensure uniformity in data structures like permissions, roles, and tokens.

Shared Parameter Types:

• shared.ASNParam
• shared.CertificateCA
• shared.CertificateRequestType
• shared.PermissionGrantParam
• shared.RatePlanParam
• shared.RoleParam
• shared.SortDirection
• shared.SubscriptionParam
• shared.TokenParam
• shared.TokenConditionCIDRListParam
• shared.TokenPolicyParam

Shared Response Types:

• shared.ASN
• shared.AuditLog
• shared.CertificateCA
• shared.CertificateRequestType
• shared.CloudflareTunnel
• shared.ErrorData
• shared.Member
• shared.Permission
• shared.PermissionGrant
• shared.RatePlan
• shared.ResponseInfo
• shared.Role
• shared.SortDirection
• shared.Subscription
• shared.Token
• shared.TokenConditionCIDRList
• shared.TokenPolicy
• shared.TokenValue

The path parameter types for Delete, Edit, and Get methods across several sub-resources have changed from int64 to string. Passing integer literals or int64 variables will cause compilation errors.

Affected Services:

• AllowPolicies (policyID)
• BlockSenders (patternID)
• Domains (domainID)
• ImpersonationRegistry (impersonationRegistryID — formerly displayNameID)
• TrustedDomains (trustedDomainID)

Actions Needed:

1. Convert all int64 path parameter arguments to string (e.g., using strconv.FormatInt() or string literals).
2. For ImpersonationRegistry, update the parameter name from displayNameID to impersonationRegistryID in any named-argument usage.

// After (v7.0.0):
_, err := client.EmailSecurity.Settings.AllowPolicies.Delete(
    ctx,
    "2401",
    email_security.SettingAllowPolicyDeleteParams{
        AccountID: cloudflare.F("account_id"),
    },
)