@fern-api/venus-api-sdk 11.5.0 → 11.6.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/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/organization/client/Client.d.ts +34 -1
- package/dist/cjs/api/resources/organization/client/Client.js +162 -1
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/getPostmanTeamDocs.js +66 -0
- package/dist/cjs/api/resources/organization/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/organization/client/index.js +3 -1
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.ts +9 -0
- package/dist/cjs/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.d.ts +11 -0
- package/dist/cjs/api/resources/organization/client/requests/SetDocsUrlRequest.js +3 -0
- package/dist/cjs/api/resources/organization/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/organization/client/setDocsUrl.d.ts +25 -0
- package/dist/cjs/api/resources/organization/client/setDocsUrl.js +66 -0
- package/dist/cjs/api/types/PostmanTeamDocsResponse.d.ts +6 -0
- package/dist/cjs/api/types/PostmanTeamDocsResponse.js +3 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/organization/client/requests/SetDocsUrlRequest.js +41 -0
- package/dist/cjs/serialization/resources/organization/client/requests/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/organization/client/requests/index.js +3 -1
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.d.ts +12 -0
- package/dist/cjs/serialization/types/PostmanTeamDocsResponse.js +44 -0
- package/dist/cjs/serialization/types/index.d.ts +1 -0
- package/dist/cjs/serialization/types/index.js +1 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/organization/client/Client.d.mts +34 -1
- package/dist/esm/api/resources/organization/client/Client.mjs +162 -1
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/getPostmanTeamDocs.mjs +30 -0
- package/dist/esm/api/resources/organization/client/index.d.mts +2 -0
- package/dist/esm/api/resources/organization/client/index.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.d.mts +9 -0
- package/dist/esm/api/resources/organization/client/requests/GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.d.mts +11 -0
- package/dist/esm/api/resources/organization/client/requests/SetDocsUrlRequest.mjs +2 -0
- package/dist/esm/api/resources/organization/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/organization/client/setDocsUrl.d.mts +25 -0
- package/dist/esm/api/resources/organization/client/setDocsUrl.mjs +30 -0
- package/dist/esm/api/types/PostmanTeamDocsResponse.d.mts +6 -0
- package/dist/esm/api/types/PostmanTeamDocsResponse.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/organization/client/requests/SetDocsUrlRequest.mjs +5 -0
- package/dist/esm/serialization/resources/organization/client/requests/index.d.mts +1 -0
- package/dist/esm/serialization/resources/organization/client/requests/index.mjs +1 -0
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.d.mts +12 -0
- package/dist/esm/serialization/types/PostmanTeamDocsResponse.mjs +8 -0
- package/dist/esm/serialization/types/index.d.mts +1 -0
- package/dist/esm/serialization/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +138 -1
package/reference.md
CHANGED
|
@@ -1042,6 +1042,74 @@ await client.organization.getOrgIdsByPostmanTeamId({
|
|
|
1042
1042
|
</dl>
|
|
1043
1043
|
|
|
1044
1044
|
|
|
1045
|
+
</dd>
|
|
1046
|
+
</dl>
|
|
1047
|
+
</details>
|
|
1048
|
+
|
|
1049
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">getPostmanTeamDocs</a>({ ...params }) -> core.APIResponse<FernVenusApi.PostmanTeamDocsResponse, FernVenusApi.organization.getPostmanTeamDocs.Error></code></summary>
|
|
1050
|
+
<dl>
|
|
1051
|
+
<dd>
|
|
1052
|
+
|
|
1053
|
+
#### 📝 Description
|
|
1054
|
+
|
|
1055
|
+
<dl>
|
|
1056
|
+
<dd>
|
|
1057
|
+
|
|
1058
|
+
<dl>
|
|
1059
|
+
<dd>
|
|
1060
|
+
|
|
1061
|
+
The claimable organization linked to a Postman team, with its claim
|
|
1062
|
+
status and the address of its docs site. Only Postman's integration
|
|
1063
|
+
service token can call it. 404 when the team has no claimable
|
|
1064
|
+
organization, or its docs address isn't set.
|
|
1065
|
+
</dd>
|
|
1066
|
+
</dl>
|
|
1067
|
+
</dd>
|
|
1068
|
+
</dl>
|
|
1069
|
+
|
|
1070
|
+
#### 🔌 Usage
|
|
1071
|
+
|
|
1072
|
+
<dl>
|
|
1073
|
+
<dd>
|
|
1074
|
+
|
|
1075
|
+
<dl>
|
|
1076
|
+
<dd>
|
|
1077
|
+
|
|
1078
|
+
```typescript
|
|
1079
|
+
await client.organization.getPostmanTeamDocs({
|
|
1080
|
+
postmanTeamId: "postman_team_id"
|
|
1081
|
+
});
|
|
1082
|
+
|
|
1083
|
+
```
|
|
1084
|
+
</dd>
|
|
1085
|
+
</dl>
|
|
1086
|
+
</dd>
|
|
1087
|
+
</dl>
|
|
1088
|
+
|
|
1089
|
+
#### ⚙️ Parameters
|
|
1090
|
+
|
|
1091
|
+
<dl>
|
|
1092
|
+
<dd>
|
|
1093
|
+
|
|
1094
|
+
<dl>
|
|
1095
|
+
<dd>
|
|
1096
|
+
|
|
1097
|
+
**request:** `FernVenusApi.GetPostmanTeamDocsOrganizationsPostmanTeamPostmanTeamIdDocsGetRequest`
|
|
1098
|
+
|
|
1099
|
+
</dd>
|
|
1100
|
+
</dl>
|
|
1101
|
+
|
|
1102
|
+
<dl>
|
|
1103
|
+
<dd>
|
|
1104
|
+
|
|
1105
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1106
|
+
|
|
1107
|
+
</dd>
|
|
1108
|
+
</dl>
|
|
1109
|
+
</dd>
|
|
1110
|
+
</dl>
|
|
1111
|
+
|
|
1112
|
+
|
|
1045
1113
|
</dd>
|
|
1046
1114
|
</dl>
|
|
1047
1115
|
</details>
|
|
@@ -1191,7 +1259,8 @@ await client.organization.getClaimStatus({
|
|
|
1191
1259
|
<dd>
|
|
1192
1260
|
|
|
1193
1261
|
Issues a claim link for an unclaimed organization, bound to one Postman
|
|
1194
|
-
user and valid for 15 minutes. Only the provisioner token
|
|
1262
|
+
user and valid for 15 minutes. Only the provisioner token and Postman's
|
|
1263
|
+
integration service token can call it.
|
|
1195
1264
|
</dd>
|
|
1196
1265
|
</dl>
|
|
1197
1266
|
</dd>
|
|
@@ -1241,6 +1310,74 @@ await client.organization.createClaimToken({
|
|
|
1241
1310
|
</dl>
|
|
1242
1311
|
|
|
1243
1312
|
|
|
1313
|
+
</dd>
|
|
1314
|
+
</dl>
|
|
1315
|
+
</details>
|
|
1316
|
+
|
|
1317
|
+
<details><summary><code>client.organization.<a href="/src/api/resources/organization/client/Client.ts">setDocsUrl</a>({ ...params }) -> core.APIResponse<void, FernVenusApi.organization.setDocsUrl.Error></code></summary>
|
|
1318
|
+
<dl>
|
|
1319
|
+
<dd>
|
|
1320
|
+
|
|
1321
|
+
#### 📝 Description
|
|
1322
|
+
|
|
1323
|
+
<dl>
|
|
1324
|
+
<dd>
|
|
1325
|
+
|
|
1326
|
+
<dl>
|
|
1327
|
+
<dd>
|
|
1328
|
+
|
|
1329
|
+
Sets the address of an unclaimed organization's docs site, which the
|
|
1330
|
+
team docs lookup returns. Only the provisioner token can call it, and
|
|
1331
|
+
only until the organization is claimed.
|
|
1332
|
+
</dd>
|
|
1333
|
+
</dl>
|
|
1334
|
+
</dd>
|
|
1335
|
+
</dl>
|
|
1336
|
+
|
|
1337
|
+
#### 🔌 Usage
|
|
1338
|
+
|
|
1339
|
+
<dl>
|
|
1340
|
+
<dd>
|
|
1341
|
+
|
|
1342
|
+
<dl>
|
|
1343
|
+
<dd>
|
|
1344
|
+
|
|
1345
|
+
```typescript
|
|
1346
|
+
await client.organization.setDocsUrl({
|
|
1347
|
+
orgId: "org_id",
|
|
1348
|
+
docsUrl: "docsUrl"
|
|
1349
|
+
});
|
|
1350
|
+
|
|
1351
|
+
```
|
|
1352
|
+
</dd>
|
|
1353
|
+
</dl>
|
|
1354
|
+
</dd>
|
|
1355
|
+
</dl>
|
|
1356
|
+
|
|
1357
|
+
#### ⚙️ Parameters
|
|
1358
|
+
|
|
1359
|
+
<dl>
|
|
1360
|
+
<dd>
|
|
1361
|
+
|
|
1362
|
+
<dl>
|
|
1363
|
+
<dd>
|
|
1364
|
+
|
|
1365
|
+
**request:** `FernVenusApi.SetDocsUrlRequest`
|
|
1366
|
+
|
|
1367
|
+
</dd>
|
|
1368
|
+
</dl>
|
|
1369
|
+
|
|
1370
|
+
<dl>
|
|
1371
|
+
<dd>
|
|
1372
|
+
|
|
1373
|
+
**requestOptions:** `OrganizationClient.RequestOptions`
|
|
1374
|
+
|
|
1375
|
+
</dd>
|
|
1376
|
+
</dl>
|
|
1377
|
+
</dd>
|
|
1378
|
+
</dl>
|
|
1379
|
+
|
|
1380
|
+
|
|
1244
1381
|
</dd>
|
|
1245
1382
|
</dl>
|
|
1246
1383
|
</details>
|