@opexa/portal-sdk 0.0.23 → 0.0.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -1
- package/dist/index.js +62 -62
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +654 -440
- package/dist/index.mjs.map +1 -1
- package/dist/sdk/sdk.d.ts +7 -9
- package/dist/sdk/transformer.d.ts +2 -0
- package/dist/sdk/types.d.ts +7 -0
- package/dist/services/cms-portal.service.d.ts +17 -0
- package/dist/services/types.d.ts +25 -8
- package/dist/utils/compact.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,7 +49,9 @@ function Page() {
|
|
|
49
49
|
|
|
50
50
|
`Sdk` accepts the following options:
|
|
51
51
|
|
|
52
|
-
- `*
|
|
52
|
+
- `*site` - The site ID to be used
|
|
53
|
+
- `*sitePlatform` - The site platform ID to be used
|
|
54
|
+
- `*platform` - The platform code to be used
|
|
53
55
|
- `*environment` - Whether to use production/development api
|
|
54
56
|
|
|
55
57
|
, and returns the following methods:
|
|
@@ -94,6 +96,32 @@ function Page() {
|
|
|
94
96
|
signOut(): Promise<void>
|
|
95
97
|
```
|
|
96
98
|
|
|
99
|
+
- `site` - Retrieve site details
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
site(): Promise<SiteReturn>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
interface Site {
|
|
107
|
+
id: string;
|
|
108
|
+
name: string;
|
|
109
|
+
logo?: string;
|
|
110
|
+
}
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
type SiteReturn =
|
|
115
|
+
| {
|
|
116
|
+
ok: true;
|
|
117
|
+
data: Site;
|
|
118
|
+
}
|
|
119
|
+
| {
|
|
120
|
+
ok: false;
|
|
121
|
+
error: HttpError;
|
|
122
|
+
};
|
|
123
|
+
```
|
|
124
|
+
|
|
97
125
|
- `platform` - Retrieve current platform details
|
|
98
126
|
|
|
99
127
|
```ts
|