@storyblok/management-api-client 0.1.0 → 0.1.2

package/dist/generated/users/core/types.d.ts

@@ -0,0 +1,78 @@
+import { Auth, AuthToken } from "./auth.js";
+import { BodySerializer, QuerySerializer, QuerySerializerOptions } from "./bodySerializer.js";
+
+//#region src/generated/users/core/types.d.ts
+interface Client<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never> {
+  /**
+   * Returns the final request URL.
+   */
+  buildUrl: BuildUrlFn;
+  connect: MethodFn;
+  delete: MethodFn;
+  get: MethodFn;
+  getConfig: () => Config;
+  head: MethodFn;
+  options: MethodFn;
+  patch: MethodFn;
+  post: MethodFn;
+  put: MethodFn;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+  trace: MethodFn;
+}
+interface Config {
+  /**
+   * Auth token or a function returning auth token. The resolved value will be
+   * added to the request payload as defined by its `security` array.
+   */
+  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+  /**
+   * A function for serializing request body parameter. By default,
+   * {@link JSON.stringify()} will be used.
+   */
+  bodySerializer?: BodySerializer | null;
+  /**
+   * An object containing any HTTP headers that you want to pre-populate your
+   * `Headers` object with.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+   */
+  headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+  /**
+   * The request method.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+   */
+  method?: 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * This method will have no effect if the native `paramsSerializer()` Axios
+   * API function is used.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function transforming response data before it's returned. This is useful
+   * for post-processing data, e.g. converting ISO strings into Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function validating response data. This is useful if you want to ensure
+   * the response conforms to the desired shape, so it can be safely passed to
+   * the transformers and returned to the user.
+   */
+  responseValidator?: (data: unknown) => Promise<unknown>;
+}
+//#endregion
+export { Client, Config };
+//# sourceMappingURL=types.d.ts.map

package/dist/generated/users/sdk.gen.d.mts

@@ -0,0 +1,38 @@
+import { MeData, MeErrors, MeResponses, UpdateMeData, UpdateMeErrors, UpdateMeResponses } from "./types.gen.mjs";
+import { Client, Options, RequestResult, TDataShape } from "./client/types.mjs";
+
+//#region src/generated/users/sdk.gen.d.ts
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
+};
+declare class _HeyApiClient {
+  protected _client: Client;
+  constructor(args?: {
+    client?: Client;
+  });
+}
+declare class Sdk extends _HeyApiClient {
+  /**
+   * Get Current User
+   * Returns the current authenticated user's information.
+   */
+  me<ThrowOnError extends boolean = false>(options?: Options$1<MeData, ThrowOnError>): RequestResult<MeResponses, MeErrors, ThrowOnError, "fields">;
+  /**
+   * Update Current User
+   * Update the current authenticated user's information.
+   */
+  updateMe<ThrowOnError extends boolean = false>(options: Options$1<UpdateMeData, ThrowOnError>): RequestResult<UpdateMeResponses, UpdateMeErrors, ThrowOnError, "fields">;
+}
+//#endregion
+export { Sdk };
+//# sourceMappingURL=sdk.gen.d.mts.map

package/dist/generated/users/sdk.gen.d.ts

@@ -0,0 +1,38 @@
+import { MeData, MeErrors, MeResponses, UpdateMeData, UpdateMeErrors, UpdateMeResponses } from "./types.gen.js";
+import { Client, Options, RequestResult, TDataShape } from "./client/types.js";
+
+//#region src/generated/users/sdk.gen.d.ts
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
+};
+declare class _HeyApiClient {
+  protected _client: Client;
+  constructor(args?: {
+    client?: Client;
+  });
+}
+declare class Sdk extends _HeyApiClient {
+  /**
+   * Get Current User
+   * Returns the current authenticated user's information.
+   */
+  me<ThrowOnError extends boolean = false>(options?: Options$1<MeData, ThrowOnError>): RequestResult<MeResponses, MeErrors, ThrowOnError, "fields">;
+  /**
+   * Update Current User
+   * Update the current authenticated user's information.
+   */
+  updateMe<ThrowOnError extends boolean = false>(options: Options$1<UpdateMeData, ThrowOnError>): RequestResult<UpdateMeResponses, UpdateMeErrors, ThrowOnError, "fields">;
+}
+//#endregion
+export { Sdk };
+//# sourceMappingURL=sdk.gen.d.ts.map

package/dist/generated/users/sdk.gen.js

@@ -0,0 +1,53 @@
+const require_client_gen = require('./client.gen.js');
+
+//#region src/generated/users/sdk.gen.ts
+var _HeyApiClient = class {
+	_client = require_client_gen.client;
+	constructor(args) {
+		if (args?.client) this._client = args.client;
+	}
+};
+var Sdk = class extends _HeyApiClient {
+	/**
+	* Get Current User
+	* Returns the current authenticated user's information.
+	*/
+	me(options) {
+		return (options?.client ?? this._client).get({
+			security: [{
+				name: "Authorization",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/users/me",
+			...options
+		});
+	}
+	/**
+	* Update Current User
+	* Update the current authenticated user's information.
+	*/
+	updateMe(options) {
+		return (options.client ?? this._client).put({
+			security: [{
+				name: "Authorization",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/users/me",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options.headers
+			}
+		});
+	}
+};
+
+//#endregion
+exports.Sdk = Sdk;
+//# sourceMappingURL=sdk.gen.js.map

package/dist/generated/users/sdk.gen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.gen.js","names":["_heyApiClient","args?: {\n        client?: Client;\n    }","options?: Options<MeData, ThrowOnError>","options: Options<UpdateMeData, ThrowOnError>"],"sources":["../../../src/generated/users/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Options as ClientOptions, TDataShape, Client } from './client';\nimport type { MeData, MeResponses, MeErrors, UpdateMeData, UpdateMeResponses, UpdateMeErrors } from './types.gen';\nimport { client as _heyApiClient } from './client.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {\n    /**\n     * You can provide a client instance returned by `createClient()` instead of\n     * individual options. This might be also useful if you want to implement a\n     * custom client.\n     */\n    client?: Client;\n    /**\n     * You can pass arbitrary values through the `meta` object. This can be\n     * used to access values that aren't defined as part of the SDK function.\n     */\n    meta?: Record<string, unknown>;\n};\n\nclass _HeyApiClient {\n    protected _client: Client = _heyApiClient;\n    \n    constructor(args?: {\n        client?: Client;\n    }) {\n        if (args?.client) {\n            this._client = args.client;\n        }\n    }\n}\n\nexport class Sdk extends _HeyApiClient {\n    /**\n     * Get Current User\n     * Returns the current authenticated user's information.\n     */\n    public me<ThrowOnError extends boolean = false>(options?: Options<MeData, ThrowOnError>) {\n        return (options?.client ?? this._client).get<MeResponses, MeErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/users/me',\n            ...options\n        });\n    }\n    \n    /**\n     * Update Current User\n     * Update the current authenticated user's information.\n     */\n    public updateMe<ThrowOnError extends boolean = false>(options: Options<UpdateMeData, ThrowOnError>) {\n        return (options.client ?? this._client).put<UpdateMeResponses, UpdateMeErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/users/me',\n            ...options,\n            headers: {\n                'Content-Type': 'application/json',\n                ...options.headers\n            }\n        });\n    }\n}"],"mappings":";;;AAoBA,IAAM,gBAAN,MAAoB;CAChB,AAAU,UAAkBA;CAE5B,YAAYC,MAET;AACC,MAAI,MAAM,QACN,KAAK,UAAU,KAAK;CAE3B;AACJ;AAED,IAAa,MAAb,cAAyB,cAAc;;;;;CAKnC,AAAO,GAAyCC,SAAyC;AACrF,UAAQ,SAAS,UAAU,KAAK,SAAS,IAAyC;GAC9E,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;EACN,EAAC;CACL;;;;;CAMD,AAAO,SAA+CC,SAA8C;AAChG,UAAQ,QAAQ,UAAU,KAAK,SAAS,IAAqD;GACzF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;GACH,SAAS;IACL,gBAAgB;IAChB,GAAG,QAAQ;GACd;EACJ,EAAC;CACL;AACJ"}

package/dist/generated/users/sdk.gen.mjs

@@ -0,0 +1,53 @@
+import { client } from "./client.gen.mjs";
+
+//#region src/generated/users/sdk.gen.ts
+var _HeyApiClient = class {
+	_client = client;
+	constructor(args) {
+		if (args?.client) this._client = args.client;
+	}
+};
+var Sdk = class extends _HeyApiClient {
+	/**
+	* Get Current User
+	* Returns the current authenticated user's information.
+	*/
+	me(options) {
+		return (options?.client ?? this._client).get({
+			security: [{
+				name: "Authorization",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/users/me",
+			...options
+		});
+	}
+	/**
+	* Update Current User
+	* Update the current authenticated user's information.
+	*/
+	updateMe(options) {
+		return (options.client ?? this._client).put({
+			security: [{
+				name: "Authorization",
+				type: "apiKey"
+			}, {
+				scheme: "bearer",
+				type: "http"
+			}],
+			url: "/v1/users/me",
+			...options,
+			headers: {
+				"Content-Type": "application/json",
+				...options.headers
+			}
+		});
+	}
+};
+
+//#endregion
+export { Sdk };
+//# sourceMappingURL=sdk.gen.mjs.map

package/dist/generated/users/sdk.gen.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.gen.mjs","names":["_heyApiClient","args?: {\n        client?: Client;\n    }","options?: Options<MeData, ThrowOnError>","options: Options<UpdateMeData, ThrowOnError>"],"sources":["../../../src/generated/users/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Options as ClientOptions, TDataShape, Client } from './client';\nimport type { MeData, MeResponses, MeErrors, UpdateMeData, UpdateMeResponses, UpdateMeErrors } from './types.gen';\nimport { client as _heyApiClient } from './client.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {\n    /**\n     * You can provide a client instance returned by `createClient()` instead of\n     * individual options. This might be also useful if you want to implement a\n     * custom client.\n     */\n    client?: Client;\n    /**\n     * You can pass arbitrary values through the `meta` object. This can be\n     * used to access values that aren't defined as part of the SDK function.\n     */\n    meta?: Record<string, unknown>;\n};\n\nclass _HeyApiClient {\n    protected _client: Client = _heyApiClient;\n    \n    constructor(args?: {\n        client?: Client;\n    }) {\n        if (args?.client) {\n            this._client = args.client;\n        }\n    }\n}\n\nexport class Sdk extends _HeyApiClient {\n    /**\n     * Get Current User\n     * Returns the current authenticated user's information.\n     */\n    public me<ThrowOnError extends boolean = false>(options?: Options<MeData, ThrowOnError>) {\n        return (options?.client ?? this._client).get<MeResponses, MeErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/users/me',\n            ...options\n        });\n    }\n    \n    /**\n     * Update Current User\n     * Update the current authenticated user's information.\n     */\n    public updateMe<ThrowOnError extends boolean = false>(options: Options<UpdateMeData, ThrowOnError>) {\n        return (options.client ?? this._client).put<UpdateMeResponses, UpdateMeErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/users/me',\n            ...options,\n            headers: {\n                'Content-Type': 'application/json',\n                ...options.headers\n            }\n        });\n    }\n}"],"mappings":";;;AAoBA,IAAM,gBAAN,MAAoB;CAChB,AAAU,UAAkBA;CAE5B,YAAYC,MAET;AACC,MAAI,MAAM,QACN,KAAK,UAAU,KAAK;CAE3B;AACJ;AAED,IAAa,MAAb,cAAyB,cAAc;;;;;CAKnC,AAAO,GAAyCC,SAAyC;AACrF,UAAQ,SAAS,UAAU,KAAK,SAAS,IAAyC;GAC9E,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;EACN,EAAC;CACL;;;;;CAMD,AAAO,SAA+CC,SAA8C;AAChG,UAAQ,QAAQ,UAAU,KAAK,SAAS,IAAqD;GACzF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;GACH,SAAS;IACL,gBAAgB;IAChB,GAAG,QAAQ;GACd;EACJ,EAAC;CACL;AACJ"}

package/dist/generated/users/types.gen.d.mts

@@ -0,0 +1,235 @@
+declare namespace types_gen_d_exports {
+  export { ClientOptions, MeData, MeErrors, MeResponse, MeResponses, UpdateMeData, UpdateMeErrors, UpdateMeResponse, UpdateMeResponses, User };
+}
+/**
+ * The User Object
+ */
+type User = {
+  /**
+   * User ID
+   */
+  readonly id: number;
+  /**
+   * User's email address
+   */
+  email: string;
+  /**
+   * User's alternative email address
+   */
+  alt_email?: string;
+  /**
+   * User's first name
+   */
+  firstname?: string;
+  /**
+   * User's last name
+   */
+  lastname?: string;
+  /**
+   * User's username
+   */
+  username?: string;
+  /**
+   * User's avatar URL
+   */
+  avatar?: string;
+  /**
+   * User's preferred language
+   */
+  lang?: string;
+  /**
+   * User's timezone
+   */
+  timezone?: string;
+  /**
+   * User's phone number
+   */
+  phone?: string;
+  /**
+   * Whether user is an editor
+   */
+  is_editor?: boolean;
+  /**
+   * User's job role
+   */
+  job_role?: string;
+  /**
+   * User's job title
+   */
+  job_title?: string;
+  /**
+   * User's company name
+   */
+  company_name?: string;
+  /**
+   * User's company size
+   */
+  company_size?: string;
+  /**
+   * User's usage type
+   */
+  usage_type?: string;
+  /**
+   * Framework used by user
+   */
+  framework_used?: string;
+  /**
+   * Whether user is a beta user
+   */
+  beta_user?: boolean;
+  /**
+   * Whether user allows statistics tracking
+   */
+  track_statistics?: boolean;
+  /**
+   * User's UI theme preferences
+   */
+  ui_theme?: {
+    [key: string]: unknown;
+  };
+  /**
+   * User's favorite spaces
+   */
+  favourite_spaces?: Array<number>;
+  /**
+   * User's favorite ideas
+   */
+  favourite_ideas?: Array<number>;
+  /**
+   * User's notification preferences
+   */
+  notified?: Array<string>;
+  /**
+   * User's disclaimer IDs
+   */
+  disclaimer_ids?: Array<number>;
+  /**
+   * Whether the user belongs to an organization
+   */
+  has_org?: boolean;
+  /**
+   * Whether the user has an approved partner status
+   */
+  has_partner?: boolean;
+  /**
+   * Partner status (e.g., 'approved')
+   */
+  partner_status?: string;
+  /**
+   * User's role in the organization (admin, owner, member)
+   */
+  org_role?: string;
+  /**
+   * User's role as a partner (partner_owner, partner_member)
+   */
+  partner_role?: string;
+  /**
+   * Organization information
+   */
+  org?: {
+    /**
+     * Organization settings
+     */
+    settings?: {
+      [key: string]: unknown;
+    };
+    /**
+     * Organization name
+     */
+    name?: string;
+    /**
+     * Organization status
+     */
+    status?: string;
+  };
+  /**
+   * User's system role (admin, normal, banned, sso, superuser, devops, marketer)
+   */
+  role?: string;
+  /**
+   * Whether the user uses SSO authentication
+   */
+  sso?: boolean;
+  /**
+   * Whether TOTP factor is verified
+   */
+  totp_factor_verified?: boolean;
+  /**
+   * Configured two-factor authentication options
+   */
+  configured_2fa_options?: Array<string>;
+  /**
+   * Whether live chat is enabled for the user
+   */
+  live_chat_enabled?: boolean;
+  /**
+   * User-friendly display name for the user, shown in interfaces or reports to identify the user in a readable way.
+   */
+  friendly_name?: string;
+  /**
+   * User creation date
+   */
+  created_at: string;
+  /**
+   * User last update date
+   */
+  updated_at: string;
+};
+type MeData = {
+  body?: never;
+  path?: never;
+  query?: never;
+  url: '/v1/users/me';
+};
+type MeErrors = {
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+};
+type MeResponses = {
+  /**
+   * Current user details
+   */
+  200: {
+    user?: User;
+  };
+};
+type MeResponse = MeResponses[keyof MeResponses];
+type UpdateMeData = {
+  body: {
+    user: User;
+  };
+  path?: never;
+  query?: never;
+  url: '/v1/users/me';
+};
+type UpdateMeErrors = {
+  /**
+   * Bad request
+   */
+  400: unknown;
+  /**
+   * Unauthorized
+   */
+  401: unknown;
+  /**
+   * Unprocessable entity - validation errors
+   */
+  422: unknown;
+};
+type UpdateMeResponses = {
+  /**
+   * User updated
+   */
+  200: {
+    user?: User;
+  };
+};
+type UpdateMeResponse = UpdateMeResponses[keyof UpdateMeResponses];
+type ClientOptions = {
+  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});
+};
+//#endregion
+export { ClientOptions, MeData, MeErrors, MeResponse, MeResponses, UpdateMeData, UpdateMeErrors, UpdateMeResponse, UpdateMeResponses, User, types_gen_d_exports };
+//# sourceMappingURL=types.gen.d.mts.map