Interface SocialEngagementClient

interface SocialEngagementClient {
    createSdkToken(input: SocialSdkTokenCreate): Promise<SocialSdkToken>;
    createUser(input: SocialUserCreate): Promise<SocialUser>;
    disconnectAccount(
        socialEngagementAccountId: string,
    ): Promise<SocialAccountDisconnected>;
    retrieveAccounts(input: SocialAccountsRetrieve): Promise<SocialAccount[]>;
    retrieveProfiles(socialEngagementUserId: string): Promise<SocialProfile[]>;
    retrieveWorkPlatforms(): Promise<SocialWorkPlatform[]>;
}

Index

Methods

createSdkToken createUser disconnectAccount retrieveAccounts retrieveProfiles retrieveWorkPlatforms

Methods

createSdkToken

createSdkToken(input: SocialSdkTokenCreate): Promise<SocialSdkToken>
Create a new SDK token for a user
Parameters
- input: SocialSdkTokenCreate
  The token options
Returns Promise<SocialSdkToken>
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:24

createUser

createUser(input: SocialUserCreate): Promise<SocialUser>
Create a new user in the social engagement system
Parameters
- input: SocialUserCreate
  The user to create
Returns Promise<SocialUser>
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:18

disconnectAccount

disconnectAccount(
socialEngagementAccountId: string,
): Promise<SocialAccountDisconnected>
Disconnect the specified socialEngagementAccount
Parameters
- socialEngagementAccountId: string
  the id of the account to disconnect
Returns Promise<SocialAccountDisconnected>
the disconnected social account
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:31

retrieveAccounts

retrieveAccounts(input: SocialAccountsRetrieve): Promise<SocialAccount[]>
Retrieve all accounts for the provided query
Parameters
- input: SocialAccountsRetrieve
  The SocialAccount query options
Returns Promise<SocialAccount[]>
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:44

retrieveProfiles

retrieveProfiles(socialEngagementUserId: string): Promise<SocialProfile[]>
Retrieve all profiles for a user
Parameters
- socialEngagementUserId: string
  The social engagement system user ID
Returns Promise<SocialProfile[]>
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:50

retrieveWorkPlatforms

retrieveWorkPlatforms(): Promise<SocialWorkPlatform[]>
Retrieve all work platforms

Returns Promise<SocialWorkPlatform[]>
- Defined in packages/services/src/services/integrations/socialEngagement/SocialEngagementClient.ts:38