ContentfulManagementClient.cs
133 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
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
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
using Contentful.Core.Configuration;
using Contentful.Core.Errors;
using Contentful.Core.Models;
using Contentful.Core.Models.Management;
using Contentful.Core.Search;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Serialization;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Reflection;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
namespace Contentful.Core
{
/// <summary>
/// Encapsulates methods to interact with the Contentful Management API.
/// </summary>
public class ContentfulManagementClient : ContentfulClientBase, IContentfulManagementClient
{
private readonly string _directApiUrl = "https://api.contentful.com/";
private readonly string _baseUrl = "https://api.contentful.com/spaces/";
private readonly string _baseUploadUrl = "https://upload.contentful.com/spaces/";
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulManagementClient"/> class.
/// The main class for interaction with the contentful deliver and preview APIs.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="options">The options object used to retrieve the <see cref="ContentfulOptions"/> for this client.</param>
/// <exception cref="ArgumentException">The <see name="options">options</see> parameter was null or empty</exception>
public ContentfulManagementClient(HttpClient httpClient, IOptions<ContentfulOptions> options)
{
_httpClient = httpClient;
_options = options.Value;
if (options == null)
{
throw new ArgumentException("The ContentfulOptions cannot be null.", nameof(options));
}
}
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulManagementClient"/> class.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="options">The <see cref="ContentfulOptions"/> used for this client.</param>
public ContentfulManagementClient(HttpClient httpClient, ContentfulOptions options) :
this(httpClient, new OptionsWrapper<ContentfulOptions>(options))
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ContentfulManagementClient"/> class.
/// </summary>
/// <param name="httpClient">The HttpClient of your application.</param>
/// <param name="managementApiKey">The management API key used when communicating with the Contentful API</param>
/// <param name="spaceId">The id of the space to fetch content from.</param>
public ContentfulManagementClient(HttpClient httpClient, string managementApiKey, string spaceId) :
this(httpClient, new OptionsWrapper<ContentfulOptions>(new ContentfulOptions()
{
ManagementApiKey = managementApiKey,
SpaceId = spaceId
}))
{
}
/// <summary>
/// Creates a new space in Contentful.
/// </summary>
/// <param name="name">The name of the space to create.</param>
/// <param name="defaultLocale">The default locale for this space.</param>
/// <param name="organisation">The organisation to create a space for. Not required if the account belongs to only one organisation.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Space"/></returns>
public async Task<Space> CreateSpace(string name, string defaultLocale, string organisation = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (!string.IsNullOrEmpty(organisation))
{
_httpClient.DefaultRequestHeaders.Add("X-Contentful-Organization", organisation);
}
var res = await PostAsync(_baseUrl, ConvertObjectToJsonStringContent(new { name, defaultLocale }), cancellationToken).ConfigureAwait(false);
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Organization");
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.ToObject<Space>(Serializer);
}
/// <summary>
/// Updates the name of a space in Contentful.
/// </summary>
/// <param name="space">The space to update, needs to contain at minimum name, Id and version.</param>
/// <param name="organisation">The organisation to update a space for. Not required if the account belongs to only one organisation.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The updated <see cref="Space"/></returns>
public async Task<Space> UpdateSpaceName(Space space, string organisation = null, CancellationToken cancellationToken = default(CancellationToken))
{
return await UpdateSpaceName(space.SystemProperties.Id, space.Name, space.SystemProperties.Version ?? 1, organisation, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Updates a space in Contentful.
/// </summary>
/// <param name="id">The id of the space to update.</param>
/// <param name="name">The name to update to.</param>
/// <param name="version">The version of the space that will be updated.</param>
/// <param name="organisation">The organisation to update a space for. Not required if the account belongs to only one organisation.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The updated <see cref="Space"/></returns>
public async Task<Space> UpdateSpaceName(string id, string name, int version, string organisation = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (!string.IsNullOrEmpty(organisation))
{
_httpClient.DefaultRequestHeaders.Add("X-Contentful-Organization", organisation);
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{id}", ConvertObjectToJsonStringContent(new { name }), cancellationToken).ConfigureAwait(false);
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Organization");
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.ToObject<Space>(Serializer);
}
/// <summary>
/// Gets a space in Contentful.
/// </summary>
/// <param name="id">The id of the space to get.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Space" /></returns>
public async Task<Space> GetSpace(string id, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{id}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.ToObject<Space>(Serializer);
}
/// <summary>
/// Gets all spaces in Contentful.
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="Space"/>.</returns>
public async Task<IEnumerable<Space>> GetSpaces(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync(_baseUrl, cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.SelectTokens("$..items[*]").Select(t => t.ToObject<Space>(Serializer));
}
/// <summary>
/// Deletes a space in Contentful.
/// </summary>
/// <param name="id">The id of the space to delete.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns></returns>
public async Task DeleteSpace(string id, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await DeleteAsync($"{_baseUrl}{id}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Get all content types of a space.
/// </summary>
/// <param name="spaceId">The id of the space to get the content types of. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="ContentType"/>.</returns>
public async Task<IEnumerable<ContentType>> GetContentTypes(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.SelectTokens("$..items[*]").Select(t => t.ToObject<ContentType>(Serializer));
}
/// <summary>
/// Creates or updates a ContentType. Updates if a content type with the same id already exists.
/// </summary>
/// <param name="contentType">The <see cref="ContentType"/> to create or update. **Remember to set the id property.**</param>
/// <param name="spaceId">The id of the space to create the content type in. Will default to the one set when creating the client.</param>
/// <param name="version">The last version known of the content type. Must be set for existing content types. Should be null if one is created.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created or updated <see cref="ContentType"/>.</returns>
/// <exception cref="ArgumentException">Thrown if the id of the content type is not set.</exception>
public async Task<ContentType> CreateOrUpdateContentType(ContentType contentType, string spaceId = null, int? version = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (contentType.SystemProperties?.Id == null)
{
throw new ArgumentException("The id of the content type must be set.", nameof(contentType));
}
AddVersionHeader(version);
var res = await PutAsync(
$"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentType.SystemProperties.Id}",
ConvertObjectToJsonStringContent(new { name = contentType.Name, description = contentType.Description, displayField = contentType.DisplayField, fields = contentType.Fields }), cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.ToObject<ContentType>(Serializer);
}
/// <summary>
/// Gets a <see cref="ContentType"/> by the specified id.
/// </summary>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="spaceId">The id of the space to get the content type from. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="ContentType"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task<ContentType> GetContentType(string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var contentType = jsonObject.ToObject<ContentType>(Serializer);
return contentType;
}
/// <summary>
/// Deletes a <see cref="ContentType"/> by the specified id.
/// </summary>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="spaceId">The id of the space to delete the content type in. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="ContentType"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task DeleteContentType(string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Activates a <see cref="ContentType"/> by the specified id.
/// </summary>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="version">The last known version of the content type.</param>
/// <param name="spaceId">The id of the space to activate the content type in. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="ContentType"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task<ContentType> ActivateContentType(string contentTypeId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/published", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var contentType = jsonObject.ToObject<ContentType>(Serializer);
return contentType;
}
/// <summary>
/// Deactivates a <see cref="ContentType"/> by the specified id.
/// </summary>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="spaceId">The id of the space to deactivate the content type in. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="ContentType"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task DeactivateContentType(string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/published", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Get all activated content types of a space.
/// </summary>
/// <param name="spaceId">The id of the space to get the activated content types of. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="ContentType"/>.</returns>
public async Task<IEnumerable<ContentType>> GetActivatedContentTypes(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/public/content_types", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.SelectTokens("$..items[*]").Select(t => t.ToObject<ContentType>(Serializer));
}
/// <summary>
/// Gets a <see cref="Contentful.Core.Models.Management.EditorInterface"/> for a specific <seealso cref="ContentType"/>.
/// </summary>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="Contentful.Core.Models.Management.EditorInterface"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task<EditorInterface> GetEditorInterface(string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/editor_interface", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var editorInterface = jsonObject.ToObject<EditorInterface>(Serializer);
return editorInterface;
}
/// <summary>
/// Updates a <see cref="Contentful.Core.Models.Management.EditorInterface"/> for a specific <see cref="ContentType"/>.
/// </summary>
/// <param name="editorInterface">The editor interface to update.</param>
/// <param name="contentTypeId">The id of the content type.</param>
/// <param name="version">The last known version of the content type.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into a <see cref="Contentful.Core.Models.Management.EditorInterface"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task<EditorInterface> UpdateEditorInterface(EditorInterface editorInterface, string contentTypeId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException(nameof(contentTypeId));
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/editor_interface",
ConvertObjectToJsonStringContent(new { controls = editorInterface.Controls }), cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var updatedEditorInterface = jsonObject.ToObject<EditorInterface>(Serializer);
return updatedEditorInterface;
}
/// <summary>
/// Gets all the entries of a space, filtered by an optional <see cref="QueryBuilder{T}"/>.
/// </summary>
/// <typeparam name="T">The type to serialize the response into.</typeparam>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of items.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<T>> GetEntriesCollection<T>(QueryBuilder<T> queryBuilder, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetEntriesCollection<T>(queryBuilder?.Build(), cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets all the entries of a space, filtered by an optional querystring. A simpler approach than
/// to construct a query manually is to use the <see cref="QueryBuilder{T}"/> class.
/// </summary>
/// <typeparam name="T">The type to serialize the response into.</typeparam>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of items.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<T>> GetEntriesCollection<T>(string queryString = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{_options.SpaceId}/entries{queryString}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var isContentfulResource = typeof(IContentfulResource).GetTypeInfo().IsAssignableFrom(typeof(T).GetTypeInfo());
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<T>>(Serializer);
if (!isContentfulResource)
{
var entryTokens = jsonObject.SelectTokens("$.items[*]..fields").ToList();
for (var i = entryTokens.Count - 1; i >= 0; i--)
{
var token = entryTokens[i];
var grandParent = token.Parent.Parent;
if (grandParent["sys"]?["type"] != null && grandParent["sys"]["type"]?.ToString() != "Entry")
{
continue;
}
//Remove the fields property and let the fields be direct descendants of the node to make deserialization logical.
token.Parent.Remove();
grandParent.Add(token.Children());
}
var entries = jsonObject.SelectToken("$.items").ToObject<IEnumerable<T>>(Serializer);
collection.Items = entries;
}
return collection;
}
/// <summary>
/// Creates an <see cref="Entry{T}"/>.
/// </summary>
/// <param name="entry">The entry to create or update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="contentTypeId">The id of the <see cref="ContentType"/> of the entry.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Entry{T}"/>.</returns>
public async Task<Entry<dynamic>> CreateEntry(Entry<dynamic> entry, string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException("The content type id must be set.", nameof(contentTypeId));
}
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Content-Type");
_httpClient.DefaultRequestHeaders.Add("X-Contentful-Content-Type", contentTypeId);
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries",
ConvertObjectToJsonStringContent(new { fields = entry.Fields }), cancellationToken).ConfigureAwait(false);
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Content-Type");
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var updatedEntry = jsonObject.ToObject<Entry<dynamic>>(Serializer);
return updatedEntry;
}
/// <summary>
/// Creates an entry.
/// </summary>
/// <param name="entry">The object to create an entry from.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="contentTypeId">The id of the <see cref="ContentType"/> of the entry.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created entry.</returns>
public async Task<T> CreateEntry<T>(T entry, string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var entryToCreate = new Entry<dynamic>
{
Fields = entry
};
var createdEntry = await CreateEntry(entryToCreate, contentTypeId, spaceId, cancellationToken);
return (createdEntry.Fields as JObject).ToObject<T>();
}
/// <summary>
/// Creates or updates an <see cref="Entry{T}"/>. Updates if an entry with the same id already exists.
/// </summary>
/// <param name="entry">The entry to create or update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="contentTypeId">The id of the <see cref="ContentType"/> of the entry. Need only be set if you are creating a new entry.</param>
/// <param name="version">The last known version of the entry. Must be set when updating an entry.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created or updated <see cref="Entry{T}"/>.</returns>
public async Task<Entry<dynamic>> CreateOrUpdateEntry(Entry<dynamic> entry, string spaceId = null, string contentTypeId = null, int? version = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entry.SystemProperties?.Id))
{
throw new ArgumentException("The id of the entry must be set.");
}
if (!string.IsNullOrEmpty(contentTypeId))
{
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Content-Type");
_httpClient.DefaultRequestHeaders.Add("X-Contentful-Content-Type", contentTypeId);
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entry.SystemProperties.Id}",
ConvertObjectToJsonStringContent(new { fields = entry.Fields }), cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
_httpClient.DefaultRequestHeaders.Remove("X-Contentful-Content-Type");
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var updatedEntry = jsonObject.ToObject<Entry<dynamic>>(Serializer);
return updatedEntry;
}
/// <summary>
/// Creates or updates an entry. Updates if an entry with the same id already exists.
/// </summary>
/// <param name="entry">The entry to create or update.</param>
/// <param name="id">The id of the entry to create or update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="contentTypeId">The id of the <see cref="ContentType"/> of the entry. Need only be set if you are creating a new entry.</param>
/// <param name="version">The last known version of the entry. Must be set when updating an entry.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created or updated entry.</returns>
public async Task<T> CreateOrUpdateEntry<T>(T entry, string id, string spaceId = null, string contentTypeId = null, int? version = null, CancellationToken cancellationToken = default(CancellationToken))
{
var entryToCreate = new Entry<dynamic>
{
SystemProperties = new SystemProperties
{
Id = id
},
Fields = entry
};
var createdEntry = await CreateOrUpdateEntry(entryToCreate, spaceId, contentTypeId, version, cancellationToken);
return (createdEntry.Fields as JObject).ToObject<T>();
}
/// <summary>
/// Creates an entry with values for a certain locale from the provided object.
/// </summary>
/// <param name="entry">The object to use as values for the entry fields.</param>
/// <param name="id">The of the entry to create.</param>
/// <param name="contentTypeId">The id of the content type to create an entry for.</param>
/// <param name="locale">The locale to set fields for. The default locale for the space will be used if this parameter is null or empty.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Entry{T}"/>.</returns>
public async Task<Entry<dynamic>> CreateEntryForLocale(object entry, string id, string contentTypeId, string locale = null, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(locale))
{
locale = (await GetLocalesCollection(spaceId, cancellationToken)).FirstOrDefault(c => c.Default).Code;
}
var jsonEntry = JObject.Parse(ConvertObjectToJsonString(entry));
var jsonToCreate = new JObject();
foreach (var prop in jsonEntry.Children().Where(p => p is JProperty).Cast<JProperty>())
{
var val = jsonEntry[prop.Name];
jsonToCreate.Add(new JProperty(prop.Name, new JObject(new JProperty(locale, val))));
}
var entryToCreate = new Entry<dynamic>
{
SystemProperties = new SystemProperties
{
Id = id
},
Fields = jsonToCreate
};
return await CreateOrUpdateEntry(entryToCreate, spaceId: spaceId, contentTypeId: contentTypeId, cancellationToken: cancellationToken);
}
/// <summary>
/// Updates an entry fields for a certain locale using the values from the provided object.
/// </summary>
/// <param name="entry">The object to use as values for the entry fields.</param>
/// <param name="id">The id of the entry to update.</param>
/// <param name="locale">The locale to set the fields for. The default locale for the space will be used if this parameter is null or empty.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The updated <see cref="Entry{T}"/>.</returns>
public async Task<Entry<dynamic>> UpdateEntryForLocale(object entry, string id, string locale = null, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var entryToUpdate = await GetEntry(id, spaceId);
if(string.IsNullOrEmpty(locale))
{
locale = (await GetLocalesCollection(spaceId, cancellationToken)).FirstOrDefault(c => c.Default).Code;
}
var jsonEntry = JObject.Parse(ConvertObjectToJsonString(entry));
var fieldsToUpdate = (entryToUpdate.Fields as JObject);
foreach (var prop in fieldsToUpdate.Children().Where(p => p is JProperty).Cast<JProperty>())
{
if(jsonEntry[prop.Name] != null)
{
fieldsToUpdate[prop.Name][locale] = jsonEntry[prop.Name];
}
}
var updatedEntry = await CreateOrUpdateEntry(entryToUpdate,spaceId: spaceId, version: entryToUpdate.SystemProperties.Version, cancellationToken: cancellationToken);
return updatedEntry;
}
/// <summary>
/// Get a single entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <see cref="Entry{dynamic}"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task<Entry<dynamic>> GetEntry(string entryId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
return JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false)).ToObject<Entry<dynamic>>(Serializer);
}
/// <summary>
/// Deletes a single entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="version">The last known version of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task DeleteEntry(string entryId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Publishes an entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="version">The last known version of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <see cref="Entry{dynamic}"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task<Entry<dynamic>> PublishEntry(string entryId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/published", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
return JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false)).ToObject<Entry<dynamic>>(Serializer);
}
/// <summary>
/// Unpublishes an entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="version">The last known version of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <see cref="Entry{dynamic}"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task<Entry<dynamic>> UnpublishEntry(string entryId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/published", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
return JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false)).ToObject<Entry<dynamic>>(Serializer);
}
/// <summary>
/// Archives an entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="version">The last known version of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <see cref="Entry{dynamic}"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task<Entry<dynamic>> ArchiveEntry(string entryId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/archived", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
return JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false)).ToObject<Entry<dynamic>>(Serializer);
}
/// <summary>
/// Unarchives an entry by the specified id.
/// </summary>
/// <param name="entryId">The id of the entry.</param>
/// <param name="version">The last known version of the entry.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The response from the API serialized into <see cref="Entry{dynamic}"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="entryId">entryId</see> parameter was null or empty.</exception>
public async Task<Entry<dynamic>> UnarchiveEntry(string entryId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException(nameof(entryId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/archived", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
return JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false)).ToObject<Entry<dynamic>>(Serializer);
}
/// <summary>
/// Gets all assets of a space, filtered by an optional <see cref="QueryBuilder{T}"/>.
/// </summary>
/// <param name="queryBuilder">The optional <see cref="QueryBuilder{T}"/> to add additional filtering to the query.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.ManagementAsset"/>.</returns>
/// <exception cref="Contentful.Core.Errors.ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<ManagementAsset>> GetAssetsCollection(QueryBuilder<Asset> queryBuilder, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
return await GetAssetsCollection(queryBuilder?.Build(), spaceId, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Gets all assets in the space.
/// </summary>
/// <param name="queryString">The optional querystring to add additional filtering to the query.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.ManagementAsset"/>.</returns>
/// <exception cref="Contentful.Core.Errors.ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<ManagementAsset>> GetAssetsCollection(string queryString = null, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{queryString}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<ManagementAsset>>(Serializer);
var assets = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<ManagementAsset>(Serializer));
collection.Items = assets;
return collection;
}
/// <summary>
/// Gets all published assets in the space.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.ManagementAsset"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<ManagementAsset>> GetPublishedAssetsCollection(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/public/assets", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<ManagementAsset>>(Serializer);
var assets = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<ManagementAsset>(Serializer));
collection.Items = assets;
return collection;
}
/// <summary>
/// Gets an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/>.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> GetAsset(string assetId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementAsset>(Serializer);
}
/// <summary>
/// Deletes an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to delete.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task DeleteAsset(string assetId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Publishes an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to publish.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/> published.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> PublishAsset(string assetId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}/published", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementAsset>(Serializer);
}
/// <summary>
/// Unpublishes an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to unpublish.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/> unpublished.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> UnpublishAsset(string assetId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}/published", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementAsset>(Serializer);
}
/// <summary>
/// Archives an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to archive.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/> archived.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> ArchiveAsset(string assetId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
HttpResponseMessage res = null;
res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}/archived", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementAsset>(Serializer);
}
/// <summary>
/// Unarchives an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to unarchive.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/> unarchived.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> UnarchiveAsset(string assetId, int version, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}/archived", cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementAsset>(Serializer);
}
/// <summary>
/// Processes an asset by the specified id and keeps polling the API until it has finished processing. **Note that this might result in multiple API calls.**
/// </summary>
/// <param name="assetId">The id of the asset to process.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="locale">The locale for which files should be processed.</param>
/// <param name="maxDelay">The maximum number of milliseconds allowed for the operation.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementAsset"/> that has been processed.</returns>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="TimeoutException">The processing of the asset did not finish within the allotted time.</exception>
public async Task<ManagementAsset> ProcessAssetUntilCompleted(string assetId, int version, string locale, int maxDelay = 2000, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
await ProcessAsset(assetId, version, locale, spaceId, cancellationToken);
var processedAsset = await GetAsset(assetId, spaceId, cancellationToken);
var delay = 0;
var completed = false;
while (completed == false && delay < maxDelay)
{
await Task.Delay(delay);
if (processedAsset?.Files[locale]?.Url == null)
{
processedAsset = await GetAsset(assetId, spaceId, cancellationToken);
}
else
{
return processedAsset;
}
delay += 200;
}
throw new TimeoutException($"The processing of the asset did not finish in a timely manner. Max delay of {maxDelay} reached.");
}
/// <summary>
/// Processes an asset by the specified id.
/// </summary>
/// <param name="assetId">The id of the asset to process.</param>
/// <param name="version">The last known version of the asset.</param>
/// <param name="locale">The locale for which files should be processed.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="assetId">assetId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task ProcessAsset(string assetId, int version, string locale, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(assetId))
{
throw new ArgumentException(nameof(assetId));
}
AddVersionHeader(version);
HttpResponseMessage res = null;
res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{assetId}/files/{locale}/process", null, cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Creates or updates an <see cref="Contentful.Core.Models.Management.ManagementAsset"/>. Updates if an asset with the same id already exists.
/// </summary>
/// <param name="asset">The asset to create or update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="version">The last known version of the entry. Must be set when updating an asset.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The updated <see cref="Contentful.Core.Models.Management.ManagementAsset"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> CreateOrUpdateAsset(ManagementAsset asset, string spaceId = null, int? version = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(asset.SystemProperties?.Id))
{
throw new ArgumentException("The id of the asset must be set.");
}
AddVersionHeader(version);
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets/{asset.SystemProperties.Id}",
ConvertObjectToJsonStringContent(new { fields = new { title = asset.Title, description = asset.Description, file = asset.Files } }), cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var updatedAsset = jsonObject.ToObject<ManagementAsset>(Serializer);
return updatedAsset;
}
/// <summary>
/// Creates an <see cref="Contentful.Core.Models.Management.ManagementAsset"/> with a randomly created id.
/// </summary>
/// <param name="asset">The asset to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.ManagementAsset"/></returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementAsset> CreateAsset(ManagementAsset asset, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/assets",
ConvertObjectToJsonStringContent(new { fields = new { title = asset.Title, description = asset.Description, file = asset.Files } }), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var createdAsset = jsonObject.ToObject<ManagementAsset>(Serializer);
return createdAsset;
}
/// <summary>
/// Gets all locales in a <see cref="Space"/>.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{Locale}"/> of locales.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Locale>> GetLocalesCollection(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/locales", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Locale>>(Serializer);
var locales = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<Locale>(Serializer));
collection.Items = locales;
return collection;
}
/// <summary>
/// Creates a locale in the specified <see cref="Space"/>.
/// </summary>
/// <param name="locale">The <see cref="Contentful.Core.Models.Management.Locale"/> to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.Locale"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Locale> CreateLocale(Locale locale, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/locales",
ConvertObjectToJsonStringContent(
new
{
code = locale.Code,
contentDeliveryApi = locale.ContentDeliveryApi,
contentManagementApi = locale.ContentManagementApi,
fallbackCode = locale.FallbackCode,
name = locale.Name,
optional = locale.Optional
}), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Locale>(Serializer);
}
/// <summary>
/// Gets a locale in the specified <see cref="Space"/>.
/// </summary>
/// <param name="localeId">The id of the locale to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The requested <see cref="Contentful.Core.Models.Management.Locale"/>.</returns>
/// <exception cref="ArgumentException">The <see name="localeId">localeId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Locale> GetLocale(string localeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(localeId))
{
throw new ArgumentException("The localeId must be set.");
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/locales/{localeId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Locale>(Serializer);
}
/// <summary>
/// Updates a locale in the specified <see cref="Space"/>.
/// </summary>
/// <param name="locale">The <see cref="Contentful.Core.Models.Management.Locale"/> to update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.Locale"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Locale> UpdateLocale(Locale locale, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(locale.SystemProperties?.Id))
{
throw new ArgumentException("The id of the Locale must be set.");
}
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/locales/{locale.SystemProperties.Id}", ConvertObjectToJsonStringContent(new
{
code = locale.Code,
contentDeliveryApi = locale.ContentDeliveryApi,
contentManagementApi = locale.ContentManagementApi,
fallbackCode = locale.FallbackCode,
name = locale.Name,
optional = locale.Optional
}), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Locale>(Serializer);
}
/// <summary>
/// Deletes a locale by the specified id.
/// </summary>
/// <param name="localeId">The id of the locale to delete.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="localeId">localeId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task DeleteLocale(string localeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(localeId))
{
throw new ArgumentException("The localeId must be set.");
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/locales/{localeId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Gets all webhooks for a <see cref="Space"/>.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.Webhook"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Webhook>> GetWebhooksCollection(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhook_definitions", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Webhook>>(Serializer);
var hooks = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<Webhook>(Serializer));
collection.Items = hooks;
return collection;
}
/// <summary>
/// Creates a webhook in a <see cref="Space"/>.
/// </summary>
/// <param name="webhook">The webhook to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.Webhook"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Webhook> CreateWebhook(Webhook webhook, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
//Not allowed to post system properties
webhook.SystemProperties = null;
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhook_definitions", ConvertObjectToJsonStringContent(webhook), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Webhook>(Serializer);
}
/// <summary>
/// Creates or updates a webhook in a <see cref="Space"/>. Updates if a webhook with the same id already exists.
/// </summary>
/// <param name="webhook">The webhook to create or update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.Webhook"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The id of the webhook parameter was null or empty.</exception>
public async Task<Webhook> CreateOrUpdateWebhook(Webhook webhook, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(webhook?.SystemProperties?.Id))
{
throw new ArgumentException("The id of the webhook must be set.");
}
var id = webhook.SystemProperties.Id;
//Not allowed to post system properties
webhook.SystemProperties = null;
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhook_definitions/{id}", ConvertObjectToJsonStringContent(webhook), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Webhook>(Serializer);
}
/// <summary>
/// Gets a single webhook from a <see cref="Space"/>.
/// </summary>
/// <param name="webhookId">The id of the webhook to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.Webhook"/>.</returns>
/// <exception cref="ArgumentException">The <see name="webhookId">webhookId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Webhook> GetWebhook(string webhookId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(webhookId))
{
throw new ArgumentException("The id of the webhook must be set.", nameof(webhookId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhook_definitions/{webhookId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Webhook>(Serializer);
}
/// <summary>
/// Deletes a webhook from a <see cref="Space"/>.
/// </summary>
/// <param name="webhookId">The id of the webhook to delete.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="webhookId">webhookId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task DeleteWebhook(string webhookId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(webhookId))
{
throw new ArgumentException("The id of the webhook must be set", nameof(webhookId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhook_definitions/{webhookId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Gets all recent call details for a webhook.
/// </summary>
/// <param name="webhookId">The id of the webhook to get details for.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.WebhookCallDetails"/>.</returns>
/// <exception cref="ArgumentException">The <see name="webhookId">webhookId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<WebhookCallDetails>> GetWebhookCallDetailsCollection(string webhookId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(webhookId))
{
throw new ArgumentException("The id of the webhook must be set.", nameof(webhookId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhooks/{webhookId}/calls", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<WebhookCallDetails>>(Serializer);
var hooks = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<WebhookCallDetails>(Serializer));
collection.Items = hooks;
return collection;
}
/// <summary>
/// Gets the details of a specific webhook call.
/// </summary>
/// <param name="callId">The id of the call to get details for.</param>
/// <param name="webhookId">The id of the webhook to get details for.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.WebhookCallDetails"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="webhookId">webhookId</see> or <see name="callId">callId</see> parameter was null or empty.</exception>
public async Task<WebhookCallDetails> GetWebhookCallDetails(string callId, string webhookId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(callId))
{
throw new ArgumentException("The id of the webhook call must be set.", nameof(callId));
}
if (string.IsNullOrEmpty(webhookId))
{
throw new ArgumentException("The id of the webhook must be set.", nameof(webhookId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhooks/{webhookId}/calls/{callId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<WebhookCallDetails>(Serializer);
}
/// <summary>
/// Gets a response containing an overview of the recent webhook calls.
/// </summary>
/// <param name="webhookId">The id of the webhook to get health details for.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="Contentful.Core.Models.Management.WebhookHealthResponse"/>.</returns>
/// <exception cref="ArgumentException">The <see name="webhookId">webhookId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<WebhookHealthResponse> GetWebhookHealth(string webhookId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(webhookId))
{
throw new ArgumentException("The id of the webhook must be set.", nameof(webhookId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/webhooks/{webhookId}/health", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var health = new WebhookHealthResponse()
{
SystemProperties = jsonObject["sys"]?.ToObject<SystemProperties>(Serializer),
TotalCalls = jsonObject["calls"]["total"].Value<int>(),
TotalHealthy = jsonObject["calls"]["healthy"].Value<int>()
};
return health;
}
/// <summary>
/// Gets a role by the specified id.
/// </summary>
/// <param name="roleId">The id of the role.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.Role"/></returns>
/// <exception cref="ArgumentException">The <see name="roleId">roleId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Role> GetRole(string roleId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(roleId))
{
throw new ArgumentException("The id of the role must be set", nameof(roleId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/roles/{roleId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Role>(Serializer);
}
/// <summary>
/// Gets all <see cref="Contentful.Core.Models.Management.Role">roles</see> of a space.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.Role"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Role>> GetAllRoles(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/roles", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Role>>(Serializer);
var roles = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<Role>(Serializer));
collection.Items = roles;
return collection;
}
/// <summary>
/// Creates a role in a <see cref="Space"/>.
/// </summary>
/// <param name="role">The role to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.Role"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Role> CreateRole(Role role, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
//Not allowed to post system properties
role.SystemProperties = null;
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/roles", ConvertObjectToJsonStringContent(role), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Role>(Serializer);
}
/// <summary>
/// Updates a role in a <see cref="Space"/>.
/// </summary>
/// <param name="role">The role to update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The updated <see cref="Contentful.Core.Models.Management.Role"/>.</returns>
/// <exception cref="ArgumentException">The id parameter of the role was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<Role> UpdateRole(Role role, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(role?.SystemProperties?.Id))
{
throw new ArgumentException("The id of the role must be set.");
}
var id = role.SystemProperties.Id;
//Not allowed to post system properties
role.SystemProperties = null;
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/roles/{id}", ConvertObjectToJsonStringContent(role), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Role>(Serializer);
}
/// <summary>
/// Deletes a role by the specified id.
/// </summary>
/// <param name="roleId">The id of the role to delete.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="roleId">roleId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task DeleteRole(string roleId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(roleId))
{
throw new ArgumentException("The id of the role must be set", nameof(roleId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/roles/{roleId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Gets all snapshots for an <see cref="Entry{T}"/>.
/// </summary>
/// <param name="entryId">The id of the entry to get snapshots for.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A collection of <see cref="Contentful.Core.Models.Management.Snapshot"/>.</returns>
public async Task<ContentfulCollection<Snapshot>> GetAllSnapshotsForEntry(string entryId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException("The id of the entry must be set", nameof(entryId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/snapshots", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Snapshot>>(Serializer);
var snapshots = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<Snapshot>(Serializer));
collection.Items = snapshots;
return collection;
}
/// <summary>
/// Gets a single snapshot for an <see cref="Entry{T}"/>
/// </summary>
/// <param name="snapshotId">The id of the snapshot to get.</param>
/// <param name="entryId">The id of entry the snapshot belongs to.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.Snapshot"/>.</returns>
public async Task<Snapshot> GetSnapshotForEntry(string snapshotId, string entryId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(snapshotId))
{
throw new ArgumentException("The id of the snapshot must be set.", nameof(snapshotId));
}
if (string.IsNullOrEmpty(entryId))
{
throw new ArgumentException("The id of the entry must be set.", nameof(entryId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/entries/{entryId}/snapshots/{snapshotId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<Snapshot>(Serializer);
}
/// <summary>
/// Gets all snapshots for a <see cref="ContentType"/>.
/// </summary>
/// <param name="contentTypeId">The id of the content type to get snapshots for.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A collection of <see cref="Contentful.Core.Models.Management.SnapshotContentType"/>.</returns>
public async Task<ContentfulCollection<SnapshotContentType>> GetAllSnapshotsForContentType(string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException("The id of the content type must be set.", nameof(contentTypeId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/snapshots", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<SnapshotContentType>>(Serializer);
var snapshots = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<SnapshotContentType>(Serializer));
collection.Items = snapshots;
return collection;
}
/// <summary>
/// Gets a single snapshot for a <see cref="ContentType"/>
/// </summary>
/// <param name="snapshotId">The id of the snapshot to get.</param>
/// <param name="contentTypeId">The id of content type the snapshot belongs to.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.SnapshotContentType"/>.</returns>
public async Task<SnapshotContentType> GetSnapshotForContentType(string snapshotId, string contentTypeId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(snapshotId))
{
throw new ArgumentException("The id of the snapshot must be set.", nameof(snapshotId));
}
if (string.IsNullOrEmpty(contentTypeId))
{
throw new ArgumentException("The id of the content type must be set.", nameof(contentTypeId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/content_types/{contentTypeId}/snapshots/{snapshotId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<SnapshotContentType>(Serializer);
}
/// <summary>
/// Gets a collection of <see cref="Contentful.Core.Models.Management.SpaceMembership"/> for the user.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A collection of <see cref="Contentful.Core.Models.Management.SpaceMembership"/>.</returns>
public async Task<ContentfulCollection<SpaceMembership>> GetSpaceMemberships(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/space_memberships", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<SpaceMembership>>(Serializer);
var memberships = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<SpaceMembership>(Serializer));
collection.Items = memberships;
return collection;
}
/// <summary>
/// Creates a membership in a <see cref="Space"/>.
/// </summary>
/// <param name="spaceMembership">The membership to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.SpaceMembership"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SpaceMembership> CreateSpaceMembership(SpaceMembership spaceMembership, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/space_memberships", ConvertObjectToJsonStringContent(spaceMembership), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<SpaceMembership>(Serializer);
}
/// <summary>
/// Gets a single <see cref="Contentful.Core.Models.Management.SpaceMembership"/> for a space.
/// </summary>
/// <param name="spaceMembershipId">The id of the space membership to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.SpaceMembership"/>.</returns>
/// <exception cref="ArgumentException">The <see name="spaceMembershipId">spaceMembershipId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SpaceMembership> GetSpaceMembership(string spaceMembershipId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(spaceMembershipId))
{
throw new ArgumentException("The id of the space membership must be set", nameof(spaceMembershipId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/space_memberships/{spaceMembershipId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<SpaceMembership>(Serializer);
}
/// <summary>
/// Updates a <see cref="Contentful.Core.Models.Management.SpaceMembership"/> for a space.
/// </summary>
/// <param name="spaceMembership">The membership to update.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.SpaceMembership"/>.</returns>
/// <exception cref="ArgumentException">The <see name="spaceMembership">spaceMembership</see> id was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<SpaceMembership> UpdateSpaceMembership(SpaceMembership spaceMembership, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(spaceMembership?.SystemProperties?.Id))
{
throw new ArgumentException("The id of the space membership id must be set", nameof(spaceMembership));
}
var res = await PutAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/space_memberships/{spaceMembership.SystemProperties.Id}", ConvertObjectToJsonStringContent(spaceMembership), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<SpaceMembership>(Serializer);
}
/// <summary>
/// Deletes a <see cref="Contentful.Core.Models.Management.SpaceMembership"/> for a space.
/// </summary>
/// <param name="spaceMembershipId">The id of the space membership to delete.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ArgumentException">The <see name="spaceMembershipId">spaceMembershipId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task DeleteSpaceMembership(string spaceMembershipId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(spaceMembershipId))
{
throw new ArgumentException("The id of the space membership must be set", nameof(spaceMembershipId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/space_memberships/{spaceMembershipId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Gets a collection of all <see cref="Contentful.Core.Models.Management.ApiKey"/> in a space.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.ApiKey"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<ApiKey>> GetAllApiKeys(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/api_keys", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<ApiKey>>(Serializer);
var keys = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<ApiKey>(Serializer));
collection.Items = keys;
return collection;
}
/// <summary>
/// Creates an <see cref="Contentful.Core.Models.Management.ApiKey"/> in a space.
/// </summary>
/// <param name="name">The name of the API key to create.</param>
/// <param name="description">The description of the API key to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.ApiKey"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ApiKey> CreateApiKey(string name, string description, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(name))
{
throw new ArgumentException("The name of the api key must be set.", nameof(name));
}
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/api_keys", ConvertObjectToJsonStringContent(new { name, description }), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ApiKey>(Serializer);
}
/// <summary>
/// Gets a collection of all <see cref="Contentful.Core.Models.Management.User"/> in a space.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.ApiKey"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<User>> GetAllUsers(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/users", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<User>>(Serializer);
var keys = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<User>(Serializer));
collection.Items = keys;
return collection;
}
/// <summary>
/// Gets a single <see cref="Contentful.Core.Models.Management.User"/> for a space.
/// </summary>
/// <param name="userId">The id of the user to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.User"/>.</returns>
/// <exception cref="ArgumentException">The <see name="spaceMembershipId">spaceMembershipId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<User> GetUser(string userId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(userId))
{
throw new ArgumentException("The id of the user must be set", nameof(userId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/users/{userId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<User>(Serializer);
}
/// <summary>
/// Gets a single <see cref="Contentful.Core.Models.Management.User"/> for the currently logged in user.
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.User"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<User> GetCurrentUser(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_directApiUrl}users/me", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<User>(Serializer);
}
/// <summary>
/// Gets an upload <see cref="SystemProperties"/> by the specified id.
/// </summary>
/// <param name="uploadId">The id of the uploaded file.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SystemProperties"/> with metadata of the upload.</returns>
public async Task<UploadReference> GetUpload(string uploadId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUploadUrl}{spaceId ?? _options.SpaceId}/uploads/{uploadId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<UploadReference>(Serializer);
}
/// <summary>
/// Uploads the specified bytes to Contentful.
/// </summary>
/// <param name="bytes">The bytes to upload.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SystemProperties"/> with an id of the created upload.</returns>
public async Task<UploadReference> UploadFile(byte[] bytes, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var byteArrayContent = new ByteArrayContent(bytes);
byteArrayContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream");
var res = await PostAsync($"{_baseUploadUrl}{spaceId ?? _options.SpaceId}/uploads", byteArrayContent, cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<UploadReference>(Serializer);
}
/// <summary>
/// Gets an upload <see cref="SystemProperties"/> by the specified id.
/// </summary>
/// <param name="uploadId">The id of the uploaded file.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="SystemProperties"/> with metadata of the upload.</returns>
public async Task DeleteUpload(string uploadId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await DeleteAsync($"{_baseUploadUrl}{spaceId ?? _options.SpaceId}/uploads/{uploadId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Uploads an array of bytes and creates an asset in Contentful as well as processing that asset.
/// </summary>
/// <param name="asset">The asset to create</param>
/// <param name="bytes">The bytes to upload.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.ManagementAsset"/>.</returns>
public async Task<ManagementAsset> UploadFileAndCreateAsset(ManagementAsset asset, byte[] bytes, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var upload = await UploadFile(bytes, spaceId, cancellationToken);
upload.SystemProperties.CreatedAt = null;
upload.SystemProperties.CreatedBy = null;
upload.SystemProperties.Space = null;
upload.SystemProperties.LinkType = "Upload";
foreach (var file in asset.Files)
{
file.Value.UploadReference = upload;
}
var createdAsset = await CreateOrUpdateAsset(asset);
foreach (var file in createdAsset.Files) {
await ProcessAsset(createdAsset.SystemProperties.Id, createdAsset.SystemProperties.Version ?? 1, file.Key);
}
return createdAsset;
}
/// <summary>
/// Gets a collection of all <see cref="Contentful.Core.Models.Management.UiExtension"/> for a space.
/// </summary>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.UiExtension"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<UiExtension>> GetAllExtensions(string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/extensions", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<UiExtension>>(Serializer);
var keys = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<UiExtension>(Serializer));
collection.Items = keys;
return collection;
}
/// <summary>
/// Creates a UiExtension in a <see cref="Space"/>.
/// </summary>
/// <param name="extension">The UI extension to create.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.UiExtension"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<UiExtension> CreateExtension(UiExtension extension, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await PostAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/extensions",
ConvertObjectToJsonStringContent(new
{
extension = new
{
src = extension.Src,
name = extension.Name,
fieldTypes = extension.FieldTypes?.Select(c => new { type = c }),
srcDoc = extension.SrcDoc,
sidebar = extension.Sidebar
}
}), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<UiExtension>(Serializer);
}
/// <summary>
/// Creates or updates a UI extension. Updates if an extension with the same id already exists.
/// </summary>
/// <param name="extension">The <see cref="Contentful.Core.Models.Management.UiExtension"/> to create or update. **Remember to set the id property.**</param>
/// <param name="spaceId">The id of the space to create the content type in. Will default to the one set when creating the client.</param>
/// <param name="version">The last version known of the extension. Must be set for existing extensions. Should be null if one is created.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created or updated <see cref="Contentful.Core.Models.Management.UiExtension"/>.</returns>
/// <exception cref="ArgumentException">Thrown if the id of the content type is not set.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<UiExtension> CreateOrUpdateExtension(UiExtension extension, string spaceId = null, int? version = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (extension.SystemProperties?.Id == null)
{
throw new ArgumentException("The id of the extension must be set.", nameof(extension));
}
AddVersionHeader(version);
var res = await PutAsync(
$"{_baseUrl}{spaceId ?? _options.SpaceId}/extensions/{extension.SystemProperties.Id}",
ConvertObjectToJsonStringContent(new
{
extension = new
{
src = extension.Src,
name = extension.Name,
fieldTypes = extension.FieldTypes?.Select(c => new { type = c }),
srcDoc = extension.SrcDoc,
sidebar = extension.Sidebar
}
}), cancellationToken).ConfigureAwait(false);
RemoveVersionHeader();
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var json = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return json.ToObject<UiExtension>(Serializer);
}
/// <summary>
/// Gets a single <see cref="Contentful.Core.Models.Management.UiExtension"/> for a space.
/// </summary>
/// <param name="extensionId">The id of the extension to get.</param>
/// <param name="spaceId">The id of the space. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.UiExtension"/>.</returns>
/// <exception cref="ArgumentException">The <see name="extensionId">extensionId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<UiExtension> GetExtension(string extensionId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(extensionId))
{
throw new ArgumentException("The id of the extension must be set", nameof(extensionId));
}
var res = await GetAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/extensions/{extensionId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<UiExtension>(Serializer);
}
/// <summary>
/// Deletes a <see cref="Contentful.Core.Models.Management.UiExtension"/> by the specified id.
/// </summary>
/// <param name="extensionId">The id of the extension.</param>
/// <param name="spaceId">The id of the space to delete the extension in. Will default to the one set when creating the client.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
/// <exception cref="ArgumentException">The <see name="contentTypeId">contentTypeId</see> parameter was null or empty</exception>
public async Task DeleteExtension(string extensionId, string spaceId = null, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(extensionId))
{
throw new ArgumentException(nameof(extensionId));
}
var res = await DeleteAsync($"{_baseUrl}{spaceId ?? _options.SpaceId}/extensions/{extensionId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
}
/// <summary>
/// Creates a CMA management token that can be used to access the Contentful Management API.
/// </summary>
/// <param name="token">The token to create.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The created <see cref="Contentful.Core.Models.Management.ManagementToken"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementToken> CreateManagementToken(ManagementToken token, CancellationToken cancellationToken = default(CancellationToken))
{
var res = await PostAsync($"{_directApiUrl}users/me/access_tokens",
ConvertObjectToJsonStringContent(new
{
name = token.Name,
scopes = token.Scopes
}), cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementToken>(Serializer);
}
/// <summary>
/// Gets a collection of all <see cref="Contentful.Core.Models.Management.ManagementToken"/> for a user. **Note that the actual token will not be part of the response.
/// It is only available directly after creation of a token for security reasons.**
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.Organization"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<ManagementToken>> GetAllManagementTokens(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_directApiUrl}users/me/access_tokens", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<ManagementToken>>(Serializer);
var keys = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<ManagementToken>(Serializer));
collection.Items = keys;
return collection;
}
/// <summary>
/// Gets a single <see cref="Contentful.Core.Models.Management.ManagementToken"/> for a user.
/// </summary>
/// <param name="managementTokenId">The id of the management token to get.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The <see cref="Contentful.Core.Models.Management.ManagementToken"/>.</returns>
/// <exception cref="ArgumentException">The <see name="managementTokenId">managementTokenId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementToken> GetManagementToken(string managementTokenId, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(managementTokenId))
{
throw new ArgumentException("The id of the token must be set", nameof(managementTokenId));
}
var res = await GetAsync($"{_directApiUrl}users/me/access_tokens/{managementTokenId}", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementToken>(Serializer);
}
/// <summary>
/// Revokes a single <see cref="Contentful.Core.Models.Management.ManagementToken"/> for a user.
/// </summary>
/// <param name="managementTokenId">The id of the management token to revoke.</param>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>The revoked <see cref="Contentful.Core.Models.Management.ManagementToken"/>.</returns>
/// <exception cref="ArgumentException">The <see name="managementTokenId">managementTokenId</see> parameter was null or empty.</exception>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ManagementToken> RevokeManagementToken(string managementTokenId, CancellationToken cancellationToken = default(CancellationToken))
{
if (string.IsNullOrEmpty(managementTokenId))
{
throw new ArgumentException("The id of the token must be set", nameof(managementTokenId));
}
var res = await PutAsync($"{_directApiUrl}users/me/access_tokens/{managementTokenId}/revoked", null, cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
return jsonObject.ToObject<ManagementToken>(Serializer);
}
/// <summary>
/// Gets a collection of all <see cref="Contentful.Core.Models.Management.Organization"/> for a user.
/// </summary>
/// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
/// <returns>A <see cref="ContentfulCollection{T}"/> of <see cref="Contentful.Core.Models.Management.Organization"/>.</returns>
/// <exception cref="ContentfulException">There was an error when communicating with the Contentful API.</exception>
public async Task<ContentfulCollection<Organization>> GetOrganizations(CancellationToken cancellationToken = default(CancellationToken))
{
var res = await GetAsync($"{_directApiUrl}organizations", cancellationToken).ConfigureAwait(false);
await EnsureSuccessfulResult(res).ConfigureAwait(false);
var jsonObject = JObject.Parse(await res.Content.ReadAsStringAsync().ConfigureAwait(false));
var collection = jsonObject.ToObject<ContentfulCollection<Organization>>(Serializer);
var orgs = jsonObject.SelectTokens("$..items[*]").Select(c => c.ToObject<Organization>(Serializer));
collection.Items = orgs;
return collection;
}
private async Task<HttpResponseMessage> PostAsync(string url, HttpContent content, CancellationToken cancellationToken)
{
return await SendHttpRequest(url, HttpMethod.Post, _options.ManagementApiKey, cancellationToken, content).ConfigureAwait(false);
}
private async Task<HttpResponseMessage> PutAsync(string url, HttpContent content, CancellationToken cancellationToken)
{
return await SendHttpRequest(url, HttpMethod.Put, _options.ManagementApiKey, cancellationToken, content).ConfigureAwait(false);
}
private async Task<HttpResponseMessage> DeleteAsync(string url, CancellationToken cancellationToken)
{
return await SendHttpRequest(url, HttpMethod.Delete, _options.ManagementApiKey, cancellationToken).ConfigureAwait(false);
}
private async Task<HttpResponseMessage> GetAsync(string url, CancellationToken cancellationToken)
{
return await SendHttpRequest(url, HttpMethod.Get, _options.ManagementApiKey, cancellationToken).ConfigureAwait(false);
}
private string ConvertObjectToJsonString(object ob)
{
var resolver = new CamelCasePropertyNamesContractResolver();
resolver.NamingStrategy.OverrideSpecifiedNames = false;
var serializedObject = JsonConvert.SerializeObject(ob, new JsonSerializerSettings
{
ContractResolver = resolver
});
return serializedObject;
}
private StringContent ConvertObjectToJsonStringContent(object ob)
{
var serializedObject = ConvertObjectToJsonString(ob);
return new StringContent(serializedObject, Encoding.UTF8, "application/vnd.contentful.management.v1+json");
}
}
}