Class KeyService

Index

Constructors

Properties

Methods

Constructors

constructor

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

Properties

`Protected` `Readonly`adapter

adapter: AuthenticatedAdapter

Methods

getKeys

getKeys(
options: { label?: string; type: "all" },
): Promise<{ m1: Magento1Key[]; m2: Magento2Key[] }>
Get all Magento keys owned by the authenticated account.
Parameters
- options: { label?: string; type: "all" }
Returns Promise<{ m1: Magento1Key[]; m2: Magento2Key[] }>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#get-keys
Example
```
eqp.getKeys({ type: 'all' })
```
Example
```
eqp.getKeys({ type: 'all', label: 'testing' })
```
- Defined in src/services/KeyService.ts:21
getKeys(options: { label?: string; type: "m1" }): Promise<{ m1: Magento1Key[] }>
Get all Magento 1 keys owned by the authenticated account.
Parameters
- options: { label?: string; type: "m1" }
Returns Promise<{ m1: Magento1Key[] }>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#get-keys
Example
```
eqp.getKeys({ type: 'm1' })
```
Example
```
eqp.getKeys({ type: 'm1', label: 'testing' })
```
- Defined in src/services/KeyService.ts:29
getKeys(options: { label?: string; type: "m2" }): Promise<{ m2: Magento2Key[] }>
Get the Magento keys owned by the authenticated account.
Parameters
- options: { label?: string; type: "m2" }
Returns Promise<{ m2: Magento2Key[] }>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#get-keys
Example
```
eqp.getKeys({ type: 'm2' })
```
Example
```
eqp.getKeys({ type: 'm2', label: 'testing' })
```
- Defined in src/services/KeyService.ts:37