@elasticpath/plasmic-backend-sdk 0.0.1

package/dist/generated/types.gen.d.ts

@@ -0,0 +1,798 @@
+export type AddTrustedHostRequest = {
+    /**
+     * Host URL to add as trusted (e.g., https://my-app.com/plasmic-host)
+     */
+    url: string;
+};
+export type AdminChangeOwnerRequest = {
+    projectId: string;
+    ownerEmail: string;
+};
+export type AdminCloneRequest = {
+    projectId: string;
+    /**
+     * Specific revision to clone from
+     */
+    revisionNum?: number;
+};
+export type AdminCloneResponse = {
+    projectId: string;
+};
+export type AdminDeleteProjectRequest = {
+    id: string;
+};
+export type AdminListProjectsRequest = {
+    /**
+     * Filter by owner user ID
+     */
+    ownerId?: string;
+};
+export type AdminListProjectsResponse = {
+    projects: Array<ApiProject>;
+};
+export type AdminRestoreProjectRequest = {
+    id: string;
+};
+export type AdminRevertRevisionRequest = {
+    projectId: string;
+    revision: number;
+};
+export type ApiCmsDatabase = {
+    id: string;
+    name: string;
+    workspaceId: string;
+    publicToken: string;
+    /**
+     * Only included when fetching a single database
+     */
+    secretToken?: string;
+    tables?: Array<ApiCmsTable>;
+    extraData?: CmsDatabaseExtraData;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdById?: string | null;
+    updatedById?: string | null;
+    deletedById?: string | null;
+};
+export type ApiCmsTable = {
+    id: string;
+    /**
+     * Unique identifier within the database
+     */
+    identifier: string;
+    name: string;
+    description?: string | null;
+    /**
+     * Table schema definition
+     */
+    schema: {
+        [key: string]: unknown;
+    };
+    isArchived?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+};
+export type ApiError = {
+    /**
+     * Error type name
+     */
+    type: 'UnauthorizedError' | 'ForbiddenError' | 'NotFoundError' | 'BadRequestError' | 'ProjectRevisionError' | 'PaywallError';
+    message: string;
+    statusCode?: number;
+};
+/**
+ * Error type name
+ */
+export type type = 'UnauthorizedError' | 'ForbiddenError' | 'NotFoundError' | 'BadRequestError' | 'ProjectRevisionError' | 'PaywallError';
+export type ApiFeatureTier = {
+    id?: string;
+    name?: string;
+};
+export type ApiPermission = {
+    id?: string;
+    projectId?: string | null;
+    workspaceId?: string | null;
+    teamId?: string | null;
+    userId?: string | null;
+    email?: string | null;
+    user?: ApiUser;
+    accessLevel?: GrantableAccessLevel;
+};
+export type ApiProject = {
+    id: string;
+    name: string;
+    hostUrl?: string | null;
+    clonedFromProjectId?: string | null;
+    workspaceId?: string | null;
+    workspaceName?: string | null;
+    teamId?: string | null;
+    teamName?: string | null;
+    inviteOnly?: boolean;
+    defaultAccessLevel?: GrantableAccessLevel;
+    readableByPublic?: boolean;
+    isUserStarter?: boolean;
+    projectApiToken?: string | null;
+    featureTier?: ApiFeatureTier;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdById?: string | null;
+    updatedById?: string | null;
+    deletedById?: string | null;
+};
+export type ApiProjectRevision = {
+    id: string;
+    projectId: string;
+    revision: number;
+    /**
+     * Bundle data as JSON string (only included in full fetch)
+     */
+    data?: string;
+    branchId?: string | null;
+    createdBy?: ApiUser;
+    createdAt?: string;
+};
+export type ApiTeam = {
+    id: string;
+    name: string;
+    billingEmail?: string | null;
+    seats?: number | null;
+    featureTierId?: string | null;
+    featureTier?: ApiFeatureTier;
+    stripeCustomerId?: string | null;
+    stripeSubscriptionId?: string | null;
+    billingFrequency?: ('month' | 'year') | null;
+    personalTeamOwnerId?: string | null;
+    trialStartDate?: string | null;
+    trialDays?: number | null;
+    onTrial?: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+};
+export type billingFrequency = 'month' | 'year';
+export type ApiTrustedHost = {
+    /**
+     * Trusted host ID
+     */
+    id: string;
+    /**
+     * The trusted host URL
+     */
+    hostUrl: string;
+};
+export type ApiUser = {
+    id: string;
+    email: string;
+    firstName?: string | null;
+    lastName?: string | null;
+    avatarUrl?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    needsIntroSplash?: boolean;
+    needsSurvey?: boolean;
+    adminModeDisabled?: boolean;
+};
+export type ApiWorkspace = {
+    id: string;
+    name: string;
+    description: string;
+    team: ApiTeam;
+    uiConfig?: {
+        [key: string]: unknown;
+    } | null;
+    contentCreatorConfig?: {
+        [key: string]: unknown;
+    } | null;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string | null;
+    createdById?: string | null;
+    updatedById?: string | null;
+    deletedById?: string | null;
+};
+export type AppConfigResponse = {
+    config?: {
+        starterSections?: Array<StarterSection>;
+        hideBlankStarter?: boolean;
+    };
+};
+export type CloneDatabaseRequest = {
+    /**
+     * Name for the cloned database
+     */
+    name?: string;
+    /**
+     * Target workspace ID (defaults to same workspace)
+     */
+    workspaceId?: string;
+};
+export type CloneProjectRequest = {
+    name?: string;
+    workspaceId?: string;
+    branchName?: string;
+    hostUrl?: string;
+};
+export type CloneProjectResponse = {
+    projectId: string;
+    workspaceId?: string;
+};
+export type CmsDatabaseExtraData = {
+    /**
+     * Additional non-default locales available in this database
+     */
+    locales?: Array<string>;
+};
+export type ComponentUpdateRequest = {
+    /**
+     * Component name (used for matching existing components)
+     */
+    name?: string;
+    /**
+     * Component UUID (alternative matching method)
+     */
+    byUuid?: string;
+    body?: PlasmicElement;
+    /**
+     * Page path (for page components only)
+     */
+    path?: string;
+};
+export type CreateDatabaseRequest = {
+    name: string;
+    workspaceId: string;
+};
+export type CreatePersonalApiTokenResponse = {
+    token: PersonalApiToken;
+};
+export type CreateProjectRequest = {
+    /**
+     * Project name (defaults to "Untitled Project")
+     */
+    name?: string;
+    workspaceId?: string;
+    isPublic?: boolean;
+};
+export type CreateProjectResponse = {
+    project: ApiProject;
+    rev: ApiProjectRevision;
+};
+export type CreateWorkspaceRequest = {
+    /**
+     * Workspace name (defaults to "Untitled workspace")
+     */
+    name?: string;
+    /**
+     * Workspace description (defaults to empty string)
+     */
+    description?: string;
+    /**
+     * Team ID (required)
+     */
+    teamId: string;
+    contentCreatorConfig?: {
+        [key: string]: unknown;
+    };
+};
+export type CreateWorkspaceResponse = {
+    paywall: 'pass' | 'upsell' | 'requireTeam';
+    workspace?: ApiWorkspace;
+    team?: ApiTeam;
+    /**
+     * Paywall description when blocked
+     */
+    description?: string;
+};
+export type paywall = 'pass' | 'upsell' | 'requireTeam';
+export type CsrfResponse = {
+    csrf: string;
+};
+export type DeleteResponse = {
+    deletedId: string;
+};
+export type GetProjectResponse = {
+    project: ApiProject;
+    rev: ApiProjectRevision;
+    perms: Array<ApiPermission>;
+    owner?: ApiUser;
+    modelVersion: number;
+    latestRevisionSynced: number;
+    hasAppAuth: boolean;
+    appAuthProvider?: string;
+    isMainBranchProtected: boolean;
+};
+export type GetWorkspaceResponse = {
+    workspace: ApiWorkspace;
+    perms: Array<ApiPermission>;
+};
+export type GrantableAccessLevel = 'owner' | 'editor' | 'commenter' | 'viewer';
+export type ListDatabasesResponse = {
+    databases: Array<ApiCmsDatabase>;
+};
+export type ListPersonalApiTokensResponse = {
+    tokens: Array<PersonalApiToken>;
+};
+export type ListProjectsResponse = {
+    projects: Array<ApiProject>;
+    perms: Array<ApiPermission>;
+};
+export type ListWorkspacesResponse = {
+    teams: Array<ApiTeam>;
+    workspaces: Array<ApiWorkspace>;
+};
+export type LoginRequest = {
+    email: string;
+    password: string;
+};
+export type LoginResponse = {
+    user?: ApiUser;
+    status?: string;
+};
+/**
+ * CMS Database ID
+ */
+export type ParameterdatabaseId = string;
+/**
+ * Project ID
+ */
+export type ParameterprojectId = string;
+/**
+ * Workspace ID
+ */
+export type ParameterworkspaceId = string;
+export type PersonalApiToken = {
+    /**
+     * The API token string
+     */
+    token: string;
+    /**
+     * When the token was created
+     */
+    createdDate: string;
+};
+/**
+ * Component element structure
+ */
+export type PlasmicElement = {
+    type?: 'component' | 'box' | 'vbox' | 'hbox' | 'text';
+    /**
+     * Component name (for type=component)
+     */
+    name?: string;
+    /**
+     * Component props/arguments
+     */
+    props?: {
+        [key: string]: unknown;
+    };
+    /**
+     * CSS styles
+     */
+    styles?: {
+        [key: string]: unknown;
+    };
+    children?: PlasmicElement | Array<PlasmicElement>;
+};
+export type type2 = 'component' | 'box' | 'vbox' | 'hbox' | 'text';
+export type SelfResponse = {
+    user?: ApiUser;
+};
+export type StarterProject = {
+    name?: string;
+    projectId?: string;
+    baseProjectId?: string;
+    tag?: string;
+    description?: string;
+    imageUrl?: string;
+    publishedUrl?: string;
+    withDropShadow?: boolean;
+    cloneWithoutName?: boolean;
+    globalContextConfigs?: Array<{
+        [key: string]: unknown;
+    }>;
+};
+export type StarterSection = {
+    title?: string;
+    tag?: string;
+    projects?: Array<StarterProject>;
+    infoTooltip?: string;
+    docsUrl?: string;
+    moreUrl?: string;
+    isPlasmicOnly?: boolean;
+};
+export type TrustedHostsListResponse = {
+    trustedHosts: Array<ApiTrustedHost>;
+};
+export type UpdateDatabaseRequest = {
+    name?: string;
+    extraData?: CmsDatabaseExtraData;
+};
+export type UpdateGlobalContextRequest = {
+    /**
+     * Global context component name (e.g., "plasmic-commerce-elastic-path-provider")
+     */
+    name: string;
+    /**
+     * Props to update on the global context
+     */
+    props: {
+        [key: string]: unknown;
+    };
+};
+export type UpdateHostUrlRequest = {
+    /**
+     * The host URL for app hosting (e.g., https://my-app.com/plasmic-host)
+     */
+    hostUrl?: string | null;
+    /**
+     * Branch ID to update the host URL for (null for main branch)
+     */
+    branchId?: string | null;
+};
+export type UpdateHostUrlResponse = {
+    hostUrl?: string | null;
+    branchId?: string | null;
+    updatedAt?: string;
+};
+export type UpdateProjectDataRequest = {
+    /**
+     * New components to create
+     */
+    newComponents?: Array<ComponentUpdateRequest>;
+    /**
+     * Existing components to update (matched by name or byUuid)
+     */
+    updateComponents?: Array<ComponentUpdateRequest>;
+    /**
+     * Global context providers to update
+     */
+    updateGlobalContexts?: Array<UpdateGlobalContextRequest>;
+    /**
+     * Branch ID to update (null for main branch)
+     */
+    branchId?: string;
+};
+export type UpdateProjectDataResponse = {
+    result?: {
+        newComponents?: Array<{
+            uuid?: string;
+            name?: string;
+            path?: string;
+        }>;
+        regeneratedSecretApiToken?: string;
+    };
+    warnings?: Array<{
+        message?: string;
+    }>;
+};
+export type UpdateProjectRequest = {
+    name?: string;
+    workspaceId?: string;
+    inviteOnly?: boolean;
+    defaultAccessLevel?: GrantableAccessLevel;
+    readableByPublic?: boolean;
+    isUserStarter?: boolean;
+    regenerateSecretApiToken?: boolean;
+};
+export type UpdateProjectResponse = {
+    paywall?: 'pass' | 'block';
+    project?: ApiProject;
+    perms?: Array<ApiPermission>;
+    owner?: ApiUser;
+    latestRevisionSynced?: number;
+    regeneratedSecretApiToken?: string;
+};
+export type paywall2 = 'pass' | 'block';
+export type UpdateWorkspaceRequest = {
+    name?: string;
+    description?: string;
+    teamId?: string;
+    contentCreatorConfig?: {
+        [key: string]: unknown;
+    };
+};
+export type GetCsrfTokenResponse = CsrfResponse;
+export type GetCsrfTokenError = unknown;
+export type LoginData = {
+    body: LoginRequest;
+};
+export type LoginResponse2 = LoginResponse;
+export type LoginError = ApiError;
+export type LogoutResponse = unknown;
+export type LogoutError = unknown;
+export type GetCurrentUserResponse = SelfResponse;
+export type GetCurrentUserError = ApiError;
+export type GetAppConfigResponse = AppConfigResponse;
+export type GetAppConfigError = unknown;
+export type ListProjectsData = {
+    query: {
+        /**
+         * Required when query=byIds (can be repeated)
+         */
+        projectIds?: Array<string>;
+        query: 'all' | 'byWorkspace' | 'byIds';
+        /**
+         * Required when query=byWorkspace
+         */
+        workspaceId?: string;
+    };
+};
+export type ListProjectsResponse2 = ListProjectsResponse;
+export type ListProjectsError = unknown;
+export type CreateProjectData = {
+    body: CreateProjectRequest;
+};
+export type CreateProjectResponse2 = CreateProjectResponse;
+export type CreateProjectError = unknown;
+export type GetProjectData = {
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+    query?: {
+        /**
+         * Skip bundle migration
+         */
+        dontMigrateProject?: boolean;
+        /**
+         * Specific revision ID to fetch
+         */
+        revisionId?: string;
+        /**
+         * Specific revision number to fetch
+         */
+        revisionNum?: number;
+    };
+};
+export type GetProjectResponse2 = GetProjectResponse;
+export type GetProjectError = ApiError;
+export type UpdateProjectData = {
+    body: UpdateProjectRequest;
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type UpdateProjectResponse2 = UpdateProjectResponse;
+export type UpdateProjectError = unknown;
+export type DeleteProjectData = {
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type DeleteProjectResponse = DeleteResponse;
+export type DeleteProjectError = unknown;
+export type CloneProjectData = {
+    body?: CloneProjectRequest;
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type CloneProjectResponse2 = CloneProjectResponse;
+export type CloneProjectError = unknown;
+export type ClonePublishedTemplateData = {
+    body?: CloneProjectRequest;
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type ClonePublishedTemplateResponse = CloneProjectResponse;
+export type ClonePublishedTemplateError = unknown;
+export type UpdateHostUrlData = {
+    body: UpdateHostUrlRequest;
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type UpdateHostUrlResponse2 = UpdateHostUrlResponse;
+export type UpdateHostUrlError = unknown;
+export type UpdateProjectDataData = {
+    body: UpdateProjectDataRequest;
+    path: {
+        /**
+         * Project ID
+         */
+        projectId: string;
+    };
+};
+export type UpdateProjectDataResponse2 = UpdateProjectDataResponse;
+export type UpdateProjectDataError = unknown;
+export type ListWorkspacesResponse2 = ListWorkspacesResponse;
+export type ListWorkspacesError = unknown;
+export type CreateWorkspaceData = {
+    body: CreateWorkspaceRequest;
+};
+export type CreateWorkspaceResponse2 = CreateWorkspaceResponse;
+export type CreateWorkspaceError = unknown;
+export type GetWorkspaceData = {
+    path: {
+        /**
+         * Workspace ID
+         */
+        workspaceId: string;
+    };
+};
+export type GetWorkspaceResponse2 = GetWorkspaceResponse;
+export type GetWorkspaceError = unknown;
+export type UpdateWorkspaceData = {
+    body: UpdateWorkspaceRequest;
+    path: {
+        /**
+         * Workspace ID
+         */
+        workspaceId: string;
+    };
+};
+export type UpdateWorkspaceResponse = CreateWorkspaceResponse;
+export type UpdateWorkspaceError = unknown;
+export type DeleteWorkspaceData = {
+    path: {
+        /**
+         * Workspace ID
+         */
+        workspaceId: string;
+    };
+};
+export type DeleteWorkspaceResponse = DeleteResponse;
+export type DeleteWorkspaceError = unknown;
+export type GetPersonalWorkspaceResponse = GetWorkspaceResponse;
+export type GetPersonalWorkspaceError = unknown;
+export type ListDatabasesData = {
+    query?: {
+        /**
+         * Team ID to list databases for all workspaces in the team
+         */
+        teamId?: string;
+        /**
+         * Workspace ID to list databases for
+         */
+        workspaceId?: string;
+    };
+};
+export type ListDatabasesResponse2 = ListDatabasesResponse;
+export type ListDatabasesError = ApiError;
+export type CreateDatabaseData = {
+    body: CreateDatabaseRequest;
+};
+export type CreateDatabaseResponse = ApiCmsDatabase;
+export type CreateDatabaseError = unknown;
+export type GetDatabaseData = {
+    path: {
+        /**
+         * CMS Database ID
+         */
+        databaseId: string;
+    };
+    query?: {
+        /**
+         * Include archived tables
+         */
+        includeArchived?: boolean;
+    };
+};
+export type GetDatabaseResponse = ApiCmsDatabase;
+export type GetDatabaseError = ApiError;
+export type UpdateDatabaseData = {
+    body: UpdateDatabaseRequest;
+    path: {
+        /**
+         * CMS Database ID
+         */
+        databaseId: string;
+    };
+};
+export type UpdateDatabaseResponse = ApiCmsDatabase;
+export type UpdateDatabaseError = unknown;
+export type DeleteDatabaseData = {
+    path: {
+        /**
+         * CMS Database ID
+         */
+        databaseId: string;
+    };
+};
+export type DeleteDatabaseResponse = DeleteResponse;
+export type DeleteDatabaseError = unknown;
+export type CloneDatabaseData = {
+    body?: CloneDatabaseRequest;
+    path: {
+        /**
+         * CMS Database ID
+         */
+        databaseId: string;
+    };
+};
+export type CloneDatabaseResponse = ApiCmsDatabase;
+export type CloneDatabaseError = unknown;
+export type ListPersonalApiTokensResponse2 = ListPersonalApiTokensResponse;
+export type ListPersonalApiTokensError = unknown;
+export type CreatePersonalApiTokenResponse2 = CreatePersonalApiTokenResponse;
+export type CreatePersonalApiTokenError = unknown;
+export type RevokePersonalApiTokenData = {
+    path: {
+        /**
+         * The token string to revoke
+         */
+        token: string;
+    };
+};
+export type RevokePersonalApiTokenResponse = {
+    [key: string]: unknown;
+};
+export type RevokePersonalApiTokenError = ApiError;
+export type ListTrustedHostsResponse = TrustedHostsListResponse;
+export type ListTrustedHostsError = unknown;
+export type AddTrustedHostData = {
+    body: AddTrustedHostRequest;
+};
+export type AddTrustedHostResponse = {
+    [key: string]: unknown;
+};
+export type AddTrustedHostError = unknown;
+export type DeleteTrustedHostData = {
+    path: {
+        /**
+         * Trusted host ID to delete
+         */
+        trustedHostId: string;
+    };
+};
+export type DeleteTrustedHostResponse = {
+    [key: string]: unknown;
+};
+export type DeleteTrustedHostError = ApiError;
+export type AdminListProjectsData = {
+    body?: AdminListProjectsRequest;
+};
+export type AdminListProjectsResponse2 = AdminListProjectsResponse;
+export type AdminListProjectsError = ApiError;
+export type AdminCloneProjectData = {
+    body: AdminCloneRequest;
+};
+export type AdminCloneProjectResponse = AdminCloneResponse;
+export type AdminCloneProjectError = unknown;
+export type AdminDeleteProjectData = {
+    body: AdminDeleteProjectRequest;
+};
+export type AdminDeleteProjectResponse = {
+    [key: string]: unknown;
+};
+export type AdminDeleteProjectError = unknown;
+export type AdminRestoreProjectData = {
+    body: AdminRestoreProjectRequest;
+};
+export type AdminRestoreProjectResponse = {
+    [key: string]: unknown;
+};
+export type AdminRestoreProjectError = unknown;
+export type AdminChangeProjectOwnerData = {
+    body: AdminChangeOwnerRequest;
+};
+export type AdminChangeProjectOwnerResponse = {
+    [key: string]: unknown;
+};
+export type AdminChangeProjectOwnerError = unknown;
+export type AdminRevertRevisionData = {
+    body: AdminRevertRevisionRequest;
+};
+export type AdminRevertRevisionResponse = AdminCloneResponse;
+export type AdminRevertRevisionError = unknown;
+//# sourceMappingURL=types.gen.d.ts.map