@schedulin/sdk 0.1.0

package/esm/api/resources/posts/client/Client.d.mts

@@ -0,0 +1,187 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Schedulin from "../../../index.mjs";
+export declare namespace PostsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class PostsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<PostsClient.Options>;
+    constructor(options: PostsClient.Options);
+    /**
+     * Search and filter posts with various criteria including status, date range, social accounts, and tags
+     *
+     * @param {Schedulin.ListPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.list()
+     */
+    list(request?: Schedulin.ListPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.ListPostsResponse>;
+    private __list;
+    /**
+     * Create a new post with media, tags, and scheduling options
+     *
+     * @param {Schedulin.PostCreate} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.create({
+     *         caption: "caption",
+     *         socialAccountId: "socialAccountId"
+     *     })
+     */
+    create(request: Schedulin.PostCreate, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.CreatePostsResponse>;
+    private __create;
+    /**
+     * Returns counts of posts for the Queue, Drafts, Approvals, and Sent tabs
+     *
+     * @param {Schedulin.V0PostCountByTabRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.v0PostCountByTab()
+     */
+    v0PostCountByTab(request?: Schedulin.V0PostCountByTabRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __v0PostCountByTab;
+    /**
+     * Retrieve a single post by its ID with all relations
+     *
+     * @param {Schedulin.RetrievePostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.retrieve({
+     *         id: "id"
+     *     })
+     */
+    retrieve(request: Schedulin.RetrievePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.PostWithRelations>;
+    private __retrieve;
+    /**
+     * Update an existing post by its ID
+     *
+     * @param {Schedulin.UpdatePostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.update({
+     *         id: "id"
+     *     })
+     */
+    update(request: Schedulin.UpdatePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.Post>;
+    private __update;
+    /**
+     * Delete a post by its ID
+     *
+     * @param {Schedulin.DeletePostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.delete({
+     *         id: "id"
+     *     })
+     */
+    delete(request: Schedulin.DeletePostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.Post>;
+    private __delete;
+    /**
+     * Retrieve the latest analytics snapshot for a post
+     *
+     * @param {Schedulin.AnalyticsSummaryPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.analyticsSummary({
+     *         id: "id"
+     *     })
+     */
+    analyticsSummary(request: Schedulin.AnalyticsSummaryPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.AnalyticsSummaryPostsResponse>;
+    private __analyticsSummary;
+    /**
+     * Retrieve time series analytics metrics for a post
+     *
+     * @param {Schedulin.AnalyticsSeriesPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.analyticsSeries({
+     *         id: "id"
+     *     })
+     */
+    analyticsSeries(request: Schedulin.AnalyticsSeriesPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.AnalyticsSeriesPostsResponse>;
+    private __analyticsSeries;
+    /**
+     * Publish a draft post to connected social media accounts
+     *
+     * @param {Schedulin.PublishDraftPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.publishDraft({
+     *         id: "id"
+     *     })
+     */
+    publishDraft(request: Schedulin.PublishDraftPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.Post>;
+    private __publishDraft;
+    /**
+     * Replace all tags on a post. No status restrictions apply.
+     *
+     * @param {Schedulin.UpdateTagsPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.updateTags({
+     *         id: "id",
+     *         tagIds: ["tagIds"]
+     *     })
+     */
+    updateTags(request: Schedulin.UpdateTagsPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<Schedulin.Post>;
+    private __updateTags;
+    /**
+     * Retrieve the processing job status and logs for a post
+     *
+     * @param {Schedulin.GetJobStatusPostsRequest} request
+     * @param {PostsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schedulin.UnauthorizedError}
+     * @throws {@link Schedulin.InternalServerError}
+     *
+     * @example
+     *     await client.posts.getJobStatus({
+     *         id: "id"
+     *     })
+     */
+    getJobStatus(request: Schedulin.GetJobStatusPostsRequest, requestOptions?: PostsClient.RequestOptions): core.HttpResponsePromise<unknown | null>;
+    private __getJobStatus;
+}