@digital8/lighting-illusions-ts-sdk 0.0.2308 → 0.0.2310
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 +0 -68
- package/README.md +2 -56
- package/dist/apis/AdminsApi.d.ts +0 -33
- package/dist/apis/AdminsApi.js +0 -125
- package/dist/apis/CustomersApi.d.ts +0 -52
- package/dist/apis/CustomersApi.js +0 -192
- package/dist/apis/index.d.ts +0 -3
- package/dist/apis/index.js +0 -3
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +4 -4
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AdminListResource.d.ts +1 -1
- package/dist/models/AdminListResource.js +1 -3
- package/dist/models/AdminLiteResource.d.ts +1 -1
- package/dist/models/AdminLiteResource.js +1 -3
- package/dist/models/AdminNoteResource.d.ts +3 -3
- package/dist/models/AdminNoteResource.js +3 -3
- package/dist/models/AdminOrderResource.d.ts +3 -3
- package/dist/models/AdminOrderResource.js +3 -3
- package/dist/models/AdminResource.d.ts +1 -7
- package/dist/models/AdminResource.js +1 -7
- package/dist/models/AdminUserLiteResource.d.ts +1 -1
- package/dist/models/AdminUserLiteResource.js +1 -3
- package/dist/models/CartResource.d.ts +3 -3
- package/dist/models/CartResource.js +3 -3
- package/dist/models/CreateAdminUserRequest.d.ts +6 -0
- package/dist/models/CreateAdminUserRequest.js +4 -0
- package/dist/models/CreateCustomerRequest.d.ts +1 -7
- package/dist/models/CreateCustomerRequest.js +3 -3
- package/dist/models/CustomerListResource.d.ts +0 -6
- package/dist/models/CustomerListResource.js +0 -4
- package/dist/models/CustomerResource.d.ts +2 -10
- package/dist/models/CustomerResource.js +3 -9
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/OrderFulfillmentResource.d.ts +1 -1
- package/dist/models/OrderFulfillmentResource.js +1 -3
- package/dist/models/RoleLiteResource.d.ts +0 -6
- package/dist/models/RoleLiteResource.js +0 -4
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +4 -4
- package/dist/models/StoreListResource.d.ts +2 -2
- package/dist/models/StoreListResource.js +4 -4
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +3 -1
- package/dist/models/UpdateAdminUserRequest.d.ts +6 -0
- package/dist/models/UpdateAdminUserRequest.js +4 -0
- package/dist/models/UpdateCustomerRequest.d.ts +0 -6
- package/dist/models/UpdateCustomerRequest.js +0 -2
- package/dist/models/index.d.ts +0 -31
- package/dist/models/index.js +0 -31
- package/docs/AdminNoteResource.md +1 -1
- package/docs/AdminOrderResource.md +1 -1
- package/docs/AdminResource.md +0 -2
- package/docs/AdminsApi.md +0 -138
- package/docs/CartResource.md +1 -1
- package/docs/CreateAdminUserRequest.md +2 -0
- package/docs/CreateCustomerRequest.md +0 -2
- package/docs/CustomerListResource.md +0 -2
- package/docs/CustomerResource.md +2 -4
- package/docs/CustomersApi.md +0 -210
- package/docs/RoleLiteResource.md +0 -2
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/UpdateAdminUserRequest.md +2 -0
- package/docs/UpdateCustomerRequest.md +0 -2
- package/package.json +1 -1
- package/src/apis/AdminsApi.ts +0 -116
- package/src/apis/CustomersApi.ts +0 -188
- package/src/apis/index.ts +0 -3
- package/src/models/AddressFrontendResource.ts +5 -5
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminListResource.ts +2 -3
- package/src/models/AdminLiteResource.ts +2 -3
- package/src/models/AdminNoteResource.ts +10 -10
- package/src/models/AdminOrderResource.ts +11 -11
- package/src/models/AdminResource.ts +2 -12
- package/src/models/AdminUserLiteResource.ts +2 -3
- package/src/models/CartResource.ts +10 -10
- package/src/models/CreateAdminUserRequest.ts +9 -0
- package/src/models/CreateCustomerRequest.ts +3 -10
- package/src/models/CustomerListResource.ts +0 -9
- package/src/models/CustomerResource.ts +5 -28
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/OrderFulfillmentResource.ts +2 -3
- package/src/models/RoleLiteResource.ts +0 -9
- package/src/models/StoreFrontendResource.ts +5 -5
- package/src/models/StoreListResource.ts +5 -5
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/StoreSpecialDateResource.ts +4 -3
- package/src/models/UpdateAdminUserRequest.ts +9 -0
- package/src/models/UpdateCustomerRequest.ts +0 -8
- package/src/models/index.ts +0 -31
- package/dist/apis/AuthApi.d.ts +0 -92
- package/dist/apis/AuthApi.js +0 -369
- package/dist/apis/PermissionsApi.d.ts +0 -67
- package/dist/apis/PermissionsApi.js +0 -259
- package/dist/apis/RolesApi.d.ts +0 -182
- package/dist/apis/RolesApi.js +0 -690
- package/dist/models/AdminLoginResponseResource.d.ts +0 -39
- package/dist/models/AdminLoginResponseResource.js +0 -56
- package/dist/models/AdminLoginResponseResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminLoginResponseResourceArrayResponse.js +0 -50
- package/dist/models/AttachAdminsToRoleRequest.d.ts +0 -32
- package/dist/models/AttachAdminsToRoleRequest.js +0 -51
- package/dist/models/AttachPermissionsToRoleRequest.d.ts +0 -32
- package/dist/models/AttachPermissionsToRoleRequest.js +0 -51
- package/dist/models/AttachRolesToAdminRequest.d.ts +0 -32
- package/dist/models/AttachRolesToAdminRequest.js +0 -51
- package/dist/models/CreateCustomerAddressRequest.d.ts +0 -90
- package/dist/models/CreateCustomerAddressRequest.js +0 -83
- package/dist/models/CreateRoleRequest.d.ts +0 -38
- package/dist/models/CreateRoleRequest.js +0 -55
- package/dist/models/ForgotPasswordAdminRequest.d.ts +0 -32
- package/dist/models/ForgotPasswordAdminRequest.js +0 -51
- package/dist/models/LoginAdminRequest.d.ts +0 -38
- package/dist/models/LoginAdminRequest.js +0 -55
- package/dist/models/NetsuiteSyncLiteResource.d.ts +0 -44
- package/dist/models/NetsuiteSyncLiteResource.js +0 -59
- package/dist/models/NetsuiteSyncLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/NetsuiteSyncLiteResourceArrayResponse.js +0 -50
- package/dist/models/PaginatedPermissionListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedPermissionListResourceResponse.js +0 -57
- package/dist/models/PaginatedPermissionLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedPermissionLiteResourceResponse.js +0 -57
- package/dist/models/PaginatedRoleListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedRoleListResourceResponse.js +0 -57
- package/dist/models/PermissionListResource.d.ts +0 -44
- package/dist/models/PermissionListResource.js +0 -55
- package/dist/models/PermissionListResourceArrayResponse.d.ts +0 -33
- package/dist/models/PermissionListResourceArrayResponse.js +0 -50
- package/dist/models/PermissionLiteResource.d.ts +0 -38
- package/dist/models/PermissionLiteResource.js +0 -53
- package/dist/models/PermissionLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/PermissionLiteResourceArrayResponse.js +0 -50
- package/dist/models/PermissionResource.d.ts +0 -56
- package/dist/models/PermissionResource.js +0 -61
- package/dist/models/PermissionResourceArrayResponse.d.ts +0 -33
- package/dist/models/PermissionResourceArrayResponse.js +0 -50
- package/dist/models/ResetPasswordAdminRequest.d.ts +0 -44
- package/dist/models/ResetPasswordAdminRequest.js +0 -59
- package/dist/models/RoleListResource.d.ts +0 -74
- package/dist/models/RoleListResource.js +0 -73
- package/dist/models/RoleListResourceArrayResponse.d.ts +0 -33
- package/dist/models/RoleListResourceArrayResponse.js +0 -50
- package/dist/models/RoleResource.d.ts +0 -82
- package/dist/models/RoleResource.js +0 -79
- package/dist/models/RoleResourceArrayResponse.d.ts +0 -33
- package/dist/models/RoleResourceArrayResponse.js +0 -50
- package/dist/models/SearchAllPermissionsRequest.d.ts +0 -79
- package/dist/models/SearchAllPermissionsRequest.js +0 -75
- package/dist/models/SearchAllRolesRequest.d.ts +0 -86
- package/dist/models/SearchAllRolesRequest.js +0 -78
- package/dist/models/SearchPermissionsRequest.d.ts +0 -91
- package/dist/models/SearchPermissionsRequest.js +0 -79
- package/dist/models/SearchRolesRequest.d.ts +0 -98
- package/dist/models/SearchRolesRequest.js +0 -82
- package/dist/models/UpdateCustomerAddressRequest.d.ts +0 -90
- package/dist/models/UpdateCustomerAddressRequest.js +0 -83
- package/dist/models/UpdateRoleRequest.d.ts +0 -38
- package/dist/models/UpdateRoleRequest.js +0 -55
- package/docs/AdminLoginResponseResource.md +0 -36
- package/docs/AdminLoginResponseResourceArrayResponse.md +0 -34
- package/docs/AttachAdminsToRoleRequest.md +0 -34
- package/docs/AttachPermissionsToRoleRequest.md +0 -34
- package/docs/AttachRolesToAdminRequest.md +0 -34
- package/docs/AuthApi.md +0 -322
- package/docs/CreateCustomerAddressRequest.md +0 -50
- package/docs/CreateRoleRequest.md +0 -36
- package/docs/ForgotPasswordAdminRequest.md +0 -34
- package/docs/LoginAdminRequest.md +0 -36
- package/docs/NetsuiteSyncLiteResource.md +0 -38
- package/docs/NetsuiteSyncLiteResourceArrayResponse.md +0 -34
- package/docs/PaginatedPermissionListResourceResponse.md +0 -36
- package/docs/PaginatedPermissionLiteResourceResponse.md +0 -36
- package/docs/PaginatedRoleListResourceResponse.md +0 -36
- package/docs/PermissionListResource.md +0 -38
- package/docs/PermissionListResourceArrayResponse.md +0 -34
- package/docs/PermissionLiteResource.md +0 -36
- package/docs/PermissionLiteResourceArrayResponse.md +0 -34
- package/docs/PermissionResource.md +0 -42
- package/docs/PermissionResourceArrayResponse.md +0 -34
- package/docs/PermissionsApi.md +0 -206
- package/docs/ResetPasswordAdminRequest.md +0 -38
- package/docs/RoleListResource.md +0 -48
- package/docs/RoleListResourceArrayResponse.md +0 -34
- package/docs/RoleResource.md +0 -50
- package/docs/RoleResourceArrayResponse.md +0 -34
- package/docs/RolesApi.md +0 -683
- package/docs/SearchAllPermissionsRequest.md +0 -44
- package/docs/SearchAllRolesRequest.md +0 -46
- package/docs/SearchPermissionsRequest.md +0 -48
- package/docs/SearchRolesRequest.md +0 -50
- package/docs/UpdateCustomerAddressRequest.md +0 -50
- package/docs/UpdateRoleRequest.md +0 -36
- package/src/apis/AuthApi.ts +0 -258
- package/src/apis/PermissionsApi.ts +0 -184
- package/src/apis/RolesApi.ts +0 -577
- package/src/models/AdminLoginResponseResource.ts +0 -83
- package/src/models/AdminLoginResponseResourceArrayResponse.ts +0 -73
- package/src/models/AttachAdminsToRoleRequest.ts +0 -66
- package/src/models/AttachPermissionsToRoleRequest.ts +0 -66
- package/src/models/AttachRolesToAdminRequest.ts +0 -66
- package/src/models/CreateCustomerAddressRequest.ts +0 -146
- package/src/models/CreateRoleRequest.ts +0 -75
- package/src/models/ForgotPasswordAdminRequest.ts +0 -66
- package/src/models/LoginAdminRequest.ts +0 -75
- package/src/models/NetsuiteSyncLiteResource.ts +0 -84
- package/src/models/NetsuiteSyncLiteResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedPermissionListResourceResponse.ts +0 -90
- package/src/models/PaginatedPermissionLiteResourceResponse.ts +0 -90
- package/src/models/PaginatedRoleListResourceResponse.ts +0 -90
- package/src/models/PermissionListResource.ts +0 -82
- package/src/models/PermissionListResourceArrayResponse.ts +0 -73
- package/src/models/PermissionLiteResource.ts +0 -74
- package/src/models/PermissionLiteResourceArrayResponse.ts +0 -73
- package/src/models/PermissionResource.ts +0 -99
- package/src/models/PermissionResourceArrayResponse.ts +0 -73
- package/src/models/ResetPasswordAdminRequest.ts +0 -84
- package/src/models/RoleListResource.ts +0 -126
- package/src/models/RoleListResourceArrayResponse.ts +0 -73
- package/src/models/RoleResource.ts +0 -150
- package/src/models/RoleResourceArrayResponse.ts +0 -73
- package/src/models/SearchAllPermissionsRequest.ts +0 -126
- package/src/models/SearchAllRolesRequest.ts +0 -135
- package/src/models/SearchPermissionsRequest.ts +0 -142
- package/src/models/SearchRolesRequest.ts +0 -151
- package/src/models/UpdateCustomerAddressRequest.ts +0 -146
- package/src/models/UpdateRoleRequest.ts +0 -75
package/docs/AdminsApi.md
CHANGED
|
@@ -4,9 +4,7 @@ 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 |
|
|
8
7
|
| [**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 |
|
|
10
8
|
| [**getAllAdminUser**](AdminsApi.md#getalladminuser) | **POST** /admin-api/admins/all | Auto-generated: getAllAdminUser |
|
|
11
9
|
| [**indexAdminUser**](AdminsApi.md#indexadminuser) | **POST** /admin-api/admins/list | Auto-generated: indexAdminUser |
|
|
12
10
|
| [**showAdminUser**](AdminsApi.md#showadminuser) | **GET** /admin-api/admins/{admin} | Auto-generated: showAdminUser |
|
|
@@ -15,74 +13,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
15
13
|
|
|
16
14
|
|
|
17
15
|
|
|
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
|
-
|
|
86
16
|
## destroyAdminUser
|
|
87
17
|
|
|
88
18
|
> GenericResponse destroyAdminUser(admin)
|
|
@@ -148,74 +78,6 @@ No authorization required
|
|
|
148
78
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
149
79
|
|
|
150
80
|
|
|
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
|
-
|
|
219
81
|
## getAllAdminUser
|
|
220
82
|
|
|
221
83
|
> AdminLiteResourceArrayResponse getAllAdminUser(searchAllAdminUsersRequest)
|
package/docs/CartResource.md
CHANGED
|
@@ -22,7 +22,7 @@ Name | Type
|
|
|
22
22
|
`includeInsurance` | boolean
|
|
23
23
|
`overrideInsurance` | boolean
|
|
24
24
|
`useAsBillingAddress` | boolean
|
|
25
|
-
`admin` | [
|
|
25
|
+
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
26
26
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
27
27
|
`customer` | [CustomerResource](CustomerResource.md)
|
|
28
28
|
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`phone` | string
|
|
12
12
|
`password` | string
|
|
13
13
|
`email` | string
|
|
14
|
+
`roleIds` | Array<number>
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"phone": null,
|
|
25
26
|
"password": null,
|
|
26
27
|
"email": null,
|
|
28
|
+
"roleIds": null,
|
|
27
29
|
} satisfies CreateAdminUserRequest
|
|
28
30
|
|
|
29
31
|
console.log(example)
|
|
@@ -13,7 +13,6 @@ Name | Type
|
|
|
13
13
|
`email` | string
|
|
14
14
|
`siteId` | number
|
|
15
15
|
`subscribedToNewsletter` | boolean
|
|
16
|
-
`netsuiteId` | number
|
|
17
16
|
|
|
18
17
|
## Example
|
|
19
18
|
|
|
@@ -29,7 +28,6 @@ const example = {
|
|
|
29
28
|
"email": null,
|
|
30
29
|
"siteId": null,
|
|
31
30
|
"subscribedToNewsletter": null,
|
|
32
|
-
"netsuiteId": null,
|
|
33
31
|
} satisfies CreateCustomerRequest
|
|
34
32
|
|
|
35
33
|
console.log(example)
|
|
@@ -13,7 +13,6 @@ Name | Type
|
|
|
13
13
|
`signUpType` | string
|
|
14
14
|
`subscribedToNewsletter` | boolean
|
|
15
15
|
`netsuiteId` | object
|
|
16
|
-
`ordersCount` | number
|
|
17
16
|
`createdAt` | Date
|
|
18
17
|
|
|
19
18
|
## Example
|
|
@@ -30,7 +29,6 @@ const example = {
|
|
|
30
29
|
"signUpType": null,
|
|
31
30
|
"subscribedToNewsletter": null,
|
|
32
31
|
"netsuiteId": null,
|
|
33
|
-
"ordersCount": null,
|
|
34
32
|
"createdAt": null,
|
|
35
33
|
} satisfies CustomerListResource
|
|
36
34
|
|
package/docs/CustomerResource.md
CHANGED
|
@@ -13,8 +13,7 @@ Name | Type
|
|
|
13
13
|
`signUpType` | string
|
|
14
14
|
`socialId` | string
|
|
15
15
|
`subscribedToNewsletter` | boolean
|
|
16
|
-
`
|
|
17
|
-
`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
|
|
16
|
+
`netsuiteId` | string
|
|
18
17
|
`addresses` | [Array<AddressResource>](AddressResource.md)
|
|
19
18
|
`createdAt` | Date
|
|
20
19
|
`updatedAt` | Date
|
|
@@ -33,8 +32,7 @@ const example = {
|
|
|
33
32
|
"signUpType": null,
|
|
34
33
|
"socialId": null,
|
|
35
34
|
"subscribedToNewsletter": null,
|
|
36
|
-
"
|
|
37
|
-
"omnisendSync": null,
|
|
35
|
+
"netsuiteId": null,
|
|
38
36
|
"addresses": null,
|
|
39
37
|
"createdAt": null,
|
|
40
38
|
"updatedAt": null,
|
package/docs/CustomersApi.md
CHANGED
|
@@ -5,14 +5,11 @@ 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 |
|
|
9
8
|
| [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
|
|
10
9
|
| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
|
|
11
10
|
| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
|
|
12
11
|
| [**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 |
|
|
14
12
|
| [**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 |
|
|
16
13
|
|
|
17
14
|
|
|
18
15
|
|
|
@@ -81,74 +78,6 @@ No authorization required
|
|
|
81
78
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
82
79
|
|
|
83
80
|
|
|
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
|
-
|
|
152
81
|
## getAllCustomer
|
|
153
82
|
|
|
154
83
|
> CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
|
|
@@ -409,74 +338,6 @@ No authorization required
|
|
|
409
338
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
410
339
|
|
|
411
340
|
|
|
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
|
-
|
|
480
341
|
## updateCustomer
|
|
481
342
|
|
|
482
343
|
> CustomerResource updateCustomer(customer, updateCustomerRequest)
|
|
@@ -544,74 +405,3 @@ No authorization required
|
|
|
544
405
|
|
|
545
406
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
546
407
|
|
|
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
|
-
|
package/docs/RoleLiteResource.md
CHANGED
|
@@ -8,7 +8,6 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`name` | string
|
|
11
|
-
`isLocked` | boolean
|
|
12
11
|
|
|
13
12
|
## Example
|
|
14
13
|
|
|
@@ -19,7 +18,6 @@ import type { RoleLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
19
18
|
const example = {
|
|
20
19
|
"id": null,
|
|
21
20
|
"name": null,
|
|
22
|
-
"isLocked": null,
|
|
23
21
|
} satisfies RoleLiteResource
|
|
24
22
|
|
|
25
23
|
console.log(example)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`phone` | string
|
|
12
12
|
`password` | string
|
|
13
13
|
`email` | string
|
|
14
|
+
`roleIds` | Array<number>
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const example = {
|
|
|
24
25
|
"phone": null,
|
|
25
26
|
"password": null,
|
|
26
27
|
"email": null,
|
|
28
|
+
"roleIds": null,
|
|
27
29
|
} satisfies UpdateAdminUserRequest
|
|
28
30
|
|
|
29
31
|
console.log(example)
|
|
@@ -12,7 +12,6 @@ Name | Type
|
|
|
12
12
|
`password` | string
|
|
13
13
|
`email` | string
|
|
14
14
|
`subscribedToNewsletter` | boolean
|
|
15
|
-
`netsuiteId` | number
|
|
16
15
|
|
|
17
16
|
## Example
|
|
18
17
|
|
|
@@ -27,7 +26,6 @@ const example = {
|
|
|
27
26
|
"password": null,
|
|
28
27
|
"email": null,
|
|
29
28
|
"subscribedToNewsletter": null,
|
|
30
|
-
"netsuiteId": null,
|
|
31
29
|
} satisfies UpdateCustomerRequest
|
|
32
30
|
|
|
33
31
|
console.log(example)
|