Skip to content

v7.0.0

Choose a tag to compare

@workos-sdk-automation workos-sdk-automation released this 26 May 19:28
· 39 commits to main since this release
b316e2a

Miscellaneous Chores

  • deps: update googleapis/release-please-action action to v5 (#389) (f973f21)

  • deps: update shivammathur/setup-php action to v2.37.0 (#388) (f9e113f)

  • use shared workos/renovate-config preset (99aad6c)

  • #392 feat(generated)!: regenerate from spec (10 changes)

    ⚠️ Breaking

    • user_management: Remove organization membership methods from UserManagement service
      • Removed listOrganizationMemberships, createOrganizationMembership, getOrganizationMembership, updateOrganizationMembership, deleteOrganizationMembership, deactivateOrganizationMembership, and reactivateOrganizationMembership methods
      • These methods have been moved to the new OrganizationMembershipService
      • Change to getAuthorizationUrl() parameter screenHint from UserManagementAuthenticationScreenHint to RadarStandaloneAssessRequestAction type
      • Removed UserManagementAuthenticationScreenHint enum
    • user_management: Remove UserManagementOrganizationMembershipGroups service
      • Removed $workos->userManagementOrganizationMembershipGroups() accessor
      • listOrganizationMembershipGroups() has been moved to the new OrganizationMembershipService
    • radar: Remove device fingerprint and bot score from RadarStandaloneAssessRequest
      • Removed deviceFingerprint parameter from Radar.createAttempt() method
      • Removed botScore parameter from Radar.createAttempt() method
      • Removed deviceFingerprint and botScore fields from RadarStandaloneAssessRequest model
      • Removed deprecated enum values from RadarStandaloneAssessRequestAction: Login, Signup, SignUp2, SignUp3, SignIn2, SignIn3
      • Changed enum values in RadarStandaloneAssessRequestAction: SignUp from 'sign up' to 'sign-up', SignIn from 'sign in' to 'sign-in'
      • Removed enum values from RadarStandaloneResponseControl: CredentialStuffing, IpSignUpRateLimit
    • radar: Rename Radar list enums
      • Renamed RadarAction to RadarListAction
      • Renamed RadarType to RadarListType
    • audit_logs: Rename audit log models for consistency
      • Renamed AuditLogActionJson to AuditLogAction
      • Renamed AuditLogExportJson to AuditLogExport
      • Renamed AuditLogExportJsonState to AuditLogExportState
      • Renamed AuditLogSchemaJson to AuditLogSchema
      • Renamed AuditLogSchemaJsonActor to AuditLogSchemaActorInput
      • Renamed AuditLogSchemaJsonTarget to AuditLogSchemaTargetInput
      • Renamed AuditLogsRetentionJson to AuditLogsRetention
      • createSchema() method parameter types changed: AuditLogSchemaActorAuditLogSchemaActorInput, AuditLogSchemaTargetAuditLogSchemaTargetInput
    • webhooks: Rename webhook endpoint models and update status field type
      • Renamed WebhookEndpointJson to WebhookEndpoint
      • Renamed WebhookEndpointJsonStatus to WebhookEndpointStatus
      • Changed UpdateWebhookEndpoint.status field type from WebhookEndpointJsonStatus to WebhookEndpointStatus
      • Updated webhook event enums: added PIPES_CONNECTED_ACCOUNT_CONNECTED, PIPES_CONNECTED_ACCOUNT_DISCONNECTED, PIPES_CONNECTED_ACCOUNT_REAUTHORIZATION_NEEDED events
    • authorization: Update Authorization API with new filters and remove search parameter
      • Added resourceId, resourceExternalId, resourceTypeSlug filter parameters to listRoleAssignments()
      • Added roleSlug filter parameter to listRoleAssignmentsForResourceByExternalId() and listRoleAssignmentsForResource()
      • Removed search parameter from listResources() method
    • vault: Replace hand-maintained WorkOS\Vault class with generated WorkOS\Service\Vault
      • The old WorkOS\Vault class (lib/Vault.php) with client-side encrypt/decrypt helpers has been removed
      • $workos->vault() now returns WorkOS\Service\Vault with a different API surface
      • New generated methods: createDataKey(), createDecrypt(), createRekey(), listKv(), createKv(), getName(), getKv(), updateKv(), deleteKv(), listKvMetadata(), listKvVersions()

    Features

    • organization_membership: Introduce OrganizationMembershipService with membership and group operations
      • New service OrganizationMembershipService with methods: listOrganizationMemberships(), createOrganizationMembership(), getOrganizationMembership(), updateOrganizationMembership(), deleteOrganizationMembership(), deactivateOrganizationMembership(), reactivateOrganizationMembership(), and listOrganizationMembershipGroups()
      • Accessible via $workos->organizationMembership()
      • Replaces functionality previously in UserManagement and UserManagementOrganizationMembershipGroups services
    • vault: Add new Vault service for encrypted key-value storage
      • New Vault service with methods: createDataKey(), createDecrypt(), createRekey(), listKv(), createKv(), getName(), getKv(), updateKv(), deleteKv(), listKvMetadata(), and listKvVersions()
      • Support for encrypted object storage and management with key rotation
      • New models: CreateDataKeyResponse, DecryptResponse, ObjectMetadata, ObjectModel, ObjectSummary, ObjectWithoutValue, ObjectVersion, VersionListResponse
      • New enum: VaultOrder for sort direction
      • Accessible via $workos->vault()
    • api_keys: Add expires_at field to API key models and creation methods
      • Added expires_at field to ApiKey, OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue models
      • Added expires_at field to ApiKeyCreatedData and ApiKeyRevokedData event data models
      • Added optional expiresAt parameter to createOrganizationApiKey() and createUserApiKey() methods
      • Support for setting API key expiration timestamps
    • applications: Update ApplicationCredentialsListItem and NewConnectApplicationSecret field types
      • Changed ApplicationCredentialsListItem.lastUsedAt field type from ?string to ?\DateTimeImmutable
      • Changed NewConnectApplicationSecret.lastUsedAt field type from ?string to ?\DateTimeImmutable
    • pipes: Add connected account event models and related types
      • New models for pipe events: PipeConnectedAccount, PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded
      • New enum: PipeConnectedAccountState with values connected and needs_reauthorization
      • Support for monitoring data integration connection status changes