@foru-ms/sdk 2.1.4 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/errors/ConflictError.d.ts +6 -0
  3. package/dist/cjs/api/errors/ConflictError.js +54 -0
  4. package/dist/cjs/api/errors/ForbiddenError.d.ts +6 -0
  5. package/dist/cjs/api/errors/ForbiddenError.js +54 -0
  6. package/dist/cjs/api/errors/index.d.ts +2 -0
  7. package/dist/cjs/api/errors/index.js +2 -0
  8. package/dist/cjs/api/resources/provisioning/client/Client.d.ts +72 -0
  9. package/dist/cjs/api/resources/provisioning/client/Client.js +295 -38
  10. package/dist/cjs/api/resources/provisioning/client/requests/GetOwnershipProvisioningRequest.d.ts +10 -0
  11. package/dist/cjs/api/resources/provisioning/client/requests/GetOwnershipProvisioningRequest.js +3 -0
  12. package/dist/cjs/api/resources/provisioning/client/requests/LoginProvisioningRequest.d.ts +13 -0
  13. package/dist/cjs/api/resources/provisioning/client/requests/LoginProvisioningRequest.js +3 -0
  14. package/dist/cjs/api/resources/provisioning/client/requests/RegisterProvisioningRequest.d.ts +15 -0
  15. package/dist/cjs/api/resources/provisioning/client/requests/RegisterProvisioningRequest.js +3 -0
  16. package/dist/cjs/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.d.ts +12 -0
  17. package/dist/cjs/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.js +3 -0
  18. package/dist/cjs/api/resources/provisioning/client/requests/index.d.ts +4 -0
  19. package/dist/cjs/api/resources/provisioning/types/GetOwnershipProvisioningResponse.d.ts +4 -0
  20. package/dist/cjs/api/resources/provisioning/types/GetOwnershipProvisioningResponse.js +3 -0
  21. package/dist/cjs/api/resources/provisioning/types/LoginProvisioningResponse.d.ts +4 -0
  22. package/dist/cjs/api/resources/provisioning/types/LoginProvisioningResponse.js +3 -0
  23. package/dist/cjs/api/resources/provisioning/types/RegisterProvisioningResponse.d.ts +4 -0
  24. package/dist/cjs/api/resources/provisioning/types/RegisterProvisioningResponse.js +3 -0
  25. package/dist/cjs/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.d.ts +16 -0
  26. package/dist/cjs/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.js +3 -0
  27. package/dist/cjs/api/resources/provisioning/types/index.d.ts +4 -0
  28. package/dist/cjs/api/resources/provisioning/types/index.js +4 -0
  29. package/dist/cjs/api/types/ConflictErrorBody.d.ts +13 -0
  30. package/dist/cjs/api/types/ConflictErrorBody.js +3 -0
  31. package/dist/cjs/api/types/OwnershipInfo.d.ts +18 -0
  32. package/dist/cjs/api/types/OwnershipInfo.js +3 -0
  33. package/dist/cjs/api/types/ProvisioningAuthResponse.d.ts +5 -0
  34. package/dist/cjs/api/types/ProvisioningAuthResponse.js +3 -0
  35. package/dist/cjs/api/types/index.d.ts +3 -0
  36. package/dist/cjs/api/types/index.js +3 -0
  37. package/dist/cjs/version.d.ts +1 -1
  38. package/dist/cjs/version.js +1 -1
  39. package/dist/esm/BaseClient.mjs +2 -2
  40. package/dist/esm/api/errors/ConflictError.d.mts +6 -0
  41. package/dist/esm/api/errors/ConflictError.mjs +17 -0
  42. package/dist/esm/api/errors/ForbiddenError.d.mts +6 -0
  43. package/dist/esm/api/errors/ForbiddenError.mjs +17 -0
  44. package/dist/esm/api/errors/index.d.mts +2 -0
  45. package/dist/esm/api/errors/index.mjs +2 -0
  46. package/dist/esm/api/resources/provisioning/client/Client.d.mts +72 -0
  47. package/dist/esm/api/resources/provisioning/client/Client.mjs +295 -38
  48. package/dist/esm/api/resources/provisioning/client/requests/GetOwnershipProvisioningRequest.d.mts +10 -0
  49. package/dist/esm/api/resources/provisioning/client/requests/GetOwnershipProvisioningRequest.mjs +2 -0
  50. package/dist/esm/api/resources/provisioning/client/requests/LoginProvisioningRequest.d.mts +13 -0
  51. package/dist/esm/api/resources/provisioning/client/requests/LoginProvisioningRequest.mjs +2 -0
  52. package/dist/esm/api/resources/provisioning/client/requests/RegisterProvisioningRequest.d.mts +15 -0
  53. package/dist/esm/api/resources/provisioning/client/requests/RegisterProvisioningRequest.mjs +2 -0
  54. package/dist/esm/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.d.mts +12 -0
  55. package/dist/esm/api/resources/provisioning/client/requests/TransferOwnershipProvisioningRequest.mjs +2 -0
  56. package/dist/esm/api/resources/provisioning/client/requests/index.d.mts +4 -0
  57. package/dist/esm/api/resources/provisioning/types/GetOwnershipProvisioningResponse.d.mts +4 -0
  58. package/dist/esm/api/resources/provisioning/types/GetOwnershipProvisioningResponse.mjs +2 -0
  59. package/dist/esm/api/resources/provisioning/types/LoginProvisioningResponse.d.mts +4 -0
  60. package/dist/esm/api/resources/provisioning/types/LoginProvisioningResponse.mjs +2 -0
  61. package/dist/esm/api/resources/provisioning/types/RegisterProvisioningResponse.d.mts +4 -0
  62. package/dist/esm/api/resources/provisioning/types/RegisterProvisioningResponse.mjs +2 -0
  63. package/dist/esm/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.d.mts +16 -0
  64. package/dist/esm/api/resources/provisioning/types/TransferOwnershipProvisioningResponse.mjs +2 -0
  65. package/dist/esm/api/resources/provisioning/types/index.d.mts +4 -0
  66. package/dist/esm/api/resources/provisioning/types/index.mjs +4 -0
  67. package/dist/esm/api/types/ConflictErrorBody.d.mts +13 -0
  68. package/dist/esm/api/types/ConflictErrorBody.mjs +2 -0
  69. package/dist/esm/api/types/OwnershipInfo.d.mts +18 -0
  70. package/dist/esm/api/types/OwnershipInfo.mjs +2 -0
  71. package/dist/esm/api/types/ProvisioningAuthResponse.d.mts +5 -0
  72. package/dist/esm/api/types/ProvisioningAuthResponse.mjs +2 -0
  73. package/dist/esm/api/types/index.d.mts +3 -0
  74. package/dist/esm/api/types/index.mjs +3 -0
  75. package/dist/esm/version.d.mts +1 -1
  76. package/dist/esm/version.mjs +1 -1
  77. package/package.json +1 -1
  78. package/reference.md +263 -0
@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
43
43
  const headers = (0, headers_js_1.mergeHeaders)({
44
44
  "X-Fern-Language": "JavaScript",
45
45
  "X-Fern-SDK-Name": "@foru-ms/sdk",
46
- "X-Fern-SDK-Version": "2.1.4",
47
- "User-Agent": "@foru-ms/sdk/2.1.4",
46
+ "X-Fern-SDK-Version": "2.1.5",
47
+ "User-Agent": "@foru-ms/sdk/2.1.5",
48
48
  "X-Fern-Runtime": core.RUNTIME.type,
49
49
  "X-Fern-Runtime-Version": core.RUNTIME.version,
50
50
  "x-provisioning-key": options === null || options === void 0 ? void 0 : options.provisioningKey,
@@ -0,0 +1,6 @@
1
+ import type * as core from "../../core/index.js";
2
+ import * as errors from "../../errors/index.js";
3
+ import type * as Forum from "../index.js";
4
+ export declare class ConflictError extends errors.ForumError {
5
+ constructor(body: Forum.ConflictErrorBody, rawResponse?: core.RawResponse);
6
+ }
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.ConflictError = void 0;
38
+ const errors = __importStar(require("../../errors/index.js"));
39
+ class ConflictError extends errors.ForumError {
40
+ constructor(body, rawResponse) {
41
+ super({
42
+ message: "ConflictError",
43
+ statusCode: 409,
44
+ body: body,
45
+ rawResponse: rawResponse,
46
+ });
47
+ Object.setPrototypeOf(this, new.target.prototype);
48
+ if (Error.captureStackTrace) {
49
+ Error.captureStackTrace(this, this.constructor);
50
+ }
51
+ this.name = this.constructor.name;
52
+ }
53
+ }
54
+ exports.ConflictError = ConflictError;
@@ -0,0 +1,6 @@
1
+ import type * as core from "../../core/index.js";
2
+ import * as errors from "../../errors/index.js";
3
+ import type * as Forum from "../index.js";
4
+ export declare class ForbiddenError extends errors.ForumError {
5
+ constructor(body: Forum.ErrorResponse, rawResponse?: core.RawResponse);
6
+ }
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.ForbiddenError = void 0;
38
+ const errors = __importStar(require("../../errors/index.js"));
39
+ class ForbiddenError extends errors.ForumError {
40
+ constructor(body, rawResponse) {
41
+ super({
42
+ message: "ForbiddenError",
43
+ statusCode: 403,
44
+ body: body,
45
+ rawResponse: rawResponse,
46
+ });
47
+ Object.setPrototypeOf(this, new.target.prototype);
48
+ if (Error.captureStackTrace) {
49
+ Error.captureStackTrace(this, this.constructor);
50
+ }
51
+ this.name = this.constructor.name;
52
+ }
53
+ }
54
+ exports.ForbiddenError = ForbiddenError;
@@ -1,4 +1,6 @@
1
1
  export * from "./BadRequestError.js";
2
+ export * from "./ConflictError.js";
3
+ export * from "./ForbiddenError.js";
2
4
  export * from "./InternalServerError.js";
3
5
  export * from "./NotFoundError.js";
4
6
  export * from "./PaymentRequiredError.js";
@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestError.js"), exports);
18
+ __exportStar(require("./ConflictError.js"), exports);
19
+ __exportStar(require("./ForbiddenError.js"), exports);
18
20
  __exportStar(require("./InternalServerError.js"), exports);
19
21
  __exportStar(require("./NotFoundError.js"), exports);
20
22
  __exportStar(require("./PaymentRequiredError.js"), exports);
@@ -356,4 +356,76 @@ export declare class ProvisioningClient {
356
356
  */
357
357
  deleteWebhook(request: Forum.DeleteWebhookProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.DeleteWebhookProvisioningResponse>;
358
358
  private __deleteWebhook;
359
+ /**
360
+ * Retrieve owner and creator information for an instance.
361
+ *
362
+ * @param {Forum.GetOwnershipProvisioningRequest} request
363
+ * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
364
+ *
365
+ * @throws {@link Forum.UnauthorizedError}
366
+ * @throws {@link Forum.ForbiddenError}
367
+ * @throws {@link Forum.NotFoundError}
368
+ * @throws {@link Forum.InternalServerError}
369
+ *
370
+ * @example
371
+ * await client.provisioning.getOwnership({
372
+ * handle: "handle"
373
+ * })
374
+ */
375
+ getOwnership(request: Forum.GetOwnershipProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.GetOwnershipProvisioningResponse>;
376
+ private __getOwnership;
377
+ /**
378
+ * Transfer instance ownership to another user. Only the current owner can transfer ownership.
379
+ *
380
+ * @param {Forum.TransferOwnershipProvisioningRequest} request
381
+ * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
382
+ *
383
+ * @throws {@link Forum.BadRequestError}
384
+ * @throws {@link Forum.UnauthorizedError}
385
+ * @throws {@link Forum.NotFoundError}
386
+ * @throws {@link Forum.InternalServerError}
387
+ *
388
+ * @example
389
+ * await client.provisioning.transferOwnership({
390
+ * handle: "handle",
391
+ * newOwnerEmail: "newOwnerEmail"
392
+ * })
393
+ */
394
+ transferOwnership(request: Forum.TransferOwnershipProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.TransferOwnershipProvisioningResponse>;
395
+ private __transferOwnership;
396
+ /**
397
+ * Create a new account and receive a provisioning key for API access. Use this key to create and manage instances.
398
+ *
399
+ * @param {Forum.RegisterProvisioningRequest} request
400
+ * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
401
+ *
402
+ * @throws {@link Forum.BadRequestError}
403
+ * @throws {@link Forum.ConflictError}
404
+ * @throws {@link Forum.InternalServerError}
405
+ *
406
+ * @example
407
+ * await client.provisioning.register({
408
+ * email: "email",
409
+ * password: "password"
410
+ * })
411
+ */
412
+ register(request: Forum.RegisterProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.RegisterProvisioningResponse>;
413
+ private __register;
414
+ /**
415
+ * Login with email and password to retrieve your provisioning key.
416
+ *
417
+ * @param {Forum.LoginProvisioningRequest} request
418
+ * @param {ProvisioningClient.RequestOptions} requestOptions - Request-specific configuration.
419
+ *
420
+ * @throws {@link Forum.UnauthorizedError}
421
+ * @throws {@link Forum.InternalServerError}
422
+ *
423
+ * @example
424
+ * await client.provisioning.login({
425
+ * email: "email",
426
+ * password: "password"
427
+ * })
428
+ */
429
+ login(request: Forum.LoginProvisioningRequest, requestOptions?: ProvisioningClient.RequestOptions): core.HttpResponsePromise<Forum.LoginProvisioningResponse>;
430
+ private __login;
359
431
  }