@wix/media 1.0.110 → 1.0.112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +6 -6
- package/type-bundles/context.bundle.d.ts +668 -228
- package/type-bundles/index.bundle.d.ts +668 -228
- package/type-bundles/meta.bundle.d.ts +16 -16
|
@@ -1,3 +1,47 @@
|
|
|
1
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
|
+
interface HttpClient {
|
|
3
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
|
+
fetchWithAuth: typeof fetch;
|
|
5
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
6
|
+
}
|
|
7
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
|
+
type HttpResponse<T = any> = {
|
|
9
|
+
data: T;
|
|
10
|
+
status: number;
|
|
11
|
+
statusText: string;
|
|
12
|
+
headers: any;
|
|
13
|
+
request?: any;
|
|
14
|
+
};
|
|
15
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
16
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
17
|
+
url: string;
|
|
18
|
+
data?: Data;
|
|
19
|
+
params?: URLSearchParams;
|
|
20
|
+
} & APIMetadata;
|
|
21
|
+
type APIMetadata = {
|
|
22
|
+
methodFqn?: string;
|
|
23
|
+
entityFqdn?: string;
|
|
24
|
+
packageName?: string;
|
|
25
|
+
};
|
|
26
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
27
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
28
|
+
__type: 'event-definition';
|
|
29
|
+
type: Type;
|
|
30
|
+
isDomainEvent?: boolean;
|
|
31
|
+
transformations?: (envelope: unknown) => Payload;
|
|
32
|
+
__payload: Payload;
|
|
33
|
+
};
|
|
34
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
35
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
36
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
37
|
+
|
|
38
|
+
declare global {
|
|
39
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
40
|
+
interface SymbolConstructor {
|
|
41
|
+
readonly observable: symbol;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
|
|
1
45
|
interface EnterpriseCategory {
|
|
2
46
|
/**
|
|
3
47
|
* Id of the category
|
|
@@ -336,84 +380,80 @@ interface EnterpriseOnboardingOptions {
|
|
|
336
380
|
accountName?: string;
|
|
337
381
|
}
|
|
338
382
|
|
|
339
|
-
|
|
340
|
-
interface
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
383
|
+
declare function createCategory$1(httpClient: HttpClient): CreateCategorySignature;
|
|
384
|
+
interface CreateCategorySignature {
|
|
385
|
+
/**
|
|
386
|
+
* Fetch a list of random media from different providers, using site information to customize results when available
|
|
387
|
+
* @param - The category object that will be created
|
|
388
|
+
* @returns A list of items matching the request
|
|
389
|
+
*/
|
|
390
|
+
(category: EnterpriseCategory): Promise<EnterpriseCategory & EnterpriseCategoryNonNullableFields>;
|
|
344
391
|
}
|
|
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
|
-
|
|
392
|
+
declare function deleteCategory$1(httpClient: HttpClient): DeleteCategorySignature;
|
|
393
|
+
interface DeleteCategorySignature {
|
|
394
|
+
/**
|
|
395
|
+
* Delete a category including all its subcategories - but not the items
|
|
396
|
+
* @param - Category id
|
|
397
|
+
*/
|
|
398
|
+
(categoryId: string): Promise<void>;
|
|
399
|
+
}
|
|
400
|
+
declare function updateCategory$1(httpClient: HttpClient): UpdateCategorySignature;
|
|
401
|
+
interface UpdateCategorySignature {
|
|
402
|
+
/**
|
|
403
|
+
* Update category details
|
|
404
|
+
* @param - Id of the category
|
|
405
|
+
* @returns The updated category
|
|
406
|
+
*/
|
|
407
|
+
(_id: string, category: UpdateCategory): Promise<EnterpriseCategory & EnterpriseCategoryNonNullableFields>;
|
|
408
|
+
}
|
|
409
|
+
declare function getCategory$1(httpClient: HttpClient): GetCategorySignature;
|
|
410
|
+
interface GetCategorySignature {
|
|
411
|
+
/**
|
|
412
|
+
* Get information about a specific category
|
|
413
|
+
* @param - Category id
|
|
414
|
+
* @returns The category details
|
|
415
|
+
*/
|
|
416
|
+
(categoryId: string, options?: GetCategoryOptions | undefined): Promise<EnterpriseCategoryTree & EnterpriseCategoryTreeNonNullableFields>;
|
|
417
|
+
}
|
|
418
|
+
declare function enterpriseOnboarding$1(httpClient: HttpClient): EnterpriseOnboardingSignature;
|
|
419
|
+
interface EnterpriseOnboardingSignature {
|
|
420
|
+
/**
|
|
421
|
+
* Create the enterprise category under "enterprise-media" main category
|
|
422
|
+
* the caller identity must be have the same accountId of the request
|
|
423
|
+
* @param - The account id of the organization - will be used as the organization category id
|
|
424
|
+
*/
|
|
425
|
+
(accountId: string, options?: EnterpriseOnboardingOptions | undefined): Promise<EnterpriseOnboardingResponse & EnterpriseOnboardingResponseNonNullableFields>;
|
|
426
|
+
}
|
|
427
|
+
declare function getMediaManagerCategories$1(httpClient: HttpClient): GetMediaManagerCategoriesSignature;
|
|
428
|
+
interface GetMediaManagerCategoriesSignature {
|
|
429
|
+
/**
|
|
430
|
+
* Get the account category tree details
|
|
431
|
+
*/
|
|
432
|
+
(): Promise<GetMediaManagerCategoriesResponse & GetMediaManagerCategoriesResponseNonNullableFields>;
|
|
381
433
|
}
|
|
382
|
-
|
|
383
|
-
declare function createCategory$1(httpClient: HttpClient): (category: EnterpriseCategory) => Promise<EnterpriseCategory & EnterpriseCategoryNonNullableFields>;
|
|
384
|
-
declare function deleteCategory$1(httpClient: HttpClient): (categoryId: string) => Promise<void>;
|
|
385
|
-
declare function updateCategory$1(httpClient: HttpClient): (_id: string, category: UpdateCategory) => Promise<EnterpriseCategory & EnterpriseCategoryNonNullableFields>;
|
|
386
|
-
declare function getCategory$1(httpClient: HttpClient): (categoryId: string, options?: GetCategoryOptions) => Promise<EnterpriseCategoryTree & EnterpriseCategoryTreeNonNullableFields>;
|
|
387
|
-
declare function enterpriseOnboarding$1(httpClient: HttpClient): (accountId: string, options?: EnterpriseOnboardingOptions) => Promise<EnterpriseOnboardingResponse & EnterpriseOnboardingResponseNonNullableFields>;
|
|
388
|
-
declare function getMediaManagerCategories$1(httpClient: HttpClient): () => Promise<GetMediaManagerCategoriesResponse & GetMediaManagerCategoriesResponseNonNullableFields>;
|
|
389
434
|
declare const onEnterpriseCategoryCreated$1: EventDefinition<EnterpriseCategoryCreatedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_category_created">;
|
|
390
435
|
declare const onEnterpriseCategoryDeleted$1: EventDefinition<EnterpriseCategoryDeletedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_category_deleted">;
|
|
391
436
|
declare const onEnterpriseCategoryUpdated$1: EventDefinition<EnterpriseCategoryUpdatedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_category_updated">;
|
|
392
437
|
|
|
393
|
-
declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
394
|
-
|
|
395
438
|
declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
396
439
|
|
|
397
|
-
|
|
398
|
-
declare const
|
|
399
|
-
|
|
400
|
-
declare const
|
|
401
|
-
|
|
402
|
-
declare const
|
|
403
|
-
type _publicGetCategoryType = typeof getCategory$1;
|
|
404
|
-
declare const getCategory: ReturnType<typeof createRESTModule$3<_publicGetCategoryType>>;
|
|
405
|
-
type _publicEnterpriseOnboardingType = typeof enterpriseOnboarding$1;
|
|
406
|
-
declare const enterpriseOnboarding: ReturnType<typeof createRESTModule$3<_publicEnterpriseOnboardingType>>;
|
|
407
|
-
type _publicGetMediaManagerCategoriesType = typeof getMediaManagerCategories$1;
|
|
408
|
-
declare const getMediaManagerCategories: ReturnType<typeof createRESTModule$3<_publicGetMediaManagerCategoriesType>>;
|
|
440
|
+
declare const createCategory: BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1;
|
|
441
|
+
declare const deleteCategory: BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1;
|
|
442
|
+
declare const updateCategory: BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1;
|
|
443
|
+
declare const getCategory: BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1;
|
|
444
|
+
declare const enterpriseOnboarding: BuildRESTFunction<typeof enterpriseOnboarding$1> & typeof enterpriseOnboarding$1;
|
|
445
|
+
declare const getMediaManagerCategories: BuildRESTFunction<typeof getMediaManagerCategories$1> & typeof getMediaManagerCategories$1;
|
|
409
446
|
|
|
410
447
|
type _publicOnEnterpriseCategoryCreatedType = typeof onEnterpriseCategoryCreated$1;
|
|
448
|
+
/** */
|
|
411
449
|
declare const onEnterpriseCategoryCreated: ReturnType<typeof createEventModule$3<_publicOnEnterpriseCategoryCreatedType>>;
|
|
412
450
|
|
|
413
451
|
type _publicOnEnterpriseCategoryDeletedType = typeof onEnterpriseCategoryDeleted$1;
|
|
452
|
+
/** */
|
|
414
453
|
declare const onEnterpriseCategoryDeleted: ReturnType<typeof createEventModule$3<_publicOnEnterpriseCategoryDeletedType>>;
|
|
415
454
|
|
|
416
455
|
type _publicOnEnterpriseCategoryUpdatedType = typeof onEnterpriseCategoryUpdated$1;
|
|
456
|
+
/** */
|
|
417
457
|
declare const onEnterpriseCategoryUpdated: ReturnType<typeof createEventModule$3<_publicOnEnterpriseCategoryUpdatedType>>;
|
|
418
458
|
|
|
419
459
|
type index_d$3_CreateCategoryRequest = CreateCategoryRequest;
|
|
@@ -447,15 +487,9 @@ type index_d$3_UpdateCategory = UpdateCategory;
|
|
|
447
487
|
type index_d$3_UpdateCategoryRequest = UpdateCategoryRequest;
|
|
448
488
|
type index_d$3_UpdateCategoryResponse = UpdateCategoryResponse;
|
|
449
489
|
type index_d$3_UpdateCategoryResponseNonNullableFields = UpdateCategoryResponseNonNullableFields;
|
|
450
|
-
type index_d$3__publicCreateCategoryType = _publicCreateCategoryType;
|
|
451
|
-
type index_d$3__publicDeleteCategoryType = _publicDeleteCategoryType;
|
|
452
|
-
type index_d$3__publicEnterpriseOnboardingType = _publicEnterpriseOnboardingType;
|
|
453
|
-
type index_d$3__publicGetCategoryType = _publicGetCategoryType;
|
|
454
|
-
type index_d$3__publicGetMediaManagerCategoriesType = _publicGetMediaManagerCategoriesType;
|
|
455
490
|
type index_d$3__publicOnEnterpriseCategoryCreatedType = _publicOnEnterpriseCategoryCreatedType;
|
|
456
491
|
type index_d$3__publicOnEnterpriseCategoryDeletedType = _publicOnEnterpriseCategoryDeletedType;
|
|
457
492
|
type index_d$3__publicOnEnterpriseCategoryUpdatedType = _publicOnEnterpriseCategoryUpdatedType;
|
|
458
|
-
type index_d$3__publicUpdateCategoryType = _publicUpdateCategoryType;
|
|
459
493
|
declare const index_d$3_createCategory: typeof createCategory;
|
|
460
494
|
declare const index_d$3_deleteCategory: typeof deleteCategory;
|
|
461
495
|
declare const index_d$3_enterpriseOnboarding: typeof enterpriseOnboarding;
|
|
@@ -466,7 +500,7 @@ declare const index_d$3_onEnterpriseCategoryDeleted: typeof onEnterpriseCategory
|
|
|
466
500
|
declare const index_d$3_onEnterpriseCategoryUpdated: typeof onEnterpriseCategoryUpdated;
|
|
467
501
|
declare const index_d$3_updateCategory: typeof updateCategory;
|
|
468
502
|
declare namespace index_d$3 {
|
|
469
|
-
export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$3_CreateCategoryRequest as CreateCategoryRequest, type index_d$3_CreateCategoryResponse as CreateCategoryResponse, type index_d$3_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, type index_d$3_DeleteCategoryRequest as DeleteCategoryRequest, type index_d$3_DeleteCategoryResponse as DeleteCategoryResponse, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type index_d$3_EnterpriseCategory as EnterpriseCategory, type index_d$3_EnterpriseCategoryCreatedEnvelope as EnterpriseCategoryCreatedEnvelope, type index_d$3_EnterpriseCategoryDeletedEnvelope as EnterpriseCategoryDeletedEnvelope, type index_d$3_EnterpriseCategoryNonNullableFields as EnterpriseCategoryNonNullableFields, type index_d$3_EnterpriseCategoryTree as EnterpriseCategoryTree, type index_d$3_EnterpriseCategoryTreeNonNullableFields as EnterpriseCategoryTreeNonNullableFields, type index_d$3_EnterpriseCategoryUpdatedEnvelope as EnterpriseCategoryUpdatedEnvelope, type index_d$3_EnterpriseOnboardingOptions as EnterpriseOnboardingOptions, type index_d$3_EnterpriseOnboardingRequest as EnterpriseOnboardingRequest, type index_d$3_EnterpriseOnboardingResponse as EnterpriseOnboardingResponse, type index_d$3_EnterpriseOnboardingResponseNonNullableFields as EnterpriseOnboardingResponseNonNullableFields, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type index_d$3_GetCategoryOptions as GetCategoryOptions, type index_d$3_GetCategoryRequest as GetCategoryRequest, type index_d$3_GetCategoryResponse as GetCategoryResponse, type index_d$3_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type index_d$3_GetMediaManagerCategoriesRequest as GetMediaManagerCategoriesRequest, type index_d$3_GetMediaManagerCategoriesResponse as GetMediaManagerCategoriesResponse, type index_d$3_GetMediaManagerCategoriesResponseNonNullableFields as GetMediaManagerCategoriesResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type index_d$3_LinkItemsToCategoryRequest as LinkItemsToCategoryRequest, type index_d$3_LinkItemsToCategoryResponse as LinkItemsToCategoryResponse, MediaType$2 as MediaType, type MessageEnvelope$3 as MessageEnvelope, PublishStatus$1 as PublishStatus, type index_d$3_UnlinkItemsFromCategoryRequest as UnlinkItemsFromCategoryRequest, type index_d$3_UnlinkItemsFromCategoryResponse as UnlinkItemsFromCategoryResponse, type index_d$3_UpdateCategory as UpdateCategory, type index_d$3_UpdateCategoryRequest as UpdateCategoryRequest, type index_d$3_UpdateCategoryResponse as UpdateCategoryResponse, type index_d$3_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, WebhookIdentityType$3 as WebhookIdentityType, type index_d$
|
|
503
|
+
export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$3_CreateCategoryRequest as CreateCategoryRequest, type index_d$3_CreateCategoryResponse as CreateCategoryResponse, type index_d$3_CreateCategoryResponseNonNullableFields as CreateCategoryResponseNonNullableFields, type index_d$3_DeleteCategoryRequest as DeleteCategoryRequest, type index_d$3_DeleteCategoryResponse as DeleteCategoryResponse, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type index_d$3_EnterpriseCategory as EnterpriseCategory, type index_d$3_EnterpriseCategoryCreatedEnvelope as EnterpriseCategoryCreatedEnvelope, type index_d$3_EnterpriseCategoryDeletedEnvelope as EnterpriseCategoryDeletedEnvelope, type index_d$3_EnterpriseCategoryNonNullableFields as EnterpriseCategoryNonNullableFields, type index_d$3_EnterpriseCategoryTree as EnterpriseCategoryTree, type index_d$3_EnterpriseCategoryTreeNonNullableFields as EnterpriseCategoryTreeNonNullableFields, type index_d$3_EnterpriseCategoryUpdatedEnvelope as EnterpriseCategoryUpdatedEnvelope, type index_d$3_EnterpriseOnboardingOptions as EnterpriseOnboardingOptions, type index_d$3_EnterpriseOnboardingRequest as EnterpriseOnboardingRequest, type index_d$3_EnterpriseOnboardingResponse as EnterpriseOnboardingResponse, type index_d$3_EnterpriseOnboardingResponseNonNullableFields as EnterpriseOnboardingResponseNonNullableFields, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type index_d$3_GetCategoryOptions as GetCategoryOptions, type index_d$3_GetCategoryRequest as GetCategoryRequest, type index_d$3_GetCategoryResponse as GetCategoryResponse, type index_d$3_GetCategoryResponseNonNullableFields as GetCategoryResponseNonNullableFields, type index_d$3_GetMediaManagerCategoriesRequest as GetMediaManagerCategoriesRequest, type index_d$3_GetMediaManagerCategoriesResponse as GetMediaManagerCategoriesResponse, type index_d$3_GetMediaManagerCategoriesResponseNonNullableFields as GetMediaManagerCategoriesResponseNonNullableFields, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type index_d$3_LinkItemsToCategoryRequest as LinkItemsToCategoryRequest, type index_d$3_LinkItemsToCategoryResponse as LinkItemsToCategoryResponse, MediaType$2 as MediaType, type MessageEnvelope$3 as MessageEnvelope, PublishStatus$1 as PublishStatus, type index_d$3_UnlinkItemsFromCategoryRequest as UnlinkItemsFromCategoryRequest, type index_d$3_UnlinkItemsFromCategoryResponse as UnlinkItemsFromCategoryResponse, type index_d$3_UpdateCategory as UpdateCategory, type index_d$3_UpdateCategoryRequest as UpdateCategoryRequest, type index_d$3_UpdateCategoryResponse as UpdateCategoryResponse, type index_d$3_UpdateCategoryResponseNonNullableFields as UpdateCategoryResponseNonNullableFields, WebhookIdentityType$3 as WebhookIdentityType, type index_d$3__publicOnEnterpriseCategoryCreatedType as _publicOnEnterpriseCategoryCreatedType, type index_d$3__publicOnEnterpriseCategoryDeletedType as _publicOnEnterpriseCategoryDeletedType, type index_d$3__publicOnEnterpriseCategoryUpdatedType as _publicOnEnterpriseCategoryUpdatedType, index_d$3_createCategory as createCategory, index_d$3_deleteCategory as deleteCategory, index_d$3_enterpriseOnboarding as enterpriseOnboarding, index_d$3_getCategory as getCategory, index_d$3_getMediaManagerCategories as getMediaManagerCategories, index_d$3_onEnterpriseCategoryCreated as onEnterpriseCategoryCreated, index_d$3_onEnterpriseCategoryDeleted as onEnterpriseCategoryDeleted, index_d$3_onEnterpriseCategoryUpdated as onEnterpriseCategoryUpdated, onEnterpriseCategoryCreated$1 as publicOnEnterpriseCategoryCreated, onEnterpriseCategoryDeleted$1 as publicOnEnterpriseCategoryDeleted, onEnterpriseCategoryUpdated$1 as publicOnEnterpriseCategoryUpdated, index_d$3_updateCategory as updateCategory };
|
|
470
504
|
}
|
|
471
505
|
|
|
472
506
|
/**
|
|
@@ -1296,59 +1330,135 @@ interface OverwriteItemCategoriesOptions {
|
|
|
1296
1330
|
categoryIds?: string[];
|
|
1297
1331
|
}
|
|
1298
1332
|
|
|
1299
|
-
declare function itemUploadCallback$1(httpClient: HttpClient):
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
declare function
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1333
|
+
declare function itemUploadCallback$1(httpClient: HttpClient): ItemUploadCallbackSignature;
|
|
1334
|
+
interface ItemUploadCallbackSignature {
|
|
1335
|
+
/**
|
|
1336
|
+
* Internal API called by the public media backend, notify about a file that was created enterprise public media server
|
|
1337
|
+
*/
|
|
1338
|
+
(options?: ItemUploadCallbackOptions | undefined): Promise<void>;
|
|
1339
|
+
}
|
|
1340
|
+
declare function generateFileUploadUrl$3(httpClient: HttpClient): GenerateFileUploadUrlSignature$1;
|
|
1341
|
+
interface GenerateFileUploadUrlSignature$1 {
|
|
1342
|
+
/**
|
|
1343
|
+
* Generate an upload url that will make public media to call the enterprise callback endpoint
|
|
1344
|
+
*/
|
|
1345
|
+
(options?: GenerateFileUploadUrlOptions$1 | undefined): Promise<GenerateFileUploadUrlResponse$1 & GenerateFileUploadUrlResponseNonNullableFields$1>;
|
|
1346
|
+
}
|
|
1347
|
+
declare function importFile$3(httpClient: HttpClient): ImportFileSignature$1;
|
|
1348
|
+
interface ImportFileSignature$1 {
|
|
1349
|
+
/**
|
|
1350
|
+
* Import a file using a url
|
|
1351
|
+
* @param - The url to the file to be imported
|
|
1352
|
+
*/
|
|
1353
|
+
(url: string, options?: ImportFileOptions$1 | undefined): Promise<ImportFileResponse$1 & ImportFileResponseNonNullableFields$1>;
|
|
1354
|
+
}
|
|
1355
|
+
declare function searchItems$1(httpClient: HttpClient): SearchItemsSignature;
|
|
1356
|
+
interface SearchItemsSignature {
|
|
1357
|
+
/**
|
|
1358
|
+
* Search items, all filters only support equality
|
|
1359
|
+
* Each query must contain a categoryId filter
|
|
1360
|
+
*/
|
|
1361
|
+
(options?: SearchItemsOptions | undefined): Promise<SearchItemsResponse & SearchItemsResponseNonNullableFields>;
|
|
1362
|
+
}
|
|
1363
|
+
declare function queryItems$1(httpClient: HttpClient): QueryItemsSignature;
|
|
1364
|
+
interface QueryItemsSignature {
|
|
1365
|
+
/**
|
|
1366
|
+
* Query items allowing to sort by specified fields, all filters only support equality
|
|
1367
|
+
* Each query must contain a categoryId filter
|
|
1368
|
+
*/
|
|
1369
|
+
(): ItemsQueryBuilder;
|
|
1370
|
+
}
|
|
1371
|
+
declare function updateItem$1(httpClient: HttpClient): UpdateItemSignature;
|
|
1372
|
+
interface UpdateItemSignature {
|
|
1373
|
+
/**
|
|
1374
|
+
* Update an item
|
|
1375
|
+
* @param - Id of the item in public media
|
|
1376
|
+
* @returns Updated item info
|
|
1377
|
+
*/
|
|
1378
|
+
(_id: string, item: UpdateItem): Promise<EnterpriseMediaItem & EnterpriseMediaItemNonNullableFields>;
|
|
1379
|
+
}
|
|
1380
|
+
declare function bulkUpdateItem$1(httpClient: HttpClient): BulkUpdateItemSignature;
|
|
1381
|
+
interface BulkUpdateItemSignature {
|
|
1382
|
+
/**
|
|
1383
|
+
* Bulk update an item
|
|
1384
|
+
* @param - Requests to update individual item
|
|
1385
|
+
*/
|
|
1386
|
+
(updateItemRequests: UpdateItemRequest[], options?: BulkUpdateItemOptions | undefined): Promise<BulkUpdateItemResponse & BulkUpdateItemResponseNonNullableFields>;
|
|
1387
|
+
}
|
|
1388
|
+
declare function getItem$1(httpClient: HttpClient): GetItemSignature;
|
|
1389
|
+
interface GetItemSignature {
|
|
1390
|
+
/**
|
|
1391
|
+
* Get item details
|
|
1392
|
+
* @param - Item id
|
|
1393
|
+
* @returns item info
|
|
1394
|
+
*/
|
|
1395
|
+
(itemId: string): Promise<EnterpriseMediaItem & EnterpriseMediaItemNonNullableFields>;
|
|
1396
|
+
}
|
|
1397
|
+
declare function linkItemToCategories$1(httpClient: HttpClient): LinkItemToCategoriesSignature;
|
|
1398
|
+
interface LinkItemToCategoriesSignature {
|
|
1399
|
+
/**
|
|
1400
|
+
* Link the item to multiple categories
|
|
1401
|
+
* @param - The item id
|
|
1402
|
+
*/
|
|
1403
|
+
(itemId: string, options?: LinkItemToCategoriesOptions | undefined): Promise<LinkItemToCategoriesResponse>;
|
|
1404
|
+
}
|
|
1405
|
+
declare function unlinkItemFromCategories$1(httpClient: HttpClient): UnlinkItemFromCategoriesSignature;
|
|
1406
|
+
interface UnlinkItemFromCategoriesSignature {
|
|
1407
|
+
/**
|
|
1408
|
+
* Unlink the item from multiple categories
|
|
1409
|
+
* @param - The item id
|
|
1410
|
+
*/
|
|
1411
|
+
(itemId: string, options?: UnlinkItemFromCategoriesOptions | undefined): Promise<UnlinkItemFromCategoriesResponse>;
|
|
1412
|
+
}
|
|
1413
|
+
declare function overwriteItemCategories$1(httpClient: HttpClient): OverwriteItemCategoriesSignature;
|
|
1414
|
+
interface OverwriteItemCategoriesSignature {
|
|
1415
|
+
/**
|
|
1416
|
+
* Overwrite item categories
|
|
1417
|
+
* @param - The item id
|
|
1418
|
+
*/
|
|
1419
|
+
(itemId: string, options?: OverwriteItemCategoriesOptions | undefined): Promise<OverwriteItemCategoriesResponse>;
|
|
1420
|
+
}
|
|
1310
1421
|
declare const onEnterpriseItemCreated$1: EventDefinition<EnterpriseItemCreatedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_item_created">;
|
|
1311
1422
|
declare const onEnterpriseItemUpdated$1: EventDefinition<EnterpriseItemUpdatedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_item_updated">;
|
|
1312
1423
|
declare const onEnterpriseItemItemCategoriesChanged$1: EventDefinition<EnterpriseItemItemCategoriesChangedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_item_item_categories_changed">;
|
|
1313
1424
|
declare const onEnterpriseItemPublishStatusChanged$1: EventDefinition<EnterpriseItemPublishStatusChangedEnvelope, "wix.media.enterprise_public_media.v1.enterprise_item_publish_status_changed">;
|
|
1314
1425
|
|
|
1315
|
-
declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
1316
|
-
|
|
1317
1426
|
declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
1318
1427
|
|
|
1319
|
-
|
|
1320
|
-
declare const
|
|
1321
|
-
|
|
1322
|
-
declare const
|
|
1323
|
-
|
|
1324
|
-
declare const
|
|
1325
|
-
|
|
1326
|
-
declare const
|
|
1327
|
-
|
|
1328
|
-
declare const
|
|
1329
|
-
|
|
1330
|
-
declare const updateItem: ReturnType<typeof createRESTModule$2<_publicUpdateItemType>>;
|
|
1331
|
-
type _publicBulkUpdateItemType = typeof bulkUpdateItem$1;
|
|
1332
|
-
declare const bulkUpdateItem: ReturnType<typeof createRESTModule$2<_publicBulkUpdateItemType>>;
|
|
1333
|
-
type _publicGetItemType = typeof getItem$1;
|
|
1334
|
-
declare const getItem: ReturnType<typeof createRESTModule$2<_publicGetItemType>>;
|
|
1335
|
-
type _publicLinkItemToCategoriesType = typeof linkItemToCategories$1;
|
|
1336
|
-
declare const linkItemToCategories: ReturnType<typeof createRESTModule$2<_publicLinkItemToCategoriesType>>;
|
|
1337
|
-
type _publicUnlinkItemFromCategoriesType = typeof unlinkItemFromCategories$1;
|
|
1338
|
-
declare const unlinkItemFromCategories: ReturnType<typeof createRESTModule$2<_publicUnlinkItemFromCategoriesType>>;
|
|
1339
|
-
type _publicOverwriteItemCategoriesType = typeof overwriteItemCategories$1;
|
|
1340
|
-
declare const overwriteItemCategories: ReturnType<typeof createRESTModule$2<_publicOverwriteItemCategoriesType>>;
|
|
1428
|
+
declare const itemUploadCallback: BuildRESTFunction<typeof itemUploadCallback$1> & typeof itemUploadCallback$1;
|
|
1429
|
+
declare const generateFileUploadUrl$2: BuildRESTFunction<typeof generateFileUploadUrl$3> & typeof generateFileUploadUrl$3;
|
|
1430
|
+
declare const importFile$2: BuildRESTFunction<typeof importFile$3> & typeof importFile$3;
|
|
1431
|
+
declare const searchItems: BuildRESTFunction<typeof searchItems$1> & typeof searchItems$1;
|
|
1432
|
+
declare const queryItems: BuildRESTFunction<typeof queryItems$1> & typeof queryItems$1;
|
|
1433
|
+
declare const updateItem: BuildRESTFunction<typeof updateItem$1> & typeof updateItem$1;
|
|
1434
|
+
declare const bulkUpdateItem: BuildRESTFunction<typeof bulkUpdateItem$1> & typeof bulkUpdateItem$1;
|
|
1435
|
+
declare const getItem: BuildRESTFunction<typeof getItem$1> & typeof getItem$1;
|
|
1436
|
+
declare const linkItemToCategories: BuildRESTFunction<typeof linkItemToCategories$1> & typeof linkItemToCategories$1;
|
|
1437
|
+
declare const unlinkItemFromCategories: BuildRESTFunction<typeof unlinkItemFromCategories$1> & typeof unlinkItemFromCategories$1;
|
|
1438
|
+
declare const overwriteItemCategories: BuildRESTFunction<typeof overwriteItemCategories$1> & typeof overwriteItemCategories$1;
|
|
1341
1439
|
|
|
1342
1440
|
type _publicOnEnterpriseItemCreatedType = typeof onEnterpriseItemCreated$1;
|
|
1441
|
+
/**
|
|
1442
|
+
* Triggered when an item is created.
|
|
1443
|
+
*/
|
|
1343
1444
|
declare const onEnterpriseItemCreated: ReturnType<typeof createEventModule$2<_publicOnEnterpriseItemCreatedType>>;
|
|
1344
1445
|
|
|
1345
1446
|
type _publicOnEnterpriseItemUpdatedType = typeof onEnterpriseItemUpdated$1;
|
|
1447
|
+
/**
|
|
1448
|
+
* Triggered when an item is updated, including when an item is archived or linked to a category
|
|
1449
|
+
*/
|
|
1346
1450
|
declare const onEnterpriseItemUpdated: ReturnType<typeof createEventModule$2<_publicOnEnterpriseItemUpdatedType>>;
|
|
1347
1451
|
|
|
1348
1452
|
type _publicOnEnterpriseItemItemCategoriesChangedType = typeof onEnterpriseItemItemCategoriesChanged$1;
|
|
1453
|
+
/**
|
|
1454
|
+
* Triggered when an is linked to a category or unlinked from a category
|
|
1455
|
+
*/
|
|
1349
1456
|
declare const onEnterpriseItemItemCategoriesChanged: ReturnType<typeof createEventModule$2<_publicOnEnterpriseItemItemCategoriesChangedType>>;
|
|
1350
1457
|
|
|
1351
1458
|
type _publicOnEnterpriseItemPublishStatusChangedType = typeof onEnterpriseItemPublishStatusChanged$1;
|
|
1459
|
+
/**
|
|
1460
|
+
* Triggered when an item is Published or Unpublished
|
|
1461
|
+
*/
|
|
1352
1462
|
declare const onEnterpriseItemPublishStatusChanged: ReturnType<typeof createEventModule$2<_publicOnEnterpriseItemPublishStatusChangedType>>;
|
|
1353
1463
|
|
|
1354
1464
|
type index_d$2_BulkItemUpdateResult = BulkItemUpdateResult;
|
|
@@ -1402,19 +1512,10 @@ type index_d$2_UpdateItem = UpdateItem;
|
|
|
1402
1512
|
type index_d$2_UpdateItemRequest = UpdateItemRequest;
|
|
1403
1513
|
type index_d$2_UpdateItemResponse = UpdateItemResponse;
|
|
1404
1514
|
type index_d$2_UpdateItemResponseNonNullableFields = UpdateItemResponseNonNullableFields;
|
|
1405
|
-
type index_d$2__publicBulkUpdateItemType = _publicBulkUpdateItemType;
|
|
1406
|
-
type index_d$2__publicGetItemType = _publicGetItemType;
|
|
1407
|
-
type index_d$2__publicItemUploadCallbackType = _publicItemUploadCallbackType;
|
|
1408
|
-
type index_d$2__publicLinkItemToCategoriesType = _publicLinkItemToCategoriesType;
|
|
1409
1515
|
type index_d$2__publicOnEnterpriseItemCreatedType = _publicOnEnterpriseItemCreatedType;
|
|
1410
1516
|
type index_d$2__publicOnEnterpriseItemItemCategoriesChangedType = _publicOnEnterpriseItemItemCategoriesChangedType;
|
|
1411
1517
|
type index_d$2__publicOnEnterpriseItemPublishStatusChangedType = _publicOnEnterpriseItemPublishStatusChangedType;
|
|
1412
1518
|
type index_d$2__publicOnEnterpriseItemUpdatedType = _publicOnEnterpriseItemUpdatedType;
|
|
1413
|
-
type index_d$2__publicOverwriteItemCategoriesType = _publicOverwriteItemCategoriesType;
|
|
1414
|
-
type index_d$2__publicQueryItemsType = _publicQueryItemsType;
|
|
1415
|
-
type index_d$2__publicSearchItemsType = _publicSearchItemsType;
|
|
1416
|
-
type index_d$2__publicUnlinkItemFromCategoriesType = _publicUnlinkItemFromCategoriesType;
|
|
1417
|
-
type index_d$2__publicUpdateItemType = _publicUpdateItemType;
|
|
1418
1519
|
declare const index_d$2_bulkUpdateItem: typeof bulkUpdateItem;
|
|
1419
1520
|
declare const index_d$2_getItem: typeof getItem;
|
|
1420
1521
|
declare const index_d$2_itemUploadCallback: typeof itemUploadCallback;
|
|
@@ -1429,7 +1530,7 @@ declare const index_d$2_searchItems: typeof searchItems;
|
|
|
1429
1530
|
declare const index_d$2_unlinkItemFromCategories: typeof unlinkItemFromCategories;
|
|
1430
1531
|
declare const index_d$2_updateItem: typeof updateItem;
|
|
1431
1532
|
declare namespace index_d$2 {
|
|
1432
|
-
export { type ActionEvent$2 as ActionEvent, type ApplicationError$1 as ApplicationError, type Archive$1 as Archive, type BaseEventMetadata$2 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type index_d$2_BulkItemUpdateResult as BulkItemUpdateResult, type index_d$2_BulkUpdateItemOptions as BulkUpdateItemOptions, type index_d$2_BulkUpdateItemRequest as BulkUpdateItemRequest, type index_d$2_BulkUpdateItemResponse as BulkUpdateItemResponse, type index_d$2_BulkUpdateItemResponseNonNullableFields as BulkUpdateItemResponseNonNullableFields, type Cursors$2 as Cursors, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type index_d$2_EnterpriseItemCreatedEnvelope as EnterpriseItemCreatedEnvelope, type index_d$2_EnterpriseItemItemCategoriesChangedEnvelope as EnterpriseItemItemCategoriesChangedEnvelope, type index_d$2_EnterpriseItemPublishStatusChangedEnvelope as EnterpriseItemPublishStatusChangedEnvelope, type index_d$2_EnterpriseItemUpdatedEnvelope as EnterpriseItemUpdatedEnvelope, type index_d$2_EnterpriseMediaItem as EnterpriseMediaItem, type index_d$2_EnterpriseMediaItemNonNullableFields as EnterpriseMediaItemNonNullableFields, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type GenerateFileUploadUrlOptions$1 as GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest$1 as GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse$1 as GenerateFileUploadUrlResponse, type GenerateFileUploadUrlResponseNonNullableFields$1 as GenerateFileUploadUrlResponseNonNullableFields, type index_d$2_GetItemRequest as GetItemRequest, type index_d$2_GetItemResponse as GetItemResponse, type index_d$2_GetItemResponseNonNullableFields as GetItemResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type ImportFileOptions$1 as ImportFileOptions, type ImportFileRequest$1 as ImportFileRequest, type ImportFileResponse$1 as ImportFileResponse, type ImportFileResponseNonNullableFields$1 as ImportFileResponseNonNullableFields, type index_d$2_ItemAssets as ItemAssets, type index_d$2_ItemAssetsAssetsOneOf as ItemAssetsAssetsOneOf, type index_d$2_ItemCategoriesChanged as ItemCategoriesChanged, type ItemMetadata$1 as ItemMetadata, type index_d$2_ItemUploadCallbackOptions as ItemUploadCallbackOptions, type index_d$2_ItemUploadCallbackRequest as ItemUploadCallbackRequest, type index_d$2_ItemUploadCallbackResponse as ItemUploadCallbackResponse, type index_d$2_ItemsQueryBuilder as ItemsQueryBuilder, type index_d$2_ItemsQueryResult as ItemsQueryResult, type index_d$2_LinkItemToCategoriesOptions as LinkItemToCategoriesOptions, type index_d$2_LinkItemToCategoriesRequest as LinkItemToCategoriesRequest, type index_d$2_LinkItemToCategoriesResponse as LinkItemToCategoriesResponse, MediaType$1 as MediaType, type MessageEnvelope$2 as MessageEnvelope, type Model3D$1 as Model3D, type index_d$2_OverwriteItemCategoriesOptions as OverwriteItemCategoriesOptions, type index_d$2_OverwriteItemCategoriesRequest as OverwriteItemCategoriesRequest, type index_d$2_OverwriteItemCategoriesResponse as OverwriteItemCategoriesResponse, type index_d$2_Paging as Paging, type PagingMetadataV2$2 as PagingMetadataV2, index_d$2_PublishStatus as PublishStatus, type index_d$2_PublishStatusChanged as PublishStatusChanged, type index_d$2_QueryItemsRequest as QueryItemsRequest, type index_d$2_QueryItemsResponse as QueryItemsResponse, type index_d$2_QueryItemsResponseNonNullableFields as QueryItemsResponseNonNullableFields, type index_d$2_QueryV2 as QueryV2, type index_d$2_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type RestoreInfo$2 as RestoreInfo, type index_d$2_Search as Search, type index_d$2_SearchDetails as SearchDetails, type index_d$2_SearchItemsOptions as SearchItemsOptions, type index_d$2_SearchItemsRequest as SearchItemsRequest, type index_d$2_SearchItemsResponse as SearchItemsResponse, type index_d$2_SearchItemsResponseNonNullableFields as SearchItemsResponseNonNullableFields, type index_d$2_SearchPagingMethodOneOf as SearchPagingMethodOneOf, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$2_UnlinkItemFromCategoriesOptions as UnlinkItemFromCategoriesOptions, type index_d$2_UnlinkItemFromCategoriesRequest as UnlinkItemFromCategoriesRequest, type index_d$2_UnlinkItemFromCategoriesResponse as UnlinkItemFromCategoriesResponse, type index_d$2_UpdateItem as UpdateItem, type index_d$2_UpdateItemRequest as UpdateItemRequest, type index_d$2_UpdateItemResponse as UpdateItemResponse, type index_d$2_UpdateItemResponseNonNullableFields as UpdateItemResponseNonNullableFields, type VideoResolution$1 as VideoResolution, WebhookIdentityType$2 as WebhookIdentityType, type index_d$
|
|
1533
|
+
export { type ActionEvent$2 as ActionEvent, type ApplicationError$1 as ApplicationError, type Archive$1 as Archive, type BaseEventMetadata$2 as BaseEventMetadata, type BulkActionMetadata$1 as BulkActionMetadata, type index_d$2_BulkItemUpdateResult as BulkItemUpdateResult, type index_d$2_BulkUpdateItemOptions as BulkUpdateItemOptions, type index_d$2_BulkUpdateItemRequest as BulkUpdateItemRequest, type index_d$2_BulkUpdateItemResponse as BulkUpdateItemResponse, type index_d$2_BulkUpdateItemResponseNonNullableFields as BulkUpdateItemResponseNonNullableFields, type Cursors$2 as Cursors, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type index_d$2_EnterpriseItemCreatedEnvelope as EnterpriseItemCreatedEnvelope, type index_d$2_EnterpriseItemItemCategoriesChangedEnvelope as EnterpriseItemItemCategoriesChangedEnvelope, type index_d$2_EnterpriseItemPublishStatusChangedEnvelope as EnterpriseItemPublishStatusChangedEnvelope, type index_d$2_EnterpriseItemUpdatedEnvelope as EnterpriseItemUpdatedEnvelope, type index_d$2_EnterpriseMediaItem as EnterpriseMediaItem, type index_d$2_EnterpriseMediaItemNonNullableFields as EnterpriseMediaItemNonNullableFields, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type GenerateFileUploadUrlOptions$1 as GenerateFileUploadUrlOptions, type GenerateFileUploadUrlRequest$1 as GenerateFileUploadUrlRequest, type GenerateFileUploadUrlResponse$1 as GenerateFileUploadUrlResponse, type GenerateFileUploadUrlResponseNonNullableFields$1 as GenerateFileUploadUrlResponseNonNullableFields, type index_d$2_GetItemRequest as GetItemRequest, type index_d$2_GetItemResponse as GetItemResponse, type index_d$2_GetItemResponseNonNullableFields as GetItemResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type ImportFileOptions$1 as ImportFileOptions, type ImportFileRequest$1 as ImportFileRequest, type ImportFileResponse$1 as ImportFileResponse, type ImportFileResponseNonNullableFields$1 as ImportFileResponseNonNullableFields, type index_d$2_ItemAssets as ItemAssets, type index_d$2_ItemAssetsAssetsOneOf as ItemAssetsAssetsOneOf, type index_d$2_ItemCategoriesChanged as ItemCategoriesChanged, type ItemMetadata$1 as ItemMetadata, type index_d$2_ItemUploadCallbackOptions as ItemUploadCallbackOptions, type index_d$2_ItemUploadCallbackRequest as ItemUploadCallbackRequest, type index_d$2_ItemUploadCallbackResponse as ItemUploadCallbackResponse, type index_d$2_ItemsQueryBuilder as ItemsQueryBuilder, type index_d$2_ItemsQueryResult as ItemsQueryResult, type index_d$2_LinkItemToCategoriesOptions as LinkItemToCategoriesOptions, type index_d$2_LinkItemToCategoriesRequest as LinkItemToCategoriesRequest, type index_d$2_LinkItemToCategoriesResponse as LinkItemToCategoriesResponse, MediaType$1 as MediaType, type MessageEnvelope$2 as MessageEnvelope, type Model3D$1 as Model3D, type index_d$2_OverwriteItemCategoriesOptions as OverwriteItemCategoriesOptions, type index_d$2_OverwriteItemCategoriesRequest as OverwriteItemCategoriesRequest, type index_d$2_OverwriteItemCategoriesResponse as OverwriteItemCategoriesResponse, type index_d$2_Paging as Paging, type PagingMetadataV2$2 as PagingMetadataV2, index_d$2_PublishStatus as PublishStatus, type index_d$2_PublishStatusChanged as PublishStatusChanged, type index_d$2_QueryItemsRequest as QueryItemsRequest, type index_d$2_QueryItemsResponse as QueryItemsResponse, type index_d$2_QueryItemsResponseNonNullableFields as QueryItemsResponseNonNullableFields, type index_d$2_QueryV2 as QueryV2, type index_d$2_QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOf, type RestoreInfo$2 as RestoreInfo, type index_d$2_Search as Search, type index_d$2_SearchDetails as SearchDetails, type index_d$2_SearchItemsOptions as SearchItemsOptions, type index_d$2_SearchItemsRequest as SearchItemsRequest, type index_d$2_SearchItemsResponse as SearchItemsResponse, type index_d$2_SearchItemsResponseNonNullableFields as SearchItemsResponseNonNullableFields, type index_d$2_SearchPagingMethodOneOf as SearchPagingMethodOneOf, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, type index_d$2_UnlinkItemFromCategoriesOptions as UnlinkItemFromCategoriesOptions, type index_d$2_UnlinkItemFromCategoriesRequest as UnlinkItemFromCategoriesRequest, type index_d$2_UnlinkItemFromCategoriesResponse as UnlinkItemFromCategoriesResponse, type index_d$2_UpdateItem as UpdateItem, type index_d$2_UpdateItemRequest as UpdateItemRequest, type index_d$2_UpdateItemResponse as UpdateItemResponse, type index_d$2_UpdateItemResponseNonNullableFields as UpdateItemResponseNonNullableFields, type VideoResolution$1 as VideoResolution, WebhookIdentityType$2 as WebhookIdentityType, type index_d$2__publicOnEnterpriseItemCreatedType as _publicOnEnterpriseItemCreatedType, type index_d$2__publicOnEnterpriseItemItemCategoriesChangedType as _publicOnEnterpriseItemItemCategoriesChangedType, type index_d$2__publicOnEnterpriseItemPublishStatusChangedType as _publicOnEnterpriseItemPublishStatusChangedType, type index_d$2__publicOnEnterpriseItemUpdatedType as _publicOnEnterpriseItemUpdatedType, index_d$2_bulkUpdateItem as bulkUpdateItem, generateFileUploadUrl$2 as generateFileUploadUrl, index_d$2_getItem as getItem, importFile$2 as importFile, index_d$2_itemUploadCallback as itemUploadCallback, index_d$2_linkItemToCategories as linkItemToCategories, index_d$2_onEnterpriseItemCreated as onEnterpriseItemCreated, index_d$2_onEnterpriseItemItemCategoriesChanged as onEnterpriseItemItemCategoriesChanged, index_d$2_onEnterpriseItemPublishStatusChanged as onEnterpriseItemPublishStatusChanged, index_d$2_onEnterpriseItemUpdated as onEnterpriseItemUpdated, index_d$2_overwriteItemCategories as overwriteItemCategories, onEnterpriseItemCreated$1 as publicOnEnterpriseItemCreated, onEnterpriseItemItemCategoriesChanged$1 as publicOnEnterpriseItemItemCategoriesChanged, onEnterpriseItemPublishStatusChanged$1 as publicOnEnterpriseItemPublishStatusChanged, onEnterpriseItemUpdated$1 as publicOnEnterpriseItemUpdated, index_d$2_queryItems as queryItems, index_d$2_searchItems as searchItems, index_d$2_unlinkItemFromCategories as unlinkItemFromCategories, index_d$2_updateItem as updateItem };
|
|
1433
1534
|
}
|
|
1434
1535
|
|
|
1435
1536
|
interface FileDescriptor {
|
|
@@ -1788,6 +1889,16 @@ interface ExternalInfo {
|
|
|
1788
1889
|
interface FileFailed {
|
|
1789
1890
|
/** External information passed in the file import or upload. */
|
|
1790
1891
|
externalInfo?: ExternalInfo;
|
|
1892
|
+
/** Error information */
|
|
1893
|
+
error?: ApplicationError;
|
|
1894
|
+
}
|
|
1895
|
+
interface ApplicationError {
|
|
1896
|
+
/** Error code. */
|
|
1897
|
+
code?: string;
|
|
1898
|
+
/** Description of the error. */
|
|
1899
|
+
description?: string;
|
|
1900
|
+
/** Data related to the error. */
|
|
1901
|
+
data?: Record<string, any> | null;
|
|
1791
1902
|
}
|
|
1792
1903
|
interface GenerateFilesDownloadUrlRequest {
|
|
1793
1904
|
/**
|
|
@@ -2058,14 +2169,6 @@ interface ItemMetadata {
|
|
|
2058
2169
|
/** Details about the error in case of failure. */
|
|
2059
2170
|
error?: ApplicationError;
|
|
2060
2171
|
}
|
|
2061
|
-
interface ApplicationError {
|
|
2062
|
-
/** Error code. */
|
|
2063
|
-
code?: string;
|
|
2064
|
-
/** Description of the error. */
|
|
2065
|
-
description?: string;
|
|
2066
|
-
/** Data related to the error. */
|
|
2067
|
-
data?: Record<string, any> | null;
|
|
2068
|
-
}
|
|
2069
2172
|
interface BulkActionMetadata {
|
|
2070
2173
|
/** Number of items that were successfully processed. */
|
|
2071
2174
|
totalSuccesses?: number;
|
|
@@ -2816,74 +2919,332 @@ interface ListDeletedFilesOptions {
|
|
|
2816
2919
|
paging?: CursorPaging$1;
|
|
2817
2920
|
}
|
|
2818
2921
|
|
|
2819
|
-
declare function generateFilesDownloadUrl$1(httpClient: HttpClient):
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
|
|
2834
|
-
|
|
2922
|
+
declare function generateFilesDownloadUrl$1(httpClient: HttpClient): GenerateFilesDownloadUrlSignature;
|
|
2923
|
+
interface GenerateFilesDownloadUrlSignature {
|
|
2924
|
+
/**
|
|
2925
|
+
* Generates a URL for downloading a compressed file containing specific files in the Media Manager.
|
|
2926
|
+
*
|
|
2927
|
+
* The `generateFilesDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
2928
|
+
*
|
|
2929
|
+
* The compressed file can contain up to 1000 files.
|
|
2930
|
+
*
|
|
2931
|
+
* To generate one or more temporary URLs for downloading a specific file in the Media Manager, use the `generateFileDownloadUrl()` function.
|
|
2932
|
+
* You can use the `expirationInMinutes` parameter to set the URL expiration time, making it more secure than the `generateFilesDownloadUrl()` function.
|
|
2933
|
+
* Therefore, to download private files, use the `generateFileDownloadUrl` function for each private file that you want to generate a download URL for.
|
|
2934
|
+
* @param - IDs of the files to download.
|
|
2935
|
+
*
|
|
2936
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2937
|
+
* Learn more in the File and Folder IDs article.
|
|
2938
|
+
*/
|
|
2939
|
+
(fileIds: string[]): Promise<GenerateFilesDownloadUrlResponse & GenerateFilesDownloadUrlResponseNonNullableFields>;
|
|
2940
|
+
}
|
|
2941
|
+
declare function generateFileDownloadUrl$1(httpClient: HttpClient): GenerateFileDownloadUrlSignature;
|
|
2942
|
+
interface GenerateFileDownloadUrlSignature {
|
|
2943
|
+
/**
|
|
2944
|
+
* Generates one or more temporary URLs for downloading a specific file in the Media Manager.
|
|
2945
|
+
*
|
|
2946
|
+
* The `generateFileDownloadUrl()` function returns a Promise that resolves to an array containing download URLs for the assets specified in the options parameter.
|
|
2947
|
+
*
|
|
2948
|
+
* To download different assets of the file, use the `assetKeys` parameter which generates a download URL for each asset.
|
|
2949
|
+
* If no asset key is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
|
|
2950
|
+
*
|
|
2951
|
+
* Use this function to grant external clients access to a private media file. Use the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect URL when the URL expires.
|
|
2952
|
+
*
|
|
2953
|
+
* To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, use the `generateFilesDownloadUrl()` function.
|
|
2954
|
+
* Since this is a permanent URL, it is less secure. Therefore, to download private files, use the `generateFileDownloadUrl()` function for each private file that you want to generate a download URL for.
|
|
2955
|
+
* @param - Options to use when generating a file's download URL.
|
|
2956
|
+
* @param - File ID.
|
|
2957
|
+
*
|
|
2958
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2959
|
+
* Learn more in the File and Folder IDs article.
|
|
2960
|
+
*/
|
|
2961
|
+
(fileId: string, options?: GenerateFileDownloadUrlOptions | undefined): Promise<GenerateFileDownloadUrlResponse & GenerateFileDownloadUrlResponseNonNullableFields>;
|
|
2962
|
+
}
|
|
2963
|
+
declare function getFileDescriptor$1(httpClient: HttpClient): GetFileDescriptorSignature;
|
|
2964
|
+
interface GetFileDescriptorSignature {
|
|
2965
|
+
/**
|
|
2966
|
+
* Gets information about the specified file in the Media Manager.
|
|
2967
|
+
*
|
|
2968
|
+
*
|
|
2969
|
+
* The `getFileDescriptor()` function returns a Promise that resolves to the specified file's descriptor.
|
|
2970
|
+
*
|
|
2971
|
+
* Use `getFileDescriptors()` to get multiple file descriptors at once.
|
|
2972
|
+
* @param - File ID.
|
|
2973
|
+
*
|
|
2974
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2975
|
+
* Learn more in the File and Folder IDs article.
|
|
2976
|
+
* @returns Information about the file.
|
|
2977
|
+
*/
|
|
2978
|
+
(fileId: string): Promise<FileDescriptor & FileDescriptorNonNullableFields>;
|
|
2979
|
+
}
|
|
2980
|
+
declare function getFileDescriptors$1(httpClient: HttpClient): GetFileDescriptorsSignature;
|
|
2981
|
+
interface GetFileDescriptorsSignature {
|
|
2982
|
+
/**
|
|
2983
|
+
* Gets information about the specified files in the Media Manager.
|
|
2984
|
+
*
|
|
2985
|
+
*
|
|
2986
|
+
* The `getFileDescriptors()` function returns a Promise that resolves to an array containing the specified files' descriptors.
|
|
2987
|
+
*
|
|
2988
|
+
* Use `getFileDescriptor()` to get a single file descriptor.
|
|
2989
|
+
* @param - File IDs.
|
|
2990
|
+
*
|
|
2991
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
2992
|
+
* Learn more in the File and Folder IDs article.
|
|
2993
|
+
*/
|
|
2994
|
+
(fileIds: string[]): Promise<GetFileDescriptorsResponse & GetFileDescriptorsResponseNonNullableFields>;
|
|
2995
|
+
}
|
|
2996
|
+
declare function updateFileDescriptor$1(httpClient: HttpClient): UpdateFileDescriptorSignature;
|
|
2997
|
+
interface UpdateFileDescriptorSignature {
|
|
2998
|
+
/**
|
|
2999
|
+
* Updates a file.
|
|
3000
|
+
*
|
|
3001
|
+
*
|
|
3002
|
+
* The `updateFileDescriptor()` function returns a Promise that resolves to the updated file's descriptor.
|
|
3003
|
+
*
|
|
3004
|
+
* You can use the `parentFolderId` parameter to move a file from its current folder to a different folder.
|
|
3005
|
+
* @param - The file to update.
|
|
3006
|
+
* @returns Information about the updated file.
|
|
3007
|
+
*/
|
|
3008
|
+
(file: FileDescriptor): Promise<FileDescriptor & FileDescriptorNonNullableFields>;
|
|
3009
|
+
}
|
|
3010
|
+
declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
|
|
3011
|
+
interface GenerateFileUploadUrlSignature {
|
|
3012
|
+
/**
|
|
3013
|
+
* Generates an upload URL to allow external clients to upload a file to the Media Manager.
|
|
3014
|
+
*
|
|
3015
|
+
* The `generateFileUploadUrl()` function returns a Promise that resolves to an upload URL.
|
|
3016
|
+
*
|
|
3017
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the Upload API article.
|
|
3018
|
+
*
|
|
3019
|
+
* > **Notes:**
|
|
3020
|
+
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](/files/importing-files).
|
|
3021
|
+
* > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, use `generateFileResumableUploadUrl()` instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
|
|
3022
|
+
* @param - File mime type.
|
|
3023
|
+
* @param - Options to use when generating a file's upload URL.
|
|
3024
|
+
*/
|
|
3025
|
+
(mimeType: string | null, options?: GenerateFileUploadUrlOptions | undefined): Promise<GenerateFileUploadUrlResponse & GenerateFileUploadUrlResponseNonNullableFields>;
|
|
3026
|
+
}
|
|
3027
|
+
declare function generateFileResumableUploadUrl$1(httpClient: HttpClient): GenerateFileResumableUploadUrlSignature;
|
|
3028
|
+
interface GenerateFileResumableUploadUrlSignature {
|
|
3029
|
+
/**
|
|
3030
|
+
* Generates a resumable upload URL to allow external clients to upload large files over 10MB to the Media Manager.
|
|
3031
|
+
*
|
|
3032
|
+
* The `generateFileResumableUploadUrl()` function returns a Promise that resolves to an upload URL, token, and protocol.
|
|
3033
|
+
*
|
|
3034
|
+
* When using the resumable upload URL, any interruptions will pause the file upload process, which automatically resumes once the interruption is resolved. The resumable upload URL is also helpful when network connection is poor.
|
|
3035
|
+
*
|
|
3036
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see the Resumable Upload API article.
|
|
3037
|
+
*
|
|
3038
|
+
* > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](/files/importing-files).
|
|
3039
|
+
* @param - File mime type.
|
|
3040
|
+
* @param - Options to use when generating a resumable upload URL.
|
|
3041
|
+
*/
|
|
3042
|
+
(mimeType: string | null, options?: GenerateFileResumableUploadUrlOptions | undefined): Promise<GenerateFileResumableUploadUrlResponse & GenerateFileResumableUploadUrlResponseNonNullableFields>;
|
|
3043
|
+
}
|
|
3044
|
+
declare function importFile$1(httpClient: HttpClient): ImportFileSignature;
|
|
3045
|
+
interface ImportFileSignature {
|
|
3046
|
+
/**
|
|
3047
|
+
* Imports a file to the Media Manager using an external URL.
|
|
3048
|
+
*
|
|
3049
|
+
* The `importFile()` function returns a Promise that resolves to the imported file's descriptor.
|
|
3050
|
+
*
|
|
3051
|
+
* This function returns information about the imported file. Importing a file is the method through which you can add files to the Media Manager.
|
|
3052
|
+
* Use the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.
|
|
3053
|
+
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3054
|
+
*
|
|
3055
|
+
* > **Note:** When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](/files/importing-files).
|
|
3056
|
+
*
|
|
3057
|
+
* To import a file, you need to do one of the following:
|
|
3058
|
+
* - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
3059
|
+
* - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
|
|
3060
|
+
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3061
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3062
|
+
* @param - Publicly accessible external file URL.
|
|
3063
|
+
* @param - Options to use when importing a single file.
|
|
3064
|
+
*/
|
|
3065
|
+
(url: string, options?: ImportFileOptions | undefined): Promise<ImportFileResponse & ImportFileResponseNonNullableFields>;
|
|
3066
|
+
}
|
|
3067
|
+
declare function bulkImportFiles$1(httpClient: HttpClient): BulkImportFilesSignature;
|
|
3068
|
+
interface BulkImportFilesSignature {
|
|
3069
|
+
/**
|
|
3070
|
+
* > **Deprecated.**
|
|
3071
|
+
* > This function has been replaced with `bulkImportFile()`, and will be removed on March 31, 2024.
|
|
3072
|
+
*
|
|
3073
|
+
*
|
|
3074
|
+
* The `bulkImportFiles()` function returns a Promise that resolves to an array of the imported files' descriptors.
|
|
3075
|
+
*
|
|
3076
|
+
* Imports a bulk of files to the Media Manager using external urls.
|
|
3077
|
+
*
|
|
3078
|
+
* Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported.
|
|
3079
|
+
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3080
|
+
*
|
|
3081
|
+
* >**Note:** The `media` property isn't returned in the `files` response object.
|
|
3082
|
+
*
|
|
3083
|
+
* To import files, you need to do one of the following for each file:
|
|
3084
|
+
* - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
3085
|
+
* - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
|
|
3086
|
+
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3087
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3088
|
+
* @param - Information about the files to import.
|
|
3089
|
+
* @param - Options to use when uploading multiple files.
|
|
3090
|
+
* @deprecated
|
|
3091
|
+
*/
|
|
3092
|
+
(importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse & BulkImportFilesResponseNonNullableFields>;
|
|
3093
|
+
}
|
|
3094
|
+
declare function bulkImportFile$1(httpClient: HttpClient): BulkImportFileSignature;
|
|
3095
|
+
interface BulkImportFileSignature {
|
|
3096
|
+
/**
|
|
3097
|
+
* Imports a bulk of files to the Media Manager using external urls.
|
|
3098
|
+
*
|
|
3099
|
+
* The `bulkImportFile()` function returns a Promise that resolves to an object containing bulk import metadata and an array of imported files' descriptors and metadata.
|
|
3100
|
+
*
|
|
3101
|
+
* Returns information about the imported files. Use the `parentFolderId` and `filePath` parameters to specify in which folder you want each file to be imported.
|
|
3102
|
+
* If no folder is specified, the file is imported to the `media-root` folder.
|
|
3103
|
+
*
|
|
3104
|
+
* > **Note:** When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](/files/importing-files).
|
|
3105
|
+
*
|
|
3106
|
+
* To import files, you need to do one of the following for each file:
|
|
3107
|
+
* - Pass its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
3108
|
+
* - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
|
|
3109
|
+
* - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
|
|
3110
|
+
* > **Note:** If you want to validate the media type, pass the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
|
|
3111
|
+
* @param - Information about the files to import.
|
|
3112
|
+
* @param - Options to include the file descriptor in the response.
|
|
3113
|
+
*/
|
|
3114
|
+
(importFileRequests: ImportFileRequest[], options?: BulkImportFileOptions | undefined): Promise<BulkImportFileResponse & BulkImportFileResponseNonNullableFields>;
|
|
3115
|
+
}
|
|
3116
|
+
declare function listFiles$1(httpClient: HttpClient): ListFilesSignature;
|
|
3117
|
+
interface ListFilesSignature {
|
|
3118
|
+
/**
|
|
3119
|
+
* Retrieves a list of files in the Media Manager.
|
|
3120
|
+
*
|
|
3121
|
+
* The `listFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.
|
|
3122
|
+
*
|
|
3123
|
+
* To retrieve a list of files within a specific folder in the Media Manager, pass the folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the files in the root folder of the Media Manager.
|
|
3124
|
+
*
|
|
3125
|
+
* To retrieve a list of (non-permanently) deleted files, use the `listDeletedFiles()` function.
|
|
3126
|
+
* @param - Options to use when listing media files.
|
|
3127
|
+
*/
|
|
3128
|
+
(options?: ListFilesOptions | undefined): Promise<ListFilesResponse & ListFilesResponseNonNullableFields>;
|
|
3129
|
+
}
|
|
3130
|
+
declare function searchFiles$1(httpClient: HttpClient): SearchFilesSignature;
|
|
3131
|
+
interface SearchFilesSignature {
|
|
3132
|
+
/**
|
|
3133
|
+
* Searches all folders in the Media Manager and returns a list of files that match the terms specified in the optional parameters.
|
|
3134
|
+
*
|
|
3135
|
+
* The `searchFiles()` function returns a Promise that resolves to an array of the specified files' descriptors and cursor information.
|
|
3136
|
+
*
|
|
3137
|
+
* If no parameters are specified, the function returns all files in the `MEDIA_ROOT` folder.
|
|
3138
|
+
* @param - Options to specify which folders to search.
|
|
3139
|
+
*/
|
|
3140
|
+
(options?: SearchFilesOptions | undefined): Promise<SearchFilesResponse & SearchFilesResponseNonNullableFields>;
|
|
3141
|
+
}
|
|
3142
|
+
declare function generateVideoStreamingUrl$1(httpClient: HttpClient): GenerateVideoStreamingUrlSignature;
|
|
3143
|
+
interface GenerateVideoStreamingUrlSignature {
|
|
3144
|
+
/**
|
|
3145
|
+
* Generates a URL for streaming a specific video file in the Media Manager.
|
|
3146
|
+
*
|
|
3147
|
+
*
|
|
3148
|
+
* The `generateVideoStreamingUrl()` function returns a Promise that resolves to a download URL and its asset key.
|
|
3149
|
+
*
|
|
3150
|
+
* To stream different assets of the file, use the `assetKeys` parameter which generates a video streaming URL for each asset. If no asset key is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.
|
|
3151
|
+
* @param - Options to use when generating a video file's streaming URL.
|
|
3152
|
+
* @param - File ID.
|
|
3153
|
+
*
|
|
3154
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
3155
|
+
* Learn more in the File and Folder IDs article.
|
|
3156
|
+
*/
|
|
3157
|
+
(fileId: string, options?: GenerateVideoStreamingUrlOptions | undefined): Promise<GenerateVideoStreamingUrlResponse & GenerateVideoStreamingUrlResponseNonNullableFields>;
|
|
3158
|
+
}
|
|
3159
|
+
declare function bulkDeleteFiles$1(httpClient: HttpClient): BulkDeleteFilesSignature;
|
|
3160
|
+
interface BulkDeleteFilesSignature {
|
|
3161
|
+
/**
|
|
3162
|
+
* Deletes the specified files from the Media Manager.
|
|
3163
|
+
*
|
|
3164
|
+
*
|
|
3165
|
+
* The `bulkDeleteFiles()` function returns a Promise that resolves when the files are deleted.
|
|
3166
|
+
*
|
|
3167
|
+
* The deleted files are moved to the Media Manager's trash bin (`TRASH_ROOT` folder) unless permanently deleted. To permanently delete files, pass the `permanent` parameter with the value `true`. Permanently deleting files isn't reversible, so make sure that these files aren't being used in a site or in any other way as the files will no longer be accessible.
|
|
3168
|
+
*
|
|
3169
|
+
* >**Notes:**
|
|
3170
|
+
* > - The specified files can be from different folders.
|
|
3171
|
+
* > - Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
3172
|
+
* > - Attempting to delete files that are already in the trash bin doesn't result in an error.
|
|
3173
|
+
* > - If your site contains deleted media files, the deleted media files still appear on your site as the files are still in the Media Manager (in the trash bin).
|
|
3174
|
+
* > - You can use `bulkRestoreFilesFromTrashBin()` to restore files from the Media Manager's trash bin.
|
|
3175
|
+
* @param - Options to use when deleting files.
|
|
3176
|
+
* @param - IDs of the files to move to the Media Manager's trash bin.
|
|
3177
|
+
*
|
|
3178
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
3179
|
+
* Learn more in the File and Folder IDs article.
|
|
3180
|
+
*/
|
|
3181
|
+
(fileIds: string[], options?: BulkDeleteFilesOptions | undefined): Promise<void>;
|
|
3182
|
+
}
|
|
3183
|
+
declare function bulkRestoreFilesFromTrashBin$1(httpClient: HttpClient): BulkRestoreFilesFromTrashBinSignature;
|
|
3184
|
+
interface BulkRestoreFilesFromTrashBinSignature {
|
|
3185
|
+
/**
|
|
3186
|
+
* Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
3187
|
+
*
|
|
3188
|
+
* The `bulkRestoreFilesFromTrashBin()` function returns a Promise that resolves when the files have been restored.
|
|
3189
|
+
* @param - IDs of the files to restore from the Media Manager's trash bin.
|
|
3190
|
+
*
|
|
3191
|
+
* You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
|
|
3192
|
+
* Learn more in the File and Folder IDs article.
|
|
3193
|
+
*/
|
|
3194
|
+
(fileIds: string[]): Promise<void>;
|
|
3195
|
+
}
|
|
3196
|
+
declare function listDeletedFiles$1(httpClient: HttpClient): ListDeletedFilesSignature;
|
|
3197
|
+
interface ListDeletedFilesSignature {
|
|
3198
|
+
/**
|
|
3199
|
+
* Retrieves a list of files in the Media Manager's trash bin.
|
|
3200
|
+
*
|
|
3201
|
+
* The `listDeletedFiles()` function returns a Promise that resolves to an array of the specified deleted files' descriptors and cursor information.
|
|
3202
|
+
*
|
|
3203
|
+
* >**Note:** The Media Manager's trash bin (`TRASH_ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
|
|
3204
|
+
*
|
|
3205
|
+
* To retrieve a list of non-deleted files, use the `listFiles()` function.
|
|
3206
|
+
* @param - Options to use when listing deleted files from the trash bin.
|
|
3207
|
+
*/
|
|
3208
|
+
(options?: ListDeletedFilesOptions | undefined): Promise<ListDeletedFilesResponse & ListDeletedFilesResponseNonNullableFields>;
|
|
3209
|
+
}
|
|
2835
3210
|
declare const onFileDescriptorUpdated$1: EventDefinition<FileDescriptorUpdatedEnvelope, "wix.media.site_media.v1.file_descriptor_updated">;
|
|
2836
3211
|
declare const onFileDescriptorDeleted$1: EventDefinition<FileDescriptorDeletedEnvelope, "wix.media.site_media.v1.file_descriptor_deleted">;
|
|
2837
3212
|
declare const onFileDescriptorFileReady$1: EventDefinition<FileDescriptorFileReadyEnvelope, "wix.media.site_media.v1.file_descriptor_file_ready">;
|
|
2838
3213
|
declare const onFileDescriptorFileFailed$1: EventDefinition<FileDescriptorFileFailedEnvelope, "wix.media.site_media.v1.file_descriptor_file_failed">;
|
|
2839
3214
|
|
|
2840
|
-
declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
2841
|
-
|
|
2842
3215
|
declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
2843
3216
|
|
|
2844
|
-
|
|
2845
|
-
declare const
|
|
2846
|
-
|
|
2847
|
-
declare const
|
|
2848
|
-
|
|
2849
|
-
declare const
|
|
2850
|
-
|
|
2851
|
-
declare const
|
|
2852
|
-
|
|
2853
|
-
declare const
|
|
2854
|
-
|
|
2855
|
-
declare const
|
|
2856
|
-
|
|
2857
|
-
declare const
|
|
2858
|
-
|
|
2859
|
-
declare const
|
|
2860
|
-
type _publicBulkImportFilesType = typeof bulkImportFiles$1;
|
|
2861
|
-
declare const bulkImportFiles: ReturnType<typeof createRESTModule$1<_publicBulkImportFilesType>>;
|
|
2862
|
-
type _publicBulkImportFileType = typeof bulkImportFile$1;
|
|
2863
|
-
declare const bulkImportFile: ReturnType<typeof createRESTModule$1<_publicBulkImportFileType>>;
|
|
2864
|
-
type _publicListFilesType = typeof listFiles$1;
|
|
2865
|
-
declare const listFiles: ReturnType<typeof createRESTModule$1<_publicListFilesType>>;
|
|
2866
|
-
type _publicSearchFilesType = typeof searchFiles$1;
|
|
2867
|
-
declare const searchFiles: ReturnType<typeof createRESTModule$1<_publicSearchFilesType>>;
|
|
2868
|
-
type _publicGenerateVideoStreamingUrlType = typeof generateVideoStreamingUrl$1;
|
|
2869
|
-
declare const generateVideoStreamingUrl: ReturnType<typeof createRESTModule$1<_publicGenerateVideoStreamingUrlType>>;
|
|
2870
|
-
type _publicBulkDeleteFilesType = typeof bulkDeleteFiles$1;
|
|
2871
|
-
declare const bulkDeleteFiles: ReturnType<typeof createRESTModule$1<_publicBulkDeleteFilesType>>;
|
|
2872
|
-
type _publicBulkRestoreFilesFromTrashBinType = typeof bulkRestoreFilesFromTrashBin$1;
|
|
2873
|
-
declare const bulkRestoreFilesFromTrashBin: ReturnType<typeof createRESTModule$1<_publicBulkRestoreFilesFromTrashBinType>>;
|
|
2874
|
-
type _publicListDeletedFilesType = typeof listDeletedFiles$1;
|
|
2875
|
-
declare const listDeletedFiles: ReturnType<typeof createRESTModule$1<_publicListDeletedFilesType>>;
|
|
3217
|
+
declare const generateFilesDownloadUrl: BuildRESTFunction<typeof generateFilesDownloadUrl$1> & typeof generateFilesDownloadUrl$1;
|
|
3218
|
+
declare const generateFileDownloadUrl: BuildRESTFunction<typeof generateFileDownloadUrl$1> & typeof generateFileDownloadUrl$1;
|
|
3219
|
+
declare const getFileDescriptor: BuildRESTFunction<typeof getFileDescriptor$1> & typeof getFileDescriptor$1;
|
|
3220
|
+
declare const getFileDescriptors: BuildRESTFunction<typeof getFileDescriptors$1> & typeof getFileDescriptors$1;
|
|
3221
|
+
declare const updateFileDescriptor: BuildRESTFunction<typeof updateFileDescriptor$1> & typeof updateFileDescriptor$1;
|
|
3222
|
+
declare const generateFileUploadUrl: BuildRESTFunction<typeof generateFileUploadUrl$1> & typeof generateFileUploadUrl$1;
|
|
3223
|
+
declare const generateFileResumableUploadUrl: BuildRESTFunction<typeof generateFileResumableUploadUrl$1> & typeof generateFileResumableUploadUrl$1;
|
|
3224
|
+
declare const importFile: BuildRESTFunction<typeof importFile$1> & typeof importFile$1;
|
|
3225
|
+
declare const bulkImportFiles: BuildRESTFunction<typeof bulkImportFiles$1> & typeof bulkImportFiles$1;
|
|
3226
|
+
declare const bulkImportFile: BuildRESTFunction<typeof bulkImportFile$1> & typeof bulkImportFile$1;
|
|
3227
|
+
declare const listFiles: BuildRESTFunction<typeof listFiles$1> & typeof listFiles$1;
|
|
3228
|
+
declare const searchFiles: BuildRESTFunction<typeof searchFiles$1> & typeof searchFiles$1;
|
|
3229
|
+
declare const generateVideoStreamingUrl: BuildRESTFunction<typeof generateVideoStreamingUrl$1> & typeof generateVideoStreamingUrl$1;
|
|
3230
|
+
declare const bulkDeleteFiles: BuildRESTFunction<typeof bulkDeleteFiles$1> & typeof bulkDeleteFiles$1;
|
|
3231
|
+
declare const bulkRestoreFilesFromTrashBin: BuildRESTFunction<typeof bulkRestoreFilesFromTrashBin$1> & typeof bulkRestoreFilesFromTrashBin$1;
|
|
3232
|
+
declare const listDeletedFiles: BuildRESTFunction<typeof listDeletedFiles$1> & typeof listDeletedFiles$1;
|
|
2876
3233
|
|
|
2877
3234
|
type _publicOnFileDescriptorUpdatedType = typeof onFileDescriptorUpdated$1;
|
|
3235
|
+
/** */
|
|
2878
3236
|
declare const onFileDescriptorUpdated: ReturnType<typeof createEventModule$1<_publicOnFileDescriptorUpdatedType>>;
|
|
2879
3237
|
|
|
2880
3238
|
type _publicOnFileDescriptorDeletedType = typeof onFileDescriptorDeleted$1;
|
|
3239
|
+
/** */
|
|
2881
3240
|
declare const onFileDescriptorDeleted: ReturnType<typeof createEventModule$1<_publicOnFileDescriptorDeletedType>>;
|
|
2882
3241
|
|
|
2883
3242
|
type _publicOnFileDescriptorFileReadyType = typeof onFileDescriptorFileReady$1;
|
|
3243
|
+
/** */
|
|
2884
3244
|
declare const onFileDescriptorFileReady: ReturnType<typeof createEventModule$1<_publicOnFileDescriptorFileReadyType>>;
|
|
2885
3245
|
|
|
2886
3246
|
type _publicOnFileDescriptorFileFailedType = typeof onFileDescriptorFileFailed$1;
|
|
3247
|
+
/** */
|
|
2887
3248
|
declare const onFileDescriptorFileFailed: ReturnType<typeof createEventModule$1<_publicOnFileDescriptorFileFailedType>>;
|
|
2888
3249
|
|
|
2889
3250
|
type index_d$1_ApplicationError = ApplicationError;
|
|
@@ -2985,26 +3346,10 @@ type index_d$1_UpdateFileResponse = UpdateFileResponse;
|
|
|
2985
3346
|
type index_d$1_UploadProtocol = UploadProtocol;
|
|
2986
3347
|
declare const index_d$1_UploadProtocol: typeof UploadProtocol;
|
|
2987
3348
|
type index_d$1_VideoResolution = VideoResolution;
|
|
2988
|
-
type index_d$1__publicBulkDeleteFilesType = _publicBulkDeleteFilesType;
|
|
2989
|
-
type index_d$1__publicBulkImportFileType = _publicBulkImportFileType;
|
|
2990
|
-
type index_d$1__publicBulkImportFilesType = _publicBulkImportFilesType;
|
|
2991
|
-
type index_d$1__publicBulkRestoreFilesFromTrashBinType = _publicBulkRestoreFilesFromTrashBinType;
|
|
2992
|
-
type index_d$1__publicGenerateFileDownloadUrlType = _publicGenerateFileDownloadUrlType;
|
|
2993
|
-
type index_d$1__publicGenerateFileResumableUploadUrlType = _publicGenerateFileResumableUploadUrlType;
|
|
2994
|
-
type index_d$1__publicGenerateFileUploadUrlType = _publicGenerateFileUploadUrlType;
|
|
2995
|
-
type index_d$1__publicGenerateFilesDownloadUrlType = _publicGenerateFilesDownloadUrlType;
|
|
2996
|
-
type index_d$1__publicGenerateVideoStreamingUrlType = _publicGenerateVideoStreamingUrlType;
|
|
2997
|
-
type index_d$1__publicGetFileDescriptorType = _publicGetFileDescriptorType;
|
|
2998
|
-
type index_d$1__publicGetFileDescriptorsType = _publicGetFileDescriptorsType;
|
|
2999
|
-
type index_d$1__publicImportFileType = _publicImportFileType;
|
|
3000
|
-
type index_d$1__publicListDeletedFilesType = _publicListDeletedFilesType;
|
|
3001
|
-
type index_d$1__publicListFilesType = _publicListFilesType;
|
|
3002
3349
|
type index_d$1__publicOnFileDescriptorDeletedType = _publicOnFileDescriptorDeletedType;
|
|
3003
3350
|
type index_d$1__publicOnFileDescriptorFileFailedType = _publicOnFileDescriptorFileFailedType;
|
|
3004
3351
|
type index_d$1__publicOnFileDescriptorFileReadyType = _publicOnFileDescriptorFileReadyType;
|
|
3005
3352
|
type index_d$1__publicOnFileDescriptorUpdatedType = _publicOnFileDescriptorUpdatedType;
|
|
3006
|
-
type index_d$1__publicSearchFilesType = _publicSearchFilesType;
|
|
3007
|
-
type index_d$1__publicUpdateFileDescriptorType = _publicUpdateFileDescriptorType;
|
|
3008
3353
|
declare const index_d$1_bulkDeleteFiles: typeof bulkDeleteFiles;
|
|
3009
3354
|
declare const index_d$1_bulkImportFile: typeof bulkImportFile;
|
|
3010
3355
|
declare const index_d$1_bulkImportFiles: typeof bulkImportFiles;
|
|
@@ -3026,7 +3371,7 @@ declare const index_d$1_onFileDescriptorUpdated: typeof onFileDescriptorUpdated;
|
|
|
3026
3371
|
declare const index_d$1_searchFiles: typeof searchFiles;
|
|
3027
3372
|
declare const index_d$1_updateFileDescriptor: typeof updateFileDescriptor;
|
|
3028
3373
|
declare namespace index_d$1 {
|
|
3029
|
-
export { type ActionEvent$1 as ActionEvent, type index_d$1_ApplicationError as ApplicationError, type index_d$1_Archive as Archive, type index_d$1_AudioV2 as AudioV2, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_BulkActionMetadata as BulkActionMetadata, type index_d$1_BulkDeleteFilesOptions as BulkDeleteFilesOptions, type index_d$1_BulkDeleteFilesRequest as BulkDeleteFilesRequest, type index_d$1_BulkDeleteFilesResponse as BulkDeleteFilesResponse, type index_d$1_BulkImportFileOptions as BulkImportFileOptions, type index_d$1_BulkImportFileRequest as BulkImportFileRequest, type index_d$1_BulkImportFileResponse as BulkImportFileResponse, type index_d$1_BulkImportFileResponseNonNullableFields as BulkImportFileResponseNonNullableFields, type index_d$1_BulkImportFileResult as BulkImportFileResult, type index_d$1_BulkImportFilesRequest as BulkImportFilesRequest, type index_d$1_BulkImportFilesResponse as BulkImportFilesResponse, type index_d$1_BulkImportFilesResponseNonNullableFields as BulkImportFilesResponseNonNullableFields, type index_d$1_BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest, type index_d$1_BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse, type index_d$1_Color as Color, type index_d$1_ColorRGB as ColorRGB, type index_d$1_Colors as Colors, index_d$1_ContentDisposition as ContentDisposition, type CursorPaging$1 as CursorPaging, type Cursors$1 as Cursors, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$1_DownloadUrl as DownloadUrl, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_ExternalInfo as ExternalInfo, type index_d$1_FaceRecognition as FaceRecognition, type index_d$1_FileDescriptor as FileDescriptor, type index_d$1_FileDescriptorDeletedEnvelope as FileDescriptorDeletedEnvelope, type index_d$1_FileDescriptorFileFailedEnvelope as FileDescriptorFileFailedEnvelope, type index_d$1_FileDescriptorFileReadyEnvelope as FileDescriptorFileReadyEnvelope, type index_d$1_FileDescriptorNonNullableFields as FileDescriptorNonNullableFields, type index_d$1_FileDescriptorUpdatedEnvelope as FileDescriptorUpdatedEnvelope, type index_d$1_FileFailed as FileFailed, type index_d$1_FileMedia as FileMedia, type index_d$1_FileMediaMediaOneOf as FileMediaMediaOneOf, type index_d$1_FileReady as FileReady, type index_d$1_GenerateFileDownloadUrlOptions as GenerateFileDownloadUrlOptions, type index_d$1_GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest, type index_d$1_GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse, type index_d$1_GenerateFileDownloadUrlResponseNonNullableFields as GenerateFileDownloadUrlResponseNonNullableFields, type index_d$1_GenerateFileResumableUploadUrlOptions as GenerateFileResumableUploadUrlOptions, type index_d$1_GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest, type index_d$1_GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse, type index_d$1_GenerateFileResumableUploadUrlResponseNonNullableFields as GenerateFileResumableUploadUrlResponseNonNullableFields, type index_d$1_GenerateFileUploadUrlOptions as GenerateFileUploadUrlOptions, type index_d$1_GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest, type index_d$1_GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse, type index_d$1_GenerateFileUploadUrlResponseNonNullableFields as GenerateFileUploadUrlResponseNonNullableFields, type index_d$1_GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest, type index_d$1_GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse, type index_d$1_GenerateFilesDownloadUrlResponseNonNullableFields as GenerateFilesDownloadUrlResponseNonNullableFields, type index_d$1_GenerateVideoStreamingUrlOptions as GenerateVideoStreamingUrlOptions, type index_d$1_GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest, type index_d$1_GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse, type index_d$1_GenerateVideoStreamingUrlResponseNonNullableFields as GenerateVideoStreamingUrlResponseNonNullableFields, type index_d$1_GenerateWebSocketTokenRequest as GenerateWebSocketTokenRequest, type index_d$1_GenerateWebSocketTokenResponse as GenerateWebSocketTokenResponse, type index_d$1_GetFileDescriptorRequest as GetFileDescriptorRequest, type index_d$1_GetFileDescriptorResponse as GetFileDescriptorResponse, type index_d$1_GetFileDescriptorResponseNonNullableFields as GetFileDescriptorResponseNonNullableFields, type index_d$1_GetFileDescriptorsRequest as GetFileDescriptorsRequest, type index_d$1_GetFileDescriptorsResponse as GetFileDescriptorsResponse, type index_d$1_GetFileDescriptorsResponseNonNullableFields as GetFileDescriptorsResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type index_d$1_IdentityInfo as IdentityInfo, index_d$1_IdentityType as IdentityType, type index_d$1_ImageMedia as ImageMedia, type index_d$1_ImportFileOptions as ImportFileOptions, type index_d$1_ImportFileRequest as ImportFileRequest, type index_d$1_ImportFileResponse as ImportFileResponse, type index_d$1_ImportFileResponseNonNullableFields as ImportFileResponseNonNullableFields, type index_d$1_ItemMetadata as ItemMetadata, type index_d$1_ListDeletedFilesOptions as ListDeletedFilesOptions, type index_d$1_ListDeletedFilesRequest as ListDeletedFilesRequest, type index_d$1_ListDeletedFilesResponse as ListDeletedFilesResponse, type index_d$1_ListDeletedFilesResponseNonNullableFields as ListDeletedFilesResponseNonNullableFields, type index_d$1_ListFilesOptions as ListFilesOptions, type index_d$1_ListFilesRequest as ListFilesRequest, type index_d$1_ListFilesResponse as ListFilesResponse, type index_d$1_ListFilesResponseNonNullableFields as ListFilesResponseNonNullableFields, index_d$1_MediaType as MediaType, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_Model3D as Model3D, Namespace$1 as Namespace, index_d$1_OperationStatus as OperationStatus, type index_d$1_OtherMedia as OtherMedia, type PagingMetadataV2$1 as PagingMetadataV2, type RestoreInfo$1 as RestoreInfo, RootFolder$1 as RootFolder, type index_d$1_SearchFilesOptions as SearchFilesOptions, type index_d$1_SearchFilesRequest as SearchFilesRequest, type index_d$1_SearchFilesResponse as SearchFilesResponse, type index_d$1_SearchFilesResponseNonNullableFields as SearchFilesResponseNonNullableFields, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, State$1 as State, index_d$1_StreamFormat as StreamFormat, type index_d$1_UpdateFileDescriptorRequest as UpdateFileDescriptorRequest, type index_d$1_UpdateFileDescriptorResponse as UpdateFileDescriptorResponse, type index_d$1_UpdateFileDescriptorResponseNonNullableFields as UpdateFileDescriptorResponseNonNullableFields, type index_d$1_UpdateFileRequest as UpdateFileRequest, type index_d$1_UpdateFileResponse as UpdateFileResponse, index_d$1_UploadProtocol as UploadProtocol, type index_d$1_VideoResolution as VideoResolution, WebhookIdentityType$1 as WebhookIdentityType, type index_d$1__publicBulkDeleteFilesType as _publicBulkDeleteFilesType, type index_d$1__publicBulkImportFileType as _publicBulkImportFileType, type index_d$1__publicBulkImportFilesType as _publicBulkImportFilesType, type index_d$1__publicBulkRestoreFilesFromTrashBinType as _publicBulkRestoreFilesFromTrashBinType, type index_d$1__publicGenerateFileDownloadUrlType as _publicGenerateFileDownloadUrlType, type index_d$1__publicGenerateFileResumableUploadUrlType as _publicGenerateFileResumableUploadUrlType, type index_d$1__publicGenerateFileUploadUrlType as _publicGenerateFileUploadUrlType, type index_d$1__publicGenerateFilesDownloadUrlType as _publicGenerateFilesDownloadUrlType, type index_d$1__publicGenerateVideoStreamingUrlType as _publicGenerateVideoStreamingUrlType, type index_d$1__publicGetFileDescriptorType as _publicGetFileDescriptorType, type index_d$1__publicGetFileDescriptorsType as _publicGetFileDescriptorsType, type index_d$1__publicImportFileType as _publicImportFileType, type index_d$1__publicListDeletedFilesType as _publicListDeletedFilesType, type index_d$1__publicListFilesType as _publicListFilesType, type index_d$1__publicOnFileDescriptorDeletedType as _publicOnFileDescriptorDeletedType, type index_d$1__publicOnFileDescriptorFileFailedType as _publicOnFileDescriptorFileFailedType, type index_d$1__publicOnFileDescriptorFileReadyType as _publicOnFileDescriptorFileReadyType, type index_d$1__publicOnFileDescriptorUpdatedType as _publicOnFileDescriptorUpdatedType, type index_d$1__publicSearchFilesType as _publicSearchFilesType, type index_d$1__publicUpdateFileDescriptorType as _publicUpdateFileDescriptorType, index_d$1_bulkDeleteFiles as bulkDeleteFiles, index_d$1_bulkImportFile as bulkImportFile, index_d$1_bulkImportFiles as bulkImportFiles, index_d$1_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin, index_d$1_generateFileDownloadUrl as generateFileDownloadUrl, index_d$1_generateFileResumableUploadUrl as generateFileResumableUploadUrl, index_d$1_generateFileUploadUrl as generateFileUploadUrl, index_d$1_generateFilesDownloadUrl as generateFilesDownloadUrl, index_d$1_generateVideoStreamingUrl as generateVideoStreamingUrl, index_d$1_getFileDescriptor as getFileDescriptor, index_d$1_getFileDescriptors as getFileDescriptors, index_d$1_importFile as importFile, index_d$1_listDeletedFiles as listDeletedFiles, index_d$1_listFiles as listFiles, index_d$1_onFileDescriptorDeleted as onFileDescriptorDeleted, index_d$1_onFileDescriptorFileFailed as onFileDescriptorFileFailed, index_d$1_onFileDescriptorFileReady as onFileDescriptorFileReady, index_d$1_onFileDescriptorUpdated as onFileDescriptorUpdated, onFileDescriptorDeleted$1 as publicOnFileDescriptorDeleted, onFileDescriptorFileFailed$1 as publicOnFileDescriptorFileFailed, onFileDescriptorFileReady$1 as publicOnFileDescriptorFileReady, onFileDescriptorUpdated$1 as publicOnFileDescriptorUpdated, index_d$1_searchFiles as searchFiles, index_d$1_updateFileDescriptor as updateFileDescriptor };
|
|
3374
|
+
export { type ActionEvent$1 as ActionEvent, type index_d$1_ApplicationError as ApplicationError, type index_d$1_Archive as Archive, type index_d$1_AudioV2 as AudioV2, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_BulkActionMetadata as BulkActionMetadata, type index_d$1_BulkDeleteFilesOptions as BulkDeleteFilesOptions, type index_d$1_BulkDeleteFilesRequest as BulkDeleteFilesRequest, type index_d$1_BulkDeleteFilesResponse as BulkDeleteFilesResponse, type index_d$1_BulkImportFileOptions as BulkImportFileOptions, type index_d$1_BulkImportFileRequest as BulkImportFileRequest, type index_d$1_BulkImportFileResponse as BulkImportFileResponse, type index_d$1_BulkImportFileResponseNonNullableFields as BulkImportFileResponseNonNullableFields, type index_d$1_BulkImportFileResult as BulkImportFileResult, type index_d$1_BulkImportFilesRequest as BulkImportFilesRequest, type index_d$1_BulkImportFilesResponse as BulkImportFilesResponse, type index_d$1_BulkImportFilesResponseNonNullableFields as BulkImportFilesResponseNonNullableFields, type index_d$1_BulkRestoreFilesFromTrashBinRequest as BulkRestoreFilesFromTrashBinRequest, type index_d$1_BulkRestoreFilesFromTrashBinResponse as BulkRestoreFilesFromTrashBinResponse, type index_d$1_Color as Color, type index_d$1_ColorRGB as ColorRGB, type index_d$1_Colors as Colors, index_d$1_ContentDisposition as ContentDisposition, type CursorPaging$1 as CursorPaging, type Cursors$1 as Cursors, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$1_DownloadUrl as DownloadUrl, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_ExternalInfo as ExternalInfo, type index_d$1_FaceRecognition as FaceRecognition, type index_d$1_FileDescriptor as FileDescriptor, type index_d$1_FileDescriptorDeletedEnvelope as FileDescriptorDeletedEnvelope, type index_d$1_FileDescriptorFileFailedEnvelope as FileDescriptorFileFailedEnvelope, type index_d$1_FileDescriptorFileReadyEnvelope as FileDescriptorFileReadyEnvelope, type index_d$1_FileDescriptorNonNullableFields as FileDescriptorNonNullableFields, type index_d$1_FileDescriptorUpdatedEnvelope as FileDescriptorUpdatedEnvelope, type index_d$1_FileFailed as FileFailed, type index_d$1_FileMedia as FileMedia, type index_d$1_FileMediaMediaOneOf as FileMediaMediaOneOf, type index_d$1_FileReady as FileReady, type index_d$1_GenerateFileDownloadUrlOptions as GenerateFileDownloadUrlOptions, type index_d$1_GenerateFileDownloadUrlRequest as GenerateFileDownloadUrlRequest, type index_d$1_GenerateFileDownloadUrlResponse as GenerateFileDownloadUrlResponse, type index_d$1_GenerateFileDownloadUrlResponseNonNullableFields as GenerateFileDownloadUrlResponseNonNullableFields, type index_d$1_GenerateFileResumableUploadUrlOptions as GenerateFileResumableUploadUrlOptions, type index_d$1_GenerateFileResumableUploadUrlRequest as GenerateFileResumableUploadUrlRequest, type index_d$1_GenerateFileResumableUploadUrlResponse as GenerateFileResumableUploadUrlResponse, type index_d$1_GenerateFileResumableUploadUrlResponseNonNullableFields as GenerateFileResumableUploadUrlResponseNonNullableFields, type index_d$1_GenerateFileUploadUrlOptions as GenerateFileUploadUrlOptions, type index_d$1_GenerateFileUploadUrlRequest as GenerateFileUploadUrlRequest, type index_d$1_GenerateFileUploadUrlResponse as GenerateFileUploadUrlResponse, type index_d$1_GenerateFileUploadUrlResponseNonNullableFields as GenerateFileUploadUrlResponseNonNullableFields, type index_d$1_GenerateFilesDownloadUrlRequest as GenerateFilesDownloadUrlRequest, type index_d$1_GenerateFilesDownloadUrlResponse as GenerateFilesDownloadUrlResponse, type index_d$1_GenerateFilesDownloadUrlResponseNonNullableFields as GenerateFilesDownloadUrlResponseNonNullableFields, type index_d$1_GenerateVideoStreamingUrlOptions as GenerateVideoStreamingUrlOptions, type index_d$1_GenerateVideoStreamingUrlRequest as GenerateVideoStreamingUrlRequest, type index_d$1_GenerateVideoStreamingUrlResponse as GenerateVideoStreamingUrlResponse, type index_d$1_GenerateVideoStreamingUrlResponseNonNullableFields as GenerateVideoStreamingUrlResponseNonNullableFields, type index_d$1_GenerateWebSocketTokenRequest as GenerateWebSocketTokenRequest, type index_d$1_GenerateWebSocketTokenResponse as GenerateWebSocketTokenResponse, type index_d$1_GetFileDescriptorRequest as GetFileDescriptorRequest, type index_d$1_GetFileDescriptorResponse as GetFileDescriptorResponse, type index_d$1_GetFileDescriptorResponseNonNullableFields as GetFileDescriptorResponseNonNullableFields, type index_d$1_GetFileDescriptorsRequest as GetFileDescriptorsRequest, type index_d$1_GetFileDescriptorsResponse as GetFileDescriptorsResponse, type index_d$1_GetFileDescriptorsResponseNonNullableFields as GetFileDescriptorsResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type index_d$1_IdentityInfo as IdentityInfo, index_d$1_IdentityType as IdentityType, type index_d$1_ImageMedia as ImageMedia, type index_d$1_ImportFileOptions as ImportFileOptions, type index_d$1_ImportFileRequest as ImportFileRequest, type index_d$1_ImportFileResponse as ImportFileResponse, type index_d$1_ImportFileResponseNonNullableFields as ImportFileResponseNonNullableFields, type index_d$1_ItemMetadata as ItemMetadata, type index_d$1_ListDeletedFilesOptions as ListDeletedFilesOptions, type index_d$1_ListDeletedFilesRequest as ListDeletedFilesRequest, type index_d$1_ListDeletedFilesResponse as ListDeletedFilesResponse, type index_d$1_ListDeletedFilesResponseNonNullableFields as ListDeletedFilesResponseNonNullableFields, type index_d$1_ListFilesOptions as ListFilesOptions, type index_d$1_ListFilesRequest as ListFilesRequest, type index_d$1_ListFilesResponse as ListFilesResponse, type index_d$1_ListFilesResponseNonNullableFields as ListFilesResponseNonNullableFields, index_d$1_MediaType as MediaType, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_Model3D as Model3D, Namespace$1 as Namespace, index_d$1_OperationStatus as OperationStatus, type index_d$1_OtherMedia as OtherMedia, type PagingMetadataV2$1 as PagingMetadataV2, type RestoreInfo$1 as RestoreInfo, RootFolder$1 as RootFolder, type index_d$1_SearchFilesOptions as SearchFilesOptions, type index_d$1_SearchFilesRequest as SearchFilesRequest, type index_d$1_SearchFilesResponse as SearchFilesResponse, type index_d$1_SearchFilesResponseNonNullableFields as SearchFilesResponseNonNullableFields, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, State$1 as State, index_d$1_StreamFormat as StreamFormat, type index_d$1_UpdateFileDescriptorRequest as UpdateFileDescriptorRequest, type index_d$1_UpdateFileDescriptorResponse as UpdateFileDescriptorResponse, type index_d$1_UpdateFileDescriptorResponseNonNullableFields as UpdateFileDescriptorResponseNonNullableFields, type index_d$1_UpdateFileRequest as UpdateFileRequest, type index_d$1_UpdateFileResponse as UpdateFileResponse, index_d$1_UploadProtocol as UploadProtocol, type index_d$1_VideoResolution as VideoResolution, WebhookIdentityType$1 as WebhookIdentityType, type index_d$1__publicOnFileDescriptorDeletedType as _publicOnFileDescriptorDeletedType, type index_d$1__publicOnFileDescriptorFileFailedType as _publicOnFileDescriptorFileFailedType, type index_d$1__publicOnFileDescriptorFileReadyType as _publicOnFileDescriptorFileReadyType, type index_d$1__publicOnFileDescriptorUpdatedType as _publicOnFileDescriptorUpdatedType, index_d$1_bulkDeleteFiles as bulkDeleteFiles, index_d$1_bulkImportFile as bulkImportFile, index_d$1_bulkImportFiles as bulkImportFiles, index_d$1_bulkRestoreFilesFromTrashBin as bulkRestoreFilesFromTrashBin, index_d$1_generateFileDownloadUrl as generateFileDownloadUrl, index_d$1_generateFileResumableUploadUrl as generateFileResumableUploadUrl, index_d$1_generateFileUploadUrl as generateFileUploadUrl, index_d$1_generateFilesDownloadUrl as generateFilesDownloadUrl, index_d$1_generateVideoStreamingUrl as generateVideoStreamingUrl, index_d$1_getFileDescriptor as getFileDescriptor, index_d$1_getFileDescriptors as getFileDescriptors, index_d$1_importFile as importFile, index_d$1_listDeletedFiles as listDeletedFiles, index_d$1_listFiles as listFiles, index_d$1_onFileDescriptorDeleted as onFileDescriptorDeleted, index_d$1_onFileDescriptorFileFailed as onFileDescriptorFileFailed, index_d$1_onFileDescriptorFileReady as onFileDescriptorFileReady, index_d$1_onFileDescriptorUpdated as onFileDescriptorUpdated, onFileDescriptorDeleted$1 as publicOnFileDescriptorDeleted, onFileDescriptorFileFailed$1 as publicOnFileDescriptorFileFailed, onFileDescriptorFileReady$1 as publicOnFileDescriptorFileReady, onFileDescriptorUpdated$1 as publicOnFileDescriptorUpdated, index_d$1_searchFiles as searchFiles, index_d$1_updateFileDescriptor as updateFileDescriptor };
|
|
3030
3375
|
}
|
|
3031
3376
|
|
|
3032
3377
|
interface Folder {
|
|
@@ -3526,49 +3871,153 @@ interface ListDeletedFoldersOptions {
|
|
|
3526
3871
|
paging?: CursorPaging;
|
|
3527
3872
|
}
|
|
3528
3873
|
|
|
3529
|
-
declare function createFolder$1(httpClient: HttpClient):
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3874
|
+
declare function createFolder$1(httpClient: HttpClient): CreateFolderSignature;
|
|
3875
|
+
interface CreateFolderSignature {
|
|
3876
|
+
/**
|
|
3877
|
+
* Creates a new folder in the Media Manager.
|
|
3878
|
+
*
|
|
3879
|
+
* The `createFolder()` function returns a Promise that resolves to the created folder.
|
|
3880
|
+
*
|
|
3881
|
+
* Use the `parentFolderId` parameter to specify in which existing folder you want the new folder to be created.
|
|
3882
|
+
* If no folder is specified, the new folder is created in the `media-root` folder.
|
|
3883
|
+
* @param - Folder name that appears in the Media Manager.
|
|
3884
|
+
* @param - Options for specifying where to create a folder.
|
|
3885
|
+
*/
|
|
3886
|
+
(displayName: string, options?: CreateFolderOptions | undefined): Promise<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
|
|
3887
|
+
}
|
|
3888
|
+
declare function getFolder$1(httpClient: HttpClient): GetFolderSignature;
|
|
3889
|
+
interface GetFolderSignature {
|
|
3890
|
+
/**
|
|
3891
|
+
* Gets information from the specified folder in the Media Manager.
|
|
3892
|
+
*
|
|
3893
|
+
* The `getFolder()` function returns a Promise that resolves to information about the specified folder.
|
|
3894
|
+
* @param - Folder ID.
|
|
3895
|
+
* @returns Information about the folder.
|
|
3896
|
+
*/
|
|
3897
|
+
(folderId: string): Promise<Folder & FolderNonNullableFields>;
|
|
3898
|
+
}
|
|
3899
|
+
declare function listFolders$1(httpClient: HttpClient): ListFoldersSignature;
|
|
3900
|
+
interface ListFoldersSignature {
|
|
3901
|
+
/**
|
|
3902
|
+
* Retrieves a list of folders in the Media Manager.
|
|
3903
|
+
*
|
|
3904
|
+
* The `listFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
3905
|
+
*
|
|
3906
|
+
* To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the `parentFolderId` parameter. If no folder is specified, the function retrieves only the list of folders within the root folder of the Media Manager.
|
|
3907
|
+
*
|
|
3908
|
+
* To retrieve a list of (non-permanently) deleted folders, use the `listDeletedFolders()` function.
|
|
3909
|
+
* @param - Options to use when listing folders from the Media Manager.
|
|
3910
|
+
*/
|
|
3911
|
+
(options?: ListFoldersOptions | undefined): Promise<ListFoldersResponse & ListFoldersResponseNonNullableFields>;
|
|
3912
|
+
}
|
|
3913
|
+
declare function searchFolders$1(httpClient: HttpClient): SearchFoldersSignature;
|
|
3914
|
+
interface SearchFoldersSignature {
|
|
3915
|
+
/**
|
|
3916
|
+
* Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.
|
|
3917
|
+
*
|
|
3918
|
+
* The `searchFolders()` function returns a Promise that resolves to information about the specified folders and cursor information.
|
|
3919
|
+
*
|
|
3920
|
+
* If no parameters are specified, the function returns all folders in the `MEDIA_ROOT` folder.
|
|
3921
|
+
* @param - Options specifying which folders to search.
|
|
3922
|
+
*/
|
|
3923
|
+
(options?: SearchFoldersOptions | undefined): Promise<SearchFoldersResponse & SearchFoldersResponseNonNullableFields>;
|
|
3924
|
+
}
|
|
3925
|
+
declare function updateFolder$1(httpClient: HttpClient): UpdateFolderSignature;
|
|
3926
|
+
interface UpdateFolderSignature {
|
|
3927
|
+
/**
|
|
3928
|
+
* Updates a folder.
|
|
3929
|
+
*
|
|
3930
|
+
* The `updateFolder()` function returns a Promise that resolves to information about the updated folder.
|
|
3931
|
+
*
|
|
3932
|
+
* You can use the `parentFolderId` parameter to move a folder from its current parent folder to a different parent folder.
|
|
3933
|
+
* @param - Folder ID. Generated when a folder is created in the Media Manager.
|
|
3934
|
+
* @param - Folder to update.
|
|
3935
|
+
* @returns Information about the updated folder.
|
|
3936
|
+
*/
|
|
3937
|
+
(_id: string, folder: UpdateFolder): Promise<Folder & FolderNonNullableFields>;
|
|
3938
|
+
}
|
|
3939
|
+
declare function generateFolderDownloadUrl$1(httpClient: HttpClient): GenerateFolderDownloadUrlSignature;
|
|
3940
|
+
interface GenerateFolderDownloadUrlSignature {
|
|
3941
|
+
/**
|
|
3942
|
+
* Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.
|
|
3943
|
+
*
|
|
3944
|
+
* The `generateFolderDownloadUrl()` function returns a Promise that resolves to a download URL.
|
|
3945
|
+
*
|
|
3946
|
+
* The compressed file can contain sub-folders, and up to 1000 files.
|
|
3947
|
+
* @param - Folder ID.
|
|
3948
|
+
*/
|
|
3949
|
+
(folderId: string): Promise<GenerateFolderDownloadUrlResponse & GenerateFolderDownloadUrlResponseNonNullableFields>;
|
|
3950
|
+
}
|
|
3951
|
+
declare function bulkDeleteFolders$1(httpClient: HttpClient): BulkDeleteFoldersSignature;
|
|
3952
|
+
interface BulkDeleteFoldersSignature {
|
|
3953
|
+
/**
|
|
3954
|
+
* Temporarily deletes the specified folders from the Media Manager.
|
|
3955
|
+
*
|
|
3956
|
+
* The `bulkDeleteFolders()` function returns a Promise that resolves when the folders are deleted.
|
|
3957
|
+
*
|
|
3958
|
+
* The deleted folders are moved to the Media Manager's `TRASH_ROOT` folder (trash bin) unless permanently deleted. To permanently delete folders, pass the `permanent` parameter with the value `true`. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.
|
|
3959
|
+
*
|
|
3960
|
+
* >**Notes:**
|
|
3961
|
+
* > - When a folder is deleted, the files in that folder are deleted.
|
|
3962
|
+
* > - The specified folders can be from different parent folders.
|
|
3963
|
+
* > - Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
|
|
3964
|
+
* > - Attempting to delete folders that are already in the trash bin doesn't result in an error.
|
|
3965
|
+
* > - If your site contains files from a non-permanently deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
|
|
3966
|
+
* > - You can use the `bulkRestoreFoldersFromTrashBin()` function to restore folders from the Media Manager's trash bin.
|
|
3967
|
+
* @param - IDs of the folders to move to the Media Manager's trash bin.
|
|
3968
|
+
* @param - Options to use when deleting folders.
|
|
3969
|
+
*/
|
|
3970
|
+
(folderIds: string[], options?: BulkDeleteFoldersOptions | undefined): Promise<void>;
|
|
3971
|
+
}
|
|
3972
|
+
declare function bulkRestoreFoldersFromTrashBin$1(httpClient: HttpClient): BulkRestoreFoldersFromTrashBinSignature;
|
|
3973
|
+
interface BulkRestoreFoldersFromTrashBinSignature {
|
|
3974
|
+
/**
|
|
3975
|
+
* Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
|
|
3976
|
+
*
|
|
3977
|
+
*
|
|
3978
|
+
* The `bulkRestoreFoldersFromTrashBin()` function returns a Promise that resolves when the folders have been restored.
|
|
3979
|
+
* @param - IDs of the folders to restore from the Media Manager's trash bin.
|
|
3980
|
+
*/
|
|
3981
|
+
(folderIds: string[]): Promise<void>;
|
|
3982
|
+
}
|
|
3983
|
+
declare function listDeletedFolders$1(httpClient: HttpClient): ListDeletedFoldersSignature;
|
|
3984
|
+
interface ListDeletedFoldersSignature {
|
|
3985
|
+
/**
|
|
3986
|
+
* Retrieves a list of deleted folders from the trash bin.
|
|
3987
|
+
*
|
|
3988
|
+
* The `listDeletedFolders()` function returns a Promise that resolves to information about the specified deleted folders and cursor information.
|
|
3989
|
+
*
|
|
3990
|
+
* To retrieve a list of non-deleted folders, use the `listFolders()` function.
|
|
3991
|
+
* @param - Options to use when listing deleted folders from the trash bin.
|
|
3992
|
+
*/
|
|
3993
|
+
(options?: ListDeletedFoldersOptions | undefined): Promise<ListDeletedFoldersResponse & ListDeletedFoldersResponseNonNullableFields>;
|
|
3994
|
+
}
|
|
3538
3995
|
declare const onFolderCreated$1: EventDefinition<FolderCreatedEnvelope, "wix.media.site_media.v1.folder_created">;
|
|
3539
3996
|
declare const onFolderUpdated$1: EventDefinition<FolderUpdatedEnvelope, "wix.media.site_media.v1.folder_updated">;
|
|
3540
3997
|
declare const onFolderDeleted$1: EventDefinition<FolderDeletedEnvelope, "wix.media.site_media.v1.folder_deleted">;
|
|
3541
3998
|
|
|
3542
|
-
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
3543
|
-
|
|
3544
3999
|
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3545
4000
|
|
|
3546
|
-
|
|
3547
|
-
declare const
|
|
3548
|
-
|
|
3549
|
-
declare const
|
|
3550
|
-
|
|
3551
|
-
declare const
|
|
3552
|
-
|
|
3553
|
-
declare const
|
|
3554
|
-
|
|
3555
|
-
declare const updateFolder: ReturnType<typeof createRESTModule<_publicUpdateFolderType>>;
|
|
3556
|
-
type _publicGenerateFolderDownloadUrlType = typeof generateFolderDownloadUrl$1;
|
|
3557
|
-
declare const generateFolderDownloadUrl: ReturnType<typeof createRESTModule<_publicGenerateFolderDownloadUrlType>>;
|
|
3558
|
-
type _publicBulkDeleteFoldersType = typeof bulkDeleteFolders$1;
|
|
3559
|
-
declare const bulkDeleteFolders: ReturnType<typeof createRESTModule<_publicBulkDeleteFoldersType>>;
|
|
3560
|
-
type _publicBulkRestoreFoldersFromTrashBinType = typeof bulkRestoreFoldersFromTrashBin$1;
|
|
3561
|
-
declare const bulkRestoreFoldersFromTrashBin: ReturnType<typeof createRESTModule<_publicBulkRestoreFoldersFromTrashBinType>>;
|
|
3562
|
-
type _publicListDeletedFoldersType = typeof listDeletedFolders$1;
|
|
3563
|
-
declare const listDeletedFolders: ReturnType<typeof createRESTModule<_publicListDeletedFoldersType>>;
|
|
4001
|
+
declare const createFolder: BuildRESTFunction<typeof createFolder$1> & typeof createFolder$1;
|
|
4002
|
+
declare const getFolder: BuildRESTFunction<typeof getFolder$1> & typeof getFolder$1;
|
|
4003
|
+
declare const listFolders: BuildRESTFunction<typeof listFolders$1> & typeof listFolders$1;
|
|
4004
|
+
declare const searchFolders: BuildRESTFunction<typeof searchFolders$1> & typeof searchFolders$1;
|
|
4005
|
+
declare const updateFolder: BuildRESTFunction<typeof updateFolder$1> & typeof updateFolder$1;
|
|
4006
|
+
declare const generateFolderDownloadUrl: BuildRESTFunction<typeof generateFolderDownloadUrl$1> & typeof generateFolderDownloadUrl$1;
|
|
4007
|
+
declare const bulkDeleteFolders: BuildRESTFunction<typeof bulkDeleteFolders$1> & typeof bulkDeleteFolders$1;
|
|
4008
|
+
declare const bulkRestoreFoldersFromTrashBin: BuildRESTFunction<typeof bulkRestoreFoldersFromTrashBin$1> & typeof bulkRestoreFoldersFromTrashBin$1;
|
|
4009
|
+
declare const listDeletedFolders: BuildRESTFunction<typeof listDeletedFolders$1> & typeof listDeletedFolders$1;
|
|
3564
4010
|
|
|
3565
4011
|
type _publicOnFolderCreatedType = typeof onFolderCreated$1;
|
|
4012
|
+
/** */
|
|
3566
4013
|
declare const onFolderCreated: ReturnType<typeof createEventModule<_publicOnFolderCreatedType>>;
|
|
3567
4014
|
|
|
3568
4015
|
type _publicOnFolderUpdatedType = typeof onFolderUpdated$1;
|
|
4016
|
+
/** */
|
|
3569
4017
|
declare const onFolderUpdated: ReturnType<typeof createEventModule<_publicOnFolderUpdatedType>>;
|
|
3570
4018
|
|
|
3571
4019
|
type _publicOnFolderDeletedType = typeof onFolderDeleted$1;
|
|
4020
|
+
/** */
|
|
3572
4021
|
declare const onFolderDeleted: ReturnType<typeof createEventModule<_publicOnFolderDeletedType>>;
|
|
3573
4022
|
|
|
3574
4023
|
type index_d_ActionEvent = ActionEvent;
|
|
@@ -3633,18 +4082,9 @@ type index_d_UpdateFolderResponse = UpdateFolderResponse;
|
|
|
3633
4082
|
type index_d_UpdateFolderResponseNonNullableFields = UpdateFolderResponseNonNullableFields;
|
|
3634
4083
|
type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
3635
4084
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
3636
|
-
type index_d__publicBulkDeleteFoldersType = _publicBulkDeleteFoldersType;
|
|
3637
|
-
type index_d__publicBulkRestoreFoldersFromTrashBinType = _publicBulkRestoreFoldersFromTrashBinType;
|
|
3638
|
-
type index_d__publicCreateFolderType = _publicCreateFolderType;
|
|
3639
|
-
type index_d__publicGenerateFolderDownloadUrlType = _publicGenerateFolderDownloadUrlType;
|
|
3640
|
-
type index_d__publicGetFolderType = _publicGetFolderType;
|
|
3641
|
-
type index_d__publicListDeletedFoldersType = _publicListDeletedFoldersType;
|
|
3642
|
-
type index_d__publicListFoldersType = _publicListFoldersType;
|
|
3643
4085
|
type index_d__publicOnFolderCreatedType = _publicOnFolderCreatedType;
|
|
3644
4086
|
type index_d__publicOnFolderDeletedType = _publicOnFolderDeletedType;
|
|
3645
4087
|
type index_d__publicOnFolderUpdatedType = _publicOnFolderUpdatedType;
|
|
3646
|
-
type index_d__publicSearchFoldersType = _publicSearchFoldersType;
|
|
3647
|
-
type index_d__publicUpdateFolderType = _publicUpdateFolderType;
|
|
3648
4088
|
declare const index_d_bulkDeleteFolders: typeof bulkDeleteFolders;
|
|
3649
4089
|
declare const index_d_bulkRestoreFoldersFromTrashBin: typeof bulkRestoreFoldersFromTrashBin;
|
|
3650
4090
|
declare const index_d_createFolder: typeof createFolder;
|
|
@@ -3658,7 +4098,7 @@ declare const index_d_onFolderUpdated: typeof onFolderUpdated;
|
|
|
3658
4098
|
declare const index_d_searchFolders: typeof searchFolders;
|
|
3659
4099
|
declare const index_d_updateFolder: typeof updateFolder;
|
|
3660
4100
|
declare namespace index_d {
|
|
3661
|
-
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BulkDeleteFoldersOptions as BulkDeleteFoldersOptions, type index_d_BulkDeleteFoldersRequest as BulkDeleteFoldersRequest, type index_d_BulkDeleteFoldersResponse as BulkDeleteFoldersResponse, type index_d_BulkRestoreFoldersFromTrashBinRequest as BulkRestoreFoldersFromTrashBinRequest, type index_d_BulkRestoreFoldersFromTrashBinResponse as BulkRestoreFoldersFromTrashBinResponse, type index_d_CreateFolderOptions as CreateFolderOptions, type index_d_CreateFolderRequest as CreateFolderRequest, type index_d_CreateFolderResponse as CreateFolderResponse, type index_d_CreateFolderResponseNonNullableFields as CreateFolderResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_Folder as Folder, type index_d_FolderCreatedEnvelope as FolderCreatedEnvelope, type index_d_FolderDeletedEnvelope as FolderDeletedEnvelope, type index_d_FolderNonNullableFields as FolderNonNullableFields, type index_d_FolderUpdatedEnvelope as FolderUpdatedEnvelope, type index_d_GenerateFolderDownloadUrlRequest as GenerateFolderDownloadUrlRequest, type index_d_GenerateFolderDownloadUrlResponse as GenerateFolderDownloadUrlResponse, type index_d_GenerateFolderDownloadUrlResponseNonNullableFields as GenerateFolderDownloadUrlResponseNonNullableFields, type index_d_GetFolderRequest as GetFolderRequest, type index_d_GetFolderResponse as GetFolderResponse, type index_d_GetFolderResponseNonNullableFields as GetFolderResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListDeletedFoldersOptions as ListDeletedFoldersOptions, type index_d_ListDeletedFoldersRequest as ListDeletedFoldersRequest, type index_d_ListDeletedFoldersResponse as ListDeletedFoldersResponse, type index_d_ListDeletedFoldersResponseNonNullableFields as ListDeletedFoldersResponseNonNullableFields, type index_d_ListFoldersOptions as ListFoldersOptions, type index_d_ListFoldersRequest as ListFoldersRequest, type index_d_ListFoldersResponse as ListFoldersResponse, type index_d_ListFoldersResponseNonNullableFields as ListFoldersResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, index_d_Namespace as Namespace, type index_d_PagingMetadataV2 as PagingMetadataV2, type index_d_RestoreInfo as RestoreInfo, index_d_RootFolder as RootFolder, type index_d_SearchFoldersOptions as SearchFoldersOptions, type index_d_SearchFoldersRequest as SearchFoldersRequest, type index_d_SearchFoldersResponse as SearchFoldersResponse, type index_d_SearchFoldersResponseNonNullableFields as SearchFoldersResponseNonNullableFields, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_State as State, type index_d_UpdateFolder as UpdateFolder, type index_d_UpdateFolderRequest as UpdateFolderRequest, type index_d_UpdateFolderResponse as UpdateFolderResponse, type index_d_UpdateFolderResponseNonNullableFields as UpdateFolderResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, type
|
|
4101
|
+
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BulkDeleteFoldersOptions as BulkDeleteFoldersOptions, type index_d_BulkDeleteFoldersRequest as BulkDeleteFoldersRequest, type index_d_BulkDeleteFoldersResponse as BulkDeleteFoldersResponse, type index_d_BulkRestoreFoldersFromTrashBinRequest as BulkRestoreFoldersFromTrashBinRequest, type index_d_BulkRestoreFoldersFromTrashBinResponse as BulkRestoreFoldersFromTrashBinResponse, type index_d_CreateFolderOptions as CreateFolderOptions, type index_d_CreateFolderRequest as CreateFolderRequest, type index_d_CreateFolderResponse as CreateFolderResponse, type index_d_CreateFolderResponseNonNullableFields as CreateFolderResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_Cursors as Cursors, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_Folder as Folder, type index_d_FolderCreatedEnvelope as FolderCreatedEnvelope, type index_d_FolderDeletedEnvelope as FolderDeletedEnvelope, type index_d_FolderNonNullableFields as FolderNonNullableFields, type index_d_FolderUpdatedEnvelope as FolderUpdatedEnvelope, type index_d_GenerateFolderDownloadUrlRequest as GenerateFolderDownloadUrlRequest, type index_d_GenerateFolderDownloadUrlResponse as GenerateFolderDownloadUrlResponse, type index_d_GenerateFolderDownloadUrlResponseNonNullableFields as GenerateFolderDownloadUrlResponseNonNullableFields, type index_d_GetFolderRequest as GetFolderRequest, type index_d_GetFolderResponse as GetFolderResponse, type index_d_GetFolderResponseNonNullableFields as GetFolderResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_ListDeletedFoldersOptions as ListDeletedFoldersOptions, type index_d_ListDeletedFoldersRequest as ListDeletedFoldersRequest, type index_d_ListDeletedFoldersResponse as ListDeletedFoldersResponse, type index_d_ListDeletedFoldersResponseNonNullableFields as ListDeletedFoldersResponseNonNullableFields, type index_d_ListFoldersOptions as ListFoldersOptions, type index_d_ListFoldersRequest as ListFoldersRequest, type index_d_ListFoldersResponse as ListFoldersResponse, type index_d_ListFoldersResponseNonNullableFields as ListFoldersResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, index_d_Namespace as Namespace, type index_d_PagingMetadataV2 as PagingMetadataV2, type index_d_RestoreInfo as RestoreInfo, index_d_RootFolder as RootFolder, type index_d_SearchFoldersOptions as SearchFoldersOptions, type index_d_SearchFoldersRequest as SearchFoldersRequest, type index_d_SearchFoldersResponse as SearchFoldersResponse, type index_d_SearchFoldersResponseNonNullableFields as SearchFoldersResponseNonNullableFields, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, index_d_State as State, type index_d_UpdateFolder as UpdateFolder, type index_d_UpdateFolderRequest as UpdateFolderRequest, type index_d_UpdateFolderResponse as UpdateFolderResponse, type index_d_UpdateFolderResponseNonNullableFields as UpdateFolderResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnFolderCreatedType as _publicOnFolderCreatedType, type index_d__publicOnFolderDeletedType as _publicOnFolderDeletedType, type index_d__publicOnFolderUpdatedType as _publicOnFolderUpdatedType, index_d_bulkDeleteFolders as bulkDeleteFolders, index_d_bulkRestoreFoldersFromTrashBin as bulkRestoreFoldersFromTrashBin, index_d_createFolder as createFolder, index_d_generateFolderDownloadUrl as generateFolderDownloadUrl, index_d_getFolder as getFolder, index_d_listDeletedFolders as listDeletedFolders, index_d_listFolders as listFolders, index_d_onFolderCreated as onFolderCreated, index_d_onFolderDeleted as onFolderDeleted, index_d_onFolderUpdated as onFolderUpdated, onFolderCreated$1 as publicOnFolderCreated, onFolderDeleted$1 as publicOnFolderDeleted, onFolderUpdated$1 as publicOnFolderUpdated, index_d_searchFolders as searchFolders, index_d_updateFolder as updateFolder };
|
|
3662
4102
|
}
|
|
3663
4103
|
|
|
3664
4104
|
export { index_d$3 as enterpriseMediaCategories, index_d$2 as enterpriseMediaItems, index_d$1 as files, index_d as folders };
|