Class BufferBaseAction`Abstract`

Base class for all Buffer social media actions. Uses Buffer's GraphQL API at https://api.buffer.com.

Migration note: replaces the deprecated v1 REST API at api.bufferapp.com/1. Key concept renames: profiles → channels, updates → posts.

Hierarchy (View Summary)

BaseSocialMediaAction
- BufferBaseAction

Constructors

constructor

new BufferBaseAction(): BufferBaseAction
Returns BufferBaseAction
Inherited from BaseSocialMediaAction.constructor

Properties

`Protected`_companyIntegration

_companyIntegration: MJCompanyIntegrationEntity

`Protected`_integration

_integration: MJIntegrationEntity

Accessors

`Protected`apiBaseUrl

get apiBaseUrl(): string
Get the API base URL for the platform

Returns string
Overrides BaseSocialMediaAction.apiBaseUrl
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:248

`Protected`bufferCommonParams

get bufferCommonParams(): ActionParam[]
Common params shared by all Buffer actions.

Returns ActionParam[]
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:253

`Protected`commonSocialParams

get commonSocialParams(): ActionParam[]
Common parameters for all social media actions

Returns ActionParam[]
Inherited from BaseSocialMediaAction.commonSocialParams
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:69

`Protected`oauthParams

get oauthParams(): ActionParam[]
OAuth-specific parameters that all OAuth actions should include

Returns ActionParam[]
Inherited from BaseSocialMediaAction.oauthParams
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:28

`Protected`platformName

get platformName(): string
Get the platform name (e.g., 'Twitter', 'LinkedIn')

Returns string
Overrides BaseSocialMediaAction.platformName
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:244

Methods

`Protected`buildErrorResult

buildErrorResult(
    error: unknown,
    verb: string,
    params: ActionParam[],
): ActionResultSimple
Build a standardized error result from a caught exception.
Parameters
- error: unknown
- verb: string
- params: ActionParam[]
Returns ActionResultSimple
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:382

`Protected`buildHeaders

buildHeaders(additionalHeaders?: Record<string, string>): Record<string, string>
Build common API headers including authentication
Parameters
- OptionaladditionalHeaders: Record<string, string>
Returns Record<string, string>
Inherited from BaseSocialMediaAction.buildHeaders
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:208

`Protected`createBufferPost

createBufferPost(
    input: {
        assets?: BufferAssetInput[];
        channelId: string;
        dueAt?: string;
        metadata?: Record<string, unknown>;
        mode?: BufferShareMode;
        schedulingType?: string;
        tagIds?: string[];
        text: string;
    },
): Promise<BufferPost>
Create a post via the createPost mutation.

metadata is Buffer's per-service extras channel, keyed by service name — e.g. { linkedin: { annotations: [...] } } for
Parameters
- input: {
      assets?: BufferAssetInput[];
      channelId: string;
      dueAt?: string;
      metadata?: Record<string, unknown>;
      mode?: BufferShareMode;
      schedulingType?: string;
      tagIds?: string[];
      text: string;
  }
Returns Promise<BufferPost>
Mention
annotations. It is passed through untouched rather than modelled, because its shape belongs to whichever network the channel points at and Buffer adds to it independently of this package.
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:553

`Protected`deleteBufferPost

deleteBufferPost(postId: string): Promise<boolean>
Delete a post via the deletePost mutation.
Parameters
- postId: string
Returns Promise<boolean>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:576

`Protected`ensureAuthenticated

ensureAuthenticated(params: RunActionParams): Promise<ActionResultSimple>
Validate CompanyIntegrationID and initialize OAuth.

Pass the full RunActionParams so the per-request provider on params.Provider is threaded into initializeOAuth (multi-tenant correctness — every entity load/save inside the OAuth flow binds to the request's connection, not the global default).

CompanyIntegrationID stays required even when CredentialID is given: it is what identifies which Buffer integration this is, and the org/channel context still comes from it. CredentialID only changes whose token the calls are made with.

Returns null on success, or an error result.
Parameters
- params: RunActionParams
Returns Promise<ActionResultSimple>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:284

`Protected`executeGraphQL

executeGraphQL<T>(
query: string,
variables?: Record<string, unknown>,
): Promise<T>
Execute a GraphQL query or mutation against the Buffer API.
Type Parameters
- T
Parameters
- query: string
- Optionalvariables: Record<string, unknown>
Returns Promise<T>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:408

`Protected`extractHashtags

extractHashtags(content: string): string[]
Parameters
- content: string
Returns string[]
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:746

`Protected`fetchChannels

fetchChannels(organizationId: string): Promise<BufferChannel[]>
Fetch all channels for an organization.
Parameters
- organizationId: string
Returns Promise<BufferChannel[]>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:488

`Protected`fetchPosts

fetchPosts(
    organizationId: string,
    filters?: {
        channelIds?: string[];
        endDate?: string;
        startDate?: string;
        status?: BufferPostStatus;
        tags?: string[];
    },
    first?: number,
    after?: string,
): Promise<BufferPostsConnection>
Fetch posts with optional filters and cursor-based pagination.
Parameters
- organizationId: string
- Optionalfilters: {
      channelIds?: string[];
      endDate?: string;
      startDate?: string;
      status?: BufferPostStatus;
      tags?: string[];
  }
- Optionalfirst: number
- Optionalafter: string
Returns Promise<BufferPostsConnection>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:500

`Protected`formatDate

formatDate(date: string | Date): string
Format date for API requests (ISO 8601)
Parameters
- date: string | Date
Returns string
Inherited from BaseSocialMediaAction.formatDate
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:225

`Protected`getAccessToken

getAccessToken(): string
The token every Buffer call is made with: the CredentialID token when one was supplied, otherwise the CompanyIntegration's own.

Returns string
Overrides BaseSocialMediaAction.getAccessToken
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:371

`Protected`getCustomAttribute

getCustomAttribute(attributeNumber: 1 | 2 | 3 | 4 | 5): string
Get custom attributes from company integration
Parameters
- attributeNumber: 1 | 2 | 3 | 4 | 5
Returns string
Inherited from BaseSocialMediaAction.getCustomAttribute
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:71

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value from params array
Parameters
- params: ActionParam[]
- paramName: string
Returns any
Inherited from BaseSocialMediaAction.getParamValue
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:266

`Protected`getProfileId

getProfileId(params: any): string
Get profile ID from parameters or default from integration
Parameters
- params: any
Returns string
Inherited from BaseSocialMediaAction.getProfileId
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:242

`Protected`getRefreshToken

getRefreshToken(): string
Get the refresh token

Returns string
Inherited from BaseSocialMediaAction.getRefreshToken
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:45

`Protected`groupPostsByDay

groupPostsByDay(
posts: SocialPost[],
dateField: "publishedAt" | "scheduledFor",
): Record<string, number>
Group posts by day using a date accessor.
Parameters
- posts: SocialPost[]
- dateField: "publishedAt" | "scheduledFor"
Returns Record<string, number>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:389

`Protected`handleOAuthError

handleOAuthError(error: any): ActionResultSimple
Handle OAuth-specific errors
Parameters
- error: any
Returns ActionResultSimple
Inherited from BaseSocialMediaAction.handleOAuthError
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:79

`Protected`handleRateLimit

handleRateLimit(retryAfter?: number): Promise<void>
Handle rate limiting with exponential backoff
Parameters
- OptionalretryAfter: number
Returns Promise<void>
Inherited from BaseSocialMediaAction.handleRateLimit
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:156

`Protected`initializeOAuth

initializeOAuth(
companyIntegrationId: string,
params?: RunActionParams,
): Promise<boolean>
Initialize OAuth connection by loading integration details.
Parameters
- companyIntegrationId: string
  the MJ Company Integration ID to load
- Optionalparams: RunActionParams
  the running action's params; params.Provider is captured so all subsequent entity loads/saves bind to the per-request provider (multi-tenant correctness). When omitted, falls back to the global default Metadata provider.
Returns Promise<boolean>
Inherited from BaseSocialMediaAction.initializeOAuth
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:37

`Protected` `Abstract`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseSocialMediaAction.InternalRunAction
- Defined in packages/Actions/Engine/dist/generic/BaseAction.d.ts:45

`Protected`isAuthError

isAuthError(error: any): boolean
Determine if an error is an authentication error. Can be overridden by subclasses for platform-specific error detection.
Parameters
- error: any
Returns boolean
Inherited from BaseSocialMediaAction.isAuthError
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:63

`Protected`isTokenExpired

isTokenExpired(): boolean
Check if the current token is expired

Returns boolean
Inherited from BaseSocialMediaAction.isTokenExpired
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:49

`Protected`logApiRequest

logApiRequest(method: string, url: string, data?: any): void
Log API request for debugging
Parameters
- method: string
- url: string
- Optionaldata: any
Returns void
Inherited from BaseSocialMediaAction.logApiRequest
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:249

`Protected`logApiResponse

logApiResponse(response: any): void
Log API response for debugging
Parameters
- response: any
Returns void
Inherited from BaseSocialMediaAction.logApiResponse
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:259

`Protected`makeAuthenticatedRequest

makeAuthenticatedRequest<T>(
requestFn: (token: string) => Promise<T>,
retryOnAuthFailure?: boolean,
): Promise<T>
Make an authenticated API request with automatic retry on auth failure
Type Parameters
- T
Parameters
- requestFn: (token: string) => Promise<T>
- OptionalretryOnAuthFailure: boolean
Returns Promise<T>
Inherited from BaseSocialMediaAction.makeAuthenticatedRequest
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:58

`Protected`mapBufferError

mapBufferError(error: unknown): string
Parameters
- error: unknown
Returns string
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:760

`Protected`normalizeAnalytics

normalizeAnalytics(bufferStats: Record<string, number>): SocialAnalytics
Normalize platform-specific analytics to common format
Parameters
- bufferStats: Record<string, number>
Returns SocialAnalytics
Overrides BaseSocialMediaAction.normalizeAnalytics
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:721

`Protected`normalizePost

normalizePost(bufferPost: BufferPost): SocialPost
Convert platform-specific post data to common format
Parameters
- bufferPost: BufferPost
Returns SocialPost
Overrides BaseSocialMediaAction.normalizePost
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:687

`Protected`parseDate

parseDate(dateString: string): Date
Parse date from API response
Parameters
- dateString: string
Returns Date
Inherited from BaseSocialMediaAction.parseDate
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:235

`Protected`parseRateLimitHeaders

parseRateLimitHeaders(
headers: any,
): { limit: number; remaining: number; reset: Date }
Parse rate limit headers from API response
Parameters
- headers: any
Returns { limit: number; remaining: number; reset: Date }
Inherited from BaseSocialMediaAction.parseRateLimitHeaders
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:176

`Protected`refreshAccessToken

refreshAccessToken(): Promise<void>
Refresh the access token using the refresh token. Must be implemented by platform-specific subclasses.

Returns Promise<void>
Overrides BaseSocialMediaAction.refreshAccessToken
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:590

`Protected`resolveCredentialAccessToken

resolveCredentialAccessToken(
credentialId: string,
params: RunActionParams,
): Promise<string | ActionResultSimple>
Load an access token out of an MJ: Credentials row.

This is the seam for acting as an identity other than the tenant's own Buffer connection — publishing to an employee's personal channel, reading the queue of the person who owns it. The token stays in the credential store; only its ID travels through action params.

A CredentialID that was supplied but cannot be read is fatal, never a silent fallback to the CompanyIntegration token: falling back would publish under the wrong identity, and the caller would have no way to notice.

Returns the token, or an error result to hand straight back to the caller.
Parameters
- credentialId: string
- params: RunActionParams
Returns Promise<string | ActionResultSimple>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:316

`Protected`resolveOrganizationId

resolveOrganizationId(params: ActionParam[]): Promise<string>
Resolve org ID from params or by fetching the account's first org.
Parameters
- params: ActionParam[]
Returns Promise<string>
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:471

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseSocialMediaAction.Run
- Defined in packages/Actions/Engine/dist/generic/BaseAction.d.ts:37

`Protected`searchPosts

searchPosts(
    params: {
        channelIds?: string[];
        endDate?: Date;
        hashtags?: string[];
        limit?: number;
        offset?: number;
        organizationId?: string;
        query?: string;
        startDate?: Date;
    },
): Promise<SocialPost[]>
Search for posts on the platform
Parameters
- params: {
      channelIds?: string[];
      endDate?: Date;
      hashtags?: string[];
      limit?: number;
      offset?: number;
      organizationId?: string;
      query?: string;
      startDate?: Date;
  }
Returns Promise<SocialPost[]>
Overrides BaseSocialMediaAction.searchPosts
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:608

`Protected`setCustomAttribute

setCustomAttribute(
attributeNumber: 1 | 2 | 3 | 4 | 5,
value: string,
): Promise<void>
Set custom attributes in company integration
Parameters
- attributeNumber: 1 | 2 | 3 | 4 | 5
- value: string
Returns Promise<void>
Inherited from BaseSocialMediaAction.setCustomAttribute
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:75

`Protected`setOutputParam

setOutputParam(params: ActionParam[], name: string, value: unknown): void
Set an output parameter value by name.
Parameters
- params: ActionParam[]
- name: string
- value: unknown
Returns void
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:376

`Protected`updateStoredTokens

updateStoredTokens(
    accessToken: string,
    refreshToken?: string,
    expiresIn?: number,
): Promise<void>
Update stored tokens after refresh
Parameters
- accessToken: string
- OptionalrefreshToken: string
- OptionalexpiresIn: number
Returns Promise<void>
Inherited from BaseSocialMediaAction.updateStoredTokens
- Defined in packages/Actions/Engine/dist/generic/BaseOAuthAction.d.ts:67

`Protected`uploadMedia

uploadMedia(files: MediaFile[]): Promise<string[]>
Upload media files to the platform
Parameters
- files: MediaFile[]
Returns Promise<string[]>
Inherited from BaseSocialMediaAction.uploadMedia
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:112

`Protected`uploadSingleMedia

uploadSingleMedia(_file: MediaFile): Promise<string>
Platform-specific media upload implementation
Parameters
- _file: MediaFile
Returns Promise<string>
Overrides BaseSocialMediaAction.uploadSingleMedia
- Defined in packages/Actions/BizApps/Social/src/providers/buffer/buffer-base.action.ts:598

`Protected`validateMediaFile

validateMediaFile(file: MediaFile): void
Validate media file meets platform requirements
Parameters
- file: MediaFile
Returns void
Inherited from BaseSocialMediaAction.validateMediaFile
- Defined in packages/Actions/BizApps/Social/src/base/base-social.action.ts:135

Class BufferBaseActionAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BufferBaseAction

Properties

Protected_companyIntegration

Protected_integration

Accessors

ProtectedapiBaseUrl

Returns string

ProtectedbufferCommonParams

Returns ActionParam[]

ProtectedcommonSocialParams

Returns ActionParam[]

ProtectedoauthParams

Returns ActionParam[]

ProtectedplatformName

Returns string

Methods

ProtectedbuildErrorResult

Parameters

Returns ActionResultSimple

ProtectedbuildHeaders

Parameters

Returns Record<string, string>

ProtectedcreateBufferPost

Parameters

Returns Promise<BufferPost>

Mention

ProtecteddeleteBufferPost

Parameters

Returns Promise<boolean>

ProtectedensureAuthenticated

Parameters

Returns Promise<ActionResultSimple>

ProtectedexecuteGraphQL

Type Parameters

Parameters

Returns Promise<T>

ProtectedextractHashtags

Parameters

Returns string[]

ProtectedfetchChannels

Parameters

Returns Promise<BufferChannel[]>

ProtectedfetchPosts

Parameters

Returns Promise<BufferPostsConnection>

ProtectedformatDate

Parameters

Returns string

ProtectedgetAccessToken

Returns string

ProtectedgetCustomAttribute

Parameters

Returns string

ProtectedgetParamValue

Parameters

Returns any

ProtectedgetProfileId

Parameters

Returns string

ProtectedgetRefreshToken

Returns string

ProtectedgroupPostsByDay

Parameters

Returns Record<string, number>

ProtectedhandleOAuthError

Parameters

Returns ActionResultSimple

ProtectedhandleRateLimit

Parameters

Returns Promise<void>

ProtectedinitializeOAuth

Class BufferBaseAction`Abstract`

`Protected`_companyIntegration

`Protected`_integration

`Protected`apiBaseUrl

`Protected`bufferCommonParams

`Protected`commonSocialParams

`Protected`oauthParams

`Protected`platformName

`Protected`buildErrorResult

`Protected`buildHeaders

`Protected`createBufferPost

`Protected`deleteBufferPost

`Protected`ensureAuthenticated

`Protected`executeGraphQL

`Protected`extractHashtags

`Protected`fetchChannels

`Protected`fetchPosts

`Protected`formatDate

`Protected`getAccessToken

`Protected`getCustomAttribute

`Protected`getParamValue

`Protected`getProfileId

`Protected`getRefreshToken

`Protected`groupPostsByDay

`Protected`handleOAuthError

`Protected`handleRateLimit

`Protected`initializeOAuth

`Protected` `Abstract`InternalRunAction

`Protected`isAuthError

`Protected`isTokenExpired

`Protected`logApiRequest

`Protected`logApiResponse

`Protected`makeAuthenticatedRequest

`Protected`mapBufferError

`Protected`normalizeAnalytics

`Protected`normalizePost

`Protected`parseDate

`Protected`parseRateLimitHeaders

`Protected`refreshAccessToken

`Protected`resolveCredentialAccessToken

`Protected`resolveOrganizationId

`Protected`searchPosts

`Protected`setCustomAttribute

`Protected`setOutputParam

`Protected`updateStoredTokens

`Protected`uploadMedia

`Protected`uploadSingleMedia

`Protected`validateMediaFile