@targetprocess/auth-client 3.2.2-ci.4 → 3.2.2-manual-up-node-client-template-1

package/bin/client.d.ts

@@ -6,143 +6,135 @@ export interface IAuthClient {
     createTenant(body: Tenant): Promise<TenantId>;
     /**
      * Update tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Updated
      */
     updateTenant(body: Tenant, tenantId: string): Promise<void>;
     /**
      * Get tenant details
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return OK
      */
     getTenant(tenantId: string): Promise<Tenant>;
     /**
      * Delete tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Deleted
      */
     deleteTenant(tenantId: string): Promise<void>;
     /**
      * Create new user in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createUserInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<UserId>;
+    createUserInTenant(body: User, tenantId: string): Promise<UserId>;
     /**
      * Update users passwords
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Imported
      */
     updateUsersPasswords(body: UserPasswordHash[], tenantId: string): Promise<void>;
     /**
      * Set user claim values
-     * @tenantId Tenant Id
-     * @claimType Claim Type
+     * @param tenantId Tenant Id
+     * @param claimType Claim Type
      * @return OK
      */
     setUserClaims(userClaimsBatch: UserClaimsBatch[], tenantId: string, claimType: string): Promise<void>;
     /**
      * Import users in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Imported
      */
     importUsersInTenant(body: UserImport[], tenantId: string): Promise<void>;
     /**
      * Get user from tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return OK
      */
-    getUserFromTenant(tenantId: string, userId: string): Promise<{
-        [key: string]: any;
-    }>;
+    getUserFromTenant(tenantId: string, userId: string): Promise<User>;
     /**
      * Update user in tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Updated
      */
     updateUserInTenant(body: UserPartial, tenantId: string, userId: string): Promise<void>;
     /**
      * Delete user from tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Deleted
      */
     deleteUserFromTenant(tenantId: string, userId: string): Promise<void>;
     /**
      * Change user's password
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Updated
      */
     changeUserPasswordInTenant(body: Password, tenantId: string, userId: string): Promise<void>;
     /**
      * Create new external SAML identity provider in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createSamlProviderInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<SamlProviderId>;
+    createSamlProviderInTenant(body: SamlProvider, tenantId: string): Promise<SamlProviderId>;
     /**
      * Get all external SAML identity providers in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return OK
      */
-    getSamlProvidersInTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }[]>;
+    getSamlProvidersInTenant(tenantId: string): Promise<SamlProvider[]>;
     /**
      * Get external SAML identity provider from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return OK
      */
-    getSamlProviderFromTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }>;
+    getSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<SamlProvider>;
     /**
      * Update external SAML identity provider in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return Updated
      */
-    updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string): Promise<void>;
+    updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string, samlProviderId: string): Promise<void>;
     /**
      * Delete external SAML identity provider from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return Deleted
      */
-    deleteSamlProviderFromTenant(tenantId: string): Promise<void>;
+    deleteSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<void>;
     /**
      * Create new external SSO profile in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createSsoProfileInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<SsoProfileId>;
+    createSsoProfileInTenant(body: SsoProfile, tenantId: string): Promise<SsoProfileId>;
     /**
      * Get external SSO profile from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return OK
      */
-    getSsoProfileFromTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }>;
+    getSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<SsoProfile>;
     /**
      * Update external SSO profile in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return Updated
      */
-    updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string): Promise<void>;
+    updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string, ssoProfileId: string): Promise<void>;
     /**
      * Delete external SSO profile from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return Deleted
      */
-    deleteSsoProfileFromTenant(tenantId: string): Promise<void>;
+    deleteSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<void>;
     /**
      * Create new client
      * @return Created
@@ -150,19 +142,19 @@ export interface IAuthClient {
     createClient(body: Client): Promise<ClientCredentials>;
     /**
      * Update client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return Updated
      */
     updateClient(body: ClientInfo, clientId: string): Promise<void>;
     /**
      * Get client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return OK
      */
     getClient(clientId: string): Promise<ClientInfo>;
     /**
      * Delete client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return Deleted
      */
     deleteClient(clientId: string): Promise<void>;
@@ -178,19 +170,19 @@ export interface IAuthClient {
     createApiResource(body: ApiResource): Promise<ApiResource>;
     /**
      * Get api resource
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     getApiResource(resourceName: string): Promise<ApiResource>;
     /**
      * Delete api resources
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     deleteApiResource(resourceName: string): Promise<void>;
     /**
      * Update api resource
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     updateApiResource(body: ApiResource, resourceName: string): Promise<void>;
@@ -210,170 +202,154 @@ export declare class AuthClient implements IAuthClient {
     protected processCreateTenant(response: Response): Promise<TenantId>;
     /**
      * Update tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Updated
      */
     updateTenant(body: Tenant, tenantId: string): Promise<void>;
     protected processUpdateTenant(response: Response): Promise<void>;
     /**
      * Get tenant details
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return OK
      */
     getTenant(tenantId: string): Promise<Tenant>;
     protected processGetTenant(response: Response): Promise<Tenant>;
     /**
      * Delete tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Deleted
      */
     deleteTenant(tenantId: string): Promise<void>;
     protected processDeleteTenant(response: Response): Promise<void>;
     /**
      * Create new user in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createUserInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<UserId>;
+    createUserInTenant(body: User, tenantId: string): Promise<UserId>;
     protected processCreateUserInTenant(response: Response): Promise<UserId>;
     /**
      * Update users passwords
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Imported
      */
     updateUsersPasswords(body: UserPasswordHash[], tenantId: string): Promise<void>;
     protected processUpdateUsersPasswords(response: Response): Promise<void>;
     /**
      * Set user claim values
-     * @tenantId Tenant Id
-     * @claimType Claim Type
+     * @param tenantId Tenant Id
+     * @param claimType Claim Type
      * @return OK
      */
     setUserClaims(userClaimsBatch: UserClaimsBatch[], tenantId: string, claimType: string): Promise<void>;
     protected processSetUserClaims(response: Response): Promise<void>;
     /**
      * Import users in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Imported
      */
     importUsersInTenant(body: UserImport[], tenantId: string): Promise<void>;
     protected processImportUsersInTenant(response: Response): Promise<void>;
     /**
      * Get user from tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return OK
      */
-    getUserFromTenant(tenantId: string, userId: string): Promise<{
-        [key: string]: any;
-    }>;
-    protected processGetUserFromTenant(response: Response): Promise<{
-        [key: string]: any;
-    }>;
+    getUserFromTenant(tenantId: string, userId: string): Promise<User>;
+    protected processGetUserFromTenant(response: Response): Promise<User>;
     /**
      * Update user in tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Updated
      */
     updateUserInTenant(body: UserPartial, tenantId: string, userId: string): Promise<void>;
     protected processUpdateUserInTenant(response: Response): Promise<void>;
     /**
      * Delete user from tenant
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Deleted
      */
     deleteUserFromTenant(tenantId: string, userId: string): Promise<void>;
     protected processDeleteUserFromTenant(response: Response): Promise<void>;
     /**
      * Change user's password
-     * @tenantId Tenant Id
-     * @userId User Id
+     * @param tenantId Tenant Id
+     * @param userId User Id
      * @return Updated
      */
     changeUserPasswordInTenant(body: Password, tenantId: string, userId: string): Promise<void>;
     protected processChangeUserPasswordInTenant(response: Response): Promise<void>;
     /**
      * Create new external SAML identity provider in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createSamlProviderInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<SamlProviderId>;
+    createSamlProviderInTenant(body: SamlProvider, tenantId: string): Promise<SamlProviderId>;
     protected processCreateSamlProviderInTenant(response: Response): Promise<SamlProviderId>;
     /**
      * Get all external SAML identity providers in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return OK
      */
-    getSamlProvidersInTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }[]>;
-    protected processGetSamlProvidersInTenant(response: Response): Promise<{
-        [key: string]: any;
-    }[]>;
+    getSamlProvidersInTenant(tenantId: string): Promise<SamlProvider[]>;
+    protected processGetSamlProvidersInTenant(response: Response): Promise<SamlProvider[]>;
     /**
      * Get external SAML identity provider from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return OK
      */
-    getSamlProviderFromTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }>;
-    protected processGetSamlProviderFromTenant(response: Response): Promise<{
-        [key: string]: any;
-    }>;
+    getSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<SamlProvider>;
+    protected processGetSamlProviderFromTenant(response: Response): Promise<SamlProvider>;
     /**
      * Update external SAML identity provider in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return Updated
      */
-    updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string): Promise<void>;
+    updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string, samlProviderId: string): Promise<void>;
     protected processUpdateSamlProviderInTenant(response: Response): Promise<void>;
     /**
      * Delete external SAML identity provider from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param samlProviderId SAML Provider Id
      * @return Deleted
      */
-    deleteSamlProviderFromTenant(tenantId: string): Promise<void>;
+    deleteSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<void>;
     protected processDeleteSamlProviderFromTenant(response: Response): Promise<void>;
     /**
      * Create new external SSO profile in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
      * @return Created
      */
-    createSsoProfileInTenant(body: {
-        [key: string]: any;
-    }, tenantId: string): Promise<SsoProfileId>;
+    createSsoProfileInTenant(body: SsoProfile, tenantId: string): Promise<SsoProfileId>;
     protected processCreateSsoProfileInTenant(response: Response): Promise<SsoProfileId>;
     /**
      * Get external SSO profile from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return OK
      */
-    getSsoProfileFromTenant(tenantId: string): Promise<{
-        [key: string]: any;
-    }>;
-    protected processGetSsoProfileFromTenant(response: Response): Promise<{
-        [key: string]: any;
-    }>;
+    getSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<SsoProfile>;
+    protected processGetSsoProfileFromTenant(response: Response): Promise<SsoProfile>;
     /**
      * Update external SSO profile in tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return Updated
      */
-    updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string): Promise<void>;
+    updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string, ssoProfileId: string): Promise<void>;
     protected processUpdateSsoProfileInTenant(response: Response): Promise<void>;
     /**
      * Delete external SSO profile from tenant
-     * @tenantId Tenant Id
+     * @param tenantId Tenant Id
+     * @param ssoProfileId External SSO Profile Id
      * @return Deleted
      */
-    deleteSsoProfileFromTenant(tenantId: string): Promise<void>;
+    deleteSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<void>;
     protected processDeleteSsoProfileFromTenant(response: Response): Promise<void>;
     /**
      * Create new client
@@ -383,21 +359,21 @@ export declare class AuthClient implements IAuthClient {
     protected processCreateClient(response: Response): Promise<ClientCredentials>;
     /**
      * Update client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return Updated
      */
     updateClient(body: ClientInfo, clientId: string): Promise<void>;
     protected processUpdateClient(response: Response): Promise<void>;
     /**
      * Get client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return OK
      */
     getClient(clientId: string): Promise<ClientInfo>;
     protected processGetClient(response: Response): Promise<ClientInfo>;
     /**
      * Delete client
-     * @clientId Client Id
+     * @param clientId Client Id
      * @return Deleted
      */
     deleteClient(clientId: string): Promise<void>;
@@ -416,21 +392,21 @@ export declare class AuthClient implements IAuthClient {
     protected processCreateApiResource(response: Response): Promise<ApiResource>;
     /**
      * Get api resource
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     getApiResource(resourceName: string): Promise<ApiResource>;
     protected processGetApiResource(response: Response): Promise<ApiResource>;
     /**
      * Delete api resources
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     deleteApiResource(resourceName: string): Promise<void>;
     protected processDeleteApiResource(response: Response): Promise<void>;
     /**
      * Update api resource
-     * @resourceName Api resource name
+     * @param resourceName Api resource name
      * @return OK
      */
     updateApiResource(body: ApiResource, resourceName: string): Promise<void>;
@@ -461,20 +437,21 @@ export interface UserPartial {
     email?: string | undefined;
     claims?: Claim[] | undefined;
 }
+export interface User extends UserPartial {
+}
 /** user password hash algorithm */
 export declare enum PasswordHashAlgorithm {
-    Unknown,
-    ProprietaryV1,
-    IdentityV3,
+    Unknown = "Unknown",
+    ProprietaryV1 = "ProprietaryV1",
+    IdentityV3 = "IdentityV3",
 }
-export interface UserImport {
+export interface UserImport extends User {
     /** User's globally unique identifier */
     id: string;
     /** User's password hash */
     passwordHash?: string | undefined;
     /** User's password hash algorithm */
     passwordHashAlgorithm?: PasswordHashAlgorithm | undefined;
-    [key: string]: any;
 }
 export interface UserPasswordHash extends UserId {
     /** User's password hash */
@@ -604,6 +581,8 @@ export interface SamlProviderPartial {
     /** Issuer */
     issuer?: string | undefined;
 }
+export interface SamlProvider extends SamlProviderPartial {
+}
 export interface SsoProfileId {
     /** External SSO profile's globally unique identifier */
     id: string;
@@ -622,6 +601,8 @@ export interface SsoProfilePartial {
     /** List of external provider (both SAML2 and OAuth) ids to use for login */
     providers?: string[] | undefined;
 }
+export interface SsoProfile extends SsoProfilePartial {
+}
 export interface ErrorDto {
     /** Internal error code */
     code?: string | undefined;
@@ -633,26 +614,26 @@ export interface UserClaimsBatch {
     claimValues?: string[] | undefined;
 }
 export declare enum AllowedGrantTypes {
-    Authorization_code,
-    Implicit,
-    Hybrid,
-    Password,
-    Client_credentials,
-    Delegation,
+    Authorization_code = "authorization_code",
+    Implicit = "implicit",
+    Hybrid = "hybrid",
+    Password = "password",
+    Client_credentials = "client_credentials",
+    Delegation = "delegation",
 }
 export declare enum ClientInfoRefreshTokenUsage {
-    ReUse,
-    OneTimeOnly,
+    ReUse = "reUse",
+    OneTimeOnly = "oneTimeOnly",
 }
 export declare enum ClientInfoRefreshTokenExpiration {
-    Absolute,
-    Sliding,
+    Absolute = "absolute",
+    Sliding = "sliding",
 }
 export declare enum ClientInfoAccessTokenType {
-    Jwt,
-    Reference,
+    Jwt = "jwt",
+    Reference = "reference",
 }
-export declare class SwaggerException extends Error {
+export declare class ApiException extends Error {
     message: string;
     status: number;
     response: string;
@@ -663,6 +644,6 @@ export declare class SwaggerException extends Error {
     constructor(message: string, status: number, response: string, headers: {
         [key: string]: any;
     }, result: any);
-    protected isSwaggerException: boolean;
-    static isSwaggerException(obj: any): obj is SwaggerException;
+    protected isApiException: boolean;
+    static isApiException(obj: any): obj is ApiException;
 }