@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
82 lines (58 loc) • 6.3 kB
Markdown
(*connectedFields.tabInfo*)
* [getConnectedFieldsTabGroups](
Returns all tabs associated with the given account.
**Note**: Unlike the Connected Fields UI, this endpoint returns only fields that are either mandatory or have the **IsRequiredForVerifyingType** <a href="https://concerto.accordproject.org/docs/design/specification/model-decorators/" target="_blank">decorator</a>
```typescript
import { IamClient } from "@docusign/iam-sdk";
const iamClient = new IamClient({
accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "",
});
async function run() {
const result = await iamClient.connectedFields.tabInfo.getConnectedFieldsTabGroups({
accountId: "<id>",
});
console.log(result);
}
run();
```
The standalone function version of this method:
```typescript
import { IamClientCore } from "@docusign/iam-sdk/core.js";
import { connectedFieldsTabInfoGetConnectedFieldsTabGroups } from "@docusign/iam-sdk/funcs/connectedFieldsTabInfoGetConnectedFieldsTabGroups.js";
// Use `IamClientCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const iamClient = new IamClientCore({
accessToken: process.env["DOCUSIGN_IAM_CLIENT_ACCESS_TOKEN"] ?? "",
});
async function run() {
const res = await connectedFieldsTabInfoGetConnectedFieldsTabGroups(iamClient, {
accountId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("connectedFieldsTabInfoGetConnectedFieldsTabGroups failed:", res.error);
}
}
run();
```
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.ConnectedFieldsApiGetTabGroupsRequest](../../models/operations/connectedfieldsapigettabgroupsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
**Promise\<[components.TabInfo[]](../../models/.md)\>**
| Error Type | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.APIError | 4XX, 5XX | \*/\* |