@foru-ms/sdk 2.1.2 → 2.1.4

package/dist/cjs/api/resources/provisioning/client/Client.d.ts

@@ -0,0 +1,359 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Forum from "../../../index.js";
+export declare namespace ProvisioningClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Platform-level instance management using your provisioning key
+ */
+export declare class ProvisioningClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ProvisioningClient.Options>;
+    constructor(options: ProvisioningClient.Options);
+    /**
+     * Retrieve all instances owned by the authenticated user. Use the `handle` query parameter to get a single instance with its API key.
+     *
+     * @param {Forum.ListProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.list()
+     */
+    list(request?: Forum.ListProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ListProvisioningResponse>;
+    private __list;
+    /**
+     * Create a new forum instance. Returns the instance details including the API key for accessing the forum API.
+     *
+     * @param {Forum.CreateInstance} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.create({
+     *         name: "name",
+     *         handle: "handle"
+     *     })
+     */
+    create(request: Forum.CreateInstance, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.CreateProvisioningResponse>;
+    private __create;
+    /**
+     * Update an instance's name or handle. The `handle` field identifies which instance to update.
+     *
+     * @param {Forum.UpdateInstance} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.update({
+     *         handle: "handle"
+     *     })
+     */
+    update(request: Forum.UpdateInstance, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.UpdateProvisioningResponse>;
+    private __update;
+    /**
+     * Permanently delete an instance. This action cannot be undone.
+     *
+     * @param {Forum.DeleteInstance} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.delete({
+     *         handle: "handle"
+     *     })
+     */
+    delete(request: Forum.DeleteInstance, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteProvisioningResponse>;
+    private __delete;
+    /**
+     * Retrieve billing and subscription information for an instance.
+     *
+     * @param {Forum.GetBillingProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.getBilling({
+     *         handle: "handle"
+     *     })
+     */
+    getBilling(request: Forum.GetBillingProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.GetBillingProvisioningResponse>;
+    private __getBilling;
+    /**
+     * Change an instance's subscription plan. Returns a checkout URL for upgrades or a billing portal URL for downgrades.
+     *
+     * @param {Forum.UpgradeInstance} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.changePlan({
+     *         handle: "handle",
+     *         plan: "FREE"
+     *     })
+     */
+    changePlan(request: Forum.UpgradeInstance, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ChangePlanProvisioningResponse>;
+    private __changePlan;
+    /**
+     * Generate a new API key for the instance. The old key will be invalidated.
+     *
+     * @param {Forum.RegenerateApiKeyProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.regenerateApiKey({
+     *         handle: "handle"
+     *     })
+     */
+    regenerateApiKey(request: Forum.RegenerateApiKeyProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.RegenerateApiKeyProvisioningResponse>;
+    private __regenerateApiKey;
+    /**
+     * Retrieve usage statistics for an instance including API requests, storage, and content counts.
+     *
+     * @param {Forum.GetUsageProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.getUsage({
+     *         handle: "handle"
+     *     })
+     */
+    getUsage(request: Forum.GetUsageProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.GetUsageProvisioningResponse>;
+    private __getUsage;
+    /**
+     * Retrieve all team members for an instance.
+     *
+     * @param {Forum.ListTeamProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.listTeam({
+     *         handle: "handle"
+     *     })
+     */
+    listTeam(request: Forum.ListTeamProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ListTeamProvisioningResponse>;
+    private __listTeam;
+    /**
+     * Invite new team members to an instance.
+     *
+     * @param {Forum.InviteTeamProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.inviteTeam({
+     *         handle: "handle",
+     *         members: [{
+     *                 email: "email"
+     *             }]
+     *     })
+     */
+    inviteTeam(request: Forum.InviteTeamProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.InviteTeamProvisioningResponse>;
+    private __inviteTeam;
+    /**
+     * Remove a team member from an instance.
+     *
+     * @param {Forum.RemoveTeamMemberProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.removeTeamMember({
+     *         handle: "handle",
+     *         email: "email"
+     *     })
+     */
+    removeTeamMember(request: Forum.RemoveTeamMemberProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.RemoveTeamMemberProvisioningResponse>;
+    private __removeTeamMember;
+    /**
+     * Retrieve all custom domains for an instance.
+     *
+     * @param {Forum.ListDomainsProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.listDomains({
+     *         handle: "handle"
+     *     })
+     */
+    listDomains(request: Forum.ListDomainsProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ListDomainsProvisioningResponse>;
+    private __listDomains;
+    /**
+     * Add a custom domain to an instance.
+     *
+     * @param {Forum.AddDomainProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.addDomain({
+     *         handle: "handle",
+     *         name: "name"
+     *     })
+     */
+    addDomain(request: Forum.AddDomainProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.AddDomainProvisioningResponse>;
+    private __addDomain;
+    /**
+     * Remove a custom domain from an instance.
+     *
+     * @param {Forum.RemoveDomainProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.removeDomain({
+     *         handle: "handle",
+     *         name: "name"
+     *     })
+     */
+    removeDomain(request: Forum.RemoveDomainProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.RemoveDomainProvisioningResponse>;
+    private __removeDomain;
+    /**
+     * Export all data from an instance including threads, posts, users, tags, etc.
+     *
+     * @param {Forum.ExportDataProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.exportData({
+     *         handle: "handle"
+     *     })
+     */
+    exportData(request: Forum.ExportDataProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ExportDataProvisioningResponse>;
+    private __exportData;
+    /**
+     * Retrieve all webhooks configured for an instance.
+     *
+     * @param {Forum.ListWebhooksProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.listWebhooks({
+     *         handle: "handle"
+     *     })
+     */
+    listWebhooks(request: Forum.ListWebhooksProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.ListWebhooksProvisioningResponse>;
+    private __listWebhooks;
+    /**
+     * Create a new webhook for an instance.
+     *
+     * @param {Forum.CreateWebhookProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.createWebhook({
+     *         handle: "handle",
+     *         url: "url",
+     *         events: ["events"]
+     *     })
+     */
+    createWebhook(request: Forum.CreateWebhookProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.CreateWebhookProvisioningResponse>;
+    private __createWebhook;
+    /**
+     * Update an existing webhook.
+     *
+     * @param {Forum.UpdateWebhookProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.updateWebhook({
+     *         handle: "handle",
+     *         webhookId: "webhookId"
+     *     })
+     */
+    updateWebhook(request: Forum.UpdateWebhookProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.UpdateWebhookProvisioningResponse>;
+    private __updateWebhook;
+    /**
+     * Delete a webhook from an instance.
+     *
+     * @param {Forum.DeleteWebhookProvisioningRequest} request
+     * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Forum.BadRequestError}
+     * @throws {@link Forum.UnauthorizedError}
+     * @throws {@link Forum.NotFoundError}
+     * @throws {@link Forum.InternalServerError}
+     *
+     * @example
+     *     await client.provisioning.deleteWebhook({
+     *         handle: "handle",
+     *         webhookId: "webhookId"
+     *     })
+     */
+    deleteWebhook(request: Forum.DeleteWebhookProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteWebhookProvisioningResponse>;
+    private __deleteWebhook;
+}