@use_socials/sdk 0.1.0

package/dist/base.d.ts

@@ -0,0 +1,42 @@
+/**
+ * use-socials API
+ * Social media publishing API as a service. Allows app builders to let their users post to YouTube, TikTok, Instagram, and Pinterest.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export interface RequestArgs {
+    url: string;
+    options: RawAxiosRequestConfig;
+}
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}
+interface ServerMap {
+    [key: string]: {
+        url: string;
+        description: string;
+    }[];
+}
+export declare const operationServerMap: ServerMap;
+export {};

package/dist/base.js

@@ -0,0 +1,46 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * use-socials API
+ * Social media publishing API as a service. Allows app builders to let their users post to YouTube, TikTok, Instagram, and Pinterest.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
+const axios_1 = require("axios");
+exports.BASE_PATH = "http://localhost:8080".replace(/\/+$/, "");
+exports.COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+class BaseAPI {
+    constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
+        var _a;
+        this.basePath = basePath;
+        this.axios = axios;
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
+        }
+    }
+}
+exports.BaseAPI = BaseAPI;
+;
+class RequiredError extends Error {
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        this.name = "RequiredError";
+    }
+}
+exports.RequiredError = RequiredError;
+exports.operationServerMap = {};

package/dist/client.d.ts

@@ -0,0 +1,196 @@
+import type { AxiosInstance, RawAxiosRequestConfig } from "axios";
+import { type HandlersPresignMediaRequest, type HandlersWaitlistResponse } from "./api";
+export type UseSocialsPlatform = "youtube" | "tiktok" | "instagram" | "pinterest";
+export type UseSocialsPostStatus = "PUBLISHING" | "PUBLISHED" | "FAILED";
+export type UseSocialsPostTargetStatus = "PENDING" | "PUBLISHING" | "PUBLISHED" | "FAILED";
+export type UseSocialsTaskStatus = "PENDING" | "PROCESSING" | "PUBLISHED" | "FAILED";
+export type UseSocialsClientOptions = {
+    apiKey: string;
+    baseUrl?: string;
+    baseOptions?: RawAxiosRequestConfig;
+    axios?: AxiosInstance;
+};
+export type UseSocialsUser = {
+    userId: string;
+    externalId: string;
+};
+export type UseSocialsAccount = {
+    id: string;
+    platform: string;
+    platformAccountId: string;
+    platformUsername: string | null;
+    status: string;
+    createdAt: string;
+};
+export type UseSocialsOAuthCallback = {
+    status: "connected";
+};
+export type UseSocialsPost = {
+    id: string;
+    userId: string;
+    status: UseSocialsPostStatus;
+    title: string | null;
+    content: object;
+    mediaItems: UseSocialsPostMediaItem[];
+    targets: UseSocialsPostTarget[];
+    createdAt: string;
+    updatedAt: string;
+};
+export type UseSocialsPostTarget = {
+    id: string;
+    platform: string;
+    status: UseSocialsPostTargetStatus;
+    socialAccountId: string;
+    platformUsername: string | null;
+    platformPostId: string | null;
+    platformPostUrl: string | null;
+    error: string | null;
+    publishedAt: string | null;
+    retryCount: number;
+};
+export type UseSocialsPostMediaItem = {
+    id: string;
+    url: string;
+    type: string;
+    filename: string | null;
+    mimeType: string | null;
+    size: number;
+};
+export type UseSocialsRetryPostTargetResult = {
+    targetId: string;
+    status: string;
+};
+export type UseSocialsPostTask = {
+    id: string;
+    status: UseSocialsTaskStatus;
+    socialAccountId: string;
+    mediaUrl: string;
+    content: object;
+    platformPostId: string | null;
+    platformPostUrl: string | null;
+    error: string | null;
+    attempts: number;
+    maxAttempts: number;
+    createdAt: string;
+    updatedAt: string;
+    lastAttemptAt: string | null;
+};
+export type YouTubePostContent = {
+    title: string;
+    description?: string;
+    tags?: string[];
+    privacyStatus?: "public" | "private" | "unlisted";
+    thumbnailUrl?: string;
+};
+export type TikTokPostContent = {
+    title: string;
+    privacyLevel?: "PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY";
+    disableDuet?: boolean;
+    disableComment?: boolean;
+    disableStitch?: boolean;
+};
+export type InstagramPostContent = {
+    caption?: string;
+    mediaType?: "REELS" | "IMAGE";
+    shareToFeed?: boolean;
+};
+export type PinterestPostContent = {
+    title?: string;
+    description?: string;
+    link?: string;
+    boardId?: string;
+};
+export type UseSocialsPostContent = YouTubePostContent | TikTokPostContent | InstagramPostContent | PinterestPostContent | Record<string, unknown>;
+export type UseSocialsPresignedMedia = {
+    mediaId: string;
+    uploadUrl: string;
+    publicUrl: string;
+    key: string;
+    expiresAt: string;
+    contentType: string;
+};
+export type UseSocialsCompletedMedia = {
+    mediaId: string;
+    publicUrl: string;
+    contentType: string;
+    size: number;
+    status: string;
+};
+export declare class UseSocialsClient {
+    private readonly healthApi;
+    private readonly mediaApi;
+    private readonly oauthApi;
+    private readonly postsApi;
+    private readonly publishApi;
+    private readonly usersApi;
+    private readonly waitlistApi;
+    readonly health: {
+        get: () => Promise<Record<string, string>>;
+    };
+    readonly users: {
+        create: (args: {
+            externalId: string;
+        }) => Promise<UseSocialsUser>;
+    };
+    readonly accounts: {
+        list: (args: {
+            userId: string;
+        }) => Promise<UseSocialsAccount[]>;
+        disconnect: (args: {
+            userId: string;
+            accountId: string;
+        }) => Promise<void>;
+    };
+    readonly oauth: {
+        getUrl: (args: {
+            platform: UseSocialsPlatform;
+            userId: string;
+            redirectUrl?: string;
+        }) => Promise<string>;
+        callback: (args: {
+            platform: UseSocialsPlatform;
+            code: string;
+            state: string;
+        }) => Promise<UseSocialsOAuthCallback>;
+    };
+    readonly posts: {
+        create: (args: {
+            userId: string;
+            socialAccountId: string;
+            socialAccountIds?: string[];
+            mediaUrl: string;
+            content: UseSocialsPostContent;
+            idempotencyKey?: string;
+        }) => Promise<UseSocialsPost>;
+        list: (args: {
+            userId: string;
+        }) => Promise<UseSocialsPost[]>;
+        get: (args: {
+            userId: string;
+            postId: string;
+        }) => Promise<UseSocialsPost>;
+        retry: (args: {
+            userId: string;
+            postId: string;
+            targetId: string;
+        }) => Promise<UseSocialsRetryPostTargetResult>;
+    };
+    readonly postsTask: {
+        get: (args: {
+            jobId: string;
+        }) => Promise<UseSocialsPostTask>;
+    };
+    readonly media: {
+        presign: (args: HandlersPresignMediaRequest) => Promise<UseSocialsPresignedMedia>;
+        complete: (args: {
+            mediaId: string;
+        }) => Promise<UseSocialsCompletedMedia>;
+    };
+    readonly waitlist: {
+        join: (args: {
+            email: string;
+        }) => Promise<HandlersWaitlistResponse>;
+    };
+    constructor(options: UseSocialsClientOptions);
+}
+export declare function createUseSocialsClient(options: UseSocialsClientOptions): UseSocialsClient;

package/dist/client.js

@@ -0,0 +1,275 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseSocialsClient = void 0;
+exports.createUseSocialsClient = createUseSocialsClient;
+const api_1 = require("./api");
+const configuration_1 = require("./configuration");
+const DEFAULT_BASE_URL = "https://api.usesocials.com";
+function getRequiredString(value, field) {
+    if (!value)
+        throw new Error(`useSocials response missing ${field}`);
+    return value;
+}
+function getOptionalString(value) {
+    return value !== null && value !== void 0 ? value : null;
+}
+function getRequiredObject(value, field) {
+    if (value === undefined || value === null) {
+        throw new Error(`useSocials response missing ${field}`);
+    }
+    return value;
+}
+function getRequiredNumber(value, field) {
+    if (value === undefined || value === null) {
+        throw new Error(`useSocials response missing ${field}`);
+    }
+    return value;
+}
+function getPostStatus(value) {
+    switch (value) {
+        case "PUBLISHING":
+        case "PUBLISHED":
+        case "FAILED":
+            return value;
+        default:
+            throw new Error(`useSocials returned unknown post status: ${value !== null && value !== void 0 ? value : "undefined"}`);
+    }
+}
+function getPostTargetStatus(value) {
+    switch (value) {
+        case "PENDING":
+        case "PUBLISHING":
+        case "PUBLISHED":
+        case "FAILED":
+            return value;
+        default:
+            throw new Error(`useSocials returned unknown post target status: ${value !== null && value !== void 0 ? value : "undefined"}`);
+    }
+}
+function getTaskStatus(value) {
+    switch (value) {
+        case "PENDING":
+        case "PROCESSING":
+        case "PUBLISHED":
+        case "FAILED":
+            return value;
+        default:
+            throw new Error(`useSocials returned unknown task status: ${value !== null && value !== void 0 ? value : "undefined"}`);
+    }
+}
+function getOptionalObject(value) {
+    var _a;
+    return (_a = value) !== null && _a !== void 0 ? _a : {};
+}
+function mapOAuthCallback(data) {
+    const status = getRequiredString(data.status, "oauth.status");
+    if (status !== "connected") {
+        throw new Error(`useSocials returned unknown oauth status: ${status}`);
+    }
+    return { status: "connected" };
+}
+function mapAccount(data) {
+    return {
+        id: getRequiredString(data.id, "account.id"),
+        platform: getRequiredString(data.platform, "account.platform"),
+        platformAccountId: getRequiredString(data.platformAccountId, "account.platformAccountId"),
+        platformUsername: getOptionalString(data.platformUsername),
+        status: getRequiredString(data.status, "account.status"),
+        createdAt: getRequiredString(data.createdAt, "account.createdAt"),
+    };
+}
+function mapPost(data) {
+    var _a, _b;
+    return {
+        id: getRequiredString(data.id, "post.id"),
+        userId: getRequiredString(data.createdByUserId, "post.createdByUserId"),
+        status: getPostStatus(data.status),
+        title: getOptionalString(data.title),
+        content: getOptionalObject(data.content),
+        mediaItems: ((_a = data.mediaItems) !== null && _a !== void 0 ? _a : []).map(mapPostMediaItem),
+        targets: ((_b = data.targets) !== null && _b !== void 0 ? _b : []).map(mapPostTarget),
+        createdAt: getRequiredString(data.createdAt, "post.createdAt"),
+        updatedAt: getRequiredString(data.updatedAt, "post.updatedAt"),
+    };
+}
+function mapPostTask(data) {
+    var _a, _b;
+    return {
+        id: getRequiredString(data.id, "postTask.id"),
+        status: getTaskStatus(data.status),
+        socialAccountId: getRequiredString(data.socialAccountId, "postTask.socialAccountId"),
+        mediaUrl: getRequiredString(data.mediaUrl, "postTask.mediaUrl"),
+        content: getOptionalObject(data.content),
+        platformPostId: getOptionalString(data.platformPostId),
+        platformPostUrl: getOptionalString(data.platformPostUrl),
+        error: getOptionalString(data.error),
+        attempts: (_a = data.attempts) !== null && _a !== void 0 ? _a : 0,
+        maxAttempts: (_b = data.maxAttempts) !== null && _b !== void 0 ? _b : 0,
+        createdAt: getRequiredString(data.createdAt, "postTask.createdAt"),
+        updatedAt: getRequiredString(data.updatedAt, "postTask.updatedAt"),
+        lastAttemptAt: getOptionalString(data.lastAttemptAt),
+    };
+}
+function mapPostTarget(data) {
+    return {
+        id: getRequiredString(data.id, "postTarget.id"),
+        platform: getRequiredString(data.platform, "postTarget.platform"),
+        status: getPostTargetStatus(data.status),
+        socialAccountId: getRequiredString(data.socialAccountId, "postTarget.socialAccountId"),
+        platformUsername: getOptionalString(data.platformUsername),
+        platformPostId: getOptionalString(data.platformPostId),
+        platformPostUrl: getOptionalString(data.platformPostUrl),
+        error: getOptionalString(data.error),
+        publishedAt: getOptionalString(data.publishedAt),
+        retryCount: getRequiredNumber(data.retryCount, "postTarget.retryCount"),
+    };
+}
+function mapPostMediaItem(data) {
+    var _a;
+    return {
+        id: getRequiredString(data.id, "postMediaItem.id"),
+        url: getRequiredString(data.url, "postMediaItem.url"),
+        type: getRequiredString(data.type, "postMediaItem.type"),
+        filename: getOptionalString(data.filename),
+        mimeType: getOptionalString(data.mimeType),
+        size: (_a = data.sizeBytes) !== null && _a !== void 0 ? _a : 0,
+    };
+}
+function mapRetryPostTarget(data) {
+    return {
+        targetId: getRequiredString(data.targetId, "postTarget.targetId"),
+        status: getRequiredString(data.status, "postTarget.status"),
+    };
+}
+function mapUser(data) {
+    return {
+        userId: getRequiredString(data.userId, "user.userId"),
+        externalId: getRequiredString(data.externalId, "user.externalId"),
+    };
+}
+function mapPresignedMedia(data) {
+    return {
+        mediaId: getRequiredString(data.mediaId, "media.mediaId"),
+        uploadUrl: getRequiredString(data.uploadUrl, "media.uploadUrl"),
+        publicUrl: getRequiredString(data.publicUrl, "media.publicUrl"),
+        key: getRequiredString(data.key, "media.key"),
+        expiresAt: getRequiredString(data.expiresAt, "media.expiresAt"),
+        contentType: getRequiredString(data.contentType, "media.contentType"),
+    };
+}
+function mapCompletedMedia(data) {
+    return {
+        mediaId: getRequiredString(data.mediaId, "media.mediaId"),
+        publicUrl: getRequiredString(data.publicUrl, "media.publicUrl"),
+        contentType: getRequiredString(data.contentType, "media.contentType"),
+        size: getRequiredNumber(data.size, "media.size"),
+        status: getRequiredString(data.status, "media.status"),
+    };
+}
+class UseSocialsClient {
+    constructor(options) {
+        var _a;
+        const configuration = new configuration_1.Configuration({
+            apiKey: options.apiKey,
+            basePath: (_a = options.baseUrl) !== null && _a !== void 0 ? _a : DEFAULT_BASE_URL,
+            baseOptions: options.baseOptions,
+        });
+        this.healthApi = new api_1.HealthApi(configuration, undefined, options.axios);
+        this.mediaApi = new api_1.MediaApi(configuration, undefined, options.axios);
+        this.oauthApi = new api_1.OauthApi(configuration, undefined, options.axios);
+        this.postsApi = new api_1.PostsApi(configuration, undefined, options.axios);
+        this.publishApi = new api_1.PublishApi(configuration, undefined, options.axios);
+        this.usersApi = new api_1.UsersApi(configuration, undefined, options.axios);
+        this.waitlistApi = new api_1.WaitlistApi(configuration, undefined, options.axios);
+        this.health = {
+            get: () => __awaiter(this, void 0, void 0, function* () {
+                const { data } = yield this.healthApi.healthGet();
+                return data;
+            }),
+        };
+        this.users = {
+            create: (_a) => __awaiter(this, [_a], void 0, function* ({ externalId }) {
+                const { data } = yield this.usersApi.apiV1UsersPost({ externalId });
+                return mapUser(data);
+            }),
+        };
+        this.accounts = {
+            list: (_a) => __awaiter(this, [_a], void 0, function* ({ userId }) {
+                const { data } = yield this.usersApi.apiV1UsersUserIdAccountsGet(userId);
+                return data.map(mapAccount);
+            }),
+            disconnect: (_a) => __awaiter(this, [_a], void 0, function* ({ userId, accountId }) {
+                yield this.usersApi.apiV1UsersUserIdAccountsAccountIdDelete(userId, accountId);
+            }),
+        };
+        this.oauth = {
+            getUrl: (_a) => __awaiter(this, [_a], void 0, function* ({ platform, userId, redirectUrl }) {
+                const { data } = yield this.oauthApi.apiV1OauthPlatformUrlGet(platform, userId, redirectUrl);
+                return getRequiredString(data.url, "oauth.url");
+            }),
+            callback: (_a) => __awaiter(this, [_a], void 0, function* ({ platform, code, state }) {
+                const { data } = yield this.oauthApi.apiV1OauthPlatformCallbackGet(platform, code, state);
+                return mapOAuthCallback(data);
+            }),
+        };
+        this.posts = {
+            create: (_a) => __awaiter(this, [_a], void 0, function* ({ userId, socialAccountId, socialAccountIds, mediaUrl, content, idempotencyKey, }) {
+                const body = {
+                    socialAccountId,
+                    socialAccountIds,
+                    mediaUrl,
+                    content,
+                };
+                const { data } = yield this.postsApi.apiV1UsersUserIdPostsPost(userId, body, idempotencyKey);
+                return mapPost(data);
+            }),
+            list: (_a) => __awaiter(this, [_a], void 0, function* ({ userId }) {
+                const { data } = yield this.postsApi.apiV1UsersUserIdPostsGet(userId);
+                return data.map(mapPost);
+            }),
+            get: (_a) => __awaiter(this, [_a], void 0, function* ({ userId, postId }) {
+                const { data } = yield this.postsApi.apiV1UsersUserIdPostsPostIdGet(userId, postId);
+                return mapPost(data);
+            }),
+            retry: (_a) => __awaiter(this, [_a], void 0, function* ({ userId, postId, targetId }) {
+                const { data } = yield this.postsApi.apiV1UsersUserIdPostsPostIdTargetsTargetIdRetryPost(userId, postId, targetId);
+                return mapRetryPostTarget(data);
+            }),
+        };
+        this.postsTask = {
+            get: (_a) => __awaiter(this, [_a], void 0, function* ({ jobId }) {
+                const { data } = yield this.publishApi.apiV1PublishJobsJobIdGet(jobId);
+                return mapPostTask(data);
+            }),
+        };
+        this.media = {
+            presign: (args) => __awaiter(this, void 0, void 0, function* () {
+                const { data } = yield this.mediaApi.apiV1MediaPresignPost(args);
+                return mapPresignedMedia(data);
+            }),
+            complete: (_a) => __awaiter(this, [_a], void 0, function* ({ mediaId }) {
+                const { data } = yield this.mediaApi.apiV1MediaMediaIdCompletePost(mediaId);
+                return mapCompletedMedia(data);
+            }),
+        };
+        this.waitlist = {
+            join: (_a) => __awaiter(this, [_a], void 0, function* ({ email }) {
+                const { data } = yield this.waitlistApi.waitlistPost({ email });
+                return data;
+            }),
+        };
+    }
+}
+exports.UseSocialsClient = UseSocialsClient;
+function createUseSocialsClient(options) {
+    return new UseSocialsClient(options);
+}

package/dist/common.d.ts

@@ -0,0 +1,34 @@
+/**
+ * use-socials API
+ * Social media publishing API as a service. Allows app builders to let their users post to YouTube, TikTok, Instagram, and Pinterest.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
+ * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
+ * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ */
+export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+export declare const toPathString: (url: URL) => string;
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;