Class BufferCreatePostAction

Protected_companyIntegration

Protected_integration

ProtectedapiBaseUrl

• get apiBaseUrl(): string

  Get the API base URL for the platform

  Returns string

ProtectedbufferCommonParams

• get bufferCommonParams(): ActionParam[]

  Common params shared by all Buffer actions.

  Returns ActionParam[]

ProtectedcommonSocialParams

• get commonSocialParams(): ActionParam[]

  Common parameters for all social media actions

  Returns ActionParam[]

ProtectedoauthParams

• get oauthParams(): ActionParam[]

  OAuth-specific parameters that all OAuth actions should include

  Returns ActionParam[]

ProtectedplatformName

• get platformName(): string

  Get the platform name (e.g., 'Twitter', 'LinkedIn')

  Returns string

ProtectedbuildErrorResult

• 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

ProtectedbuildHeaders

• buildHeaders(additionalHeaders?: Record<string, string>): Record<string, string>

  Build common API headers including authentication

  Parameters

  • OptionaladditionalHeaders: Record<string, string>

  Returns Record<string, string>

ProtectedcreateBufferPost

• 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.

ProtecteddeleteBufferPost

• deleteBufferPost(postId: string): Promise<boolean>

  Delete a post via the deletePost mutation.

  Parameters

  • postId: string

  Returns Promise<boolean>

ProtectedensureAuthenticated

• 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>

ProtectedexecuteGraphQL

• 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>

ProtectedextractHashtags

• extractHashtags(content: string): string[]

  Parameters

  • content: string

  Returns string[]

ProtectedfetchChannels

• fetchChannels(organizationId: string): Promise<BufferChannel[]>

  Fetch all channels for an organization.

  Parameters

  • organizationId: string

  Returns Promise<BufferChannel[]>

ProtectedfetchPosts

• 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>

ProtectedformatDate

• formatDate(date: string | Date): string

  Format date for API requests (ISO 8601)

  Parameters

  • date: string | Date

  Returns string

ProtectedgetAccessToken

• getAccessToken(): string

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

  Returns string

ProtectedgetCustomAttribute

• getCustomAttribute(attributeNumber: 1 | 2 | 3 | 4 | 5): string

  Get custom attributes from company integration

  Parameters

  • attributeNumber: 1 | 2 | 3 | 4 | 5

  Returns string

ProtectedgetParamValue

• getParamValue(params: ActionParam[], paramName: string): any

  Helper to get parameter value from params array

  Parameters

  • params: ActionParam[]
  • paramName: string

  Returns any

ProtectedgetProfileId

• getProfileId(params: any): string

  Get profile ID from parameters or default from integration

  Parameters

  • params: any

  Returns string

ProtectedgetRefreshToken

• getRefreshToken(): string

  Get the refresh token

  Returns string

ProtectedgroupPostsByDay

• 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>

ProtectedhandleOAuthError

• handleOAuthError(error: any): ActionResultSimple

  Handle OAuth-specific errors

  Parameters

  • error: any

  Returns ActionResultSimple

ProtectedhandleRateLimit

• handleRateLimit(retryAfter?: number): Promise<void>

  Handle rate limiting with exponential backoff

  Parameters

  • OptionalretryAfter: number

  Returns Promise<void>

ProtectedinitializeOAuth

• 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>

ProtectedisAuthError

• 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

ProtectedisTokenExpired

• isTokenExpired(): boolean

  Check if the current token is expired

  Returns boolean

ProtectedlogApiRequest

• logApiRequest(method: string, url: string, data?: any): void

  Log API request for debugging

  Parameters

  • method: string
  • url: string
  • Optionaldata: any

  Returns void

ProtectedlogApiResponse

• logApiResponse(response: any): void

  Log API response for debugging

  Parameters

  • response: any

  Returns void

ProtectedmakeAuthenticatedRequest

• 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>

ProtectedmapBufferError

• mapBufferError(error: unknown): string

  Parameters

  • error: unknown

  Returns string

ProtectednormalizeAnalytics

• normalizeAnalytics(bufferStats: Record<string, number>): SocialAnalytics

  Normalize platform-specific analytics to common format

  Parameters

  • bufferStats: Record<string, number>

  Returns SocialAnalytics

ProtectednormalizePost

• normalizePost(bufferPost: BufferPost): SocialPost

  Convert platform-specific post data to common format

  Parameters

  • bufferPost: BufferPost

  Returns SocialPost

ProtectedparseDate

• parseDate(dateString: string): Date

  Parse date from API response

  Parameters

  • dateString: string

  Returns Date

ProtectedparseRateLimitHeaders

• 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 }

ProtectedrefreshAccessToken

• refreshAccessToken(): Promise<void>

  Refresh the access token using the refresh token. Must be implemented by platform-specific subclasses.

  Returns Promise<void>

ProtectedresolveCredentialAccessToken

• 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>

ProtectedresolveOrganizationId

• resolveOrganizationId(params: ActionParam[]): Promise<string>

  Resolve org ID from params or by fetching the account's first org.

  Parameters

  • params: ActionParam[]

  Returns Promise<string>

ProtectedsearchPosts

• 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[]>

ProtectedsetCustomAttribute

• 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>

ProtectedsetOutputParam

• setOutputParam(params: ActionParam[], name: string, value: unknown): void

  Set an output parameter value by name.

  Parameters

  • params: ActionParam[]
  • name: string
  • value: unknown

  Returns void

ProtectedupdateStoredTokens

• updateStoredTokens(
      accessToken: string,
      refreshToken?: string,
      expiresIn?: number,
  ): Promise<void>

  Update stored tokens after refresh

  Parameters

  • accessToken: string
  • OptionalrefreshToken: string
  • OptionalexpiresIn: number

  Returns Promise<void>

ProtecteduploadMedia

• uploadMedia(files: MediaFile[]): Promise<string[]>

  Upload media files to the platform

  Parameters

  • files: MediaFile[]

  Returns Promise<string[]>

ProtecteduploadSingleMedia

• uploadSingleMedia(_file: MediaFile): Promise<string>

  Platform-specific media upload implementation

  Parameters

  • _file: MediaFile

  Returns Promise<string>

ProtectedvalidateMediaFile

• validateMediaFile(file: MediaFile): void

  Validate media file meets platform requirements

  Parameters

  • file: MediaFile

  Returns void