Class PackageService

Index

Constructors

Properties

Methods

getPackageByItemId getPackageBySubmissionId getPackages

Constructors

constructor

new PackageService(adapter: AuthenticatedAdapter): PackageService
Parameters
- adapter: AuthenticatedAdapter
Returns PackageService
- Defined in src/services/PackageService.ts:5

Properties

`Protected` `Readonly`adapter

adapter: AuthenticatedAdapter

Methods

getPackageByItemId

getPackageByItemId(itemId: string): Promise<Package>
Get a specific package by it's item ID.
Parameters
- itemId: string
Returns Promise<Package>
See
https://devdocs.magento.com/marketplace/eqp/v1/packages.html#get-package-details
Example
```
eqp.getPackageByItemId('1')
```
- Defined in src/services/PackageService.ts:30

getPackageBySubmissionId

getPackageBySubmissionId(submissionId: string): Promise<Package>
Get a specific package by it's submission ID.
Parameters
- submissionId: string
Returns Promise<Package>
See
https://devdocs.magento.com/marketplace/eqp/v1/packages.html#get-package-details
Example
```
eqp.getPackageBySubmissionId('1')
```
- Defined in src/services/PackageService.ts:21

getPackages

getPackages(): Promise<Package[]>
Get all packages for the authenticated account.

Returns Promise<Package[]>
See
https://devdocs.magento.com/marketplace/eqp/v1/packages.html#get-package-details
Example
```
eqp.getPackages()
```
- Defined in src/services/PackageService.ts:12