@digital8/lighting-illusions-ts-sdk 0.0.649 → 0.0.651
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 +38 -10
- package/README.md +26 -7
- package/dist/apis/DefinitionApi.d.ts +85 -0
- package/dist/apis/DefinitionApi.js +355 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/CategoryFrontendResource.d.ts +70 -0
- package/dist/models/CategoryFrontendResource.js +73 -0
- package/dist/models/CategoryFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/CategoryFrontendResourceArrayResponse.js +50 -0
- package/dist/models/CategoryWithChildrenFrontendResource.d.ts +39 -0
- package/dist/models/CategoryWithChildrenFrontendResource.js +56 -0
- package/dist/models/CategoryWithChildrenFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/CategoryWithChildrenFrontendResourceArrayResponse.js +50 -0
- package/dist/models/DefinitionListResource.d.ts +38 -0
- package/dist/models/DefinitionListResource.js +55 -0
- package/dist/models/DefinitionListResourceArrayResponse.d.ts +33 -0
- package/dist/models/DefinitionListResourceArrayResponse.js +50 -0
- package/dist/models/DefinitionResource.d.ts +44 -0
- package/dist/models/DefinitionResource.js +59 -0
- package/dist/models/DefinitionResourceArrayResponse.d.ts +33 -0
- package/dist/models/DefinitionResourceArrayResponse.js +50 -0
- package/dist/models/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/GetAllDefinitionRequest.d.ts +80 -0
- package/dist/models/GetAllDefinitionRequest.js +76 -0
- package/dist/models/GlobalSearchProductResource.d.ts +6 -0
- package/dist/models/GlobalSearchProductResource.js +4 -0
- package/dist/models/IndexDefinitionRequest.d.ts +92 -0
- package/dist/models/IndexDefinitionRequest.js +80 -0
- package/dist/models/OverlayTemplateAssetFrontendResource.d.ts +3 -2
- package/dist/models/OverlayTemplateAssetFrontendResource.js +3 -2
- package/dist/models/OverlayTemplateAssetResource.d.ts +3 -3
- package/dist/models/OverlayTemplateAssetResource.js +3 -3
- package/dist/models/PaginatedCategoryFrontendResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedCategoryFrontendResourceResponse.js +57 -0
- package/dist/models/PaginatedDefinitionListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedDefinitionListResourceResponse.js +57 -0
- package/dist/models/PaginatedDefinitionResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedDefinitionResourceResponse.js +57 -0
- package/dist/models/ProductAvailability.d.ts +26 -0
- package/dist/models/ProductAvailability.js +52 -0
- package/dist/models/ProductCompareResource.d.ts +2 -2
- package/dist/models/ProductSearchResultResource.d.ts +12 -6
- package/dist/models/ProductSearchResultResource.js +8 -4
- package/dist/models/StoreDefinitionRequest.d.ts +38 -0
- package/dist/models/StoreDefinitionRequest.js +55 -0
- package/dist/models/SupplierFrontendResource.d.ts +7 -8
- package/dist/models/SupplierFrontendResource.js +8 -9
- package/dist/models/TagFrontendResource.d.ts +63 -0
- package/dist/models/TagFrontendResource.js +72 -0
- package/dist/models/TagFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/TagFrontendResourceArrayResponse.js +50 -0
- package/dist/models/UpdateDefinitionRequest.d.ts +38 -0
- package/dist/models/UpdateDefinitionRequest.js +55 -0
- package/dist/models/index.d.ts +18 -5
- package/dist/models/index.js +18 -5
- package/docs/CategoryFrontendResource.md +46 -0
- package/docs/CategoryFrontendResourceArrayResponse.md +34 -0
- package/docs/CategoryWithChildrenFrontendResource.md +36 -0
- package/docs/CategoryWithChildrenFrontendResourceArrayResponse.md +34 -0
- package/docs/DefinitionApi.md +407 -0
- package/docs/{WishlistToggleResource.md → DefinitionListResource.md} +8 -8
- package/docs/{WishlistToggleResourceArrayResponse.md → DefinitionListResourceArrayResponse.md} +5 -5
- package/docs/DefinitionResource.md +38 -0
- package/docs/{WishlistCheckResourceArrayResponse.md → DefinitionResourceArrayResponse.md} +5 -5
- package/docs/GetAllDefinitionRequest.md +44 -0
- package/docs/GlobalSearchProductResource.md +2 -0
- package/docs/IndexDefinitionRequest.md +48 -0
- package/docs/OverlayTemplateAssetFrontendResource.md +1 -1
- package/docs/OverlayTemplateAssetResource.md +1 -1
- package/docs/PaginatedCategoryFrontendResourceResponse.md +36 -0
- package/docs/PaginatedDefinitionListResourceResponse.md +36 -0
- package/docs/PaginatedDefinitionResourceResponse.md +36 -0
- package/docs/{ProductStatus.md → ProductAvailability.md} +4 -4
- package/docs/ProductCompareResource.md +1 -1
- package/docs/ProductSearchResultResource.md +4 -2
- package/docs/{WishlistCheckResource.md → StoreDefinitionRequest.md} +8 -6
- package/docs/SupplierFrontendResource.md +4 -4
- package/docs/TagFrontendResource.md +44 -0
- package/docs/TagFrontendResourceArrayResponse.md +34 -0
- package/docs/UpdateDefinitionRequest.md +36 -0
- package/package.json +1 -1
- package/src/apis/DefinitionApi.ts +286 -0
- package/src/apis/index.ts +1 -0
- package/src/models/CategoryFrontendResource.ts +133 -0
- package/src/models/CategoryFrontendResourceArrayResponse.ts +73 -0
- package/src/models/CategoryWithChildrenFrontendResource.ts +83 -0
- package/src/models/CategoryWithChildrenFrontendResourceArrayResponse.ts +73 -0
- package/src/models/DefinitionListResource.ts +75 -0
- package/src/models/DefinitionListResourceArrayResponse.ts +73 -0
- package/src/models/DefinitionResource.ts +84 -0
- package/src/models/DefinitionResourceArrayResponse.ts +73 -0
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/GetAllDefinitionRequest.ts +127 -0
- package/src/models/GlobalSearchProductResource.ts +9 -0
- package/src/models/IndexDefinitionRequest.ts +143 -0
- package/src/models/OverlayTemplateAssetFrontendResource.ts +12 -4
- package/src/models/OverlayTemplateAssetResource.ts +10 -10
- package/src/models/PaginatedCategoryFrontendResourceResponse.ts +90 -0
- package/src/models/PaginatedDefinitionListResourceResponse.ts +90 -0
- package/src/models/PaginatedDefinitionResourceResponse.ts +90 -0
- package/src/models/ProductAvailability.ts +54 -0
- package/src/models/ProductCompareResource.ts +2 -2
- package/src/models/ProductSearchResultResource.ts +18 -9
- package/src/models/StoreDefinitionRequest.ts +75 -0
- package/src/models/SupplierFrontendResource.ts +20 -27
- package/src/models/TagFrontendResource.ts +119 -0
- package/src/models/TagFrontendResourceArrayResponse.ts +73 -0
- package/src/models/UpdateDefinitionRequest.ts +75 -0
- package/src/models/index.ts +18 -5
- package/dist/models/ProductStatus.d.ts +0 -24
- package/dist/models/ProductStatus.js +0 -50
- package/dist/models/WishlistCheckResource.d.ts +0 -32
- package/dist/models/WishlistCheckResource.js +0 -51
- package/dist/models/WishlistCheckResourceArrayResponse.d.ts +0 -33
- package/dist/models/WishlistCheckResourceArrayResponse.js +0 -50
- package/dist/models/WishlistToggleResource.d.ts +0 -38
- package/dist/models/WishlistToggleResource.js +0 -55
- package/dist/models/WishlistToggleResourceArrayResponse.d.ts +0 -33
- package/dist/models/WishlistToggleResourceArrayResponse.js +0 -50
- package/src/models/ProductStatus.ts +0 -52
- package/src/models/WishlistCheckResource.ts +0 -66
- package/src/models/WishlistCheckResourceArrayResponse.ts +0 -73
- package/src/models/WishlistToggleResource.ts +0 -75
- package/src/models/WishlistToggleResourceArrayResponse.ts +0 -73
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedCategoryFrontendResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<CategoryFrontendResource>](CategoryFrontendResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedCategoryFrontendResourceResponse } 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 PaginatedCategoryFrontendResourceResponse
|
|
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 PaginatedCategoryFrontendResourceResponse
|
|
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,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedDefinitionListResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<DefinitionListResource>](DefinitionListResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedDefinitionListResourceResponse } 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 PaginatedDefinitionListResourceResponse
|
|
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 PaginatedDefinitionListResourceResponse
|
|
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,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedDefinitionResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<DefinitionResource>](DefinitionResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedDefinitionResourceResponse } 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 PaginatedDefinitionResourceResponse
|
|
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 PaginatedDefinitionResourceResponse
|
|
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,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ProductAvailability
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -10,11 +10,11 @@ Name | Type
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import type {
|
|
13
|
+
import type { ProductAvailability } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
14
|
|
|
15
15
|
// TODO: Update the object below with actual values
|
|
16
16
|
const example = {
|
|
17
|
-
} satisfies
|
|
17
|
+
} satisfies ProductAvailability
|
|
18
18
|
|
|
19
19
|
console.log(example)
|
|
20
20
|
|
|
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
23
23
|
console.log(exampleJSON)
|
|
24
24
|
|
|
25
25
|
// Parse the JSON string back to an object
|
|
26
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as ProductAvailability
|
|
27
27
|
console.log(exampleParsed)
|
|
28
28
|
```
|
|
29
29
|
|
|
@@ -16,12 +16,13 @@ Name | Type
|
|
|
16
16
|
`thumbnail` | string
|
|
17
17
|
`averageRating` | string
|
|
18
18
|
`labelDetails` | Array<number>
|
|
19
|
-
`categories` | Array<object>
|
|
20
19
|
`supplierName` | string
|
|
21
20
|
`supplierLogo` | string
|
|
22
21
|
`supplierId` | number
|
|
23
22
|
`availability` | string
|
|
24
23
|
`wishlisted` | boolean
|
|
24
|
+
`variationCount` | number
|
|
25
|
+
`overlayAssets` | Array<object>
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -40,12 +41,13 @@ const example = {
|
|
|
40
41
|
"thumbnail": null,
|
|
41
42
|
"averageRating": null,
|
|
42
43
|
"labelDetails": null,
|
|
43
|
-
"categories": null,
|
|
44
44
|
"supplierName": null,
|
|
45
45
|
"supplierLogo": null,
|
|
46
46
|
"supplierId": null,
|
|
47
47
|
"availability": null,
|
|
48
48
|
"wishlisted": null,
|
|
49
|
+
"variationCount": null,
|
|
50
|
+
"overlayAssets": null,
|
|
49
51
|
} satisfies ProductSearchResultResource
|
|
50
52
|
|
|
51
53
|
console.log(example)
|
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# StoreDefinitionRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`name` | string
|
|
10
|
+
`content` | string
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
13
14
|
```typescript
|
|
14
|
-
import type {
|
|
15
|
+
import type { StoreDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
16
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
|
|
19
|
+
"name": null,
|
|
20
|
+
"content": null,
|
|
21
|
+
} satisfies StoreDefinitionRequest
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
|
22
24
|
|
|
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
27
|
console.log(exampleJSON)
|
|
26
28
|
|
|
27
29
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as StoreDefinitionRequest
|
|
29
31
|
console.log(exampleParsed)
|
|
30
32
|
```
|
|
31
33
|
|
|
@@ -9,10 +9,10 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`name` | string
|
|
11
11
|
`slug` | string
|
|
12
|
-
`thumbnail` | [
|
|
12
|
+
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
-
`seo` |
|
|
15
|
-
`
|
|
14
|
+
`seo` | object
|
|
15
|
+
`description` | [DescriptionResource](DescriptionResource.md)
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -27,7 +27,7 @@ const example = {
|
|
|
27
27
|
"thumbnail": null,
|
|
28
28
|
"supplierEta": null,
|
|
29
29
|
"seo": null,
|
|
30
|
-
"
|
|
30
|
+
"description": null,
|
|
31
31
|
} satisfies SupplierFrontendResource
|
|
32
32
|
|
|
33
33
|
console.log(example)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# TagFrontendResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`slug` | string
|
|
12
|
+
`type` | string
|
|
13
|
+
`seo` | object
|
|
14
|
+
`description` | [DescriptionResource](DescriptionResource.md)
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { TagFrontendResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"id": null,
|
|
24
|
+
"name": null,
|
|
25
|
+
"slug": null,
|
|
26
|
+
"type": null,
|
|
27
|
+
"seo": null,
|
|
28
|
+
"description": null,
|
|
29
|
+
} satisfies TagFrontendResource
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as TagFrontendResource
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# TagFrontendResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<TagFrontendResource>](TagFrontendResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TagFrontendResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies TagFrontendResourceArrayResponse
|
|
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 TagFrontendResourceArrayResponse
|
|
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,36 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateDefinitionRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`content` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { UpdateDefinitionRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"name": null,
|
|
20
|
+
"content": null,
|
|
21
|
+
} satisfies UpdateDefinitionRequest
|
|
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 UpdateDefinitionRequest
|
|
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
|
+
|
package/package.json
CHANGED
|
@@ -0,0 +1,286 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* My API
|
|
5
|
+
* API documentation for my Laravel app
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import * as runtime from '../runtime';
|
|
17
|
+
import type {
|
|
18
|
+
DefinitionListResourceArrayResponse,
|
|
19
|
+
DefinitionResource,
|
|
20
|
+
GenericResponse,
|
|
21
|
+
GetAllDefinitionRequest,
|
|
22
|
+
IndexDefinitionRequest,
|
|
23
|
+
PaginatedDefinitionListResourceResponse,
|
|
24
|
+
StoreDefinitionRequest,
|
|
25
|
+
UpdateDefinitionRequest,
|
|
26
|
+
} from '../models/index';
|
|
27
|
+
import {
|
|
28
|
+
DefinitionListResourceArrayResponseFromJSON,
|
|
29
|
+
DefinitionListResourceArrayResponseToJSON,
|
|
30
|
+
DefinitionResourceFromJSON,
|
|
31
|
+
DefinitionResourceToJSON,
|
|
32
|
+
GenericResponseFromJSON,
|
|
33
|
+
GenericResponseToJSON,
|
|
34
|
+
GetAllDefinitionRequestFromJSON,
|
|
35
|
+
GetAllDefinitionRequestToJSON,
|
|
36
|
+
IndexDefinitionRequestFromJSON,
|
|
37
|
+
IndexDefinitionRequestToJSON,
|
|
38
|
+
PaginatedDefinitionListResourceResponseFromJSON,
|
|
39
|
+
PaginatedDefinitionListResourceResponseToJSON,
|
|
40
|
+
StoreDefinitionRequestFromJSON,
|
|
41
|
+
StoreDefinitionRequestToJSON,
|
|
42
|
+
UpdateDefinitionRequestFromJSON,
|
|
43
|
+
UpdateDefinitionRequestToJSON,
|
|
44
|
+
} from '../models/index';
|
|
45
|
+
|
|
46
|
+
export interface DestroyDefinitionRequest {
|
|
47
|
+
definition: number;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export interface GetAllDefinitionOperationRequest {
|
|
51
|
+
getAllDefinitionRequest?: GetAllDefinitionRequest;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export interface IndexDefinitionOperationRequest {
|
|
55
|
+
indexDefinitionRequest?: IndexDefinitionRequest;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface ShowDefinitionRequest {
|
|
59
|
+
definition: number;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface StoreDefinitionOperationRequest {
|
|
63
|
+
storeDefinitionRequest?: StoreDefinitionRequest;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export interface UpdateDefinitionOperationRequest {
|
|
67
|
+
definition: number;
|
|
68
|
+
updateDefinitionRequest?: UpdateDefinitionRequest;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
*/
|
|
74
|
+
export class DefinitionApi extends runtime.BaseAPI {
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Auto-generated: destroyDefinition
|
|
78
|
+
*/
|
|
79
|
+
async destroyDefinitionRaw(requestParameters: DestroyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
|
|
80
|
+
if (requestParameters['definition'] == null) {
|
|
81
|
+
throw new runtime.RequiredError(
|
|
82
|
+
'definition',
|
|
83
|
+
'Required parameter "definition" was null or undefined when calling destroyDefinition().'
|
|
84
|
+
);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
const queryParameters: any = {};
|
|
88
|
+
|
|
89
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
let urlPath = `/admin-api/definition/{definition}/delete`;
|
|
93
|
+
urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
|
|
94
|
+
|
|
95
|
+
const response = await this.request({
|
|
96
|
+
path: urlPath,
|
|
97
|
+
method: 'DELETE',
|
|
98
|
+
headers: headerParameters,
|
|
99
|
+
query: queryParameters,
|
|
100
|
+
}, initOverrides);
|
|
101
|
+
|
|
102
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Auto-generated: destroyDefinition
|
|
107
|
+
*/
|
|
108
|
+
async destroyDefinition(requestParameters: DestroyDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
|
|
109
|
+
const response = await this.destroyDefinitionRaw(requestParameters, initOverrides);
|
|
110
|
+
return await response.value();
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Auto-generated: getAllDefinition
|
|
115
|
+
*/
|
|
116
|
+
async getAllDefinitionRaw(requestParameters: GetAllDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionListResourceArrayResponse>> {
|
|
117
|
+
const queryParameters: any = {};
|
|
118
|
+
|
|
119
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
120
|
+
|
|
121
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
let urlPath = `/admin-api/definition/all`;
|
|
125
|
+
|
|
126
|
+
const response = await this.request({
|
|
127
|
+
path: urlPath,
|
|
128
|
+
method: 'POST',
|
|
129
|
+
headers: headerParameters,
|
|
130
|
+
query: queryParameters,
|
|
131
|
+
body: GetAllDefinitionRequestToJSON(requestParameters['getAllDefinitionRequest']),
|
|
132
|
+
}, initOverrides);
|
|
133
|
+
|
|
134
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionListResourceArrayResponseFromJSON(jsonValue));
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* Auto-generated: getAllDefinition
|
|
139
|
+
*/
|
|
140
|
+
async getAllDefinition(requestParameters: GetAllDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionListResourceArrayResponse> {
|
|
141
|
+
const response = await this.getAllDefinitionRaw(requestParameters, initOverrides);
|
|
142
|
+
return await response.value();
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Auto-generated: indexDefinition
|
|
147
|
+
*/
|
|
148
|
+
async indexDefinitionRaw(requestParameters: IndexDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedDefinitionListResourceResponse>> {
|
|
149
|
+
const queryParameters: any = {};
|
|
150
|
+
|
|
151
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
152
|
+
|
|
153
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
let urlPath = `/admin-api/definition/list`;
|
|
157
|
+
|
|
158
|
+
const response = await this.request({
|
|
159
|
+
path: urlPath,
|
|
160
|
+
method: 'POST',
|
|
161
|
+
headers: headerParameters,
|
|
162
|
+
query: queryParameters,
|
|
163
|
+
body: IndexDefinitionRequestToJSON(requestParameters['indexDefinitionRequest']),
|
|
164
|
+
}, initOverrides);
|
|
165
|
+
|
|
166
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedDefinitionListResourceResponseFromJSON(jsonValue));
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Auto-generated: indexDefinition
|
|
171
|
+
*/
|
|
172
|
+
async indexDefinition(requestParameters: IndexDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedDefinitionListResourceResponse> {
|
|
173
|
+
const response = await this.indexDefinitionRaw(requestParameters, initOverrides);
|
|
174
|
+
return await response.value();
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Auto-generated: showDefinition
|
|
179
|
+
*/
|
|
180
|
+
async showDefinitionRaw(requestParameters: ShowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
|
|
181
|
+
if (requestParameters['definition'] == null) {
|
|
182
|
+
throw new runtime.RequiredError(
|
|
183
|
+
'definition',
|
|
184
|
+
'Required parameter "definition" was null or undefined when calling showDefinition().'
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
const queryParameters: any = {};
|
|
189
|
+
|
|
190
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
let urlPath = `/admin-api/definition/{definition}`;
|
|
194
|
+
urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
|
|
195
|
+
|
|
196
|
+
const response = await this.request({
|
|
197
|
+
path: urlPath,
|
|
198
|
+
method: 'GET',
|
|
199
|
+
headers: headerParameters,
|
|
200
|
+
query: queryParameters,
|
|
201
|
+
}, initOverrides);
|
|
202
|
+
|
|
203
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Auto-generated: showDefinition
|
|
208
|
+
*/
|
|
209
|
+
async showDefinition(requestParameters: ShowDefinitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
|
|
210
|
+
const response = await this.showDefinitionRaw(requestParameters, initOverrides);
|
|
211
|
+
return await response.value();
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* Auto-generated: storeDefinition
|
|
216
|
+
*/
|
|
217
|
+
async storeDefinitionRaw(requestParameters: StoreDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
|
|
218
|
+
const queryParameters: any = {};
|
|
219
|
+
|
|
220
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
221
|
+
|
|
222
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
let urlPath = `/admin-api/definition/create`;
|
|
226
|
+
|
|
227
|
+
const response = await this.request({
|
|
228
|
+
path: urlPath,
|
|
229
|
+
method: 'POST',
|
|
230
|
+
headers: headerParameters,
|
|
231
|
+
query: queryParameters,
|
|
232
|
+
body: StoreDefinitionRequestToJSON(requestParameters['storeDefinitionRequest']),
|
|
233
|
+
}, initOverrides);
|
|
234
|
+
|
|
235
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* Auto-generated: storeDefinition
|
|
240
|
+
*/
|
|
241
|
+
async storeDefinition(requestParameters: StoreDefinitionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
|
|
242
|
+
const response = await this.storeDefinitionRaw(requestParameters, initOverrides);
|
|
243
|
+
return await response.value();
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Auto-generated: updateDefinition
|
|
248
|
+
*/
|
|
249
|
+
async updateDefinitionRaw(requestParameters: UpdateDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DefinitionResource>> {
|
|
250
|
+
if (requestParameters['definition'] == null) {
|
|
251
|
+
throw new runtime.RequiredError(
|
|
252
|
+
'definition',
|
|
253
|
+
'Required parameter "definition" was null or undefined when calling updateDefinition().'
|
|
254
|
+
);
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
const queryParameters: any = {};
|
|
258
|
+
|
|
259
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
260
|
+
|
|
261
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
let urlPath = `/admin-api/definition/{definition}/update`;
|
|
265
|
+
urlPath = urlPath.replace(`{${"definition"}}`, encodeURIComponent(String(requestParameters['definition'])));
|
|
266
|
+
|
|
267
|
+
const response = await this.request({
|
|
268
|
+
path: urlPath,
|
|
269
|
+
method: 'PUT',
|
|
270
|
+
headers: headerParameters,
|
|
271
|
+
query: queryParameters,
|
|
272
|
+
body: UpdateDefinitionRequestToJSON(requestParameters['updateDefinitionRequest']),
|
|
273
|
+
}, initOverrides);
|
|
274
|
+
|
|
275
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => DefinitionResourceFromJSON(jsonValue));
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
* Auto-generated: updateDefinition
|
|
280
|
+
*/
|
|
281
|
+
async updateDefinition(requestParameters: UpdateDefinitionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DefinitionResource> {
|
|
282
|
+
const response = await this.updateDefinitionRaw(requestParameters, initOverrides);
|
|
283
|
+
return await response.value();
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
}
|