@digital8/lighting-illusions-ts-sdk 0.0.2361 → 0.0.2363
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 +136 -4
- package/README.md +98 -4
- package/dist/apis/AdminsApi.d.ts +149 -0
- package/dist/apis/AdminsApi.js +565 -0
- package/dist/apis/AuthApi.d.ts +92 -0
- package/dist/apis/AuthApi.js +369 -0
- package/dist/apis/CustomersApi.d.ts +102 -0
- package/dist/apis/CustomersApi.js +374 -0
- package/dist/apis/PermissionsApi.d.ts +67 -0
- package/dist/apis/PermissionsApi.js +259 -0
- package/dist/apis/RolesApi.d.ts +182 -0
- package/dist/apis/RolesApi.js +690 -0
- package/dist/apis/index.d.ts +4 -0
- package/dist/apis/index.js +4 -0
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +2 -6
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +3 -1
- package/dist/models/AddressType.d.ts +2 -0
- package/dist/models/AddressType.js +3 -1
- package/dist/models/AdminListResource.d.ts +52 -0
- package/dist/models/AdminListResource.js +63 -0
- package/dist/models/AdminListResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminListResourceArrayResponse.js +50 -0
- package/dist/models/AdminLiteResource.d.ts +39 -0
- package/dist/models/AdminLiteResource.js +56 -0
- package/dist/models/AdminLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminLiteResourceArrayResponse.js +50 -0
- package/dist/models/AdminLoginResponseResource.d.ts +39 -0
- package/dist/models/AdminLoginResponseResource.js +56 -0
- package/dist/models/AdminLoginResponseResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminLoginResponseResourceArrayResponse.js +50 -0
- package/dist/models/AdminNoteResource.d.ts +3 -3
- package/dist/models/AdminNoteResource.js +3 -3
- package/dist/models/AdminOrderResource.d.ts +6 -5
- package/dist/models/AdminOrderResource.js +6 -5
- package/dist/models/AdminResource.d.ts +64 -0
- package/dist/models/AdminResource.js +69 -0
- package/dist/models/AdminResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminResourceArrayResponse.js +50 -0
- package/dist/models/AdminUserLiteResource.d.ts +1 -1
- package/dist/models/AdminUserLiteResource.js +3 -1
- 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/CartCouponResource.d.ts +50 -0
- package/dist/models/{AppliedCouponResource.js → CartCouponResource.js} +13 -13
- package/dist/models/CartCouponResourceArrayResponse.d.ts +33 -0
- package/dist/models/CartCouponResourceArrayResponse.js +50 -0
- package/dist/models/CartResource.d.ts +3 -3
- package/dist/models/CartResource.js +3 -3
- package/dist/models/CheckEmailFrontendResource.d.ts +38 -0
- package/dist/models/CheckEmailFrontendResource.js +53 -0
- package/dist/models/CheckEmailFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/CheckEmailFrontendResourceArrayResponse.js +50 -0
- package/dist/models/CreateAdminUserRequest.d.ts +56 -0
- package/dist/models/CreateAdminUserRequest.js +65 -0
- package/dist/models/CreateCustomerAddressRequest.d.ts +90 -0
- package/dist/models/CreateCustomerAddressRequest.js +83 -0
- package/dist/models/CreateCustomerRequest.d.ts +24 -6
- package/dist/models/CreateCustomerRequest.js +12 -6
- package/dist/models/CreateRoleRequest.d.ts +38 -0
- package/dist/models/CreateRoleRequest.js +55 -0
- package/dist/models/CustomerAuthResponseResource.d.ts +39 -0
- package/dist/models/CustomerAuthResponseResource.js +56 -0
- package/dist/models/CustomerAuthResponseResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerAuthResponseResourceArrayResponse.js +50 -0
- package/dist/models/CustomerFrontendResource.d.ts +70 -0
- package/dist/models/CustomerFrontendResource.js +75 -0
- package/dist/models/CustomerFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerFrontendResourceArrayResponse.js +50 -0
- package/dist/models/CustomerListResource.d.ts +27 -8
- package/dist/models/CustomerListResource.js +24 -13
- package/dist/models/CustomerResource.d.ts +43 -10
- package/dist/models/CustomerResource.js +33 -16
- package/dist/models/CustomerSocialLinkableResource.d.ts +38 -0
- package/dist/models/CustomerSocialLinkableResource.js +55 -0
- package/dist/models/CustomerSocialLinkableResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerSocialLinkableResourceArrayResponse.js +50 -0
- package/dist/models/CustomerType.d.ts +25 -0
- package/dist/models/CustomerType.js +51 -0
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +3 -1
- package/dist/models/ForgotPasswordAdminRequest.d.ts +32 -0
- package/dist/models/ForgotPasswordAdminRequest.js +51 -0
- package/dist/models/FrontendOrderResource.d.ts +3 -3
- package/dist/models/FrontendOrderResource.js +3 -3
- package/dist/models/LoginAdminRequest.d.ts +38 -0
- package/dist/models/LoginAdminRequest.js +55 -0
- 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 +3 -3
- package/dist/models/OrderFulfillmentResource.js +9 -3
- package/dist/models/PaginatedAdminListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAdminListResourceResponse.js +57 -0
- package/dist/models/PaginatedAdminLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAdminLiteResourceResponse.js +57 -0
- package/dist/models/PaginatedPermissionListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedPermissionListResourceResponse.js +57 -0
- package/dist/models/PaginatedPermissionLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedPermissionLiteResourceResponse.js +57 -0
- package/dist/models/PaginatedRoleListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedRoleListResourceResponse.js +57 -0
- package/dist/models/PaginatedRoleLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedRoleLiteResourceResponse.js +57 -0
- package/dist/models/PermissionListResource.d.ts +44 -0
- package/dist/models/PermissionListResource.js +55 -0
- package/dist/models/PermissionListResourceArrayResponse.d.ts +33 -0
- package/dist/models/PermissionListResourceArrayResponse.js +50 -0
- package/dist/models/PermissionLiteResource.d.ts +38 -0
- package/dist/models/PermissionLiteResource.js +53 -0
- package/dist/models/PermissionLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/PermissionLiteResourceArrayResponse.js +50 -0
- package/dist/models/PermissionResource.d.ts +56 -0
- package/dist/models/PermissionResource.js +61 -0
- package/dist/models/PermissionResourceArrayResponse.d.ts +33 -0
- package/dist/models/PermissionResourceArrayResponse.js +50 -0
- package/dist/models/ResetPasswordAdminRequest.d.ts +44 -0
- package/dist/models/ResetPasswordAdminRequest.js +59 -0
- package/dist/models/RoleListResource.d.ts +74 -0
- package/dist/models/RoleListResource.js +73 -0
- package/dist/models/RoleListResourceArrayResponse.d.ts +33 -0
- package/dist/models/RoleListResourceArrayResponse.js +50 -0
- package/dist/models/RoleLiteResource.d.ts +44 -0
- package/dist/models/RoleLiteResource.js +57 -0
- package/dist/models/RoleLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/RoleLiteResourceArrayResponse.js +50 -0
- package/dist/models/RoleResource.d.ts +82 -0
- package/dist/models/RoleResource.js +79 -0
- package/dist/models/RoleResourceArrayResponse.d.ts +33 -0
- package/dist/models/RoleResourceArrayResponse.js +50 -0
- package/dist/models/SearchAdminUsersRequest.d.ts +112 -0
- package/dist/models/SearchAdminUsersRequest.js +88 -0
- package/dist/models/SearchAllAdminUsersRequest.d.ts +88 -0
- package/dist/models/SearchAllAdminUsersRequest.js +80 -0
- package/dist/models/SearchAllCustomersRequest.d.ts +103 -0
- package/dist/models/SearchAllCustomersRequest.js +87 -0
- package/dist/models/SearchAllPermissionsRequest.d.ts +85 -0
- package/dist/models/SearchAllPermissionsRequest.js +77 -0
- package/dist/models/SearchAllRolesRequest.d.ts +92 -0
- package/dist/models/SearchAllRolesRequest.js +80 -0
- package/dist/models/SearchCustomersRequest.d.ts +31 -3
- package/dist/models/SearchCustomersRequest.js +15 -3
- package/dist/models/SearchPermissionsRequest.d.ts +97 -0
- package/dist/models/SearchPermissionsRequest.js +81 -0
- package/dist/models/SearchRolesRequest.d.ts +104 -0
- package/dist/models/SearchRolesRequest.js +84 -0
- package/dist/models/SignUpType.d.ts +29 -0
- package/dist/models/SignUpType.js +55 -0
- package/dist/models/SocialProvider.d.ts +26 -0
- package/dist/models/SocialProvider.js +52 -0
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +3 -1
- package/dist/models/UpdateAdminUserRequest.d.ts +56 -0
- package/dist/models/UpdateAdminUserRequest.js +63 -0
- package/dist/models/UpdateCustomerAddressRequest.d.ts +90 -0
- package/dist/models/UpdateCustomerAddressRequest.js +83 -0
- package/dist/models/UpdateCustomerRequest.d.ts +68 -0
- package/dist/models/UpdateCustomerRequest.js +67 -0
- package/dist/models/UpdateRoleRequest.d.ts +38 -0
- package/dist/models/UpdateRoleRequest.js +55 -0
- package/dist/models/UserLiteResource.d.ts +62 -0
- package/dist/models/UserLiteResource.js +69 -0
- package/dist/models/UserLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/UserLiteResourceArrayResponse.js +50 -0
- package/dist/models/UserType.d.ts +25 -0
- package/dist/models/UserType.js +51 -0
- package/dist/models/index.d.ts +64 -2
- package/dist/models/index.js +64 -2
- package/docs/AdminListResource.md +40 -0
- package/docs/{AppliedCouponResourceArrayResponse.md → AdminListResourceArrayResponse.md} +5 -5
- package/docs/AdminLiteResource.md +36 -0
- package/docs/AdminLiteResourceArrayResponse.md +34 -0
- package/docs/AdminLoginResponseResource.md +36 -0
- package/docs/AdminLoginResponseResourceArrayResponse.md +34 -0
- package/docs/AdminNoteResource.md +1 -1
- package/docs/AdminOrderResource.md +2 -2
- package/docs/AdminResource.md +44 -0
- package/docs/AdminResourceArrayResponse.md +34 -0
- package/docs/AdminsApi.md +545 -0
- package/docs/AttachAdminsToRoleRequest.md +34 -0
- package/docs/AttachPermissionsToRoleRequest.md +34 -0
- package/docs/AttachRolesToAdminRequest.md +34 -0
- package/docs/AuthApi.md +322 -0
- package/docs/{AppliedCouponResource.md → CartCouponResource.md} +4 -4
- package/docs/CartCouponResourceArrayResponse.md +34 -0
- package/docs/CartResource.md +1 -1
- package/docs/CheckEmailFrontendResource.md +36 -0
- package/docs/CheckEmailFrontendResourceArrayResponse.md +34 -0
- package/docs/CreateAdminUserRequest.md +42 -0
- package/docs/CreateCustomerAddressRequest.md +50 -0
- package/docs/CreateCustomerRequest.md +10 -4
- package/docs/CreateRoleRequest.md +36 -0
- package/docs/CustomerAuthResponseResource.md +36 -0
- package/docs/CustomerAuthResponseResourceArrayResponse.md +34 -0
- package/docs/CustomerFrontendResource.md +46 -0
- package/docs/CustomerFrontendResourceArrayResponse.md +34 -0
- package/docs/CustomerListResource.md +14 -8
- package/docs/CustomerResource.md +19 -9
- package/docs/CustomerSocialLinkableResource.md +36 -0
- package/docs/CustomerSocialLinkableResourceArrayResponse.md +34 -0
- package/docs/CustomerType.md +32 -0
- package/docs/CustomersApi.md +411 -0
- package/docs/ForgotPasswordAdminRequest.md +34 -0
- package/docs/FrontendOrderResource.md +1 -1
- package/docs/LoginAdminRequest.md +36 -0
- package/docs/NetsuiteSyncLiteResource.md +38 -0
- package/docs/NetsuiteSyncLiteResourceArrayResponse.md +34 -0
- package/docs/PaginatedAdminListResourceResponse.md +36 -0
- package/docs/PaginatedAdminLiteResourceResponse.md +36 -0
- package/docs/PaginatedPermissionListResourceResponse.md +36 -0
- package/docs/PaginatedPermissionLiteResourceResponse.md +36 -0
- package/docs/PaginatedRoleListResourceResponse.md +36 -0
- package/docs/PaginatedRoleLiteResourceResponse.md +36 -0
- package/docs/PermissionListResource.md +38 -0
- package/docs/PermissionListResourceArrayResponse.md +34 -0
- package/docs/PermissionLiteResource.md +36 -0
- package/docs/PermissionLiteResourceArrayResponse.md +34 -0
- package/docs/PermissionResource.md +42 -0
- package/docs/PermissionResourceArrayResponse.md +34 -0
- package/docs/PermissionsApi.md +206 -0
- package/docs/ResetPasswordAdminRequest.md +38 -0
- package/docs/RoleListResource.md +48 -0
- package/docs/RoleListResourceArrayResponse.md +34 -0
- package/docs/RoleLiteResource.md +38 -0
- package/docs/RoleLiteResourceArrayResponse.md +34 -0
- package/docs/RoleResource.md +50 -0
- package/docs/RoleResourceArrayResponse.md +34 -0
- package/docs/RolesApi.md +683 -0
- package/docs/SearchAdminUsersRequest.md +54 -0
- package/docs/SearchAllAdminUsersRequest.md +46 -0
- package/docs/SearchAllCustomersRequest.md +50 -0
- package/docs/SearchAllPermissionsRequest.md +46 -0
- package/docs/SearchAllRolesRequest.md +48 -0
- package/docs/SearchCustomersRequest.md +8 -0
- package/docs/SearchPermissionsRequest.md +50 -0
- package/docs/SearchRolesRequest.md +52 -0
- package/docs/SignUpType.md +32 -0
- package/docs/SocialProvider.md +32 -0
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/UpdateAdminUserRequest.md +42 -0
- package/docs/UpdateCustomerAddressRequest.md +50 -0
- package/docs/UpdateCustomerRequest.md +46 -0
- package/docs/UpdateRoleRequest.md +36 -0
- package/docs/UserLiteResource.md +44 -0
- package/docs/UserLiteResourceArrayResponse.md +34 -0
- package/docs/UserType.md +32 -0
- package/package.json +1 -1
- package/src/apis/AdminsApi.ts +461 -0
- package/src/apis/AuthApi.ts +258 -0
- package/src/apis/CustomersApi.ts +354 -0
- package/src/apis/PermissionsApi.ts +184 -0
- package/src/apis/RolesApi.ts +577 -0
- package/src/apis/index.ts +4 -0
- package/src/models/AddressFrontendResource.ts +4 -6
- package/src/models/AddressResource.ts +3 -2
- package/src/models/AddressType.ts +3 -1
- package/src/models/AdminListResource.ts +107 -0
- package/src/models/AdminListResourceArrayResponse.ts +73 -0
- package/src/models/AdminLiteResource.ts +83 -0
- package/src/models/AdminLiteResourceArrayResponse.ts +73 -0
- package/src/models/AdminLoginResponseResource.ts +83 -0
- package/src/models/AdminLoginResponseResourceArrayResponse.ts +73 -0
- package/src/models/AdminNoteResource.ts +10 -10
- package/src/models/AdminOrderResource.ts +22 -15
- package/src/models/AdminResource.ts +124 -0
- package/src/models/AdminResourceArrayResponse.ts +73 -0
- package/src/models/AdminUserLiteResource.ts +3 -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/{AppliedCouponResource.ts → CartCouponResource.ts} +14 -14
- package/src/models/CartCouponResourceArrayResponse.ts +73 -0
- package/src/models/CartResource.ts +10 -10
- package/src/models/CheckEmailFrontendResource.ts +74 -0
- package/src/models/CheckEmailFrontendResourceArrayResponse.ts +73 -0
- package/src/models/CreateAdminUserRequest.ts +101 -0
- package/src/models/CreateCustomerAddressRequest.ts +146 -0
- package/src/models/CreateCustomerRequest.ts +35 -11
- package/src/models/CreateRoleRequest.ts +75 -0
- package/src/models/CustomerAuthResponseResource.ts +83 -0
- package/src/models/CustomerAuthResponseResourceArrayResponse.ts +73 -0
- package/src/models/CustomerFrontendResource.ts +134 -0
- package/src/models/CustomerFrontendResourceArrayResponse.ts +73 -0
- package/src/models/CustomerListResource.ts +53 -20
- package/src/models/CustomerResource.ts +92 -29
- package/src/models/CustomerSocialLinkableResource.ts +75 -0
- package/src/models/CustomerSocialLinkableResourceArrayResponse.ts +73 -0
- package/src/models/CustomerType.ts +53 -0
- package/src/models/ExternalApiLogResource.ts +3 -2
- package/src/models/ForgotPasswordAdminRequest.ts +66 -0
- package/src/models/FrontendOrderResource.ts +11 -11
- package/src/models/LoginAdminRequest.ts +75 -0
- package/src/models/NetsuiteSyncLiteResource.ts +84 -0
- package/src/models/NetsuiteSyncLiteResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +9 -6
- package/src/models/PaginatedAdminListResourceResponse.ts +90 -0
- package/src/models/PaginatedAdminLiteResourceResponse.ts +90 -0
- package/src/models/PaginatedPermissionListResourceResponse.ts +90 -0
- package/src/models/PaginatedPermissionLiteResourceResponse.ts +90 -0
- package/src/models/PaginatedRoleListResourceResponse.ts +90 -0
- package/src/models/PaginatedRoleLiteResourceResponse.ts +90 -0
- package/src/models/PermissionListResource.ts +82 -0
- package/src/models/PermissionListResourceArrayResponse.ts +73 -0
- package/src/models/PermissionLiteResource.ts +74 -0
- package/src/models/PermissionLiteResourceArrayResponse.ts +73 -0
- package/src/models/PermissionResource.ts +99 -0
- package/src/models/PermissionResourceArrayResponse.ts +73 -0
- package/src/models/ResetPasswordAdminRequest.ts +84 -0
- package/src/models/RoleListResource.ts +126 -0
- package/src/models/RoleListResourceArrayResponse.ts +73 -0
- package/src/models/RoleLiteResource.ts +83 -0
- package/src/models/RoleLiteResourceArrayResponse.ts +73 -0
- package/src/models/RoleResource.ts +150 -0
- package/src/models/RoleResourceArrayResponse.ts +73 -0
- package/src/models/SearchAdminUsersRequest.ts +169 -0
- package/src/models/SearchAllAdminUsersRequest.ts +137 -0
- package/src/models/SearchAllCustomersRequest.ts +156 -0
- package/src/models/SearchAllPermissionsRequest.ts +134 -0
- package/src/models/SearchAllRolesRequest.ts +143 -0
- package/src/models/SearchCustomersRequest.ts +39 -3
- package/src/models/SearchPermissionsRequest.ts +150 -0
- package/src/models/SearchRolesRequest.ts +159 -0
- package/src/models/SignUpType.ts +57 -0
- package/src/models/SocialProvider.ts +54 -0
- package/src/models/StoreResource.ts +2 -3
- package/src/models/StoreSpecialDateResource.ts +4 -3
- package/src/models/UpdateAdminUserRequest.ts +100 -0
- package/src/models/UpdateCustomerAddressRequest.ts +146 -0
- package/src/models/UpdateCustomerRequest.ts +116 -0
- package/src/models/UpdateRoleRequest.ts +75 -0
- package/src/models/UserLiteResource.ts +110 -0
- package/src/models/UserLiteResourceArrayResponse.ts +73 -0
- package/src/models/UserType.ts +53 -0
- package/src/models/index.ts +64 -2
- package/dist/models/AppliedCouponResource.d.ts +0 -50
- package/dist/models/AppliedCouponResourceArrayResponse.d.ts +0 -33
- package/dist/models/AppliedCouponResourceArrayResponse.js +0 -50
- package/src/models/AppliedCouponResourceArrayResponse.ts +0 -73
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerFrontendResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`type` | string
|
|
11
|
+
`signUpType` | string
|
|
12
|
+
`subscribedToNewsletter` | boolean
|
|
13
|
+
`user` | [UserLiteResource](UserLiteResource.md)
|
|
14
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
15
|
+
`addresses` | object
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { CustomerFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": null,
|
|
25
|
+
"type": null,
|
|
26
|
+
"signUpType": null,
|
|
27
|
+
"subscribedToNewsletter": null,
|
|
28
|
+
"user": null,
|
|
29
|
+
"site": null,
|
|
30
|
+
"addresses": null,
|
|
31
|
+
} satisfies CustomerFrontendResource
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as CustomerFrontendResource
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerFrontendResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CustomerFrontendResource>](CustomerFrontendResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { CustomerFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies CustomerFrontendResourceArrayResponse
|
|
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 CustomerFrontendResourceArrayResponse
|
|
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
|
+
|
|
@@ -7,11 +7,14 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`lastName` | string
|
|
12
|
-
`email` | string
|
|
13
|
-
`phone` | string
|
|
10
|
+
`user` | [UserLiteResource](UserLiteResource.md)
|
|
14
11
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
12
|
+
`type` | string
|
|
13
|
+
`signUpType` | string
|
|
14
|
+
`subscribedToNewsletter` | boolean
|
|
15
|
+
`netsuiteId` | object
|
|
16
|
+
`ordersCount` | number
|
|
17
|
+
`createdAt` | Date
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -21,11 +24,14 @@ import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
21
24
|
// TODO: Update the object below with actual values
|
|
22
25
|
const example = {
|
|
23
26
|
"id": null,
|
|
24
|
-
"
|
|
25
|
-
"lastName": null,
|
|
26
|
-
"email": null,
|
|
27
|
-
"phone": null,
|
|
27
|
+
"user": null,
|
|
28
28
|
"site": null,
|
|
29
|
+
"type": null,
|
|
30
|
+
"signUpType": null,
|
|
31
|
+
"subscribedToNewsletter": null,
|
|
32
|
+
"netsuiteId": null,
|
|
33
|
+
"ordersCount": null,
|
|
34
|
+
"createdAt": null,
|
|
29
35
|
} satisfies CustomerListResource
|
|
30
36
|
|
|
31
37
|
console.log(example)
|
package/docs/CustomerResource.md
CHANGED
|
@@ -7,12 +7,17 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`
|
|
11
|
-
`lastName` | string
|
|
12
|
-
`email` | string
|
|
13
|
-
`phone` | string
|
|
10
|
+
`user` | [UserLiteResource](UserLiteResource.md)
|
|
14
11
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
15
|
-
`
|
|
12
|
+
`type` | string
|
|
13
|
+
`signUpType` | string
|
|
14
|
+
`socialId` | string
|
|
15
|
+
`subscribedToNewsletter` | boolean
|
|
16
|
+
`netsuiteSync` | [NetsuiteSyncLiteResource](NetsuiteSyncLiteResource.md)
|
|
17
|
+
`omnisendSync` | [OmnisendSyncLiteResource](OmnisendSyncLiteResource.md)
|
|
18
|
+
`addresses` | [Array<AddressResource>](AddressResource.md)
|
|
19
|
+
`createdAt` | Date
|
|
20
|
+
`updatedAt` | Date
|
|
16
21
|
|
|
17
22
|
## Example
|
|
18
23
|
|
|
@@ -22,12 +27,17 @@ import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
22
27
|
// TODO: Update the object below with actual values
|
|
23
28
|
const example = {
|
|
24
29
|
"id": null,
|
|
25
|
-
"
|
|
26
|
-
"lastName": null,
|
|
27
|
-
"email": null,
|
|
28
|
-
"phone": null,
|
|
30
|
+
"user": null,
|
|
29
31
|
"site": null,
|
|
32
|
+
"type": null,
|
|
33
|
+
"signUpType": null,
|
|
34
|
+
"socialId": null,
|
|
35
|
+
"subscribedToNewsletter": null,
|
|
36
|
+
"netsuiteSync": null,
|
|
37
|
+
"omnisendSync": null,
|
|
30
38
|
"addresses": null,
|
|
39
|
+
"createdAt": null,
|
|
40
|
+
"updatedAt": null,
|
|
31
41
|
} satisfies CustomerResource
|
|
32
42
|
|
|
33
43
|
console.log(example)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerSocialLinkableResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`linkable` | boolean
|
|
10
|
+
`customer` | object
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { CustomerSocialLinkableResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"linkable": null,
|
|
20
|
+
"customer": null,
|
|
21
|
+
} satisfies CustomerSocialLinkableResource
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as CustomerSocialLinkableResource
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerSocialLinkableResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CustomerSocialLinkableResource>](CustomerSocialLinkableResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { CustomerSocialLinkableResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies CustomerSocialLinkableResourceArrayResponse
|
|
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 CustomerSocialLinkableResourceArrayResponse
|
|
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,32 @@
|
|
|
1
|
+
|
|
2
|
+
# CustomerType
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import type { CustomerType } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
|
+
|
|
15
|
+
// TODO: Update the object below with actual values
|
|
16
|
+
const example = {
|
|
17
|
+
} satisfies CustomerType
|
|
18
|
+
|
|
19
|
+
console.log(example)
|
|
20
|
+
|
|
21
|
+
// Convert the instance to a JSON string
|
|
22
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
23
|
+
console.log(exampleJSON)
|
|
24
|
+
|
|
25
|
+
// Parse the JSON string back to an object
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as CustomerType
|
|
27
|
+
console.log(exampleParsed)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
31
|
+
|
|
32
|
+
|
package/docs/CustomersApi.md
CHANGED
|
@@ -4,12 +4,216 @@ 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
|
+
| [**destroyCustomerAddress**](CustomersApi.md#destroycustomeraddress) | **DELETE** /admin-api/customers/{customer}/addresses/{address} | Auto-generated: destroyCustomerAddress |
|
|
9
|
+
| [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
|
|
7
10
|
| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
|
|
8
11
|
| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
|
|
9
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 |
|
|
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 |
|
|
10
16
|
|
|
11
17
|
|
|
12
18
|
|
|
19
|
+
## destroyCustomer
|
|
20
|
+
|
|
21
|
+
> GenericResponse destroyCustomer(customer)
|
|
22
|
+
|
|
23
|
+
Auto-generated: destroyCustomer
|
|
24
|
+
|
|
25
|
+
### Example
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import {
|
|
29
|
+
Configuration,
|
|
30
|
+
CustomersApi,
|
|
31
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
32
|
+
import type { DestroyCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
33
|
+
|
|
34
|
+
async function example() {
|
|
35
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
36
|
+
const api = new CustomersApi();
|
|
37
|
+
|
|
38
|
+
const body = {
|
|
39
|
+
// number | The id of the customer
|
|
40
|
+
customer: 56,
|
|
41
|
+
} satisfies DestroyCustomerRequest;
|
|
42
|
+
|
|
43
|
+
try {
|
|
44
|
+
const data = await api.destroyCustomer(body);
|
|
45
|
+
console.log(data);
|
|
46
|
+
} catch (error) {
|
|
47
|
+
console.error(error);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// Run the test
|
|
52
|
+
example().catch(console.error);
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
| Name | Type | Description | Notes |
|
|
59
|
+
|------------- | ------------- | ------------- | -------------|
|
|
60
|
+
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
[**GenericResponse**](GenericResponse.md)
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
No authorization required
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: Not defined
|
|
73
|
+
- **Accept**: `application/json`
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### HTTP response details
|
|
77
|
+
| Status code | Description | Response headers |
|
|
78
|
+
|-------------|-------------|------------------|
|
|
79
|
+
| **200** | \\JsonResponse<array{message: string}> | - |
|
|
80
|
+
|
|
81
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
82
|
+
|
|
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
|
+
|
|
152
|
+
## getAllCustomer
|
|
153
|
+
|
|
154
|
+
> CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
|
|
155
|
+
|
|
156
|
+
Auto-generated: getAllCustomer
|
|
157
|
+
|
|
158
|
+
### Example
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
import {
|
|
162
|
+
Configuration,
|
|
163
|
+
CustomersApi,
|
|
164
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
165
|
+
import type { GetAllCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
166
|
+
|
|
167
|
+
async function example() {
|
|
168
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
169
|
+
const api = new CustomersApi();
|
|
170
|
+
|
|
171
|
+
const body = {
|
|
172
|
+
// SearchAllCustomersRequest (optional)
|
|
173
|
+
searchAllCustomersRequest: ...,
|
|
174
|
+
} satisfies GetAllCustomerRequest;
|
|
175
|
+
|
|
176
|
+
try {
|
|
177
|
+
const data = await api.getAllCustomer(body);
|
|
178
|
+
console.log(data);
|
|
179
|
+
} catch (error) {
|
|
180
|
+
console.error(error);
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
// Run the test
|
|
185
|
+
example().catch(console.error);
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Parameters
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
| Name | Type | Description | Notes |
|
|
192
|
+
|------------- | ------------- | ------------- | -------------|
|
|
193
|
+
| **searchAllCustomersRequest** | [SearchAllCustomersRequest](SearchAllCustomersRequest.md) | | [Optional] |
|
|
194
|
+
|
|
195
|
+
### Return type
|
|
196
|
+
|
|
197
|
+
[**CustomerLiteResourceArrayResponse**](CustomerLiteResourceArrayResponse.md)
|
|
198
|
+
|
|
199
|
+
### Authorization
|
|
200
|
+
|
|
201
|
+
No authorization required
|
|
202
|
+
|
|
203
|
+
### HTTP request headers
|
|
204
|
+
|
|
205
|
+
- **Content-Type**: `application/json`
|
|
206
|
+
- **Accept**: `application/json`
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
### HTTP response details
|
|
210
|
+
| Status code | Description | Response headers |
|
|
211
|
+
|-------------|-------------|------------------|
|
|
212
|
+
| **200** | Successful resource response | - |
|
|
213
|
+
|
|
214
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
215
|
+
|
|
216
|
+
|
|
13
217
|
## indexCustomer
|
|
14
218
|
|
|
15
219
|
> PaginatedCustomerListResourceResponse indexCustomer(searchCustomersRequest)
|
|
@@ -204,3 +408,210 @@ No authorization required
|
|
|
204
408
|
|
|
205
409
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
206
410
|
|
|
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
|
+
|
|
480
|
+
## updateCustomer
|
|
481
|
+
|
|
482
|
+
> CustomerResource updateCustomer(customer, updateCustomerRequest)
|
|
483
|
+
|
|
484
|
+
Auto-generated: updateCustomer
|
|
485
|
+
|
|
486
|
+
### Example
|
|
487
|
+
|
|
488
|
+
```ts
|
|
489
|
+
import {
|
|
490
|
+
Configuration,
|
|
491
|
+
CustomersApi,
|
|
492
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
493
|
+
import type { UpdateCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
494
|
+
|
|
495
|
+
async function example() {
|
|
496
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
497
|
+
const api = new CustomersApi();
|
|
498
|
+
|
|
499
|
+
const body = {
|
|
500
|
+
// number | The id of the customer
|
|
501
|
+
customer: 56,
|
|
502
|
+
// UpdateCustomerRequest (optional)
|
|
503
|
+
updateCustomerRequest: ...,
|
|
504
|
+
} satisfies UpdateCustomerOperationRequest;
|
|
505
|
+
|
|
506
|
+
try {
|
|
507
|
+
const data = await api.updateCustomer(body);
|
|
508
|
+
console.log(data);
|
|
509
|
+
} catch (error) {
|
|
510
|
+
console.error(error);
|
|
511
|
+
}
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
// Run the test
|
|
515
|
+
example().catch(console.error);
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
### Parameters
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
| Name | Type | Description | Notes |
|
|
522
|
+
|------------- | ------------- | ------------- | -------------|
|
|
523
|
+
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
524
|
+
| **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.md) | | [Optional] |
|
|
525
|
+
|
|
526
|
+
### Return type
|
|
527
|
+
|
|
528
|
+
[**CustomerResource**](CustomerResource.md)
|
|
529
|
+
|
|
530
|
+
### Authorization
|
|
531
|
+
|
|
532
|
+
No authorization required
|
|
533
|
+
|
|
534
|
+
### HTTP request headers
|
|
535
|
+
|
|
536
|
+
- **Content-Type**: `application/json`
|
|
537
|
+
- **Accept**: `application/json`
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
### HTTP response details
|
|
541
|
+
| Status code | Description | Response headers |
|
|
542
|
+
|-------------|-------------|------------------|
|
|
543
|
+
| **200** | Successful resource response | - |
|
|
544
|
+
|
|
545
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
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
|
+
|