1 | import { DefaultElements, MakeRequest, MetaSysProps, SysLink } from '../common-types';
|
2 | export declare type UploadProps = {
|
3 | /**
|
4 | * System metadata
|
5 | */
|
6 | sys: MetaSysProps & {
|
7 | space: SysLink;
|
8 | };
|
9 | };
|
10 | export interface Upload extends UploadProps, DefaultElements<UploadProps> {
|
11 | /**
|
12 | * Deletes this object on the server.
|
13 | * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
|
14 | * @example
|
15 | * const contentful = require('contentful-management')
|
16 | *
|
17 | * const client = contentful.createClient({
|
18 | * accessToken: '<content_management_api_key>'
|
19 | * })
|
20 | *
|
21 | * client.getSpace('<space_id>')
|
22 | * .then((space) => space.getEnvironment('<environment_id>'))
|
23 | * .then((environment) => environment.getUpload('<upload_id>'))
|
24 | * .then((upload) => upload.delete())
|
25 | * .then((upload) => console.log(`upload ${upload.sys.id} updated.`))
|
26 | * .catch(console.error)
|
27 | */
|
28 | delete(): Promise<void>;
|
29 | }
|
30 | /**
|
31 | * @private
|
32 | * @param {function} makeRequest - function to make requests via an adapter
|
33 | * @param {object} data - Raw upload data
|
34 | * @return {Upload} Wrapped upload data
|
35 | */
|
36 | export declare function wrapUpload(makeRequest: MakeRequest, data: UploadProps): {
|
37 | delete: () => Promise<void>;
|
38 | } & UploadProps & {
|
39 | toPlainObject(): UploadProps;
|
40 | };
|