Skip to main content

Function: mediaDocumentService()

mediaDocumentService(client): object

Defined in: service/MediaDocumentService.ts:18

Service for managing media documents

Parameters

client

GraphQLClient

Returns

createMediaDocument()

createMediaDocument(input): Promise<MediaDocument>

Creates a new media document *

Parameters

input

MediaDocumentInput

Media document creation input *

Returns

Promise<MediaDocument>

Promise<MediaDocument> The created media document

deleteMediaDocument()

deleteMediaDocument(variables): Promise&lt;DeleteMediaDocumentResponse>

Deletes a media document *

Parameters

variables

MediaDocumentDeleteVariables

Media document ID *

Returns

Promise&lt;DeleteMediaDocumentResponse>

Promise<boolean> Success status

getMediaDocument()

getMediaDocument(variables): Promise&lt;MediaDocument>

Retrieves a specific media document *

Parameters

variables

MediaDocumentVariables

Media document ID *

Returns

Promise&lt;MediaDocument>

Promise<MediaDocument> Media document data

Deprecated

The upstream mediaDocument query is deprecated; read via media.document from the parent resource instead. *

getMediaDocuments()

getMediaDocuments(variables): Promise&lt;PaginatedMediaDocumentResponse>

Retrieves media documents with pagination *

Parameters

variables

MediaDocumentsVariables

Search input parameters *

Returns

Promise&lt;PaginatedMediaDocumentResponse>

Promise<PaginatedMediaDocumentResponse> Paginated media documents

Deprecated

The upstream mediaDocuments query is deprecated; read via media.documents from the parent resource instead. *

updateMediaDocument()

updateMediaDocument(input): Promise&lt;MediaDocument>

Updates an existing media document *

Parameters

input

UpdateMediaDocumentInput

Media document update input *

Returns

Promise&lt;MediaDocument>

Promise<MediaDocument> The updated media document