@opencoredev/social-sdk 0.1.2 → 0.2.1

package/dist/platforms/linkedin.d.ts

@@ -0,0 +1,108 @@
+import type { AdapterOperationContext, ConnectedAccountRef, JsonObject, MediaRef } from "../core/types.js";
+export interface LinkedInOptions {
+    readonly auth: {
+        readonly accessToken: string;
+        readonly author: `urn:li:person:${string}` | `urn:li:organization:${string}`;
+    };
+    /** Explicit monthly API version, for example 202609. Upgrade after reviewing LinkedIn's migration notes. */
+    readonly apiVersion: string;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly clock?: () => Date;
+}
+export interface LinkedInTimeInterval {
+    readonly granularity: "DAY" | "WEEK" | "MONTH";
+    readonly start?: number;
+    readonly end?: number;
+}
+export interface LinkedInFollowerBreakdown {
+    readonly dimension: "function" | "seniority" | "industry" | "geo" | "geoCountry" | "staffCountRange" | "associationType";
+    readonly value: string;
+    readonly organicFollowerCount?: number | undefined;
+    readonly paidFollowerCount?: number | undefined;
+}
+export interface LinkedInFollowerStatistics {
+    readonly organization: string;
+    readonly interval?: LinkedInTimeInterval | undefined;
+    readonly organicFollowerGain?: number | undefined;
+    readonly paidFollowerGain?: number | undefined;
+    readonly breakdowns: readonly LinkedInFollowerBreakdown[];
+}
+export interface LinkedInPageStatistics {
+    readonly organization: string;
+    readonly interval?: LinkedInTimeInterval | undefined;
+    readonly views: Readonly<Record<string, number>>;
+    readonly clicks: Readonly<Record<string, number>>;
+    readonly breakdowns: {
+        readonly dimension: string;
+        readonly value: string;
+        readonly views: Readonly<Record<string, number>>;
+        readonly clicks: Readonly<Record<string, number>>;
+    }[];
+}
+export interface LinkedInShareStatistics {
+    readonly organization: string;
+    readonly interval?: LinkedInTimeInterval | undefined;
+    readonly metrics: Readonly<Record<string, number>>;
+}
+export interface LinkedInNative {
+    readonly imageStatus: (ref: MediaRef, context: AdapterOperationContext) => Promise<JsonObject>;
+    readonly registerVideo: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly byteSize: number;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly createPoll: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly text: string;
+        readonly options: readonly string[];
+        readonly duration?: "ONE_DAY" | "THREE_DAYS" | "SEVEN_DAYS" | "FOURTEEN_DAYS";
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly react: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly postId: string;
+        readonly reaction: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly reshare: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly postId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly updatePost: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly postId: string;
+        readonly body: JsonObject;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly deletePost: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly postId: string;
+        readonly context: AdapterOperationContext;
+    }) => Promise<void>;
+    readonly organizationAnalytics: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly query?: JsonObject;
+        readonly context: AdapterOperationContext;
+    }) => Promise<JsonObject>;
+    readonly getOrganizationFollowerStatistics: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly interval?: LinkedInTimeInterval;
+        readonly context: AdapterOperationContext;
+    }) => Promise<readonly LinkedInFollowerStatistics[]>;
+    readonly getOrganizationPageStatistics: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly interval?: LinkedInTimeInterval;
+        readonly context: AdapterOperationContext;
+    }) => Promise<readonly LinkedInPageStatistics[]>;
+    readonly getOrganizationShareStatistics: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly interval?: LinkedInTimeInterval;
+        readonly context: AdapterOperationContext;
+    }) => Promise<readonly LinkedInShareStatistics[]>;
+    readonly getOrganizationFollowerCount: (input: {
+        readonly account: ConnectedAccountRef;
+        readonly context: AdapterOperationContext;
+    }) => Promise<number | undefined>;
+}
+export declare function linkedin(options: LinkedInOptions): import("../core/adapter.js").SocialAdapter<LinkedInNative>;