freescout-help-desk-freescout

Namespace

freescout-help-desk-freescout

Description:

  • Discover FreeScout, the ultimate self-hosted help desk solution. Enjoy robust features akin to Zendesk & Help Scout without conceding privacy or control. Fully customizable, mobile-friendly, and free!

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createFreescoutHelpDeskFreescoutInstance(context, body) → {FreescoutHelpDeskFreescout}

Description:

  • Create a new FreeScout instance

Example
import { Context } from '@osaas/client-core';
import { createFreescoutHelpDeskFreescoutInstance } from '@osaas/client-services';

const ctx = new Context();
const body: FreescoutHelpDeskFreescoutConfig = { name: 'myinstance', ... };
const instance = await createFreescoutHelpDeskFreescoutInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body FreescoutHelpDeskFreescoutConfig

Service instance configuration
Returns:
  • Service instance
Type
FreescoutHelpDeskFreescout

(async, static) getFreescoutHelpDeskFreescoutInstance(context, name) → {FreescoutHelpDeskFreescout}

Description:

  • Get a FreeScout instance

Example
import { Context } from '@osaas/client-core';
import { getFreescoutHelpDeskFreescoutInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getFreescoutHelpDeskFreescoutInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the freescout to be retrieved
Returns:
  • Service instance
Type
FreescoutHelpDeskFreescout

(async, static) removeFreescoutHelpDeskFreescoutInstance(context, name)

Description:

  • Remove a FreeScout instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the freescout to be removed