@digital8/lighting-illusions-ts-sdk 0.0.2201 → 0.0.2202
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 -64
- package/README.md +2 -42
- package/dist/apis/CustomersApi.d.ts +0 -50
- package/dist/apis/CustomersApi.js +0 -182
- package/dist/apis/index.d.ts +0 -1
- package/dist/apis/index.js +0 -1
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AddressType.d.ts +0 -2
- package/dist/models/AddressType.js +1 -3
- package/dist/models/CreateCustomerRequest.d.ts +6 -18
- package/dist/models/CreateCustomerRequest.js +6 -12
- package/dist/models/CreateSupplierRequest.d.ts +6 -0
- package/dist/models/CreateSupplierRequest.js +2 -0
- package/dist/models/CustomerListResource.d.ts +8 -21
- package/dist/models/CustomerListResource.js +13 -20
- package/dist/models/CustomerResource.d.ts +9 -34
- package/dist/models/CustomerResource.js +16 -27
- package/dist/models/SearchCustomersRequest.d.ts +3 -31
- package/dist/models/SearchCustomersRequest.js +3 -15
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/SupplierFrontendResource.d.ts +6 -0
- package/dist/models/SupplierFrontendResource.js +4 -0
- package/dist/models/SupplierResource.d.ts +6 -0
- package/dist/models/SupplierResource.js +4 -0
- package/dist/models/UpdateSupplierRequest.d.ts +6 -0
- package/dist/models/UpdateSupplierRequest.js +2 -0
- package/dist/models/index.d.ts +0 -31
- package/dist/models/index.js +0 -31
- package/docs/CreateCustomerRequest.md +4 -8
- package/docs/CreateSupplierRequest.md +2 -0
- package/docs/CustomerListResource.md +8 -12
- package/docs/CustomerResource.md +9 -17
- package/docs/CustomersApi.md +0 -201
- package/docs/SearchCustomersRequest.md +0 -8
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/SupplierFrontendResource.md +2 -0
- package/docs/SupplierResource.md +2 -0
- package/docs/UpdateSupplierRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/CustomersApi.ts +0 -166
- package/src/apis/index.ts +0 -1
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AddressType.ts +1 -3
- package/src/models/CreateCustomerRequest.ts +11 -28
- package/src/models/CreateSupplierRequest.ts +8 -0
- package/src/models/CustomerListResource.ts +20 -44
- package/src/models/CustomerResource.ts +28 -68
- package/src/models/SearchCustomersRequest.ts +3 -39
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/SupplierFrontendResource.ts +9 -0
- package/src/models/SupplierResource.ts +9 -0
- package/src/models/UpdateSupplierRequest.ts +8 -0
- package/src/models/index.ts +0 -31
- package/dist/apis/AdminsApi.d.ts +0 -116
- package/dist/apis/AdminsApi.js +0 -440
- package/dist/models/AdminListResource.d.ts +0 -52
- package/dist/models/AdminListResource.js +0 -61
- package/dist/models/AdminListResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminListResourceArrayResponse.js +0 -50
- package/dist/models/AdminLiteResource.d.ts +0 -39
- package/dist/models/AdminLiteResource.js +0 -54
- package/dist/models/AdminLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminLiteResourceArrayResponse.js +0 -50
- package/dist/models/AdminResource.d.ts +0 -58
- package/dist/models/AdminResource.js +0 -63
- package/dist/models/AdminResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminResourceArrayResponse.js +0 -50
- package/dist/models/CheckEmailFrontendResource.d.ts +0 -38
- package/dist/models/CheckEmailFrontendResource.js +0 -53
- package/dist/models/CheckEmailFrontendResourceArrayResponse.d.ts +0 -33
- package/dist/models/CheckEmailFrontendResourceArrayResponse.js +0 -50
- package/dist/models/CreateAdminUserRequest.d.ts +0 -62
- package/dist/models/CreateAdminUserRequest.js +0 -69
- package/dist/models/CustomerAuthResponseResource.d.ts +0 -39
- package/dist/models/CustomerAuthResponseResource.js +0 -56
- package/dist/models/CustomerAuthResponseResourceArrayResponse.d.ts +0 -33
- package/dist/models/CustomerAuthResponseResourceArrayResponse.js +0 -50
- package/dist/models/CustomerFrontendResource.d.ts +0 -70
- package/dist/models/CustomerFrontendResource.js +0 -75
- package/dist/models/CustomerFrontendResourceArrayResponse.d.ts +0 -33
- package/dist/models/CustomerFrontendResourceArrayResponse.js +0 -50
- package/dist/models/CustomerSocialLinkableResource.d.ts +0 -38
- package/dist/models/CustomerSocialLinkableResource.js +0 -55
- package/dist/models/CustomerSocialLinkableResourceArrayResponse.d.ts +0 -33
- package/dist/models/CustomerSocialLinkableResourceArrayResponse.js +0 -50
- package/dist/models/CustomerType.d.ts +0 -25
- package/dist/models/CustomerType.js +0 -51
- package/dist/models/PaginatedAdminListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAdminListResourceResponse.js +0 -57
- package/dist/models/PaginatedAdminLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedAdminLiteResourceResponse.js +0 -57
- package/dist/models/PaginatedRoleLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedRoleLiteResourceResponse.js +0 -57
- package/dist/models/RoleLiteResource.d.ts +0 -38
- package/dist/models/RoleLiteResource.js +0 -53
- package/dist/models/RoleLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/RoleLiteResourceArrayResponse.js +0 -50
- package/dist/models/SearchAdminUsersRequest.d.ts +0 -112
- package/dist/models/SearchAdminUsersRequest.js +0 -88
- package/dist/models/SearchAllAdminUsersRequest.d.ts +0 -82
- package/dist/models/SearchAllAdminUsersRequest.js +0 -78
- package/dist/models/SearchAllCustomersRequest.d.ts +0 -103
- package/dist/models/SearchAllCustomersRequest.js +0 -87
- package/dist/models/SignUpType.d.ts +0 -29
- package/dist/models/SignUpType.js +0 -55
- package/dist/models/SocialProvider.d.ts +0 -26
- package/dist/models/SocialProvider.js +0 -52
- package/dist/models/UpdateAdminUserRequest.d.ts +0 -62
- package/dist/models/UpdateAdminUserRequest.js +0 -67
- package/dist/models/UpdateCustomerRequest.d.ts +0 -62
- package/dist/models/UpdateCustomerRequest.js +0 -65
- package/dist/models/UserLiteResource.d.ts +0 -62
- package/dist/models/UserLiteResource.js +0 -69
- package/dist/models/UserLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/UserLiteResourceArrayResponse.js +0 -50
- package/dist/models/UserType.d.ts +0 -25
- package/dist/models/UserType.js +0 -51
- package/docs/AdminListResource.md +0 -40
- package/docs/AdminListResourceArrayResponse.md +0 -34
- package/docs/AdminLiteResource.md +0 -36
- package/docs/AdminLiteResourceArrayResponse.md +0 -34
- package/docs/AdminResource.md +0 -42
- package/docs/AdminResourceArrayResponse.md +0 -34
- package/docs/AdminsApi.md +0 -407
- package/docs/CheckEmailFrontendResource.md +0 -36
- package/docs/CheckEmailFrontendResourceArrayResponse.md +0 -34
- package/docs/CreateAdminUserRequest.md +0 -44
- package/docs/CustomerAuthResponseResource.md +0 -36
- package/docs/CustomerAuthResponseResourceArrayResponse.md +0 -34
- package/docs/CustomerFrontendResource.md +0 -46
- package/docs/CustomerFrontendResourceArrayResponse.md +0 -34
- package/docs/CustomerSocialLinkableResource.md +0 -36
- package/docs/CustomerSocialLinkableResourceArrayResponse.md +0 -34
- package/docs/CustomerType.md +0 -32
- package/docs/PaginatedAdminListResourceResponse.md +0 -36
- package/docs/PaginatedAdminLiteResourceResponse.md +0 -36
- package/docs/PaginatedRoleLiteResourceResponse.md +0 -36
- package/docs/RoleLiteResource.md +0 -36
- package/docs/RoleLiteResourceArrayResponse.md +0 -34
- package/docs/SearchAdminUsersRequest.md +0 -54
- package/docs/SearchAllAdminUsersRequest.md +0 -44
- package/docs/SearchAllCustomersRequest.md +0 -50
- package/docs/SignUpType.md +0 -32
- package/docs/SocialProvider.md +0 -32
- package/docs/UpdateAdminUserRequest.md +0 -44
- package/docs/UpdateCustomerRequest.md +0 -44
- package/docs/UserLiteResource.md +0 -44
- package/docs/UserLiteResourceArrayResponse.md +0 -34
- package/docs/UserType.md +0 -32
- package/src/apis/AdminsApi.ts +0 -345
- package/src/models/AdminListResource.ts +0 -106
- package/src/models/AdminListResourceArrayResponse.ts +0 -73
- package/src/models/AdminLiteResource.ts +0 -82
- package/src/models/AdminLiteResourceArrayResponse.ts +0 -73
- package/src/models/AdminResource.ts +0 -114
- package/src/models/AdminResourceArrayResponse.ts +0 -73
- package/src/models/CheckEmailFrontendResource.ts +0 -74
- package/src/models/CheckEmailFrontendResourceArrayResponse.ts +0 -73
- package/src/models/CreateAdminUserRequest.ts +0 -110
- package/src/models/CustomerAuthResponseResource.ts +0 -83
- package/src/models/CustomerAuthResponseResourceArrayResponse.ts +0 -73
- package/src/models/CustomerFrontendResource.ts +0 -134
- package/src/models/CustomerFrontendResourceArrayResponse.ts +0 -73
- package/src/models/CustomerSocialLinkableResource.ts +0 -75
- package/src/models/CustomerSocialLinkableResourceArrayResponse.ts +0 -73
- package/src/models/CustomerType.ts +0 -53
- package/src/models/PaginatedAdminListResourceResponse.ts +0 -90
- package/src/models/PaginatedAdminLiteResourceResponse.ts +0 -90
- package/src/models/PaginatedRoleLiteResourceResponse.ts +0 -90
- package/src/models/RoleLiteResource.ts +0 -74
- package/src/models/RoleLiteResourceArrayResponse.ts +0 -73
- package/src/models/SearchAdminUsersRequest.ts +0 -169
- package/src/models/SearchAllAdminUsersRequest.ts +0 -129
- package/src/models/SearchAllCustomersRequest.ts +0 -156
- package/src/models/SignUpType.ts +0 -57
- package/src/models/SocialProvider.ts +0 -54
- package/src/models/UpdateAdminUserRequest.ts +0 -109
- package/src/models/UpdateCustomerRequest.ts +0 -108
- package/src/models/UserLiteResource.ts +0 -110
- package/src/models/UserLiteResourceArrayResponse.ts +0 -73
- package/src/models/UserType.ts +0 -53
|
@@ -7,13 +7,11 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
12
|
+
`email` | string
|
|
13
|
+
`phone` | string
|
|
11
14
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
12
|
-
`type` | string
|
|
13
|
-
`signUpType` | string
|
|
14
|
-
`subscribedToNewsletter` | boolean
|
|
15
|
-
`netsuiteId` | object
|
|
16
|
-
`createdAt` | Date
|
|
17
15
|
|
|
18
16
|
## Example
|
|
19
17
|
|
|
@@ -23,13 +21,11 @@ import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
23
21
|
// TODO: Update the object below with actual values
|
|
24
22
|
const example = {
|
|
25
23
|
"id": null,
|
|
26
|
-
"
|
|
24
|
+
"firstName": null,
|
|
25
|
+
"lastName": null,
|
|
26
|
+
"email": null,
|
|
27
|
+
"phone": null,
|
|
27
28
|
"site": null,
|
|
28
|
-
"type": null,
|
|
29
|
-
"signUpType": null,
|
|
30
|
-
"subscribedToNewsletter": null,
|
|
31
|
-
"netsuiteId": null,
|
|
32
|
-
"createdAt": null,
|
|
33
29
|
} satisfies CustomerListResource
|
|
34
30
|
|
|
35
31
|
console.log(example)
|
package/docs/CustomerResource.md
CHANGED
|
@@ -7,16 +7,12 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
12
|
+
`email` | string
|
|
13
|
+
`phone` | string
|
|
11
14
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
12
|
-
`
|
|
13
|
-
`signUpType` | string
|
|
14
|
-
`socialId` | string
|
|
15
|
-
`subscribedToNewsletter` | boolean
|
|
16
|
-
`netsuiteId` | string
|
|
17
|
-
`addresses` | [Array<AddressResource>](AddressResource.md)
|
|
18
|
-
`createdAt` | Date
|
|
19
|
-
`updatedAt` | Date
|
|
15
|
+
`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
|
|
20
16
|
|
|
21
17
|
## Example
|
|
22
18
|
|
|
@@ -26,16 +22,12 @@ import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
26
22
|
// TODO: Update the object below with actual values
|
|
27
23
|
const example = {
|
|
28
24
|
"id": null,
|
|
29
|
-
"
|
|
25
|
+
"firstName": null,
|
|
26
|
+
"lastName": null,
|
|
27
|
+
"email": null,
|
|
28
|
+
"phone": null,
|
|
30
29
|
"site": null,
|
|
31
|
-
"type": null,
|
|
32
|
-
"signUpType": null,
|
|
33
|
-
"socialId": null,
|
|
34
|
-
"subscribedToNewsletter": null,
|
|
35
|
-
"netsuiteId": null,
|
|
36
30
|
"addresses": null,
|
|
37
|
-
"createdAt": null,
|
|
38
|
-
"updatedAt": null,
|
|
39
31
|
} satisfies CustomerResource
|
|
40
32
|
|
|
41
33
|
console.log(example)
|
package/docs/CustomersApi.md
CHANGED
|
@@ -4,145 +4,12 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**destroyCustomer**](CustomersApi.md#destroycustomer) | **DELETE** /admin-api/customers/{customer}/delete | Auto-generated: destroyCustomer |
|
|
8
|
-
| [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
|
|
9
7
|
| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
|
|
10
8
|
| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
|
|
11
9
|
| [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
|
|
12
|
-
| [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
|
|
13
10
|
|
|
14
11
|
|
|
15
12
|
|
|
16
|
-
## destroyCustomer
|
|
17
|
-
|
|
18
|
-
> GenericResponse destroyCustomer(customer)
|
|
19
|
-
|
|
20
|
-
Auto-generated: destroyCustomer
|
|
21
|
-
|
|
22
|
-
### Example
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
import {
|
|
26
|
-
Configuration,
|
|
27
|
-
CustomersApi,
|
|
28
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
29
|
-
import type { DestroyCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
30
|
-
|
|
31
|
-
async function example() {
|
|
32
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
33
|
-
const api = new CustomersApi();
|
|
34
|
-
|
|
35
|
-
const body = {
|
|
36
|
-
// number | The id of the customer
|
|
37
|
-
customer: 56,
|
|
38
|
-
} satisfies DestroyCustomerRequest;
|
|
39
|
-
|
|
40
|
-
try {
|
|
41
|
-
const data = await api.destroyCustomer(body);
|
|
42
|
-
console.log(data);
|
|
43
|
-
} catch (error) {
|
|
44
|
-
console.error(error);
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
// Run the test
|
|
49
|
-
example().catch(console.error);
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Parameters
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
| Name | Type | Description | Notes |
|
|
56
|
-
|------------- | ------------- | ------------- | -------------|
|
|
57
|
-
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
58
|
-
|
|
59
|
-
### Return type
|
|
60
|
-
|
|
61
|
-
[**GenericResponse**](GenericResponse.md)
|
|
62
|
-
|
|
63
|
-
### Authorization
|
|
64
|
-
|
|
65
|
-
No authorization required
|
|
66
|
-
|
|
67
|
-
### HTTP request headers
|
|
68
|
-
|
|
69
|
-
- **Content-Type**: Not defined
|
|
70
|
-
- **Accept**: `application/json`
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
### HTTP response details
|
|
74
|
-
| Status code | Description | Response headers |
|
|
75
|
-
|-------------|-------------|------------------|
|
|
76
|
-
| **200** | Generic JSON success | - |
|
|
77
|
-
|
|
78
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
## getAllCustomer
|
|
82
|
-
|
|
83
|
-
> CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
|
|
84
|
-
|
|
85
|
-
Auto-generated: getAllCustomer
|
|
86
|
-
|
|
87
|
-
### Example
|
|
88
|
-
|
|
89
|
-
```ts
|
|
90
|
-
import {
|
|
91
|
-
Configuration,
|
|
92
|
-
CustomersApi,
|
|
93
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
94
|
-
import type { GetAllCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
95
|
-
|
|
96
|
-
async function example() {
|
|
97
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
98
|
-
const api = new CustomersApi();
|
|
99
|
-
|
|
100
|
-
const body = {
|
|
101
|
-
// SearchAllCustomersRequest (optional)
|
|
102
|
-
searchAllCustomersRequest: ...,
|
|
103
|
-
} satisfies GetAllCustomerRequest;
|
|
104
|
-
|
|
105
|
-
try {
|
|
106
|
-
const data = await api.getAllCustomer(body);
|
|
107
|
-
console.log(data);
|
|
108
|
-
} catch (error) {
|
|
109
|
-
console.error(error);
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
// Run the test
|
|
114
|
-
example().catch(console.error);
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
### Parameters
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
| Name | Type | Description | Notes |
|
|
121
|
-
|------------- | ------------- | ------------- | -------------|
|
|
122
|
-
| **searchAllCustomersRequest** | [SearchAllCustomersRequest](SearchAllCustomersRequest.md) | | [Optional] |
|
|
123
|
-
|
|
124
|
-
### Return type
|
|
125
|
-
|
|
126
|
-
[**CustomerLiteResourceArrayResponse**](CustomerLiteResourceArrayResponse.md)
|
|
127
|
-
|
|
128
|
-
### Authorization
|
|
129
|
-
|
|
130
|
-
No authorization required
|
|
131
|
-
|
|
132
|
-
### HTTP request headers
|
|
133
|
-
|
|
134
|
-
- **Content-Type**: `application/json`
|
|
135
|
-
- **Accept**: `application/json`
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
### HTTP response details
|
|
139
|
-
| Status code | Description | Response headers |
|
|
140
|
-
|-------------|-------------|------------------|
|
|
141
|
-
| **200** | Successful resource response | - |
|
|
142
|
-
|
|
143
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
144
|
-
|
|
145
|
-
|
|
146
13
|
## indexCustomer
|
|
147
14
|
|
|
148
15
|
> PaginatedCustomerListResourceResponse indexCustomer(searchCustomersRequest)
|
|
@@ -337,71 +204,3 @@ No authorization required
|
|
|
337
204
|
|
|
338
205
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
339
206
|
|
|
340
|
-
|
|
341
|
-
## updateCustomer
|
|
342
|
-
|
|
343
|
-
> CustomerResource updateCustomer(customer, updateCustomerRequest)
|
|
344
|
-
|
|
345
|
-
Auto-generated: updateCustomer
|
|
346
|
-
|
|
347
|
-
### Example
|
|
348
|
-
|
|
349
|
-
```ts
|
|
350
|
-
import {
|
|
351
|
-
Configuration,
|
|
352
|
-
CustomersApi,
|
|
353
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
354
|
-
import type { UpdateCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
355
|
-
|
|
356
|
-
async function example() {
|
|
357
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
358
|
-
const api = new CustomersApi();
|
|
359
|
-
|
|
360
|
-
const body = {
|
|
361
|
-
// number | The id of the customer
|
|
362
|
-
customer: 56,
|
|
363
|
-
// UpdateCustomerRequest (optional)
|
|
364
|
-
updateCustomerRequest: ...,
|
|
365
|
-
} satisfies UpdateCustomerOperationRequest;
|
|
366
|
-
|
|
367
|
-
try {
|
|
368
|
-
const data = await api.updateCustomer(body);
|
|
369
|
-
console.log(data);
|
|
370
|
-
} catch (error) {
|
|
371
|
-
console.error(error);
|
|
372
|
-
}
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
// Run the test
|
|
376
|
-
example().catch(console.error);
|
|
377
|
-
```
|
|
378
|
-
|
|
379
|
-
### Parameters
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
| Name | Type | Description | Notes |
|
|
383
|
-
|------------- | ------------- | ------------- | -------------|
|
|
384
|
-
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
385
|
-
| **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.md) | | [Optional] |
|
|
386
|
-
|
|
387
|
-
### Return type
|
|
388
|
-
|
|
389
|
-
[**CustomerResource**](CustomerResource.md)
|
|
390
|
-
|
|
391
|
-
### Authorization
|
|
392
|
-
|
|
393
|
-
No authorization required
|
|
394
|
-
|
|
395
|
-
### HTTP request headers
|
|
396
|
-
|
|
397
|
-
- **Content-Type**: `application/json`
|
|
398
|
-
- **Accept**: `application/json`
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
### HTTP response details
|
|
402
|
-
| Status code | Description | Response headers |
|
|
403
|
-
|-------------|-------------|------------------|
|
|
404
|
-
| **200** | Successful resource response | - |
|
|
405
|
-
|
|
406
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
407
|
-
|
|
@@ -12,10 +12,6 @@ Name | Type
|
|
|
12
12
|
`perPage` | number
|
|
13
13
|
`page` | number
|
|
14
14
|
`siteId` | Array<string>
|
|
15
|
-
`type` | Array<string>
|
|
16
|
-
`signUpType` | Array<string>
|
|
17
|
-
`beforeCreatedAt` | Date
|
|
18
|
-
`afterCreatedAt` | Date
|
|
19
15
|
`relatedId` | number
|
|
20
16
|
`relatedType` | string
|
|
21
17
|
`includesRelations` | boolean
|
|
@@ -33,10 +29,6 @@ const example = {
|
|
|
33
29
|
"perPage": null,
|
|
34
30
|
"page": null,
|
|
35
31
|
"siteId": null,
|
|
36
|
-
"type": null,
|
|
37
|
-
"signUpType": null,
|
|
38
|
-
"beforeCreatedAt": null,
|
|
39
|
-
"afterCreatedAt": null,
|
|
40
32
|
"relatedId": null,
|
|
41
33
|
"relatedType": null,
|
|
42
34
|
"includesRelations": null,
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
+
`productEnquiriesOnly` | boolean
|
|
14
15
|
`seo` | object
|
|
15
16
|
`description` | [DescriptionResource](DescriptionResource.md)
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"slug": null,
|
|
27
28
|
"thumbnail": null,
|
|
28
29
|
"supplierEta": null,
|
|
30
|
+
"productEnquiriesOnly": null,
|
|
29
31
|
"seo": null,
|
|
30
32
|
"description": null,
|
|
31
33
|
} satisfies SupplierFrontendResource
|
package/docs/SupplierResource.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
+
`productEnquiriesOnly` | boolean
|
|
14
15
|
`seo` | [Array<SEOResource>](SEOResource.md)
|
|
15
16
|
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"slug": null,
|
|
27
28
|
"thumbnail": null,
|
|
28
29
|
"supplierEta": null,
|
|
30
|
+
"productEnquiriesOnly": null,
|
|
29
31
|
"seo": null,
|
|
30
32
|
"descriptions": null,
|
|
31
33
|
} satisfies SupplierResource
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
+
`productEnquiriesOnly` | boolean
|
|
12
13
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
13
14
|
`altText` | string
|
|
14
15
|
`mimeType` | string
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"name": null,
|
|
28
29
|
"slug": null,
|
|
29
30
|
"supplierEta": null,
|
|
31
|
+
"productEnquiriesOnly": null,
|
|
30
32
|
"seo": null,
|
|
31
33
|
"altText": null,
|
|
32
34
|
"mimeType": null,
|
package/package.json
CHANGED
package/src/apis/CustomersApi.ts
CHANGED
|
@@ -18,49 +18,21 @@ import {
|
|
|
18
18
|
CreateCustomerRequestFromJSON,
|
|
19
19
|
CreateCustomerRequestToJSON,
|
|
20
20
|
} from '../models/CreateCustomerRequest';
|
|
21
|
-
import {
|
|
22
|
-
type CustomerLiteResourceArrayResponse,
|
|
23
|
-
CustomerLiteResourceArrayResponseFromJSON,
|
|
24
|
-
CustomerLiteResourceArrayResponseToJSON,
|
|
25
|
-
} from '../models/CustomerLiteResourceArrayResponse';
|
|
26
21
|
import {
|
|
27
22
|
type CustomerResource,
|
|
28
23
|
CustomerResourceFromJSON,
|
|
29
24
|
CustomerResourceToJSON,
|
|
30
25
|
} from '../models/CustomerResource';
|
|
31
|
-
import {
|
|
32
|
-
type GenericResponse,
|
|
33
|
-
GenericResponseFromJSON,
|
|
34
|
-
GenericResponseToJSON,
|
|
35
|
-
} from '../models/GenericResponse';
|
|
36
26
|
import {
|
|
37
27
|
type PaginatedCustomerListResourceResponse,
|
|
38
28
|
PaginatedCustomerListResourceResponseFromJSON,
|
|
39
29
|
PaginatedCustomerListResourceResponseToJSON,
|
|
40
30
|
} from '../models/PaginatedCustomerListResourceResponse';
|
|
41
|
-
import {
|
|
42
|
-
type SearchAllCustomersRequest,
|
|
43
|
-
SearchAllCustomersRequestFromJSON,
|
|
44
|
-
SearchAllCustomersRequestToJSON,
|
|
45
|
-
} from '../models/SearchAllCustomersRequest';
|
|
46
31
|
import {
|
|
47
32
|
type SearchCustomersRequest,
|
|
48
33
|
SearchCustomersRequestFromJSON,
|
|
49
34
|
SearchCustomersRequestToJSON,
|
|
50
35
|
} from '../models/SearchCustomersRequest';
|
|
51
|
-
import {
|
|
52
|
-
type UpdateCustomerRequest,
|
|
53
|
-
UpdateCustomerRequestFromJSON,
|
|
54
|
-
UpdateCustomerRequestToJSON,
|
|
55
|
-
} from '../models/UpdateCustomerRequest';
|
|
56
|
-
|
|
57
|
-
export interface DestroyCustomerRequest {
|
|
58
|
-
customer: number;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
export interface GetAllCustomerRequest {
|
|
62
|
-
searchAllCustomersRequest?: SearchAllCustomersRequest;
|
|
63
|
-
}
|
|
64
36
|
|
|
65
37
|
export interface IndexCustomerRequest {
|
|
66
38
|
searchCustomersRequest?: SearchCustomersRequest;
|
|
@@ -74,101 +46,11 @@ export interface StoreCustomerRequest {
|
|
|
74
46
|
createCustomerRequest?: CreateCustomerRequest;
|
|
75
47
|
}
|
|
76
48
|
|
|
77
|
-
export interface UpdateCustomerOperationRequest {
|
|
78
|
-
customer: number;
|
|
79
|
-
updateCustomerRequest?: UpdateCustomerRequest;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
49
|
/**
|
|
83
50
|
*
|
|
84
51
|
*/
|
|
85
52
|
export class CustomersApi extends runtime.BaseAPI {
|
|
86
53
|
|
|
87
|
-
/**
|
|
88
|
-
* Creates request options for destroyCustomer without sending the request
|
|
89
|
-
*/
|
|
90
|
-
async destroyCustomerRequestOpts(requestParameters: DestroyCustomerRequest): Promise<runtime.RequestOpts> {
|
|
91
|
-
if (requestParameters['customer'] == null) {
|
|
92
|
-
throw new runtime.RequiredError(
|
|
93
|
-
'customer',
|
|
94
|
-
'Required parameter "customer" was null or undefined when calling destroyCustomer().'
|
|
95
|
-
);
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
const queryParameters: any = {};
|
|
99
|
-
|
|
100
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
let urlPath = `/admin-api/customers/{customer}/delete`;
|
|
104
|
-
urlPath = urlPath.replace('{customer}', encodeURIComponent(String(requestParameters['customer'])));
|
|
105
|
-
|
|
106
|
-
return {
|
|
107
|
-
path: urlPath,
|
|
108
|
-
method: 'DELETE',
|
|
109
|
-
headers: headerParameters,
|
|
110
|
-
query: queryParameters,
|
|
111
|
-
};
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* Auto-generated: destroyCustomer
|
|
116
|
-
*/
|
|
117
|
-
async destroyCustomerRaw(requestParameters: DestroyCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
|
|
118
|
-
const requestOptions = await this.destroyCustomerRequestOpts(requestParameters);
|
|
119
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
120
|
-
|
|
121
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
* Auto-generated: destroyCustomer
|
|
126
|
-
*/
|
|
127
|
-
async destroyCustomer(requestParameters: DestroyCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
|
|
128
|
-
const response = await this.destroyCustomerRaw(requestParameters, initOverrides);
|
|
129
|
-
return await response.value();
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* Creates request options for getAllCustomer without sending the request
|
|
134
|
-
*/
|
|
135
|
-
async getAllCustomerRequestOpts(requestParameters: GetAllCustomerRequest): Promise<runtime.RequestOpts> {
|
|
136
|
-
const queryParameters: any = {};
|
|
137
|
-
|
|
138
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
139
|
-
|
|
140
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
let urlPath = `/admin-api/customers/all`;
|
|
144
|
-
|
|
145
|
-
return {
|
|
146
|
-
path: urlPath,
|
|
147
|
-
method: 'POST',
|
|
148
|
-
headers: headerParameters,
|
|
149
|
-
query: queryParameters,
|
|
150
|
-
body: SearchAllCustomersRequestToJSON(requestParameters['searchAllCustomersRequest']),
|
|
151
|
-
};
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
/**
|
|
155
|
-
* Auto-generated: getAllCustomer
|
|
156
|
-
*/
|
|
157
|
-
async getAllCustomerRaw(requestParameters: GetAllCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerLiteResourceArrayResponse>> {
|
|
158
|
-
const requestOptions = await this.getAllCustomerRequestOpts(requestParameters);
|
|
159
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
160
|
-
|
|
161
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => CustomerLiteResourceArrayResponseFromJSON(jsonValue));
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
/**
|
|
165
|
-
* Auto-generated: getAllCustomer
|
|
166
|
-
*/
|
|
167
|
-
async getAllCustomer(requestParameters: GetAllCustomerRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerLiteResourceArrayResponse> {
|
|
168
|
-
const response = await this.getAllCustomerRaw(requestParameters, initOverrides);
|
|
169
|
-
return await response.value();
|
|
170
|
-
}
|
|
171
|
-
|
|
172
54
|
/**
|
|
173
55
|
* Creates request options for indexCustomer without sending the request
|
|
174
56
|
*/
|
|
@@ -294,52 +176,4 @@ export class CustomersApi extends runtime.BaseAPI {
|
|
|
294
176
|
return await response.value();
|
|
295
177
|
}
|
|
296
178
|
|
|
297
|
-
/**
|
|
298
|
-
* Creates request options for updateCustomer without sending the request
|
|
299
|
-
*/
|
|
300
|
-
async updateCustomerRequestOpts(requestParameters: UpdateCustomerOperationRequest): Promise<runtime.RequestOpts> {
|
|
301
|
-
if (requestParameters['customer'] == null) {
|
|
302
|
-
throw new runtime.RequiredError(
|
|
303
|
-
'customer',
|
|
304
|
-
'Required parameter "customer" was null or undefined when calling updateCustomer().'
|
|
305
|
-
);
|
|
306
|
-
}
|
|
307
|
-
|
|
308
|
-
const queryParameters: any = {};
|
|
309
|
-
|
|
310
|
-
const headerParameters: runtime.HTTPHeaders = {};
|
|
311
|
-
|
|
312
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
let urlPath = `/admin-api/customers/{customer}/update`;
|
|
316
|
-
urlPath = urlPath.replace('{customer}', encodeURIComponent(String(requestParameters['customer'])));
|
|
317
|
-
|
|
318
|
-
return {
|
|
319
|
-
path: urlPath,
|
|
320
|
-
method: 'PUT',
|
|
321
|
-
headers: headerParameters,
|
|
322
|
-
query: queryParameters,
|
|
323
|
-
body: UpdateCustomerRequestToJSON(requestParameters['updateCustomerRequest']),
|
|
324
|
-
};
|
|
325
|
-
}
|
|
326
|
-
|
|
327
|
-
/**
|
|
328
|
-
* Auto-generated: updateCustomer
|
|
329
|
-
*/
|
|
330
|
-
async updateCustomerRaw(requestParameters: UpdateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerResource>> {
|
|
331
|
-
const requestOptions = await this.updateCustomerRequestOpts(requestParameters);
|
|
332
|
-
const response = await this.request(requestOptions, initOverrides);
|
|
333
|
-
|
|
334
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => CustomerResourceFromJSON(jsonValue));
|
|
335
|
-
}
|
|
336
|
-
|
|
337
|
-
/**
|
|
338
|
-
* Auto-generated: updateCustomer
|
|
339
|
-
*/
|
|
340
|
-
async updateCustomer(requestParameters: UpdateCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerResource> {
|
|
341
|
-
const response = await this.updateCustomerRaw(requestParameters, initOverrides);
|
|
342
|
-
return await response.value();
|
|
343
|
-
}
|
|
344
|
-
|
|
345
179
|
}
|
package/src/apis/index.ts
CHANGED
|
@@ -48,7 +48,7 @@ export interface AddressResource {
|
|
|
48
48
|
* @type {string}
|
|
49
49
|
* @memberof AddressResource
|
|
50
50
|
*/
|
|
51
|
-
company
|
|
51
|
+
company?: string | null;
|
|
52
52
|
/**
|
|
53
53
|
*
|
|
54
54
|
* @type {string}
|
|
@@ -98,7 +98,6 @@ export interface AddressResource {
|
|
|
98
98
|
*/
|
|
99
99
|
export function instanceOfAddressResource(value: object): value is AddressResource {
|
|
100
100
|
if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
|
|
101
|
-
if (!('company' in value) || value['company'] === undefined) return false;
|
|
102
101
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
103
102
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
104
103
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
@@ -122,7 +121,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
122
121
|
'type': json['type'] == null ? undefined : json['type'],
|
|
123
122
|
'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
|
|
124
123
|
'addresseeName': json['addresseeName'],
|
|
125
|
-
'company': json['company'],
|
|
124
|
+
'company': json['company'] == null ? undefined : json['company'],
|
|
126
125
|
'line1': json['line1'],
|
|
127
126
|
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
128
127
|
'postcode': json['postcode'],
|
|
@@ -19,9 +19,7 @@
|
|
|
19
19
|
*/
|
|
20
20
|
export const AddressType = {
|
|
21
21
|
Shipping: 'shipping',
|
|
22
|
-
Billing: 'billing'
|
|
23
|
-
ShippingBilling: 'shipping-billing',
|
|
24
|
-
Others: 'others'
|
|
22
|
+
Billing: 'billing'
|
|
25
23
|
} as const;
|
|
26
24
|
export type AddressType = typeof AddressType[keyof typeof AddressType];
|
|
27
25
|
|