Class FoldersApi

Index

Constructors

Methods

create createWithHttpInfo getAll getAllWithHttpInfo move moveList moveListWithHttpInfo moveWithHttpInfo remove removeWithHttpInfo rename renameWithHttpInfo

Constructors

constructor

new FoldersApi(configuration, requestFactory?, responseProcessor?): FoldersApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: FoldersApiRequestFactory
- OptionalresponseProcessor: FoldersApiResponseProcessor
Returns FoldersApi
- Defined in codegen/crm/lists/types/PromiseAPI.ts:31

Methods

create

create(listFolderCreateRequest, _options?): Promise<ListFolderCreateResponse>
Creates a folder with the given information. Creates a folder
Parameters
- listFolderCreateRequest: ListFolderCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<ListFolderCreateResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:66

createWithHttpInfo

createWithHttpInfo(listFolderCreateRequest, _options?): Promise<HttpInfo<ListFolderCreateResponse>>
Creates a folder with the given information. Creates a folder
Parameters
- listFolderCreateRequest: ListFolderCreateRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ListFolderCreateResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:44

getAll

getAll(folderId?, _options?): Promise<ListFolderFetchResponse>
Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder. Retrieves a folder.
Parameters
- OptionalfolderId: string
  The Id of the folder to retrieve.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ListFolderFetchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:110

getAllWithHttpInfo

getAllWithHttpInfo(folderId?, _options?): Promise<HttpInfo<ListFolderFetchResponse>>
Retrieves a folder and recursively includes all folders via the childNodes attribute. The child lists field will be empty in all child nodes. Only the folder retrieved will include the child lists in that folder. Retrieves a folder.
Parameters
- OptionalfolderId: string
  The Id of the folder to retrieve.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ListFolderFetchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:88

move

move(folderId, newParentFolderId, _options?): Promise<ListFolderFetchResponse>
This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. Moves a folder
Parameters
- folderId: string
  The ID of the folder to move
- newParentFolderId: string
  The ID for the target parent folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ListFolderFetchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:156

moveList

moveList(listMoveRequest, _options?): Promise<void>
Given a list and a folder, the list will be moved to that folder. Moves a list to a given folder
Parameters
- listMoveRequest: ListMoveRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:200

moveListWithHttpInfo

moveListWithHttpInfo(listMoveRequest, _options?): Promise<HttpInfo<void>>
Given a list and a folder, the list will be moved to that folder. Moves a list to a given folder
Parameters
- listMoveRequest: ListMoveRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:178

moveWithHttpInfo

moveWithHttpInfo(folderId, newParentFolderId, _options?): Promise<HttpInfo<ListFolderFetchResponse>>
This moves the folder from its current location to a new location. It updates the parent of this folder to the new Id given. Moves a folder
Parameters
- folderId: string
  The ID of the folder to move
- newParentFolderId: string
  The ID for the target parent folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ListFolderFetchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:133

remove

remove(folderId, _options?): Promise<void>
Deletes the folder with the given Id. Deletes a folder
Parameters
- folderId: string
  The ID of the folder to delete
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:244

removeWithHttpInfo

removeWithHttpInfo(folderId, _options?): Promise<HttpInfo<void>>
Deletes the folder with the given Id. Deletes a folder
Parameters
- folderId: string
  The ID of the folder to delete
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:222

rename

rename(folderId, newFolderName?, _options?): Promise<ListFolderFetchResponse>
Renames the given folderId with a new name. Rename a folder
Parameters
- folderId: string
  The ID of the folder to rename
- OptionalnewFolderName: string
  The new name of the folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<ListFolderFetchResponse>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:290

renameWithHttpInfo

renameWithHttpInfo(folderId, newFolderName?, _options?): Promise<HttpInfo<ListFolderFetchResponse>>
Renames the given folderId with a new name. Rename a folder
Parameters
- folderId: string
  The ID of the folder to rename
- OptionalnewFolderName: string
  The new name of the folder.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<ListFolderFetchResponse>>
- Defined in codegen/crm/lists/types/PromiseAPI.ts:267

Class FoldersApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FoldersApi

Methods

create

Parameters

Returns Promise<ListFolderCreateResponse>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFolderCreateResponse>>

getAll

Parameters

Returns Promise<ListFolderFetchResponse>

getAllWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFolderFetchResponse>>

move

Parameters

Returns Promise<ListFolderFetchResponse>

moveList

Parameters

Returns Promise<void>

moveListWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

moveWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFolderFetchResponse>>

remove

Parameters

Returns Promise<void>

removeWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

rename

Parameters

Returns Promise<ListFolderFetchResponse>

renameWithHttpInfo

Parameters

Returns Promise<HttpInfo<ListFolderFetchResponse>>

Settings

On This Page