-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathAsset.cs
More file actions
376 lines (338 loc) · 17.1 KB
/
Asset.cs
File metadata and controls
376 lines (338 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
using System;
using System.Threading.Tasks;
using Contentstack.Management.Core.Queryable;
using Contentstack.Management.Core.Services.Models;
namespace Contentstack.Management.Core.Models
{
public class Asset
{
internal Stack stack;
public string Uid { get; set; }
internal string resourcePath;
internal Asset(Stack stack, string uid = null)
{
stack.ThrowIfAPIKeyEmpty();
this.stack = stack;
Uid = uid;
resourcePath = uid == null ? "/assets" : $"/assets/{uid}";
}
/// <summary>
/// The Query on Asset will allow to fetch details of all Assets.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset().Query().Find();
/// </code></pre>
/// </example>
/// <returns>The <see cref="Queryable.Query"/></returns>
public Query Query()
{
ThrowIfUidNotEmpty();
return new Query(stack, resourcePath);
}
/// <summary>
/// The Folder allows to fetch and create folders in assets.
/// </summary>
/// <param name="uid"></param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset().Folder().Create();
/// </code></pre>
/// </example>
/// <returns>The <see cref="Models.Folder"/></returns>
public Folder Folder(string uid = null)
{
ThrowIfUidNotEmpty();
return new Folder(stack, uid);
}
/// <summary>
/// The Versioning on Asset will allow to fetch all version, delete specific version or naming the asset version.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Version().GetAll();
/// </code></pre>
/// </example>
/// <returns>The <see cref="Models.Version"/></returns>
public Version Version(int? versionNumber = null)
{
ThrowIfUidEmpty();
return new Version(stack, resourcePath, "asset", versionNumber);
}
/// <summary>
/// The Upload asset request uploads an asset file to your stack.
/// </summary>
/// <param name="model">Asset Model with details.</param>
/// <param name="collection">Query parameters</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// AssetModel model = new AssetModel("ASSET_NAME", "FILE_PATH", "FILE_CONTENT_TYPE");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset().Create(model);
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Create(AssetModel model, ParameterCollection collection = null)
{
ThrowIfUidNotEmpty();
var service = new UploadService(stack.client.serializer, stack, resourcePath, model);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Upload asset request uploads an asset file to your stack.
/// </summary>
/// <param name="model">Asset Model with details.</param>
/// <param name="collection">Query parameters</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// AssetModel model = new AssetModel("ASSET_NAME", "FILE_PATH", "FILE_CONTENT_TYPE");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset().CreateAsync(model);
/// </code></pre>
/// </example>
/// <returns>The Task.</returns>
public virtual Task<ContentstackResponse> CreateAsync(AssetModel model, ParameterCollection collection = null)
{
ThrowIfUidNotEmpty();
stack.ThrowIfNotLoggedIn();
var service = new UploadService(stack.client.serializer, stack, resourcePath, model);
return stack.client.InvokeAsync<UploadService, ContentstackResponse>(service, true);
}
/// <summary>
/// The Replace asset call will replace an existing asset with another file on the stack.
/// </summary>
/// <param name="model">Asset Model with details.</param>
/// <param name="collection">Query parameters</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// AssetModel model = new AssetModel("ASSET_NAME", "FILE_PATH", "FILE_CONTENT_TYPE");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Update(model);
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Update(AssetModel model, ParameterCollection collection = null)
{
ThrowIfUidEmpty();
var service = new UploadService(stack.client.serializer, stack, resourcePath, model, "PUT");
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Replace asset call will replace an existing asset with another file on the stack.
/// </summary>
/// <param name="model">Asset Model with details.</param>
/// <param name="collection">Query parameters</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// AssetModel model = new AssetModel("ASSET_NAME", "FILE_PATH", "FILE_CONTENT_TYPE");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").UpdateAsync(model);
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> UpdateAsync(AssetModel model, ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new UploadService(stack.client.serializer, stack, resourcePath, model, "PUT");
return stack.client.InvokeAsync<UploadService, ContentstackResponse>(service, true);
}
/// <summary>
/// The Get an asset call returns comprehensive information about a specific version of an asset of a stack.
/// </summary>
/// <param name="collection">Query parameter</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Fetch();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Fetch(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchDeleteService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Get an asset call returns comprehensive information about a specific version of an asset of a stack.
/// </summary>
/// <param name="collection">Query parameter</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").FetchAsync();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> FetchAsync(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchDeleteService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeAsync<FetchDeleteService, ContentstackResponse>(service, true);
}
/// <summary>
/// The Delete asset call will delete an existing asset from the stack
/// </summary>
/// <param name="collection">Query parameter</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Delete();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Delete()
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchDeleteService(stack.client.serializer, stack, resourcePath, "DELETE");
return stack.client.InvokeSync(service);
}
/// <summary>
/// The Delete asset call will delete an existing asset from the stack
/// </summary>
/// <param name="collection">Query parameter</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").DeleteAsync();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> DeleteAsync()
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchDeleteService(stack.client.serializer, stack, resourcePath, "DELETE");
return stack.client.InvokeAsync<FetchDeleteService, ContentstackResponse>(service, true);
}
/// <summary>
/// The Publish an asset call is used to publish a specific version of an asset on the desired environment either immediately or at a later date/time.
/// </summary>
/// <param name="details">Publish details.</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Publish(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Publish(PublishUnpublishDetails details, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/publish", "asset");
return stack.client.InvokeSync(service, apiVersion: apiVersion);
}
/// <summary>
/// The Publish an asset call is used to publish a specific version of an asset on the desired environment either immediately or at a later date/time.
/// </summary>
/// <param name="details">Publish details.</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").PublishAsync(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> PublishAsync(PublishUnpublishDetails details, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/publish", "asset");
return stack.client.InvokeAsync<PublishUnpublishService, ContentstackResponse>(service, apiVersion: apiVersion);
}
/// <summary>
/// The Unpublish an asset call is used to unpublish a specific version of an asset from a desired environment.
/// </summary>
/// <param name="details">Publish details.</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").Unpublish(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse Unpublish(PublishUnpublishDetails details, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/unpublish", "asset");
return stack.client.InvokeSync(service, apiVersion: apiVersion);
}
/// <summary>
/// The Unpublish an asset call is used to unpublish a specific version of an asset from a desired environment.
/// </summary>
/// <param name="details">Publish details.</param>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").UnpublishAsync(new PublishUnpublishDetails());
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> UnpublishAsync(PublishUnpublishDetails details, string apiVersion = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new PublishUnpublishService(stack.client.serializer, stack, details, $"{resourcePath}/unpublish", "asset");
return stack.client.InvokeAsync<PublishUnpublishService, ContentstackResponse>(service, apiVersion: apiVersion);
}
/// <summary>
/// The References request returns the details of the entries and the content types in which the specified asset is referenced.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = client.Stack("<API_KEY>").Asset("<ASSET_UID>").References();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual ContentstackResponse References(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchReferencesService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeSync(service);
}
/// <summary>
/// The ReferencesAsync request returns the details of the entries and the content types in which the specified asset is referenced.
/// </summary>
/// <example>
/// <pre><code>
/// ContentstackClient client = new ContentstackClient("<AUTHTOKEN>", "<API_HOST>");
/// ContentstackResponse contentstackResponse = await client.Stack("<API_KEY>").Asset("<ASSET_UID>").ReferencesAsync();
/// </code></pre>
/// </example>
/// <returns>The <see cref="ContentstackResponse"/>.</returns>
public virtual Task<ContentstackResponse> ReferencesAsync(ParameterCollection collection = null)
{
stack.ThrowIfNotLoggedIn();
ThrowIfUidEmpty();
var service = new FetchReferencesService(stack.client.serializer, stack, resourcePath, collection: collection);
return stack.client.InvokeAsync<FetchReferencesService, ContentstackResponse>(service);
}
#region Throw Error
internal void ThrowIfUidNotEmpty()
{
if (!string.IsNullOrEmpty(this.Uid))
{
throw new InvalidOperationException("Operation not allowed.");
}
}
internal void ThrowIfUidEmpty()
{
if (string.IsNullOrEmpty(this.Uid))
{
throw new InvalidOperationException("Uid can not be empty.");
}
}
#endregion
}
}