@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/src/models/EventMatcherPolicy.ts

@@ -51,37 +51,65 @@ export interface EventMatcherPolicy {
      */
     executionLogging?: boolean;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof EventMatcherPolicy
      */
     readonly metaModelName: string;
     /**
-     * 
+     * Return objects policy is bound to
      * @type {number}
      * @memberof EventMatcherPolicy
      */
     readonly boundTo: number;
     /**
      * Match created events with this action type. When left empty, all action types will be matched.
+     * 
+     * * `login` - Login
+     * * `login_failed` - Login Failed
+     * * `logout` - Logout
+     * * `user_write` - User Write
+     * * `suspicious_request` - Suspicious Request
+     * * `password_set` - Password Set
+     * * `secret_view` - Secret View
+     * * `secret_rotate` - Secret Rotate
+     * * `invitation_used` - Invite Used
+     * * `authorize_application` - Authorize Application
+     * * `source_linked` - Source Linked
+     * * `impersonation_started` - Impersonation Started
+     * * `impersonation_ended` - Impersonation Ended
+     * * `flow_execution` - Flow Execution
+     * * `policy_execution` - Policy Execution
+     * * `policy_exception` - Policy Exception
+     * * `property_mapping_exception` - Property Mapping Exception
+     * * `system_task_execution` - System Task Execution
+     * * `system_task_exception` - System Task Exception
+     * * `system_exception` - System Exception
+     * * `configuration_error` - Configuration Error
+     * * `model_created` - Model Created
+     * * `model_updated` - Model Updated
+     * * `model_deleted` - Model Deleted
+     * * `email_sent` - Email Sent
+     * * `update_available` - Update Available
+     * * `custom_` - Custom Prefix
      * @type {EventActions}
      * @memberof EventMatcherPolicy
      */
@@ -94,6 +122,53 @@ export interface EventMatcherPolicy {
     clientIp?: string;
     /**
      * Match events created by selected application. When left empty, all applications are matched.
+     * 
+     * * `authentik.admin` - authentik Admin
+     * * `authentik.api` - authentik API
+     * * `authentik.crypto` - authentik Crypto
+     * * `authentik.events` - authentik Events
+     * * `authentik.flows` - authentik Flows
+     * * `authentik.lib` - authentik lib
+     * * `authentik.outposts` - authentik Outpost
+     * * `authentik.policies.dummy` - authentik Policies.Dummy
+     * * `authentik.policies.event_matcher` - authentik Policies.Event Matcher
+     * * `authentik.policies.expiry` - authentik Policies.Expiry
+     * * `authentik.policies.expression` - authentik Policies.Expression
+     * * `authentik.policies.password` - authentik Policies.Password
+     * * `authentik.policies.reputation` - authentik Policies.Reputation
+     * * `authentik.policies` - authentik Policies
+     * * `authentik.providers.ldap` - authentik Providers.LDAP
+     * * `authentik.providers.oauth2` - authentik Providers.OAuth2
+     * * `authentik.providers.proxy` - authentik Providers.Proxy
+     * * `authentik.providers.saml` - authentik Providers.SAML
+     * * `authentik.providers.scim` - authentik Providers.SCIM
+     * * `authentik.recovery` - authentik Recovery
+     * * `authentik.sources.ldap` - authentik Sources.LDAP
+     * * `authentik.sources.oauth` - authentik Sources.OAuth
+     * * `authentik.sources.plex` - authentik Sources.Plex
+     * * `authentik.sources.saml` - authentik Sources.SAML
+     * * `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo
+     * * `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS
+     * * `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static
+     * * `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP
+     * * `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate
+     * * `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn
+     * * `authentik.stages.captcha` - authentik Stages.Captcha
+     * * `authentik.stages.consent` - authentik Stages.Consent
+     * * `authentik.stages.deny` - authentik Stages.Deny
+     * * `authentik.stages.dummy` - authentik Stages.Dummy
+     * * `authentik.stages.email` - authentik Stages.Email
+     * * `authentik.stages.identification` - authentik Stages.Identification
+     * * `authentik.stages.invitation` - authentik Stages.User Invitation
+     * * `authentik.stages.password` - authentik Stages.Password
+     * * `authentik.stages.prompt` - authentik Stages.Prompt
+     * * `authentik.stages.user_delete` - authentik Stages.User Delete
+     * * `authentik.stages.user_login` - authentik Stages.User Login
+     * * `authentik.stages.user_logout` - authentik Stages.User Logout
+     * * `authentik.stages.user_write` - authentik Stages.User Write
+     * * `authentik.tenants` - authentik Tenants
+     * * `authentik.blueprints` - authentik Blueprints
+     * * `authentik.core` - authentik Core
      * @type {AppEnum}
      * @memberof EventMatcherPolicy
      */

package/src/models/EventMatcherPolicyRequest.ts

@@ -46,6 +46,34 @@ export interface EventMatcherPolicyRequest {
     executionLogging?: boolean;
     /**
      * Match created events with this action type. When left empty, all action types will be matched.
+     * 
+     * * `login` - Login
+     * * `login_failed` - Login Failed
+     * * `logout` - Logout
+     * * `user_write` - User Write
+     * * `suspicious_request` - Suspicious Request
+     * * `password_set` - Password Set
+     * * `secret_view` - Secret View
+     * * `secret_rotate` - Secret Rotate
+     * * `invitation_used` - Invite Used
+     * * `authorize_application` - Authorize Application
+     * * `source_linked` - Source Linked
+     * * `impersonation_started` - Impersonation Started
+     * * `impersonation_ended` - Impersonation Ended
+     * * `flow_execution` - Flow Execution
+     * * `policy_execution` - Policy Execution
+     * * `policy_exception` - Policy Exception
+     * * `property_mapping_exception` - Property Mapping Exception
+     * * `system_task_execution` - System Task Execution
+     * * `system_task_exception` - System Task Exception
+     * * `system_exception` - System Exception
+     * * `configuration_error` - Configuration Error
+     * * `model_created` - Model Created
+     * * `model_updated` - Model Updated
+     * * `model_deleted` - Model Deleted
+     * * `email_sent` - Email Sent
+     * * `update_available` - Update Available
+     * * `custom_` - Custom Prefix
      * @type {EventActions}
      * @memberof EventMatcherPolicyRequest
      */
@@ -58,6 +86,53 @@ export interface EventMatcherPolicyRequest {
     clientIp?: string;
     /**
      * Match events created by selected application. When left empty, all applications are matched.
+     * 
+     * * `authentik.admin` - authentik Admin
+     * * `authentik.api` - authentik API
+     * * `authentik.crypto` - authentik Crypto
+     * * `authentik.events` - authentik Events
+     * * `authentik.flows` - authentik Flows
+     * * `authentik.lib` - authentik lib
+     * * `authentik.outposts` - authentik Outpost
+     * * `authentik.policies.dummy` - authentik Policies.Dummy
+     * * `authentik.policies.event_matcher` - authentik Policies.Event Matcher
+     * * `authentik.policies.expiry` - authentik Policies.Expiry
+     * * `authentik.policies.expression` - authentik Policies.Expression
+     * * `authentik.policies.password` - authentik Policies.Password
+     * * `authentik.policies.reputation` - authentik Policies.Reputation
+     * * `authentik.policies` - authentik Policies
+     * * `authentik.providers.ldap` - authentik Providers.LDAP
+     * * `authentik.providers.oauth2` - authentik Providers.OAuth2
+     * * `authentik.providers.proxy` - authentik Providers.Proxy
+     * * `authentik.providers.saml` - authentik Providers.SAML
+     * * `authentik.providers.scim` - authentik Providers.SCIM
+     * * `authentik.recovery` - authentik Recovery
+     * * `authentik.sources.ldap` - authentik Sources.LDAP
+     * * `authentik.sources.oauth` - authentik Sources.OAuth
+     * * `authentik.sources.plex` - authentik Sources.Plex
+     * * `authentik.sources.saml` - authentik Sources.SAML
+     * * `authentik.stages.authenticator_duo` - authentik Stages.Authenticator.Duo
+     * * `authentik.stages.authenticator_sms` - authentik Stages.Authenticator.SMS
+     * * `authentik.stages.authenticator_static` - authentik Stages.Authenticator.Static
+     * * `authentik.stages.authenticator_totp` - authentik Stages.Authenticator.TOTP
+     * * `authentik.stages.authenticator_validate` - authentik Stages.Authenticator.Validate
+     * * `authentik.stages.authenticator_webauthn` - authentik Stages.Authenticator.WebAuthn
+     * * `authentik.stages.captcha` - authentik Stages.Captcha
+     * * `authentik.stages.consent` - authentik Stages.Consent
+     * * `authentik.stages.deny` - authentik Stages.Deny
+     * * `authentik.stages.dummy` - authentik Stages.Dummy
+     * * `authentik.stages.email` - authentik Stages.Email
+     * * `authentik.stages.identification` - authentik Stages.Identification
+     * * `authentik.stages.invitation` - authentik Stages.User Invitation
+     * * `authentik.stages.password` - authentik Stages.Password
+     * * `authentik.stages.prompt` - authentik Stages.Prompt
+     * * `authentik.stages.user_delete` - authentik Stages.User Delete
+     * * `authentik.stages.user_login` - authentik Stages.User Login
+     * * `authentik.stages.user_logout` - authentik Stages.User Logout
+     * * `authentik.stages.user_write` - authentik Stages.User Write
+     * * `authentik.tenants` - authentik Tenants
+     * * `authentik.blueprints` - authentik Blueprints
+     * * `authentik.core` - authentik Core
      * @type {AppEnum}
      * @memberof EventMatcherPolicyRequest
      */

package/src/models/ExpiringBaseGrantModel.ts

@@ -51,7 +51,7 @@ export interface ExpiringBaseGrantModel {
      */
     user: User;
     /**
-     * 
+     * Check if token is expired yet.
      * @type {boolean}
      * @memberof ExpiringBaseGrantModel
      */

package/src/models/ExpressionPolicy.ts

@@ -38,31 +38,31 @@ export interface ExpressionPolicy {
      */
     executionLogging?: boolean;
     /**
-     * 
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof ExpressionPolicy
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof ExpressionPolicy
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof ExpressionPolicy
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof ExpressionPolicy
      */
     readonly metaModelName: string;
     /**
-     * 
+     * Return objects policy is bound to
      * @type {number}
      * @memberof ExpressionPolicy
      */

package/src/models/Flow.ts

@@ -82,12 +82,21 @@ export interface Flow {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     * 
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof Flow
      */
     designation: FlowDesignationEnum | null;
     /**
-     * 
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof Flow
      */
@@ -105,7 +114,7 @@ export interface Flow {
      */
     readonly policies: Array<string>;
     /**
-     * 
+     * Get count of cached flows
      * @type {number}
      * @memberof Flow
      */
@@ -123,7 +132,7 @@ export interface Flow {
      */
     compatibilityMode?: boolean;
     /**
-     * 
+     * Get export URL for flow
      * @type {string}
      * @memberof Flow
      */
@@ -136,12 +145,21 @@ export interface Flow {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     * 
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof Flow
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     * 
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof Flow
      */

package/src/models/FlowDesignationEnum.ts

@@ -14,7 +14,13 @@
 
 
 /**
- * 
+ * * `authentication` - Authentication
+ * * `authorization` - Authorization
+ * * `invalidation` - Invalidation
+ * * `enrollment` - Enrollment
+ * * `unenrollment` - Unrenollment
+ * * `recovery` - Recovery
+ * * `stage_configuration` - Stage Configuration
  * @export
  */
 export const FlowDesignationEnum = {

package/src/models/FlowInspectorPlan.ts

@@ -39,13 +39,13 @@ export interface FlowInspectorPlan {
      */
     nextPlannedStage: FlowInspectorPlanCurrentStage;
     /**
-     * 
+     * Get the plan's context, sanitized
      * @type {{ [key: string]: any; }}
      * @memberof FlowInspectorPlan
      */
     readonly planContext: { [key: string]: any; };
     /**
-     * 
+     * Get a unique session ID
      * @type {string}
      * @memberof FlowInspectorPlan
      */

package/src/models/FlowInspectorPlanCurrentStage.ts

@@ -100,6 +100,10 @@ export interface FlowInspectorPlanCurrentStage {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     * 
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowInspectorPlanCurrentStage
      */

package/src/models/FlowRequest.ts

@@ -70,6 +70,14 @@ export interface FlowRequest {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     * 
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowRequest
      */
@@ -94,12 +102,21 @@ export interface FlowRequest {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     * 
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowRequest
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     * 
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof FlowRequest
      */

package/src/models/FlowSet.ts

@@ -76,12 +76,21 @@ export interface FlowSet {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     * 
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowSet
      */
     designation: FlowDesignationEnum | null;
     /**
-     * 
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof FlowSet
      */
@@ -99,7 +108,7 @@ export interface FlowSet {
      */
     compatibilityMode?: boolean;
     /**
-     * 
+     * Get export URL for flow
      * @type {string}
      * @memberof FlowSet
      */
@@ -112,6 +121,10 @@ export interface FlowSet {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     * 
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowSet
      */

package/src/models/FlowSetRequest.ts

@@ -64,6 +64,14 @@ export interface FlowSetRequest {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     * 
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowSetRequest
      */
@@ -88,6 +96,10 @@ export interface FlowSetRequest {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     * 
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowSetRequest
      */

package/src/models/FlowStageBinding.ts

@@ -94,6 +94,10 @@ export interface FlowStageBinding {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     * 
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowStageBinding
      */

package/src/models/FlowStageBindingRequest.ts

@@ -70,6 +70,10 @@ export interface FlowStageBindingRequest {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     * 
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowStageBindingRequest
      */

package/src/models/FlowStageBindingStageObj.ts

@@ -45,25 +45,25 @@ export interface FlowStageBindingStageObj {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */

package/src/models/IdentificationStage.ts

@@ -45,25 +45,25 @@ export interface IdentificationStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof IdentificationStage
      */

package/src/models/IntentEnum.ts

@@ -14,7 +14,10 @@
 
 
 /**
- * 
+ * * `verification` - Intent Verification
+ * * `api` - Intent Api
+ * * `recovery` - Intent Recovery
+ * * `app_password` - Intent App Password
  * @export
  */
 export const IntentEnum = {

package/src/models/InvalidResponseActionEnum.ts

@@ -14,7 +14,9 @@
 
 
 /**
- * 
+ * * `retry` - Retry
+ * * `restart` - Restart
+ * * `restart_with_context` - Restart With Context
  * @export
  */
 export const InvalidResponseActionEnum = {

package/src/models/InvitationFlowObj.ts

@@ -88,12 +88,21 @@ export interface InvitationFlowObj {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     * 
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof InvitationFlowObj
      */
     designation: FlowDesignationEnum | null;
     /**
-     * 
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof InvitationFlowObj
      */
@@ -111,7 +120,7 @@ export interface InvitationFlowObj {
      */
     readonly policies: Array<string>;
     /**
-     * 
+     * Get count of cached flows
      * @type {number}
      * @memberof InvitationFlowObj
      */
@@ -129,7 +138,7 @@ export interface InvitationFlowObj {
      */
     compatibilityMode?: boolean;
     /**
-     * 
+     * Get export URL for flow
      * @type {string}
      * @memberof InvitationFlowObj
      */
@@ -142,12 +151,21 @@ export interface InvitationFlowObj {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     * 
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof InvitationFlowObj
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     * 
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof InvitationFlowObj
      */

package/src/models/InvitationStage.ts

@@ -39,25 +39,25 @@ export interface InvitationStage {
      */
     name: string;
     /**
-     * 
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof InvitationStage
      */
     readonly component: string;
     /**
-     * 
+     * Return object's verbose_name
      * @type {string}
      * @memberof InvitationStage
      */
     readonly verboseName: string;
     /**
-     * 
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof InvitationStage
      */
     readonly verboseNamePlural: string;
     /**
-     * 
+     * Return internal model name
      * @type {string}
      * @memberof InvitationStage
      */