@digital8/lighting-illusions-ts-sdk 0.0.1886 → 0.0.1888

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 (65) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +20 -2
  3. package/dist/apis/DocumentApi.d.ts +156 -0
  4. package/dist/apis/DocumentApi.js +613 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/models/AddressFrontendResource.d.ts +1 -1
  8. package/dist/models/AddressFrontendResource.js +1 -3
  9. package/dist/models/AddressResource.d.ts +1 -1
  10. package/dist/models/AddressResource.js +3 -1
  11. package/dist/models/AttachDocumentablesToDocumentRequest.d.ts +33 -0
  12. package/dist/models/AttachDocumentablesToDocumentRequest.js +52 -0
  13. package/dist/models/AttachDocumentablesToDocumentRequestDocumentablesInner.d.ts +53 -0
  14. package/dist/models/AttachDocumentablesToDocumentRequestDocumentablesInner.js +66 -0
  15. package/dist/models/CreateDocumentFileRequest.d.ts +38 -0
  16. package/dist/models/CreateDocumentFileRequest.js +55 -0
  17. package/dist/models/CreateDocumentRequest.d.ts +44 -0
  18. package/dist/models/CreateDocumentRequest.js +57 -0
  19. package/dist/models/DetachDocumentablesFromDocumentRequest.d.ts +33 -0
  20. package/dist/models/DetachDocumentablesFromDocumentRequest.js +52 -0
  21. package/dist/models/DetachDocumentablesFromDocumentRequestDocumentablesInner.d.ts +47 -0
  22. package/dist/models/DetachDocumentablesFromDocumentRequestDocumentablesInner.js +64 -0
  23. package/dist/models/SearchAllDocumentsRequest.d.ts +95 -0
  24. package/dist/models/SearchAllDocumentsRequest.js +86 -0
  25. package/dist/models/SearchDocumentsRequest.d.ts +107 -0
  26. package/dist/models/SearchDocumentsRequest.js +90 -0
  27. package/dist/models/StoreFrontendResource.d.ts +1 -1
  28. package/dist/models/StoreFrontendResource.js +3 -1
  29. package/dist/models/StoreResource.d.ts +2 -2
  30. package/dist/models/StoreResource.js +6 -2
  31. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  32. package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
  33. package/dist/models/UpdateDocumentRequest.d.ts +44 -0
  34. package/dist/models/UpdateDocumentRequest.js +57 -0
  35. package/dist/models/index.d.ts +9 -0
  36. package/dist/models/index.js +9 -0
  37. package/docs/AttachDocumentablesToDocumentRequest.md +34 -0
  38. package/docs/AttachDocumentablesToDocumentRequestDocumentablesInner.md +38 -0
  39. package/docs/CreateDocumentFileRequest.md +36 -0
  40. package/docs/CreateDocumentRequest.md +38 -0
  41. package/docs/DetachDocumentablesFromDocumentRequest.md +34 -0
  42. package/docs/DetachDocumentablesFromDocumentRequestDocumentablesInner.md +36 -0
  43. package/docs/DocumentApi.md +611 -0
  44. package/docs/SearchAllDocumentsRequest.md +46 -0
  45. package/docs/SearchDocumentsRequest.md +50 -0
  46. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  47. package/docs/UpdateDocumentRequest.md +38 -0
  48. package/package.json +1 -1
  49. package/src/apis/DocumentApi.ts +496 -0
  50. package/src/apis/index.ts +1 -0
  51. package/src/models/AddressFrontendResource.ts +2 -3
  52. package/src/models/AddressResource.ts +3 -2
  53. package/src/models/AttachDocumentablesToDocumentRequest.ts +74 -0
  54. package/src/models/AttachDocumentablesToDocumentRequestDocumentablesInner.ts +95 -0
  55. package/src/models/CreateDocumentFileRequest.ts +75 -0
  56. package/src/models/CreateDocumentRequest.ts +83 -0
  57. package/src/models/DetachDocumentablesFromDocumentRequest.ts +74 -0
  58. package/src/models/DetachDocumentablesFromDocumentRequestDocumentablesInner.ts +87 -0
  59. package/src/models/SearchAllDocumentsRequest.ts +145 -0
  60. package/src/models/SearchDocumentsRequest.ts +161 -0
  61. package/src/models/StoreFrontendResource.ts +3 -2
  62. package/src/models/StoreResource.ts +6 -4
  63. package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
  64. package/src/models/UpdateDocumentRequest.ts +83 -0
  65. package/src/models/index.ts +9 -0
@@ -32,6 +32,8 @@ __exportStar(require("./AssetWithOverlayLinkResource"), exports);
32
32
  __exportStar(require("./AssetWithOverlayLinkResourceArrayResponse"), exports);
33
33
  __exportStar(require("./AttachAttributesToProductRangeRequest"), exports);
34
34
  __exportStar(require("./AttachAttributesToProductRangeRequestAttributesInner"), exports);
35
+ __exportStar(require("./AttachDocumentablesToDocumentRequest"), exports);
36
+ __exportStar(require("./AttachDocumentablesToDocumentRequestDocumentablesInner"), exports);
35
37
  __exportStar(require("./AttachDocumentsToProductChildRequest"), exports);
36
38
  __exportStar(require("./AttachDocumentsToProductChildRequestDocumentsInner"), exports);
37
39
  __exportStar(require("./AttachDocumentsToProductRangeRequest"), exports);
@@ -82,6 +84,8 @@ __exportStar(require("./CreateBlogCategoryRequest"), exports);
82
84
  __exportStar(require("./CreateBlogCategoryRequestDescriptionsInner"), exports);
83
85
  __exportStar(require("./CreateBlogCategoryRequestSeoInner"), exports);
84
86
  __exportStar(require("./CreateDefinitionRequest"), exports);
87
+ __exportStar(require("./CreateDocumentFileRequest"), exports);
88
+ __exportStar(require("./CreateDocumentRequest"), exports);
85
89
  __exportStar(require("./CreateLabelRequest"), exports);
86
90
  __exportStar(require("./CreateMenuItemRequest"), exports);
87
91
  __exportStar(require("./CreateMenuItemRequestMenuItemLink"), exports);
@@ -117,6 +121,8 @@ __exportStar(require("./DeleteAttributeValueRequest"), exports);
117
121
  __exportStar(require("./DescriptionResource"), exports);
118
122
  __exportStar(require("./DescriptionResourceArrayResponse"), exports);
119
123
  __exportStar(require("./DetachAttributesFromProductRangeRequest"), exports);
124
+ __exportStar(require("./DetachDocumentablesFromDocumentRequest"), exports);
125
+ __exportStar(require("./DetachDocumentablesFromDocumentRequestDocumentablesInner"), exports);
120
126
  __exportStar(require("./DetachDocumentsFromProductChildRequest"), exports);
121
127
  __exportStar(require("./DetachDocumentsFromProductRangeRequest"), exports);
122
128
  __exportStar(require("./DetachProductChildrenFromProductRangeRequest"), exports);
@@ -380,6 +386,7 @@ __exportStar(require("./SearchAllAttributeValuesRequest"), exports);
380
386
  __exportStar(require("./SearchAllAttributesRequest"), exports);
381
387
  __exportStar(require("./SearchAllBlogCategoriesRequest"), exports);
382
388
  __exportStar(require("./SearchAllDefinitionsRequest"), exports);
389
+ __exportStar(require("./SearchAllDocumentsRequest"), exports);
383
390
  __exportStar(require("./SearchAllFrontendComponentsRequest"), exports);
384
391
  __exportStar(require("./SearchAllMenuItemsRequest"), exports);
385
392
  __exportStar(require("./SearchAllMenusRequest"), exports);
@@ -398,6 +405,7 @@ __exportStar(require("./SearchAttributeValuesRequest"), exports);
398
405
  __exportStar(require("./SearchAttributesRequest"), exports);
399
406
  __exportStar(require("./SearchBlogCategoriesRequest"), exports);
400
407
  __exportStar(require("./SearchDefinitionsRequest"), exports);
408
+ __exportStar(require("./SearchDocumentsRequest"), exports);
401
409
  __exportStar(require("./SearchExternalApiLogsRequest"), exports);
402
410
  __exportStar(require("./SearchGoogleCategoriesRequest"), exports);
403
411
  __exportStar(require("./SearchLabelsRequest"), exports);
@@ -477,6 +485,7 @@ __exportStar(require("./UpdateAttributeRequest"), exports);
477
485
  __exportStar(require("./UpdateAttributeValueRequest"), exports);
478
486
  __exportStar(require("./UpdateBlogCategoryRequest"), exports);
479
487
  __exportStar(require("./UpdateDefinitionRequest"), exports);
488
+ __exportStar(require("./UpdateDocumentRequest"), exports);
480
489
  __exportStar(require("./UpdateLabelRequest"), exports);
481
490
  __exportStar(require("./UpdateMenuItemRequest"), exports);
482
491
  __exportStar(require("./UpdateMenuRequest"), exports);
@@ -0,0 +1,34 @@
1
+
2
+ # AttachDocumentablesToDocumentRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `documentables` | [Array<AttachDocumentablesToDocumentRequestDocumentablesInner>](AttachDocumentablesToDocumentRequestDocumentablesInner.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AttachDocumentablesToDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "documentables": null,
19
+ } satisfies AttachDocumentablesToDocumentRequest
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 AttachDocumentablesToDocumentRequest
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,38 @@
1
+
2
+ # AttachDocumentablesToDocumentRequestDocumentablesInner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `documentableType` | string
10
+ `documentableId` | number
11
+ `index` | number
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { AttachDocumentablesToDocumentRequestDocumentablesInner } from '@digital8/lighting-illusions-ts-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "documentableType": null,
21
+ "documentableId": null,
22
+ "index": null,
23
+ } satisfies AttachDocumentablesToDocumentRequestDocumentablesInner
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as AttachDocumentablesToDocumentRequestDocumentablesInner
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,36 @@
1
+
2
+ # CreateDocumentFileRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `fileName` | string
10
+ `fileType` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { CreateDocumentFileRequest } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "fileName": null,
20
+ "fileType": null,
21
+ } satisfies CreateDocumentFileRequest
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 CreateDocumentFileRequest
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,38 @@
1
+
2
+ # CreateDocumentRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `fileId` | string
11
+ `siteIds` | Array<string>
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { CreateDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "name": null,
21
+ "fileId": null,
22
+ "siteIds": null,
23
+ } satisfies CreateDocumentRequest
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as CreateDocumentRequest
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,34 @@
1
+
2
+ # DetachDocumentablesFromDocumentRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `documentables` | [Array<DetachDocumentablesFromDocumentRequestDocumentablesInner>](DetachDocumentablesFromDocumentRequestDocumentablesInner.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { DetachDocumentablesFromDocumentRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "documentables": null,
19
+ } satisfies DetachDocumentablesFromDocumentRequest
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 DetachDocumentablesFromDocumentRequest
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
+ # DetachDocumentablesFromDocumentRequestDocumentablesInner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `documentableType` | string
10
+ `documentableId` | number
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { DetachDocumentablesFromDocumentRequestDocumentablesInner } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "documentableType": null,
20
+ "documentableId": null,
21
+ } satisfies DetachDocumentablesFromDocumentRequestDocumentablesInner
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 DetachDocumentablesFromDocumentRequestDocumentablesInner
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
+