@workos/openapi-spec 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/open-api-spec.yaml +99 -0
- package/dist/policy.mjs +15 -0
- package/dist/types.d.ts +80 -2
- package/package.json +3 -3
package/dist/open-api-spec.yaml
CHANGED
|
@@ -20097,6 +20097,7 @@ components:
|
|
|
20097
20097
|
- permission.deleted
|
|
20098
20098
|
- permission.updated
|
|
20099
20099
|
- pipes.connected_account.connected
|
|
20100
|
+
- pipes.connected_account.connection_failed
|
|
20100
20101
|
- pipes.connected_account.disconnected
|
|
20101
20102
|
- pipes.connected_account.reauthorization_needed
|
|
20102
20103
|
- session.created
|
|
@@ -30125,6 +30126,104 @@ components:
|
|
|
30125
30126
|
- data
|
|
30126
30127
|
- created_at
|
|
30127
30128
|
- object
|
|
30129
|
+
- type: object
|
|
30130
|
+
properties:
|
|
30131
|
+
id:
|
|
30132
|
+
type: string
|
|
30133
|
+
description: Unique identifier for the event.
|
|
30134
|
+
example: event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30135
|
+
event:
|
|
30136
|
+
type: string
|
|
30137
|
+
const: pipes.connected_account.connection_failed
|
|
30138
|
+
data:
|
|
30139
|
+
type: object
|
|
30140
|
+
properties:
|
|
30141
|
+
object:
|
|
30142
|
+
type: string
|
|
30143
|
+
description: The object type.
|
|
30144
|
+
example: connection_failed
|
|
30145
|
+
const: connection_failed
|
|
30146
|
+
data_integration_id:
|
|
30147
|
+
type: string
|
|
30148
|
+
description: The unique ID of the data integration.
|
|
30149
|
+
example: data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30150
|
+
provider_slug:
|
|
30151
|
+
type: string
|
|
30152
|
+
description: The provider slug for this connection attempt.
|
|
30153
|
+
example: github
|
|
30154
|
+
user_id:
|
|
30155
|
+
type:
|
|
30156
|
+
- string
|
|
30157
|
+
- 'null'
|
|
30158
|
+
description: The ID of the User the connection attempt belongs to.
|
|
30159
|
+
example: user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
30160
|
+
organization_id:
|
|
30161
|
+
type:
|
|
30162
|
+
- string
|
|
30163
|
+
- 'null'
|
|
30164
|
+
description: >-
|
|
30165
|
+
The ID of the Organization the connection attempt
|
|
30166
|
+
belongs to.
|
|
30167
|
+
example: org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
30168
|
+
error_code:
|
|
30169
|
+
type: string
|
|
30170
|
+
description: A machine-readable error code for the failure.
|
|
30171
|
+
example: authorization_code_exchange_error
|
|
30172
|
+
error_reason:
|
|
30173
|
+
type:
|
|
30174
|
+
- string
|
|
30175
|
+
- 'null'
|
|
30176
|
+
description: A human-readable explanation of the failure.
|
|
30177
|
+
example: The authorization code has expired.
|
|
30178
|
+
provider_error:
|
|
30179
|
+
type:
|
|
30180
|
+
- string
|
|
30181
|
+
- 'null'
|
|
30182
|
+
description: The raw error code returned by the OAuth provider.
|
|
30183
|
+
example: access_denied
|
|
30184
|
+
provider_error_description:
|
|
30185
|
+
type:
|
|
30186
|
+
- string
|
|
30187
|
+
- 'null'
|
|
30188
|
+
description: >-
|
|
30189
|
+
The raw error description returned by the OAuth
|
|
30190
|
+
provider.
|
|
30191
|
+
example: The user denied the authorization request.
|
|
30192
|
+
created_at:
|
|
30193
|
+
format: date-time
|
|
30194
|
+
type: string
|
|
30195
|
+
description: An ISO 8601 timestamp.
|
|
30196
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30197
|
+
required:
|
|
30198
|
+
- object
|
|
30199
|
+
- data_integration_id
|
|
30200
|
+
- provider_slug
|
|
30201
|
+
- user_id
|
|
30202
|
+
- organization_id
|
|
30203
|
+
- error_code
|
|
30204
|
+
- error_reason
|
|
30205
|
+
- provider_error
|
|
30206
|
+
- provider_error_description
|
|
30207
|
+
- created_at
|
|
30208
|
+
title: PipesConnectionFailed
|
|
30209
|
+
description: The event payload.
|
|
30210
|
+
created_at:
|
|
30211
|
+
format: date-time
|
|
30212
|
+
type: string
|
|
30213
|
+
description: An ISO 8601 timestamp.
|
|
30214
|
+
example: '2026-01-15T12:00:00.000Z'
|
|
30215
|
+
context:
|
|
30216
|
+
$ref: '#/components/schemas/EventContextDto'
|
|
30217
|
+
object:
|
|
30218
|
+
type: string
|
|
30219
|
+
description: Distinguishes the Event object.
|
|
30220
|
+
const: event
|
|
30221
|
+
required:
|
|
30222
|
+
- id
|
|
30223
|
+
- event
|
|
30224
|
+
- data
|
|
30225
|
+
- created_at
|
|
30226
|
+
- object
|
|
30128
30227
|
- type: object
|
|
30129
30228
|
properties:
|
|
30130
30229
|
id:
|
package/dist/policy.mjs
CHANGED
|
@@ -434,6 +434,21 @@ function transformSpec(spec) {
|
|
|
434
434
|
const listMetadata = groupRoleList?.properties?.list_metadata;
|
|
435
435
|
if (listMetadata && !listMetadata.$ref && listMetadata.properties) groupRoleList.properties.list_metadata = { $ref: "#/components/schemas/ListMetadata" };
|
|
436
436
|
}
|
|
437
|
+
if (schemas["OrganizationDomainStandAlone"] && !schemas["OrganizationDomain"]) {
|
|
438
|
+
schemas["OrganizationDomain"] = schemas["OrganizationDomainStandAlone"];
|
|
439
|
+
delete schemas["OrganizationDomainStandAlone"];
|
|
440
|
+
const oldRef = "#/components/schemas/OrganizationDomainStandAlone";
|
|
441
|
+
const newRef = "#/components/schemas/OrganizationDomain";
|
|
442
|
+
for (const pathItem of Object.values(paths)) for (const op of Object.values(pathItem)) {
|
|
443
|
+
const responses = op.responses;
|
|
444
|
+
for (const response of Object.values(responses ?? {})) {
|
|
445
|
+
const schema = response.content?.["application/json"]?.schema;
|
|
446
|
+
if (schema?.$ref === oldRef) schema.$ref = newRef;
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
const createJson = paths["/organization_domains"]?.post?.responses?.["201"]?.content?.["application/json"];
|
|
450
|
+
if (createJson && !createJson.schema?.$ref) createJson.schema = { $ref: newRef };
|
|
451
|
+
}
|
|
437
452
|
return spec;
|
|
438
453
|
}
|
|
439
454
|
//#endregion
|
package/dist/types.d.ts
CHANGED
|
@@ -4350,7 +4350,7 @@ export interface components {
|
|
|
4350
4350
|
* "dsync.user.created"
|
|
4351
4351
|
* ]
|
|
4352
4352
|
*/
|
|
4353
|
-
events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4353
|
+
events: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4354
4354
|
};
|
|
4355
4355
|
UpdateWebhookEndpointDto: {
|
|
4356
4356
|
/**
|
|
@@ -4371,7 +4371,7 @@ export interface components {
|
|
|
4371
4371
|
* "dsync.user.created"
|
|
4372
4372
|
* ]
|
|
4373
4373
|
*/
|
|
4374
|
-
events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4374
|
+
events?: ("authentication.email_verification_succeeded" | "authentication.magic_auth_failed" | "authentication.magic_auth_succeeded" | "authentication.mfa_succeeded" | "authentication.oauth_failed" | "authentication.oauth_succeeded" | "authentication.password_failed" | "authentication.password_succeeded" | "authentication.passkey_failed" | "authentication.passkey_succeeded" | "authentication.sso_failed" | "authentication.sso_started" | "authentication.sso_succeeded" | "authentication.sso_timed_out" | "authentication.radar_risk_detected" | "api_key.created" | "api_key.revoked" | "api_key.updated" | "connection.activated" | "connection.deactivated" | "connection.saml_certificate_renewal_required" | "connection.saml_certificate_renewed" | "connection.deleted" | "dsync.activated" | "dsync.deleted" | "dsync.group.created" | "dsync.group.deleted" | "dsync.group.updated" | "dsync.group.user_added" | "dsync.group.user_removed" | "dsync.user.created" | "dsync.user.deleted" | "dsync.user.updated" | "email_verification.created" | "group.created" | "group.deleted" | "group.member_added" | "group.member_removed" | "group.updated" | "flag.created" | "flag.deleted" | "flag.updated" | "flag.rule_updated" | "invitation.accepted" | "invitation.created" | "invitation.resent" | "invitation.revoked" | "magic_auth.created" | "organization.created" | "organization.deleted" | "organization.updated" | "organization_domain.created" | "organization_domain.deleted" | "organization_domain.updated" | "organization_domain.verified" | "organization_domain.verification_failed" | "password_reset.created" | "password_reset.succeeded" | "user.created" | "user.updated" | "user.deleted" | "organization_membership.created" | "organization_membership.deleted" | "organization_membership.updated" | "role.created" | "role.deleted" | "role.updated" | "organization_role.created" | "organization_role.deleted" | "organization_role.updated" | "permission.created" | "permission.deleted" | "permission.updated" | "pipes.connected_account.connected" | "pipes.connected_account.connection_failed" | "pipes.connected_account.disconnected" | "pipes.connected_account.reauthorization_needed" | "session.created" | "session.reauthenticated" | "session.revoked" | "waitlist_user.approved" | "waitlist_user.created" | "waitlist_user.denied")[];
|
|
4375
4375
|
};
|
|
4376
4376
|
WidgetSessionTokenDto: {
|
|
4377
4377
|
/**
|
|
@@ -12130,6 +12130,84 @@ export interface components {
|
|
|
12130
12130
|
* @constant
|
|
12131
12131
|
*/
|
|
12132
12132
|
object: "event";
|
|
12133
|
+
} | {
|
|
12134
|
+
/**
|
|
12135
|
+
* @description Unique identifier for the event.
|
|
12136
|
+
* @example event_01EHZNVPK3SFK441A1RGBFSHRT
|
|
12137
|
+
*/
|
|
12138
|
+
id: string;
|
|
12139
|
+
/** @constant */
|
|
12140
|
+
event: "pipes.connected_account.connection_failed";
|
|
12141
|
+
/**
|
|
12142
|
+
* PipesConnectionFailed
|
|
12143
|
+
* @description The event payload.
|
|
12144
|
+
*/
|
|
12145
|
+
data: {
|
|
12146
|
+
/**
|
|
12147
|
+
* @description The object type.
|
|
12148
|
+
* @example connection_failed
|
|
12149
|
+
* @constant
|
|
12150
|
+
*/
|
|
12151
|
+
object: "connection_failed";
|
|
12152
|
+
/**
|
|
12153
|
+
* @description The unique ID of the data integration.
|
|
12154
|
+
* @example data_integration_01EHZNVPK3SFK441A1RGBFSHRT
|
|
12155
|
+
*/
|
|
12156
|
+
data_integration_id: string;
|
|
12157
|
+
/**
|
|
12158
|
+
* @description The provider slug for this connection attempt.
|
|
12159
|
+
* @example github
|
|
12160
|
+
*/
|
|
12161
|
+
provider_slug: string;
|
|
12162
|
+
/**
|
|
12163
|
+
* @description The ID of the User the connection attempt belongs to.
|
|
12164
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
12165
|
+
*/
|
|
12166
|
+
user_id: string | null;
|
|
12167
|
+
/**
|
|
12168
|
+
* @description The ID of the Organization the connection attempt belongs to.
|
|
12169
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
12170
|
+
*/
|
|
12171
|
+
organization_id: string | null;
|
|
12172
|
+
/**
|
|
12173
|
+
* @description A machine-readable error code for the failure.
|
|
12174
|
+
* @example authorization_code_exchange_error
|
|
12175
|
+
*/
|
|
12176
|
+
error_code: string;
|
|
12177
|
+
/**
|
|
12178
|
+
* @description A human-readable explanation of the failure.
|
|
12179
|
+
* @example The authorization code has expired.
|
|
12180
|
+
*/
|
|
12181
|
+
error_reason: string | null;
|
|
12182
|
+
/**
|
|
12183
|
+
* @description The raw error code returned by the OAuth provider.
|
|
12184
|
+
* @example access_denied
|
|
12185
|
+
*/
|
|
12186
|
+
provider_error: string | null;
|
|
12187
|
+
/**
|
|
12188
|
+
* @description The raw error description returned by the OAuth provider.
|
|
12189
|
+
* @example The user denied the authorization request.
|
|
12190
|
+
*/
|
|
12191
|
+
provider_error_description: string | null;
|
|
12192
|
+
/**
|
|
12193
|
+
* Format: date-time
|
|
12194
|
+
* @description An ISO 8601 timestamp.
|
|
12195
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12196
|
+
*/
|
|
12197
|
+
created_at: string;
|
|
12198
|
+
};
|
|
12199
|
+
/**
|
|
12200
|
+
* Format: date-time
|
|
12201
|
+
* @description An ISO 8601 timestamp.
|
|
12202
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
12203
|
+
*/
|
|
12204
|
+
created_at: string;
|
|
12205
|
+
context?: components["schemas"]["EventContextDto"];
|
|
12206
|
+
/**
|
|
12207
|
+
* @description Distinguishes the Event object.
|
|
12208
|
+
* @constant
|
|
12209
|
+
*/
|
|
12210
|
+
object: "event";
|
|
12133
12211
|
} | {
|
|
12134
12212
|
/**
|
|
12135
12213
|
* @description Unique identifier for the event.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workos/openapi-spec",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.15.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
|
|
6
6
|
"license": "MIT",
|
|
@@ -60,8 +60,8 @@
|
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
62
|
"@types/js-yaml": "^4.0.9",
|
|
63
|
-
"@types/node": "^26.0.
|
|
64
|
-
"@workos/oagen-emitters": "^0.19.
|
|
63
|
+
"@types/node": "^26.0.1",
|
|
64
|
+
"@workos/oagen-emitters": "^0.19.1",
|
|
65
65
|
"diff2html": "^3.4.56",
|
|
66
66
|
"husky": "^9.1.7",
|
|
67
67
|
"js-yaml": "^4.1.1",
|