linkbreakers 1.34.0

package/dist/apis/MediaApi.d.ts

@@ -0,0 +1,181 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * 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<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<CreateMediaResponse>>;
+    /**
+     * 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<CreateMediaResponse>;
+    /**
+     * 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<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<object>>;
+    /**
+     * Removes a media file from the workspace. This operation cannot be undone.
+     * Delete a media file
+     */
+    mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * 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<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<GetMediaResponse>>;
+    /**
+     * 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<GetMediaResponse>;
+    /**
+     * 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<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<ListMediaResponse>>;
+    /**
+     * Retrieves the media files for your workspace
+     * List media files
+     */
+    mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;
+}
+/**
+ *
+ */
+export declare class MediaApi extends runtime.BaseAPI implements MediaApiInterface {
+    /**
+     * Creates request options for mediaServiceCreate without sending the request
+     */
+    mediaServiceCreateRequestOpts(requestParameters: MediaServiceCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<CreateMediaResponse>>;
+    /**
+     * 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<CreateMediaResponse>;
+    /**
+     * Creates request options for mediaServiceDelete without sending the request
+     */
+    mediaServiceDeleteRequestOpts(requestParameters: MediaServiceDeleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes a media file from the workspace. This operation cannot be undone.
+     * Delete a media file
+     */
+    mediaServiceDeleteRaw(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Removes a media file from the workspace. This operation cannot be undone.
+     * Delete a media file
+     */
+    mediaServiceDelete(requestParameters: MediaServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates request options for mediaServiceGet without sending the request
+     */
+    mediaServiceGetRequestOpts(requestParameters: MediaServiceGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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<runtime.ApiResponse<GetMediaResponse>>;
+    /**
+     * 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<GetMediaResponse>;
+    /**
+     * Creates request options for mediaServiceList without sending the request
+     */
+    mediaServiceListRequestOpts(requestParameters: MediaServiceListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the media files for your workspace
+     * List media files
+     */
+    mediaServiceListRaw(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListMediaResponse>>;
+    /**
+     * Retrieves the media files for your workspace
+     * List media files
+     */
+    mediaServiceList(requestParameters: MediaServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListMediaResponse>;
+}

package/dist/apis/MediaApi.js

@@ -0,0 +1,231 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class MediaApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for mediaServiceCreate without sending the request
+     */
+    async mediaServiceCreateRequestOpts(requestParameters) {
+        if (requestParameters['createMediaRequest'] == null) {
+            throw new runtime.RequiredError('createMediaRequest', 'Required parameter "createMediaRequest" was null or undefined when calling mediaServiceCreate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateMediaRequestToJSON)(requestParameters['createMediaRequest']),
+        };
+    }
+    /**
+     * 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
+     */
+    async mediaServiceCreateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceCreateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateMediaResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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
+     */
+    async mediaServiceCreate(requestParameters, initOverrides) {
+        const response = await this.mediaServiceCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for mediaServiceDelete without sending the request
+     */
+    async mediaServiceDeleteRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling mediaServiceDelete().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Removes a media file from the workspace. This operation cannot be undone.
+     * Delete a media file
+     */
+    async mediaServiceDeleteRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceDeleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Removes a media file from the workspace. This operation cannot be undone.
+     * Delete a media file
+     */
+    async mediaServiceDelete(requestParameters, initOverrides) {
+        const response = await this.mediaServiceDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for mediaServiceGet without sending the request
+     */
+    async mediaServiceGetRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling mediaServiceGet().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\".
+     * Get media file details
+     */
+    async mediaServiceGetRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetMediaResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieves information about a media file including its metadata and URL. Example: Getting details for media with ID \"med_123\".
+     * Get media file details
+     */
+    async mediaServiceGet(requestParameters, initOverrides) {
+        const response = await this.mediaServiceGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for mediaServiceList without sending the request
+     */
+    async mediaServiceListRequestOpts(requestParameters) {
+        if (requestParameters['pageSize'] == null) {
+            throw new runtime.RequiredError('pageSize', 'Required parameter "pageSize" was null or undefined when calling mediaServiceList().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+        if (requestParameters['pageToken'] != null) {
+            queryParameters['pageToken'] = requestParameters['pageToken'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/media`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves the media files for your workspace
+     * List media files
+     */
+    async mediaServiceListRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.mediaServiceListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListMediaResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieves the media files for your workspace
+     * List media files
+     */
+    async mediaServiceList(requestParameters, initOverrides) {
+        const response = await this.mediaServiceListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.MediaApi = MediaApi;