@workos/openapi-spec 0.72.0 → 0.73.0

package/dist/open-api-spec.yaml

@@ -3506,7 +3506,7 @@ paths:
       summary: Check authorization
       tags:
         - authorization
-      x-mutually-exclusive-body-groups: &ref_3
+      x-mutually-exclusive-body-groups: &ref_4
         resource_target:
           optional: false
           variants:
@@ -4149,7 +4149,7 @@ paths:
       summary: Assign a role
       tags:
         - authorization
-      x-mutually-exclusive-body-groups: &ref_4
+      x-mutually-exclusive-body-groups: &ref_5
         resource_target:
           optional: false
           variants:
@@ -4220,7 +4220,7 @@ paths:
       summary: Remove a role assignment
       tags:
         - authorization
-      x-mutually-exclusive-body-groups: &ref_5
+      x-mutually-exclusive-body-groups: &ref_6
         resource_target:
           optional: false
           variants:
@@ -6643,7 +6643,7 @@ paths:
       summary: Create an authorization resource
       tags:
         - authorization
-      x-mutually-exclusive-body-groups: &ref_6
+      x-mutually-exclusive-body-groups: &ref_7
         parent_resource:
           optional: true
           variants:
@@ -8782,7 +8782,7 @@ paths:
       tags:
         - connections
       x-feature-flag: connections-api-migrations-capabilities-api
-      x-mutually-exclusive-body-groups: &ref_7
+      x-mutually-exclusive-body-groups: &ref_8
         protocol_options:
           optional: false
           variants:
@@ -10010,7 +10010,7 @@ paths:
       tags:
         - connections
       x-feature-flag: connections-api-migrations-capabilities-api
-      x-mutually-exclusive-body-groups: &ref_10
+      x-mutually-exclusive-body-groups: &ref_11
         protocol_options:
           optional: true
           variants:
@@ -12964,6 +12964,14 @@ paths:
       summary: Set Retention
       tags:
         - audit-logs
+      x-mutually-exclusive-body-groups: &ref_3
+        retention:
+          optional: false
+          variants:
+            period:
+              - retention_period
+            period_in_days:
+              - retention_period_in_days
   /organizations/{organizationId}/api_keys:
     get:
       description: Get a list of all API keys for an organization.
@@ -18616,7 +18624,7 @@ paths:
       summary: Create an organization membership
       tags:
         - user-management.organization-membership
-      x-mutually-exclusive-body-groups: &ref_14
+      x-mutually-exclusive-body-groups: &ref_15
         role:
           optional: true
           variants:
@@ -18800,7 +18808,7 @@ paths:
       summary: Update an organization membership
       tags:
         - user-management.organization-membership
-      x-mutually-exclusive-body-groups: &ref_15
+      x-mutually-exclusive-body-groups: &ref_16
         role:
           optional: true
           variants:
@@ -20120,7 +20128,7 @@ paths:
       summary: Create a user
       tags:
         - user-management.users
-      x-mutually-exclusive-body-groups: &ref_16
+      x-mutually-exclusive-body-groups: &ref_17
         password:
           optional: true
           variants:
@@ -20413,7 +20421,7 @@ paths:
       summary: Update a user
       tags:
         - user-management.users
-      x-mutually-exclusive-body-groups: &ref_20
+      x-mutually-exclusive-body-groups: &ref_21
         password:
           optional: true
           variants:
@@ -24344,16 +24352,70 @@ components:
         - range_start
         - range_end
     UpdateAuditLogsRetentionDto:
-      type: object
-      properties:
-        retention_period_in_days:
-          type: integer
-          description: >-
-            The number of days Audit Log events will be retained. Valid values
-            are `30` and `365`.
-          example: 30
-      required:
-        - retention_period_in_days
+      x-mutually-exclusive-body-groups: *ref_3
+      oneOf:
+        - type: object
+          properties:
+            retention_period:
+              enum:
+                - 1_MONTH
+                - 2_MONTHS
+                - 3_MONTHS
+                - 4_MONTHS
+                - 5_MONTHS
+                - 6_MONTHS
+                - 7_MONTHS
+                - 8_MONTHS
+                - 9_MONTHS
+                - 10_MONTHS
+                - 11_MONTHS
+                - 1_YEAR
+                - 2_YEARS
+                - 3_YEARS
+                - 4_YEARS
+                - 5_YEARS
+                - 6_YEARS
+                - 7_YEARS
+                - 8_YEARS
+                - 9_YEARS
+                - 10_YEARS
+              type: string
+              description: >-
+                The period Audit Log events will be retained. Valid values are
+                `1_MONTH` through `11_MONTHS` in one-month increments and
+                `1_YEAR` through `10_YEARS` in one-year increments. Mutually
+                exclusive with `retention_period_in_days`.
+              example: 1_MONTH
+          required:
+            - retention_period
+          not:
+            anyOf:
+              - properties:
+                  retention_period_in_days:
+                    x-exclude-from-lint: true
+                required:
+                  - retention_period_in_days
+        - type: object
+          properties:
+            retention_period_in_days:
+              type: integer
+              description: >-
+                The number of days Audit Log events will be retained. Valid
+                values are `30` through `330` in 30-day increments and `365`
+                through `3650` in 365-day increments. Deprecated: use
+                `retention_period` instead. Mutually exclusive with
+                `retention_period`.
+              example: 30
+              deprecated: true
+          required:
+            - retention_period_in_days
+          not:
+            anyOf:
+              - properties:
+                  retention_period:
+                    x-exclude-from-lint: true
+                required:
+                  - retention_period
     AuditLogSchemaActorDto:
       type: object
       properties:
@@ -24473,7 +24535,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - resource_id
-      x-mutually-exclusive-body-groups: *ref_3
+      x-mutually-exclusive-body-groups: *ref_4
     CreateGroupRoleAssignmentDto:
       type: object
       properties:
@@ -24614,7 +24676,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - resource_id
-      x-mutually-exclusive-body-groups: *ref_4
+      x-mutually-exclusive-body-groups: *ref_5
     RemoveRoleDto:
       allOf:
         - type: object
@@ -24673,7 +24735,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - resource_id
-      x-mutually-exclusive-body-groups: *ref_5
+      x-mutually-exclusive-body-groups: *ref_6
     SetRolePermissionsDto:
       type: object
       properties:
@@ -25023,7 +25085,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - parent_resource_id
-      x-mutually-exclusive-body-groups: *ref_6
+      x-mutually-exclusive-body-groups: *ref_7
     CreateConnectionKeyPairDto:
       type: object
       properties:
@@ -25140,7 +25202,7 @@ components:
           default: true
         token_authentication_method:
           type: string
-          enum: &ref_8
+          enum: &ref_9
             - client_secret_post
             - client_secret_basic
             - private_key_jwt
@@ -25156,7 +25218,7 @@ components:
           $ref: '#/components/schemas/CreateConnectionKeyPairDto'
         id_token_signature_algorithm:
           type: string
-          enum: &ref_9
+          enum: &ref_10
             - ES256
             - ES384
             - ES512
@@ -25312,7 +25374,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - saml_options
-      x-mutually-exclusive-body-groups: *ref_7
+      x-mutually-exclusive-body-groups: *ref_8
     PatchConnectionSamlOptionsDto:
       type: object
       properties:
@@ -25388,7 +25450,7 @@ components:
           example: true
         token_authentication_method:
           type: string
-          enum: *ref_8
+          enum: *ref_9
           description: >-
             The token-endpoint client authentication method. Moving to
             `private_key_jwt` generates a signing key pair if the connection has
@@ -25398,7 +25460,7 @@ components:
           example: client_secret_basic
         id_token_signature_algorithm:
           type: string
-          enum: *ref_9
+          enum: *ref_10
           description: The ID-token signing algorithm.
           example: RS256
         fetch_user_info:
@@ -25542,7 +25604,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - saml_options
-      x-mutually-exclusive-body-groups: *ref_10
+      x-mutually-exclusive-body-groups: *ref_11
     CreateCorsOriginDto:
       type: object
       properties:
@@ -25724,11 +25786,11 @@ components:
           type:
             - object
             - 'null'
-          additionalProperties: &ref_11
+          additionalProperties: &ref_12
             type: string
             maxLength: 600
           maxProperties: 50
-          example: &ref_12
+          example: &ref_13
             tier: diamond
           description: >-
             Object containing [metadata](/authkit/metadata) key/value pairs
@@ -25783,9 +25845,9 @@ components:
           type:
             - object
             - 'null'
-          additionalProperties: *ref_11
+          additionalProperties: *ref_12
           maxProperties: 50
-          example: *ref_12
+          example: *ref_13
           description: >-
             Object containing [metadata](/authkit/metadata) key/value pairs
             associated with the Organization.
@@ -25919,7 +25981,7 @@ components:
           example: application/x-www-form-urlencoded
         authenticate_via:
           type: string
-          enum: &ref_13
+          enum: &ref_14
             - request_body
             - basic_auth_header
           description: >-
@@ -26075,7 +26137,7 @@ components:
           example: application/x-www-form-urlencoded
         authenticate_via:
           type: string
-          enum: *ref_13
+          enum: *ref_14
           description: >-
             How client credentials are sent when exchanging authorization codes
             and refreshing tokens.
@@ -26640,9 +26702,9 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - role_slug
-      x-mutually-exclusive-body-groups: *ref_14
-    UpdateUserlandUserOrganizationMembershipDto:
       x-mutually-exclusive-body-groups: *ref_15
+    UpdateUserlandUserOrganizationMembershipDto:
+      x-mutually-exclusive-body-groups: *ref_16
       oneOf:
         - type: object
           not:
@@ -26764,9 +26826,9 @@ components:
               type:
                 - object
                 - 'null'
-              additionalProperties: *ref_11
+              additionalProperties: *ref_12
               maxProperties: 50
-              example: &ref_17
+              example: &ref_18
                 timezone: America/New_York
               description: >-
                 Object containing metadata key/value pairs associated with the
@@ -26865,7 +26927,7 @@ components:
                   example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
                 password_hash_type:
                   type: string
-                  enum: &ref_18
+                  enum: &ref_19
                     - bcrypt
                     - firebase-scrypt
                     - ssha
@@ -26880,7 +26942,7 @@ components:
                   example: bcrypt
                 password_salt_position:
                   type: string
-                  enum: &ref_19
+                  enum: &ref_20
                     - prefix
                     - suffix
                   description: >-
@@ -26901,7 +26963,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - password
-      x-mutually-exclusive-body-groups: *ref_16
+      x-mutually-exclusive-body-groups: *ref_17
     UpdateUserlandUserDto:
       allOf:
         - type: object
@@ -26931,9 +26993,9 @@ components:
               type:
                 - object
                 - 'null'
-              additionalProperties: *ref_11
+              additionalProperties: *ref_12
               maxProperties: 50
-              example: *ref_17
+              example: *ref_18
               description: >-
                 Object containing metadata key/value pairs associated with the
                 user.
@@ -27015,7 +27077,7 @@ components:
                   example: $2a$10$N9qo8uLOickgx2ZMRZoMyeIjZAgcfl7p92ldGxad68LJZdL17lhWy
                 password_hash_type:
                   type: string
-                  enum: *ref_18
+                  enum: *ref_19
                   description: >-
                     The algorithm originally used to hash the password, used
                     when providing a `password_hash`. Required with
@@ -27023,7 +27085,7 @@ components:
                   example: bcrypt
                 password_salt_position:
                   type: string
-                  enum: *ref_19
+                  enum: *ref_20
                   description: >-
                     The position of the salt relative to the password when the
                     `password_hash` digest was computed: `prefix` for `hash(salt
@@ -27042,7 +27104,7 @@ components:
                         x-exclude-from-lint: true
                     required:
                       - password
-      x-mutually-exclusive-body-groups: *ref_20
+      x-mutually-exclusive-body-groups: *ref_21
     VerifyEmailAddressDto:
       type: object
       properties:
@@ -27149,7 +27211,7 @@ components:
           description: The events that the Webhook Endpoint is subscribed to.
           items:
             type: string
-            enum: &ref_21
+            enum: &ref_22
               - agent.blueprint.created
               - agent.blueprint.deleted
               - agent.blueprint.updated
@@ -27275,7 +27337,7 @@ components:
           description: The events that the Webhook Endpoint is subscribed to.
           items:
             type: string
-            enum: *ref_21
+            enum: *ref_22
           example:
             - user.created
             - dsync.user.created
@@ -30863,7 +30925,7 @@ components:
           description: >-
             An object containing the custom attribute mapping for the Directory
             Provider.
-          example: &ref_27
+          example: &ref_28
             department: Engineering
             job_title: Software Engineer
         role:
@@ -31057,7 +31119,7 @@ components:
               type: object
               additionalProperties: {}
               description: The event payload.
-              example: &ref_22
+              example: &ref_23
                 id: directory_user_01E1JG7J09H96KYP8HM9B0G5SJ
                 directory_id: directory_01ECAZ4NV9QMV47GW873HDCX74
                 organization_id: org_01EZTR6WYX1A0DSE2CYMGXQ24Y
@@ -31092,11 +31154,11 @@ components:
             - data
             - created_at
           description: An event emitted by WorkOS.
-          example: &ref_32
+          example: &ref_33
             object: event
             id: event_01EHZNVPK3SFK441A1RGBFSHRT
             event: dsync.user.created
-            data: *ref_22
+            data: *ref_23
             created_at: '2021-06-25T19:07:33.155Z'
             context: {}
         - oneOf:
@@ -31296,7 +31358,7 @@ components:
                       description: >-
                         Permission slugs forming the ceiling on what sessions
                         minted from this blueprint may do.
-                      example: &ref_23
+                      example: &ref_24
                         - crm:read
                         - email:send
                     invocable_by:
@@ -31309,7 +31371,7 @@ components:
                           description: >-
                             Role slugs whose members may mint user-delegated
                             sessions from this blueprint.
-                          example: &ref_24
+                          example: &ref_25
                             - manager
                         organization_ids:
                           type: array
@@ -31318,7 +31380,7 @@ components:
                           description: >-
                             Organizations in which autonomous sessions may be
                             minted from this blueprint.
-                          example: &ref_25
+                          example: &ref_26
                             - org_01EHWNCE74X7JSDV0X3SZ3KJNY
                       required:
                         - role_slugs
@@ -31477,7 +31539,7 @@ components:
                       description: >-
                         Permission slugs forming the ceiling on what sessions
                         minted from this blueprint may do.
-                      example: *ref_23
+                      example: *ref_24
                     invocable_by:
                       type: object
                       properties:
@@ -31488,7 +31550,7 @@ components:
                           description: >-
                             Role slugs whose members may mint user-delegated
                             sessions from this blueprint.
-                          example: *ref_24
+                          example: *ref_25
                         organization_ids:
                           type: array
                           items:
@@ -31496,7 +31558,7 @@ components:
                           description: >-
                             Organizations in which autonomous sessions may be
                             minted from this blueprint.
-                          example: *ref_25
+                          example: *ref_26
                       required:
                         - role_slugs
                         - organization_ids
@@ -32532,7 +32594,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted to the API key.
-                      example: &ref_26
+                      example: &ref_27
                         - users:read
                         - users:write
                     created_at:
@@ -32658,7 +32720,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted to the API key.
-                      example: *ref_26
+                      example: *ref_27
                     created_at:
                       type: string
                       description: The timestamp when the API key was created.
@@ -32782,7 +32844,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted to the API key.
-                      example: *ref_26
+                      example: *ref_27
                     created_at:
                       type: string
                       description: The timestamp when the API key was created.
@@ -35649,7 +35711,7 @@ components:
                       description: >-
                         An object containing the custom attribute mapping for
                         the Directory Provider.
-                      example: *ref_27
+                      example: *ref_28
                     role:
                       $ref: '#/components/schemas/SlimRole'
                     roles:
@@ -35839,7 +35901,7 @@ components:
                       description: >-
                         Labels assigned to the Feature Flag for categorizing and
                         filtering.
-                      example: &ref_28
+                      example: &ref_29
                         - reports
                     enabled:
                       type: boolean
@@ -36000,7 +36062,7 @@ components:
                       description: >-
                         Labels assigned to the Feature Flag for categorizing and
                         filtering.
-                      example: *ref_28
+                      example: *ref_29
                     enabled:
                       type: boolean
                       description: >-
@@ -36160,7 +36222,7 @@ components:
                       description: >-
                         Labels assigned to the Feature Flag for categorizing and
                         filtering.
-                      example: *ref_28
+                      example: *ref_29
                     enabled:
                       type: boolean
                       description: >-
@@ -36440,7 +36502,7 @@ components:
                       description: >-
                         Labels assigned to the Feature Flag for categorizing and
                         filtering.
-                      example: *ref_28
+                      example: *ref_29
                     enabled:
                       type: boolean
                       description: >-
@@ -37428,7 +37490,7 @@ components:
                       description: >-
                         Object containing [metadata](/authkit/metadata)
                         key/value pairs associated with the Organization.
-                      example: &ref_29
+                      example: &ref_30
                         tier: diamond
                       propertyNames:
                         maxLength: 40
@@ -37578,7 +37640,7 @@ components:
                       description: >-
                         Object containing [metadata](/authkit/metadata)
                         key/value pairs associated with the Organization.
-                      example: *ref_29
+                      example: *ref_30
                       propertyNames:
                         maxLength: 40
                       maxProperties: 50
@@ -38405,7 +38467,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: &ref_30
+                      example: &ref_31
                         - users:read
                         - users:write
                     created_at:
@@ -38489,7 +38551,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: *ref_30
+                      example: *ref_31
                     created_at:
                       format: date-time
                       type: string
@@ -38571,7 +38633,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: *ref_30
+                      example: *ref_31
                     created_at:
                       format: date-time
                       type: string
@@ -38708,7 +38770,7 @@ components:
                       description: >-
                         Object containing [metadata](/authkit/metadata)
                         key/value pairs associated with the Organization.
-                      example: *ref_29
+                      example: *ref_30
                       propertyNames:
                         maxLength: 40
                       maxProperties: 50
@@ -39579,7 +39641,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: &ref_31
+                      example: &ref_32
                         - users:read
                         - users:write
                     created_at:
@@ -39645,7 +39707,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: *ref_31
+                      example: *ref_32
                     created_at:
                       format: date-time
                       type: string
@@ -39709,7 +39771,7 @@ components:
                       items:
                         type: string
                       description: The permissions granted by the role.
-                      example: *ref_31
+                      example: *ref_32
                     created_at:
                       format: date-time
                       type: string
@@ -40849,7 +40911,7 @@ components:
                 - data
                 - created_at
                 - object
-      example: *ref_32
+      example: *ref_33
       description: An event emitted by WorkOS.
     EventList:
       type: object
@@ -40884,7 +40946,7 @@ components:
       example:
         object: list
         data:
-          - *ref_32
+          - *ref_33
         list_metadata:
           after: event_01EHZNVPK3SFK441A1RGBFSHRT
     JwtTemplate:

package/dist/types.d.ts

@@ -4218,7 +4218,15 @@ export interface components {
         };
         UpdateAuditLogsRetentionDto: {
             /**
-             * @description The number of days Audit Log events will be retained. Valid values are `30` and `365`.
+             * @description The period Audit Log events will be retained. Valid values are `1_MONTH` through `11_MONTHS` in one-month increments and `1_YEAR` through `10_YEARS` in one-year increments. Mutually exclusive with `retention_period_in_days`.
+             * @example 1_MONTH
+             * @enum {string}
+             */
+            retention_period: "1_MONTH" | "2_MONTHS" | "3_MONTHS" | "4_MONTHS" | "5_MONTHS" | "6_MONTHS" | "7_MONTHS" | "8_MONTHS" | "9_MONTHS" | "10_MONTHS" | "11_MONTHS" | "1_YEAR" | "2_YEARS" | "3_YEARS" | "4_YEARS" | "5_YEARS" | "6_YEARS" | "7_YEARS" | "8_YEARS" | "9_YEARS" | "10_YEARS";
+        } | {
+            /**
+             * @deprecated
+             * @description The number of days Audit Log events will be retained. Valid values are `30` through `330` in 30-day increments and `365` through `3650` in 365-day increments. Deprecated: use `retention_period` instead. Mutually exclusive with `retention_period`.
              * @example 30
              */
             retention_period_in_days: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.72.0",
+  "version": "0.73.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",
@@ -58,7 +58,7 @@
   "devDependencies": {
     "@types/node": "^26.4.0",
     "@workos/oagen": "^0.29.4",
-    "@workos/oagen-emitters": "^0.24.7",
+    "@workos/oagen-emitters": "^0.24.10",
     "diff2html": "^3.4.56",
     "husky": "^9.1.7",
     "js-yaml": "^5.4.1",