@adyen/api-library/lib/src/services/balancePlatform/sCAAssociationManagementApi.d.ts

The Adyen API Library for NodeJS enables you to work with Adyen APIs.

import Service from "../../service";
import Client from "../../client";
import { IRequest } from "../../typings/requestOptions";
import { ApproveAssociationRequest } from "../../typings/balancePlatform/models";
import { ApproveAssociationResponse } from "../../typings/balancePlatform/models";
import { ListAssociationsResponse } from "../../typings/balancePlatform/models";
import { RemoveAssociationRequest } from "../../typings/balancePlatform/models";
import { ScaEntityType } from "../../typings/balancePlatform/models";
/**
 * API handler for SCAAssociationManagementApi
 */
export declare class SCAAssociationManagementApi extends Service {
    private readonly API_BASEPATH;
    private baseUrl;
    constructor(client: Client);
    /**
    * @summary Approve a pending approval association
    * @param approveAssociationRequest {@link ApproveAssociationRequest }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link ApproveAssociationResponse }
    */
    approveAssociation(approveAssociationRequest: ApproveAssociationRequest, requestOptions?: IRequest.Options): Promise<ApproveAssociationResponse>;
    /**
    * @summary Get a list of devices associated with an entity
    * @param requestOptions {@link IRequest.Options }
    * @param entityType {@link ScaEntityType } (Required) The type of entity you want to retrieve a list of associations for.   Possible values: **accountHolder**, **legalEntity** or **paymentInstrument**.
    * @param entityId {@link string } (Required) The unique identifier of the entity.
    * @param pageSize {@link number } (Required) The number of items to have on a page.   Default: **5**.
    * @param pageNumber {@link number } (Required) The index of the page to retrieve. The index of the first page is **0** (zero).   Default:  **0**.
    * @return {@link ListAssociationsResponse }
    */
    listAssociations(entityType: ScaEntityType, entityId: string, pageSize: number, pageNumber: number, requestOptions?: IRequest.Options): Promise<ListAssociationsResponse>;
    /**
    * @summary Delete association to devices
    * @param removeAssociationRequest {@link RemoveAssociationRequest }
    * @param requestOptions {@link IRequest.Options }
    * @return {@link void }
    */
    removeAssociation(removeAssociationRequest: RemoveAssociationRequest, requestOptions?: IRequest.Options): Promise<void>;
}