MasaClient
[# Masa SDK
- v3.34.1](/docs/developers/sdk/) / Exports / MasaClient
Class: MasaClient
Hierarchy
MasaBase↳
MasaClient
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new MasaClient(«destructured»): MasaClient
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› apiUrl | string |
› cookie? | string |
› masa | MasaInterface |
Returns
Overrides
MasaBase.constructor
Properties
_cookie
• Private Optional _cookie: string
_middlewareClient
• Private _middlewareClient: AxiosInstance
creditScore
• creditScore: Object
Type declaration
| Name | Type | Description |
|---|---|---|
generate | () => Promise\<undefined | GenerateCreditScoreResult> | - |
update | (transactionHash: string) => Promise\<undefined | UpdateCreditScoreResult> | - |
green
• green: Object
Type declaration
| Name | Type | Description |
|---|---|---|
generate | (phoneNumber: string) => Promise\<GenerateGreenResult> | - |
verify | (phoneNumber: string, code: string) => Promise\<undefined | VerifyGreenResult> | - |
masa
• Protected Readonly masa: MasaInterface
Inherited from
MasaBase.masa
metadata
• metadata: Object
Type declaration
| Name | Type | Description |
|---|---|---|
get | (uri: string, additionalHeaders?: Record\<string, string>) => Promise\<undefined | IIdentity | ICreditScore | IGreen> | - |
session
• session: Object
Type declaration
| Name | Type | Description |
|---|---|---|
check | () => Promise\<undefined | ISession> | - |
checkSignature | (address: string, signature: string, cookie?: string) => Promise\<undefined | SessionUser> | - |
getChallenge | () => Promise\<undefined | ChallengeResultWithCookie> | - |
logout | () => Promise\<undefined | LogoutResult> | - |
soulName
• soulName: Object
Type declaration
| Name | Type | Description |
|---|---|---|
store | (soulName: string, receiver: string, duration: number, style?: string) => Promise\<undefined | SoulNameMetadataStoreResult | SoulNameResultBase> | - |
Accessors
cookie
• get cookie(): undefined | string
Returns
undefined | string
Methods
get
▸ get\<Result>(endpoint, silent?): Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>
Type parameters
| Name |
|---|
Result |
Parameters
| Name | Type | Default value |
|---|---|---|
endpoint | string | undefined |
silent | boolean | false |
Returns
Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>
patch
▸ patch\<Request, Result>(endpoint, data, silent?): Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>
Type parameters
| Name |
|---|
Request |
Result |
Parameters
| Name | Type | Default value |
|---|---|---|
endpoint | string | undefined |
data | Request | undefined |
silent | boolean | false |
Returns
Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>
post
▸ post\<Request, Result>(endpoint, data, silent?): Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>
Type parameters
| Name |
|---|
Request |
Result |
Parameters
| Name | Type | Default value |
|---|---|---|
endpoint | string | undefined |
data | Request | undefined |
silent | boolean | false |
Returns
Promise\<{ data: undefined | Result ; status: undefined | number ; statusText: undefined | string }>