@licensespring/node-sdk 1.2.0 → 1.3.0-alpha

package/dist/src/floating-api.d.ts

@@ -0,0 +1,487 @@
+import { HardwareIdAlgorithm, LogLevel } from './types';
+import { AxiosProxyConfig } from 'axios';
+type FloatingAPIConfig = {
+    apiPath: string;
+    hardwareID?: string;
+    hardwareIDMethod?: number;
+    logLevel?: LogLevel;
+    proxy?: AxiosProxyConfig;
+    certChain: string;
+    publicKey: string;
+} & ({
+    apiKey: string;
+    sharedKey: string;
+} | {
+    clientID: string;
+    clientSecret: string;
+    tokenUrl: string;
+});
+export declare class FloatingAPI {
+    private readonly config;
+    private readonly service;
+    private readonly hardwareIDmanual?;
+    private certsVerified;
+    constructor(config: FloatingAPIConfig);
+    private verifyCertChain;
+    setLogLevel(level: LogLevel): void;
+    getHardwareID(algorithm?: HardwareIdAlgorithm): string;
+    ping(): Promise<boolean>;
+    authAddUser(user: User): Promise<string>;
+    authChangePassword(body: ChangePasswordReq): Promise<boolean>;
+    authInitialPassword(body: SetPasswordReq): Promise<boolean>;
+    authLogin(body: LoginUser): Promise<LoginResponse>;
+    authMe(): Promise<AuthMeResponseBody>;
+    authUsersList(): Promise<User[]>;
+    authUsersDelete(): Promise<string>;
+    getConfig(): Promise<CloudConfig>;
+    patchConfig(input: CloudConfigUpdate): Promise<string>;
+    bundleActivate(body: BundleRequest): Promise<ActivateBundleResponse>;
+    bundleDeactivate(id: number): Promise<DeactivateBundleResponse>;
+    bundleOfflineActivationGenerate(body: OfflineRequestInput): Promise<GenerateOfflineRequestResponse>;
+    bundleOfflineDeactivationGenerate(body: OfflineRequestInput): Promise<GenerateOfflineRequestResponse>;
+    bundleOfflineActivationUpload(product: string, file: File | Blob): Promise<ActivateBundleResponse>;
+    listLicenses(params?: {
+        product?: string;
+    }): Promise<LicenseData[]>;
+    activateLicense(body: AddLicenseRequest): Promise<ActivateLicenseResponse>;
+    getLicenseById(id: string): Promise<LicenseData>;
+    deactivateLicense(id: number): Promise<boolean>;
+    addLicenseConsumption(id: number, body: AddConsumptionRequest): Promise<ConsumptionResponse>;
+    addFeatureConsumption(id: number, body: AddFeatureConsumptionRequest): Promise<FeatureConsumptionResponse>;
+    listLicenseFeatureUsers(id: number): Promise<AllFeatureUsersResponse>;
+    registerFeatureForUser(id: number, body: RegisterFeatureRequest): Promise<RegisterFeatureResponse>;
+    releaseFeatureForUser(id: number, body: UnregisterFeatureRequest): Promise<boolean>;
+    releaseFeatureForAllUsers(id: number, body: AllFeatureUsersRequest): Promise<FeatureReleasedAllResponse>;
+    listLicenseUsers(id: number): Promise<FloatingUser[]>;
+    registerUserToLicense(id: number, body: RegisterRequestBody): Promise<LicenseData>;
+    unregisterUserFromLicense(id: number, body: UsernameRequest): Promise<boolean>;
+    unregisterAllUsersFromLicense(id: number): Promise<UnregisterAllUsersResponse>;
+    borrowLicenseForUser(id: number, body: BorrowUserRequest): Promise<BorrowResponse>;
+    offlineActivationGenerate(body: OfflineRequestInput): Promise<GenerateOfflineRequestResponse>;
+    offlineActivationUpload(product: string, file: File | Blob): Promise<ActivateBundleResponse | ActivateLicenseResponse>;
+    offlineDeactivationGenerate(body: OfflineRequestInput): Promise<GenerateOfflineRequestResponse>;
+    airgapGenerateActivation(body: GenerateAirgapRequestBody): Promise<AirgapActivationCodeResponse>;
+    airgapGenerateDeactivation(body: GenerateAirgapDeactivationRequestBody): Promise<AirgapDeactivationCodeResponse>;
+    airgapDeactivate(body: DeactivateAirgapRequestBody): Promise<AirgapeDeactivatedResponse>;
+    airgapActivate(file: File | Blob, jsonFile: File | Blob): Promise<AirgapActivatedResponse>;
+    getSyncConfig(): Promise<SyncConfig>;
+    setSyncMode(body: SyncEnableReq): Promise<boolean>;
+    triggerSync(): Promise<boolean>;
+}
+type AnyJson = Record<string, any>;
+type RFC3339 = string;
+interface LoginResponse {
+    token: string;
+    expires_at: RFC3339;
+    expires_in: number;
+}
+interface User {
+    id: number;
+    username: string;
+    role: 'admin' | 'user';
+    created_at: RFC3339;
+    updated_at: RFC3339;
+}
+interface LoginUser {
+    username: string;
+    password: string;
+}
+interface ChangePasswordReq {
+    username: string;
+    old_password: string;
+    new_password: string;
+}
+interface SetPasswordReq {
+    password: string;
+}
+type AuthMeSuccessBody = {
+    expires_at?: string;
+    ExpiresAt?: string;
+    [key: string]: unknown;
+};
+interface AuthMeErrorBody {
+    error: string;
+}
+type AuthMeResponseBody = AuthMeSuccessBody | AuthMeErrorBody;
+interface CloudConfig {
+    airGapPublicKey: string;
+    apikey: string;
+    apiprefix: string;
+    baseURL: string;
+    cacertificatePath: string;
+    certificatePath: string;
+    clientId: string;
+    clientSecret: string;
+    disableSync: boolean;
+    id: number;
+    privateKeyPath: string;
+    serverPublicKey: string;
+    sharedKey: string;
+    syncIntervalHours: number;
+    syncIntervalMinutes: number;
+    useHardwareKey: boolean;
+    useOAuth: boolean;
+}
+interface CloudConfigUpdate {
+    airgap_public_key?: string;
+    api_key?: string;
+    api_prefix?: string;
+    base_url?: string;
+    client_id?: string;
+    client_secret?: string;
+    server_public_key?: string;
+    shared_key?: string;
+    use_oauth?: boolean;
+}
+interface AddLicenseRequest {
+    product?: string;
+    license_key?: string;
+}
+interface Company {
+    id: number;
+}
+interface LicenseUser {
+    id: number;
+    email: string;
+    is_active?: boolean;
+    first_name: string;
+    last_name: string;
+    phone_number: string;
+    is_initial_password: boolean;
+    initial_password?: string;
+    license_id?: number;
+    order_store_id?: string;
+    order_id?: number;
+    max_activations: number;
+    allow_unlimited_activations: boolean;
+    total_activations: number;
+}
+interface ProductDetails {
+    product_id: number;
+    product_name: string;
+    short_code: string;
+    authorization_method: string;
+    metadata: AnyJson | null;
+    company_id: number;
+    trial_days?: number;
+    allow_overages?: boolean;
+    max_overages?: number;
+    prevent_vm?: boolean;
+    floating_timeout?: number;
+    validity_period?: string | null;
+}
+interface CustomerAccount {
+    code: string;
+    id: number;
+    name: string;
+}
+interface Customer {
+    email: string;
+    first_name: string;
+    last_name: string;
+    company_name: string;
+    phone: string;
+    reference: string;
+    address: string;
+    postcode: string;
+    city: string;
+    country: string;
+    state: string;
+    customer_account?: CustomerAccount;
+    metadata: AnyJson | null;
+}
+interface CustomField {
+    name: string;
+    value: string;
+    data_type: string;
+}
+interface LicenseData {
+    product?: string;
+    hardware_id?: string;
+    policy_id: number;
+    is_licensed?: boolean;
+    is_unlicensed_copy?: boolean;
+    is_valid?: boolean;
+    is_dirty?: boolean;
+    local_consumptions?: number;
+    last_check?: RFC3339;
+    last_usage_date?: RFC3339;
+    grace_period_start?: RFC3339;
+    floating_vp?: RFC3339;
+    custom_fields: CustomField[] | null;
+    user_data?: Record<string, string>;
+    metadata: AnyJson | null;
+    id: number;
+    license_active: boolean;
+    license_enabled: boolean;
+    is_expired: boolean;
+    license_type: string;
+    start_date: RFC3339 | null;
+    signature?: string;
+    is_trial?: boolean;
+    trial_days: number;
+    validity_period: RFC3339 | null;
+    maintenance_period: RFC3339 | null;
+    allow_overages: boolean;
+    max_overages: number;
+    max_consumptions: number;
+    total_consumptions: number;
+    allow_unlimited_consumptions: boolean;
+    allow_negative_consumptions?: boolean;
+    reset_consumption: boolean;
+    consumption_period: string | null;
+    is_floating_cloud: boolean;
+    is_floating: boolean;
+    floating_timeout: number;
+    floating_in_use_devices: number;
+    floating_users: number;
+    max_borrow_time: number;
+    prevent_vm: boolean;
+    is_air_gapped: boolean;
+    times_activated: number;
+    max_activations: number;
+    transfer_count: number;
+    max_transfers: number;
+    is_borrowed: boolean;
+    offline_activated?: boolean;
+    grace_period: number;
+    is_bundle_activated?: boolean;
+    bundle_license_id?: number;
+    bundle_licenses?: LicenseData[];
+    is_bundle?: boolean;
+    customer: Customer;
+    user?: LicenseUser;
+    product_details: ProductDetails;
+    license_features: LicenseFeature[];
+    company?: Company;
+    variables: DeviceVariable[];
+    channel: string;
+    enable_maintenance_period: boolean;
+    environment: string;
+    eula_link: string;
+    hash_md5: string;
+    installation_file: string;
+    is_hardware_key_auth: boolean;
+    offline_signature: string;
+    license_signature_v2: string;
+    release_date: string;
+    release_notes_link: string;
+    requires_version: string;
+    size: string;
+    version: string;
+    max_license_users: number;
+    allow_grace_period: boolean;
+    allow_unlimited_activations: boolean;
+    can_borrow: boolean;
+    device_id: number;
+    license_signature: string;
+    order_store_id: string;
+}
+interface DeviceVariable {
+    id?: number;
+    name?: string;
+    value?: string;
+    variable?: string;
+    created_at: RFC3339;
+    device_id?: number;
+}
+interface LicenseFeature {
+    id: number;
+    code: string;
+    name: string;
+    feature_type: string;
+    expiry_date: string;
+    max_consumption: number;
+    total_consumptions: number;
+    local_consumptions?: number;
+    allow_overages: boolean;
+    max_overages: number;
+    allow_unlimited_consumptions: boolean;
+    allow_negative_consumptions?: boolean;
+    reset_consumption: boolean;
+    consumption_period: string | null;
+    is_floating_cloud: boolean;
+    is_floating: boolean;
+    floating_timeout?: number;
+    floating_users?: number;
+    floating_in_use_devices?: number;
+    floating_start?: RFC3339;
+    floating_end?: RFC3339;
+    metadata: AnyJson | null;
+}
+interface ActivateBundleResponse {
+    status: 'ok';
+    message: 'bundle added';
+    license_ids: number[];
+    bundle_license_id: number;
+}
+interface DeactivateBundleResponse {
+    status: 'ok';
+    message: 'bundle deactivated';
+}
+interface FloatingUser {
+    id?: number;
+    username: string;
+    email: string;
+    license_id: number;
+    product: string;
+    product_id: number;
+    floating_amount: number;
+    floating_end_time: RFC3339;
+    created_at: RFC3339;
+    last_check: RFC3339;
+    vendor_id: number;
+    is_borrowed: boolean;
+}
+interface ActivateLicenseResponse {
+    status: 'ok';
+    message: 'license added';
+    product: string;
+    license_id: number;
+}
+interface AddConsumptionRequest {
+    consumptions: number;
+    allow_overages?: boolean;
+    max_overages?: number;
+}
+interface ConsumptionResponse {
+    id: number;
+    max_consumptions: number;
+    total_consumptions: number;
+    allow_unlimited_consumptions: boolean;
+    allow_negative_consumptions: boolean;
+    allow_overages: boolean;
+    max_overages: number;
+    reset_consumption: boolean;
+    consumption_period: string | null;
+    license_signature: string;
+}
+interface FeatureConsumptionResponse extends ConsumptionResponse {
+    is_floating_cloud: boolean;
+    is_floating: boolean;
+    floating_timeout: number;
+    floating_users: number;
+}
+interface AddFeatureConsumptionRequest {
+    consumptions: number;
+    feature: string;
+}
+interface RegisterFeatureRequest {
+    username: string;
+    feature?: string;
+    email?: string;
+}
+interface UnregisterFeatureRequest {
+    username?: string;
+    feature?: string;
+}
+interface AllFeatureUsersRequest {
+    feature?: string;
+}
+interface RegisterRequestBody {
+    username: string;
+    email?: string;
+}
+interface UsernameRequest {
+    username: string;
+}
+interface BorrowUserRequest {
+    username: string;
+    borrowed_until?: string;
+}
+interface BorrowResponse {
+    license_id?: number;
+    device_id?: string;
+    borrowed_until?: string;
+    license_signature?: string;
+    max_borrow_time?: number;
+}
+interface OfflineRequestInput {
+    product?: string;
+    license_key?: string;
+}
+interface BundleRequest {
+    bundle: string;
+    license_key: string;
+}
+interface GenerateOfflineRequestResponse {
+    status: 'ok';
+    request_data: string;
+}
+interface GenerateAirgapRequestBody {
+    initialization_code: string;
+    license_key: string;
+    product: string;
+}
+interface GenerateAirgapDeactivationRequestBody {
+    initialization_code: string;
+    license_key: string;
+}
+interface DeactivateAirgapRequestBody {
+    confirmation_code: string;
+    license_key: string;
+}
+interface SyncConfig {
+    enabled: boolean;
+    hours: number;
+    minutes: number;
+}
+interface SyncEnableReq {
+    enabled: boolean;
+    hours?: number;
+    minutes?: number;
+}
+interface FloatingFeatureUser {
+    feature_id: number;
+    username: string;
+    email: string;
+    license_id: number;
+    feature: string;
+    product: string;
+    floating_amount: number;
+    floating_end_time: string;
+    created_at: string;
+    last_check: string;
+    vendor_code: string;
+    vendor_id: number;
+}
+interface FeatureCodeID {
+    feature_id: number;
+    feature_code: string;
+    users_list: FloatingFeatureUser[];
+}
+type AllFeatureUsersResponse = FeatureCodeID[];
+interface RegisterFeatureResponse extends LicenseFeature {
+    license_id: number;
+}
+interface FeatureReleasedAllResponse {
+    status: 'ok';
+    message: 'all features released';
+    license_id: number;
+    feature: string;
+}
+interface UnregisterAllUsersResponse {
+    status: 'ok';
+    message: 'all users unregistered';
+    license_id: number;
+}
+interface AirgapActivationCodeResponse {
+    status: 'ok';
+    hardware_id: string;
+    activation_code: string;
+}
+interface AirgapDeactivationCodeResponse {
+    status: 'ok';
+    hardware_id: string;
+    deactivation_code: string;
+}
+interface AirgapeDeactivatedResponse {
+    status: 'ok';
+    message: 'license_deactivated';
+}
+interface AirgapActivatedResponse {
+    status: 'ok';
+    message: 'airgap license activated';
+    license_id: number;
+}
+export {};