The BinderAPI class is used to manage binders within Veeva

Hierarchy

  • BinderAPI

Implements

Constructors

  • Class which communicates with Veeva to manage binders on the platform.

    Parameters

    • restAPI: RestAPI

      Rest API instance

    Returns BinderAPI

Properties

API for managing documents that appear in a binder

API for managing binder relationships

restAPI: RestAPI

Methods

  • Create a new binder in the Veeva environment.

    const service = new VeevaService(credentials)
    await service.binder.create({
    lifecycle__v: 'Binder Lifecycle',
    type__v: 'Presentation',
    product__v: '00P000000000C01',
    country__v: 'unitedKingdom',
    name__v: 'Test Binder',
    major_version_number__v: 0,
    minor_version_number__v: 1
    })

    Returns

    Response from Veeva

    Parameters

    • binder: IBinder

      The binder object to create in Veeva

    Returns Promise<IVeevaResponse>

  • Delete a binder in the Veeva environment.

    const service = new VeevaService(credentials)
    await service.binder.delete(2000)

    Returns

    Response from Veeva

    Parameters

    • id: number

      Binder to delete in Veeva

    Returns Promise<IVeevaResponse>

  • Get a complete list of binders within the Veeva environment

    const service = new VeevaService(credentials)
    await service.binder.get()

    Returns

    An array of binders in Veeva

    Returns Promise<IBinder[]>

  • Get a single binder from the Veeva environment

    const service = new VeevaService(credentials)
    await service.binder.getById(2000)

    Returns

    A single binder from Veeva

    Parameters

    • id: number

      Document/Binder id to get from Veeva

    Returns Promise<IBinder>

  • Update the metadata for a binder in veeva

    const service = new VeevaService(credentials)
    await service.binder.update(2000, {
    name__v: 'Updated Name'
    })

    Returns

    Response from Veeva

    Parameters

    • id: number

      The ID of the binder to update

    • data: IDocument

      The binder data to update

    Returns Promise<IVeevaResponse>

Generated using TypeDoc