@equisoft/account-service-sdk-typescript 4.5.1-snapshot.20230206204303 → 6.6.0

package/dist/esm/models/SessionPayload.d.ts

@@ -0,0 +1,62 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { SsoProvider } from './SsoProvider';
+/**
+ * Data needed for the creation of a user session.
+ * @export
+ * @interface SessionPayload
+ */
+export interface SessionPayload {
+    /**
+     * Globally unique identifier.
+     * @type {string}
+     * @memberof SessionPayload
+     */
+    userUuid: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SessionPayload
+     */
+    enable: boolean;
+    /**
+     *
+     * @type {SsoProvider}
+     * @memberof SessionPayload
+     */
+    sso?: SsoProvider | null;
+    /**
+     * Indicate that the session is initiated from a public computer.
+     * @type {boolean}
+     * @memberof SessionPayload
+     */
+    publicComputer?: boolean | null;
+    /**
+     * Indicate that the session is initiated from a mobile device.
+     * @type {boolean}
+     * @memberof SessionPayload
+     */
+    mobileDevice?: boolean | null;
+    /**
+     * Indicate the domain name the session cookie was emitted for. If null, the cookie is assumed to be on the current hostname.
+     * @type {string}
+     * @memberof SessionPayload
+     */
+    cookieDomain?: string | null;
+}
+/**
+ * Check if a given object implements the SessionPayload interface.
+ */
+export declare function instanceOfSessionPayload(value: object): boolean;
+export declare function SessionPayloadFromJSON(json: any): SessionPayload;
+export declare function SessionPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionPayload;
+export declare function SessionPayloadToJSON(value?: SessionPayload | null): any;

package/dist/esm/models/SessionPayload.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+import { SsoProviderFromJSON, SsoProviderToJSON, } from './SsoProvider';
+/**
+ * Check if a given object implements the SessionPayload interface.
+ */
+export function instanceOfSessionPayload(value) {
+    let isInstance = true;
+    isInstance = isInstance && "userUuid" in value;
+    isInstance = isInstance && "enable" in value;
+    return isInstance;
+}
+export function SessionPayloadFromJSON(json) {
+    return SessionPayloadFromJSONTyped(json, false);
+}
+export function SessionPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'userUuid': json['userUuid'],
+        'enable': json['enable'],
+        'sso': !exists(json, 'sso') ? undefined : SsoProviderFromJSON(json['sso']),
+        'publicComputer': !exists(json, 'publicComputer') ? undefined : json['publicComputer'],
+        'mobileDevice': !exists(json, 'mobileDevice') ? undefined : json['mobileDevice'],
+        'cookieDomain': !exists(json, 'cookieDomain') ? undefined : json['cookieDomain'],
+    };
+}
+export function SessionPayloadToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'userUuid': value.userUuid,
+        'enable': value.enable,
+        'sso': SsoProviderToJSON(value.sso),
+        'publicComputer': value.publicComputer,
+        'mobileDevice': value.mobileDevice,
+        'cookieDomain': value.cookieDomain,
+    };
+}

package/dist/esm/models/SessionPolicy.d.ts

@@ -0,0 +1,37 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SessionPolicy
+ */
+export interface SessionPolicy {
+    /**
+     * Delay after which a session is closed if not used, in seconds. Set to 0 to disable.
+     * @type {number}
+     * @memberof SessionPolicy
+     */
+    idleTimeout?: number | null;
+    /**
+     * Absolute duration of a session, in seconds. Set to 0 for infinite session duration.
+     * @type {number}
+     * @memberof SessionPolicy
+     */
+    absoluteTimeout?: number | null;
+}
+/**
+ * Check if a given object implements the SessionPolicy interface.
+ */
+export declare function instanceOfSessionPolicy(value: object): boolean;
+export declare function SessionPolicyFromJSON(json: any): SessionPolicy;
+export declare function SessionPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionPolicy;
+export declare function SessionPolicyToJSON(value?: SessionPolicy | null): any;

package/dist/esm/models/SessionPolicy.js

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+/**
+ * Check if a given object implements the SessionPolicy interface.
+ */
+export function instanceOfSessionPolicy(value) {
+    let isInstance = true;
+    return isInstance;
+}
+export function SessionPolicyFromJSON(json) {
+    return SessionPolicyFromJSONTyped(json, false);
+}
+export function SessionPolicyFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'idleTimeout': !exists(json, 'idleTimeout') ? undefined : json['idleTimeout'],
+        'absoluteTimeout': !exists(json, 'absoluteTimeout') ? undefined : json['absoluteTimeout'],
+    };
+}
+export function SessionPolicyToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'idleTimeout': value.idleTimeout,
+        'absoluteTimeout': value.absoluteTimeout,
+    };
+}

package/dist/esm/models/SessionState.d.ts

@@ -0,0 +1,33 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * States:
+ * * `NEW` - Session creation is not finished.  It can't be used by consumer.
+ * * `ENABLED` - Session is active and ready.
+ * * `SUSPENDED` - Session idle for too long.  User has to reenter credentials to activate it (Not implemented yet).
+ * * `EXPIRED` - Session is expired.
+ * * `DELETED` - Session exists but is soft-deleted (Not implemented yet).
+ *
+ * @export
+ */
+export declare const SessionState: {
+    readonly NEW: "NEW";
+    readonly ENABLED: "ENABLED";
+    readonly SUSPENDED: "SUSPENDED";
+    readonly EXPIRED: "EXPIRED";
+    readonly DELETED: "DELETED";
+    readonly unknown_default_open_api: "11184809";
+};
+export type SessionState = typeof SessionState[keyof typeof SessionState];
+export declare function SessionStateFromJSON(json: any): SessionState;
+export declare function SessionStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SessionState;
+export declare function SessionStateToJSON(value?: SessionState | null): any;

package/dist/esm/models/SessionState.js

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * States:
+ * * `NEW` - Session creation is not finished.  It can't be used by consumer.
+ * * `ENABLED` - Session is active and ready.
+ * * `SUSPENDED` - Session idle for too long.  User has to reenter credentials to activate it (Not implemented yet).
+ * * `EXPIRED` - Session is expired.
+ * * `DELETED` - Session exists but is soft-deleted (Not implemented yet).
+ *
+ * @export
+ */
+export const SessionState = {
+    NEW: 'NEW',
+    ENABLED: 'ENABLED',
+    SUSPENDED: 'SUSPENDED',
+    EXPIRED: 'EXPIRED',
+    DELETED: 'DELETED',
+    unknown_default_open_api: '11184809'
+};
+export function SessionStateFromJSON(json) {
+    return SessionStateFromJSONTyped(json, false);
+}
+export function SessionStateFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SessionStateToJSON(value) {
+    return value;
+}

package/dist/esm/models/SetPasswordByConfirmationHashPayload.d.ts

@@ -0,0 +1,31 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SetPasswordByConfirmationHashPayload
+ */
+export interface SetPasswordByConfirmationHashPayload {
+    /**
+     *
+     * @type {string}
+     * @memberof SetPasswordByConfirmationHashPayload
+     */
+    newPassword: string;
+}
+/**
+ * Check if a given object implements the SetPasswordByConfirmationHashPayload interface.
+ */
+export declare function instanceOfSetPasswordByConfirmationHashPayload(value: object): boolean;
+export declare function SetPasswordByConfirmationHashPayloadFromJSON(json: any): SetPasswordByConfirmationHashPayload;
+export declare function SetPasswordByConfirmationHashPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetPasswordByConfirmationHashPayload;
+export declare function SetPasswordByConfirmationHashPayloadToJSON(value?: SetPasswordByConfirmationHashPayload | null): any;

package/dist/esm/models/SetPasswordByConfirmationHashPayload.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SetPasswordByConfirmationHashPayload interface.
+ */
+export function instanceOfSetPasswordByConfirmationHashPayload(value) {
+    let isInstance = true;
+    isInstance = isInstance && "newPassword" in value;
+    return isInstance;
+}
+export function SetPasswordByConfirmationHashPayloadFromJSON(json) {
+    return SetPasswordByConfirmationHashPayloadFromJSONTyped(json, false);
+}
+export function SetPasswordByConfirmationHashPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'newPassword': json['newPassword'],
+    };
+}
+export function SetPasswordByConfirmationHashPayloadToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'newPassword': value.newPassword,
+    };
+}

package/dist/esm/models/SetUserAccountPasswordPayload.d.ts

@@ -0,0 +1,43 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SetUserAccountPasswordPayload
+ */
+export interface SetUserAccountPasswordPayload {
+    /**
+     *
+     * @type {string}
+     * @memberof SetUserAccountPasswordPayload
+     */
+    currentPassword?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SetUserAccountPasswordPayload
+     */
+    newPassword: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SetUserAccountPasswordPayload
+     */
+    passwordResetRequired: boolean;
+}
+/**
+ * Check if a given object implements the SetUserAccountPasswordPayload interface.
+ */
+export declare function instanceOfSetUserAccountPasswordPayload(value: object): boolean;
+export declare function SetUserAccountPasswordPayloadFromJSON(json: any): SetUserAccountPasswordPayload;
+export declare function SetUserAccountPasswordPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): SetUserAccountPasswordPayload;
+export declare function SetUserAccountPasswordPayloadToJSON(value?: SetUserAccountPasswordPayload | null): any;

package/dist/esm/models/SetUserAccountPasswordPayload.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+/**
+ * Check if a given object implements the SetUserAccountPasswordPayload interface.
+ */
+export function instanceOfSetUserAccountPasswordPayload(value) {
+    let isInstance = true;
+    isInstance = isInstance && "newPassword" in value;
+    isInstance = isInstance && "passwordResetRequired" in value;
+    return isInstance;
+}
+export function SetUserAccountPasswordPayloadFromJSON(json) {
+    return SetUserAccountPasswordPayloadFromJSONTyped(json, false);
+}
+export function SetUserAccountPasswordPayloadFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'currentPassword': !exists(json, 'currentPassword') ? undefined : json['currentPassword'],
+        'newPassword': json['newPassword'],
+        'passwordResetRequired': json['passwordResetRequired'],
+    };
+}
+export function SetUserAccountPasswordPayloadToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'currentPassword': value.currentPassword,
+        'newPassword': value.newPassword,
+        'passwordResetRequired': value.passwordResetRequired,
+    };
+}

package/dist/esm/models/SignupHash.d.ts

@@ -0,0 +1,31 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SignupHash
+ */
+export interface SignupHash {
+    /**
+     *
+     * @type {string}
+     * @memberof SignupHash
+     */
+    hash: string;
+}
+/**
+ * Check if a given object implements the SignupHash interface.
+ */
+export declare function instanceOfSignupHash(value: object): boolean;
+export declare function SignupHashFromJSON(json: any): SignupHash;
+export declare function SignupHashFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignupHash;
+export declare function SignupHashToJSON(value?: SignupHash | null): any;

package/dist/esm/models/SignupHash.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SignupHash interface.
+ */
+export function instanceOfSignupHash(value) {
+    let isInstance = true;
+    isInstance = isInstance && "hash" in value;
+    return isInstance;
+}
+export function SignupHashFromJSON(json) {
+    return SignupHashFromJSONTyped(json, false);
+}
+export function SignupHashFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'hash': json['hash'],
+    };
+}
+export function SignupHashToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'hash': value.hash,
+    };
+}

package/dist/esm/models/SsoProvider.d.ts

@@ -0,0 +1,37 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Details related to the SSO provider user to create this session.
+ * @export
+ * @interface SsoProvider
+ */
+export interface SsoProvider {
+    /**
+     * SSO Provider who initiated the single sign on.
+     * @type {string}
+     * @memberof SsoProvider
+     */
+    provider: string;
+    /**
+     * External identifier the user used to login with the SSO provider.
+     * @type {string}
+     * @memberof SsoProvider
+     */
+    identifier: string;
+}
+/**
+ * Check if a given object implements the SsoProvider interface.
+ */
+export declare function instanceOfSsoProvider(value: object): boolean;
+export declare function SsoProviderFromJSON(json: any): SsoProvider;
+export declare function SsoProviderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SsoProvider;
+export declare function SsoProviderToJSON(value?: SsoProvider | null): any;

package/dist/esm/models/SsoProvider.js

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the SsoProvider interface.
+ */
+export function instanceOfSsoProvider(value) {
+    let isInstance = true;
+    isInstance = isInstance && "provider" in value;
+    isInstance = isInstance && "identifier" in value;
+    return isInstance;
+}
+export function SsoProviderFromJSON(json) {
+    return SsoProviderFromJSONTyped(json, false);
+}
+export function SsoProviderFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'provider': json['provider'],
+        'identifier': json['identifier'],
+    };
+}
+export function SsoProviderToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'provider': value.provider,
+        'identifier': value.identifier,
+    };
+}

package/dist/esm/models/SsoToken.d.ts

@@ -0,0 +1,37 @@
+/**
+ * User account and session management
+ * Provides HTTP endpoints to manage User Accounts and User Sessions.
+ *
+ * The version of the OpenAPI document: 6.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SsoToken
+ */
+export interface SsoToken {
+    /**
+     * String that uniquely identify a sso token for a given session.
+     * @type {string}
+     * @memberof SsoToken
+     */
+    id: string;
+    /**
+     * Token value returned as stored. There is no double-encoding.
+     * @type {string}
+     * @memberof SsoToken
+     */
+    value: string;
+}
+/**
+ * Check if a given object implements the SsoToken interface.
+ */
+export declare function instanceOfSsoToken(value: object): boolean;
+export declare function SsoTokenFromJSON(json: any): SsoToken;
+export declare function SsoTokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): SsoToken;
+export declare function SsoTokenToJSON(value?: SsoToken | null): any;