@workos/openapi-spec 0.48.0 → 0.50.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 +52 -5
- package/dist/types.d.ts +43 -7
- package/package.json +1 -1
package/dist/open-api-spec.yaml
CHANGED
|
@@ -13867,6 +13867,20 @@ paths:
|
|
|
13867
13867
|
required:
|
|
13868
13868
|
- code
|
|
13869
13869
|
- message
|
|
13870
|
+
- type: object
|
|
13871
|
+
properties:
|
|
13872
|
+
code:
|
|
13873
|
+
type: string
|
|
13874
|
+
description: The error code identifying the type of error.
|
|
13875
|
+
example: email_domain_not_deliverable
|
|
13876
|
+
const: email_domain_not_deliverable
|
|
13877
|
+
message:
|
|
13878
|
+
type: string
|
|
13879
|
+
description: A human-readable description of the error.
|
|
13880
|
+
example: Request could not be processed.
|
|
13881
|
+
required:
|
|
13882
|
+
- code
|
|
13883
|
+
- message
|
|
13870
13884
|
'404':
|
|
13871
13885
|
description: Not Found
|
|
13872
13886
|
content:
|
|
@@ -14212,6 +14226,20 @@ paths:
|
|
|
14212
14226
|
required:
|
|
14213
14227
|
- code
|
|
14214
14228
|
- message
|
|
14229
|
+
- type: object
|
|
14230
|
+
properties:
|
|
14231
|
+
code:
|
|
14232
|
+
type: string
|
|
14233
|
+
description: The error code identifying the type of error.
|
|
14234
|
+
example: email_domain_not_deliverable
|
|
14235
|
+
const: email_domain_not_deliverable
|
|
14236
|
+
message:
|
|
14237
|
+
type: string
|
|
14238
|
+
description: A human-readable description of the error.
|
|
14239
|
+
example: Request could not be processed.
|
|
14240
|
+
required:
|
|
14241
|
+
- code
|
|
14242
|
+
- message
|
|
14215
14243
|
'404':
|
|
14216
14244
|
description: Not Found
|
|
14217
14245
|
content:
|
|
@@ -14552,6 +14580,20 @@ paths:
|
|
|
14552
14580
|
required:
|
|
14553
14581
|
- error
|
|
14554
14582
|
- error_description
|
|
14583
|
+
- type: object
|
|
14584
|
+
properties:
|
|
14585
|
+
code:
|
|
14586
|
+
type: string
|
|
14587
|
+
description: The error code identifying the type of error.
|
|
14588
|
+
example: email_domain_not_deliverable
|
|
14589
|
+
const: email_domain_not_deliverable
|
|
14590
|
+
message:
|
|
14591
|
+
type: string
|
|
14592
|
+
description: A human-readable description of the error.
|
|
14593
|
+
example: Request could not be processed.
|
|
14594
|
+
required:
|
|
14595
|
+
- code
|
|
14596
|
+
- message
|
|
14555
14597
|
'422':
|
|
14556
14598
|
description: Unprocessable Entity
|
|
14557
14599
|
content:
|
|
@@ -35646,6 +35688,7 @@ components:
|
|
|
35646
35688
|
enum:
|
|
35647
35689
|
- oauth
|
|
35648
35690
|
- api_key
|
|
35691
|
+
- client_credentials
|
|
35649
35692
|
description: >-
|
|
35650
35693
|
How accounts authenticate with the provider for this Data
|
|
35651
35694
|
Integration.
|
|
@@ -36160,9 +36203,10 @@ components:
|
|
|
36160
36203
|
enum:
|
|
36161
36204
|
- oauth
|
|
36162
36205
|
- api_key
|
|
36206
|
+
- client_credentials
|
|
36163
36207
|
description: >-
|
|
36164
|
-
The authentication method used for this connection (`oauth
|
|
36165
|
-
`api_key`). Defaults to `oauth` if absent.
|
|
36208
|
+
The authentication method used for this connection (`oauth`,
|
|
36209
|
+
`api_key`, or `client_credentials`). Defaults to `oauth` if absent.
|
|
36166
36210
|
example: oauth
|
|
36167
36211
|
api_key_last_4:
|
|
36168
36212
|
type:
|
|
@@ -36270,10 +36314,11 @@ components:
|
|
|
36270
36314
|
enum:
|
|
36271
36315
|
- oauth
|
|
36272
36316
|
- api_key
|
|
36317
|
+
- client_credentials
|
|
36273
36318
|
description: >-
|
|
36274
36319
|
The authentication methods supported by this provider
|
|
36275
|
-
(`oauth`, `api_key`, or
|
|
36276
|
-
absent.
|
|
36320
|
+
(`oauth`, `api_key`, `client_credentials`, or a combination).
|
|
36321
|
+
Defaults to `["oauth"]` if absent.
|
|
36277
36322
|
example:
|
|
36278
36323
|
- oauth
|
|
36279
36324
|
ownership:
|
|
@@ -36352,9 +36397,11 @@ components:
|
|
|
36352
36397
|
enum:
|
|
36353
36398
|
- oauth
|
|
36354
36399
|
- api_key
|
|
36400
|
+
- client_credentials
|
|
36355
36401
|
description: >-
|
|
36356
36402
|
The authentication method used for this connection
|
|
36357
|
-
(`oauth` or `
|
|
36403
|
+
(`oauth`, `api_key`, or `client_credentials`).
|
|
36404
|
+
Defaults to `oauth` if absent.
|
|
36358
36405
|
example: oauth
|
|
36359
36406
|
api_key_last_4:
|
|
36360
36407
|
type:
|
package/dist/types.d.ts
CHANGED
|
@@ -15311,7 +15311,7 @@ export interface components {
|
|
|
15311
15311
|
* "oauth"
|
|
15312
15312
|
* ]
|
|
15313
15313
|
*/
|
|
15314
|
-
auth_methods: ("oauth" | "api_key")[];
|
|
15314
|
+
auth_methods: ("oauth" | "api_key" | "client_credentials")[];
|
|
15315
15315
|
/** @description The credentials configured for the Data Integration. */
|
|
15316
15316
|
credentials: {
|
|
15317
15317
|
/**
|
|
@@ -15646,11 +15646,11 @@ export interface components {
|
|
|
15646
15646
|
*/
|
|
15647
15647
|
scopes: string[];
|
|
15648
15648
|
/**
|
|
15649
|
-
* @description The authentication method used for this connection (`oauth` or `
|
|
15649
|
+
* @description The authentication method used for this connection (`oauth`, `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
|
|
15650
15650
|
* @example oauth
|
|
15651
15651
|
* @enum {string}
|
|
15652
15652
|
*/
|
|
15653
|
-
auth_method?: "oauth" | "api_key";
|
|
15653
|
+
auth_method?: "oauth" | "api_key" | "client_credentials";
|
|
15654
15654
|
/**
|
|
15655
15655
|
* @description The last four characters of the API key, or `null` for OAuth connections.
|
|
15656
15656
|
* @example null
|
|
@@ -15728,12 +15728,12 @@ export interface components {
|
|
|
15728
15728
|
*/
|
|
15729
15729
|
scopes: string[] | null;
|
|
15730
15730
|
/**
|
|
15731
|
-
* @description The authentication methods supported by this provider (`oauth`, `api_key`, or
|
|
15731
|
+
* @description The authentication methods supported by this provider (`oauth`, `api_key`, `client_credentials`, or a combination). Defaults to `["oauth"]` if absent.
|
|
15732
15732
|
* @example [
|
|
15733
15733
|
* "oauth"
|
|
15734
15734
|
* ]
|
|
15735
15735
|
*/
|
|
15736
|
-
auth_methods?: ("oauth" | "api_key")[];
|
|
15736
|
+
auth_methods?: ("oauth" | "api_key" | "client_credentials")[];
|
|
15737
15737
|
/**
|
|
15738
15738
|
* @description Whether the provider is owned by a user or organization.
|
|
15739
15739
|
* @enum {string}
|
|
@@ -15800,11 +15800,11 @@ export interface components {
|
|
|
15800
15800
|
*/
|
|
15801
15801
|
scopes: string[];
|
|
15802
15802
|
/**
|
|
15803
|
-
* @description The authentication method used for this connection (`oauth` or `
|
|
15803
|
+
* @description The authentication method used for this connection (`oauth`, `api_key`, or `client_credentials`). Defaults to `oauth` if absent.
|
|
15804
15804
|
* @example oauth
|
|
15805
15805
|
* @enum {string}
|
|
15806
15806
|
*/
|
|
15807
|
-
auth_method?: "oauth" | "api_key";
|
|
15807
|
+
auth_method?: "oauth" | "api_key" | "client_credentials";
|
|
15808
15808
|
/**
|
|
15809
15809
|
* @description The last four characters of the API key, or `null` for OAuth connections.
|
|
15810
15810
|
* @example null
|
|
@@ -29127,6 +29127,18 @@ export interface operations {
|
|
|
29127
29127
|
* @example Request could not be processed.
|
|
29128
29128
|
*/
|
|
29129
29129
|
message: string;
|
|
29130
|
+
} | {
|
|
29131
|
+
/**
|
|
29132
|
+
* @description The error code identifying the type of error.
|
|
29133
|
+
* @example email_domain_not_deliverable
|
|
29134
|
+
* @constant
|
|
29135
|
+
*/
|
|
29136
|
+
code: "email_domain_not_deliverable";
|
|
29137
|
+
/**
|
|
29138
|
+
* @description A human-readable description of the error.
|
|
29139
|
+
* @example Request could not be processed.
|
|
29140
|
+
*/
|
|
29141
|
+
message: string;
|
|
29130
29142
|
};
|
|
29131
29143
|
};
|
|
29132
29144
|
};
|
|
@@ -29436,6 +29448,18 @@ export interface operations {
|
|
|
29436
29448
|
* @example Invite has already been accepted.
|
|
29437
29449
|
*/
|
|
29438
29450
|
message: string;
|
|
29451
|
+
} | {
|
|
29452
|
+
/**
|
|
29453
|
+
* @description The error code identifying the type of error.
|
|
29454
|
+
* @example email_domain_not_deliverable
|
|
29455
|
+
* @constant
|
|
29456
|
+
*/
|
|
29457
|
+
code: "email_domain_not_deliverable";
|
|
29458
|
+
/**
|
|
29459
|
+
* @description A human-readable description of the error.
|
|
29460
|
+
* @example Request could not be processed.
|
|
29461
|
+
*/
|
|
29462
|
+
message: string;
|
|
29439
29463
|
};
|
|
29440
29464
|
};
|
|
29441
29465
|
};
|
|
@@ -29753,6 +29777,18 @@ export interface operations {
|
|
|
29753
29777
|
* @example The request failed due to: sign_up_not_allowed.
|
|
29754
29778
|
*/
|
|
29755
29779
|
error_description: string;
|
|
29780
|
+
} | {
|
|
29781
|
+
/**
|
|
29782
|
+
* @description The error code identifying the type of error.
|
|
29783
|
+
* @example email_domain_not_deliverable
|
|
29784
|
+
* @constant
|
|
29785
|
+
*/
|
|
29786
|
+
code: "email_domain_not_deliverable";
|
|
29787
|
+
/**
|
|
29788
|
+
* @description A human-readable description of the error.
|
|
29789
|
+
* @example Request could not be processed.
|
|
29790
|
+
*/
|
|
29791
|
+
message: string;
|
|
29756
29792
|
};
|
|
29757
29793
|
};
|
|
29758
29794
|
};
|