Class Compose

Hierarchy

Compose

Index

Constructors

Properties

Methods

api attachmentDelete attachmentDeleteEndpoint attachmentList attachmentListEndpoint attachmentOriginal attachmentOriginalEndpoint attachmentPreview attachmentPreviewEndpoint attachmentRead attachmentReadEndpoint automationBundle automationBundleEndpoint automationList automationListEndpoint automationTriggerScript automationTriggerScriptEndpoint chartCreate chartCreateEndpoint chartDelete chartDeleteEndpoint chartList chartListEndpoint chartListTranslations chartListTranslationsEndpoint chartRead chartReadEndpoint chartUpdate chartUpdateEndpoint chartUpdateTranslations chartUpdateTranslationsEndpoint dataPrivacyModuleList dataPrivacyModuleListEndpoint dataPrivacyRecordList dataPrivacyRecordListEndpoint moduleCreate moduleCreateEndpoint moduleDelete moduleDeleteEndpoint moduleList moduleListEndpoint moduleListTranslations moduleListTranslationsEndpoint moduleRead moduleReadEndpoint moduleTriggerScript moduleTriggerScriptEndpoint moduleUpdate moduleUpdateEndpoint moduleUpdateTranslations moduleUpdateTranslationsEndpoint namespaceClone namespaceCloneEndpoint namespaceCreate namespaceCreateEndpoint namespaceDelete namespaceDeleteEndpoint namespaceExport namespaceExportEndpoint namespaceImportInit namespaceImportInitEndpoint namespaceImportRun namespaceImportRunEndpoint namespaceList namespaceListEndpoint namespaceListTranslations namespaceListTranslationsEndpoint namespaceRead namespaceReadEndpoint namespaceTriggerScript namespaceTriggerScriptEndpoint namespaceUpdate namespaceUpdateEndpoint namespaceUpdateTranslations namespaceUpdateTranslationsEndpoint namespaceUpload namespaceUploadEndpoint notificationEmailSend notificationEmailSendEndpoint pageCreate pageCreateEndpoint pageDelete pageDeleteEndpoint pageList pageListEndpoint pageListTranslations pageListTranslationsEndpoint pageRead pageReadEndpoint pageReorder pageReorderEndpoint pageTree pageTreeEndpoint pageTriggerScript pageTriggerScriptEndpoint pageUpdate pageUpdateEndpoint pageUpdateTranslations pageUpdateTranslationsEndpoint pageUpload pageUploadEndpoint permissionsDelete permissionsDeleteEndpoint permissionsEffective permissionsEffectiveEndpoint permissionsList permissionsListEndpoint permissionsRead permissionsReadEndpoint permissionsTrace permissionsTraceEndpoint permissionsUpdate permissionsUpdateEndpoint recordBulkDelete recordBulkDeleteEndpoint recordCreate recordCreateEndpoint recordDelete recordDeleteEndpoint recordExec recordExecEndpoint recordExport recordExportEndpoint recordImportInit recordImportInitEndpoint recordImportProgress recordImportProgressEndpoint recordImportRun recordImportRunEndpoint recordList recordListEndpoint recordRead recordReadEndpoint recordReport recordReportEndpoint recordRevisions recordRevisionsEndpoint recordTriggerScript recordTriggerScriptEndpoint recordTriggerScriptOnList recordTriggerScriptOnListEndpoint recordUpdate recordUpdateEndpoint recordUpload recordUploadEndpoint setAccessTokenFn setHeader setHeaders

Constructors

constructor

new Compose(__namedParameters: Ctor): Compose
Parameters
- __namedParameters: Ctor
Returns Compose
- Defined in compose.ts:44

Properties

`Protected` `Optional` accessTokenFn

accessTokenFn?: (() => undefined | string)

Type declaration

- (): undefined | string
- Returns undefined | string

`Protected` `Optional` baseURL

baseURL?: string

`Protected` headers

headers: Headers = {}

Methods

api

api(): AxiosInstance
Returns AxiosInstance
- Defined in compose.ts:80

attachmentDelete

attachmentDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2335

attachmentDeleteEndpoint

attachmentDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2367

attachmentList

attachmentList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2244

attachmentListEndpoint

attachmentListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2284

attachmentOriginal

attachmentOriginal(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2377

attachmentOriginalEndpoint

attachmentOriginalEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2415

attachmentPreview

attachmentPreview(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2426

attachmentPreviewEndpoint

attachmentPreviewEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2462

attachmentRead

attachmentRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2293

attachmentReadEndpoint

attachmentReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2325

automationBundle

automationBundle(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2654

automationBundleEndpoint

automationBundleEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2671

automationList

automationList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2623

automationListEndpoint

automationListEndpoint(): string
Returns string
- Defined in compose.ts:2649

automationTriggerScript

automationTriggerScript(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2681

automationTriggerScriptEndpoint

automationTriggerScriptEndpoint(): string
Returns string
- Defined in compose.ts:2701

chartCreate

chartCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1989

chartCreateEndpoint

chartCreateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2022

chartDelete

chartDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2109

chartDeleteEndpoint

chartDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2131

chartList

chartList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1947

chartListEndpoint

chartListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1981

chartListTranslations

chartListTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2140

chartListTranslationsEndpoint

chartListTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2162

chartRead

chartRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2030

chartReadEndpoint

chartReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2052

chartUpdate

chartUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2061

chartUpdateEndpoint

chartUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2100

chartUpdateTranslations

chartUpdateTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2171

chartUpdateTranslationsEndpoint

chartUpdateTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2199

dataPrivacyModuleList

dataPrivacyModuleList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1920

dataPrivacyModuleListEndpoint

dataPrivacyModuleListEndpoint(): string
Returns string
- Defined in compose.ts:1942

dataPrivacyRecordList

dataPrivacyRecordList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1897

dataPrivacyRecordListEndpoint

dataPrivacyRecordListEndpoint(): string
Returns string
- Defined in compose.ts:1915

moduleCreate

moduleCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:967

moduleCreateEndpoint

moduleCreateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1007

moduleDelete

moduleDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1101

moduleDeleteEndpoint

moduleDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1123

moduleList

moduleList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:923

moduleListEndpoint

moduleListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:959

moduleListTranslations

moduleListTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1171

moduleListTranslationsEndpoint

moduleListTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1193

moduleRead

moduleRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1015

moduleReadEndpoint

moduleReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1037

moduleTriggerScript

moduleTriggerScript(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1132

moduleTriggerScriptEndpoint

moduleTriggerScriptEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1162

moduleUpdate

moduleUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1046

moduleUpdateEndpoint

moduleUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1092

moduleUpdateTranslations

moduleUpdateTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1202

moduleUpdateTranslationsEndpoint

moduleUpdateTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1230

namespaceClone

namespaceClone(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:282

namespaceCloneEndpoint

namespaceCloneEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:308

namespaceCreate

namespaceCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:128

namespaceCreateEndpoint

namespaceCreateEndpoint(): string
Returns string
- Defined in compose.ts:157

namespaceDelete

namespaceDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:233

namespaceDeleteEndpoint

namespaceDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:251

namespaceExport

namespaceExport(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:316

namespaceExportEndpoint

namespaceExportEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:342

namespaceImportInit

namespaceImportInit(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:352

namespaceImportInitEndpoint

namespaceImportInitEndpoint(): string
Returns string
- Defined in compose.ts:370

namespaceImportRun

namespaceImportRun(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:375

namespaceImportRunEndpoint

namespaceImportRunEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:401

namespaceList

namespaceList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:95

namespaceListEndpoint

namespaceListEndpoint(): string
Returns string
- Defined in compose.ts:123

namespaceListTranslations

namespaceListTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:443

namespaceListTranslationsEndpoint

namespaceListTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:461

namespaceRead

namespaceRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:162

namespaceReadEndpoint

namespaceReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:180

namespaceTriggerScript

namespaceTriggerScript(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:409

namespaceTriggerScriptEndpoint

namespaceTriggerScriptEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:435

namespaceUpdate

namespaceUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:188

namespaceUpdateEndpoint

namespaceUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:225

namespaceUpdateTranslations

namespaceUpdateTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:469

namespaceUpdateTranslationsEndpoint

namespaceUpdateTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:493

namespaceUpload

namespaceUpload(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:259

namespaceUploadEndpoint

namespaceUploadEndpoint(): string
Returns string
- Defined in compose.ts:277

notificationEmailSend

notificationEmailSend(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2208

notificationEmailSendEndpoint

notificationEmailSendEndpoint(): string
Returns string
- Defined in compose.ts:2239

pageCreate

pageCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:545

pageCreateEndpoint

pageCreateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:587

pageDelete

pageDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:744

pageDeleteEndpoint

pageDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:770

pageList

pageList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:501

pageListEndpoint

pageListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:537

pageListTranslations

pageListTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:855

pageListTranslationsEndpoint

pageListTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:877

pageRead

pageRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:595

pageReadEndpoint

pageReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:617

pageReorder

pageReorder(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:707

pageReorderEndpoint

pageReorderEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:735

pageTree

pageTree(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:626

pageTreeEndpoint

pageTreeEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:644

pageTriggerScript

pageTriggerScript(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:816

pageTriggerScriptEndpoint

pageTriggerScriptEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:846

pageUpdate

pageUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:652

pageUpdateEndpoint

pageUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:698

pageUpdateTranslations

pageUpdateTranslations(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:886

pageUpdateTranslationsEndpoint

pageUpdateTranslationsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:914

pageUpload

pageUpload(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:779

pageUploadEndpoint

pageUploadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:807

permissionsDelete

permissionsDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2565

permissionsDeleteEndpoint

permissionsDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2583

permissionsEffective

permissionsEffective(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2489

permissionsEffectiveEndpoint

permissionsEffectiveEndpoint(): string
Returns string
- Defined in compose.ts:2505

permissionsList

permissionsList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2473

permissionsListEndpoint

permissionsListEndpoint(): string
Returns string
- Defined in compose.ts:2484

permissionsRead

permissionsRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2535

permissionsReadEndpoint

permissionsReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2557

permissionsTrace

permissionsTrace(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2510

permissionsTraceEndpoint

permissionsTraceEndpoint(): string
Returns string
- Defined in compose.ts:2530

permissionsUpdate

permissionsUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:2591

permissionsUpdateEndpoint

permissionsUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:2615

recordBulkDelete

recordBulkDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1659

recordBulkDeleteEndpoint

recordBulkDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1686

recordCreate

recordCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1538

recordCreateEndpoint

recordCreateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1569

recordDelete

recordDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1695

recordDeleteEndpoint

recordDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1721

recordExec

recordExec(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1499

recordExecEndpoint

recordExecEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1528

recordExport

recordExport(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1450

recordExportEndpoint

recordExportEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1488

recordImportInit

recordImportInit(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1330

recordImportInitEndpoint

recordImportInitEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1358

recordImportProgress

recordImportProgress(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1414

recordImportProgressEndpoint

recordImportProgressEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1440

recordImportRun

recordImportRun(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1367

recordImportRunEndpoint

recordImportRunEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1404

recordList

recordList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1281

recordListEndpoint

recordListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1321

recordRead

recordRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1578

recordReadEndpoint

recordReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1604

recordReport

recordReport(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1239

recordReportEndpoint

recordReportEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1272

recordRevisions

recordRevisions(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1861

recordRevisionsEndpoint

recordRevisionsEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1887

recordTriggerScript

recordTriggerScript(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1775

recordTriggerScriptEndpoint

recordTriggerScriptEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1812

recordTriggerScriptOnList

recordTriggerScriptOnList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1822

recordTriggerScriptOnListEndpoint

recordTriggerScriptOnListEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1852

recordUpdate

recordUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1614

recordUpdateEndpoint

recordUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1649

recordUpload

recordUpload(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in compose.ts:1731

recordUploadEndpoint

recordUploadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in compose.ts:1766

setAccessTokenFn

setAccessTokenFn(fn: (() => undefined | string)): Compose
Parameters
- fn: (() => undefined | string)
  - - (): undefined | string
    - Returns undefined | string
Returns Compose
- Defined in compose.ts:57

setHeader

setHeader(name: string, value: undefined | string): Compose
Parameters
- name: string
- value: undefined | string
Returns Compose
- Defined in compose.ts:70

setHeaders

setHeaders(headers?: Headers): Compose
Parameters
- Optional headers: Headers
Returns Compose
- Defined in compose.ts:62

Class Compose

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: Ctor

Returns Compose

Properties

Protected Optional accessTokenFn

Type declaration

Returns undefined | string

Protected Optional baseURL

Protected headers

Methods

api

Returns AxiosInstance

attachmentDelete

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

attachmentDeleteEndpoint

Parameters

a: KV

Returns string

attachmentList

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

attachmentListEndpoint

Parameters

a: KV

Returns string

attachmentOriginal

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

attachmentOriginalEndpoint

Parameters

a: KV

Returns string

attachmentPreview

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

attachmentPreviewEndpoint

Parameters

a: KV

Returns string

attachmentRead

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

attachmentReadEndpoint

Parameters

a: KV

Returns string

automationBundle

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

automationBundleEndpoint

Parameters

a: KV

Returns string

automationList

Parameters

a: KV

extra: AxiosRequestConfig<any> = {}

Returns Promise<KV>

automationListEndpoint

`Protected` `Optional` accessTokenFn

`Protected` `Optional` baseURL

`Protected` headers