@digital8/lighting-illusions-ts-sdk 0.0.2307 → 0.0.2308
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/.openapi-generator/FILES +14 -0
- package/README.md +18 -2
- package/dist/apis/AdminsApi.d.ts +33 -0
- package/dist/apis/AdminsApi.js +125 -0
- package/dist/apis/CustomersApi.d.ts +52 -0
- package/dist/apis/CustomersApi.js +192 -0
- package/dist/apis/RolesApi.d.ts +66 -0
- package/dist/apis/RolesApi.js +250 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AdminResource.d.ts +2 -2
- package/dist/models/AttachAdminsToRoleRequest.d.ts +32 -0
- package/dist/models/AttachAdminsToRoleRequest.js +51 -0
- package/dist/models/AttachPermissionsToRoleRequest.d.ts +32 -0
- package/dist/models/AttachPermissionsToRoleRequest.js +51 -0
- package/dist/models/AttachRolesToAdminRequest.d.ts +32 -0
- package/dist/models/AttachRolesToAdminRequest.js +51 -0
- package/dist/models/CreateCustomerAddressRequest.d.ts +90 -0
- package/dist/models/CreateCustomerAddressRequest.js +83 -0
- package/dist/models/CreateCustomerRequest.d.ts +7 -1
- package/dist/models/CreateCustomerRequest.js +3 -3
- package/dist/models/CustomerListResource.d.ts +6 -0
- package/dist/models/CustomerListResource.js +4 -0
- package/dist/models/CustomerResource.d.ts +10 -2
- package/dist/models/CustomerResource.js +9 -3
- package/dist/models/NetsuiteSyncLiteResource.d.ts +44 -0
- package/dist/models/NetsuiteSyncLiteResource.js +59 -0
- package/dist/models/NetsuiteSyncLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/NetsuiteSyncLiteResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +1 -1
- package/dist/models/OrderFulfillmentResource.js +3 -1
- package/dist/models/RoleListResource.d.ts +6 -0
- package/dist/models/RoleListResource.js +4 -0
- package/dist/models/RoleResource.d.ts +9 -2
- package/dist/models/RoleResource.js +5 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/UpdateCustomerAddressRequest.d.ts +90 -0
- package/dist/models/UpdateCustomerAddressRequest.js +83 -0
- package/dist/models/UpdateCustomerRequest.d.ts +6 -0
- package/dist/models/UpdateCustomerRequest.js +2 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/docs/AdminResource.md +1 -1
- package/docs/AdminsApi.md +138 -0
- package/docs/AttachAdminsToRoleRequest.md +34 -0
- package/docs/AttachPermissionsToRoleRequest.md +34 -0
- package/docs/AttachRolesToAdminRequest.md +34 -0
- package/docs/CreateCustomerAddressRequest.md +50 -0
- package/docs/CreateCustomerRequest.md +2 -0
- package/docs/CustomerListResource.md +2 -0
- package/docs/CustomerResource.md +4 -2
- package/docs/CustomersApi.md +210 -0
- package/docs/NetsuiteSyncLiteResource.md +38 -0
- package/docs/NetsuiteSyncLiteResourceArrayResponse.md +34 -0
- package/docs/RoleListResource.md +2 -0
- package/docs/RoleResource.md +3 -1
- package/docs/RolesApi.md +276 -0
- package/docs/UpdateCustomerAddressRequest.md +50 -0
- package/docs/UpdateCustomerRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/AdminsApi.ts +116 -0
- package/src/apis/CustomersApi.ts +188 -0
- package/src/apis/RolesApi.ts +232 -0
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AdminResource.ts +2 -2
- package/src/models/AttachAdminsToRoleRequest.ts +66 -0
- package/src/models/AttachPermissionsToRoleRequest.ts +66 -0
- package/src/models/AttachRolesToAdminRequest.ts +66 -0
- package/src/models/CreateCustomerAddressRequest.ts +146 -0
- package/src/models/CreateCustomerRequest.ts +10 -3
- package/src/models/CustomerListResource.ts +9 -0
- package/src/models/CustomerResource.ts +28 -5
- package/src/models/NetsuiteSyncLiteResource.ts +84 -0
- package/src/models/NetsuiteSyncLiteResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +3 -2
- package/src/models/RoleListResource.ts +9 -0
- package/src/models/RoleResource.ts +18 -2
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +3 -2
- package/src/models/UpdateCustomerAddressRequest.ts +146 -0
- package/src/models/UpdateCustomerRequest.ts +8 -0
- package/src/models/index.ts +7 -0
package/docs/AdminsApi.md
CHANGED
|
@@ -4,7 +4,9 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**attachRolesAdminUser**](AdminsApi.md#attachrolesadminuser) | **POST** /admin-api/admins/{admin}/roles/attach | Auto-generated: attachRolesAdminUser |
|
|
7
8
|
| [**destroyAdminUser**](AdminsApi.md#destroyadminuser) | **DELETE** /admin-api/admins/{admin}/delete | Auto-generated: destroyAdminUser |
|
|
9
|
+
| [**detachRoleAdminUser**](AdminsApi.md#detachroleadminuser) | **DELETE** /admin-api/admins/{admin}/roles/{role} | Auto-generated: detachRoleAdminUser |
|
|
8
10
|
| [**getAllAdminUser**](AdminsApi.md#getalladminuser) | **POST** /admin-api/admins/all | Auto-generated: getAllAdminUser |
|
|
9
11
|
| [**indexAdminUser**](AdminsApi.md#indexadminuser) | **POST** /admin-api/admins/list | Auto-generated: indexAdminUser |
|
|
10
12
|
| [**showAdminUser**](AdminsApi.md#showadminuser) | **GET** /admin-api/admins/{admin} | Auto-generated: showAdminUser |
|
|
@@ -13,6 +15,74 @@ All URIs are relative to *http://localhost/api*
|
|
|
13
15
|
|
|
14
16
|
|
|
15
17
|
|
|
18
|
+
## attachRolesAdminUser
|
|
19
|
+
|
|
20
|
+
> AdminResource attachRolesAdminUser(admin, attachRolesToAdminRequest)
|
|
21
|
+
|
|
22
|
+
Auto-generated: attachRolesAdminUser
|
|
23
|
+
|
|
24
|
+
### Example
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import {
|
|
28
|
+
Configuration,
|
|
29
|
+
AdminsApi,
|
|
30
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
31
|
+
import type { AttachRolesAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
32
|
+
|
|
33
|
+
async function example() {
|
|
34
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
35
|
+
const api = new AdminsApi();
|
|
36
|
+
|
|
37
|
+
const body = {
|
|
38
|
+
// number | The id of the admin
|
|
39
|
+
admin: 56,
|
|
40
|
+
// AttachRolesToAdminRequest (optional)
|
|
41
|
+
attachRolesToAdminRequest: ...,
|
|
42
|
+
} satisfies AttachRolesAdminUserRequest;
|
|
43
|
+
|
|
44
|
+
try {
|
|
45
|
+
const data = await api.attachRolesAdminUser(body);
|
|
46
|
+
console.log(data);
|
|
47
|
+
} catch (error) {
|
|
48
|
+
console.error(error);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
// Run the test
|
|
53
|
+
example().catch(console.error);
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
| Name | Type | Description | Notes |
|
|
60
|
+
|------------- | ------------- | ------------- | -------------|
|
|
61
|
+
| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
|
|
62
|
+
| **attachRolesToAdminRequest** | [AttachRolesToAdminRequest](AttachRolesToAdminRequest.md) | | [Optional] |
|
|
63
|
+
|
|
64
|
+
### Return type
|
|
65
|
+
|
|
66
|
+
[**AdminResource**](AdminResource.md)
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
No authorization required
|
|
71
|
+
|
|
72
|
+
### HTTP request headers
|
|
73
|
+
|
|
74
|
+
- **Content-Type**: `application/json`
|
|
75
|
+
- **Accept**: `application/json`
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### HTTP response details
|
|
79
|
+
| Status code | Description | Response headers |
|
|
80
|
+
|-------------|-------------|------------------|
|
|
81
|
+
| **200** | Successful resource response | - |
|
|
82
|
+
|
|
83
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
|
+
|
|
85
|
+
|
|
16
86
|
## destroyAdminUser
|
|
17
87
|
|
|
18
88
|
> GenericResponse destroyAdminUser(admin)
|
|
@@ -78,6 +148,74 @@ No authorization required
|
|
|
78
148
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
149
|
|
|
80
150
|
|
|
151
|
+
## detachRoleAdminUser
|
|
152
|
+
|
|
153
|
+
> AdminResource detachRoleAdminUser(admin, role)
|
|
154
|
+
|
|
155
|
+
Auto-generated: detachRoleAdminUser
|
|
156
|
+
|
|
157
|
+
### Example
|
|
158
|
+
|
|
159
|
+
```ts
|
|
160
|
+
import {
|
|
161
|
+
Configuration,
|
|
162
|
+
AdminsApi,
|
|
163
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
164
|
+
import type { DetachRoleAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
165
|
+
|
|
166
|
+
async function example() {
|
|
167
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
168
|
+
const api = new AdminsApi();
|
|
169
|
+
|
|
170
|
+
const body = {
|
|
171
|
+
// number | The id of the admin
|
|
172
|
+
admin: 56,
|
|
173
|
+
// number | The id of the role
|
|
174
|
+
role: 56,
|
|
175
|
+
} satisfies DetachRoleAdminUserRequest;
|
|
176
|
+
|
|
177
|
+
try {
|
|
178
|
+
const data = await api.detachRoleAdminUser(body);
|
|
179
|
+
console.log(data);
|
|
180
|
+
} catch (error) {
|
|
181
|
+
console.error(error);
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
// Run the test
|
|
186
|
+
example().catch(console.error);
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Parameters
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
| Name | Type | Description | Notes |
|
|
193
|
+
|------------- | ------------- | ------------- | -------------|
|
|
194
|
+
| **admin** | `number` | The id of the admin | [Defaults to `undefined`] |
|
|
195
|
+
| **role** | `number` | The id of the role | [Defaults to `undefined`] |
|
|
196
|
+
|
|
197
|
+
### Return type
|
|
198
|
+
|
|
199
|
+
[**AdminResource**](AdminResource.md)
|
|
200
|
+
|
|
201
|
+
### Authorization
|
|
202
|
+
|
|
203
|
+
No authorization required
|
|
204
|
+
|
|
205
|
+
### HTTP request headers
|
|
206
|
+
|
|
207
|
+
- **Content-Type**: Not defined
|
|
208
|
+
- **Accept**: `application/json`
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
### HTTP response details
|
|
212
|
+
| Status code | Description | Response headers |
|
|
213
|
+
|-------------|-------------|------------------|
|
|
214
|
+
| **200** | Successful resource response | - |
|
|
215
|
+
|
|
216
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
217
|
+
|
|
218
|
+
|
|
81
219
|
## getAllAdminUser
|
|
82
220
|
|
|
83
221
|
> AdminLiteResourceArrayResponse getAllAdminUser(searchAllAdminUsersRequest)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AttachAdminsToRoleRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`adminIds` | Array<number>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AttachAdminsToRoleRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"adminIds": null,
|
|
19
|
+
} satisfies AttachAdminsToRoleRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachAdminsToRoleRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AttachPermissionsToRoleRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`permissionIds` | Array<number>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AttachPermissionsToRoleRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"permissionIds": null,
|
|
19
|
+
} satisfies AttachPermissionsToRoleRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachPermissionsToRoleRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AttachRolesToAdminRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`roleIds` | Array<number>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AttachRolesToAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"roleIds": null,
|
|
19
|
+
} satisfies AttachRolesToAdminRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachRolesToAdminRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# CreateCustomerAddressRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`addresseeName` | string
|
|
10
|
+
`company` | string
|
|
11
|
+
`line1` | string
|
|
12
|
+
`line2` | string
|
|
13
|
+
`suburb` | string
|
|
14
|
+
`state` | string
|
|
15
|
+
`postcode` | string
|
|
16
|
+
`country` | string
|
|
17
|
+
`type` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { CreateCustomerAddressRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"addresseeName": null,
|
|
27
|
+
"company": null,
|
|
28
|
+
"line1": null,
|
|
29
|
+
"line2": null,
|
|
30
|
+
"suburb": null,
|
|
31
|
+
"state": null,
|
|
32
|
+
"postcode": null,
|
|
33
|
+
"country": null,
|
|
34
|
+
"type": null,
|
|
35
|
+
} satisfies CreateCustomerAddressRequest
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as CreateCustomerAddressRequest
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`email` | string
|
|
14
14
|
`siteId` | number
|
|
15
15
|
`subscribedToNewsletter` | boolean
|
|
16
|
+
`netsuiteId` | number
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,6 +29,7 @@ const example = {
|
|
|
28
29
|
"email": null,
|
|
29
30
|
"siteId": null,
|
|
30
31
|
"subscribedToNewsletter": null,
|
|
32
|
+
"netsuiteId": null,
|
|
31
33
|
} satisfies CreateCustomerRequest
|
|
32
34
|
|
|
33
35
|
console.log(example)
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`signUpType` | string
|
|
14
14
|
`subscribedToNewsletter` | boolean
|
|
15
15
|
`netsuiteId` | object
|
|
16
|
+
`ordersCount` | number
|
|
16
17
|
`createdAt` | Date
|
|
17
18
|
|
|
18
19
|
## Example
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"signUpType": null,
|
|
30
31
|
"subscribedToNewsletter": null,
|
|
31
32
|
"netsuiteId": null,
|
|
33
|
+
"ordersCount": null,
|
|
32
34
|
"createdAt": null,
|
|
33
35
|
} satisfies CustomerListResource
|
|
34
36
|
|
package/docs/CustomerResource.md
CHANGED
|
@@ -13,7 +13,8 @@ Name | Type
|
|
|
13
13
|
`signUpType` | string
|
|
14
14
|
`socialId` | string
|
|
15
15
|
`subscribedToNewsletter` | boolean
|
|
16
|
-
`
|
|
16
|
+
`netsuiteSync` | [NetsuiteSyncLiteResource](NetsuiteSyncLiteResource.md)
|
|
17
|
+
`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
|
|
17
18
|
`addresses` | [Array<AddressResource>](AddressResource.md)
|
|
18
19
|
`createdAt` | Date
|
|
19
20
|
`updatedAt` | Date
|
|
@@ -32,7 +33,8 @@ const example = {
|
|
|
32
33
|
"signUpType": null,
|
|
33
34
|
"socialId": null,
|
|
34
35
|
"subscribedToNewsletter": null,
|
|
35
|
-
"
|
|
36
|
+
"netsuiteSync": null,
|
|
37
|
+
"omnisendSync": null,
|
|
36
38
|
"addresses": null,
|
|
37
39
|
"createdAt": null,
|
|
38
40
|
"updatedAt": null,
|
package/docs/CustomersApi.md
CHANGED
|
@@ -5,11 +5,14 @@ All URIs are relative to *http://localhost/api*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**destroyCustomer**](CustomersApi.md#destroycustomer) | **DELETE** /admin-api/customers/{customer}/delete | Auto-generated: destroyCustomer |
|
|
8
|
+
| [**destroyCustomerAddress**](CustomersApi.md#destroycustomeraddress) | **DELETE** /admin-api/customers/{customer}/addresses/{address} | Auto-generated: destroyCustomerAddress |
|
|
8
9
|
| [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
|
|
9
10
|
| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
|
|
10
11
|
| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
|
|
11
12
|
| [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
|
|
13
|
+
| [**storeCustomerAddress**](CustomersApi.md#storecustomeraddress) | **POST** /admin-api/customers/{customer}/addresses | Auto-generated: storeCustomerAddress |
|
|
12
14
|
| [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
|
|
15
|
+
| [**updateCustomerAddress**](CustomersApi.md#updatecustomeraddressoperation) | **PUT** /admin-api/customers/{customer}/addresses/{address} | Auto-generated: updateCustomerAddress |
|
|
13
16
|
|
|
14
17
|
|
|
15
18
|
|
|
@@ -78,6 +81,74 @@ No authorization required
|
|
|
78
81
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
82
|
|
|
80
83
|
|
|
84
|
+
## destroyCustomerAddress
|
|
85
|
+
|
|
86
|
+
> GenericResponse destroyCustomerAddress(customer, address)
|
|
87
|
+
|
|
88
|
+
Auto-generated: destroyCustomerAddress
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
import {
|
|
94
|
+
Configuration,
|
|
95
|
+
CustomersApi,
|
|
96
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
97
|
+
import type { DestroyCustomerAddressRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
98
|
+
|
|
99
|
+
async function example() {
|
|
100
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
101
|
+
const api = new CustomersApi();
|
|
102
|
+
|
|
103
|
+
const body = {
|
|
104
|
+
// number | The id of the customer
|
|
105
|
+
customer: 56,
|
|
106
|
+
// number | The id of the address
|
|
107
|
+
address: 56,
|
|
108
|
+
} satisfies DestroyCustomerAddressRequest;
|
|
109
|
+
|
|
110
|
+
try {
|
|
111
|
+
const data = await api.destroyCustomerAddress(body);
|
|
112
|
+
console.log(data);
|
|
113
|
+
} catch (error) {
|
|
114
|
+
console.error(error);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// Run the test
|
|
119
|
+
example().catch(console.error);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
| Name | Type | Description | Notes |
|
|
126
|
+
|------------- | ------------- | ------------- | -------------|
|
|
127
|
+
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
128
|
+
| **address** | `number` | The id of the address | [Defaults to `undefined`] |
|
|
129
|
+
|
|
130
|
+
### Return type
|
|
131
|
+
|
|
132
|
+
[**GenericResponse**](GenericResponse.md)
|
|
133
|
+
|
|
134
|
+
### Authorization
|
|
135
|
+
|
|
136
|
+
No authorization required
|
|
137
|
+
|
|
138
|
+
### HTTP request headers
|
|
139
|
+
|
|
140
|
+
- **Content-Type**: Not defined
|
|
141
|
+
- **Accept**: `application/json`
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### HTTP response details
|
|
145
|
+
| Status code | Description | Response headers |
|
|
146
|
+
|-------------|-------------|------------------|
|
|
147
|
+
| **200** | \\JsonResponse<array{message: string}> | - |
|
|
148
|
+
|
|
149
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
150
|
+
|
|
151
|
+
|
|
81
152
|
## getAllCustomer
|
|
82
153
|
|
|
83
154
|
> CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
|
|
@@ -338,6 +409,74 @@ No authorization required
|
|
|
338
409
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
339
410
|
|
|
340
411
|
|
|
412
|
+
## storeCustomerAddress
|
|
413
|
+
|
|
414
|
+
> AddressResource storeCustomerAddress(customer, createCustomerAddressRequest)
|
|
415
|
+
|
|
416
|
+
Auto-generated: storeCustomerAddress
|
|
417
|
+
|
|
418
|
+
### Example
|
|
419
|
+
|
|
420
|
+
```ts
|
|
421
|
+
import {
|
|
422
|
+
Configuration,
|
|
423
|
+
CustomersApi,
|
|
424
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
425
|
+
import type { StoreCustomerAddressRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
426
|
+
|
|
427
|
+
async function example() {
|
|
428
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
429
|
+
const api = new CustomersApi();
|
|
430
|
+
|
|
431
|
+
const body = {
|
|
432
|
+
// number | The id of the customer
|
|
433
|
+
customer: 56,
|
|
434
|
+
// CreateCustomerAddressRequest (optional)
|
|
435
|
+
createCustomerAddressRequest: ...,
|
|
436
|
+
} satisfies StoreCustomerAddressRequest;
|
|
437
|
+
|
|
438
|
+
try {
|
|
439
|
+
const data = await api.storeCustomerAddress(body);
|
|
440
|
+
console.log(data);
|
|
441
|
+
} catch (error) {
|
|
442
|
+
console.error(error);
|
|
443
|
+
}
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
// Run the test
|
|
447
|
+
example().catch(console.error);
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Parameters
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
| Name | Type | Description | Notes |
|
|
454
|
+
|------------- | ------------- | ------------- | -------------|
|
|
455
|
+
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
456
|
+
| **createCustomerAddressRequest** | [CreateCustomerAddressRequest](CreateCustomerAddressRequest.md) | | [Optional] |
|
|
457
|
+
|
|
458
|
+
### Return type
|
|
459
|
+
|
|
460
|
+
[**AddressResource**](AddressResource.md)
|
|
461
|
+
|
|
462
|
+
### Authorization
|
|
463
|
+
|
|
464
|
+
No authorization required
|
|
465
|
+
|
|
466
|
+
### HTTP request headers
|
|
467
|
+
|
|
468
|
+
- **Content-Type**: `application/json`
|
|
469
|
+
- **Accept**: `application/json`
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
### HTTP response details
|
|
473
|
+
| Status code | Description | Response headers |
|
|
474
|
+
|-------------|-------------|------------------|
|
|
475
|
+
| **200** | Successful resource response | - |
|
|
476
|
+
|
|
477
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
478
|
+
|
|
479
|
+
|
|
341
480
|
## updateCustomer
|
|
342
481
|
|
|
343
482
|
> CustomerResource updateCustomer(customer, updateCustomerRequest)
|
|
@@ -405,3 +544,74 @@ No authorization required
|
|
|
405
544
|
|
|
406
545
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
407
546
|
|
|
547
|
+
|
|
548
|
+
## updateCustomerAddress
|
|
549
|
+
|
|
550
|
+
> AddressResource updateCustomerAddress(customer, address, updateCustomerAddressRequest)
|
|
551
|
+
|
|
552
|
+
Auto-generated: updateCustomerAddress
|
|
553
|
+
|
|
554
|
+
### Example
|
|
555
|
+
|
|
556
|
+
```ts
|
|
557
|
+
import {
|
|
558
|
+
Configuration,
|
|
559
|
+
CustomersApi,
|
|
560
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
561
|
+
import type { UpdateCustomerAddressOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
562
|
+
|
|
563
|
+
async function example() {
|
|
564
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
565
|
+
const api = new CustomersApi();
|
|
566
|
+
|
|
567
|
+
const body = {
|
|
568
|
+
// number | The id of the customer
|
|
569
|
+
customer: 56,
|
|
570
|
+
// number | The id of the address
|
|
571
|
+
address: 56,
|
|
572
|
+
// UpdateCustomerAddressRequest (optional)
|
|
573
|
+
updateCustomerAddressRequest: ...,
|
|
574
|
+
} satisfies UpdateCustomerAddressOperationRequest;
|
|
575
|
+
|
|
576
|
+
try {
|
|
577
|
+
const data = await api.updateCustomerAddress(body);
|
|
578
|
+
console.log(data);
|
|
579
|
+
} catch (error) {
|
|
580
|
+
console.error(error);
|
|
581
|
+
}
|
|
582
|
+
}
|
|
583
|
+
|
|
584
|
+
// Run the test
|
|
585
|
+
example().catch(console.error);
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### Parameters
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
| Name | Type | Description | Notes |
|
|
592
|
+
|------------- | ------------- | ------------- | -------------|
|
|
593
|
+
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
594
|
+
| **address** | `number` | The id of the address | [Defaults to `undefined`] |
|
|
595
|
+
| **updateCustomerAddressRequest** | [UpdateCustomerAddressRequest](UpdateCustomerAddressRequest.md) | | [Optional] |
|
|
596
|
+
|
|
597
|
+
### Return type
|
|
598
|
+
|
|
599
|
+
[**AddressResource**](AddressResource.md)
|
|
600
|
+
|
|
601
|
+
### Authorization
|
|
602
|
+
|
|
603
|
+
No authorization required
|
|
604
|
+
|
|
605
|
+
### HTTP request headers
|
|
606
|
+
|
|
607
|
+
- **Content-Type**: `application/json`
|
|
608
|
+
- **Accept**: `application/json`
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
### HTTP response details
|
|
612
|
+
| Status code | Description | Response headers |
|
|
613
|
+
|-------------|-------------|------------------|
|
|
614
|
+
| **200** | Successful resource response | - |
|
|
615
|
+
|
|
616
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
617
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# NetsuiteSyncLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`netsuiteId` | string
|
|
11
|
+
`syncStatus` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { NetsuiteSyncLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"netsuiteId": null,
|
|
22
|
+
"syncStatus": null,
|
|
23
|
+
} satisfies NetsuiteSyncLiteResource
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as NetsuiteSyncLiteResource
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# NetsuiteSyncLiteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<NetsuiteSyncLiteResource>](NetsuiteSyncLiteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { NetsuiteSyncLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies NetsuiteSyncLiteResourceArrayResponse
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as NetsuiteSyncLiteResourceArrayResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
package/docs/RoleListResource.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`name` | string
|
|
11
11
|
`isLocked` | boolean
|
|
12
12
|
`permissionCount` | number
|
|
13
|
+
`adminsCount` | number
|
|
13
14
|
`permissions` | object
|
|
14
15
|
`createdAt` | Date
|
|
15
16
|
`updatedAt` | Date
|
|
@@ -25,6 +26,7 @@ const example = {
|
|
|
25
26
|
"name": null,
|
|
26
27
|
"isLocked": null,
|
|
27
28
|
"permissionCount": null,
|
|
29
|
+
"adminsCount": null,
|
|
28
30
|
"permissions": null,
|
|
29
31
|
"createdAt": null,
|
|
30
32
|
"updatedAt": null,
|