-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathEntry.cs
More file actions
674 lines (617 loc) · 34.1 KB
/
Entry.cs
File metadata and controls
674 lines (617 loc) · 34.1 KB
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
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Contentstack.Management.Core.Abstractions;
using Contentstack.Management.Core.Queryable;
using Contentstack.Management.Core.Services.Models;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace Contentstack.Management.Core.Models
{
public class Entry: BaseModel<IEntry>
{
internal Entry(Stack stack, string contentTyppe, string uid)
: base(stack, "entry", uid)
{
resourcePath = uid == null ? $"/content_types/{contentTyppe}/entries" : $"/content_types/{contentTyppe}/entries/{uid}";
}
/// <summary>
/// The Query on Entry will allow to fetch details of all or specific Content Type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry().Query().Find();
/// </code></pre>
/// </example>
/// <returns>The <see cref="Query"/></returns>
public Query Query()
{
ThrowIfUidNotEmpty();
return new Query(stack, resourcePath);
}
/// <summary>
/// The Version on Entry will allow to fetch all version, delete specific version or naming the asset version.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry().Version().GetAll();
/// </code></pre>
/// </example>
/// <returns>The <see cref="Query"/></returns>
public Version Version(int? versionNumber = null)
{
ThrowIfUidEmpty();
return new Version(stack, resourcePath, "entry", versionNumber);
}
/// <summary>
/// The Create entry with JSON RTE request shows you how to add a JSON RTE field while creating a content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry().Create(model);
/// </code></pre>
/// </example>
/// <param name="model">IEntry for createing Entry.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public override ContentstackResponse Create(IEntry model, ParameterCollection collection = null)
{
return base.Create(model, collection);
}
/// <summary>
/// The Create entry with JSON RTE request shows you how to add a JSON RTE field while creating a content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry().CreateAsync(model);
/// </code></pre>
/// </example>
/// <param name="model">IEntry for createing Entry.</param>
/// <returns>The Task.</returns>
public override Task<ContentstackResponse> CreateAsync(IEntry model, ParameterCollection collection = null)
{
return base.CreateAsync(model, collection);
}
/// <summary>
/// The Update Entry call is used to update the schema of an existing content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Update(model);
/// </code></pre>
/// </example>
/// <param name="model">IEntry for updating entry.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public override ContentstackResponse Update(IEntry model, ParameterCollection collection = null)
{
return base.Update(model, collection);
}
/// <summary>
/// The Update Entry call is used to update the schema of an existing content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").UpdateAsync(model);
/// </code></pre>
/// </example>
/// <param name="model">IEntry for updating entry.</param>
/// <returns>The Task.</returns>
public override Task<ContentstackResponse> UpdateAsync(IEntry model, ParameterCollection collection = null)
{
return base.UpdateAsync(model, collection);
}
/// <summary>
/// The Fetch a single entry call returns information of a specific content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Fetch();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public override ContentstackResponse Fetch(ParameterCollection collection = null)
{
return base.Fetch(collection);
}
/// <summary>
/// The Fetch a single entry call returns information of a specific content type.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").FetchAsync();
/// </code></pre>
/// </example>
/// <returns>The Task.</returns>
public override Task<ContentstackResponse> FetchAsync(ParameterCollection collection = null)
{
return base.FetchAsync(collection);
}
/// <summary>
/// The Delete Entry call deletes an existing entry and all the entries within it.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Delete();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public override ContentstackResponse Delete(ParameterCollection collection = null)
{
return base.Delete(collection);
}
/// <summary>
/// The Delete Entry call deletes an existing entry and all the entries within it.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").DeleteAsync();
/// </code></pre>
/// </example>
/// <returns>The Task.</returns>
public override Task<ContentstackResponse> DeleteAsync(ParameterCollection collection = null)
{
return base.DeleteAsync(collection);
}
/// <summary>
/// The Delete Locale will delete specific localized entries by passing the locale codes.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// List<string> locales = new List<string>();
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").DeleteMultipleLocal(locales);
/// </code></pre>
/// </example>
/// <param name="locales">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse DeleteMultipleLocal(List<string> locales)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new DeleteService<Dictionary<string, List<string>>>(stack.client.serializer, stack, resourcePath, "entry", new Dictionary<string, List<string>>()
{
{"locales", locales }
});
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Delete Locale will delete specific localized entries by passing the locale codes.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// List<string> locales = new List<string>();
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").DeleteMultipleLocalAsync(locales);
/// </code></pre>
/// </example>
/// <param name="locales">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The Task</returns>
public Task<ContentstackResponse> DeleteMultipleLocalAsync(List<string> locales)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new DeleteService<Dictionary<string, List<string>>>(stack.client.serializer, stack, resourcePath, "entry", new Dictionary<string, List<string>>()
{
{"locales", locales }
});
return stack.client.InvokeAsync<DeleteService<Dictionary<string, List<string>>>, ContentstackResponse>(service);
}
/// <summary>
/// The Localize an entry request allows you to localize an entry i.e., the entry will cease to fetch data from its fallback language and possess independent content specific to the selected locale.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Localize(model, "hi-in");
/// </code></pre>
/// </example>
/// <param name="model">Localized IEntry model.</param>
/// <param name="locale">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse Localize(IEntry model, string locale)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
ParameterCollection collection = new ParameterCollection();
collection.Add("locale", locale);
var service = new LocalizationService<IEntry>(stack.client.serializer, stack, resourcePath, model, "entry", collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Localize an entry request allows you to localize an entry i.e., the entry will cease to fetch data from its fallback language and possess independent content specific to the selected locale.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryModel model = new EntryModel(); // Add field values
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").LocalizeAsync(model, "hi-in");
/// </code></pre>
/// </example>
/// <param name="model">Localized IEntry model.</param>
/// <param name="locale">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The Task</returns>
public Task<ContentstackResponse> LocalizeAsync(IEntry model, string locale)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
ParameterCollection collection = new ParameterCollection();
collection.Add("locale", locale);
var service = new LocalizationService<IEntry>(stack.client.serializer, stack, resourcePath, model, "entry", collection);
return stack.client.InvokeAsync<LocalizationService<IEntry>, ContentstackResponse>(service);
}
/// <summary>
/// The Unlocalize an entry request is used to unlocalize an existing entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Unlocalize("hi-in");
/// </code></pre>
/// </example>
/// <param name="locale">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse Unlocalize(string locale)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
ParameterCollection collection = new ParameterCollection();
collection.Add("locale", locale);
var service = new LocalizationService<IEntry>(stack.client.serializer, stack, resourcePath, null, "entry", collection, true);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Unlocalize an entry request is used to unlocalize an existing entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").UnlocalizeAsync("hi-in");
/// </code></pre>
/// </example>
/// <param name="locale">Enter the code of the language to unlocalize the entry of that particular language.</param>
/// <returns>The Task</returns>
public Task<ContentstackResponse> UnlocalizeAsync(string locale)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
ParameterCollection collection = new ParameterCollection();
collection.Add("locale", locale);
var service = new LocalizationService<IEntry>(stack.client.serializer, stack, resourcePath, null, "entry", collection, true);
return stack.client.InvokeAsync<LocalizationService<IEntry>, ContentstackResponse>(service);
}
/// <summary>
/// The Get languages of an entry call returns the details of all the languages that an entry exists in.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Locales();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse Locales()
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new LocaleService(stack.client.serializer, stack, resourcePath);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Get languages of an entry call returns the details of all the languages that an entry exists in.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").LocalesAsync();
/// </code></pre>
/// </example>
/// <returns>The Task</returns>
public Task<ContentstackResponse> LocalesAsync()
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new LocaleService(stack.client.serializer, stack, resourcePath);
return stack.client.InvokeAsync<LocaleService, ContentstackResponse>(service);
}
/// <summary>
/// The Get references of an entry call returns all the entries of content types that are referenced by a particular entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").References();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse References(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchReferencesService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Get references of an entry call returns all the entries of content types that are referenced by a particular entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").ReferencesAsync();
/// </code></pre>
/// </example>
/// <returns>The Task</returns>
public Task<ContentstackResponse> ReferencesAsync(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchReferencesService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeAsync<FetchReferencesService, ContentstackResponse>(service);
}
/// <summary>
/// The Publish an entry request lets you publish an entry either immediately or schedule it for a later date/time.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Publish(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <param name="details">Publish/Unpublish details.</param>
/// <param name="locale">Locale for entry to be publish</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Publish(PublishUnpublishDetails details, string locale = null, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/publish", "entry", locale);
return stack.client.InvokeSync(service, apiVersion: apiVersion);
}
/// <summary>
/// The Publish an entry request lets you publish an entry either immediately or schedule it for a later date/time.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").PublishAsync(new PublishUnpublishDetails(), "en-us");
/// </code></pre>
/// </example>
/// <param name="details">Publish/Unpublish details.</param>
/// <param name="locale">Locale for entry to be publish</param>
/// <returns>The Task</returns>
public virtual Task<ContentstackResponse> PublishAsync(PublishUnpublishDetails details, string locale = null, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/publish", "entry", locale);
return stack.client.InvokeAsync<PublishUnpublishService, ContentstackResponse>(service, apiVersion: apiVersion);
}
/// <summary>
/// The Unpublish an entry call will unpublish an entry at once, and also, gives you the provision to unpublish an entry automatically at a later date/time.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Unpublish(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <param name="details">Publish/Unpublish details.</param>
/// <param name="locale">Locale for entry to be publish</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Unpublish(PublishUnpublishDetails details, string locale = null, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/unpublish", "entry", locale);
return stack.client.InvokeSync(service, apiVersion: apiVersion);
}
/// <summary>
/// The Unpublish an entry call will unpublish an entry at once, and also, gives you the provision to unpublish an entry automatically at a later date/time.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").UnpublishAsync(new PublishUnpublishDetails(), "en-us");
/// </code></pre>
/// </example>
/// <param name="details">Publish/Unpublish details.</param>
/// <param name="locale">Locale for entry to be publish</param>
/// <returns>The Task</returns>
public virtual Task<ContentstackResponse> UnpublishAsync(PublishUnpublishDetails details, string locale = null, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/unpublish", "entry", locale);
return stack.client.InvokeAsync<PublishUnpublishService, ContentstackResponse>(service, apiVersion: apiVersion);
}
/// <summary>
/// The Import an entry call is used to import an entry.
/// To import an entry, you need to upload a JSON file that has entry data in the format that fits the schema of the content type it is being imported to.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Import("PATH/TO/FILE");
/// </code></pre>
/// </example>
/// <param name="filePath">Path to file you want to import</param>
/// <param name="collection">Query parameter.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse Import(string filePath, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
var text = File.ReadAllText(filePath);
var service = new ImportExportService(stack.client.serializer, stack, resourcePath, true, "POST", collection);
service.ByteContent = System.Text.Encoding.UTF8.GetBytes(text);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Import an entry call is used to import an entry.
/// To import an entry, you need to upload a JSON file that has entry data in the format that fits the schema of the content type it is being imported to.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").ImportAsync("PATH/TO/FILE");
/// </code></pre>
/// </example>
/// <param name="filePath">Path to file you want to import</param>
/// <param name="collection">Query parameter.</param>
/// <returns>The Task</returns>
public Task<ContentstackResponse> ImportAsync(string filePath, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var text = File.ReadAllText(filePath);
var service = new ImportExportService(stack.client.serializer, stack, resourcePath, isImport: true, "POST", collection);
service.ByteContent = System.Text.Encoding.UTF8.GetBytes(text);
return stack.client.InvokeAsync<ImportExportService, ContentstackResponse>(service);
}
/// <summary>
/// The Export an entry call is used to export an entry. The exported entry data is saved in a downloadable JSON file/
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").Export("PATH/TO/FILE");
/// </code></pre>
/// </example>
/// <param name="filePath">Path to file you want to export entry.</param>
/// <param name="collection">Query parameter.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse Export(string filePath, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
try
{
var service = new ImportExportService(stack.client.serializer, stack, resourcePath, collection: collection);
ContentstackResponse response = stack.client.InvokeSync(service);
if (response.IsSuccessStatusCode)
{
using (StreamWriter file = File.CreateText(filePath))
using (JsonTextWriter writer = new JsonTextWriter(file))
{
JObject json = response.OpenJObjectResponse();
json.WriteTo(writer);
}
}
return response;
} catch (Exception e)
{
Console.WriteLine(e);
throw;
}
}
/// <summary>
/// The Set Entry Workflow Stage request allows you to either set a particular workflow stage of an entry or update the workflow stage details of an entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryWorkflowStage model = new EntryWorkflowStage();
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").SetWorkflow(model);
/// </code></pre>
/// </example>
/// <param name="model"><see cref="EntryWorkflowStage"/> object.</param>
/// <param name="collection">Query parameter.</param>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public ContentstackResponse SetWorkflow(EntryWorkflowStage model, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
Dictionary<string, EntryWorkflowStage> dict = new Dictionary<string, EntryWorkflowStage>()
{
{ "workflow_stage", model}
};
var service = new CreateUpdateService<Dictionary<string, EntryWorkflowStage>>(stack.client.serializer, stack, $"{resourcePath}/workflow", dict, "workflow", collection: collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Set Entry Workflow Stage request allows you to either set a particular workflow stage of an entry or update the workflow stage details of an entry.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryWorkflowStage model = new EntryWorkflowStage();
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").SetWorkflowAsync(model);
/// </code></pre>
/// </example>
/// <param name="model"><see cref="EntryWorkflowStage"/> object.</param>
/// <param name="collection">Query parameter.</param>
/// <returns>The Task.</returns>
public Task<ContentstackResponse> SetWorkflowAsync(EntryWorkflowStage model, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
Dictionary<string, EntryWorkflowStage> dict = new Dictionary<string, EntryWorkflowStage>()
{
{ "workflow_stage", model}
};
var service = new CreateUpdateService<Dictionary<string, EntryWorkflowStage>>(stack.client.serializer, stack, $"{resourcePath}/workflow", dict, "workflow", collection: collection);
return stack.client.InvokeAsync<CreateUpdateService<Dictionary<string, EntryWorkflowStage>>, ContentstackResponse>(service);
}
/// <summary>
/// This multipurpose request allows you to either send a publish request or accept/reject a received publish request.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryPublishAction model = new EntryPublishAction();
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").PublishRequest(model);
/// </code></pre>
/// </example>
/// <param name="publishAction"><see cref="EntryPublishAction"/> object.</param>
/// <param name="collection">Query parameter.</param>
/// <returns></returns>
public ContentstackResponse PublishRequest(EntryPublishAction publishAction, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
Dictionary<string, EntryPublishAction> dict = new Dictionary<string, EntryPublishAction>()
{
{ "publishing_rule", publishAction}
};
var service = new CreateUpdateService<Dictionary<string, EntryPublishAction>>(stack.client.serializer, stack, $"{resourcePath}/workflow", dict, "workflow", collection: collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// This multipurpose request allows you to either send a publish request or accept/reject a received publish request.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// EntryPublishAction model = new EntryPublishAction();
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").ContentType("<CONTENT_TYPE_UID>").Entry("<ENTRY_UID>").PublishRequestAsync(model);
/// </code></pre>
/// </example>
/// <param name="publishAction"><see cref="EntryPublishAction"/> object.</param>
/// <param name="collection">Query parameter.</param>
/// <returns></returns>
public Task<ContentstackResponse> PublishRequestAsync(EntryPublishAction publishAction, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
Dictionary<string, EntryPublishAction> dict = new Dictionary<string, EntryPublishAction>()
{
{ "publishing_rule", publishAction}
};
var service = new CreateUpdateService<Dictionary<string, EntryPublishAction>>(stack.client.serializer, stack, $"{resourcePath}/workflow", dict, "workflow", collection: collection);
return stack.client.InvokeAsync<CreateUpdateService<Dictionary<string, EntryPublishAction>>, ContentstackResponse>(service);
}
}
}