@osaas/client-services 0.14.0 → 0.15.0

package/lib/generated/oss-apps-dynamic-og.js

@@ -0,0 +1,88 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOssAppsDynamicOgInstance = exports.removeOssAppsDynamicOgInstance = exports.createOssAppsDynamicOgInstance = void 0;
+const client_core_1 = require("@osaas/client-core");
+/**
+ * @namespace oss-apps-dynamic-og
+ * @description Instantly enhance your content with Dynamic OG's AI-powered dynamic Open Graph images! Save time on design, and choose from weekly template updates to keep your website visually engaging and fresh.
+ * @author Eyevinn Technology AB <osc@eyevinn.se>
+ * @copyright 2026 Eyevinn Technology AB
+ *
+ */
+/**
+ * @typedef {Object} OssAppsDynamicOgConfig
+ * @property {string} name - Name of dynamic-og
+ * @property {string} [nextBeamAnalyticsId] - Configuration ID for Beam Analytics integration to track website usage and performance metrics for your Dynamic OG application
+ * @property {string} [nextDocsAiId] - Configuration ID for DocsAI chatbot integration to enhance user interaction and provide automated assistance within your Dynamic OG application
+
+ *
+ */
+/**
+ * @typedef {Object} OssAppsDynamicOg
+ * @property {string} name - Name of the Dynamic OG instance
+ * @property {string} url - URL of the Dynamic OG instance
+ *
+ */
+/**
+ * Create a new Dynamic OG instance
+ *
+ * @memberOf oss-apps-dynamic-og
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {OssAppsDynamicOgConfig} body - Service instance configuration
+ * @returns {OssAppsDynamicOg} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { createOssAppsDynamicOgInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const body: OssAppsDynamicOgConfig = { name: 'myinstance', ... };
+ * const instance = await createOssAppsDynamicOgInstance(ctx, body);
+ * console.log(instance.url);
+ */
+async function createOssAppsDynamicOgInstance(ctx, body) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('oss-apps-dynamic-og');
+    const instance = await (0, client_core_1.createInstance)(ctx, 'oss-apps-dynamic-og', serviceAccessToken, body);
+    await (0, client_core_1.waitForInstanceReady)('oss-apps-dynamic-og', instance.name, ctx);
+    return instance;
+}
+exports.createOssAppsDynamicOgInstance = createOssAppsDynamicOgInstance;
+/**
+ * Remove a Dynamic OG instance
+ *
+ * @memberOf oss-apps-dynamic-og
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the dynamic-og to be removed
+ */
+async function removeOssAppsDynamicOgInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('oss-apps-dynamic-og');
+    await (0, client_core_1.removeInstance)(ctx, 'oss-apps-dynamic-og', name, serviceAccessToken);
+}
+exports.removeOssAppsDynamicOgInstance = removeOssAppsDynamicOgInstance;
+/**
+ * Get a Dynamic OG instance
+ *
+ * @memberOf oss-apps-dynamic-og
+ * @async
+ * @param {Context} context - Open Source Cloud configuration context
+ * @param {string} name - Name of the dynamic-og to be retrieved
+ * @returns {OssAppsDynamicOg} - Service instance
+ * @example
+ * import { Context } from '@osaas/client-core';
+ * import { getOssAppsDynamicOgInstance } from '@osaas/client-services';
+ *
+ * const ctx = new Context();
+ * const instance = await getOssAppsDynamicOgInstance(ctx, 'myinstance');
+ * console.log(instance.url);
+ */
+async function getOssAppsDynamicOgInstance(ctx, name) {
+    const serviceAccessToken = await ctx.getServiceAccessToken('oss-apps-dynamic-og');
+    return await (0, client_core_1.getInstance)(ctx, 'oss-apps-dynamic-og', name, serviceAccessToken);
+}
+exports.getOssAppsDynamicOgInstance = getOssAppsDynamicOgInstance;
+//# sourceMappingURL=oss-apps-dynamic-og.js.map

package/lib/generated/oss-apps-dynamic-og.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oss-apps-dynamic-og.js","sourceRoot":"","sources":["../../src/generated/oss-apps-dynamic-og.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA6jBH,oDAM4B;AAC5B;;;;;;GAMG;AAEH;;;;;;;GAOG;AAEH;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,8BAA8B,CAClD,GAAY,EACZ,IAA4B;IAE5B,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,IAAA,4BAAc,EACnC,GAAG,EACH,qBAAqB,EACrB,kBAAkB,EAClB,IAAI,CACL,CAAC;IACF,MAAM,IAAA,kCAAoB,EAAC,qBAAqB,EAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACtE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAfD,wEAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,8BAA8B,CAClD,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,MAAM,IAAA,4BAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;AAC7E,CAAC;AARD,wEAQC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,2BAA2B,CAC/C,GAAY,EACZ,IAAY;IAEZ,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,qBAAqB,CACxD,qBAAqB,CACtB,CAAC;IACF,OAAO,MAAM,IAAA,yBAAW,EACtB,GAAG,EACH,qBAAqB,EACrB,IAAI,EACJ,kBAAkB,CACnB,CAAC;AACJ,CAAC;AAbD,kEAaC"}