/** * 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 { CreateQrcodeTemplateRequest, CreateQrcodeTemplateResponse, ImportQrcodeTemplateRequest, ImportQrcodeTemplateResponse, ListQrcodeTemplatesResponse, PublicListQrcodeTemplatesResponse, PublicQrcodeTemplate, PublishQrcodeTemplateResponse, QrcodeTemplate, QrcodeTemplatesServiceUpdateQrcodeTemplateBody, UpdateQrcodeTemplateResponse } from '../models/index'; export interface QrcodeTemplatesServiceCreateQrcodeTemplateRequest { createQrcodeTemplateRequest: CreateQrcodeTemplateRequest; } export interface QrcodeTemplatesServiceDeleteQrcodeTemplateRequest { id: string; } export interface QrcodeTemplatesServiceGetQrcodeTemplateRequest { id: string; include?: Array; } export interface QrcodeTemplatesServiceImportQrcodeTemplateRequest { importQrcodeTemplateRequest: ImportQrcodeTemplateRequest; } export interface QrcodeTemplatesServiceListQrcodeTemplatesRequest { include?: Array; search?: string; pageSize?: number; pageToken?: string; } export interface QrcodeTemplatesServicePublicGetQrcodeTemplateRequest { slug: string; include?: Array; } export interface QrcodeTemplatesServicePublicListQrcodeTemplatesRequest { include?: Array; search?: string; pageSize?: number; pageToken?: string; workspaceId?: string; } export interface QrcodeTemplatesServicePublishQrcodeTemplateRequest { id: string; body: object; } export interface QrcodeTemplatesServiceUpdateQrcodeTemplateRequest { id: string; qrcodeTemplatesServiceUpdateQrcodeTemplateBody: QrcodeTemplatesServiceUpdateQrcodeTemplateBody; } /** * QRCodeTemplatesApi - interface * * @export * @interface QRCodeTemplatesApiInterface */ export interface QRCodeTemplatesApiInterface { /** * Creates request options for qrcodeTemplatesServiceCreateQrcodeTemplate without sending the request * @param {CreateQrcodeTemplateRequest} createQrcodeTemplateRequest * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceCreateQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest): Promise; /** * Create a new QR code template using a fresh design. The design must not be used by any other links or templates. * @summary Create a new QR code template * @param {CreateQrcodeTemplateRequest} createQrcodeTemplateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceCreateQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new QR code template using a fresh design. The design must not be used by any other links or templates. * Create a new QR code template */ qrcodeTemplatesServiceCreateQrcodeTemplate(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceDeleteQrcodeTemplate without sending the request * @param {string} id * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceDeleteQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest): Promise; /** * Remove a QR code template belonging to the authenticated caller\'s workspace. * @summary Delete a workspace QR code template * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceDeleteQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a QR code template belonging to the authenticated caller\'s workspace. * Delete a workspace QR code template */ qrcodeTemplatesServiceDeleteQrcodeTemplate(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceGetQrcodeTemplate without sending the request * @param {string} id * @param {Array} [include] * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceGetQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest): Promise; /** * Retrieve a QR code template that belongs to the authenticated caller\'s workspace. * @summary Get a workspace QR code template * @param {string} id * @param {Array} [include] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceGetQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a QR code template that belongs to the authenticated caller\'s workspace. * Get a workspace QR code template */ qrcodeTemplatesServiceGetQrcodeTemplate(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceImportQrcodeTemplate without sending the request * @param {ImportQrcodeTemplateRequest} importQrcodeTemplateRequest * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceImportQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest): Promise; /** * Import a public QR code template into your workspace by slug. Creates a private copy owned by your workspace. * @summary Import a public QR code template * @param {ImportQrcodeTemplateRequest} importQrcodeTemplateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceImportQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Import a public QR code template into your workspace by slug. Creates a private copy owned by your workspace. * Import a public QR code template */ qrcodeTemplatesServiceImportQrcodeTemplate(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceListQrcodeTemplates without sending the request * @param {Array} [include] * @param {string} [search] * @param {number} [pageSize] * @param {string} [pageToken] * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceListQrcodeTemplatesRequestOpts(requestParameters: QrcodeTemplatesServiceListQrcodeTemplatesRequest): Promise; /** * Retrieve QR code templates that belong to the authenticated caller\'s workspace. * @summary List my QR code templates * @param {Array} [include] * @param {string} [search] * @param {number} [pageSize] * @param {string} [pageToken] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceListQrcodeTemplatesRaw(requestParameters: QrcodeTemplatesServiceListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve QR code templates that belong to the authenticated caller\'s workspace. * List my QR code templates */ qrcodeTemplatesServiceListQrcodeTemplates(requestParameters: QrcodeTemplatesServiceListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublicGetQrcodeTemplate without sending the request * @param {string} slug * @param {Array} [include] Related objects to include in the response List of related objects to include. Supported values: \'workspace\' * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublicGetQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest): Promise; /** * Retrieve a single published QR code template that is visible in the public gallery. * @summary Get a public QR code template * @param {string} slug * @param {Array} [include] Related objects to include in the response List of related objects to include. Supported values: \'workspace\' * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublicGetQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a single published QR code template that is visible in the public gallery. * Get a public QR code template */ qrcodeTemplatesServicePublicGetQrcodeTemplate(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublicListQrcodeTemplates without sending the request * @param {Array} [include] Related objects to include in the response List of related objects to include. Supported values: \'workspace\' * @param {string} [search] Search query applied to template name/description * @param {number} [pageSize] Maximum number of templates to return (defaults to 20) * @param {string} [pageToken] Cursor token to retrieve the next page of results * @param {string} [workspaceId] Optional workspace ID to filter templates by workspace Filter public templates by workspace. Only published templates for that workspace will be returned. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublicListQrcodeTemplatesRequestOpts(requestParameters: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest): Promise; /** * Retrieve available QR code templates, optionally filtered by search terms or link destination. * @summary List QR code templates * @param {Array} [include] Related objects to include in the response List of related objects to include. Supported values: \'workspace\' * @param {string} [search] Search query applied to template name/description * @param {number} [pageSize] Maximum number of templates to return (defaults to 20) * @param {string} [pageToken] Cursor token to retrieve the next page of results * @param {string} [workspaceId] Optional workspace ID to filter templates by workspace Filter public templates by workspace. Only published templates for that workspace will be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublicListQrcodeTemplatesRaw(requestParameters: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve available QR code templates, optionally filtered by search terms or link destination. * List QR code templates */ qrcodeTemplatesServicePublicListQrcodeTemplates(requestParameters: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublishQrcodeTemplate without sending the request * @param {string} id The ID of the QR code template to publish (UUID) * @param {object} body * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublishQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest): Promise; /** * Publish a QR code template to make it available in the public gallery. Requires workspace to be public and template to have slug, description, and name. * @summary Publish a workspace QR code template * @param {string} id The ID of the QR code template to publish (UUID) * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServicePublishQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Publish a QR code template to make it available in the public gallery. Requires workspace to be public and template to have slug, description, and name. * Publish a workspace QR code template */ qrcodeTemplatesServicePublishQrcodeTemplate(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceUpdateQrcodeTemplate without sending the request * @param {string} id The ID of the QR code template to update (UUID) * @param {QrcodeTemplatesServiceUpdateQrcodeTemplateBody} qrcodeTemplatesServiceUpdateQrcodeTemplateBody * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceUpdateQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest): Promise; /** * Modify the name or description of a QR code template owned by the authenticated workspace. * @summary Update a workspace QR code template * @param {string} id The ID of the QR code template to update (UUID) * @param {QrcodeTemplatesServiceUpdateQrcodeTemplateBody} qrcodeTemplatesServiceUpdateQrcodeTemplateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QRCodeTemplatesApiInterface */ qrcodeTemplatesServiceUpdateQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify the name or description of a QR code template owned by the authenticated workspace. * Update a workspace QR code template */ qrcodeTemplatesServiceUpdateQrcodeTemplate(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class QRCodeTemplatesApi extends runtime.BaseAPI implements QRCodeTemplatesApiInterface { /** * Creates request options for qrcodeTemplatesServiceCreateQrcodeTemplate without sending the request */ qrcodeTemplatesServiceCreateQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest): Promise; /** * Create a new QR code template using a fresh design. The design must not be used by any other links or templates. * Create a new QR code template */ qrcodeTemplatesServiceCreateQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new QR code template using a fresh design. The design must not be used by any other links or templates. * Create a new QR code template */ qrcodeTemplatesServiceCreateQrcodeTemplate(requestParameters: QrcodeTemplatesServiceCreateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceDeleteQrcodeTemplate without sending the request */ qrcodeTemplatesServiceDeleteQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest): Promise; /** * Remove a QR code template belonging to the authenticated caller\'s workspace. * Delete a workspace QR code template */ qrcodeTemplatesServiceDeleteQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a QR code template belonging to the authenticated caller\'s workspace. * Delete a workspace QR code template */ qrcodeTemplatesServiceDeleteQrcodeTemplate(requestParameters: QrcodeTemplatesServiceDeleteQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceGetQrcodeTemplate without sending the request */ qrcodeTemplatesServiceGetQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest): Promise; /** * Retrieve a QR code template that belongs to the authenticated caller\'s workspace. * Get a workspace QR code template */ qrcodeTemplatesServiceGetQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a QR code template that belongs to the authenticated caller\'s workspace. * Get a workspace QR code template */ qrcodeTemplatesServiceGetQrcodeTemplate(requestParameters: QrcodeTemplatesServiceGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceImportQrcodeTemplate without sending the request */ qrcodeTemplatesServiceImportQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest): Promise; /** * Import a public QR code template into your workspace by slug. Creates a private copy owned by your workspace. * Import a public QR code template */ qrcodeTemplatesServiceImportQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Import a public QR code template into your workspace by slug. Creates a private copy owned by your workspace. * Import a public QR code template */ qrcodeTemplatesServiceImportQrcodeTemplate(requestParameters: QrcodeTemplatesServiceImportQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceListQrcodeTemplates without sending the request */ qrcodeTemplatesServiceListQrcodeTemplatesRequestOpts(requestParameters: QrcodeTemplatesServiceListQrcodeTemplatesRequest): Promise; /** * Retrieve QR code templates that belong to the authenticated caller\'s workspace. * List my QR code templates */ qrcodeTemplatesServiceListQrcodeTemplatesRaw(requestParameters: QrcodeTemplatesServiceListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve QR code templates that belong to the authenticated caller\'s workspace. * List my QR code templates */ qrcodeTemplatesServiceListQrcodeTemplates(requestParameters?: QrcodeTemplatesServiceListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublicGetQrcodeTemplate without sending the request */ qrcodeTemplatesServicePublicGetQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest): Promise; /** * Retrieve a single published QR code template that is visible in the public gallery. * Get a public QR code template */ qrcodeTemplatesServicePublicGetQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a single published QR code template that is visible in the public gallery. * Get a public QR code template */ qrcodeTemplatesServicePublicGetQrcodeTemplate(requestParameters: QrcodeTemplatesServicePublicGetQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublicListQrcodeTemplates without sending the request */ qrcodeTemplatesServicePublicListQrcodeTemplatesRequestOpts(requestParameters: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest): Promise; /** * Retrieve available QR code templates, optionally filtered by search terms or link destination. * List QR code templates */ qrcodeTemplatesServicePublicListQrcodeTemplatesRaw(requestParameters: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve available QR code templates, optionally filtered by search terms or link destination. * List QR code templates */ qrcodeTemplatesServicePublicListQrcodeTemplates(requestParameters?: QrcodeTemplatesServicePublicListQrcodeTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServicePublishQrcodeTemplate without sending the request */ qrcodeTemplatesServicePublishQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest): Promise; /** * Publish a QR code template to make it available in the public gallery. Requires workspace to be public and template to have slug, description, and name. * Publish a workspace QR code template */ qrcodeTemplatesServicePublishQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Publish a QR code template to make it available in the public gallery. Requires workspace to be public and template to have slug, description, and name. * Publish a workspace QR code template */ qrcodeTemplatesServicePublishQrcodeTemplate(requestParameters: QrcodeTemplatesServicePublishQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for qrcodeTemplatesServiceUpdateQrcodeTemplate without sending the request */ qrcodeTemplatesServiceUpdateQrcodeTemplateRequestOpts(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest): Promise; /** * Modify the name or description of a QR code template owned by the authenticated workspace. * Update a workspace QR code template */ qrcodeTemplatesServiceUpdateQrcodeTemplateRaw(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Modify the name or description of a QR code template owned by the authenticated workspace. * Update a workspace QR code template */ qrcodeTemplatesServiceUpdateQrcodeTemplate(requestParameters: QrcodeTemplatesServiceUpdateQrcodeTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }