Skip to content

feat(generated): Changes to events and pipes - #533

Merged
gjtorikian merged 4 commits into
mainfrom
oagen/batch-20b123c9
Aug 11, 2026
Merged

feat(generated): Changes to events and pipes#533
gjtorikian merged 4 commits into
mainfrom
oagen/batch-20b123c9

Conversation

@workos-sdk-automation

@workos-sdk-automation workos-sdk-automation Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

feat(events)!: Change required status for parameter Events.list.events

  • Changed required status for parameter Events.list.events.

feat(pipes)!: SDK surface change: Symbol "CreateDataIntegrationAuthMethods" was removed

  • SDK surface change: Symbol "CreateDataIntegrationAuthMethods" was removed.

Triggered by workos/openapi-spec@c4d55e1

BEGIN_COMMIT_OVERRIDE
feat(events): Change required status for parameter Events.list.events (#533)
feat(pipes): SDK surface change: Symbol "CreateDataIntegrationAuthMethods" was removed (#533)
END_COMMIT_OVERRIDE

…iKeys, AuditLogs, Authorization, ClientApi, Connect, DirectorySync, Events, FeatureFlags, Groups, MultiFactorAuth, OrganizationDomains, OrganizationMembership, Organizations, Pipes, PipesProvider, Radar, SSO, UserManagement, Vault, Webhooks, Widgets
@workos-sdk-automation workos-sdk-automation Bot added the autogenerated Autogenerated code or content label Aug 11, 2026
@workos-sdk-automation
workos-sdk-automation Bot requested review from a team as code owners August 11, 2026 17:12
@workos-sdk-automation workos-sdk-automation Bot added the autogenerated Autogenerated code or content label Aug 11, 2026
@greptile-apps

greptile-apps Bot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This generated update expands Events, Pipes, Groups, User Management, SSO provider enums, and webhook models from the latest API specification.

  • Makes the Events event-type filter required and adds organization-group search.
  • Adds Pipes client-credentials support and connected-account fields.
  • Adds password salt-position support, new OAuth provider enum values, and the agent-registration refresh webhook model.
  • Updates RBI declarations, generated manifests, changelog metadata, and tests.

Confidence Score: 4/5

The PR should not merge until the new refreshed webhook is registered for typed parsing; the RBI constructor mismatch is also worth correcting.

Subscribing to the newly introduced webhook currently yields raw Hash data despite the generated typed model, while Sorbet consumers also see an optional runtime constructor keyword as mandatory.

Files Needing Attention: lib/workos/types/create_webhook_endpoint_events.rb, lib/workos/webhook_event.rb, rbi/workos/user_management.rbi

Important Files Changed

Filename Overview
lib/workos/events.rb Makes the event filter required while preserving it across cursor pagination, matching the documented breaking change.
lib/workos/pipes.rb Adds the client-credentials upsert endpoint and updates integration authentication documentation consistently.
lib/workos/user_management.rb Adds optional password salt-position serialization to both user creation and update paths.
lib/workos/types/create_webhook_endpoint_events.rb Adds the refreshed event as subscribable without coordinating the hand-maintained typed webhook dispatch map.
lib/workos/webhook_event.rb Remains unchanged and therefore falls back to raw Hash data for the newly added refreshed event.
rbi/workos/user_management.rbi Adds the salt-position type but incorrectly exposes the runtime-optional constructor keyword as required.
lib/workos/groups.rb Adds the search filter consistently to the request, pagination closure, and retained filters.
Prompt To Fix All With AI
### Issue 1
lib/workos/types/create_webhook_endpoint_events.rb:13
**Refreshed webhook remains untyped**

When an endpoint receives the newly supported `agent.registration.refreshed` event, `WebhookEvent#coerce_data` finds no corresponding entry in `EVENT_DATA_MODELS` and returns a raw `Hash`, causing consumers of `WorkOS::AgentRegistrationRefreshedData` accessors to fail or skip typed handling.

### Issue 2
rbi/workos/user_management.rbi:31-38
**Optional keyword declared mandatory**

The runtime constructor defaults `password_salt_position` to `nil`, but this RBI requires the keyword, so Sorbet rejects existing valid two-keyword `PasswordHashed.new` calls after an upgrade.

```suggestion
      sig do
        params(
          password_hash: String,
          password_hash_type: String,
          password_salt_position: T.nilable(String)
        ).returns(WorkOS::UserManagement::PasswordHashed)
      end
      def self.new(password_hash:, password_hash_type:, password_salt_position: nil); end
```

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Reviews (1): Last reviewed commit: "chore(generated): add release notes frag..." | Re-trigger Greptile

AGENT_REGISTRATION_CLAIM_COMPLETED = "agent.registration.claim.completed"
AGENT_REGISTRATION_CREDENTIAL_ISSUED = "agent.registration.credential.issued"
AGENT_REGISTRATION_DELETED = "agent.registration.deleted"
AGENT_REGISTRATION_REFRESHED = "agent.registration.refreshed"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Refreshed webhook remains untyped

When an endpoint receives the newly supported agent.registration.refreshed event, WebhookEvent#coerce_data finds no corresponding entry in EVENT_DATA_MODELS and returns a raw Hash, causing consumers of WorkOS::AgentRegistrationRefreshedData accessors to fail or skip typed handling.

Knowledge Base Used: Webhooks and Pipes

Prompt To Fix With AI
This is a comment left during a code review.
Path: lib/workos/types/create_webhook_endpoint_events.rb
Line: 13

Comment:
**Refreshed webhook remains untyped**

When an endpoint receives the newly supported `agent.registration.refreshed` event, `WebhookEvent#coerce_data` finds no corresponding entry in `EVENT_DATA_MODELS` and returns a raw `Hash`, causing consumers of `WorkOS::AgentRegistrationRefreshedData` accessors to fail or skip typed handling.

**Knowledge Base Used:** [Webhooks and Pipes](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/workos-ruby/-/docs/webhooks-pipes.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Comment on lines 31 to +38
sig do
params(
password_hash: String,
password_hash_type: String
password_hash_type: String,
password_salt_position: T.nilable(String)
).returns(WorkOS::UserManagement::PasswordHashed)
end
def self.new(password_hash:, password_hash_type:); end
def self.new(password_hash:, password_hash_type:, password_salt_position:); end

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Optional keyword declared mandatory

The runtime constructor defaults password_salt_position to nil, but this RBI requires the keyword, so Sorbet rejects existing valid two-keyword PasswordHashed.new calls after an upgrade.

Suggested change
sig do
params(
password_hash: String,
password_hash_type: String
password_hash_type: String,
password_salt_position: T.nilable(String)
).returns(WorkOS::UserManagement::PasswordHashed)
end
def self.new(password_hash:, password_hash_type:); end
def self.new(password_hash:, password_hash_type:, password_salt_position:); end
sig do
params(
password_hash: String,
password_hash_type: String,
password_salt_position: T.nilable(String)
).returns(WorkOS::UserManagement::PasswordHashed)
end
def self.new(password_hash:, password_hash_type:, password_salt_position: nil); end

Knowledge Base Used: User Management, Authentication, and Sessions

Prompt To Fix With AI
This is a comment left during a code review.
Path: rbi/workos/user_management.rbi
Line: 31-38

Comment:
**Optional keyword declared mandatory**

The runtime constructor defaults `password_salt_position` to `nil`, but this RBI requires the keyword, so Sorbet rejects existing valid two-keyword `PasswordHashed.new` calls after an upgrade.

```suggestion
      sig do
        params(
          password_hash: String,
          password_hash_type: String,
          password_salt_position: T.nilable(String)
        ).returns(WorkOS::UserManagement::PasswordHashed)
      end
      def self.new(password_hash:, password_hash_type:, password_salt_position: nil); end
```

**Knowledge Base Used:** [User Management, Authentication, and Sessions](https://app.greptile.com/workos/-/custom-context/knowledge-base/workos/workos-ruby/-/docs/user-management.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@gjtorikian gjtorikian changed the title feat(generated)!: Changes to events and pipes feat(generated): Changes to events and pipes Aug 11, 2026
@gjtorikian
gjtorikian merged commit acf83ea into main Aug 11, 2026
10 checks passed
@gjtorikian
gjtorikian deleted the oagen/batch-20b123c9 branch August 11, 2026 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autogenerated Autogenerated code or content

Development

Successfully merging this pull request may close these issues.

1 participant