@foru-ms/sdk 2.1.4 → 2.1.5

package/dist/esm/api/resources/provisioning/client/requests/RegisterProvisioningRequest.d.mts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         email: "email",
+ *         password: "password"
+ *     }
+ */
+export interface RegisterProvisioningRequest {
+    /** Email address for the account */
+    email: string;
+    /** Password (minimum 8 characters) */
+    password: string;
+    /** Display name (optional) */
+    name?: string;
+}

package/dist/esm/api/resources/provisioning/client/requests/RegisterProvisioningRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.d.mts

@@ -0,0 +1,12 @@
+/**
+ * @example
+ *     {
+ *         handle: "handle",
+ *         newOwnerEmail: "newOwnerEmail"
+ *     }
+ */
+export interface TransferOwnershipProvisioningRequest {
+    handle: string;
+    /** Email of the new owner */
+    newOwnerEmail: string;
+}

package/dist/esm/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/client/requests/index.d.mts

@@ -5,15 +5,19 @@ export type { DeleteInstance } from "./DeleteInstance.mjs";
 export type { DeleteWebhookProvisioningRequest } from "./DeleteWebhookProvisioningRequest.mjs";
 export type { ExportDataProvisioningRequest } from "./ExportDataProvisioningRequest.mjs";
 export type { GetBillingProvisioningRequest } from "./GetBillingProvisioningRequest.mjs";
+export type { GetOwnershipProvisioningRequest } from "./GetOwnershipProvisioningRequest.mjs";
 export type { GetUsageProvisioningRequest } from "./GetUsageProvisioningRequest.mjs";
 export { InviteTeamProvisioningRequest } from "./InviteTeamProvisioningRequest.mjs";
 export type { ListDomainsProvisioningRequest } from "./ListDomainsProvisioningRequest.mjs";
 export type { ListProvisioningRequest } from "./ListProvisioningRequest.mjs";
 export type { ListTeamProvisioningRequest } from "./ListTeamProvisioningRequest.mjs";
 export type { ListWebhooksProvisioningRequest } from "./ListWebhooksProvisioningRequest.mjs";
+export type { LoginProvisioningRequest } from "./LoginProvisioningRequest.mjs";
 export type { RegenerateApiKeyProvisioningRequest } from "./RegenerateApiKeyProvisioningRequest.mjs";
+export type { RegisterProvisioningRequest } from "./RegisterProvisioningRequest.mjs";
 export type { RemoveDomainProvisioningRequest } from "./RemoveDomainProvisioningRequest.mjs";
 export type { RemoveTeamMemberProvisioningRequest } from "./RemoveTeamMemberProvisioningRequest.mjs";
+export type { TransferOwnershipProvisioningRequest } from "./TransferOwnershipProvisioningRequest.mjs";
 export type { UpdateInstance } from "./UpdateInstance.mjs";
 export type { UpdateWebhookProvisioningRequest } from "./UpdateWebhookProvisioningRequest.mjs";
 export { UpgradeInstance } from "./UpgradeInstance.mjs";

package/dist/esm/api/resources/provisioning/types/GetOwnershipProvisioningResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as Forum from "../../../index.mjs";
+export interface GetOwnershipProvisioningResponse {
+    data: Forum.OwnershipInfo;
+}

package/dist/esm/api/resources/provisioning/types/GetOwnershipProvisioningResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/types/LoginProvisioningResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as Forum from "../../../index.mjs";
+export interface LoginProvisioningResponse {
+    data: Forum.ProvisioningAuthResponse;
+}

package/dist/esm/api/resources/provisioning/types/LoginProvisioningResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/types/RegisterProvisioningResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as Forum from "../../../index.mjs";
+export interface RegisterProvisioningResponse {
+    data: Forum.ProvisioningAuthResponse;
+}

package/dist/esm/api/resources/provisioning/types/RegisterProvisioningResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.d.mts

@@ -0,0 +1,16 @@
+export interface TransferOwnershipProvisioningResponse {
+    data: TransferOwnershipProvisioningResponse.Data;
+}
+export declare namespace TransferOwnershipProvisioningResponse {
+    interface Data {
+        message: string;
+        instanceId: string;
+        newOwner: Data.NewOwner;
+    }
+    namespace Data {
+        interface NewOwner {
+            id: string;
+            email: string;
+        }
+    }
+}

package/dist/esm/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/provisioning/types/index.d.mts

@@ -6,14 +6,18 @@ export * from "./DeleteProvisioningResponse.mjs";
 export * from "./DeleteWebhookProvisioningResponse.mjs";
 export * from "./ExportDataProvisioningResponse.mjs";
 export * from "./GetBillingProvisioningResponse.mjs";
+export * from "./GetOwnershipProvisioningResponse.mjs";
 export * from "./GetUsageProvisioningResponse.mjs";
 export * from "./InviteTeamProvisioningResponse.mjs";
 export * from "./ListDomainsProvisioningResponse.mjs";
 export * from "./ListProvisioningResponse.mjs";
 export * from "./ListTeamProvisioningResponse.mjs";
 export * from "./ListWebhooksProvisioningResponse.mjs";
+export * from "./LoginProvisioningResponse.mjs";
 export * from "./RegenerateApiKeyProvisioningResponse.mjs";
+export * from "./RegisterProvisioningResponse.mjs";
 export * from "./RemoveDomainProvisioningResponse.mjs";
 export * from "./RemoveTeamMemberProvisioningResponse.mjs";
+export * from "./TransferOwnershipProvisioningResponse.mjs";
 export * from "./UpdateProvisioningResponse.mjs";
 export * from "./UpdateWebhookProvisioningResponse.mjs";

package/dist/esm/api/resources/provisioning/types/index.mjs

@@ -6,14 +6,18 @@ export * from "./DeleteProvisioningResponse.mjs";
 export * from "./DeleteWebhookProvisioningResponse.mjs";
 export * from "./ExportDataProvisioningResponse.mjs";
 export * from "./GetBillingProvisioningResponse.mjs";
+export * from "./GetOwnershipProvisioningResponse.mjs";
 export * from "./GetUsageProvisioningResponse.mjs";
 export * from "./InviteTeamProvisioningResponse.mjs";
 export * from "./ListDomainsProvisioningResponse.mjs";
 export * from "./ListProvisioningResponse.mjs";
 export * from "./ListTeamProvisioningResponse.mjs";
 export * from "./ListWebhooksProvisioningResponse.mjs";
+export * from "./LoginProvisioningResponse.mjs";
 export * from "./RegenerateApiKeyProvisioningResponse.mjs";
+export * from "./RegisterProvisioningResponse.mjs";
 export * from "./RemoveDomainProvisioningResponse.mjs";
 export * from "./RemoveTeamMemberProvisioningResponse.mjs";
+export * from "./TransferOwnershipProvisioningResponse.mjs";
 export * from "./UpdateProvisioningResponse.mjs";
 export * from "./UpdateWebhookProvisioningResponse.mjs";

package/dist/esm/api/types/ConflictErrorBody.d.mts

@@ -0,0 +1,13 @@
+export interface ConflictErrorBody {
+    errors: ConflictErrorBody.Errors;
+}
+export declare namespace ConflictErrorBody {
+    interface Errors {
+        error: Errors.Error_;
+    }
+    namespace Errors {
+        interface Error_ {
+            msg: string;
+        }
+    }
+}

package/dist/esm/api/types/ConflictErrorBody.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/OwnershipInfo.d.mts

@@ -0,0 +1,18 @@
+export interface OwnershipInfo {
+    handle: string;
+    owner: OwnershipInfo.Owner;
+    creator: OwnershipInfo.Creator;
+    isCurrentUserOwner: boolean;
+}
+export declare namespace OwnershipInfo {
+    interface Owner {
+        id: string;
+        email: string;
+        name?: string;
+    }
+    interface Creator {
+        id: string;
+        email: string;
+        name?: string;
+    }
+}

package/dist/esm/api/types/OwnershipInfo.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ProvisioningAuthResponse.d.mts

@@ -0,0 +1,5 @@
+export interface ProvisioningAuthResponse {
+    provisioningKey: string;
+    userId: string;
+    email: string;
+}

package/dist/esm/api/types/ProvisioningAuthResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -2,6 +2,7 @@ export * from "./Auth.mjs";
 export * from "./AuthListResponse.mjs";
 export * from "./AuthResponse.mjs";
 export * from "./BillingInfo.mjs";
+export * from "./ConflictErrorBody.mjs";
 export * from "./ErrorResponse.mjs";
 export * from "./ForgotPasswordResponse.mjs";
 export * from "./Instance.mjs";
@@ -22,6 +23,7 @@ export * from "./NotificationList.mjs";
 export * from "./NotificationListResponse.mjs";
 export * from "./NotificationResponse.mjs";
 export * from "./NotificationUpdate.mjs";
+export * from "./OwnershipInfo.mjs";
 export * from "./Post.mjs";
 export * from "./PostCreate.mjs";
 export * from "./PostList.mjs";
@@ -45,6 +47,7 @@ export * from "./PrivateMessageReplyListResponse.mjs";
 export * from "./PrivateMessageReplyResponse.mjs";
 export * from "./PrivateMessageResponse.mjs";
 export * from "./PrivateMessageUpdate.mjs";
+export * from "./ProvisioningAuthResponse.mjs";
 export * from "./RegisterResponse.mjs";
 export * from "./Report.mjs";
 export * from "./ReportCreate.mjs";

package/dist/esm/api/types/index.mjs

@@ -2,6 +2,7 @@ export * from "./Auth.mjs";
 export * from "./AuthListResponse.mjs";
 export * from "./AuthResponse.mjs";
 export * from "./BillingInfo.mjs";
+export * from "./ConflictErrorBody.mjs";
 export * from "./ErrorResponse.mjs";
 export * from "./ForgotPasswordResponse.mjs";
 export * from "./Instance.mjs";
@@ -22,6 +23,7 @@ export * from "./NotificationList.mjs";
 export * from "./NotificationListResponse.mjs";
 export * from "./NotificationResponse.mjs";
 export * from "./NotificationUpdate.mjs";
+export * from "./OwnershipInfo.mjs";
 export * from "./Post.mjs";
 export * from "./PostCreate.mjs";
 export * from "./PostList.mjs";
@@ -45,6 +47,7 @@ export * from "./PrivateMessageReplyListResponse.mjs";
 export * from "./PrivateMessageReplyResponse.mjs";
 export * from "./PrivateMessageResponse.mjs";
 export * from "./PrivateMessageUpdate.mjs";
+export * from "./ProvisioningAuthResponse.mjs";
 export * from "./RegisterResponse.mjs";
 export * from "./Report.mjs";
 export * from "./ReportCreate.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.1.4";
+export declare const SDK_VERSION = "2.1.5";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.1.4";
+export const SDK_VERSION = "2.1.5";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@foru-ms/sdk",
-    "version": "2.1.4",
+    "version": "2.1.5",
     "private": false,
     "repository": {
         "type": "git",

package/reference.md

@@ -7244,6 +7244,269 @@ await client.provisioning.deleteWebhook({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.provisioning.<a href="/src/api/resources/provisioning/client/Client.ts">getOwnership</a>({ ...params }) -> Forum.GetOwnershipProvisioningResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve owner and creator information for an instance.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.provisioning.getOwnership({
+    handle: "handle"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.GetOwnershipProvisioningRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProvisioningClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.provisioning.<a href="/src/api/resources/provisioning/client/Client.ts">transferOwnership</a>({ ...params }) -> Forum.TransferOwnershipProvisioningResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Transfer instance ownership to another user. Only the current owner can transfer ownership.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.provisioning.transferOwnership({
+    handle: "handle",
+    newOwnerEmail: "newOwnerEmail"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.TransferOwnershipProvisioningRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProvisioningClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.provisioning.<a href="/src/api/resources/provisioning/client/Client.ts">register</a>({ ...params }) -> Forum.RegisterProvisioningResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new account and receive a provisioning key for API access. Use this key to create and manage instances.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.provisioning.register({
+    email: "email",
+    password: "password"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.RegisterProvisioningRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProvisioningClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.provisioning.<a href="/src/api/resources/provisioning/client/Client.ts">login</a>({ ...params }) -> Forum.LoginProvisioningResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Login with email and password to retrieve your provisioning key.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.provisioning.login({
+    email: "email",
+    password: "password"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Forum.LoginProvisioningRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ProvisioningClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>