This is a major version release that includes breaking changes to three packages: ai_search, email_security, and workers. These changes reflect upstream API specification updates that improve type correctness and consistency.
Please ensure you read through the list of changes below before moving to this version - this will help you understand any down or upstream issues it may cause to your environments.
Breaking Changes
See the v7.0.0 Migration Guide ↗ for before/after code examples and actions needed for each change.
AI Search - SearchForAgents Metadata Removed
The SearchForAgents nested type has been removed from all instance metadata structs. This field is no longer part of the API specification.
The Investigate.Get, Investigate.Move.New, and Investigate.Reclassify.New methods now use investigateID instead of postfixID as the path parameter name.
The observability telemetry filter parameter types have been restructured to support nested filter groups. New discriminated union types replace the previous flat filter arrays:
ObservabilityTelemetryKeysParams.Filters now accepts FiltersObjectFilterUnion (was []interface\{\})
ObservabilityTelemetryQueryParams.Parameters.Filters now accepts FiltersObjectFilterUnion
ObservabilityTelemetryValuesParams.Filters now accepts FiltersObjectFilterUnion
New types include FiltersObjectFiltersObject (for group filters with FilterCombination) and FiltersWorkersObservabilityFilterLeaf (for leaf filters with typed Operation, Type, and Value fields).
In this release, you'll see a number of breaking changes. This is primarily due to changes in OpenAPI definitions, which our libraries are based off of, and codegen updates that we rely on to read those OpenAPI definitions and produce our SDK libraries.
Please ensure you read through the list of changes below before moving to this version - this will help you understand any down or upstream issues it may cause to your environments.
Breaking Changes
See the v6.10.0 Migration Guide ↗ for before/after code examples and actions needed for each change.
Abuse Reports - Registrar WHOIS Report Field Removals
Several fields have been removed from AbuseReportNewParamsBodyAbuseReportsRegistrarWhoisReportRegWhoRequest:
RegWhoGoodFaithAffirmation
RegWhoLawfulProcessingAgreement
RegWhoLegalBasis
RegWhoRequestType
RegWhoRequestedDataElements
AI Search - Instance Params Restructured
The InstanceNewParams and InstanceUpdateParams types have been significantly restructured. Many fields have been moved or removed:
InstanceSearchParams.Messages field removed along with InstanceSearchParamsMessage and InstanceSearchParamsMessagesRole types
AI Search - InstanceItem Service Removed
The InstanceItemService type has been removed. The items sub-resource at client.AISearch.Instances.Items no longer exists in the non-namespace path. Use client.AISearch.Namespaces.Instances.Items instead.
AI Search - Token Types Removed
The following types have been removed from the ai_search package:
Email Security - Investigate Move Return Type Change
The Investigate.Move.New() method now returns a raw slice instead of a paginated wrapper:
New() returns *[]InvestigateMoveNewResponse instead of *pagination.SinglePage[InvestigateMoveNewResponse]
NewAutoPaging() method removed
Hyperdrive - Config Params Restructured
The ConfigEditParams type lost its MTLS and Name fields. The HyperdriveMTLSParam type lost MTLS and Host fields. The Host field on origin config changed from param.Field[string] to a plain string.
IAM - UserGroupMember Params and Return Types Changed
The UserGroupMemberNewParams struct has been restructured and the New() method now returns a paginated response:
UserGroupMemberNewParams.Body renamed to UserGroupMemberNewParams.Members
UserGroupMemberNewParamsBody renamed to UserGroupMemberNewParamsMember
UserGroupMemberUpdateParams.Body renamed to UserGroupMemberUpdateParams.Members
UserGroupMemberUpdateParamsBody renamed to UserGroupMemberUpdateParamsMember
UserGroups.Members.New() returns *pagination.SinglePage[UserGroupMemberNewResponse] instead of *UserGroupMemberNewResponse
IAM - UserGroup List Direction Type Changed
The UserGroupListParams.Direction field changed from param.Field[string] to param.Field[UserGroupListParamsDirection] (typed enum with asc/desc values).
Pipelines - Delete Methods Now Return Typed Responses
Several delete methods across Pipelines now return typed responses instead of bare error:
Pipelines.DeleteV1() returns (*PipelineDeleteV1Response, error) instead of error
Pipelines.Sinks.Delete() returns (*SinkDeleteResponse, error) instead of error
Pipelines.Streams.Delete() returns (*StreamDeleteResponse, error) instead of error
Queues - Message Response Types Removed
The following response envelope types have been removed:
MessageBulkPushResponseSuccess
MessagePushResponseSuccess
MessageAckResponse fields RetryCount and Warnings removed
Secrets Store - Pagination Wrapper Removal and Type Changes
Methods now return direct types instead of SinglePage wrappers, and several internal types have been removed. Associated AutoPaging methods have also been removed:
Stores.New() returns *StoreNewResponse instead of *pagination.SinglePage[StoreNewResponse]
Stores.NewAutoPaging() method removed
Stores.Secrets.BulkDelete() returns *StoreSecretBulkDeleteResponse instead of *pagination.SinglePage[StoreSecretBulkDeleteResponse]
