@digital8/lighting-illusions-ts-sdk 0.0.1160 → 0.0.1161
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 +2 -2
- package/README.md +11 -13
- package/dist/apis/ProductApi.d.ts +7 -7
- package/dist/apis/ProductApi.js +2 -2
- package/dist/apis/index.d.ts +0 -1
- package/dist/apis/index.js +0 -1
- package/dist/models/IndexProductChildRequest.d.ts +190 -0
- package/dist/models/IndexProductChildRequest.js +129 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/docs/IndexProductChildRequest.md +72 -0
- package/docs/ProductApi.md +11 -11
- package/package.json +1 -1
- package/src/apis/ProductApi.ts +11 -11
- package/src/apis/index.ts +0 -1
- package/src/models/IndexProductChildRequest.ts +266 -0
- package/src/models/index.ts +1 -0
- package/dist/apis/AdminApi.d.ts +0 -63
- package/dist/apis/AdminApi.js +0 -254
- package/docs/AdminApi.md +0 -206
- package/src/apis/AdminApi.ts +0 -165
package/.openapi-generator/FILES
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
.npmignore
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
|
-
docs/AdminApi.md
|
|
6
5
|
docs/AssetApi.md
|
|
7
6
|
docs/AssetFileForUploadResource.md
|
|
8
7
|
docs/AssetFileForUploadResourceArrayResponse.md
|
|
@@ -106,6 +105,7 @@ docs/IndexDocumentRequest.md
|
|
|
106
105
|
docs/IndexExternalApiLogRequest.md
|
|
107
106
|
docs/IndexOverlayTemplateRequest.md
|
|
108
107
|
docs/IndexProductCategoryRequest.md
|
|
108
|
+
docs/IndexProductChildRequest.md
|
|
109
109
|
docs/IndexProductRequest.md
|
|
110
110
|
docs/IndexProductTypeRequest.md
|
|
111
111
|
docs/IndexSiteNotificationRequest.md
|
|
@@ -309,7 +309,6 @@ docs/WishlistCheckResourceArrayResponse.md
|
|
|
309
309
|
docs/WishlistToggleResource.md
|
|
310
310
|
docs/WishlistToggleResourceArrayResponse.md
|
|
311
311
|
package.json
|
|
312
|
-
src/apis/AdminApi.ts
|
|
313
312
|
src/apis/AssetApi.ts
|
|
314
313
|
src/apis/AttributeApi.ts
|
|
315
314
|
src/apis/DefinitionApi.ts
|
|
@@ -422,6 +421,7 @@ src/models/IndexDocumentRequest.ts
|
|
|
422
421
|
src/models/IndexExternalApiLogRequest.ts
|
|
423
422
|
src/models/IndexOverlayTemplateRequest.ts
|
|
424
423
|
src/models/IndexProductCategoryRequest.ts
|
|
424
|
+
src/models/IndexProductChildRequest.ts
|
|
425
425
|
src/models/IndexProductRequest.ts
|
|
426
426
|
src/models/IndexProductTypeRequest.ts
|
|
427
427
|
src/models/IndexSiteNotificationRequest.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @digital8/lighting-illusions-ts-sdk@0.0.
|
|
1
|
+
# @digital8/lighting-illusions-ts-sdk@0.0.1161
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -16,21 +16,21 @@ Next, try it out.
|
|
|
16
16
|
```ts
|
|
17
17
|
import {
|
|
18
18
|
Configuration,
|
|
19
|
-
|
|
19
|
+
AssetApi,
|
|
20
20
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
21
|
-
import type {
|
|
21
|
+
import type { DestroyAssetForAssetableRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
22
22
|
|
|
23
23
|
async function example() {
|
|
24
24
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
25
|
-
const api = new
|
|
25
|
+
const api = new AssetApi();
|
|
26
26
|
|
|
27
27
|
const body = {
|
|
28
|
-
//
|
|
29
|
-
|
|
30
|
-
} satisfies
|
|
28
|
+
// number | The id of the asset
|
|
29
|
+
asset: 56,
|
|
30
|
+
} satisfies DestroyAssetForAssetableRequest;
|
|
31
31
|
|
|
32
32
|
try {
|
|
33
|
-
const data = await api.
|
|
33
|
+
const data = await api.destroyAssetForAssetable(body);
|
|
34
34
|
console.log(data);
|
|
35
35
|
} catch (error) {
|
|
36
36
|
console.error(error);
|
|
@@ -50,9 +50,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
50
50
|
|
|
51
51
|
| Class | Method | HTTP request | Description
|
|
52
52
|
| ----- | ------ | ------------ | -------------
|
|
53
|
-
*AdminApi* | [**generateGoogleFeedAdmin**](docs/AdminApi.md#generategooglefeedadmin) | **POST** /admin-api/admin/feeds/google/generate | Auto-generated: generateGoogleFeedAdmin
|
|
54
|
-
*AdminApi* | [**generateSocialFeedAdmin**](docs/AdminApi.md#generatesocialfeedadmin) | **POST** /admin-api/admin/feeds/social/generate | Auto-generated: generateSocialFeedAdmin
|
|
55
|
-
*AdminApi* | [**generateTGNDataFeedAdmin**](docs/AdminApi.md#generatetgndatafeedadmin) | **POST** /admin-api/admin/feeds/tgn-data/generate | Auto-generated: generateTGNDataFeedAdmin
|
|
56
53
|
*AssetApi* | [**destroyAssetForAssetable**](docs/AssetApi.md#destroyassetforassetable) | **DELETE** /admin-api/asset/{asset}/delete | Auto-generated: destroyAssetForAssetable
|
|
57
54
|
*AssetApi* | [**storeAssetFile**](docs/AssetApi.md#storeassetfileoperation) | **POST** /admin-api/asset/files | Auto-generated: storeAssetFile
|
|
58
55
|
*AssetApi* | [**storeAssetForAssetable**](docs/AssetApi.md#storeassetforassetableoperation) | **POST** /admin-api/asset/create | Auto-generated: storeAssetForAssetable
|
|
@@ -117,7 +114,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
117
114
|
*ProductApi* | [**getAllProductChild**](docs/ProductApi.md#getallproductchildoperation) | **POST** /admin-api/product/children/all | Auto-generated: getAllProductChild
|
|
118
115
|
*ProductApi* | [**getCompatibleProductsProductChild**](docs/ProductApi.md#getcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild
|
|
119
116
|
*ProductApi* | [**indexProduct**](docs/ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct
|
|
120
|
-
*ProductApi* | [**indexProductChild**](docs/ProductApi.md#
|
|
117
|
+
*ProductApi* | [**indexProductChild**](docs/ProductApi.md#indexproductchildoperation) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild
|
|
121
118
|
*ProductApi* | [**showAssetsProductChild**](docs/ProductApi.md#showassetsproductchild) | **GET** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild
|
|
122
119
|
*ProductApi* | [**showProduct**](docs/ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct
|
|
123
120
|
*ProductApi* | [**showProductChild**](docs/ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild
|
|
@@ -272,6 +269,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
272
269
|
- [IndexExternalApiLogRequest](docs/IndexExternalApiLogRequest.md)
|
|
273
270
|
- [IndexOverlayTemplateRequest](docs/IndexOverlayTemplateRequest.md)
|
|
274
271
|
- [IndexProductCategoryRequest](docs/IndexProductCategoryRequest.md)
|
|
272
|
+
- [IndexProductChildRequest](docs/IndexProductChildRequest.md)
|
|
275
273
|
- [IndexProductRequest](docs/IndexProductRequest.md)
|
|
276
274
|
- [IndexProductTypeRequest](docs/IndexProductTypeRequest.md)
|
|
277
275
|
- [IndexSiteNotificationRequest](docs/IndexSiteNotificationRequest.md)
|
|
@@ -480,7 +478,7 @@ and is automatically generated by the
|
|
|
480
478
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
481
479
|
|
|
482
480
|
- API version: `1.0.0`
|
|
483
|
-
- Package version: `0.0.
|
|
481
|
+
- Package version: `0.0.1161`
|
|
484
482
|
- Generator version: `7.20.0`
|
|
485
483
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
486
484
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { AssetResourceArrayResponse, AttachAccessoriesProductChildRequest, AttachDocumentsProductChildRequest, DetachDocumentsProductChildRequest, GenericResponse, GetAllProductChildRequest, GetAllProductRequest,
|
|
13
|
+
import type { AssetResourceArrayResponse, AttachAccessoriesProductChildRequest, AttachDocumentsProductChildRequest, DetachDocumentsProductChildRequest, GenericResponse, GetAllProductChildRequest, GetAllProductRequest, IndexProductChildRequest, IndexProductRequest, PaginatedProductChildListResourceResponse, PaginatedProductListResourceResponse, ProductChildListResourceArrayResponse, ProductChildLiteResourceArrayResponse, ProductChildResource, ProductLiteResourceArrayResponse, ProductResource, StoreProductChildRequest, StoreProductRequest, UpdateProductChildRequest, UpdateProductRequest } from '../models/index';
|
|
14
14
|
export interface AttachAccessoriesProductChildOperationRequest {
|
|
15
15
|
productChild: number;
|
|
16
16
|
attachAccessoriesProductChildRequest?: AttachAccessoriesProductChildRequest;
|
|
@@ -53,13 +53,13 @@ export interface GetAllProductChildOperationRequest {
|
|
|
53
53
|
}
|
|
54
54
|
export interface GetCompatibleProductsProductChildRequest {
|
|
55
55
|
productChild: number;
|
|
56
|
-
|
|
56
|
+
indexProductChildRequest?: IndexProductChildRequest;
|
|
57
57
|
}
|
|
58
58
|
export interface IndexProductOperationRequest {
|
|
59
59
|
indexProductRequest?: IndexProductRequest;
|
|
60
60
|
}
|
|
61
|
-
export interface
|
|
62
|
-
|
|
61
|
+
export interface IndexProductChildOperationRequest {
|
|
62
|
+
indexProductChildRequest?: IndexProductChildRequest;
|
|
63
63
|
}
|
|
64
64
|
export interface ShowAssetsProductChildRequest {
|
|
65
65
|
productChild: number;
|
|
@@ -247,15 +247,15 @@ export declare class ProductApi extends runtime.BaseAPI {
|
|
|
247
247
|
/**
|
|
248
248
|
* Creates request options for indexProductChild without sending the request
|
|
249
249
|
*/
|
|
250
|
-
indexProductChildRequestOpts(requestParameters:
|
|
250
|
+
indexProductChildRequestOpts(requestParameters: IndexProductChildOperationRequest): Promise<runtime.RequestOpts>;
|
|
251
251
|
/**
|
|
252
252
|
* Auto-generated: indexProductChild
|
|
253
253
|
*/
|
|
254
|
-
indexProductChildRaw(requestParameters:
|
|
254
|
+
indexProductChildRaw(requestParameters: IndexProductChildOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedProductChildListResourceResponse>>;
|
|
255
255
|
/**
|
|
256
256
|
* Auto-generated: indexProductChild
|
|
257
257
|
*/
|
|
258
|
-
indexProductChild(requestParameters?:
|
|
258
|
+
indexProductChild(requestParameters?: IndexProductChildOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedProductChildListResourceResponse>;
|
|
259
259
|
/**
|
|
260
260
|
* Creates request options for showAssetsProductChild without sending the request
|
|
261
261
|
*/
|
package/dist/apis/ProductApi.js
CHANGED
|
@@ -760,7 +760,7 @@ var ProductApi = /** @class */ (function (_super) {
|
|
|
760
760
|
method: 'POST',
|
|
761
761
|
headers: headerParameters,
|
|
762
762
|
query: queryParameters,
|
|
763
|
-
body: (0, index_1.
|
|
763
|
+
body: (0, index_1.IndexProductChildRequestToJSON)(requestParameters['indexProductChildRequest']),
|
|
764
764
|
}];
|
|
765
765
|
});
|
|
766
766
|
});
|
|
@@ -875,7 +875,7 @@ var ProductApi = /** @class */ (function (_super) {
|
|
|
875
875
|
method: 'POST',
|
|
876
876
|
headers: headerParameters,
|
|
877
877
|
query: queryParameters,
|
|
878
|
-
body: (0, index_1.
|
|
878
|
+
body: (0, index_1.IndexProductChildRequestToJSON)(requestParameters['indexProductChildRequest']),
|
|
879
879
|
}];
|
|
880
880
|
});
|
|
881
881
|
});
|
package/dist/apis/index.d.ts
CHANGED
package/dist/apis/index.js
CHANGED
|
@@ -16,7 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
/* tslint:disable */
|
|
18
18
|
/* eslint-disable */
|
|
19
|
-
__exportStar(require("./AdminApi"), exports);
|
|
20
19
|
__exportStar(require("./AssetApi"), exports);
|
|
21
20
|
__exportStar(require("./AttributeApi"), exports);
|
|
22
21
|
__exportStar(require("./DefinitionApi"), exports);
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* My API
|
|
3
|
+
* API documentation for my Laravel app
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface IndexProductChildRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface IndexProductChildRequest {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof IndexProductChildRequest
|
|
22
|
+
*/
|
|
23
|
+
search?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {IndexProductChildRequestSortByEnum}
|
|
27
|
+
* @memberof IndexProductChildRequest
|
|
28
|
+
*/
|
|
29
|
+
sortBy?: IndexProductChildRequestSortByEnum;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {IndexProductChildRequestSortDirectionEnum}
|
|
33
|
+
* @memberof IndexProductChildRequest
|
|
34
|
+
*/
|
|
35
|
+
sortDirection?: IndexProductChildRequestSortDirectionEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof IndexProductChildRequest
|
|
40
|
+
*/
|
|
41
|
+
perPage?: number;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof IndexProductChildRequest
|
|
46
|
+
*/
|
|
47
|
+
page?: number;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {Array<string>}
|
|
51
|
+
* @memberof IndexProductChildRequest
|
|
52
|
+
*/
|
|
53
|
+
siteDetailsSiteId?: Array<string>;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {Array<string>}
|
|
57
|
+
* @memberof IndexProductChildRequest
|
|
58
|
+
*/
|
|
59
|
+
isDisabled?: Array<string>;
|
|
60
|
+
/**
|
|
61
|
+
*
|
|
62
|
+
* @type {Array<string>}
|
|
63
|
+
* @memberof IndexProductChildRequest
|
|
64
|
+
*/
|
|
65
|
+
netsuiteSyncHasNetsuiteId?: Array<string>;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {Array<string>}
|
|
69
|
+
* @memberof IndexProductChildRequest
|
|
70
|
+
*/
|
|
71
|
+
categoryId?: Array<string>;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {Array<string>}
|
|
75
|
+
* @memberof IndexProductChildRequest
|
|
76
|
+
*/
|
|
77
|
+
supplierId?: Array<string>;
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @type {Array<string>}
|
|
81
|
+
* @memberof IndexProductChildRequest
|
|
82
|
+
*/
|
|
83
|
+
tagsId?: Array<string>;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {Array<string>}
|
|
87
|
+
* @memberof IndexProductChildRequest
|
|
88
|
+
*/
|
|
89
|
+
productTypeId?: Array<string>;
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @type {Array<string>}
|
|
93
|
+
* @memberof IndexProductChildRequest
|
|
94
|
+
*/
|
|
95
|
+
parentIsAccessory?: Array<string>;
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {Array<string>}
|
|
99
|
+
* @memberof IndexProductChildRequest
|
|
100
|
+
*/
|
|
101
|
+
availableSitesId?: Array<string>;
|
|
102
|
+
/**
|
|
103
|
+
*
|
|
104
|
+
* @type {Array<string>}
|
|
105
|
+
* @memberof IndexProductChildRequest
|
|
106
|
+
*/
|
|
107
|
+
enabledSitesId?: Array<string>;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @type {Array<string>}
|
|
111
|
+
* @memberof IndexProductChildRequest
|
|
112
|
+
*/
|
|
113
|
+
siteDetailsSeoHasSeoTitle?: Array<string>;
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {Array<string>}
|
|
117
|
+
* @memberof IndexProductChildRequest
|
|
118
|
+
*/
|
|
119
|
+
siteDetailsSeoHasSeoDescription?: Array<string>;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @type {number}
|
|
123
|
+
* @memberof IndexProductChildRequest
|
|
124
|
+
*/
|
|
125
|
+
relatedId?: number;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {IndexProductChildRequestRelatedTypeEnum}
|
|
129
|
+
* @memberof IndexProductChildRequest
|
|
130
|
+
*/
|
|
131
|
+
relatedType?: IndexProductChildRequestRelatedTypeEnum;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @type {boolean}
|
|
135
|
+
* @memberof IndexProductChildRequest
|
|
136
|
+
*/
|
|
137
|
+
includesRelations?: boolean;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* @export
|
|
141
|
+
*/
|
|
142
|
+
export declare const IndexProductChildRequestSortByEnum: {
|
|
143
|
+
readonly Id: "id";
|
|
144
|
+
readonly Name: "name";
|
|
145
|
+
readonly ParentName: "parent-name";
|
|
146
|
+
readonly SiteDetailsName: "siteDetails-name";
|
|
147
|
+
readonly SiteDetailsSlug: "siteDetails-slug";
|
|
148
|
+
readonly Sku: "sku";
|
|
149
|
+
readonly Model: "model";
|
|
150
|
+
readonly NetsuiteSyncNetsuiteId: "netsuiteSync-netsuite_id";
|
|
151
|
+
readonly NewArrivalStartDate: "new_arrival_start_date";
|
|
152
|
+
readonly NewArrivalEndDate: "new_arrival_end_date";
|
|
153
|
+
readonly CreatedAt: "created_at";
|
|
154
|
+
readonly UpdatedAt: "updated_at";
|
|
155
|
+
};
|
|
156
|
+
export type IndexProductChildRequestSortByEnum = typeof IndexProductChildRequestSortByEnum[keyof typeof IndexProductChildRequestSortByEnum];
|
|
157
|
+
/**
|
|
158
|
+
* @export
|
|
159
|
+
*/
|
|
160
|
+
export declare const IndexProductChildRequestSortDirectionEnum: {
|
|
161
|
+
readonly Asc: "asc";
|
|
162
|
+
readonly Desc: "desc";
|
|
163
|
+
};
|
|
164
|
+
export type IndexProductChildRequestSortDirectionEnum = typeof IndexProductChildRequestSortDirectionEnum[keyof typeof IndexProductChildRequestSortDirectionEnum];
|
|
165
|
+
/**
|
|
166
|
+
* @export
|
|
167
|
+
*/
|
|
168
|
+
export declare const IndexProductChildRequestRelatedTypeEnum: {
|
|
169
|
+
readonly Accessory: "accessory";
|
|
170
|
+
readonly Attribute: "attribute";
|
|
171
|
+
readonly AttributeValue: "attributeValue";
|
|
172
|
+
readonly CompatibleProduct: "compatibleProduct";
|
|
173
|
+
readonly Category: "category";
|
|
174
|
+
readonly AutomatedCategory: "automatedCategory";
|
|
175
|
+
readonly Document: "document";
|
|
176
|
+
readonly OverlayTemplate: "overlayTemplate";
|
|
177
|
+
readonly ProductType: "productType";
|
|
178
|
+
readonly Supplier: "supplier";
|
|
179
|
+
readonly Tag: "tag";
|
|
180
|
+
readonly Site: "site";
|
|
181
|
+
};
|
|
182
|
+
export type IndexProductChildRequestRelatedTypeEnum = typeof IndexProductChildRequestRelatedTypeEnum[keyof typeof IndexProductChildRequestRelatedTypeEnum];
|
|
183
|
+
/**
|
|
184
|
+
* Check if a given object implements the IndexProductChildRequest interface.
|
|
185
|
+
*/
|
|
186
|
+
export declare function instanceOfIndexProductChildRequest(value: object): value is IndexProductChildRequest;
|
|
187
|
+
export declare function IndexProductChildRequestFromJSON(json: any): IndexProductChildRequest;
|
|
188
|
+
export declare function IndexProductChildRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexProductChildRequest;
|
|
189
|
+
export declare function IndexProductChildRequestToJSON(json: any): IndexProductChildRequest;
|
|
190
|
+
export declare function IndexProductChildRequestToJSONTyped(value?: IndexProductChildRequest | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,129 @@
|
|
|
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.IndexProductChildRequestRelatedTypeEnum = exports.IndexProductChildRequestSortDirectionEnum = exports.IndexProductChildRequestSortByEnum = void 0;
|
|
17
|
+
exports.instanceOfIndexProductChildRequest = instanceOfIndexProductChildRequest;
|
|
18
|
+
exports.IndexProductChildRequestFromJSON = IndexProductChildRequestFromJSON;
|
|
19
|
+
exports.IndexProductChildRequestFromJSONTyped = IndexProductChildRequestFromJSONTyped;
|
|
20
|
+
exports.IndexProductChildRequestToJSON = IndexProductChildRequestToJSON;
|
|
21
|
+
exports.IndexProductChildRequestToJSONTyped = IndexProductChildRequestToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.IndexProductChildRequestSortByEnum = {
|
|
26
|
+
Id: 'id',
|
|
27
|
+
Name: 'name',
|
|
28
|
+
ParentName: 'parent-name',
|
|
29
|
+
SiteDetailsName: 'siteDetails-name',
|
|
30
|
+
SiteDetailsSlug: 'siteDetails-slug',
|
|
31
|
+
Sku: 'sku',
|
|
32
|
+
Model: 'model',
|
|
33
|
+
NetsuiteSyncNetsuiteId: 'netsuiteSync-netsuite_id',
|
|
34
|
+
NewArrivalStartDate: 'new_arrival_start_date',
|
|
35
|
+
NewArrivalEndDate: 'new_arrival_end_date',
|
|
36
|
+
CreatedAt: 'created_at',
|
|
37
|
+
UpdatedAt: 'updated_at'
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* @export
|
|
41
|
+
*/
|
|
42
|
+
exports.IndexProductChildRequestSortDirectionEnum = {
|
|
43
|
+
Asc: 'asc',
|
|
44
|
+
Desc: 'desc'
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* @export
|
|
48
|
+
*/
|
|
49
|
+
exports.IndexProductChildRequestRelatedTypeEnum = {
|
|
50
|
+
Accessory: 'accessory',
|
|
51
|
+
Attribute: 'attribute',
|
|
52
|
+
AttributeValue: 'attributeValue',
|
|
53
|
+
CompatibleProduct: 'compatibleProduct',
|
|
54
|
+
Category: 'category',
|
|
55
|
+
AutomatedCategory: 'automatedCategory',
|
|
56
|
+
Document: 'document',
|
|
57
|
+
OverlayTemplate: 'overlayTemplate',
|
|
58
|
+
ProductType: 'productType',
|
|
59
|
+
Supplier: 'supplier',
|
|
60
|
+
Tag: 'tag',
|
|
61
|
+
Site: 'site'
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the IndexProductChildRequest interface.
|
|
65
|
+
*/
|
|
66
|
+
function instanceOfIndexProductChildRequest(value) {
|
|
67
|
+
return true;
|
|
68
|
+
}
|
|
69
|
+
function IndexProductChildRequestFromJSON(json) {
|
|
70
|
+
return IndexProductChildRequestFromJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
function IndexProductChildRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
73
|
+
if (json == null) {
|
|
74
|
+
return json;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
'search': json['search'] == null ? undefined : json['search'],
|
|
78
|
+
'sortBy': json['sortBy'] == null ? undefined : json['sortBy'],
|
|
79
|
+
'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
|
|
80
|
+
'perPage': json['per_page'] == null ? undefined : json['per_page'],
|
|
81
|
+
'page': json['page'] == null ? undefined : json['page'],
|
|
82
|
+
'siteDetailsSiteId': json['siteDetails-site_id'] == null ? undefined : json['siteDetails-site_id'],
|
|
83
|
+
'isDisabled': json['is_disabled'] == null ? undefined : json['is_disabled'],
|
|
84
|
+
'netsuiteSyncHasNetsuiteId': json['netsuiteSync-has_netsuite_id'] == null ? undefined : json['netsuiteSync-has_netsuite_id'],
|
|
85
|
+
'categoryId': json['category-id'] == null ? undefined : json['category-id'],
|
|
86
|
+
'supplierId': json['supplier-id'] == null ? undefined : json['supplier-id'],
|
|
87
|
+
'tagsId': json['tags-id'] == null ? undefined : json['tags-id'],
|
|
88
|
+
'productTypeId': json['productType-id'] == null ? undefined : json['productType-id'],
|
|
89
|
+
'parentIsAccessory': json['parent-is_accessory'] == null ? undefined : json['parent-is_accessory'],
|
|
90
|
+
'availableSitesId': json['availableSites-id'] == null ? undefined : json['availableSites-id'],
|
|
91
|
+
'enabledSitesId': json['enabledSites-id'] == null ? undefined : json['enabledSites-id'],
|
|
92
|
+
'siteDetailsSeoHasSeoTitle': json['siteDetailsSeo-has_seo_title'] == null ? undefined : json['siteDetailsSeo-has_seo_title'],
|
|
93
|
+
'siteDetailsSeoHasSeoDescription': json['siteDetailsSeo-has_seo_description'] == null ? undefined : json['siteDetailsSeo-has_seo_description'],
|
|
94
|
+
'relatedId': json['related_id'] == null ? undefined : json['related_id'],
|
|
95
|
+
'relatedType': json['related_type'] == null ? undefined : json['related_type'],
|
|
96
|
+
'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
function IndexProductChildRequestToJSON(json) {
|
|
100
|
+
return IndexProductChildRequestToJSONTyped(json, false);
|
|
101
|
+
}
|
|
102
|
+
function IndexProductChildRequestToJSONTyped(value, ignoreDiscriminator) {
|
|
103
|
+
if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
|
|
104
|
+
if (value == null) {
|
|
105
|
+
return value;
|
|
106
|
+
}
|
|
107
|
+
return {
|
|
108
|
+
'search': value['search'],
|
|
109
|
+
'sortBy': value['sortBy'],
|
|
110
|
+
'sortDirection': value['sortDirection'],
|
|
111
|
+
'per_page': value['perPage'],
|
|
112
|
+
'page': value['page'],
|
|
113
|
+
'siteDetails-site_id': value['siteDetailsSiteId'],
|
|
114
|
+
'is_disabled': value['isDisabled'],
|
|
115
|
+
'netsuiteSync-has_netsuite_id': value['netsuiteSyncHasNetsuiteId'],
|
|
116
|
+
'category-id': value['categoryId'],
|
|
117
|
+
'supplier-id': value['supplierId'],
|
|
118
|
+
'tags-id': value['tagsId'],
|
|
119
|
+
'productType-id': value['productTypeId'],
|
|
120
|
+
'parent-is_accessory': value['parentIsAccessory'],
|
|
121
|
+
'availableSites-id': value['availableSitesId'],
|
|
122
|
+
'enabledSites-id': value['enabledSitesId'],
|
|
123
|
+
'siteDetailsSeo-has_seo_title': value['siteDetailsSeoHasSeoTitle'],
|
|
124
|
+
'siteDetailsSeo-has_seo_description': value['siteDetailsSeoHasSeoDescription'],
|
|
125
|
+
'related_id': value['relatedId'],
|
|
126
|
+
'related_type': value['relatedType'],
|
|
127
|
+
'includes_relations': value['includesRelations'],
|
|
128
|
+
};
|
|
129
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -95,6 +95,7 @@ export * from './IndexDocumentRequest';
|
|
|
95
95
|
export * from './IndexExternalApiLogRequest';
|
|
96
96
|
export * from './IndexOverlayTemplateRequest';
|
|
97
97
|
export * from './IndexProductCategoryRequest';
|
|
98
|
+
export * from './IndexProductChildRequest';
|
|
98
99
|
export * from './IndexProductRequest';
|
|
99
100
|
export * from './IndexProductTypeRequest';
|
|
100
101
|
export * from './IndexSiteNotificationRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -113,6 +113,7 @@ __exportStar(require("./IndexDocumentRequest"), exports);
|
|
|
113
113
|
__exportStar(require("./IndexExternalApiLogRequest"), exports);
|
|
114
114
|
__exportStar(require("./IndexOverlayTemplateRequest"), exports);
|
|
115
115
|
__exportStar(require("./IndexProductCategoryRequest"), exports);
|
|
116
|
+
__exportStar(require("./IndexProductChildRequest"), exports);
|
|
116
117
|
__exportStar(require("./IndexProductRequest"), exports);
|
|
117
118
|
__exportStar(require("./IndexProductTypeRequest"), exports);
|
|
118
119
|
__exportStar(require("./IndexSiteNotificationRequest"), exports);
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
|
|
2
|
+
# IndexProductChildRequest
|
|
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
|
+
`siteDetailsSiteId` | Array<string>
|
|
15
|
+
`isDisabled` | Array<string>
|
|
16
|
+
`netsuiteSyncHasNetsuiteId` | Array<string>
|
|
17
|
+
`categoryId` | Array<string>
|
|
18
|
+
`supplierId` | Array<string>
|
|
19
|
+
`tagsId` | Array<string>
|
|
20
|
+
`productTypeId` | Array<string>
|
|
21
|
+
`parentIsAccessory` | Array<string>
|
|
22
|
+
`availableSitesId` | Array<string>
|
|
23
|
+
`enabledSitesId` | Array<string>
|
|
24
|
+
`siteDetailsSeoHasSeoTitle` | Array<string>
|
|
25
|
+
`siteDetailsSeoHasSeoDescription` | Array<string>
|
|
26
|
+
`relatedId` | number
|
|
27
|
+
`relatedType` | string
|
|
28
|
+
`includesRelations` | boolean
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import type { IndexProductChildRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
34
|
+
|
|
35
|
+
// TODO: Update the object below with actual values
|
|
36
|
+
const example = {
|
|
37
|
+
"search": null,
|
|
38
|
+
"sortBy": null,
|
|
39
|
+
"sortDirection": null,
|
|
40
|
+
"perPage": null,
|
|
41
|
+
"page": null,
|
|
42
|
+
"siteDetailsSiteId": null,
|
|
43
|
+
"isDisabled": null,
|
|
44
|
+
"netsuiteSyncHasNetsuiteId": null,
|
|
45
|
+
"categoryId": null,
|
|
46
|
+
"supplierId": null,
|
|
47
|
+
"tagsId": null,
|
|
48
|
+
"productTypeId": null,
|
|
49
|
+
"parentIsAccessory": null,
|
|
50
|
+
"availableSitesId": null,
|
|
51
|
+
"enabledSitesId": null,
|
|
52
|
+
"siteDetailsSeoHasSeoTitle": null,
|
|
53
|
+
"siteDetailsSeoHasSeoDescription": null,
|
|
54
|
+
"relatedId": null,
|
|
55
|
+
"relatedType": null,
|
|
56
|
+
"includesRelations": null,
|
|
57
|
+
} satisfies IndexProductChildRequest
|
|
58
|
+
|
|
59
|
+
console.log(example)
|
|
60
|
+
|
|
61
|
+
// Convert the instance to a JSON string
|
|
62
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
63
|
+
console.log(exampleJSON)
|
|
64
|
+
|
|
65
|
+
// Parse the JSON string back to an object
|
|
66
|
+
const exampleParsed = JSON.parse(exampleJSON) as IndexProductChildRequest
|
|
67
|
+
console.log(exampleParsed)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
71
|
+
|
|
72
|
+
|
package/docs/ProductApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
17
17
|
| [**getAllProductChild**](ProductApi.md#getallproductchildoperation) | **POST** /admin-api/product/children/all | Auto-generated: getAllProductChild |
|
|
18
18
|
| [**getCompatibleProductsProductChild**](ProductApi.md#getcompatibleproductsproductchild) | **POST** /admin-api/product/children/{productChild}/compatible-product/list | Auto-generated: getCompatibleProductsProductChild |
|
|
19
19
|
| [**indexProduct**](ProductApi.md#indexproductoperation) | **POST** /admin-api/product/parent/list | Auto-generated: indexProduct |
|
|
20
|
-
| [**indexProductChild**](ProductApi.md#
|
|
20
|
+
| [**indexProductChild**](ProductApi.md#indexproductchildoperation) | **POST** /admin-api/product/children/list | Auto-generated: indexProductChild |
|
|
21
21
|
| [**showAssetsProductChild**](ProductApi.md#showassetsproductchild) | **GET** /admin-api/product/children/{productChild}/assets | Auto-generated: showAssetsProductChild |
|
|
22
22
|
| [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
|
|
23
23
|
| [**showProductChild**](ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild |
|
|
@@ -766,7 +766,7 @@ No authorization required
|
|
|
766
766
|
|
|
767
767
|
## getCompatibleProductsProductChild
|
|
768
768
|
|
|
769
|
-
> PaginatedProductChildListResourceResponse getCompatibleProductsProductChild(productChild,
|
|
769
|
+
> PaginatedProductChildListResourceResponse getCompatibleProductsProductChild(productChild, indexProductChildRequest)
|
|
770
770
|
|
|
771
771
|
Auto-generated: getCompatibleProductsProductChild
|
|
772
772
|
|
|
@@ -786,8 +786,8 @@ async function example() {
|
|
|
786
786
|
const body = {
|
|
787
787
|
// number | The id of the productChild
|
|
788
788
|
productChild: 56,
|
|
789
|
-
//
|
|
790
|
-
|
|
789
|
+
// IndexProductChildRequest (optional)
|
|
790
|
+
indexProductChildRequest: ...,
|
|
791
791
|
} satisfies GetCompatibleProductsProductChildRequest;
|
|
792
792
|
|
|
793
793
|
try {
|
|
@@ -808,7 +808,7 @@ example().catch(console.error);
|
|
|
808
808
|
| Name | Type | Description | Notes |
|
|
809
809
|
|------------- | ------------- | ------------- | -------------|
|
|
810
810
|
| **productChild** | `number` | The id of the productChild | [Defaults to `undefined`] |
|
|
811
|
-
| **
|
|
811
|
+
| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) | | [Optional] |
|
|
812
812
|
|
|
813
813
|
### Return type
|
|
814
814
|
|
|
@@ -899,7 +899,7 @@ No authorization required
|
|
|
899
899
|
|
|
900
900
|
## indexProductChild
|
|
901
901
|
|
|
902
|
-
> PaginatedProductChildListResourceResponse indexProductChild(
|
|
902
|
+
> PaginatedProductChildListResourceResponse indexProductChild(indexProductChildRequest)
|
|
903
903
|
|
|
904
904
|
Auto-generated: indexProductChild
|
|
905
905
|
|
|
@@ -910,16 +910,16 @@ import {
|
|
|
910
910
|
Configuration,
|
|
911
911
|
ProductApi,
|
|
912
912
|
} from '@digital8/lighting-illusions-ts-sdk';
|
|
913
|
-
import type {
|
|
913
|
+
import type { IndexProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
914
914
|
|
|
915
915
|
async function example() {
|
|
916
916
|
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
917
917
|
const api = new ProductApi();
|
|
918
918
|
|
|
919
919
|
const body = {
|
|
920
|
-
//
|
|
921
|
-
|
|
922
|
-
} satisfies
|
|
920
|
+
// IndexProductChildRequest (optional)
|
|
921
|
+
indexProductChildRequest: ...,
|
|
922
|
+
} satisfies IndexProductChildOperationRequest;
|
|
923
923
|
|
|
924
924
|
try {
|
|
925
925
|
const data = await api.indexProductChild(body);
|
|
@@ -938,7 +938,7 @@ example().catch(console.error);
|
|
|
938
938
|
|
|
939
939
|
| Name | Type | Description | Notes |
|
|
940
940
|
|------------- | ------------- | ------------- | -------------|
|
|
941
|
-
| **
|
|
941
|
+
| **indexProductChildRequest** | [IndexProductChildRequest](IndexProductChildRequest.md) | | [Optional] |
|
|
942
942
|
|
|
943
943
|
### Return type
|
|
944
944
|
|