Class ConfluenceClient

Hierarchy (View Summary)

BaseClient
- ConfluenceClient

Constructors

constructor

new ConfluenceClient(
    config: {
        apiPrefix?: string;
        authentication?:
            | { basic: { apiToken: string; email: string } }
            | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
            | { oauth2: { accessToken: string } };
        baseRequestConfig?: any;
        host: string;
        middlewares?: {
            onError?: (...args: [any, ...unknown[]]) => void;
            onResponse?: (...args: [any, ...unknown[]]) => void;
        };
        noCheckAtlassianToken?: boolean;
    },
): ConfluenceClient
Parameters
- config: {
      apiPrefix?: string;
      authentication?:
          | { basic: { apiToken: string; email: string } }
          | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
          | { oauth2: { accessToken: string } };
      baseRequestConfig?: any;
      host: string;
      middlewares?: {
          onError?: (...args: [any, ...unknown[]]) => void;
          onResponse?: (...args: [any, ...unknown[]]) => void;
      };
      noCheckAtlassianToken?: boolean;
  }
  - OptionalapiPrefix?: string
    Prefix for all API routes.
  - Optionalauthentication?:
        | { basic: { apiToken: string; email: string } }
        | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
        | { oauth2: { accessToken: string } }
  - OptionalbaseRequestConfig?: any
  - host: string
  - Optionalmiddlewares?: {
    onError?: (...args: [any, ...unknown[]]) => void;
    onResponse?: (...args: [any, ...unknown[]]) => void;
    }
    OptionalonError?: (...args: [any, ...unknown[]]) => void
    Error handler middleware
    
    OptionalonResponse?: (...args: [any, ...unknown[]]) => void
    Response handler middleware
  - OptionalnoCheckAtlassianToken?: boolean
    Adds 'X-Atlassian-Token': 'no-check' to each request header
Returns ConfluenceClient
Overrides BaseClient.constructor
- Defined in src/clients/confluenceClient.ts:38

Properties

analytics

analytics: Analytics = ...

audit

audit: Audit = ...

`Protected` `Readonly`config

config: {
    apiPrefix?: string;
    authentication?:
        | { basic: { apiToken: string; email: string } }
        | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
        | { oauth2: { accessToken: string } };
    baseRequestConfig?: any;
    host: string;
    middlewares?: {
        onError?: (...args: [any, ...unknown[]]) => void;
        onResponse?: (...args: [any, ...unknown[]]) => void;
    };
    noCheckAtlassianToken?: boolean;
}

Type declaration

OptionalapiPrefix?: string
Prefix for all API routes.
Optionalauthentication?:
    | { basic: { apiToken: string; email: string } }
    | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
    | { oauth2: { accessToken: string } }
OptionalbaseRequestConfig?: any
host: string
Optionalmiddlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}
- OptionalonError?: (...args: [any, ...unknown[]]) => void
  Error handler middleware
- OptionalonResponse?: (...args: [any, ...unknown[]]) => void
  Response handler middleware
OptionalnoCheckAtlassianToken?: boolean
Adds 'X-Atlassian-Token': 'no-check' to each request header

content

content: Api.Content = ...

contentAttachments

contentAttachments: ContentAttachments = ...

contentBody

contentBody: Api.ContentBody = ...

contentChildrenAndDescendants

contentChildrenAndDescendants: ContentChildrenAndDescendants = ...

contentComments

contentComments: ContentComments = ...

contentLabels

contentLabels: ContentLabels = ...

contentMacroBody

contentMacroBody: ContentMacroBody = ...

contentPermissions

contentPermissions: ContentPermissions = ...

contentProperties

contentProperties: ContentProperties = ...

contentRestrictions

contentRestrictions: ContentRestrictions = ...

contentStates

contentStates: ContentStates = ...

contentVersions

contentVersions: ContentVersions = ...

contentWatches

contentWatches: ContentWatches = ...

dynamicModules

dynamicModules: DynamicModules = ...

experimental

experimental: Experimental = ...

group

group: Api.Group = ...

inlineTasks

inlineTasks: InlineTasks = ...

labelInfo

labelInfo: LabelInfo = ...

longRunningTask

longRunningTask: LongRunningTask = ...

relation

relation: Api.Relation = ...

search

search: Search = ...

settings

settings: Settings = ...

space

space: Api.Space = ...

spacePermissions

spacePermissions: SpacePermissions = ...

spaceProperties

spaceProperties: SpaceProperties = ...

spaceSettings

spaceSettings: Api.SpaceSettings = ...

template

template: Template = ...

themes

themes: Themes = ...

users

users: Users = ...

Methods

`Protected`encode

encode(value: string): string
Parameters
- value: string
Returns string
Inherited from BaseClient.encode
- Defined in src/clients/baseClient.ts:63

`Protected`paramSerializer

paramSerializer(parameters: Record<string, any>): string
Parameters
- parameters: Record<string, any>
Returns string
Inherited from BaseClient.paramSerializer
- Defined in src/clients/baseClient.ts:35

`Protected`removeUndefinedProperties

removeUndefinedProperties(obj: Record<string, any>): Record<string, any>
Parameters
- obj: Record<string, any>
Returns Record<string, any>
Inherited from BaseClient.removeUndefinedProperties
- Defined in src/clients/baseClient.ts:73

sendRequest

sendRequest<T>(requestConfig: RequestConfig, callback: never): Promise<T>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: never
Returns Promise<T>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:99
sendRequest<T>(
requestConfig: RequestConfig,
callback: Callback<T>,
): Promise<void>
Type Parameters
- T
Parameters
- requestConfig: RequestConfig
- callback: Callback<T>
Returns Promise<void>
Inherited from BaseClient.sendRequest
- Defined in src/clients/baseClient.ts:100

Class ConfluenceClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalapiPrefix?: string

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalonError?: (...args: [any, ...unknown[]]) => void

OptionalonResponse?: (...args: [any, ...unknown[]]) => void

OptionalnoCheckAtlassianToken?: boolean

Returns ConfluenceClient

Properties

analytics

audit

Protected Readonlyconfig

Type declaration

OptionalapiPrefix?: string

Optionalauthentication?: | { basic: { apiToken: string; email: string } } | { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } } | { oauth2: { accessToken: string } }

OptionalbaseRequestConfig?: any

host: string

Optionalmiddlewares?: { onError?: (...args: [any, ...unknown[]]) => void; onResponse?: (...args: [any, ...unknown[]]) => void;}

OptionalonError?: (...args: [any, ...unknown[]]) => void

OptionalonResponse?: (...args: [any, ...unknown[]]) => void

OptionalnoCheckAtlassianToken?: boolean

content

contentAttachments

contentBody

contentChildrenAndDescendants

contentComments

contentLabels

contentMacroBody

contentPermissions

contentProperties

contentRestrictions

contentStates

contentVersions

contentWatches

dynamicModules

experimental

group

inlineTasks

labelInfo

longRunningTask

relation

search

settings

space

spacePermissions

spaceProperties

spaceSettings

template

themes

users

Methods

Protectedencode

Parameters

Returns string

ProtectedparamSerializer

Parameters

Returns string

ProtectedremoveUndefinedProperties

Parameters

Returns Record<string, any>

sendRequest

Type Parameters

Parameters

Returns Promise<T>

Type Parameters

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`apiPrefix?: string

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`onError?: (...args: [any, ...unknown[]]) => void

`Optional`onResponse?: (...args: [any, ...unknown[]]) => void

`Optional`noCheckAtlassianToken?: boolean

`Protected` `Readonly`config

`Optional`apiPrefix?: string

`Optional`authentication?:
| { basic: { apiToken: string; email: string } }
| { jwt: { expiryTimeSeconds?: number; issuer: string; secret: string } }
| { oauth2: { accessToken: string } }

`Optional`baseRequestConfig?: any

`Optional`middlewares?: {
onError?: (...args: [any, ...unknown[]]) => void;
onResponse?: (...args: [any, ...unknown[]]) => void;
}

`Optional`onError?: (...args: [any, ...unknown[]]) => void

`Optional`onResponse?: (...args: [any, ...unknown[]]) => void

`Optional`noCheckAtlassianToken?: boolean

`Protected`encode

`Protected`paramSerializer

`Protected`removeUndefinedProperties