feat(generated)!: regenerate from spec (13 changes)#478
feat(generated)!: regenerate from spec (13 changes)#478workos-sdk-automation[bot] wants to merge 1 commit intomainfrom
Conversation
Greptile SummaryThis is a large auto-generated PR (94 files) that regenerates the WorkOS Ruby SDK from an updated OpenAPI spec across 13 feature areas.
Confidence Score: 4/5The change is safe to merge — all new endpoints are additive, breaking renames are intentional and consistent with the spec, and existing behaviour is preserved. The bulk of the change is mechanical spec-driven generation that is well-tested. Two non-blocking observations: lib/workos/user_management.rb (list_jwt_template naming) and lib/workos/api_keys/user_api_key_owner.rb (cross-directory alias) Important Files Changed
|
| def list_jwt_template(request_options: {}) | ||
| response = @client.request( | ||
| method: :get, | ||
| path: "/user_management/jwt_template", | ||
| auth: true, | ||
| request_options: request_options | ||
| ) | ||
| result = WorkOS::JWTTemplateResponse.new(response.body) | ||
| result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) | ||
| result | ||
| end |
There was a problem hiding this comment.
Misleading
list_ prefix for a singleton resource
list_jwt_template performs a GET on /user_management/jwt_template and returns a single JWTTemplateResponse, not a paginated collection. Every other list_* method in this SDK returns a WorkOS::Types::ListStruct. A caller following the naming convention would reasonably expect to iterate over results, but there are none to iterate — calling .data or .each on the returned object will fail. The companion write method is correctly named update_jwt_template, so a consistent read name would be get_jwt_template.
Summary
feat(authorization)!: Rename RoleAssignment to UserRoleAssignment
RoleAssignmentmodel toUserRoleAssignmentRoleAssignmentResourcetoUserRoleAssignmentResourceorganization_membership_idfield toUserRoleAssignmentlist_role_assignments()return type toUserRoleAssignmentassign_role()return type toUserRoleAssignmentfeat(authorization)!: Consolidate order enums to PaginationOrder
AuthorizationOrder,PermissionsOrderPaginationOrderenum for all list operationsPaginationOrderfeat(authorization): Add new role assignment listing endpoints
list_role_assignments_for_resource()methodlist_role_assignments_for_resource_by_external_id()methodUserRoleAssignmentobjects for a resourcefeat(api_keys)!: Separate organization and user API key types
OrganizationApiKeyclass to replace genericApiKeyusageOrganizationApiKeyWithValueto replaceApiKeyWithValueApiKeyWithValueOwnertoOrganizationApiKeyWithValueOwnerlist_organization_api_keys()return type toOrganizationApiKeycreate_organization_api_key()return type toOrganizationApiKeyWithValuefeat(user_management): Add user API key management
UserApiKeymodel to represent user-scoped API keysUserApiKeyWithValuemodel for creation responsesUserApiKeyOwnerand related owner modelslist_user_api_keys()method to list user API keys by user IDcreate_user_api_key()method to create new user API keysCreateUserApiKeyrequest modelfeat(user_management)!: Consolidate order enums to PaginationOrder
UserManagementUsersOrder,UserManagementInvitationsOrder,UserManagementOrganizationMembershipOrder,UserManagementOrganizationMembershipGroupsOrder,UserManagementUsersFeatureFlagsOrder,UserManagementUsersAuthorizedApplicationsOrder,UserManagementMultiFactorAuthenticationOrderPaginationOrderenum for all list operationsPaginationOrderfeat(user_management): Add user field to membership and organization membership
userfield toUserOrganizationMembership(embeddedUserobject)userfield toUserOrganizationMembershipBaseListData(embeddedUserobject)userfield toOrganizationMembership(embeddedUserobject)feat(user_management): Add get JWT template endpoint
list_jwt_template()method to retrieve current JWT template configurationfeat(directory_sync): Add name field to directory users
namefield toDirectoryUsermodelnamefield toDirectoryUserWithGroupsmodelnamefield toDsyncUserUpdatedDatamodelgroupsfield inDirectoryUserWithGroupsfeat(sso): Add name field to SSO profile
namefield toProfilemodel to provide full name when availablefeat(vault)!: Add BYOK key deleted event and consolidate key provider enum
VaultByokKeyDeletedevent model for vault.byok_key.deleted eventsVaultByokKeyDeletedDatamodel containing organization_id and key_providerVaultByokKeyVerificationCompletedDataKeyProvidertoVaultByokKeyProviderfeat(types)!: Consolidate pagination order enums
PaginationOrderenum with values: NORMAL, DESC, ASCPaginationOrdertypefeat(events): Add admin_portal source to event context actor
ADMIN_PORTAL = "admin_portal"value toEventContextActorSourceenumTriggered by workos/openapi-spec@a06e54d
BEGIN_COMMIT_OVERRIDE
feat(authorization)!: Rename RoleAssignment to UserRoleAssignment
feat(authorization)!: Consolidate order enums to PaginationOrder
feat(authorization): Add new role assignment listing endpoints
feat(api_keys)!: Separate organization and user API key types
feat(user_management): Add user API key management
feat(user_management)!: Consolidate order enums to PaginationOrder
feat(user_management): Add user field to membership and organization membership
feat(user_management): Add get JWT template endpoint
feat(directory_sync): Add name field to directory users
feat(sso): Add name field to SSO profile
feat(vault)!: Add BYOK key deleted event and consolidate key provider enum
feat(types)!: Consolidate pagination order enums
feat(events): Add admin_portal source to event context actor
END_COMMIT_OVERRIDE