@digital8/lighting-illusions-ts-sdk 0.0.1572 → 0.0.1574

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.
Files changed (137) hide show
  1. package/.openapi-generator/FILES +18 -40
  2. package/README.md +11 -25
  3. package/dist/apis/RedirectApi.d.ts +33 -0
  4. package/dist/apis/RedirectApi.js +138 -0
  5. package/dist/apis/index.d.ts +1 -1
  6. package/dist/apis/index.js +1 -1
  7. package/dist/models/AddressResource.d.ts +1 -1
  8. package/dist/models/AddressResource.js +3 -1
  9. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  10. package/dist/models/ExternalApiLogResource.js +1 -3
  11. package/dist/models/IndexProductChildRequest.d.ts +0 -1
  12. package/dist/models/IndexProductChildRequest.js +0 -1
  13. package/dist/models/IndexRedirectRequest.d.ts +112 -0
  14. package/dist/models/IndexRedirectRequest.js +91 -0
  15. package/dist/models/ModelAttributeFrontendResource.d.ts +38 -0
  16. package/dist/models/ModelAttributeFrontendResource.js +55 -0
  17. package/dist/models/ModelAttributeFrontendResourceArrayResponse.d.ts +33 -0
  18. package/dist/models/ModelAttributeFrontendResourceArrayResponse.js +50 -0
  19. package/dist/models/PaginatedRedirectListResourceResponse.d.ts +40 -0
  20. package/dist/models/PaginatedRedirectListResourceResponse.js +57 -0
  21. package/dist/models/ProductRangeFrontendResource.d.ts +7 -0
  22. package/dist/models/ProductRangeFrontendResource.js +5 -0
  23. package/dist/models/RedirectFrontendResource.d.ts +62 -0
  24. package/dist/models/RedirectFrontendResource.js +71 -0
  25. package/dist/models/RedirectFrontendResourceArrayResponse.d.ts +33 -0
  26. package/dist/models/RedirectFrontendResourceArrayResponse.js +50 -0
  27. package/dist/models/RedirectListResource.d.ts +69 -0
  28. package/dist/models/RedirectListResource.js +76 -0
  29. package/dist/models/RedirectListResourceArrayResponse.d.ts +33 -0
  30. package/dist/models/RedirectListResourceArrayResponse.js +50 -0
  31. package/dist/models/StoreFrontendResource.d.ts +1 -1
  32. package/dist/models/StoreFrontendResource.js +1 -3
  33. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  34. package/dist/models/StoreSpecialDateResource.js +3 -1
  35. package/dist/models/index.d.ts +8 -19
  36. package/dist/models/index.js +8 -19
  37. package/docs/{GetAllProductRegistrationRequest.md → IndexRedirectRequest.md} +12 -6
  38. package/docs/{ProductRegistrationAssetType.md → ModelAttributeFrontendResource.md} +8 -4
  39. package/docs/{ProductRegistrationLiteResourceArrayResponse.md → ModelAttributeFrontendResourceArrayResponse.md} +5 -5
  40. package/docs/{PaginatedProductRegistrationResourceResponse.md → PaginatedRedirectListResourceResponse.md} +5 -5
  41. package/docs/ProductRangeFrontendResource.md +2 -0
  42. package/docs/RedirectApi.md +74 -0
  43. package/docs/{ProductRegistrationAssetResource.md → RedirectFrontendResource.md} +14 -8
  44. package/docs/{ProductRegistrationResourceArrayResponse.md → RedirectFrontendResourceArrayResponse.md} +5 -5
  45. package/docs/{ProductRegistrationCustomerResource.md → RedirectListResource.md} +16 -14
  46. package/docs/{ProductRegistrationLiteResource.md → RedirectListResourceArrayResponse.md} +6 -8
  47. package/docs/StoreSpecialDateResource.md +1 -1
  48. package/package.json +1 -1
  49. package/src/apis/RedirectApi.ts +77 -0
  50. package/src/apis/index.ts +1 -1
  51. package/src/models/AddressResource.ts +3 -2
  52. package/src/models/ExternalApiLogResource.ts +2 -3
  53. package/src/models/IndexProductChildRequest.ts +0 -1
  54. package/src/models/IndexRedirectRequest.ts +168 -0
  55. package/src/models/ModelAttributeFrontendResource.ts +75 -0
  56. package/src/models/ModelAttributeFrontendResourceArrayResponse.ts +73 -0
  57. package/src/models/PaginatedRedirectListResourceResponse.ts +90 -0
  58. package/src/models/ProductRangeFrontendResource.ts +16 -0
  59. package/src/models/RedirectFrontendResource.ts +111 -0
  60. package/src/models/RedirectFrontendResourceArrayResponse.ts +73 -0
  61. package/src/models/RedirectListResource.ts +128 -0
  62. package/src/models/RedirectListResourceArrayResponse.ts +73 -0
  63. package/src/models/StoreFrontendResource.ts +2 -3
  64. package/src/models/StoreSpecialDateResource.ts +4 -3
  65. package/src/models/index.ts +8 -19
  66. package/dist/apis/ProductRegistrationApi.d.ts +0 -79
  67. package/dist/apis/ProductRegistrationApi.js +0 -316
  68. package/dist/models/GetAllProductRegistrationRequest.d.ts +0 -88
  69. package/dist/models/GetAllProductRegistrationRequest.js +0 -80
  70. package/dist/models/IndexProductRegistrationRequest.d.ts +0 -131
  71. package/dist/models/IndexProductRegistrationRequest.js +0 -98
  72. package/dist/models/ListAssetsProductRegistrationRequest.d.ts +0 -103
  73. package/dist/models/ListAssetsProductRegistrationRequest.js +0 -83
  74. package/dist/models/PaginatedProductRegistrationAssetResourceResponse.d.ts +0 -40
  75. package/dist/models/PaginatedProductRegistrationAssetResourceResponse.js +0 -57
  76. package/dist/models/PaginatedProductRegistrationListResourceResponse.d.ts +0 -40
  77. package/dist/models/PaginatedProductRegistrationListResourceResponse.js +0 -57
  78. package/dist/models/PaginatedProductRegistrationResourceResponse.d.ts +0 -40
  79. package/dist/models/PaginatedProductRegistrationResourceResponse.js +0 -57
  80. package/dist/models/ProductRegistrationAssetResource.d.ts +0 -45
  81. package/dist/models/ProductRegistrationAssetResource.js +0 -58
  82. package/dist/models/ProductRegistrationAssetResourceArrayResponse.d.ts +0 -33
  83. package/dist/models/ProductRegistrationAssetResourceArrayResponse.js +0 -50
  84. package/dist/models/ProductRegistrationAssetType.d.ts +0 -25
  85. package/dist/models/ProductRegistrationAssetType.js +0 -51
  86. package/dist/models/ProductRegistrationCustomerResource.d.ts +0 -62
  87. package/dist/models/ProductRegistrationCustomerResource.js +0 -65
  88. package/dist/models/ProductRegistrationCustomerResourceArrayResponse.d.ts +0 -33
  89. package/dist/models/ProductRegistrationCustomerResourceArrayResponse.js +0 -50
  90. package/dist/models/ProductRegistrationListResource.d.ts +0 -57
  91. package/dist/models/ProductRegistrationListResource.js +0 -64
  92. package/dist/models/ProductRegistrationListResourceArrayResponse.d.ts +0 -33
  93. package/dist/models/ProductRegistrationListResourceArrayResponse.js +0 -50
  94. package/dist/models/ProductRegistrationLiteResource.d.ts +0 -38
  95. package/dist/models/ProductRegistrationLiteResource.js +0 -53
  96. package/dist/models/ProductRegistrationLiteResourceArrayResponse.d.ts +0 -33
  97. package/dist/models/ProductRegistrationLiteResourceArrayResponse.js +0 -50
  98. package/dist/models/ProductRegistrationProductChildResource.d.ts +0 -50
  99. package/dist/models/ProductRegistrationProductChildResource.js +0 -63
  100. package/dist/models/ProductRegistrationProductChildResourceArrayResponse.d.ts +0 -33
  101. package/dist/models/ProductRegistrationProductChildResourceArrayResponse.js +0 -50
  102. package/dist/models/ProductRegistrationResource.d.ts +0 -90
  103. package/dist/models/ProductRegistrationResource.js +0 -81
  104. package/dist/models/ProductRegistrationResourceArrayResponse.d.ts +0 -33
  105. package/dist/models/ProductRegistrationResourceArrayResponse.js +0 -50
  106. package/docs/IndexProductRegistrationRequest.md +0 -58
  107. package/docs/ListAssetsProductRegistrationRequest.md +0 -52
  108. package/docs/PaginatedProductRegistrationAssetResourceResponse.md +0 -36
  109. package/docs/PaginatedProductRegistrationListResourceResponse.md +0 -36
  110. package/docs/ProductRegistrationApi.md +0 -275
  111. package/docs/ProductRegistrationAssetResourceArrayResponse.md +0 -34
  112. package/docs/ProductRegistrationCustomerResourceArrayResponse.md +0 -34
  113. package/docs/ProductRegistrationListResource.md +0 -42
  114. package/docs/ProductRegistrationListResourceArrayResponse.md +0 -34
  115. package/docs/ProductRegistrationProductChildResource.md +0 -40
  116. package/docs/ProductRegistrationProductChildResourceArrayResponse.md +0 -34
  117. package/docs/ProductRegistrationResource.md +0 -52
  118. package/src/apis/ProductRegistrationApi.ts +0 -238
  119. package/src/models/GetAllProductRegistrationRequest.ts +0 -137
  120. package/src/models/IndexProductRegistrationRequest.ts +0 -193
  121. package/src/models/ListAssetsProductRegistrationRequest.ts +0 -158
  122. package/src/models/PaginatedProductRegistrationAssetResourceResponse.ts +0 -90
  123. package/src/models/PaginatedProductRegistrationListResourceResponse.ts +0 -90
  124. package/src/models/PaginatedProductRegistrationResourceResponse.ts +0 -90
  125. package/src/models/ProductRegistrationAssetResource.ts +0 -91
  126. package/src/models/ProductRegistrationAssetResourceArrayResponse.ts +0 -73
  127. package/src/models/ProductRegistrationAssetType.ts +0 -53
  128. package/src/models/ProductRegistrationCustomerResource.ts +0 -108
  129. package/src/models/ProductRegistrationCustomerResourceArrayResponse.ts +0 -73
  130. package/src/models/ProductRegistrationListResource.ts +0 -108
  131. package/src/models/ProductRegistrationListResourceArrayResponse.ts +0 -73
  132. package/src/models/ProductRegistrationLiteResource.ts +0 -74
  133. package/src/models/ProductRegistrationLiteResourceArrayResponse.ts +0 -73
  134. package/src/models/ProductRegistrationProductChildResource.ts +0 -93
  135. package/src/models/ProductRegistrationProductChildResourceArrayResponse.ts +0 -73
  136. package/src/models/ProductRegistrationResource.ts +0 -171
  137. package/src/models/ProductRegistrationResourceArrayResponse.ts +0 -73
@@ -1,50 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * My API
6
- * API documentation for my Laravel app
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfProductRegistrationResourceArrayResponse = instanceOfProductRegistrationResourceArrayResponse;
17
- exports.ProductRegistrationResourceArrayResponseFromJSON = ProductRegistrationResourceArrayResponseFromJSON;
18
- exports.ProductRegistrationResourceArrayResponseFromJSONTyped = ProductRegistrationResourceArrayResponseFromJSONTyped;
19
- exports.ProductRegistrationResourceArrayResponseToJSON = ProductRegistrationResourceArrayResponseToJSON;
20
- exports.ProductRegistrationResourceArrayResponseToJSONTyped = ProductRegistrationResourceArrayResponseToJSONTyped;
21
- var ProductRegistrationResource_1 = require("./ProductRegistrationResource");
22
- /**
23
- * Check if a given object implements the ProductRegistrationResourceArrayResponse interface.
24
- */
25
- function instanceOfProductRegistrationResourceArrayResponse(value) {
26
- return true;
27
- }
28
- function ProductRegistrationResourceArrayResponseFromJSON(json) {
29
- return ProductRegistrationResourceArrayResponseFromJSONTyped(json, false);
30
- }
31
- function ProductRegistrationResourceArrayResponseFromJSONTyped(json, ignoreDiscriminator) {
32
- if (json == null) {
33
- return json;
34
- }
35
- return {
36
- 'data': json['data'] == null ? undefined : (json['data'].map(ProductRegistrationResource_1.ProductRegistrationResourceFromJSON)),
37
- };
38
- }
39
- function ProductRegistrationResourceArrayResponseToJSON(json) {
40
- return ProductRegistrationResourceArrayResponseToJSONTyped(json, false);
41
- }
42
- function ProductRegistrationResourceArrayResponseToJSONTyped(value, ignoreDiscriminator) {
43
- if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
44
- if (value == null) {
45
- return value;
46
- }
47
- return {
48
- 'data': value['data'] == null ? undefined : (value['data'].map(ProductRegistrationResource_1.ProductRegistrationResourceToJSON)),
49
- };
50
- }
@@ -1,58 +0,0 @@
1
-
2
- # IndexProductRegistrationRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `search` | string
10
- `sortBy` | string
11
- `sortDirection` | string
12
- `perPage` | number
13
- `page` | number
14
- `siteId` | Array<string>
15
- `beforePurchasedDate` | Date
16
- `afterPurchasedDate` | Date
17
- `beforeCreatedAt` | Date
18
- `afterCreatedAt` | Date
19
- `relatedId` | number
20
- `relatedType` | string
21
- `includesRelations` | boolean
22
-
23
- ## Example
24
-
25
- ```typescript
26
- import type { IndexProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
27
-
28
- // TODO: Update the object below with actual values
29
- const example = {
30
- "search": null,
31
- "sortBy": null,
32
- "sortDirection": null,
33
- "perPage": null,
34
- "page": null,
35
- "siteId": null,
36
- "beforePurchasedDate": null,
37
- "afterPurchasedDate": null,
38
- "beforeCreatedAt": null,
39
- "afterCreatedAt": null,
40
- "relatedId": null,
41
- "relatedType": null,
42
- "includesRelations": null,
43
- } satisfies IndexProductRegistrationRequest
44
-
45
- console.log(example)
46
-
47
- // Convert the instance to a JSON string
48
- const exampleJSON: string = JSON.stringify(example)
49
- console.log(exampleJSON)
50
-
51
- // Parse the JSON string back to an object
52
- const exampleParsed = JSON.parse(exampleJSON) as IndexProductRegistrationRequest
53
- console.log(exampleParsed)
54
- ```
55
-
56
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
57
-
58
-
@@ -1,52 +0,0 @@
1
-
2
- # ListAssetsProductRegistrationRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `search` | string
10
- `sortBy` | string
11
- `sortDirection` | string
12
- `perPage` | number
13
- `page` | number
14
- `productRegistrationId` | Array<string>
15
- `type` | Array<string>
16
- `relatedId` | number
17
- `relatedType` | string
18
- `includesRelations` | boolean
19
-
20
- ## Example
21
-
22
- ```typescript
23
- import type { ListAssetsProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk'
24
-
25
- // TODO: Update the object below with actual values
26
- const example = {
27
- "search": null,
28
- "sortBy": null,
29
- "sortDirection": null,
30
- "perPage": null,
31
- "page": null,
32
- "productRegistrationId": null,
33
- "type": null,
34
- "relatedId": null,
35
- "relatedType": null,
36
- "includesRelations": null,
37
- } satisfies ListAssetsProductRegistrationRequest
38
-
39
- console.log(example)
40
-
41
- // Convert the instance to a JSON string
42
- const exampleJSON: string = JSON.stringify(example)
43
- console.log(exampleJSON)
44
-
45
- // Parse the JSON string back to an object
46
- const exampleParsed = JSON.parse(exampleJSON) as ListAssetsProductRegistrationRequest
47
- console.log(exampleParsed)
48
- ```
49
-
50
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
-
52
-
@@ -1,36 +0,0 @@
1
-
2
- # PaginatedProductRegistrationAssetResourceResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<ProductRegistrationAssetResource>](ProductRegistrationAssetResource.md)
10
- `meta` | [PagingMetadata](PagingMetadata.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { PaginatedProductRegistrationAssetResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "data": null,
20
- "meta": null,
21
- } satisfies PaginatedProductRegistrationAssetResourceResponse
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 PaginatedProductRegistrationAssetResourceResponse
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
-
@@ -1,36 +0,0 @@
1
-
2
- # PaginatedProductRegistrationListResourceResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
10
- `meta` | [PagingMetadata](PagingMetadata.md)
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import type { PaginatedProductRegistrationListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
-
17
- // TODO: Update the object below with actual values
18
- const example = {
19
- "data": null,
20
- "meta": null,
21
- } satisfies PaginatedProductRegistrationListResourceResponse
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 PaginatedProductRegistrationListResourceResponse
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
-
@@ -1,275 +0,0 @@
1
- # ProductRegistrationApi
2
-
3
- All URIs are relative to *http://localhost/api*
4
-
5
- | Method | HTTP request | Description |
6
- |------------- | ------------- | -------------|
7
- | [**getAllProductRegistration**](ProductRegistrationApi.md#getallproductregistrationoperation) | **POST** /admin-api/product-registration/all | Auto-generated: getAllProductRegistration |
8
- | [**indexProductRegistration**](ProductRegistrationApi.md#indexproductregistrationoperation) | **POST** /admin-api/product-registration/list | Auto-generated: indexProductRegistration |
9
- | [**listAssetsProductRegistration**](ProductRegistrationApi.md#listassetsproductregistrationoperation) | **POST** /admin-api/product-registration/{productRegistration}/assets | Auto-generated: listAssetsProductRegistration |
10
- | [**showProductRegistration**](ProductRegistrationApi.md#showproductregistration) | **GET** /admin-api/product-registration/{productRegistration} | Auto-generated: showProductRegistration |
11
-
12
-
13
-
14
- ## getAllProductRegistration
15
-
16
- > ProductRegistrationLiteResourceArrayResponse getAllProductRegistration(getAllProductRegistrationRequest)
17
-
18
- Auto-generated: getAllProductRegistration
19
-
20
- ### Example
21
-
22
- ```ts
23
- import {
24
- Configuration,
25
- ProductRegistrationApi,
26
- } from '@digital8/lighting-illusions-ts-sdk';
27
- import type { GetAllProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
28
-
29
- async function example() {
30
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
31
- const api = new ProductRegistrationApi();
32
-
33
- const body = {
34
- // GetAllProductRegistrationRequest (optional)
35
- getAllProductRegistrationRequest: ...,
36
- } satisfies GetAllProductRegistrationOperationRequest;
37
-
38
- try {
39
- const data = await api.getAllProductRegistration(body);
40
- console.log(data);
41
- } catch (error) {
42
- console.error(error);
43
- }
44
- }
45
-
46
- // Run the test
47
- example().catch(console.error);
48
- ```
49
-
50
- ### Parameters
51
-
52
-
53
- | Name | Type | Description | Notes |
54
- |------------- | ------------- | ------------- | -------------|
55
- | **getAllProductRegistrationRequest** | [GetAllProductRegistrationRequest](GetAllProductRegistrationRequest.md) | | [Optional] |
56
-
57
- ### Return type
58
-
59
- [**ProductRegistrationLiteResourceArrayResponse**](ProductRegistrationLiteResourceArrayResponse.md)
60
-
61
- ### Authorization
62
-
63
- No authorization required
64
-
65
- ### HTTP request headers
66
-
67
- - **Content-Type**: `application/json`
68
- - **Accept**: `application/json`
69
-
70
-
71
- ### HTTP response details
72
- | Status code | Description | Response headers |
73
- |-------------|-------------|------------------|
74
- | **200** | Successful resource response | - |
75
-
76
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
77
-
78
-
79
- ## indexProductRegistration
80
-
81
- > PaginatedProductRegistrationListResourceResponse indexProductRegistration(indexProductRegistrationRequest)
82
-
83
- Auto-generated: indexProductRegistration
84
-
85
- ### Example
86
-
87
- ```ts
88
- import {
89
- Configuration,
90
- ProductRegistrationApi,
91
- } from '@digital8/lighting-illusions-ts-sdk';
92
- import type { IndexProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
93
-
94
- async function example() {
95
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
96
- const api = new ProductRegistrationApi();
97
-
98
- const body = {
99
- // IndexProductRegistrationRequest (optional)
100
- indexProductRegistrationRequest: ...,
101
- } satisfies IndexProductRegistrationOperationRequest;
102
-
103
- try {
104
- const data = await api.indexProductRegistration(body);
105
- console.log(data);
106
- } catch (error) {
107
- console.error(error);
108
- }
109
- }
110
-
111
- // Run the test
112
- example().catch(console.error);
113
- ```
114
-
115
- ### Parameters
116
-
117
-
118
- | Name | Type | Description | Notes |
119
- |------------- | ------------- | ------------- | -------------|
120
- | **indexProductRegistrationRequest** | [IndexProductRegistrationRequest](IndexProductRegistrationRequest.md) | | [Optional] |
121
-
122
- ### Return type
123
-
124
- [**PaginatedProductRegistrationListResourceResponse**](PaginatedProductRegistrationListResourceResponse.md)
125
-
126
- ### Authorization
127
-
128
- No authorization required
129
-
130
- ### HTTP request headers
131
-
132
- - **Content-Type**: `application/json`
133
- - **Accept**: `application/json`
134
-
135
-
136
- ### HTTP response details
137
- | Status code | Description | Response headers |
138
- |-------------|-------------|------------------|
139
- | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductRegistrationListResource[]>> | - |
140
-
141
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
142
-
143
-
144
- ## listAssetsProductRegistration
145
-
146
- > PaginatedProductRegistrationAssetResourceResponse listAssetsProductRegistration(productRegistration, listAssetsProductRegistrationRequest)
147
-
148
- Auto-generated: listAssetsProductRegistration
149
-
150
- ### Example
151
-
152
- ```ts
153
- import {
154
- Configuration,
155
- ProductRegistrationApi,
156
- } from '@digital8/lighting-illusions-ts-sdk';
157
- import type { ListAssetsProductRegistrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
158
-
159
- async function example() {
160
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
161
- const api = new ProductRegistrationApi();
162
-
163
- const body = {
164
- // number | The id of the productRegistration
165
- productRegistration: 56,
166
- // ListAssetsProductRegistrationRequest (optional)
167
- listAssetsProductRegistrationRequest: ...,
168
- } satisfies ListAssetsProductRegistrationOperationRequest;
169
-
170
- try {
171
- const data = await api.listAssetsProductRegistration(body);
172
- console.log(data);
173
- } catch (error) {
174
- console.error(error);
175
- }
176
- }
177
-
178
- // Run the test
179
- example().catch(console.error);
180
- ```
181
-
182
- ### Parameters
183
-
184
-
185
- | Name | Type | Description | Notes |
186
- |------------- | ------------- | ------------- | -------------|
187
- | **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
188
- | **listAssetsProductRegistrationRequest** | [ListAssetsProductRegistrationRequest](ListAssetsProductRegistrationRequest.md) | | [Optional] |
189
-
190
- ### Return type
191
-
192
- [**PaginatedProductRegistrationAssetResourceResponse**](PaginatedProductRegistrationAssetResourceResponse.md)
193
-
194
- ### Authorization
195
-
196
- No authorization required
197
-
198
- ### HTTP request headers
199
-
200
- - **Content-Type**: `application/json`
201
- - **Accept**: `application/json`
202
-
203
-
204
- ### HTTP response details
205
- | Status code | Description | Response headers |
206
- |-------------|-------------|------------------|
207
- | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductRegistrationAssetResource[]>> | - |
208
-
209
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
210
-
211
-
212
- ## showProductRegistration
213
-
214
- > ProductRegistrationResource showProductRegistration(productRegistration)
215
-
216
- Auto-generated: showProductRegistration
217
-
218
- ### Example
219
-
220
- ```ts
221
- import {
222
- Configuration,
223
- ProductRegistrationApi,
224
- } from '@digital8/lighting-illusions-ts-sdk';
225
- import type { ShowProductRegistrationRequest } from '@digital8/lighting-illusions-ts-sdk';
226
-
227
- async function example() {
228
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
229
- const api = new ProductRegistrationApi();
230
-
231
- const body = {
232
- // number | The id of the productRegistration
233
- productRegistration: 56,
234
- } satisfies ShowProductRegistrationRequest;
235
-
236
- try {
237
- const data = await api.showProductRegistration(body);
238
- console.log(data);
239
- } catch (error) {
240
- console.error(error);
241
- }
242
- }
243
-
244
- // Run the test
245
- example().catch(console.error);
246
- ```
247
-
248
- ### Parameters
249
-
250
-
251
- | Name | Type | Description | Notes |
252
- |------------- | ------------- | ------------- | -------------|
253
- | **productRegistration** | `number` | The id of the productRegistration | [Defaults to `undefined`] |
254
-
255
- ### Return type
256
-
257
- [**ProductRegistrationResource**](ProductRegistrationResource.md)
258
-
259
- ### Authorization
260
-
261
- No authorization required
262
-
263
- ### HTTP request headers
264
-
265
- - **Content-Type**: Not defined
266
- - **Accept**: `application/json`
267
-
268
-
269
- ### HTTP response details
270
- | Status code | Description | Response headers |
271
- |-------------|-------------|------------------|
272
- | **200** | Successful resource response | - |
273
-
274
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
275
-
@@ -1,34 +0,0 @@
1
-
2
- # ProductRegistrationAssetResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<ProductRegistrationAssetResource>](ProductRegistrationAssetResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { ProductRegistrationAssetResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies ProductRegistrationAssetResourceArrayResponse
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 ProductRegistrationAssetResourceArrayResponse
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
-
@@ -1,34 +0,0 @@
1
-
2
- # ProductRegistrationCustomerResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<ProductRegistrationCustomerResource>](ProductRegistrationCustomerResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { ProductRegistrationCustomerResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies ProductRegistrationCustomerResourceArrayResponse
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 ProductRegistrationCustomerResourceArrayResponse
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
-
@@ -1,42 +0,0 @@
1
-
2
- # ProductRegistrationListResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `purchasedDate` | Date
11
- `customer` | [ProductRegistrationCustomerResource](ProductRegistrationCustomerResource.md)
12
- `productChildrenCount` | number
13
- `createdAt` | Date
14
-
15
- ## Example
16
-
17
- ```typescript
18
- import type { ProductRegistrationListResource } from '@digital8/lighting-illusions-ts-sdk'
19
-
20
- // TODO: Update the object below with actual values
21
- const example = {
22
- "id": null,
23
- "purchasedDate": null,
24
- "customer": null,
25
- "productChildrenCount": null,
26
- "createdAt": null,
27
- } satisfies ProductRegistrationListResource
28
-
29
- console.log(example)
30
-
31
- // Convert the instance to a JSON string
32
- const exampleJSON: string = JSON.stringify(example)
33
- console.log(exampleJSON)
34
-
35
- // Parse the JSON string back to an object
36
- const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationListResource
37
- console.log(exampleParsed)
38
- ```
39
-
40
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
-
42
-
@@ -1,34 +0,0 @@
1
-
2
- # ProductRegistrationListResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<ProductRegistrationListResource>](ProductRegistrationListResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { ProductRegistrationListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies ProductRegistrationListResourceArrayResponse
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 ProductRegistrationListResourceArrayResponse
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
-
@@ -1,40 +0,0 @@
1
-
2
- # ProductRegistrationProductChildResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `name` | string
11
- `sku` | number
12
- `quantity` | number
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import type { ProductRegistrationProductChildResource } from '@digital8/lighting-illusions-ts-sdk'
18
-
19
- // TODO: Update the object below with actual values
20
- const example = {
21
- "id": null,
22
- "name": null,
23
- "sku": null,
24
- "quantity": null,
25
- } satisfies ProductRegistrationProductChildResource
26
-
27
- console.log(example)
28
-
29
- // Convert the instance to a JSON string
30
- const exampleJSON: string = JSON.stringify(example)
31
- console.log(exampleJSON)
32
-
33
- // Parse the JSON string back to an object
34
- const exampleParsed = JSON.parse(exampleJSON) as ProductRegistrationProductChildResource
35
- console.log(exampleParsed)
36
- ```
37
-
38
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
-
40
-