Class MediaAPI

constructor

• new MediaAPI(httpRequest): MediaAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MediaAPI

Readonly httpRequest

createMediaFolder

• createMediaFolder(__namedParameters): CancelablePromise<GetMediaResponse>

• Create a media folder Create a new media folder for a company

  Parameters

  • __namedParameters: {
        companyId: string;
    }

    • companyId: string

      Company ID for which to create media folder

  Returns CancelablePromise<GetMediaResponse>

  GetMediaResponse

  Throws

  ApiError

deleteMedia

• deleteMedia(__namedParameters): CancelablePromise<DeleteMediaResponse>

• Remove a media file Remove a media file from a company.

  Parameters

  • __namedParameters: {
        companyId: string;
        mediaId: string;
    }

    • companyId: string

      Company ID for which to remove media

    • mediaId: string

      Media ID to delete

  Returns CancelablePromise<DeleteMediaResponse>

  DeleteMediaResponse

  Throws

  ApiError

deleteMediaFolder

• deleteMediaFolder(__namedParameters): CancelablePromise<DeleteMediaResponse>

• Remove a media folder Remove a media folder from a company. Folder must be empty.

  Parameters

  • __namedParameters: {
        companyId: string;
        folderId: string;
    }

    • companyId: string

      Company ID for which to remove media folder

    • folderId: string

      Folder ID to delete

  Returns CancelablePromise<DeleteMediaResponse>

  DeleteMediaResponse

  Throws

  ApiError

getMedia

• getMedia(__namedParameters): CancelablePromise<GetMediaResponse>

• Get media by ID Fetch the details of a specific media file by its ID

  Parameters

  • __namedParameters: {
        companyId: string;
        mediaId: string;
    }

    • companyId: string

      Company ID the media belongs to

    • mediaId: string

      ID of the media to retrieve

  Returns CancelablePromise<GetMediaResponse>

  GetMediaResponse

  Throws

  ApiError

getMediaFolder

• getMediaFolder(__namedParameters): CancelablePromise<GetMediaResponse>

• Get media folder by ID Fetch the details of a specific media folder by its ID

  Parameters

  • __namedParameters: {
        companyId: string;
        folderId: string;
    }

    • companyId: string

      Company ID the folder belongs to

    • folderId: string

      ID of the folder to retrieve

  Returns CancelablePromise<GetMediaResponse>

  GetMediaResponse

  Throws

  ApiError

getRootMediaFolders

• getRootMediaFolders(__namedParameters): CancelablePromise<ListMediaResponse>

• Get root media folders Get all root-level media folders for a company

  Parameters

  • __namedParameters: {
        companyId: string;
        projectId?: string;
    }

    • companyId: string

      Company ID for which to get root folders

    • Optional projectId?: string

      Project ID to filter folders

  Returns CancelablePromise<ListMediaResponse>

  ListMediaResponse

  Throws

  ApiError

listMedia

• listMedia(__namedParameters): CancelablePromise<ListMediaResponse>

• List media files Get all media files for a company, optionally filtered by project or type

  Parameters

  • __namedParameters: {
        companyId: string;
        folderId?: string;
        limit?: number;
        page?: number;
        projectId?: string;
        search?: string;
        type?: string;
    }

    • companyId: string

      Company ID for which to list media

    • Optional folderId?: string

      Folder ID to filter media

    • Optional limit?: number

      Items to limit per page

    • Optional page?: number

      Page being requested

    • Optional projectId?: string

      Project ID to filter media

    • Optional search?: string

    • Optional type?: string

      Media type to filter

  Returns CancelablePromise<ListMediaResponse>

  ListMediaResponse

  Throws

  ApiError

listMediaFolders

• listMediaFolders(__namedParameters): CancelablePromise<ListMediaResponse>

• List media folders Get all media folders for a company, optionally filtered by project or parent folder

  Parameters

  • __namedParameters: {
        companyId: string;
        limit?: number;
        page?: number;
        parentFolderId?: string;
        projectId?: string;
        search?: string;
    }

    • companyId: string

      Company ID for which to list media folders

    • Optional limit?: number

      Items to limit per page

    • Optional page?: number

      Page being requested

    • Optional parentFolderId?: string

      Parent folder ID to filter subfolders

    • Optional projectId?: string

      Project ID to filter folders

    • Optional search?: string

  Returns CancelablePromise<ListMediaResponse>

  ListMediaResponse

  Throws

  ApiError

updateMedia

• updateMedia(__namedParameters): CancelablePromise<UpdateMediaResponse>

• Update a media file Update an existing media file for a company

  Parameters

  • __namedParameters: {
        companyId: string;
        mediaId: string;
        requestBody: UpdateMediaRequestBody;
    }

    • companyId: string

      Company ID for which to update media

    • mediaId: string

      Media ID to update

    • requestBody: UpdateMediaRequestBody

  Returns CancelablePromise<UpdateMediaResponse>

  UpdateMediaResponse

  Throws

  ApiError

updateMediaFolder

• updateMediaFolder(__namedParameters): CancelablePromise<UpdateMediaResponse>

• Update a media folder Update an existing media folder for a company

  Parameters

  • __namedParameters: {
        companyId: string;
        folderId: string;
    }

    • companyId: string

      Company ID for which to update media folder

    • folderId: string

      Folder ID to update

  Returns CancelablePromise<UpdateMediaResponse>

  UpdateMediaResponse

  Throws

  ApiError

uploadMedia

• uploadMedia(__namedParameters): CancelablePromise<UploadMediaResponse>

• Upload media files Upload one or more media files to a company

  Parameters

  • __namedParameters: {
        companyId: string;
        formData: UploadMediaRequestBody;
    }

    • companyId: string

      Company ID for which to upload media

    • formData: UploadMediaRequestBody

  Returns CancelablePromise<UploadMediaResponse>

  UploadMediaResponse

  Throws

  ApiError