@workos/openapi-spec 0.45.0 → 0.47.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.
@@ -13122,20 +13122,35 @@ paths:
13122
13122
  content:
13123
13123
  application/json:
13124
13124
  schema:
13125
- type: object
13126
- properties:
13127
- code:
13128
- type: string
13129
- description: The error code identifying the type of error.
13130
- example: daily_quota_exceeded
13131
- const: daily_quota_exceeded
13132
- message:
13133
- type: string
13134
- description: A human-readable description of the error.
13135
- example: Request could not be processed.
13136
- required:
13137
- - code
13138
- - message
13125
+ oneOf:
13126
+ - type: object
13127
+ properties:
13128
+ code:
13129
+ type: string
13130
+ description: The error code identifying the type of error.
13131
+ example: daily_quota_exceeded
13132
+ const: daily_quota_exceeded
13133
+ message:
13134
+ type: string
13135
+ description: A human-readable description of the error.
13136
+ example: Request could not be processed.
13137
+ required:
13138
+ - code
13139
+ - message
13140
+ - type: object
13141
+ properties:
13142
+ error:
13143
+ type: string
13144
+ description: The OAuth error code.
13145
+ example: too_many_requests
13146
+ const: too_many_requests
13147
+ error_description:
13148
+ type: string
13149
+ description: A human-readable description of the error.
13150
+ example: 'The request failed due to: too_many_requests.'
13151
+ required:
13152
+ - error
13153
+ - error_description
13139
13154
  summary: Authenticate
13140
13155
  tags:
13141
13156
  - user-management.authentication
@@ -21093,6 +21108,16 @@ components:
21093
21108
  - api_key
21094
21109
  example:
21095
21110
  - oauth
21111
+ config:
21112
+ type: object
21113
+ description: >-
21114
+ Provider-specific config values (e.g. a Snowflake
21115
+ `account_identifier`), keyed by the config field. Only fields the
21116
+ built-in provider declares are accepted.
21117
+ additionalProperties:
21118
+ type: string
21119
+ example:
21120
+ account_identifier: acme-prod
21096
21121
  credentials:
21097
21122
  description: >-
21098
21123
  The OAuth credentials to configure for the Data Integration.
@@ -35707,6 +35732,16 @@ components:
35707
35732
  - organization_id
35708
35733
  - api_key_last_4
35709
35734
  - type: 'null'
35735
+ config:
35736
+ type: object
35737
+ additionalProperties:
35738
+ type: string
35739
+ description: >-
35740
+ Provider-specific config values set on the Data Integration (e.g. a
35741
+ Snowflake `account_identifier`), keyed by config field. Only fields
35742
+ the provider declares are accepted.
35743
+ example:
35744
+ account_identifier: acme-prod
35710
35745
  custom_provider:
35711
35746
  description: >-
35712
35747
  The OAuth definition when this is a custom provider; `null` for
@@ -35814,6 +35849,7 @@ components:
35814
35849
  - auth_methods
35815
35850
  - credentials
35816
35851
  - installation
35852
+ - config
35817
35853
  - custom_provider
35818
35854
  - created_at
35819
35855
  - updated_at
package/dist/types.d.ts CHANGED
@@ -4328,6 +4328,15 @@ export interface components {
4328
4328
  * ]
4329
4329
  */
4330
4330
  auth_methods?: ("oauth" | "api_key")[];
4331
+ /**
4332
+ * @description Provider-specific config values (e.g. a Snowflake `account_identifier`), keyed by the config field. Only fields the built-in provider declares are accepted.
4333
+ * @example {
4334
+ * "account_identifier": "acme-prod"
4335
+ * }
4336
+ */
4337
+ config?: {
4338
+ [key: string]: string;
4339
+ };
4331
4340
  /** @description The OAuth credentials to configure for the Data Integration. Required for OAuth integrations; omit when `auth_methods` is `["api_key"]`. */
4332
4341
  credentials?: components["schemas"]["DataIntegrationCredentialsDto"];
4333
4342
  /** @description An optional API key to install for the first tenant on an `api_key` integration. Omit to declare a keyless integration; tenants can be added later via the per-installation API key path. */
@@ -15353,6 +15362,15 @@ export interface components {
15353
15362
  */
15354
15363
  api_key_last_4: string | null;
15355
15364
  } | null;
15365
+ /**
15366
+ * @description Provider-specific config values set on the Data Integration (e.g. a Snowflake `account_identifier`), keyed by config field. Only fields the provider declares are accepted.
15367
+ * @example {
15368
+ * "account_identifier": "acme-prod"
15369
+ * }
15370
+ */
15371
+ config: {
15372
+ [key: string]: string;
15373
+ };
15356
15374
  /** @description The OAuth definition when this is a custom provider; `null` for built-in providers. */
15357
15375
  custom_provider: {
15358
15376
  /**
@@ -28614,6 +28632,18 @@ export interface operations {
28614
28632
  * @example Request could not be processed.
28615
28633
  */
28616
28634
  message: string;
28635
+ } | {
28636
+ /**
28637
+ * @description The OAuth error code.
28638
+ * @example too_many_requests
28639
+ * @constant
28640
+ */
28641
+ error: "too_many_requests";
28642
+ /**
28643
+ * @description A human-readable description of the error.
28644
+ * @example The request failed due to: too_many_requests.
28645
+ */
28646
+ error_description: string;
28617
28647
  };
28618
28648
  };
28619
28649
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workos/openapi-spec",
3
- "version": "0.45.0",
3
+ "version": "0.47.0",
4
4
  "type": "module",
5
5
  "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
6
6
  "license": "MIT",