@adeli/sdk 0.0.0-stage → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,360 @@
+import { T as Transport, R as RequestOptions, A as ApiResponse, C as ClientOptions } from './uploads-MGVSU99R.cjs';
+export { D as DirectUploadDescriptor, a as DirectUploadOptions, b as DirectUploadProgress, F as FileUploadOptions, O as OperationMetadata, c as OperationOptions, d as blobFromPath, f as fileFromPath } from './uploads-MGVSU99R.cjs';
+import { c as components, O as OperationSuccessBody, d as OperationQuery, e as OperationPath, f as OperationJsonBody, g as ProfilesResource, h as PostsResource, i as CommentsResource, j as PublicPlatform } from './comments-C_vDnwix.cjs';
+export { B as BinaryUpload, k as CommentMutationResponse, a as CommentsQuery, b as CommentsResponse, C as ConnectionSession, l as ConnectionSessionError, m as CreateCommentBody, n as CreateMediaUploadsBody, o as CreateMediaUploadsResponse, p as CreatePostBody, q as CreatePostWithFiles, r as CreateProfileBody, D as DeletePostPath, s as DeletePostQuery, t as DeleteProfileResponse, F as FacebookPostStatusResponse, I as InstagramPostStatusResponse, J as JsonObject, u as JsonValue, L as ListCommentsQuery, v as ListPostsQuery, w as PostListResponse, x as PostStatusQuery, y as Profile, S as StartConnectionBody, z as TikTokCreatorInfoResponse, A as TikTokMultipartBody, T as TikTokPostStatusResponse, U as UpdateCommentBody, E as UpdateProfileBody, G as UpdatedCommentResponse, H as UploadYouTubeVideoBody, K as YouTubeStagedUploadBody, M as YouTubeUploadBody, N as YouTubeUploadResponse, Y as YouTubeVideoStatusResponse } from './comments-C_vDnwix.cjs';
+
+/** Wire types for the account services and profile-scoped account handlers. */
+type AccountSchema = components['schemas']['Account'];
+type CapabilityDescriptor = AccountSchema['recommendedPermissions'][number];
+type ReconnectGuidance = AccountSchema['reconnect'];
+type AccountPermissionState = Pick<AccountSchema, 'grantedPermissions' | 'recommendedPermissions' | 'missingRecommendedPermissions' | 'capabilities' | 'capabilityRequirements' | 'reconnect'>;
+interface XCapabilities {
+    readonly analytics: boolean;
+    readonly inbox: boolean;
+}
+/** Aggregate account responses include the full capability/scope state. */
+type Account = AccountSchema;
+/** Detail/update handlers additionally return X-specific capability toggles. */
+type AccountDetailResponse = OperationSuccessBody<'getAccount'> & {
+    readonly xCapabilities?: XCapabilities;
+};
+type AccountUpdateResponse = OperationSuccessBody<'updateAccount'> & {
+    readonly xCapabilities?: XCapabilities;
+};
+type AccountsAggregateResponse = OperationSuccessBody<'listAccounts'>;
+type RefreshAccountsResponse = OperationSuccessBody<'refreshAccounts'>;
+/** At least one capability must be supplied; the API rejects an empty object. */
+type XCapabilitiesUpdate = {
+    readonly analytics: boolean;
+    readonly inbox?: boolean;
+} | {
+    readonly analytics?: boolean;
+    readonly inbox: boolean;
+};
+type UpdateAccountBody = OperationJsonBody<'updateAccount'>;
+type ListAccountsQuery = OperationQuery<'listAccounts'>;
+type AccountPath = OperationPath<'getAccount'>;
+type DisconnectAccountResponse = OperationSuccessBody<'disconnectAccount'>;
+declare class AccountsResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    listAccounts(args?: {
+        readonly query?: ListAccountsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AccountsAggregateResponse>>;
+    listProfileAccounts(args: {
+        readonly path: {
+            readonly profileId: string;
+        };
+    }, options?: RequestOptions): Promise<ApiResponse<AccountsAggregateResponse>>;
+    getAccount(args: {
+        readonly path: AccountPath;
+    }, options?: RequestOptions): Promise<ApiResponse<AccountDetailResponse>>;
+    updateAccount(args: {
+        readonly path: AccountPath;
+        readonly body: UpdateAccountBody;
+    }, options?: RequestOptions): Promise<ApiResponse<AccountUpdateResponse>>;
+    disconnectAccount(args: {
+        readonly path: AccountPath;
+    }, options?: RequestOptions): Promise<ApiResponse<DisconnectAccountResponse>>;
+    refreshAccounts(args: {
+        readonly path: {
+            readonly profileId: string;
+        };
+    }, options?: RequestOptions): Promise<ApiResponse<RefreshAccountsResponse>>;
+}
+
+type MessagesQuery = OperationQuery<'listMessages'>;
+type ListMessagesQuery = MessagesQuery;
+type SendMessageBody = OperationJsonBody<'sendMessage'>;
+type MessagesResponse = OperationSuccessBody<'listMessages'>;
+type SentMessage = OperationSuccessBody<'sendMessage'>;
+type SendInstagramMessageBody = OperationJsonBody<'sendInstagramMessage'>;
+type SentInstagramMessage = OperationSuccessBody<'sendInstagramMessage'>;
+declare class MessagesResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    listMessages(args?: {
+        readonly query?: MessagesQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<MessagesResponse>>;
+    sendMessage(args: {
+        readonly body: SendMessageBody;
+    }, options?: RequestOptions): Promise<ApiResponse<SentMessage>>;
+    sendInstagramMessage(args: {
+        readonly body: SendInstagramMessageBody;
+    }, options?: RequestOptions): Promise<ApiResponse<SentInstagramMessage>>;
+}
+
+type InstagramAccountInsightsQuery = OperationQuery<'getInstagramAccountInsights'>;
+type FacebookPageMetricsQuery = OperationQuery<'getFacebookPageMetrics'>;
+type TikTokAccountAnalyticsQuery = OperationQuery<'getTikTokAccountAnalytics'>;
+type TikTokAccountInsightsQuery = OperationQuery<'getTikTokAccountInsights'>;
+type TikTokVideoInsightsQuery = OperationQuery<'getTikTokVideoInsights'>;
+type YouTubeChannelInsightsQuery = OperationQuery<'getYouTubeChannelInsights'>;
+type YouTubeVideoInsightsQuery = OperationQuery<'getYouTubeVideoInsights'>;
+type InstagramAccountInsightsResponse = OperationSuccessBody<'getInstagramAccountInsights'>;
+type FacebookPageMetricsResponse = OperationSuccessBody<'getFacebookPageMetrics'>;
+type TikTokAccountAnalyticsResponse = OperationSuccessBody<'getTikTokAccountAnalytics'>;
+type TikTokAccountInsightsResponse = OperationSuccessBody<'getTikTokAccountInsights'>;
+type TikTokVideoInsightsResponse = OperationSuccessBody<'getTikTokVideoInsights'>;
+type YouTubeChannelInsightsResponse = OperationSuccessBody<'getYouTubeChannelInsights'>;
+type YouTubeVideoInsightsResponse = OperationSuccessBody<'getYouTubeVideoInsights'>;
+declare class AnalyticsResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    getInstagramAccountInsights(args: {
+        readonly query: InstagramAccountInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<InstagramAccountInsightsResponse>>;
+    getFacebookPageMetrics(args: {
+        readonly query?: FacebookPageMetricsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<FacebookPageMetricsResponse>>;
+    getTikTokAccountAnalytics(args: {
+        readonly query: TikTokAccountAnalyticsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<TikTokAccountAnalyticsResponse>>;
+    getTikTokAccountInsights(args: {
+        readonly query: TikTokAccountInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<TikTokAccountInsightsResponse>>;
+    getTikTokVideoInsights(args: {
+        readonly query: TikTokVideoInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<TikTokVideoInsightsResponse>>;
+    getYouTubeChannelInsights(args: {
+        readonly query: YouTubeChannelInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<YouTubeChannelInsightsResponse>>;
+    getYouTubeVideoInsights(args: {
+        readonly query: YouTubeVideoInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<YouTubeVideoInsightsResponse>>;
+}
+
+type IdempotentOptions = RequestOptions & {
+    readonly idempotencyKey: string;
+};
+type AdBusinessesQuery = OperationQuery<'listAdBusinesses'>;
+type ListAdBusinessesQuery = AdBusinessesQuery;
+type AdAccountsQuery = OperationQuery<'listAdAccounts'>;
+type ListAdAccountsQuery = AdAccountsQuery;
+type CreateAdAccountQuery = OperationQuery<'createAdAccount'>;
+type AdAccountQuery = OperationQuery<'getAdAccount'>;
+type AdTreeQuery = OperationQuery<'getAdTree'>;
+type AdInsightsQuery = OperationQuery<'getAdInsights'>;
+type AdLeadsQuery = OperationQuery<'listAdLeads'>;
+type ListAdLeadsQuery = AdLeadsQuery;
+type CreateCampaignQuery = OperationQuery<'createCampaign'>;
+type CreateAdAccountBody = OperationJsonBody<'createAdAccount'>;
+type UpdateAdAccountBody = OperationJsonBody<'updateAdAccount'>;
+type CreateCampaignBody = OperationJsonBody<'createCampaign'>;
+type SetAdStatusBody = OperationJsonBody<'setAdStatus'>;
+type AdAccountPath = OperationPath<'getAdAccount'>;
+type UpdateAdAccountPath = OperationPath<'updateAdAccount'>;
+type DeleteCampaignPath = OperationPath<'deleteCampaign'>;
+type ListAdBusinessesResponse = OperationSuccessBody<'listAdBusinesses'>;
+type ListAdAccountsResponse = OperationSuccessBody<'listAdAccounts'>;
+type CreateAdAccountResponse = OperationSuccessBody<'createAdAccount'>;
+type AdAccountResponse = OperationSuccessBody<'getAdAccount'>;
+type AdTreeResponse = OperationSuccessBody<'getAdTree'>;
+type AdInsightsResponse = OperationSuccessBody<'getAdInsights'>;
+type AdLeadsResponse = OperationSuccessBody<'listAdLeads'>;
+type CampaignResponse = OperationSuccessBody<'createCampaign'>;
+type AdStatusResponse = OperationSuccessBody<'setAdStatus'>;
+/** TikTok Ads only: an ad group's budget, end date or name. */
+type UpdateAdGroupPath = OperationPath<'updateAdGroup'>;
+type UpdateAdGroupQuery = OperationQuery<'updateAdGroup'>;
+type UpdateAdGroupBody = OperationJsonBody<'updateAdGroup'>;
+type AdGroupResponse = OperationSuccessBody<'updateAdGroup'>;
+/** TikTok Ads only: location, language and interest options. */
+type AdTargetingQuery = OperationQuery<'listAdTargeting'>;
+type AdTargetingResponse = OperationSuccessBody<'listAdTargeting'>;
+/** TikTok Ads only: the brand identities an ad runs as. */
+type AdIdentitiesQuery = OperationQuery<'listAdIdentities'>;
+type AdIdentitiesResponse = OperationSuccessBody<'listAdIdentities'>;
+type CreateAdIdentityQuery = OperationQuery<'createAdIdentity'>;
+type CreateAdIdentityBody = OperationJsonBody<'createAdIdentity'>;
+type AdIdentityResponse = OperationSuccessBody<'createAdIdentity'>;
+declare class AdsResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    listAdBusinesses(args?: {
+        readonly query?: AdBusinessesQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<ListAdBusinessesResponse>>;
+    listAdAccounts(args?: {
+        readonly query?: AdAccountsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<ListAdAccountsResponse>>;
+    createAdAccount(args: {
+        readonly query?: CreateAdAccountQuery;
+        readonly body: CreateAdAccountBody;
+    }, options: IdempotentOptions): Promise<ApiResponse<CreateAdAccountResponse>>;
+    getAdAccount(args: {
+        readonly path: AdAccountPath;
+        readonly query?: AdAccountQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdAccountResponse>>;
+    updateAdAccount(args: {
+        readonly path: UpdateAdAccountPath;
+        readonly query?: AdAccountQuery;
+        readonly body: UpdateAdAccountBody;
+    }, options?: RequestOptions): Promise<ApiResponse<AdAccountResponse>>;
+    getAdTree(args: {
+        readonly query: AdTreeQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdTreeResponse>>;
+    getAdInsights(args: {
+        readonly query: AdInsightsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdInsightsResponse>>;
+    listAdLeads(args?: {
+        readonly query?: AdLeadsQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdLeadsResponse>>;
+    createCampaign(args: {
+        readonly query?: CreateCampaignQuery;
+        readonly body: CreateCampaignBody;
+    }, options: IdempotentOptions): Promise<ApiResponse<CampaignResponse>>;
+    deleteCampaign(args: {
+        readonly path: DeleteCampaignPath;
+        readonly query: OperationQuery<'deleteCampaign'>;
+    }, options?: RequestOptions): Promise<ApiResponse<undefined>>;
+    setAdStatus(args: {
+        readonly query?: OperationQuery<'setAdStatus'>;
+        readonly body: SetAdStatusBody;
+    }, options?: RequestOptions): Promise<ApiResponse<AdStatusResponse>>;
+    updateAdGroup(args: {
+        readonly path: UpdateAdGroupPath;
+        readonly query?: UpdateAdGroupQuery;
+        readonly body: UpdateAdGroupBody;
+    }, options?: RequestOptions): Promise<ApiResponse<AdGroupResponse>>;
+    listAdTargeting(args: {
+        readonly query: AdTargetingQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdTargetingResponse>>;
+    listAdIdentities(args: {
+        readonly query: AdIdentitiesQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<AdIdentitiesResponse>>;
+    createAdIdentity(args: {
+        readonly query?: CreateAdIdentityQuery;
+        readonly body: CreateAdIdentityBody;
+    }, options?: RequestOptions): Promise<ApiResponse<AdIdentityResponse>>;
+}
+
+type XUsageResponse = OperationSuccessBody<'getXUsage'>;
+declare class UsageResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    getXUsage(_args?: Record<never, never>, options?: RequestOptions): Promise<ApiResponse<XUsageResponse>>;
+}
+
+type ListWebhooksQuery = OperationQuery<'listWebhooks'>;
+type CreateWebhookBody = OperationJsonBody<'createWebhook'>;
+type WebhooksResponse = OperationSuccessBody<'listWebhooks'>;
+type Webhook = WebhooksResponse['webhooks'][number];
+/** The created webhook and its signing secret. The secret is returned only here. */
+type CreatedWebhook = OperationSuccessBody<'createWebhook'>;
+declare class WebhooksResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    listWebhooks(args: {
+        readonly query: ListWebhooksQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<WebhooksResponse>>;
+    createWebhook(args: {
+        readonly body: CreateWebhookBody;
+    }, options?: RequestOptions): Promise<ApiResponse<CreatedWebhook>>;
+    deleteWebhook(args: {
+        readonly path: OperationPath<'deleteWebhook'>;
+    }, options?: RequestOptions): Promise<ApiResponse<undefined>>;
+}
+
+/** Wire alias for the object serialized by apps/web/lib/public-api/me.ts. */
+interface Identity {
+    readonly message: string;
+    readonly you: {
+        readonly name: string | null;
+        readonly organization: string | null;
+        readonly profile: {
+            readonly id: string;
+            readonly name: string;
+        };
+    };
+    readonly apiKey: {
+        readonly label: string | null;
+        readonly prefix: string;
+        readonly createdAt: string;
+    };
+    readonly accountsConnected: readonly {
+        readonly accountId: string;
+        readonly platform: PublicPlatform;
+        readonly username: string | null;
+    }[];
+    readonly docs: string;
+}
+interface GetMeQuery {
+    readonly profileId?: string;
+}
+declare class Adeli {
+    readonly profiles: ProfilesResource;
+    readonly accounts: AccountsResource;
+    readonly posts: PostsResource;
+    readonly comments: CommentsResource;
+    readonly messages: MessagesResource;
+    readonly analytics: AnalyticsResource;
+    readonly ads: AdsResource;
+    readonly usage: UsageResource;
+    readonly webhooks: WebhooksResource;
+    private readonly transport;
+    constructor(options?: ClientOptions);
+    /** Do not serialize client internals or its API key. */
+    toJSON(): Record<string, never>;
+    getMe(args?: {
+        readonly query?: GetMeQuery;
+    }, options?: RequestOptions): Promise<ApiResponse<Identity>>;
+}
+
+type PermissionRequiredDetails = NonNullable<components['schemas']['PermissionRequiredError']['error']['details']>;
+/** Conservative recognition, not normalization or proof that a URL is safe to follow.
+ * Sparse known fields are allowed; unknown-only objects and malformed known fields are not.
+ */
+declare function isPermissionRequiredDetails(value: unknown): value is PermissionRequiredDetails;
+declare class AdeliError extends Error {
+    readonly name: string;
+    constructor(message: string);
+}
+declare class ConfigurationError extends AdeliError {
+    readonly name = "ConfigurationError";
+}
+declare class NetworkError extends AdeliError {
+    readonly name: string;
+}
+/** Redirects are refused and must never be retried with credentials. */
+declare class RedirectError extends NetworkError {
+    readonly name: string;
+}
+/** A timeout only cancels this client request; a write may still have completed remotely. */
+declare class TimeoutError extends AdeliError {
+    readonly name = "TimeoutError";
+}
+declare class CancellationError extends AdeliError {
+    readonly name = "CancellationError";
+}
+declare class MalformedResponseError extends AdeliError {
+    readonly name = "MalformedResponseError";
+}
+interface AdeliApiErrorOptions {
+    status: number;
+    code?: string;
+    details?: unknown;
+    headers?: Headers;
+}
+declare class AdeliApiError extends AdeliError {
+    readonly name: string;
+    readonly status: number;
+    readonly code: string;
+    readonly details: unknown;
+    readonly headers: Headers;
+    constructor(message: string, options: AdeliApiErrorOptions);
+}
+declare class AuthenticationError extends AdeliApiError {
+    readonly name = "AuthenticationError";
+}
+declare class ValidationError extends AdeliApiError {
+    readonly name = "ValidationError";
+}
+declare class RateLimitError extends AdeliApiError {
+    readonly name = "RateLimitError";
+}
+declare class PermissionRequiredError extends AdeliApiError {
+    readonly name = "PermissionRequiredError";
+}
+declare function isAdeliApiError(error: unknown): error is AdeliApiError;
+
+export { type Account, type AccountDetailResponse, type AccountPermissionState, type AccountUpdateResponse, type AccountsAggregateResponse, type AdAccountPath, type AdAccountResponse, type AdAccountsQuery, type AdBusinessesQuery, type AdGroupResponse, type AdIdentitiesQuery, type AdIdentitiesResponse, type AdIdentityResponse, type AdInsightsQuery, type AdInsightsResponse, type AdLeadsQuery, type AdLeadsResponse, type AdStatusResponse, type AdTargetingQuery, type AdTargetingResponse, type AdTreeQuery, type AdTreeResponse, Adeli, AdeliApiError, AdeliError, AnalyticsResource, ApiResponse, AuthenticationError, type CampaignResponse, CancellationError, type CapabilityDescriptor, ClientOptions, ConfigurationError, type CreateAdAccountBody, type CreateAdAccountQuery, type CreateAdAccountResponse, type CreateAdIdentityBody, type CreateAdIdentityQuery, type CreateCampaignBody, type CreateCampaignQuery, type CreateWebhookBody, type CreatedWebhook, type DisconnectAccountResponse, type GetMeQuery, type Identity, type ListAdAccountsQuery, type ListAdBusinessesQuery, type ListAdLeadsQuery, type ListMessagesQuery, type ListWebhooksQuery, MalformedResponseError, type MessagesQuery, type MessagesResponse, NetworkError, type PermissionRequiredDetails, PermissionRequiredError, PublicPlatform, RateLimitError, type ReconnectGuidance, RedirectError, RequestOptions, type SendInstagramMessageBody, type SendMessageBody, type SentInstagramMessage, type SentMessage, type SetAdStatusBody, TimeoutError, type UpdateAccountBody, type UpdateAdGroupBody, type UpdateAdGroupPath, type UpdateAdGroupQuery, ValidationError, type Webhook, type WebhooksResponse, type XCapabilities, type XCapabilitiesUpdate, type XUsageResponse, isAdeliApiError, isPermissionRequiredDetails };