/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateMediaRequest, CreateMediaResponse, GetMediaResponse, ListMediaResponse } from '../models/index'; export interface MediaServiceCreateRequest { createMediaRequest: CreateMediaRequest; } export interface MediaServiceDeleteRequest { id: string; } export interface MediaServiceGetRequest { id: string; } export interface MediaServiceListRequest { pageSize: number; pageToken?: string; } /** * MediaApi - interface * * @export * @interface MediaApiInterface */ export interface MediaApiInterface { /** * Creates request options for mediaServiceCreate without sending the request * @param {CreateMediaRequest} createMediaRequest * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise; /** * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code. * @summary Upload a media file * @param {CreateMediaRequest} createMediaRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code. * Upload a media file */ mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceDelete without sending the request * @param {string} id The ID of the media file to delete (UUID) * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise; /** * Removes a media file from the workspace. This operation cannot be undone. * @summary Delete a media file * @param {string} id The ID of the media file to delete (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a media file from the workspace. This operation cannot be undone. * Delete a media file */ mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceGet without sending the request * @param {string} id The ID of the media file to retrieve (UUID) * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceGetRequestOpts(requestParameters: MediaServiceGetRequest): Promise; /** * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\". * @summary Get media file details * @param {string} id The ID of the media file to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceGetRaw(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\". * Get media file details */ mediaServiceGet(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceList without sending the request * @param {number} pageSize The maximum number of media files to return. * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise; /** * Retrieves the media files for your workspace * @summary List media files * @param {number} pageSize The maximum number of media files to return. * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MediaApiInterface */ mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves the media files for your workspace * List media files */ mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterface { /** * Creates request options for mediaServiceCreate without sending the request */ mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise; /** * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code. * Upload a media file */ mediaServiceCreateRaw(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows users to upload a new media file to their Linkbreakers workspace. For now the file size limit is 3MB. Example: Uploading an image to be placed in the center of a QR Code. * Upload a media file */ mediaServiceCreate(requestParameters: MediaServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceDelete without sending the request */ mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise; /** * Removes a media file from the workspace. This operation cannot be undone. * Delete a media file */ mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a media file from the workspace. This operation cannot be undone. * Delete a media file */ mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceGet without sending the request */ mediaServiceGetRequestOpts(requestParameters: MediaServiceGetRequest): Promise; /** * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\". * Get media file details */ mediaServiceGetRaw(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\". * Get media file details */ mediaServiceGet(requestParameters: MediaServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for mediaServiceList without sending the request */ mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise; /** * Retrieves the media files for your workspace * List media files */ mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves the media files for your workspace * List media files */ mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }