-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.js
865 lines (830 loc) · 30.9 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
import cloneDeep from 'lodash/cloneDeep'
import error from '../core/contentstackError'
import { UserCollection } from '../user/index'
import { Role } from './roles/index'
import { create, query, update, fetch, deleteEntity } from '../entity'
import { ContentType } from './contentType/index'
import { GlobalField } from './globalField/index'
import { DeliveryToken } from './deliveryToken/index'
import { Environment } from './environment'
import { Asset } from './asset'
import { Locale } from './locale'
import { Extension } from './extension'
import { Webhook } from './webhook'
import { Workflow } from './workflow'
import { Release } from './release'
import { BulkOperation } from './bulkOperation'
import { Label } from './label'
import { Branch } from './branch'
import { BranchAlias } from './branchAlias'
import { AuditLog } from './auditlog'
import { Taxonomy } from './taxonomy'
import { ManagementToken } from './managementToken'
import { Variants } from './variants'
import { VariantGroup } from './variantGroup'
/**
* A stack is a space that stores the content of a project (a web or mobile property). Within a stack, you can create content structures, content entries, users, etc. related to the project. Read more about <a href='https://www.contentstack.com/docs/guide/stack'>Stacks</a>.
* @namespace Stack
*/
export function Stack (http, data) {
this.urlPath = '/stacks'
if (data) {
if (data.stack) {
Object.assign(this, cloneDeep(data.stack))
} else if (data.organization_uid) {
this.organization_uid = data.organization_uid
}
}
if (data && data.stack && data.stack.api_key) {
this.stackHeaders = { api_key: this.api_key }
if (this.management_token && this.management_token !== undefined) {
http.defaults.headers.authorization = this.management_token
delete this.management_token
}
if (this.branch_uid) {
this.stackHeaders.branch = this.branch_uid
}
/**
* @description The Update stack call lets you update the name and description of an existing stack.
* @memberof Stack
* @func update
* @returns {Promise<Stack.Stack>} Promise for Stack instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).fetch()
* .then((stack) => {
* stack.name = 'My New Stack'
* stack.description = 'My new test stack'
* return stack.update()
* })
* .then((stack) => console.log(stack))
*
*/
this.update = update(http, 'stack')
/**
* @description The fetch stack call fetches stack details.
* @memberof Stack
* @func fetch
* @returns {Promise<Stack.Stack>} Promise for Stack instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).fetch()
* .then((stack) => console.log(stack))
*
*/
this.fetch = fetch(http, 'stack')
/**
* @description Content type defines the structure or schema of a page or a section of your web or mobile property.
* @param {String} uid The UID of the ContentType you want to get details.
* @returns {ContentType} Instance of ContentType.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).contentType().create()
* .then((contentType) => console.log(contentType))
*
* client.stack({ api_key: 'api_key'}).contentType('content_type_uid').fetch()
* .then((contentType) => console.log(contentType))
*/
this.contentType = (contentTypeUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (contentTypeUid) {
data.content_type = { uid: contentTypeUid }
}
return new ContentType(http, data)
}
/**
* @description Locale allows you to create and publish entries in any language.
* @param {String} uid The UID of the Locale you want to get details.
* @returns {Locale} Instance of Locale.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).locale().create()
* .then((locale) => console.log(locale))
*
* client.stack({ api_key: 'api_key'}).locale('locale_code').fetch()
* .then((locale) => console.log(locale))
*/
this.locale = (code = null) => {
const data = { stackHeaders: this.stackHeaders }
if (code) {
data.locale = { code: code }
}
return new Locale(http, data)
}
/**
* @description Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use.
* @param {String} uid The UID of the Asset you want to get details.
* @returns {Asset} Instance of Asset.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).asset().create()
* .then((asset) => console.log(asset))
*
* client.stack({ api_key: 'api_key'}).asset('asset_uid').fetch()
* .then((asset) => console.log(asset))
*/
this.asset = (assetUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (assetUid) {
data.asset = { uid: assetUid }
}
return new Asset(http, data)
}
/**
* @description Global field defines the structure or schema of a page or a section of your web or mobile property.
* @param {String} uid The UID of the Global field you want to get details.
* @returns {GlobalField} Instance of Global field.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).globalField().create()
* .then((globalField) => console.log(globalField))
*
* client.stack({ api_key: 'api_key'}).globalField('globalField_uid').fetch()
* .then((globalField) => console.log(globalField))
*/
this.globalField = (globalFieldUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (globalFieldUid) {
data.global_field = { uid: globalFieldUid }
}
return new GlobalField(http, data)
}
/**
* @description Environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published.
* @param {String} uid The UID of the Environment you want to get details.
* @returns {Environment} Instance of Environment.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).environment().create()
* .then((environment) => console.log(environment))
*
* client.stack({ api_key: 'api_key'}).environment('environment_uid').fetch()
* .then((environment) => console.log(environment))
*/
this.environment = (environmentUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (environmentUid) {
data.environment = { name: environmentUid }
}
return new Environment(http, data)
}
/**
* @description Branch corresponds to Stack branch.
* @param {String}
* @returns {Branch}
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).branch().create()
* .then((branch) => console.log(branch))
*
* client.stack({ api_key: 'api_key' }).branch('branch_uid').fetch()
* .then((branch) => console.log(branch))
*
*/
this.branch = (branchUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (branchUid) {
data.branch = { uid: branchUid }
}
return new Branch(http, data)
}
/**
* @description Branch corresponds to Stack branch.
* @param {String}
* @returns {BranchAlias}
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).branchAlias().create()
* .then((branch) => console.log(branch))
*
* client.stack({ api_key: 'api_key' }).branchAlias('branch_alias_uid').fetch()
* .then((branch) => console.log(branch))
*
*/
this.branchAlias = (branchUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (branchUid) {
data.branch_alias = { uid: branchUid }
}
return new BranchAlias(http, data)
}
/**
* @description Delivery Tokens provide read-only access to the associated environments.
* @param {String} deliveryTokenUid The UID of the Delivery Token field you want to get details.
* @returns {DeliveryToken} Instance of DeliveryToken.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).deliveryToken().create()
* .then((deliveryToken) => console.log(deliveryToken))
*
* client.stack({ api_key: 'api_key'}).deliveryToken('deliveryToken_uid').fetch()
* .then((deliveryToken) => console.log(deliveryToken))
*/
this.deliveryToken = (deliveryTokenUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (deliveryTokenUid) {
data.token = { uid: deliveryTokenUid }
}
return new DeliveryToken(http, data)
}
/**
* @description Management Tokens are tokens that provide you with read-write access to the content of your stack.
* @param {String} managementTokenUid The UID of the Management Token field you want to get details.
* @returns {ManagementToken} Instance of ManagementToken.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).managementToken().create()
* .then((managementToken) => console.log(managementToken))
*
* client.stack({ api_key: 'api_key'}).managementToken('managementToken_uid').fetch()
* .then((managementToken) => console.log(managementToken))
*/
this.managementToken = (managementTokenUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (managementTokenUid) {
data.token = { uid: managementTokenUid }
}
return new ManagementToken(http, data)
}
/**
* @description Extensions let you create custom fields and custom widgets that lets you customize Contentstack's default UI and behavior.
* @param {String} extensionUid The UID of the Extension you want to get details.
* @returns {Extension} Instance of Extension.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).extension().create()
* .then((extension) => console.log(extension))
*
* client.stack({ api_key: 'api_key'}).extension('extension_uid').fetch()
* .then((extension) => console.log(extension))
*/
this.extension = (extensionUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (extensionUid) {
data.extension = { uid: extensionUid }
}
return new Extension(http, data)
}
/**
* @description Workflow is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly.
* @param {String} workflowUid The UID of the Workflow you want to get details.
* @returns {Workflow} Instance of Workflow.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).workflow().create()
* .then((workflow) => console.log(workflow))
*
* client.stack({ api_key: 'api_key'}).workflow('workflow_uid').fetch()
* .then((workflow) => console.log(workflow))
*/
this.workflow = (workflowUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (workflowUid) {
data.workflow = { uid: workflowUid }
}
return new Workflow(http, data)
}
/**
* @description Webhooks allow you to specify a URL to which you would like Contentstack to post data when an event happens.
* @param {String} webhookUid The UID of the Webhook you want to get details.
* @returns {Webhook} Instance of Webhook.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).webhook().create()
* .then((webhook) => console.log(webhook))
*
* client.stack({ api_key: 'api_key'}).webhook('webhook_uid').fetch()
* .then((webhook) => console.log(webhook))
*/
this.webhook = (webhookUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (webhookUid) {
data.webhook = { uid: webhookUid }
}
return new Webhook(http, data)
}
/**
* @description Labels allow you to group a collection of content within a stack. Using labels you can group content types that need to work together
* @param {String} uid The UID of the Label you want to get details.
* @returns {Label} Instance of Label.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).label().create()
* .then((label) => console.log(label))
*
* client.stack({ api_key: 'api_key'}).label('label_uid').fetch()
* .then((label) => console.log(label))
*/
this.label = (labelUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (labelUid) {
data.label = { uid: labelUid }
}
return new Label(http, data)
}
/**
* @description For creating ungrouped variants.
* @param {String} uid The UID of the variants you want to get details.
* @returns {Variants} Instance of variants.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).variants().create()
* .then((variants) => console.log(variants))
*
* client.stack({ api_key: 'api_key'}).variants('variants_uid').fetch()
* .then((variants) => console.log(variants))
*/
this.variants = (variantsUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (variantsUid) {
data.variants = { uid: variantsUid }
}
return new Variants(http, data)
}
/**
* @description You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a ‘release’, and then deploy this release to an environment.
* @param {String} releaseUid The UID of the Releases you want to get details.
* @returns {Release} Instance of Release.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).release().create()
* .then((release) => console.log(release))
*
* client.stack({ api_key: 'api_key'}).release('release_uid').fetch()
* .then((release) => console.log(release))
*/
this.release = (releaseUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (releaseUid) {
data.release = { uid: releaseUid }
}
return new Release(http, data)
}
/**
* Bulk operations such as Publish, Unpublish, and Delete on multiple entries or assets.
* @returns {BulkOperation} Instance of BulkOperation.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* const publishDetails = {
* entries: [
* {
* uid: '{{entry_uid}}',
* content_type: '{{content_type_uid}}',
* version: '{{version}}',
* locale: '{{entry_locale}}'
* }
* ],
* assets: [{
* uid: '{{uid}}'
* }],
* locales: [
* 'en'
* ],
* environments: [
* '{{env_name}}/env_uid}}'
* ]
* }
* client.stack({ api_key: 'api_key'}).bulkOperation().publish({ details: publishDetails })
* .then((response) => { console.log(response.notice) })
*
*/
this.bulkOperation = () => {
const data = { stackHeaders: this.stackHeaders }
return new BulkOperation(http, data)
}
/**
* @description The Get all users of a stack call fetches the list of all users of a particular stack
* @memberof Stack
* @func users
* @returns {Array<User>} Array of User's including owner of Stack
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).users()
* .then((users) => console.log(users))
*
*/
this.users = async () => {
try {
const response = await http.get(this.urlPath, {
params: {
include_collaborators: true
},
headers: {
...cloneDeep(this.stackHeaders)
}
})
if (response.data) {
return UserCollection(http, response.data.stack)
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Update User Role API Request updates the roles of an existing user account.
* This API Request will override the existing roles assigned to a user
* @memberof Stack
* @func updateUsersRoles
* @param {*} users object containing userId and array of roles to assign user.
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
* const users = {
* user_uid: ['role_uid_1', 'role_uid_2' ]
* }
*
* client.stack({ api_key: 'api_key'}).updateUsersRoles(users)
* .then((response) => console.log(response.notice))
*
*/
this.updateUsersRoles = async (data) => {
try {
const response = await http.post(`${this.urlPath}/users/roles`,
{ users: data },
{
headers: {
...cloneDeep(this.stackHeaders)
}
})
if (response.data) {
return response.data
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Transfer stack ownership to other users call sends the specified user an email invitation for accepting the ownership of a particular stack.
* @memberof Stack
* @func transferOwnership
* @param {String} email The email address of the user to whom you wish to transfer the ownership of the stack.
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).transferOwnership('emailId')
* .then((response) => console.log(response.notice))
*
*/
this.transferOwnership = async (email) => {
try {
const response = await http.post(`${this.urlPath}/transfer_ownership`,
{ transfer_to: email },
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Get stack settings call retrieves the configuration settings of an existing stack.
* @memberof Stack
* @func settings
* @returns {Object} Configuration settings of stack.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).settings()
* .then((settings) => console.log(settings))
*
*/
this.settings = async () => {
try {
const response = await http.get(`${this.urlPath}/settings`,
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data.stack_settings
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Reset stack settings call resets your stack to default settings, and additionally, lets you add parameters to or modify the settings of an existing stack.
* @memberof Stack
* @func resetSettings
* @returns {Object} Configuration settings of stack.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).resetSettings()
* .then((settings) => console.log(settings))
*
*/
this.resetSettings = async () => {
try {
const response = await http.post(`${this.urlPath}/settings`, { stack_settings: { discrete_variables: {}, stack_variables: {} } },
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data.stack_settings
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Add stack settings call lets you add settings for an existing stack.
* @memberof Stack
* @func addSettings
* @returns {Object} Configuration settings of stack.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).addSettings({ key: 'value' })
* .then((settings) => console.log(settings))
*
*/
this.addSettings = async (stackVariables = {}) => {
try {
const response = await http.post(`${this.urlPath}/settings`, { stack_settings: { stack_variables: stackVariables } },
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data.stack_settings
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Share a stack call shares a stack with the specified user to collaborate on the stack.
* @memberof Stack
* @func share
* @param {Array<String>} emails - Email ID of the user with whom you wish to share the stack
* @param {Array<String>} roles - The role uid that you wish to assign the user.
* @returns {Object} Response Object.
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).share([ "[email protected]" ], { "[email protected]": [ "abcdefhgi1234567890" ] })
* .then((response) => console.log(response.notice))
*
*/
this.share = async (emails = [], roles = {}) => {
try {
const response = await http.post(`${this.urlPath}/share`, { emails: emails, roles: roles },
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description The Unshare a stack call unshares a stack with a user and removes the user account from the list of collaborators.
* @memberof Stack
* @func unShare
* @param {String} email The email ID of the user from whom you wish to unshare the stack.
* @returns {Object} Response Object.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).unShare('[email protected]')
* .then((response) => console.log(response.notice))
*
*/
this.unShare = async (email) => {
try {
const response = await http.post(`${this.urlPath}/unshare`, { email: email },
{ headers: {
...cloneDeep(this.stackHeaders)
} })
if (response.data) {
return response.data
} else {
return error(response)
}
} catch (err) {
return error(err)
}
}
/**
* @description Variant Group allows you to create a variant groups.
* @param {String} uid The UID of the variant group you want to get details.
* @returns {VariantGroup} Instance of VariantGroup.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).variantGroup().create()
* .then((variant_group) => console.log(variant_group))
*
* client.stack({ api_key: 'api_key'}).variantGroup('variant_group_uid').fetch()
* .then((variant_group) => console.log(variant_group))
*/
this.variantGroup = (variantGroupUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (variantGroupUid) {
data.variant_group = { uid: variantGroupUid }
}
return new VariantGroup(http, data)
}
/**
* @description A role is a collection of permissions that will be applicable to all the users who are assigned this role.
* @memberof Stack
* @func role
* @param {String=} uid The UID of the role you want to get details.
* @returns {Role} Instance of Role.
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).role().create({
* "role":
* {
* "name":"testRole",
* "description":"",
* "rules":[...],
* }
* })
* .then((role) => console.log(role))
*
* client.stack({ api_key: 'api_key'}).role('role_uid').fetch())
* .then((role) => console.log(role))
*
*/
this.role = (uid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (uid) {
data.role = { uid: uid }
}
return new Role(http, data)
}
/**
* @description Taxonomies allow you to group a collection of content within a stack. Using taxonomies you can group content types that need to work together
* @param {String} uid The UID of the Taxonomy you want to get details.
* @returns {Taxonomy} Instance of Taxonomy.
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).taxonomy().create()
* .then((taxonomy) => console.log(taxonomy))
*
* client.stack({ api_key: 'api_key'}).taxonomy('taxonomy_uid').fetch()
* .then((taxonomy) => console.log(taxonomy))
*/
this.taxonomy = (taxonomyUid = '') => {
const data = { stackHeaders: this.stackHeaders }
if (taxonomyUid) {
data.taxonomy = { uid: taxonomyUid }
}
return new Taxonomy(http, data)
}
/**
* @description The delete stack call lets you delete the stack.
* @memberof Stack
* @func delete
* @returns {Promise<Stack.Stack>} Promise for Stack instance
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).delete()
* .then((stack) => console.log(stack))
*
*/
this.delete = deleteEntity(http)
} else {
/**
* @description The Create stack call creates a new stack in your Contentstack account.
* @memberof Stack
* @func create
* @returns {Promise<Stack.Stack>} Promise for Stack instance
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack().create({name: 'My New Stack'}, { organization_uid: 'org_uid' })
* .then((stack) => console.log(stack))
*/
this.create = create({ http: http, params: this.organization_uid ? { organization_uid: this.organization_uid } : null })
/**
* @description The Query on Stack will allow to fetch details of all or specific Stack.
* @memberof Stack
* @func query
* @param {Boolean} include_collaborators Set this parameter to 'true' to include the details of the stack collaborators.
* @param {Boolean} include_stack_variablesSet this to 'true' to display the stack variables. Stack variables are extra information about the stack, such as the description, format of date, format of time, and so on. Users can include or exclude stack variables in the response.
* @param {Boolean} include_discrete_variables Set this to 'true' to view the access token of your stack.
* @param {Boolean} include_count Set this to 'true' to include in the response the total count of the stacks owned by or shared with a user account.
* @param {Object} query Queries that you can use to fetch filtered results.
* @returns {ContentstackCollection} Instance of ContentstackCollection.
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack().query({ query: { name: 'Stack Name' } }).find()
* .then((stack) => console.log(stack))
*/
this.query = query({ http: http, wrapperCollection: StackCollection })
/**
* @description Audit log displays a record of all the activities performed in a stack and helps you keep a track of all published items, updates, deletes, and current status of the existing content.
* @param {String}
* @returns {AuditLog}
*
* @example
* import * as contentstack from '@contentstack/management'
* const client = contentstack.client()
*
* client.stack({ api_key: 'api_key'}).auditLog().fetchAll()
* .then((logs) => console.log(logs))
*
* client.stack({ api_key: 'api_key' }).auditLog('log_item_uid').fetch()
* .then((log) => console.log(log))
*
*/
this.auditLog = (logItemUid = null) => {
const data = { stackHeaders: this.stackHeaders }
if (logItemUid) {
data.logs = { uid: logItemUid }
}
return new AuditLog(http, data)
}
}
return this
}
export function StackCollection (http, data) {
const stacks = data.stacks || []
const obj = cloneDeep(stacks)
const stackCollection = obj.map((userdata) => {
return new Stack(http, { stack: userdata })
})
return stackCollection
}