Class AuthenticatedAdapter

Index

Constructors

Properties

baseAdapter credentials

Methods

authenticate delete get getMageId post put

Constructors

constructor

new AuthenticatedAdapter(
baseAdapter: Adapter,
credentials: { appId: string; appSecret: string },
): AuthenticatedAdapter
Parameters
- baseAdapter: Adapter
- credentials: { appId: string; appSecret: string }
Returns AuthenticatedAdapter
- Defined in AuthenticatedAdapter.ts:8

Properties

`Protected` `Readonly`baseAdapter

baseAdapter: Adapter

`Protected` `Readonly`credentials

credentials: { appId: string; appSecret: string }

Methods

`Protected`authenticate

authenticate(): Promise<
readonly [string, { authorization: `Bearer ${string}` }],
>
Authenticate with the API. You can find the App ID and secret with the next link.

Returns Promise<readonly [string, { authorization: `Bearer ${string}` }]>
See
- https://developer.magento.com/account/apikeys
- https://devdocs.magento.com/marketplace/eqp/v1/auth.html#session-token
- Defined in AuthenticatedAdapter.ts:51

delete

delete<T>(url: string, config?: AxiosRequestConfig<any>): Promise<T>
Type Parameters
- T
Parameters
- url: string
- Optionalconfig: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in AuthenticatedAdapter.ts:34

get

get<T>(url: string, config?: AxiosRequestConfig<any>): Promise<T>
Type Parameters
- T
Parameters
- url: string
- Optionalconfig: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in AuthenticatedAdapter.ts:16

getMageId

getMageId(): Promise<string>
Returns Promise<string>
- Defined in AuthenticatedAdapter.ts:40

post

post<T>(
    url: string,
    body: unknown,
    config?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T
Parameters
- url: string
- body: unknown
- Optionalconfig: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in AuthenticatedAdapter.ts:22

put

put<T>(url: string, body: unknown, config?: AxiosRequestConfig<any>): Promise<T>
Type Parameters
- T
Parameters
- url: string
- body: unknown
- Optionalconfig: AxiosRequestConfig<any>
Returns Promise<T>
- Defined in AuthenticatedAdapter.ts:28