@storyblok/management-api-client 0.2.1 → 0.2.3

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

@@ -0,0 +1,95 @@
+import { client } from "./client.gen.mjs";
+
+//#region src/generated/presets/sdk.gen.ts
+/**
+* Retrieve Multiple Presets
+*
+* Returns an array of preset objects.
+*/
+const list = (options) => (options.client ?? client).get({
+	security: [{
+		name: "Authorization",
+		type: "apiKey"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v1/spaces/{space_id}/presets",
+	...options
+});
+/**
+* Create a Preset
+*
+* This endpoint can be used to create new presets.
+*/
+const create = (options) => (options.client ?? client).post({
+	security: [{
+		name: "Authorization",
+		type: "apiKey"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v1/spaces/{space_id}/presets",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+/**
+* Delete a Preset
+*
+* Delete a preset by using its numeric id.
+*/
+const delete_ = (options) => (options.client ?? client).delete({
+	security: [{
+		name: "Authorization",
+		type: "apiKey"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v1/spaces/{space_id}/presets/{preset_id}",
+	...options
+});
+/**
+* Retrieve a Single Preset
+*
+* Returns a single preset object with a specific numeric id.
+*/
+const get = (options) => (options.client ?? client).get({
+	security: [{
+		name: "Authorization",
+		type: "apiKey"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v1/spaces/{space_id}/presets/{preset_id}",
+	...options
+});
+/**
+* Update a Preset
+*
+* This endpoint can be used to update presets using the numeric ID.
+*/
+const update = (options) => (options.client ?? client).put({
+	security: [{
+		name: "Authorization",
+		type: "apiKey"
+	}, {
+		scheme: "bearer",
+		type: "http"
+	}],
+	url: "/v1/spaces/{space_id}/presets/{preset_id}",
+	...options,
+	headers: {
+		"Content-Type": "application/json",
+		...options.headers
+	}
+});
+
+//#endregion
+export { create, delete_, get, list, update };
+//# sourceMappingURL=sdk.gen.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.gen.mjs","names":[],"sources":["../../../src/generated/presets/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Client, Options as Options2, TDataShape } from '../shared/client';\nimport { client } from './client.gen';\nimport type { CreateData, CreateErrors, CreateResponses, DeleteData, DeleteErrors, DeleteResponses, GetData, GetErrors, GetResponses, ListData, ListErrors, ListResponses, UpdateData, UpdateErrors, UpdateResponses } from './types.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<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\n/**\n * Retrieve Multiple Presets\n *\n * Returns an array of preset objects.\n */\nexport const list = <ThrowOnError extends boolean = false>(options: Options<ListData, ThrowOnError>) => (options.client ?? client).get<ListResponses, ListErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/presets',\n    ...options\n});\n\n/**\n * Create a Preset\n *\n * This endpoint can be used to create new presets.\n */\nexport const create = <ThrowOnError extends boolean = false>(options: Options<CreateData, ThrowOnError>) => (options.client ?? client).post<CreateResponses, CreateErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/presets',\n    ...options,\n    headers: {\n        'Content-Type': 'application/json',\n        ...options.headers\n    }\n});\n\n/**\n * Delete a Preset\n *\n * Delete a preset by using its numeric id.\n */\nexport const delete_ = <ThrowOnError extends boolean = false>(options: Options<DeleteData, ThrowOnError>) => (options.client ?? client).delete<DeleteResponses, DeleteErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/presets/{preset_id}',\n    ...options\n});\n\n/**\n * Retrieve a Single Preset\n *\n * Returns a single preset object with a specific numeric id.\n */\nexport const get = <ThrowOnError extends boolean = false>(options: Options<GetData, ThrowOnError>) => (options.client ?? client).get<GetResponses, GetErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/presets/{preset_id}',\n    ...options\n});\n\n/**\n * Update a Preset\n *\n * This endpoint can be used to update presets using the numeric ID.\n */\nexport const update = <ThrowOnError extends boolean = false>(options: Options<UpdateData, ThrowOnError>) => (options.client ?? client).put<UpdateResponses, UpdateErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/presets/{preset_id}',\n    ...options,\n    headers: {\n        'Content-Type': 'application/json',\n        ...options.headers\n    }\n});\n"],"mappings":";;;;;;;;AAyBA,MAAa,QAA8C,aAA8C,QAAQ,UAAU,QAAQ,IAA6C;CAC5K,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAU,QAAQ,KAAkD;CACrL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC;;;;;;AAOF,MAAa,WAAiD,aAAgD,QAAQ,UAAU,QAAQ,OAAoD;CACxL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,OAA6C,aAA6C,QAAQ,UAAU,QAAQ,IAA2C;CACxK,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;;;AAOF,MAAa,UAAgD,aAAgD,QAAQ,UAAU,QAAQ,IAAiD;CACpL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC"}

package/dist/generated/presets/types.gen.d.cts

@@ -1,6 +1,4 @@
-declare namespace types_gen_d_exports {
-  export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses };
-}
+//#region src/generated/presets/types.gen.d.ts
 /**
  * A Preset Object representing a content preset
  */
@@ -16,7 +14,7 @@ type Preset = {
   /**
    * Fields of the component filled with content
    */
-  preset: {
+  preset?: {
     [key: string]: unknown;
   };
   /**
@@ -53,13 +51,40 @@ type Preset = {
   description?: string;
 };
 /**
- * The ID of the Storyblok space (can be integer or string)
- */
-type SpaceId = number | string;
-/**
- * The ID of your preset (can be integer or string)
+ * A Preset Object representing a content preset
  */
-type PresetId = number | string;
+type PresetWritable = {
+  /**
+   * Given name of your preset
+   */
+  name: string;
+  /**
+   * Fields of the component filled with content
+   */
+  preset?: {
+    [key: string]: unknown;
+  };
+  /**
+   * The ID of the component the preset is for
+   */
+  component_id: number;
+  /**
+   * Screenshot or other preview image for your editor
+   */
+  image?: string;
+  /**
+   * Color of the preset icon
+   */
+  color?: string;
+  /**
+   * Icon of the preset
+   */
+  icon?: string;
+  /**
+   * A description of the preset for the editors
+   */
+  description?: string;
+};
 type ListData = {
   body?: never;
   path: {
@@ -76,39 +101,17 @@ type ListData = {
   };
   url: '/v1/spaces/{space_id}/presets';
 };
-type ListErrors = {
-  /**
-   * Bad request
-   */
-  400: {
-    error?: string;
-  };
-  /**
-   * Unauthorized
-   */
-  401: {
-    error?: string;
-  };
-  /**
-   * Resource not found
-   */
-  404: {
-    error?: string;
-  };
-};
-type ListError = ListErrors[keyof ListErrors];
 type ListResponses = {
   /**
    * Successfully retrieved presets
    */
   200: {
-    presets?: Array<Preset>;
+    presets: Array<Preset>;
   };
 };
-type ListResponse = ListResponses[keyof ListResponses];
 type CreateData = {
   body: {
-    preset?: Preset;
+    preset?: PresetWritable;
   };
   path: {
     /**
@@ -119,27 +122,6 @@ type CreateData = {
   query?: never;
   url: '/v1/spaces/{space_id}/presets';
 };
-type CreateErrors = {
-  /**
-   * Bad request
-   */
-  400: {
-    error?: string;
-  };
-  /**
-   * Unauthorized
-   */
-  401: {
-    error?: string;
-  };
-  /**
-   * Resource not found
-   */
-  404: {
-    error?: string;
-  };
-};
-type CreateError = CreateErrors[keyof CreateErrors];
 type CreateResponses = {
   /**
    * Successfully created preset
@@ -148,43 +130,6 @@ type CreateResponses = {
     preset?: Preset;
   };
 };
-type CreateResponse = CreateResponses[keyof CreateResponses];
-type DeleteData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of your preset (can be integer or string)
-     */
-    preset_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/presets/{preset_id}';
-};
-type DeleteErrors = {
-  /**
-   * Bad request
-   */
-  400: {
-    error?: string;
-  };
-  /**
-   * Unauthorized
-   */
-  401: {
-    error?: string;
-  };
-  /**
-   * Resource not found
-   */
-  404: {
-    error?: string;
-  };
-};
-type DeleteError = DeleteErrors[keyof DeleteErrors];
 type DeleteResponses = {
   /**
    * Successfully deleted preset
@@ -193,43 +138,6 @@ type DeleteResponses = {
     preset?: Preset;
   };
 };
-type DeleteResponse = DeleteResponses[keyof DeleteResponses];
-type GetData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-    /**
-     * The ID of your preset (can be integer or string)
-     */
-    preset_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}/presets/{preset_id}';
-};
-type GetErrors = {
-  /**
-   * Bad request
-   */
-  400: {
-    error?: string;
-  };
-  /**
-   * Unauthorized
-   */
-  401: {
-    error?: string;
-  };
-  /**
-   * Resource not found
-   */
-  404: {
-    error?: string;
-  };
-};
-type GetError = GetErrors[keyof GetErrors];
 type GetResponses = {
   /**
    * Successfully retrieved preset
@@ -238,10 +146,9 @@ type GetResponses = {
     preset?: Preset;
   };
 };
-type GetResponse = GetResponses[keyof GetResponses];
 type UpdateData = {
   body: {
-    preset?: Preset;
+    preset?: PresetWritable;
   };
   path: {
     /**
@@ -256,27 +163,6 @@ type UpdateData = {
   query?: never;
   url: '/v1/spaces/{space_id}/presets/{preset_id}';
 };
-type UpdateErrors = {
-  /**
-   * Bad request
-   */
-  400: {
-    error?: string;
-  };
-  /**
-   * Unauthorized
-   */
-  401: {
-    error?: string;
-  };
-  /**
-   * Resource not found
-   */
-  404: {
-    error?: string;
-  };
-};
-type UpdateError = UpdateErrors[keyof UpdateErrors];
 type UpdateResponses = {
   /**
    * Successfully updated preset
@@ -285,10 +171,6 @@ type UpdateResponses = {
     preset?: Preset;
   };
 };
-type UpdateResponse = UpdateResponses[keyof UpdateResponses];
-type ClientOptions = {
-  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblokchina.cn' | (string & {});
-};
 //#endregion
-export { ClientOptions, CreateData, CreateError, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteError, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetError, GetErrors, GetResponse, GetResponses, ListData, ListError, ListErrors, ListResponse, ListResponses, Preset, PresetId, SpaceId, UpdateData, UpdateError, UpdateErrors, UpdateResponse, UpdateResponses, types_gen_d_exports };
+export { CreateData, CreateResponses, DeleteResponses, GetResponses, ListData, ListResponses, Preset, UpdateData, UpdateResponses };
 //# sourceMappingURL=types.gen.d.cts.map

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

@@ -0,0 +1,176 @@
+//#region src/generated/presets/types.gen.d.ts
+/**
+ * A Preset Object representing a content preset
+ */
+type Preset = {
+  /**
+   * Numeric ID of your preset
+   */
+  readonly id: number;
+  /**
+   * Given name of your preset
+   */
+  name: string;
+  /**
+   * Fields of the component filled with content
+   */
+  preset?: {
+    [key: string]: unknown;
+  };
+  /**
+   * The ID of the component the preset is for
+   */
+  component_id: number;
+  /**
+   * Numeric ID of a space
+   */
+  readonly space_id?: number;
+  /**
+   * Creation date
+   */
+  readonly created_at?: string;
+  /**
+   * Latest update date
+   */
+  readonly updated_at?: string;
+  /**
+   * Screenshot or other preview image for your editor
+   */
+  image?: string;
+  /**
+   * Color of the preset icon
+   */
+  color?: string;
+  /**
+   * Icon of the preset
+   */
+  icon?: string;
+  /**
+   * A description of the preset for the editors
+   */
+  description?: string;
+};
+/**
+ * A Preset Object representing a content preset
+ */
+type PresetWritable = {
+  /**
+   * Given name of your preset
+   */
+  name: string;
+  /**
+   * Fields of the component filled with content
+   */
+  preset?: {
+    [key: string]: unknown;
+  };
+  /**
+   * The ID of the component the preset is for
+   */
+  component_id: number;
+  /**
+   * Screenshot or other preview image for your editor
+   */
+  image?: string;
+  /**
+   * Color of the preset icon
+   */
+  color?: string;
+  /**
+   * Icon of the preset
+   */
+  icon?: string;
+  /**
+   * A description of the preset for the editors
+   */
+  description?: string;
+};
+type ListData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * Filter presets by component ID
+     */
+    component_id?: number;
+  };
+  url: '/v1/spaces/{space_id}/presets';
+};
+type ListResponses = {
+  /**
+   * Successfully retrieved presets
+   */
+  200: {
+    presets: Array<Preset>;
+  };
+};
+type CreateData = {
+  body: {
+    preset?: PresetWritable;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/presets';
+};
+type CreateResponses = {
+  /**
+   * Successfully created preset
+   */
+  201: {
+    preset?: Preset;
+  };
+};
+type DeleteResponses = {
+  /**
+   * Successfully deleted preset
+   */
+  200: {
+    preset?: Preset;
+  };
+};
+type GetResponses = {
+  /**
+   * Successfully retrieved preset
+   */
+  200: {
+    preset?: Preset;
+  };
+};
+type UpdateData = {
+  body: {
+    preset?: PresetWritable;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The ID of your preset (can be integer or string)
+     */
+    preset_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/presets/{preset_id}';
+};
+type UpdateResponses = {
+  /**
+   * Successfully updated preset
+   */
+  200: {
+    preset?: Preset;
+  };
+};
+//#endregion
+export { CreateData, CreateResponses, DeleteResponses, GetResponses, ListData, ListResponses, Preset, UpdateData, UpdateResponses };
+//# sourceMappingURL=types.gen.d.mts.map