Options
All
  • Public
  • Public/Protected
  • All
Menu

PackagesApi - object-oriented interface

export

Hierarchy

  • BaseAPI
    • PackagesApi

Index

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

addPackage

  • Recipient can be an individual user, workspace, or a dropbox.

    summary

    add_package

    throws

    {RequiredError}

    memberof

    PackagesApi

    Parameters

    Returns Promise<AxiosResponse<PackagesResponse>>

deletePackage

  • Use package_id to delete the contents of a specific package. This action removes package contents permanently, but retains information on the package: sender, recipients, size, date, metadata if any, download history, and transfer specs like rate.

    summary

    delete_package

    throws

    {RequiredError}

    memberof

    PackagesApi

    Parameters

    Returns Promise<AxiosResponse<void>>

getPackageById

getPackages

  • Get information about all packages or retrieve packages sent to me in a specific workspace, sent to me as individual (not as a member of a dropbox), that are not archived and not deleted if the user ID is included in the token sent with the call.

    summary

    get_packages

    throws

    {RequiredError}

    memberof

    PackagesApi

    Parameters

    Returns Promise<AxiosResponse<PackagesResponse[]>>

updatePackage

  • Use the PUT method to mark the package "sent=true", including the proper number of transfers in the "transfers_expected" field, after the transfers have completed. The number of transfers expected depends on the number of discrete source locations of package contents.

    summary

    update_package

    throws

    {RequiredError}

    memberof

    PackagesApi

    Parameters

    Returns Promise<AxiosResponse<void>>