Class SettingsClient

Index

Constructors

Methods

getPublicAccountSetting getPublicAccountUserPreference getPublicWorkspaceSetting listAccountSettingsMetadata listAccountSettingsMetadataIter listAccountUserPreferencesMetadata listAccountUserPreferencesMetadataIter listWorkspaceSettingsMetadata listWorkspaceSettingsMetadataIter patchPublicAccountSetting patchPublicAccountUserPreference patchPublicWorkspaceSetting

Constructors

constructor

new SettingsClient(options: ClientOptions): SettingsClient
Parameters
- options: ClientOptions
Returns SettingsClient
- Defined in client.ts:64

Methods

getPublicAccountSetting

getPublicAccountSetting(
req: GetPublicAccountSettingRequest,
options?: CallOptions,
): Promise<Setting>
Get a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level.
Parameters
- req: GetPublicAccountSettingRequest
- Optionaloptions: CallOptions
Returns Promise<Setting>
- Defined in client.ts:80

getPublicAccountUserPreference

getPublicAccountUserPreference(
req: GetPublicAccountUserPreferenceRequest,
options?: CallOptions,
): Promise<UserPreference>
Get a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.
Parameters
- req: GetPublicAccountUserPreferenceRequest
- Optionaloptions: CallOptions
Returns Promise<UserPreference>
- Defined in client.ts:110

getPublicWorkspaceSetting

getPublicWorkspaceSetting(
req: GetPublicWorkspaceSettingRequest,
options?: CallOptions,
): Promise<Setting>
Get a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs.
Parameters
- req: GetPublicWorkspaceSettingRequest
- Optionaloptions: CallOptions
Returns Promise<Setting>
- Defined in client.ts:136

listAccountSettingsMetadata

listAccountSettingsMetadata(
req: ListAccountSettingsMetadataRequest,
options?: CallOptions,
): Promise<ListAccountSettingsMetadataResponse>
List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountsetting and PATCH :method:settingsv2/patchpublicaccountsetting APIs
Parameters
- req: ListAccountSettingsMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ListAccountSettingsMetadataResponse>
- Defined in client.ts:169

listAccountSettingsMetadataIter

listAccountSettingsMetadataIter(
req: ListAccountSettingsMetadataRequest,
options?: CallOptions,
): AsyncGenerator<SettingsMetadata>
Parameters
- req: ListAccountSettingsMetadataRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SettingsMetadata>
- Defined in client.ts:206

listAccountUserPreferencesMetadata

listAccountUserPreferencesMetadata(
req: ListAccountUserPreferencesMetadataRequest,
options?: CallOptions,
): Promise<ListAccountUserPreferencesMetadataResponse>
List valid user preferences and their metadata for a specific user. User preferences are personal settings that allow individual customization without affecting other users. These settings are available to be referenced via GET :method:settingsv2/getpublicaccountuserpreference and PATCH :method:settingsv2/patchpublicaccountuserpreference APIs
Parameters
- req: ListAccountUserPreferencesMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ListAccountUserPreferencesMetadataResponse>
- Defined in client.ts:230

listAccountUserPreferencesMetadataIter

listAccountUserPreferencesMetadataIter(
req: ListAccountUserPreferencesMetadataRequest,
options?: CallOptions,
): AsyncGenerator<SettingsMetadata>
Parameters
- req: ListAccountUserPreferencesMetadataRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SettingsMetadata>
- Defined in client.ts:267

listWorkspaceSettingsMetadata

listWorkspaceSettingsMetadata(
req: ListWorkspaceSettingsMetadataRequest,
options?: CallOptions,
): Promise<ListWorkspaceSettingsMetadataResponse>
List valid setting keys and metadata. These settings are available to be referenced via GET :method:settingsv2/getpublicworkspacesetting and PATCH :method:settingsv2/patchpublicworkspacesetting APIs
Parameters
- req: ListWorkspaceSettingsMetadataRequest
- Optionaloptions: CallOptions
Returns Promise<ListWorkspaceSettingsMetadataResponse>
- Defined in client.ts:292

listWorkspaceSettingsMetadataIter

listWorkspaceSettingsMetadataIter(
req: ListWorkspaceSettingsMetadataRequest,
options?: CallOptions,
): AsyncGenerator<SettingsMetadata>
Parameters
- req: ListWorkspaceSettingsMetadataRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<SettingsMetadata>
- Defined in client.ts:332

patchPublicAccountSetting

patchPublicAccountSetting(
req: PatchPublicAccountSettingRequest,
options?: CallOptions,
): Promise<Setting>
Patch a setting value at account level. See :method:settingsv2/listaccountsettingsmetadata for list of setting available via public APIs at account level. To determine the correct field to include in a patch request, refer to the type field of the setting returned in the :method:settingsv2/listaccountsettingsmetadata response.

Note: Page refresh is required for changes to take effect in UI.
Parameters
- req: PatchPublicAccountSettingRequest
- Optionaloptions: CallOptions
Returns Promise<Setting>
- Defined in client.ts:355

patchPublicAccountUserPreference

patchPublicAccountUserPreference(
req: PatchPublicAccountUserPreferenceRequest,
options?: CallOptions,
): Promise<UserPreference>
Update a user preference for a specific user. User preferences are personal settings that allow individual customization without affecting other users. See :method:settingsv2/listaccountuserpreferencesmetadata for list of user preferences available via public APIs.

Note: Page refresh is required for changes to take effect in UI.
Parameters
- req: PatchPublicAccountUserPreferenceRequest
- Optionaloptions: CallOptions
Returns Promise<UserPreference>
- Defined in client.ts:388

patchPublicWorkspaceSetting

patchPublicWorkspaceSetting(
req: PatchPublicWorkspaceSettingRequest,
options?: CallOptions,
): Promise<Setting>
Patch a setting value at workspace level. See :method:settingsv2/listworkspacesettingsmetadata for list of setting available via public APIs at workspace level. To determine the correct field to include in a patch request, refer to the type field of the setting returned in the :method:settingsv2/listworkspacesettingsmetadata response.

Note: Page refresh is required for changes to take effect in UI.
Parameters
- req: PatchPublicWorkspaceSettingRequest
- Optionaloptions: CallOptions
Returns Promise<Setting>
- Defined in client.ts:420

Class SettingsClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SettingsClient

Methods

getPublicAccountSetting

Parameters

Returns Promise<Setting>

getPublicAccountUserPreference

Parameters

Returns Promise<UserPreference>

getPublicWorkspaceSetting

Parameters

Returns Promise<Setting>

listAccountSettingsMetadata

Parameters

Returns Promise<ListAccountSettingsMetadataResponse>

listAccountSettingsMetadataIter

Parameters

Returns AsyncGenerator<SettingsMetadata>

listAccountUserPreferencesMetadata

Parameters

Returns Promise<ListAccountUserPreferencesMetadataResponse>

listAccountUserPreferencesMetadataIter

Parameters

Returns AsyncGenerator<SettingsMetadata>

listWorkspaceSettingsMetadata

Parameters

Returns Promise<ListWorkspaceSettingsMetadataResponse>

listWorkspaceSettingsMetadataIter

Parameters

Returns AsyncGenerator<SettingsMetadata>

patchPublicAccountSetting

Parameters

Returns Promise<Setting>

patchPublicAccountUserPreference

Parameters

Returns Promise<UserPreference>

patchPublicWorkspaceSetting

Parameters

Returns Promise<Setting>

Settings

On This Page